Module: Helio::APIOperations::NestedResource

Included in:
CustomerList
Defined in:
lib/helio/api_operations/nested_resource.rb

Overview

Adds methods to help manipulate a subresource from its parent resource so that it’s possible to do so from a static context (i.e. without a pre-existing collection of subresources on the parent).

For examle, a transfer gains the static methods for reversals so that the methods ‘.create_reversal`, `.retrieve_reversal`, `.update_reversal`, etc. all become available.

Instance Method Summary collapse

Instance Method Details

#nested_resource_class_methods(resource, path: nil, operations: nil) ⇒ Object

Raises:

  • (ArgumentError) 


13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/helio/api_operations/nested_resource.rb', line 13

def nested_resource_class_methods(resource, path: nil, operations: nil)
  path ||= "#{resource}s"
  raise ArgumentError, "operations array required" if operations.nil?

  resource_url_method = :"#{resource}s_url"
  define_singleton_method(resource_url_method) do |id, nested_id = nil|
    url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(path)}"
    url += "/#{CGI.escape(nested_id)}" unless nested_id.nil?
    url
  end

  operations.each do |operation|
    case operation
    when :create
      define_singleton_method(:"create_#{resource}") do |id, params = {}, opts = {}|
        url = send(resource_url_method, id)
        resp, opts = request(:post, url, params, opts)
        Util.convert_to_helio_object(resp.data, opts)
      end
    when :retrieve
      define_singleton_method(:"retrieve_#{resource}") do |id, nested_id, opts = {}|
        url = send(resource_url_method, id, nested_id)
        resp, opts = request(:get, url, {}, opts)
        Util.convert_to_helio_object(resp.data, opts)
      end
    when :update
      define_singleton_method(:"update_#{resource}") do |id, nested_id, params = {}, opts = {}|
        url = send(resource_url_method, id, nested_id)
        resp, opts = request(:post, url, params, opts)
        Util.convert_to_helio_object(resp.data, opts)
      end
    when :delete
      define_singleton_method(:"delete_#{resource}") do |id, nested_id, params = {}, opts = {}|
        url = send(resource_url_method, id, nested_id)
        resp, opts = request(:delete, url, params, opts)
        Util.convert_to_helio_object(resp.data, opts)
      end
    when :list
      define_singleton_method(:"list_#{resource}s") do |id, params = {}, opts = {}|
        url = send(resource_url_method, id)
        resp, opts = request(:get, url, params, opts)
        Util.convert_to_helio_object(resp.data, opts)
      end
    else
      raise ArgumentError, "Unknown operation: #{operation.inspect}"
    end
  end
end