class EasyPost::Resource

Public Class Methods

all(filters={}, api_key=nil) click to toggle source
# File lib/easypost/resource.rb, line 32
def self.all(filters={}, api_key=nil)
  response = EasyPost.make_request(:get, url, api_key, filters)
  return EasyPost::Util.convert_to_easypost_object(response, api_key)
end
class_name() click to toggle source
# File lib/easypost/resource.rb, line 2
def self.class_name
  camel = self.name.split('::')[-1]
  snake = camel[0..0] + camel[1..-1].gsub(/([A-Z])/, '_\1')
  return snake.downcase
end
create(params={}, api_key=nil) click to toggle source
# File lib/easypost/resource.rb, line 43
def self.create(params={}, api_key=nil)
  wrapped_params = {}
  wrapped_params[self.class_name().to_sym] = params
  response = EasyPost.make_request(:post, self.url, api_key, wrapped_params)
  return EasyPost::Util.convert_to_easypost_object(response, api_key)
end
retrieve(id, api_key=nil) click to toggle source
# File lib/easypost/resource.rb, line 37
def self.retrieve(id, api_key=nil)
  instance = self.new(id, api_key)
  instance.refresh
  return instance
end
url() click to toggle source
# File lib/easypost/resource.rb, line 8
def self.url
  if self.class_name == 'resource'
    raise NotImplementedError.new('Resource is an abstract class.  You should perform actions on its subclasses (Address, Shipment, etc.)')
  end
  if(self.class_name[-1..-1] == 's' || self.class_name[-1..-1] == 'h')
    return "/v2/#{CGI.escape(self.class_name.downcase)}es"
  else
    return "/v2/#{CGI.escape(class_name.downcase)}s"
  end
end

Public Instance Methods

delete() click to toggle source
# File lib/easypost/resource.rb, line 50
def delete
  response = EasyPost.make_request(:delete, url, @api_key)
  refresh_from(response, api_key)
  return self
end
refresh() click to toggle source
# File lib/easypost/resource.rb, line 26
def refresh
  response = EasyPost.make_request(:get, url, @api_key, @retrieve_options)
  refresh_from(response, api_key)
  return self
end
save() click to toggle source
# File lib/easypost/resource.rb, line 56
def save
  if @unsaved_values.length > 0
    values = {}
    @unsaved_values.each { |k| values[k] = @values[k] }

    for key in @unsaved_values
      value = values[key]
      if value.is_a?(EasyPost::EasyPostObject)
        values[key] = value.flatten_unsaved
      end
    end

    wrapped_params = {self.class.class_name => values}

    response = EasyPost.make_request(:put, url, @api_key, wrapped_params)
    refresh_from(response, api_key)
  end
  return self
end
url() click to toggle source
# File lib/easypost/resource.rb, line 19
def url
  unless self.id
    raise EasyPost::Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
  end
  return "#{self.class.url}/#{CGI.escape(id)}"
end