Class: EasyPost::Resource

Inherits:
EasyPostObject show all
Defined in:
lib/easypost/resource.rb

Instance Attribute Summary

Attributes inherited from EasyPostObject

#api_key, #name, #parent, #unsaved_values

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from EasyPostObject

#[], #[]=, #as_json, construct_from, #deconstruct_keys, #each, #id, #id=, #initialize, #inspect, #keys, #refresh_from, #to_hash, #to_json, #to_s, #values

Constructor Details

This class inherits a constructor from EasyPost::EasyPostObject

Class Method Details

.all(filters = {}, api_key = nil) ⇒ Object 



32
33
34
35
 
# 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 ⇒ Object 



2
3
4
5
6
 
# 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) ⇒ Object 



43
44
45
46
47
48
 
# 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) ⇒ Object 



37
38
39
40
41
 
# 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 ⇒ Object 



8
9
10
11
12
13
14
15
16
17
 
# 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

Instance Method Details

#delete ⇒ Object 



50
51
52
53
54
 
# 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 ⇒ Object 



26
27
28
29
30
 
# 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 ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# 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 ⇒ Object 



19
20
21
22
23
24
 
# 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