class BoffinIO::APIResource

Public Class Methods

class_name() click to toggle source
# File lib/boffinio/api_resource.rb, line 3
def self.class_name
  self.name.split('::')[-1]
end
retrieve(id, api_key=nil) click to toggle source
# 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() click to toggle source
# 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

Public Instance Methods

refresh() click to toggle source
# 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() click to toggle source
# 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