Rails Rabl - Custom array keys

Question

I'm trying to customize my RABL API response. I have a collection of games, and each game contains multiple players. For now my players are stored in an array, but I need to access them by a key so I'd like to customize my json response.

Here is my base.rabl file:

collection @games
attributes :id
child(:players) do |a|
  attributes :id, :position
end

This is what I get:

[
  {
    id: 1,
    players: [
      {
        id: 27,
        position: 'goalkeeper'
      },
      {
        id: 32,
        position: 'striker'
      },
      {
        id: 45,
        position: 'defender'
      }
    ]
  }
]

And this is what I'm trying to get:

[
  {
    id: 1,
    goalkeeper: {
      id: 27
    },
    striker: {
      id: 32
    },
    defender: {
      id: 45
    }
  }
]

For now I can't find a way to display the players other than in an array of objects.

Could someone give me a hit? I tried a lot of rabl configurations but without success for now...

EDIT:

I changed the attributes so it is more explicit. Each game has numerous players and each player has a different position.

In order to add more details so you could understand what I'm trying to achieve, here is my best attempt:

base.rabl file:

object @games

@games.each do |game|
  node(:id) { |_| game.id }
  game.players.each do |player|
    if (player.position == 'goalkeeper')
      node(:goalkeeper) { |_| player.id }
    elsif (player.position == 'striker')
      node(:striker) { |_| player.id }
    end
  end
end

And this is what I get:

[
  {
    id: 1,
    goalkeeper: {
      id: 27
    },
    striker: {
      id: 32
    }
  },
  {
    id: 1,
    goalkeeper: {
      id: 27
    },
    striker: {
      id: 32
    }
  }
]

The structure is what I want, but each game returned is the same. If my query result contains 4 games, it returns 4 games but they are all the same...

Leantraxxx · Accepted Answer · 2016-04-26T22:57:41.017

If you have the models...

class Game < ActiveRecord::Base
  has_many :players
end

class Player < ActiveRecord::Base
  belongs_to :game
end

In your base.json.rabl file you can do:

attributes :id

node do |game|
  game.players.each do |player|
    node(player.position) { { id: player.id } } # I suggest node(pos) { player.id }
  end
end

In your index.json.rabl you need to have:

collection @games
extends 'api/games/base' # the base.rabl path

In your show.json.rabl you need to have:

object @game
extends 'api/games/base' # the base.rabl path

In your GamesController you need to do:

respond_to :json

def index
  @games = Game.all
  respond_with @games
end

def show
  @game = Game.find(params[:id)
  respond_with @game
end

So, if your request is to GET /api/games you will hit index.json.rabl and you will get your desired response.

If you want to see only one game, you need to hit GET /api/games/:id

I'm assuming your have a namespace api. I don't know if GET /api/games really exists but, you get the idea.

I'm assuming you have one position by player in one game.

Thanks for your answer. But it won't work in my case. I edited my post in order to add more details so you could understand more precisely what I'm trying to achieve. — alskaa, Apr 21 '16 at 08:07
I think you are misunderstanding the rabl's concept of `collection` and `object. I've updated my answer with the example from controller. — Leantraxxx, Apr 21 '16 at 12:57
You're right, it's the first project where I use rabl and I was not using it properly. Now I think I understand :) Thanks very much for your detailed answer, it helped me a lot! — alskaa, Apr 22 '16 at 08:59

Rails Rabl - Custom array keys

1 Answers1