Как создать ответ JSON, состоящий из нескольких моделей в Rails

Во-первых, желаемый результат

У меня есть модели User и Item. Я хотел бы создать ответ JSON, который выглядит так:

{
  "user":
    {"username":"Bob!","foo":"whatever","bar":"hello!"},

  "items": [
    {"id":1, "name":"one", "zim":"planet", "gir":"earth"},
    {"id":2, "name":"two", "zim":"planet", "gir":"mars"}
  ]
}

Однако моя модель User и Item имеет больше атрибутов, чем только те. Я нашел способ заставить это работать, но остерегаться, это не очень... Пожалуйста, помогите...

Update

Следующий раздел содержит исходный вопрос. В последнем разделе показано новое решение.

Мои хаки

home_controller.rb

class HomeController < ApplicationController

  def observe
    respond_to do |format|
      format.js { render :json => Observation.new(current_user, @items).to_json }
    end
  end

end

observation.rb

# NOTE: this is not a subclass of ActiveRecord::Base
# this class just serves as a container to aggregate all "observable" objects
class Observation
  attr_accessor :user, :items

  def initialize(user, items)
    self.user = user
    self.items = items
  end

  # The JSON needs to be decoded before it sent to the `to_json` method in the home_controller otherwise the JSON will be escaped...
  # What a mess!
  def to_json
    {
      :user => ActiveSupport::JSON.decode(user.to_json(:only => :username, :methods => [:foo, :bar])),
      :items => ActiveSupport::JSON.decode(auctions.to_json(:only => [:id, :name], :methods => [:zim, :gir]))
    }
  end
end

Посмотри Ма! Больше никаких хаков!

Вместо as_json вместо

ActiveRecord:: Serialization # as_json Документы довольно скудны. Здесь кратко:

as_json(options = nil) 
  [show source]

Для получения дополнительной информации о to_json vs as_json см. принятый ответ для Переопределение to_json в Rails 2.3.5

Код без хаков

user.rb

class User < ActiveRecord::Base

  def as_json(options)
    options = { :only => [:username], :methods => [:foo, :bar] }.merge(options)
    super(options)
  end

end

item.rb

class Item < ActiveRecord::Base

  def as_json(options)
    options = { :only => [:id, name], :methods => [:zim, :gir] }.merge(options)
    super(options)
  end

end

home_controller.rb

class HomeController < ApplicationController

  def observe
    @items = Items.find(...)
    respond_to do |format|
      format.js do
        render :json => {
          :user => current_user || {},
          :items => @items
        }
      end
    end
  end

end

ОТВЕТЫ

Ответ 1

EDITED использовать as_json вместо to_json. См. Как переопределить to_json в Rails? для подробного объяснения. Я думаю, что это лучший ответ.

Вы можете отобразить JSON, который вы хотите в контроллере, без необходимости в вспомогательной модели.

def observe
  respond_to do |format|
    format.js do
      render :json => {
        :user => current_user.as_json(:only => [:username], :methods => [:foo, :bar]),
        :items => @items.collect{ |i| i.as_json(:only => [:id, :name], :methods => [:zim, :gir]) }
      }
    end
  end
end

Убедитесь, что для параметра ActiveRecord::Base.include_root_in_json установлено значение false или вы получите атрибут "пользователь" внутри "пользователя". К сожалению, похоже, что массивы не пропускают options до каждого элемента, поэтому необходим collect.

Ответ 2

Есть много новых камней для создания JSON сейчас, для этого случая наиболее подходящим я нашел Jsonify:

https://github.com/bsiggelkow/jsonify https://github.com/bsiggelkow/jsonify-rails

Это позволяет вам создавать сочетание атрибутов и массивов с вашими моделями.

Ответ 3

Рабочий ответ # 2. Чтобы избежать проблемы с "бегством" вашего json, создайте структуру данных вручную, затем вызовите to_json на нее один раз. Это может стать немногословным, но вы можете сделать все это в контроллере или абстрагировать его на отдельные модели как to_hash или что-то в этом роде.

def observe
  respond_to do |format|
    format.js do
      render :json => {
        :user => {:username => current_user.username, :foo => current_user.foo, :bar => current_user.bar},
        :items => @items.collect{ |i| {:id => i.id, :name => i.name, :zim => i.zim, :gir => i.gir} }
      }
    end
  end
end