Ответьте с использованием Devise & attr_accessible в Rails 3 - PullRequest
Новая
       24

Ответьте с использованием Devise & attr_accessible в Rails 3

2 голосов
/ 25 июня 2011

Я создаю API с Rails 3, используя devise для обработки некоторых аутентификаций.

Я обычно использую метод response_with для возврата xml / json для различных ресурсов.

Например, GET /groups.xml будет направлен на 

def index
  respond_with Group.all
end

Это отлично работает на моем сайте для различных ресурсов и возвращает красиво отформатированный json или xml, содержащий все атрибуты каждой группы.

Однако, когда я вызываю GET /users.xml, он отвечает только ограниченным подмножеством атрибутов каждого пользователя. Оказывается, здесь будут возвращены только атрибуты, определенные в attr_assessible - я подозреваю, что это «особенность» устройства, потому что это не относится к любой другой модели.

Может ли кто-нибудь просветить меня?

Редактировать: Это исправлено в Devise 1.4.2. Подробности см. Ниже

Ответы [ 2 ]

1 голос
/ 08 июля 2011

Более старые версии (<1.4.2) Devise выполнили monkeypatch для методов to_json и to_xml, перезаписав параметр: only => [] атрибутами, определенными в attr_accessible. Раздражает.

Это теперь было изменено, так что serializable_hash вместо этого перезаписывается, и любые параметры: only => [: attribute], установленные в to_json или to_xml, сохраняются.

В моем случае я закончил сбор обезьян в to_json и добавил метод api_accessible для всех моделей ActiveRecord. 

class ActiveRecord::Base

  def to_json(options = {}, &block)
    if self.class.respond_to?(:api_attributes)
      super(build_serialize_options(options), &block)
    else
      super(options, &block)
    end
  end

  class << self
    attr_reader :api_attributes
    def api_accessible(*args)
      @api_attributes ||= []
      @api_attributes += args
    end
  end

  private

    def build_serialize_options(options)
      return options if self.class.api_attributes.blank?
      methods = self.class.instance_methods - self.class.attribute_names.map(&:to_sym)
      api_methods = self.class.api_attributes.select { |m| methods.include?(m) }
      api_attrs = self.class.api_attributes - api_methods
      options.merge!(only: api_attrs) if api_attrs.present?
      options.merge!(methods: api_methods) if api_methods.present?
      return options
    end

end

Это означает, что теперь вы можете определить список атрибутов (и методов!), Которые будут отображаться по умолчанию при вызове to_json. Respond_with также использует to_json, поэтому он хорошо работает для API.

Например, user.rb 

class User < ActiveRecord::Base

 devise :database_authenticatable, :registerable, :confirmable,
         :recoverable, :rememberable, :trackable, :validatable

  #Setup accessible (or protected) attributes for your model
  attr_accessible :email,
                  :password,
                  :password_confirmation,
                  :remember_me,
                  :first_name,
                  :last_name,


  api_accessible :id,
                 :name,
                 :created_at,
                 :first_name,
                 :last_name,
                 :some_model_method_also_works
end
1 голос
/ 25 июня 2011

Ваше подозрение правильно .Модуль Devise Authenticatable переопределяет # to_xml и # to_json , чтобы сначала проверить, отвечает ли класс методу # available_attributes , и если это происходит, то вывод ограничентолько те атрибуты, которые возвращает #accessible_attributes.Код от authenticatable.rb находится здесь: 

  %w(to_xml to_json).each do |method|
    class_eval <<-RUBY, __FILE__, __LINE__
      def #{method}(options={})
        if self.class.respond_to?(:accessible_attributes)
          options = { :only => self.class.accessible_attributes.to_a }.merge(options || {})
          super(options)
        else
          super
        end
      end
    RUBY
  end

Вы заметите, что этот код объединяет результат #accessible_attributes с любыми переданными параметрами.Таким образом, вы можете указать опцию : only , например: 

.to_xml(:only => [:field, :field, :field])

Это заменит ограничение, наложенное Devise, и создаст вывод xml, включающий только указанные вами поля.Вам нужно будет включить все поля, которые вы хотите раскрыть, поскольку, как только вы используете: только вы превзойдете нормальную работу.

Я не думаю, что вы сможете продолжать использовать response_with ярлык в вашем контроллере в этом случае, потому что вам нужно будет указать вывод xml напрямую.Возможно, вам придется вернуться к блоку старой школы response_to : 

respond_to do |format|
  format.xml { render :xml => @users.to_xml(:only => [:field, :field, :field]) }
  format.html
end

Как вы уже обнаружили, вы также можете просто добавить дополнительные поля, которые вы хотите открыть, с помощью attr_accessible в классе модели.Однако это приведет к дополнительному побочному эффекту присвоения этих полей массовому назначению, и вы не обязательно захотите этого в этой ситуации.

...