CSC/ECE 517 Fall 2014/ch1a 24 sa
Active Model Serializers
Ruby on Rails offers strong features to write API based server applications, which expose data through a well designed API and serve data in various formats as requested. One of these features is Active Model Serializers which help the API designer to have fine control over the response generated by the API to a data request. Active Model Serializers help programmers do this very easily and cleanly without breaking separation of concerns in a rails application. They promote convention over configuration, thus reducing code bloat and increasing code scalibility and readability.
The modern web has seen more and more web applications that are written as web services or web APIs. These applications do not return a web page to the client browser, but return just the bare bones data to the client in the format requested. This gives the clients the liberty to develop customized User interfaces for the same web application. A common example is the Rotten Tomatoes API which offers movie data in JSON, XML and various other formats. The clients request the Rotten Tomatoes web server for the data in the desired format, and the web server is able to respond with the correct data in the required format.
Active Model Serializers are a way for Web API designers who use Ruby on Rails to have full control over the formatting and the content of data that is returned to clients. For eg. An employee data model returned as JSON to a data request might look like this:
{Employee: {
name: emp_name
age: 26
salary: 35000
weight: 90kg
height: 170
}
}
But the API designer may want to improve this formatting and exclude certain fields so that the response is just the data without the Employee token:
{
EmpConciseDetails: emp_name 26
}
Active Model Serializers help API designers do this very easily and cleanly without breaking separation of concerns in a Rails application. They promote convention over configuration, thus reducing code bloat and increasing code scalibility and readability.
Introduction
Let us familiarize ourselves with a few terms before getting to the usage of Active Model Serializers.
- Active Model
- Active Model is closely related to the widely used concept of Active Record in the Rails world. Active Record is an object that maps directly to the data in our database. An Active Record takes care of fetching and saving data to the database. For example, in an employee records application an Employee Active Record helps to persist a newly created/edited Employee. So how is an Active Model different? It may not always be the case that we want our Employee model to be backed by a database. But we might want to have all the functionality that an Active Record provides (for example, validations on the Employee model to check if name is present on the Employee Active Record before persisting it or checking if the active record got dirtied because of an attribute change etc. ). An example of this is, as and when an Employee create form is submitted, we might want to just send an email to the admin with the new employee data once we validate that data. An Active Model does just this. Infact, the rails developers segregated all the non database functionality out of an Active Record into an Active Model.
- Serializer
- Serializer is a small program that takes an object residing in program memory (for example: could be a C# object in an ASP.NET application, or an ActiveModel object in a Rails application) and converts this information into format that is transferrable over the wire, for example, JSON and XML. This is required because the client may be written in Java and there is no way for it to read an Active Model Ruby Object that exists in memory on the server side.
- API Server Application
- API Server application is an application which serves data requests coming from a variety of clients (for example: mobile, desktop) in various formats such as JSON, XML. For example, An employee data web service which returns employee age and name in both JSON and XML
Why Active Model Serializers?
- Custom response attributes: It is not always the case that an API application serves a request by responding with data as it is stored on the server. The API designer has a task of exposing just the right data to the clients and hence needs fine control over exactly what part of the data on the server is returned in a response. An Active Model Serializer could help return just the Employee age and name to the client as JSON and ignore all the other attributes set on an Employee Model.
- Separation of Concerns: The response data could also be customized in the respond_to method of the rails controller action or for example, by implementing a custom as_json method on the model class. However this breaks the separation of concerns principle as we let something like formatting the response data venture into the controller and model layer. With Active Model Serializers we can keep this functionality segregated from the application.
- Maintainability: Client needs keep changing. Let's say a Client requests some changes to the API response data, only the Active Model Serializer would get affected and there are no side effects on the Controller or the Model itself.
How Active Model Serializer Works?
Active Model Serializers work with the help of two components namely Serializer and Adapter. Let's say we wanted to write an Active Model Serializer for customizing an API that returns Employee data as json. We would have to write an EmployeeSerializer which is configured to use a JsonApiAdapter. The Serializer Component would specify which attributes and relationships of Employee to other models would be captured in the response data. For example, it might choose to return the Employee name, age and the data about the employee's family members which are different models. The Adapter component specifies how to format this selected Employee data in the correct format as required by the client. A JsonApiAdapter would format it as JSON and is the default adapter used by an Active Model Serializer. However you can always supply your own Adapter for the serializer to use.
Assume the Employee data API scenario cited above and Refer to the figure.
- The Controller receives the request for json data and routes it to a specific action method
- The action method has a respond_to method that returns Employee model as JSON. When Rails encounters this line, it looks for an EmployeeSerializer in the project specifically in a file employee_serializer to get the exact data to be put into the response.
- The EmployeeSerializer is by default configured to use a JsonApiAdapter and formats the specified attributes and relationships in the JSON format. This forms the final customized response.
As you can see, instead of returning the default JSON conversion of the Employee model from the respond_to method, that Rails does automatically for us, we were able to customize our API response data through the use of Active Model Serializers in a non-intrusive way maintaining separation from the controller and the model layers.
Using Active Model Serializer
Let us see some code now.
Step 1: Active Model Serializer is available as a gem. Add to the gem file the following line :
gem 'active_model_serializers'
Step 2: Run the following command at the terminal window to install the gem.
bundle update
Step 3: This gem provides a serializer generator for the selected Active Model. For example, if employee was your Active Model run : rails g serializer employee
This would create a file employee_serializer.rb containing the following code in the newly created app/serializers directory of your project:
class EmployeeSerializer < ActiveModel::Serializer attributes :id end
Step 4: Add your custom attributes and any other customizations to this file. For example: We are adding a url attribute to get details of this employee although the Employee Active Model does not have any such attribute. We add it because the client might be interested in it. That is the power of Active Model Serializer. It does not require us to define another property on the Employee Active Model to return its Url.
class EmployeeSerializer < ActiveModel::Serializer
attributes :id, :name, :age, :url
def url
employee_url(object)
end
end
Step 5: That's it! Whenever an Employee is requested the custom EmployeeSerializer does the task of serializing the employee to json and will now include a url key value pair to view the Employee.