class ApiClient::Collection

ApiClient::Collection handle a collection of objects

Public Class Methods

new(attributes, klass) click to toggle source

Initialize a collection of objects based on attributes.

@param [Hash/Array] the hash or array of attributes. @param [Class] klass The class to instantiate the objects. @return [Collection] the collection of objects.

# File lib/api-client/collection.rb, line 8
def initialize(attributes, klass)
  @klass = klass
  update(attributes)
end

Public Instance Methods

pagination_attributes(attributes) click to toggle source

Initialize some variables based on attributes.

@param [Hash] the hash of attributes. @return [Hash] the hash of attributes without pagination attributes.

# File lib/api-client/collection.rb, line 38
def pagination_attributes(attributes)
  @total = attributes.delete("total")
  @total_pages = attributes.delete("total_pages")
  @offset = attributes.delete("offset")
  @_links = attributes.delete("_links")
  attributes
end

update(attributes) click to toggle source

Update the collection of objects based on the new attributes.

@param [Hash/Array] the hash or array of attributes. @return [Collection] the collection of objects.

# File lib/api-client/collection.rb, line 17
def update(attributes)
  self.clear
  @response = attributes
  if attributes.instance_of?(Array)
    attributes.each do |attr|
      self << @klass.new(attr)
    end
  elsif attributes[@klass.name.pluralize.downcase].instance_of?(Array)
    attributes = pagination_attributes(attributes)
    attributes[@klass.name.pluralize.downcase].each do |attr|
      self << @klass.new(attr)
    end
  else
    self << @klass.new(attributes)
  end
end