Serializers (Active Model Serializers) in Ruby on Rails - Mini Project: Build & Apply

Serializing User Data with Active Model Serializers

📖 Scenario: You are building a simple Rails API that sends user information as JSON to a frontend app. To make the JSON neat and easy to use, you will use Active Model Serializers.

🎯 Goal: Create a serializer for the User model that controls which user attributes are sent in the JSON response.

📋 What You'll Learn

Create a User model with specific attributes

Set a configuration variable for attributes to include

Write a serializer class using Active Model Serializers

Use the serializer in a controller to render JSON

💡 Why This Matters

🌍 Real World

APIs often need to send only specific parts of data to clients. Serializers help format and filter this data cleanly.

💼 Career

Understanding serializers is key for backend developers working with Rails APIs to deliver well-structured JSON to frontend or mobile apps.

1

Create the User model with attributes

Create a User model with these exact attributes: id, name, email, and age. Use attr_accessor to define them.

Ruby on Rails

# Define the User model with id, name, email, and age attributes
# Your code here

Hint

Use attr_accessor to create readable and writable attributes for User.

2

Set attributes to include in serialization

Create a variable called USER_ATTRIBUTES as an array containing :id, :name, and :email. This will control which attributes the serializer sends.

Ruby on Rails

class User
  attr_accessor :id, :name, :email, :age

  def initialize(id, name, email, age)
    @id = id
    @name = name
    @email = email
    @age = age
  end
end

# Define USER_ATTRIBUTES array with :id, :name, and :email
# Your code here

Hint

Use a constant array named USER_ATTRIBUTES with symbols for the attributes.

3

Create the UserSerializer class

Create a class called UserSerializer that inherits from ActiveModel::Serializer. Use attributes method with the USER_ATTRIBUTES array to specify which attributes to serialize.

Ruby on Rails

class UserSerializer < ActiveModel::Serializer
  # Use attributes method with USER_ATTRIBUTES
  # Your code here
end

Hint

Use the splat operator * to pass the array elements as arguments to attributes.

4

Render JSON using the serializer in controller

In a controller action, create a User instance with id: 1, name: 'Alice', email: '[e-mail]', and age: 30. Render JSON using render json: user, serializer: UserSerializer.

Ruby on Rails

def show
  # Create user instance
  # Render JSON with UserSerializer
  # Your code here
end

Hint

Create the user with exact values and use render json: with the serializer option.

Practice

1. What is the main purpose of using Active Model Serializers in a Rails application?

easy

A. To handle database migrations automatically

B. To format and control how Rails models are converted to JSON responses

C. To manage user authentication and sessions

D. To style HTML views with CSS

Solution

1. Step 1: Understand the role of serializers

   Serializers format model data into JSON, deciding which attributes to include.

2. Step 2: Compare with other options

   Database migrations, authentication, and styling are unrelated to serializers.

3. Final Answer:

   To format and control how Rails models are converted to JSON responses -> Option B

4. Quick Check:

   Serializers format JSON = A [OK]

Hint: Serializers shape JSON output, not database or styling [OK]

Common Mistakes:

• Confusing serializers with database migration tools
• Thinking serializers handle user login
• Assuming serializers style HTML pages

2. Which of the following is the correct way to define attributes in an Active Model Serializer?

easy

A. attributes :id, :name, :email

B. attribute :id, :name, :email

C. attrs :id, :name, :email

D. fields :id, :name, :email

Solution

1. Step 1: Recall the syntax for attributes in serializers

   The correct method is attributes followed by symbols for each field.

2. Step 2: Check other options

   attribute (singular), attrs, and fields are not valid methods in Active Model Serializers.

3. Final Answer:

   attributes :id, :name, :email -> Option A

4. Quick Check:

   Use plural 'attributes' method [OK]

Hint: Use plural 'attributes' to list fields in serializer [OK]

Common Mistakes:

• Using singular 'attribute' instead of 'attributes'
• Trying non-existent methods like 'attrs' or 'fields'
• Forgetting to use symbols for attribute names

3. Given this serializer:

class UserSerializer < ActiveModel::Serializer
  attributes :id, :name
  attribute :email
end

What will be the JSON output keys for a user with id=1, name='Alice', email='[e-mail]'?

medium

A. {"id":1,"name":"Alice"}

B. {"id":1,"name":"Alice","email":"[e-mail]"}

C. {"id":1,"name":"Alice", "email":null}

D. NoMethodError due to 'attribute' usage

Solution

1. Step 1: Check serializer attribute methods

   The serializer uses attributes (plural) and attribute (singular). Only attributes is valid; attribute is not a defined method and raises NoMethodError when the class is defined.

2. Step 2: Determine output keys

   The serializer class fails to load due to the undefined method, preventing JSON output.

3. Final Answer:

   NoMethodError due to 'attribute' usage -> Option D

4. Quick Check:

   Undefined 'attribute' method causes error = D [OK]

Hint: Only use plural 'attributes' to include fields [OK]

Common Mistakes:

• Using singular 'attribute' which causes NoMethodError
• Expecting all fields to appear despite syntax error
• Confusing attribute method names

4. Identify the error in this serializer code:

class PostSerializer < ActiveModel::Serializer
  attributes :id, :title

  def title
    object.title.upcase
  end

  def author_name
    object.author.name
  end
end

medium

A. Missing :author_name in attributes list, so it won't appear in JSON

B. Method 'title' should not be defined in serializer

C. Using 'object' is invalid inside serializer methods

D. Attributes list should include :author instead of :author_name

Solution

1. Step 1: Check attributes declaration

   Only :id and :title are declared in attributes, so only these keys appear in JSON.

2. Step 2: Check custom method usage

   Method author_name exists but is not listed in attributes, so it won't be serialized.

3. Final Answer:

   Missing :author_name in attributes list, so it won't appear in JSON -> Option A

4. Quick Check:

   Only declared attributes appear in JSON = B [OK]

Hint: Add custom methods to attributes list to include them [OK]

Common Mistakes:

• Defining methods but forgetting to list them in attributes
• Thinking all methods auto-serialize
• Misusing 'object' inside serializer methods

5. You want to include a nested association in your JSON output using Active Model Serializers. Given these models:

class Article < ApplicationRecord
  belongs_to :author
end

class Author < ApplicationRecord
  has_many :articles
end

And these serializers:

class ArticleSerializer < ActiveModel::Serializer
  attributes :id, :title
  belongs_to :author
end

class AuthorSerializer < ActiveModel::Serializer
  attributes :id, :name
end

What will the JSON output for an article include regarding the author?

hard

A. The author will not be included unless manually added in controller

B. Only the author's id will be included as a number

C. The author will be included as a nested JSON object with :id and :name

D. The JSON will raise an error due to missing author attributes

Solution

1. Step 1: Understand belongs_to in serializer

   Using belongs_to :author in ArticleSerializer includes the author association serialized by AuthorSerializer.

2. Step 2: Check AuthorSerializer attributes

   AuthorSerializer defines :id and :name, so these fields appear nested inside article JSON.

3. Final Answer:

   The author will be included as a nested JSON object with :id and :name -> Option C

4. Quick Check:

   belongs_to includes nested object = C [OK]

Hint: Use belongs_to with serializer to nest associated objects [OK]

Common Mistakes:

• Expecting only author id without serializer
• Thinking associations need manual controller inclusion
• Assuming missing attributes cause errors