Class: HelloSign::Resource::ResourceArray

Inherits:
Array
  • Object
show all
Defined in:
lib/hello_sign/resource/resource_array.rb

Overview

Stores an array of HelloSign BaseResource with paging information

Author:

  • hellosign

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hash, key, resource_class) ⇒ type

create a new ResourceArray from a hash

Parameters:

  • hash (Hash) —

    data of the array

  • key (String) —

    key of the hash, point to where resource array data is

  • resource_class (Class) —

    a Resource Class object inherited from BaseResource. Use the created array item from hash



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/hello_sign/resource/resource_array.rb', line 44

def initialize(hash, key, resource_class)
  @page = hash['list_info']['page']
  @num_pages = hash['list_info']['num_pages']
  @num_results = hash['list_info']['num_results']
  @page_size = hash['list_info']['page_size']
  @warnings = hash['warnings'] ? hash['warnings'] : nil

  self << resource_class.new(hash, nil)

  hash[key] && hash[key].each do |resource|
    self << resource_class.new(resource, nil)
  end

end

Instance Attribute Details

#num_pages ⇒ Object (readonly)

Returns the value of attribute num_pages.



34
35
36
 
# File 'lib/hello_sign/resource/resource_array.rb', line 34

def num_pages
  @num_pages
end

#num_results ⇒ Object (readonly)

Returns the value of attribute num_results.



34
35
36
 
# File 'lib/hello_sign/resource/resource_array.rb', line 34

def num_results
  @num_results
end

#page ⇒ Object (readonly)

Returns the value of attribute page.



34
35
36
 
# File 'lib/hello_sign/resource/resource_array.rb', line 34

def page
  @page
end

#page_size ⇒ Object (readonly)

Returns the value of attribute page_size.



34
35
36
 
# File 'lib/hello_sign/resource/resource_array.rb', line 34

def page_size
  @page_size
end

#warnings ⇒ Object (readonly)

Returns the value of attribute warnings.



34
35
36
 
# File 'lib/hello_sign/resource/resource_array.rb', line 34

def warnings
  @warnings
end