Class: Grape::Entity

Inherits:
Object
  • Object
show all
Defined in:
lib/grape/entity.rb

Overview

An Entity is a lightweight structure that allows you to easily represent data from your application in a consistent and abstracted way in your API. Entities can also provide documentation for the fields exposed.

Entities are not independent structures, rather, they create representations of other Ruby objects using a number of methods that are convenient for use in an API. Once you’ve defined an Entity, you can use it in your API like this:

Examples:

Entity Definition


module API
  module Entities
    class User < Grape::Entity
      expose :first_name, :last_name, :screen_name, :location
      expose :field, :documentation => {:type => "string", :desc => "describe the field"}
      expose :latest_status, :using => API::Status, :as => :status, :unless => {:collection => true}
      expose :email, :if => {:type => :full}
      expose :new_attribute, :if => {:version => 'v2'}
      expose(:name){|model,options| [model.first_name, model.last_name].join(' ')}
    end
  end
end

Usage in the API Layer


module API
  class Users < Grape::API
    version 'v2'

    desc 'User index', { :object_fields => API::Entities::User.documentation }
    get '/users' do
      @users = User.all
      type = current_user.admin? ? :full : :default
      present @users, :with => API::Entities::User, :type => type
    end
  end
end

Defined Under Namespace

Modules: DSL

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object, options = {}) ⇒ Entity

Returns a new instance of Entity.



289
290
291
 
# File 'lib/grape/entity.rb', line 289

def initialize(object, options = {})
  @object, @options = object, options
end

Instance Attribute Details

#object ⇒ Object (readonly)

Returns the value of attribute object.



44
45
46
 
# File 'lib/grape/entity.rb', line 44

def object
  @object
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



44
45
46
 
# File 'lib/grape/entity.rb', line 44

def options
  @options
end

Class Method Details

.documentation ⇒ Object

Returns a hash, the keys are symbolized references to fields in the entity, the values are document keys in the entity’s documentation key. When calling #docmentation, any exposure without a documentation key will be ignored.



158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/grape/entity.rb', line 158

def self.documentation
  @documentation ||= exposures.inject({}) do |memo, value|
                       unless value[1][:documentation].nil? || value[1][:documentation].empty?
                         memo[value[0]] = value[1][:documentation]
                       end
                       memo
                     end

  if superclass.respond_to? :documentation
    @documentation = superclass.documentation.merge(@documentation)
  end

  @documentation
end

.expose(*args, &block) ⇒ Object

This method is the primary means by which you will declare what attributes should be exposed by the entity.

Parameters:

  • options (Hash) —

    a customizable set of options

Raises:

  • (ArgumentError) 


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/grape/entity.rb', line 125

def self.expose(*args, &block)
  options = args.last.is_a?(Hash) ? args.pop : {}

  if args.size > 1
    raise ArgumentError, "You may not use the :as option on multi-attribute exposures." if options[:as]
    raise ArgumentError, "You may not use block-setting on multi-attribute exposures." if block_given?
  end

  raise ArgumentError, "You may not use block-setting when also using format_with" if block_given? && options[:format_with].respond_to?(:call)

  options[:proc] = block if block_given?

  args.each do |attribute|
    exposures[attribute.to_sym] = options
  end
end

.exposures ⇒ Object

Returns a hash of exposures that have been declared for this Entity or ancestors. The keys are symbolized references to methods on the containing object, the values are the options that were passed into expose.



145
146
147
148
149
150
151
152
153
 
# File 'lib/grape/entity.rb', line 145

def self.exposures
  @exposures ||= {}

  if superclass.respond_to? :exposures
    @exposures = superclass.exposures.merge(@exposures)
  end

  @exposures
end

.format_with(name, &block) ⇒ Object

This allows you to declare a Proc in which exposures can be formatted with. It take a block with an arity of 1 which is passed as the value of the exposed attribute.

Examples:

Formatter declaration


module API
  module Entities
    class User < Grape::Entity
      format_with :timestamp do |date|
        date.strftime('%m/%d/%Y')
      end

      expose :birthday, :last_signed_in, :format_with => :timestamp
    end
  end
end

Formatters are available to all decendants


Grape::Entity.format_with :timestamp do |date|
  date.strftime('%m/%d/%Y')
end

Parameters:

  • name (Symbol) —

    the name of the formatter

  • block (Proc) —

    the block that will interpret the exposed attribute

Raises:

  • (ArgumentError) 


201
202
203
204
 
# File 'lib/grape/entity.rb', line 201

def self.format_with(name, &block)
  raise ArgumentError, "You must pass a block for formatters" unless block_given?
  formatters[name.to_sym] = block
end

.formatters ⇒ Object

Returns a hash of all formatters that are registered for this and it’s ancestors.



207
208
209
210
211
212
213
214
215
 
# File 'lib/grape/entity.rb', line 207

def self.formatters
  @formatters ||= {}

  if superclass.respond_to? :formatters
    @formatters = superclass.formatters.merge(@formatters)
  end

  @formatters
end

.represent(objects, options = {}) ⇒ Object

This convenience method allows you to instantiate one or more entities by passing either a singular or collection of objects. Each object will be initialized with the same options. If an array of objects is passed in, an array of entities will be returned. If a single object is passed in, a single entity will be returned.

  entity. Pass nil or false to represent the object or objects with no

root name even if one is defined for the entity.

Parameters:

  • objects (Object or Array) —

    One or more objects to be represented.

  • options (Hash) (defaults to: {}) —

    Options that will be passed through to each entity representation.

Options Hash (options):

  • :root (String) —

    override the default root name set for the



274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/grape/entity.rb', line 274

def self.represent(objects, options = {})
  inner = if objects.respond_to?(:to_ary)
    objects.to_ary().map{|o| self.new(o, {:collection => true}.merge(options))}
  else
    self.new(objects, options)
  end

  root_element = if options.has_key?(:root)
    options[:root]
  else
    objects.respond_to?(:to_ary) ? @collection_root : @root
  end
  root_element ? { root_element => inner } : inner
end

.root(plural, singular = nil) ⇒ Object

This allows you to set a root element name for your representation.

Examples:

Entity Definition


module API
  module Entities
    class User < Grape::Entity
      root 'users', 'user'
      expose :id
    end
  end
end

Usage in the API Layer


module API
  class Users < Grape::API
    version 'v2'

    # this will render { "users": [ {"id":"1"}, {"id":"2"} ] }
    get '/users' do
      @users = User.all
      present @users, :with => API::Entities::User
    end

    # this will render { "user": {"id":"1"} }
    get '/users/:id' do
      @user = User.find(params[:id])
      present @user, :with => API::Entities::User
    end
  end
end

Parameters:

  • plural (String) —

    the root key to use when representing a collection of objects. If missing or nil, no root key will be used when representing collections of objects.

  • singular (String) (defaults to: nil) —

    the root key to use when representing a single object. If missing or nil, no root key will be used when representing an individual object.



256
257
258
259
 
# File 'lib/grape/entity.rb', line 256

def self.root(plural, singular=nil)
  @collection_root = plural
  @root = singular
end

Instance Method Details

#documentation ⇒ Object 



297
298
299
 
# File 'lib/grape/entity.rb', line 297

def documentation
  self.class.documentation
end

#exposures ⇒ Object 



293
294
295
 
# File 'lib/grape/entity.rb', line 293

def exposures
  self.class.exposures
end

#formatters ⇒ Object 



301
302
303
 
# File 'lib/grape/entity.rb', line 301

def formatters
  self.class.formatters
end

#serializable_hash(runtime_options = {}) ⇒ Object Also known as: as_json

The serializable hash is the Entity’s primary output. It is the transformed hash for the given data model and is used as the basis for serialization to JSON and other formats.

Parameters:

  • runtime_options (Hash) (defaults to: {}) —

    Any options you pass in here will be known to the entity representation, this is where you can trigger things from conditional options etc.



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/grape/entity.rb', line 312

def serializable_hash(runtime_options = {})
  return nil if object.nil?
  opts = options.merge(runtime_options || {})
  exposures.inject({}) do |output, (attribute, exposure_options)|
    if (exposure_options.has_key?(:proc) || object.respond_to?(attribute)) && conditions_met?(exposure_options, opts)
      partial_output = value_for(attribute, opts)
      output[key_for(attribute)] =
        if partial_output.respond_to? :serializable_hash
          partial_output.serializable_hash(runtime_options)
        elsif partial_output.kind_of?(Array) && !partial_output.map {|o| o.respond_to? :serializable_hash}.include?(false)
          partial_output.map {|o| o.serializable_hash}
        else
          partial_output
        end
    end
    output
  end
end