Rails Grape API pagination with AMS and custom JSON

Question

Doing in Rails what may require a more complex/creative solution, but basically using Grape, active_model_serializers (AMS), and grape-kaminari to return an index route (list) of User objects, and I'd like to be able to use the advantages of AMS with caching and easily serializing objects, but customize the JSON response.

Here's Grape:

module API
  module V1
    class Users < Grape::API
      include API::V1::Defaults
      include Grape::Kaminari

      resource :users do
         paginate per_page: 18
         get do
           users = User.all
           paginate users
         end
      end
    end
  end
end

And AMS:

class UserSerializer < ActiveModel::Serializer
  cache key: 'user', expires_in: 3.hours
  attributes :id, :firstname, :lastname, :email, :username
end

Ideal Response in JSON:

{
  users: [
    {
      id: 1,
      firstname: "Daniel",
      lastname: "Archer,
      email: "daniel@archer.co",
      username: "dja"
     },
    {
      id: 2,
      firstname: "Fakey",
      lastname: "McFakerson,
      email: "fake@fake.io",
      username: "fake"
     }
  ],
  extras: {
    user_count: 300,
    new_users_last_5_days: 10,
    new_users_last_30_days: 25
  }
}

What I'd like to happen (and having trouble with) is to paginate the amount of users in the JSON response, but include some extras that are related to the entire collection of Users. For example, I may have 300 Users, but I only want to return the first 18 users (or however many based on params per_page and page), and extra data on the entire collection.

Martin M · Answer 1 · 2016-06-07T05:51:16.550

0

With Grape::Entity you can present multiple values.

paginate users

just presents the selected page of users. You can add another present just after that:

present :extras, {user_count: User.count, ...}

To Answer your comment:
I'm using a similar setup and have a response that is paginated with kaminary and extended with extra data:

get do
  ...
  present :statistics, statistics, with: API::Entities::Statistics
  present :refresh_time, Setting.list_refresh_time
  present :users, @users.page(params[:page]).per(18), with: API::Entities::User
end

With vanilla Grape, a data structure is returned, that is converted dependent of the output format, i.e. with .to_json. So you can return a Hash:

get do
  ...
  { statistics: some_statistics, 
    users: @users.page(params[:page]).per(18)
  }
end

edited Jun 07 '16 at 05:51

answered Jun 05 '16 at 21:56

Martin M

8,430
2
35
53

So you're saying just add `present :extras, {user_count: User.count, ...}` on a line after `paginate users`? That doesn't seem to work for me.. – Daniel Jacob Archer Jun 05 '16 at 21:59
Or does that require the use of Grape-Entity? – Daniel Jacob Archer Jun 06 '16 at 00:35
I'm using it with and without Grape-Entity. – Martin M Jun 06 '16 at 06:35
When I use present, I'm only getting the last presenter.. :/ – Daniel Jacob Archer Jun 06 '16 at 17:48
Admitted, `present` is a tool of `Grape::Entity`. Vanilla `Grape` returns a single data structure, I expanded my answer. – Martin M Jun 07 '16 at 05:48

Rails Grape API pagination with AMS and custom JSON

1 Answers1