class Octobat::APIResource

Public Class Methods

class_name() click to toggle source
# File lib/octobat/api_resource.rb, line 3
def self.class_name
  self.name.split('::')[-1]
end
retrieve(id, opts={}) click to toggle source
# File lib/octobat/api_resource.rb, line 26
def self.retrieve(id, opts={})
  api_key, headers = Util.parse_opts(opts)
  opts[:api_key] ||= @api_key
              
  instance = self.new(id, opts)
  instance.refresh
  instance
end
url() click to toggle source
# File lib/octobat/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 (Invoice, Customer, etc.)')
  end
  "/#{CGI.escape(class_name.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase)}s"
end

Public Instance Methods

refresh() click to toggle source
# File lib/octobat/api_resource.rb, line 21
def refresh
  response, api_key = Octobat.request(:get, url, @api_key, @retrieve_options, @headers)
  refresh_from(response, api_key)
end
url() click to toggle source
# File lib/octobat/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