Class: RemoteResource::Collection

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/remote_resource/collection.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(resource_klass, resources_collection, options = {}) ⇒ Collection

Returns a new instance of Collection.



10
11
12
13
14
 
# File 'lib/remote_resource/collection.rb', line 10

def initialize(resource_klass, resources_collection, options = {})
  @resource_klass       = resource_klass
  @resources_collection = resources_collection
  @options              = options
end

Instance Attribute Details

#last_request ⇒ Object

Returns the value of attribute last_request.



6
7
8
 
# File 'lib/remote_resource/collection.rb', line 6

def last_request
  @last_request
end

#last_response ⇒ Object

Returns the value of attribute last_response.



6
7
8
 
# File 'lib/remote_resource/collection.rb', line 6

def last_response
  @last_response
end

#meta ⇒ Object

Returns the value of attribute meta.



6
7
8
 
# File 'lib/remote_resource/collection.rb', line 6

def meta
  @meta
end

#resource_klass ⇒ Object (readonly)

Returns the value of attribute resource_klass.



5
6
7
 
# File 'lib/remote_resource/collection.rb', line 5

def resource_klass
  @resource_klass
end

#resources_collection ⇒ Object (readonly)

Returns the value of attribute resources_collection.



5
6
7
 
# File 'lib/remote_resource/collection.rb', line 5

def resources_collection
  @resources_collection
end

Instance Method Details

#_response ⇒ Object 



51
52
53
 
# File 'lib/remote_resource/collection.rb', line 51

def _response
  warn '[DEPRECATION] `._response` is deprecated. Please use `.last_response` instead.'
end

#each(&block) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/remote_resource/collection.rb', line 16

def each(&block)
  return nil if !resources_collection.is_a?(Array)

  if defined?(@collection)
    @collection.each(&block)
  else
    @collection = []
    resources_collection.each do |element|
      record = resource_klass.new(element.merge(@options))
      @collection.push(record)
    end
    @collection.each(&block)
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/remote_resource/collection.rb', line 31

def empty?
  resources_collection.blank?
end

#success? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/remote_resource/collection.rb', line 35

def success?
  last_response.success?
end