Class: BoffinIO::APIResource

Inherits:
BoffinIOObject show all
Defined in:
lib/boffinio/api_resource.rb

Direct Known Subclasses

Customer, Plan, Subscription

Instance Attribute Summary

Attributes inherited from BoffinIOObject

#api_key

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BoffinIOObject

#[], #[]=, #_dump, _load, #as_json, construct_from, #each, #initialize, #inspect, #keys, #refresh_from, #respond_to?, #to_hash, #to_json, #to_s, #values

Constructor Details

This class inherits a constructor from BoffinIO::BoffinIOObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class BoffinIO::BoffinIOObject

Class Method Details

.class_name ⇒ Object 



3
4
5
 
# File 'lib/boffinio/api_resource.rb', line 3

def self.class_name
  self.name.split('::')[-1]
end

.retrieve(id, api_key = nil) ⇒ Object 



27
28
29
30
31
 
# File 'lib/boffinio/api_resource.rb', line 27

def self.retrieve(id, api_key=nil)
  instance = self.new(id, api_key)
  instance.refresh
  instance
end

.url ⇒ Object 



7
8
9
10
11
12
 
# File 'lib/boffinio/api_resource.rb', line 7

def self.url()
  if self == APIResource
    raise NotImplementedError.new('APIResource is an abstract class.  You should perform actions on its subclasses (Charge, Customer, etc.)')
  end
  "/v1/#{CGI.escape(class_name.downcase)}s"
end

Instance Method Details

#refresh ⇒ Object 



21
22
23
24
25
 
# File 'lib/boffinio/api_resource.rb', line 21

def refresh
  response, api_key = BoffinIO.request(:get, url, @api_key, @retrieve_options)
  refresh_from(response, api_key)
  self
end

#url ⇒ Object 



14
15
16
17
18
19
 
# File 'lib/boffinio/api_resource.rb', line 14

def url
  unless id = self['id']
    raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", 'id')
  end
  "#{self.class.url}/#{CGI.escape(id)}"
end