Class: BridgeAPI::ApiArray

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/bridge_api/api_array.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(response, api_client, result_mapping) ⇒ ApiArray

Returns a new instance of ApiArray.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/bridge_api/api_array.rb', line 16

def initialize(response, api_client, result_mapping)
  @meta_fields = %w[meta linked]
  @api_client = api_client
  @linked = {}
  @meta = {}
  @extra_meta_fields = []
  pattern = %r{.*(/api/.*)}
  path = response.env.url
  matches = pattern.match(path.to_s)
  mapping = nil
  if matches
    mapping_exists = result_mapping.key?(matches[1])
    mapping = result_mapping[matches[1]] if mapping_exists
  end
  @extra_meta_fields.concat(mapping[:meta]) unless mapping.nil?
  case response.status
  when *((200..206).to_a + [302])
    apply_response_metadata(response)
    @members = get_response_content(response)
  else
    set_response_vars(response)
  end
end

Instance Attribute Details

#body ⇒ Object (readonly)

Returns the value of attribute body.



10
11
12
 
# File 'lib/bridge_api/api_array.rb', line 10

def body
  @body
end

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



10
11
12
 
# File 'lib/bridge_api/api_array.rb', line 10

def errors
  @errors
end

#headers ⇒ Object (readonly)

Returns the value of attribute headers.



10
11
12
 
# File 'lib/bridge_api/api_array.rb', line 10

def headers
  @headers
end

#linked ⇒ Object (readonly)

Returns the value of attribute linked.



10
11
12
 
# File 'lib/bridge_api/api_array.rb', line 10

def linked
  @linked
end

#members ⇒ Object (readonly)

Returns the value of attribute members.



10
11
12
 
# File 'lib/bridge_api/api_array.rb', line 10

def members
  @members
end

#meta ⇒ Object (readonly)

Returns the value of attribute meta.



10
11
12
 
# File 'lib/bridge_api/api_array.rb', line 10

def meta
  @meta
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



10
11
12
 
# File 'lib/bridge_api/api_array.rb', line 10

def status
  @status
end

Class Method Details

.process_response(response, api_client, result_mapping) ⇒ Object 



12
13
14
 
# File 'lib/bridge_api/api_array.rb', line 12

def self.process_response(response, api_client, result_mapping)
  ApiArray.new(response, api_client, result_mapping)
end

Instance Method Details

#[](i) ⇒ Object 



55
56
57
 
# File 'lib/bridge_api/api_array.rb', line 55

def [](i)
  @members[i]
end

#all_pages! ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/bridge_api/api_array.rb', line 86

def all_pages!
  if pages?
    response = get_page(@next_page)
    apply_response_metadata(response)
    @members.concat(get_response_content(response))
    while @next_page
      response = get_page(@next_page)
      apply_response_metadata(response)
      @members.concat(get_response_content(response))
    end
  end
  self
end

#each ⇒ Object 



63
64
65
 
# File 'lib/bridge_api/api_array.rb', line 63

def each
  @members.each { |member| yield(member) }
end

#each_page {|@members, @linked, @meta| ... } ⇒ Object

Yields:



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/bridge_api/api_array.rb', line 75

def each_page
  yield(@members, @linked, @meta)
  while @next_page
    response = get_page(@next_page)
    apply_response_metadata(response, false)
    @members = get_response_content(response)
    yield(@members, @linked, @meta)
  end
  @link_hash = {}
end

#last ⇒ Object 



59
60
61
 
# File 'lib/bridge_api/api_array.rb', line 59

def last
  @members.last
end

#length ⇒ Object 



51
52
53
 
# File 'lib/bridge_api/api_array.rb', line 51

def length
  @members.length
end

#next_page ⇒ Object 



71
72
73
 
# File 'lib/bridge_api/api_array.rb', line 71

def next_page
  load_page(@next_page)
end

#pages? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/bridge_api/api_array.rb', line 67

def pages?
  !@next_page.nil?
end

#set_response_vars(response) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/bridge_api/api_array.rb', line 40

def set_response_vars(response)
  @headers = response.headers
  @status = response.status
  @body = response.body
  @errors = begin
              response.body['errors']
            rescue StandardError
              []
            end
end