easypost 2.1.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,15 +1,7 @@
1
1
  ---
2
- !binary "U0hBMQ==":
3
- metadata.gz: !binary |-
4
- ZDRiZmUzZDYxMmEzNmNlNWRhNjMxNzZkYjdhMzQ4MGZjZTMxOTM5Mw==
5
- data.tar.gz: !binary |-
6
- ZTcxNzNjN2ZhMzYxODA3NmFhMGY5NzQ4NTg2ZTk5NmNjOTAwODI5ZA==
2
+ SHA1:
3
+ metadata.gz: 8deaad3af93387997d1bd5b4c3112ec58628a6bb
4
+ data.tar.gz: 16fef7e30f4b5de916e6057ef31b901a6d9c47ea
7
5
  SHA512:
8
- metadata.gz: !binary |-
9
- MzlmYzQ1YjZkMjQ0YWMzYTVjMzU5ZDI4NzJhYzAzODcxYmQ0MDBiMDVjYTAw
10
- OTQ2NjE0YjQwMzcyZmY4ZTkyMzcwYjMxODBjM2I3Y2ZhMmQ0NzAzMThhOWNm
11
- OTEzYjVkNzMzNmFmZTMyNmMyODBjNjJiYzRkZmM3N2Q0NDcxNjU=
12
- data.tar.gz: !binary |-
13
- NjNlMmY0ZmI5MDdjNWI1ODM0MDBkZTBhMjQ0OTk3NDhkMjIxNTNlMTZhOWQ0
14
- OGVlYjVlYjRkMjhkMThiMDZlMmRhZmM4NTIxMWJmMWI4NTc1ODRmMDNjMzk1
15
- ODExMzE1MmE0OWMxOTY4ZWRmMTg3YThiOWE4NGE2NWY1Mzk5ZGU=
6
+ metadata.gz: 6e3442b420f010160a89409c46893793949b993510d9807bdea7a5faed1eb806ee5ed7895d81c2fee6cc599090ffce3c4f2c0104ee49ec0ec2af1517b310bf0b
7
+ data.tar.gz: b07d522882ee05908622130530b9ae2820c65f79be71887ad380499bc7e72be62065376888f0ccb68ef9d79c2995ea1088d68b6ebb606d136e6295bbe7e39718
data/.gitignore CHANGED
@@ -25,4 +25,5 @@ doc/
25
25
  Icon
26
26
  ._*
27
27
  .Spotlight-V100
28
- .Trashes
28
+ .Trashes
29
+ vendor/
data/CHANGELOG CHANGED
@@ -1,3 +1,86 @@
1
+ === 2.2.0 2016-07-26
2
+
3
+ * Added standalone Insurance model
4
+
5
+
6
+ === 2.1.11 2016-02-04
7
+
8
+ * Allowed user creation for top-level users
9
+
10
+
11
+ === 2.1.10 2015-12-23
12
+
13
+ * Added verify and verify_strict params to Address.create
14
+ * Added Tracker.create_list and Tracker.all_updated for working with large
15
+ numbers of Trackers.
16
+
17
+
18
+ === 2.1.9 2015-11-04
19
+
20
+ * Added new tests for Tracker.all
21
+ * Updated some old examples
22
+
23
+
24
+ === 2.1.8 2015-10-21
25
+
26
+ * Added Cancel method for Pickups (thanks Ramie Blatt!)
27
+
28
+
29
+ === 2.1.7 2015-10-05
30
+
31
+ * Fixed Address.create_and_verify and changed how errors are raised (thanks Dimitri Roche!)
32
+ * Require newer version of the multi_json package
33
+
34
+
35
+ === 2.1.6 2015-06-10
36
+
37
+ * Added Address message accessor for backwards compatability
38
+
39
+
40
+ === 2.1.5 2015-06-10
41
+
42
+ * Removed Address.message
43
+
44
+
45
+ === 2.1.4 2015-06-03
46
+
47
+ * Add Printer and PrintJob resources.
48
+
49
+
50
+ === 2.1.3 2015-04-30
51
+
52
+ * Bux fix, EasyPost::Errors no longer break with a nil json body.
53
+
54
+
55
+ === 2.1.2 2015-04-29
56
+
57
+ * EasyPost::Errors now correctly parse field errors and error codes.
58
+
59
+
60
+ === 2.1.1 2015-04-15
61
+
62
+ * CarrierAccount will now correctly save in-place modifications to credentials
63
+ * Nested variables should now be saved correctly across all models
64
+ * Fixed version numbering confusion (the previous version was 2.0.15, not 2.1.0)
65
+
66
+
67
+ === 2.0.15 2015-04-15
68
+
69
+ * Added tracker to shipment buy response
70
+ * Updated tracker tests
71
+
72
+
73
+ === 2.0.14 2015-04-15
74
+
75
+ * Added User and CarrierAccount models with CRUD functionality
76
+
77
+
78
+ === 2.0.13 2014-10-30
79
+
80
+ * Added Pickup, PickupRate resources.
81
+ * Added ability to pass api_key to a few resources that were missing it.
82
+
83
+
1
84
  === 2.0.12 2014-07-07
2
85
 
3
86
  * Added Item, Container, and Order resources.
data/README.md CHANGED
@@ -1,5 +1,8 @@
1
1
  # EasyPost Ruby Client Library
2
2
 
3
+ [<img src="https://circleci.com/gh/EasyPost/easypost-ruby.png?circle-token=80adb5236ed1fdce20810b055af79c63c3d5796b">](https://circleci.com/gh/EasyPost/easypost-ruby)
4
+
5
+
3
6
  EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com
4
7
 
5
8
  Installation
@@ -25,27 +28,27 @@ require 'easypost'
25
28
  EasyPost.api_key = 'cueqNZUb3ldeWTNX7MU3Mel8UXtaAMUi'
26
29
 
27
30
  to_address = EasyPost::Address.create(
28
- :name => 'Sawyer Bateman',
29
- :street1 => '1A Larkspur Cres.',
30
- :city => 'St. Albert',
31
- :state => 'AB',
32
- :zip => 't8n2m4',
33
- :country => 'CA',
34
- :phone => '780-273-8374'
31
+ :name => 'Dr. Steve Brule',
32
+ :street1 => '179 N Harbor Dr',
33
+ :city => 'Redondo Beach',
34
+ :state => 'CA',
35
+ :zip => '90277',
36
+ :country => 'US',
37
+ :phone => '310-808-5243'
35
38
  )
36
39
  from_address = EasyPost::Address.create(
37
- :company => 'Simpler Postage Inc',
38
- :street1 => '388 Townsend Street',
39
- :street2 => 'Apt 20',
40
+ :company => 'EasyPost',
41
+ :street1 => '118 2nd Street',
42
+ :street2 => '4th Floor',
40
43
  :city => 'San Francisco',
41
44
  :state => 'CA',
42
- :zip => '94107',
45
+ :zip => '94105',
43
46
  :phone => '415-456-7890'
44
47
  )
45
48
 
46
49
  parcel = EasyPost::Parcel.create(
47
50
  :width => 15.2,
48
- :length => 18,
51
+ :length => 18,
49
52
  :height => 9.5,
50
53
  :weight => 35.1
51
54
  )
@@ -82,6 +85,10 @@ shipment.buy(
82
85
  :rate => shipment.lowest_rate
83
86
  )
84
87
 
88
+ shipment.insure(amount: 100)
89
+
90
+ puts shipment.insurance
91
+
85
92
  puts shipment.postage_label.label_url
86
93
 
87
94
  ```
data/VERSION CHANGED
@@ -1 +1 @@
1
- 2.1.0
1
+ 2.2.0
data/easypost.gemspec CHANGED
@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
19
19
  spec.require_paths = ['lib']
20
20
 
21
21
  spec.add_dependency 'rest-client', '~> 1.4'
22
- spec.add_dependency 'multi_json', '>= 1.0.4', '< 2'
22
+ spec.add_dependency 'multi_json', '>= 1.3.0'
23
23
  spec.add_development_dependency 'bundler', '~> 1.7'
24
24
  spec.add_development_dependency 'rake', '~> 10.0'
25
- spec.add_development_dependency 'rspec', '~> 2.13.0'
25
+ spec.add_development_dependency 'rspec', '~> 2.13'
26
26
  end
@@ -1,5 +1,26 @@
1
1
  module EasyPost
2
2
  class Address < Resource
3
+ attr_accessor :message # Backwards compatibility
4
+
5
+ def self.create(params={}, api_key=nil)
6
+ url = self.url
7
+
8
+ if params[:verify] || params[:verify_strict]
9
+ verify = params.delete(:verify) || []
10
+ verify_strict = params.delete(:verify_strict) || []
11
+
12
+ url += "?"
13
+ verify.each do |verification|
14
+ url += "verify[]=#{verification}&"
15
+ end
16
+ verify_strict.each do |verification|
17
+ url += "verify_strict[]=#{verification}&"
18
+ end
19
+ end
20
+
21
+ response, api_key = EasyPost.request(:post, url, api_key, {address: params})
22
+ return Util.convert_to_easypost_object(response, api_key)
23
+ end
3
24
 
4
25
  def self.create_and_verify(params={}, carrier=nil, api_key=nil)
5
26
  wrapped_params = {}
@@ -19,20 +40,19 @@ module EasyPost
19
40
  end
20
41
 
21
42
  def verify(params={}, carrier=nil)
22
- response, api_key = EasyPost.request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
43
+ begin
44
+ response, api_key = EasyPost.request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
45
+ rescue
46
+ raise Error.new("Unable to verify address.")
47
+ end
23
48
 
24
49
  if response.has_key?(:address)
25
- if response.has_key?(:message)
26
- response[:address][:message] = response[:message]
27
- end
28
- verified_address = EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
29
- return verified_address
50
+ return EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
30
51
  else
31
52
  raise Error.new("Unable to verify address.")
32
53
  end
33
54
 
34
55
  return self
35
56
  end
36
-
37
57
  end
38
58
  end
@@ -0,0 +1,8 @@
1
+ module EasyPost
2
+ class CarrierAccount < Resource
3
+ def self.types
4
+ response, api_key = EasyPost.request(:get, "/carrier_types", @api_key)
5
+ return Util.convert_to_easypost_object(response, api_key)
6
+ end
7
+ end
8
+ end
@@ -5,25 +5,35 @@ module EasyPost
5
5
  attr_reader :http_body
6
6
  attr_reader :json_body
7
7
  attr_reader :param
8
+ attr_reader :code
9
+ attr_reader :errors
8
10
 
9
- def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
11
+ def initialize(message=nil, http_status=nil, http_body=nil, json_body={})
10
12
  @message = message
11
13
  @http_status = http_status
12
14
  @http_body = http_body
13
15
  @json_body = json_body
14
16
 
15
- begin
16
- @param = @json_body[:error][:param]
17
- rescue
18
- @param = nil
19
- end
17
+ @param = @json_body.fetch(:error, {}).fetch(:param, nil)
18
+ @code = @json_body.fetch(:error, {}).fetch(:code, nil)
19
+ @errors = @json_body.fetch(:error, {}).fetch(:errors, nil)
20
20
 
21
21
  super(message)
22
22
  end
23
23
 
24
24
  def to_s
25
- status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
26
- "#{status_string}#{@message}"
25
+ s = "#{@code} (#{@http_status}): #{@message}";
26
+ if @errors
27
+ s += "\nField errors:\n"
28
+ @errors.each do |field_error|
29
+ field_error.each do |k, v|
30
+ s += " #{k}: #{v}\n"
31
+ end
32
+ s += "\n"
33
+ end
34
+ end
35
+ s
27
36
  end
28
37
  end
29
38
  end
39
+
@@ -0,0 +1,4 @@
1
+ module EasyPost
2
+ class Insurance < Resource
3
+ end
4
+ end
@@ -2,19 +2,21 @@ module EasyPost
2
2
  class EasyPostObject
3
3
  include Enumerable
4
4
 
5
- attr_accessor :api_key
5
+ attr_accessor :parent, :name, :api_key, :unsaved_values
6
6
  @@immutable_values = Set.new([:api_key, :id])
7
7
 
8
- def initialize(id=nil, api_key=nil)
8
+ def initialize(id=nil, api_key=nil, parent=nil, name=nil)
9
9
  @api_key = api_key
10
10
  @values = {}
11
11
  @unsaved_values = Set.new
12
12
  @transient_values = Set.new
13
+ @parent = parent
14
+ @name = name
13
15
  self.id = id if id
14
16
  end
15
17
 
16
- def self.construct_from(values, api_key=nil)
17
- obj = self.new(values[:id], api_key)
18
+ def self.construct_from(values, api_key=nil, parent=nil, name=nil)
19
+ obj = self.new(values[:id], api_key, parent, name)
18
20
  obj.refresh_from(values, api_key)
19
21
  obj
20
22
  end
@@ -32,13 +34,13 @@ module EasyPost
32
34
  @api_key = api_key
33
35
 
34
36
  added = Set.new(values.keys - @values.keys)
35
-
37
+
36
38
  instance_eval do
37
39
  add_accessors(added)
38
40
  end
39
-
41
+
40
42
  values.each do |k, v|
41
- @values[k] = Util.convert_to_easypost_object(v, api_key)
43
+ @values[k] = Util.convert_to_easypost_object(v, api_key, self, k)
42
44
  @transient_values.delete(k)
43
45
  @unsaved_values.delete(k)
44
46
  end
@@ -87,6 +89,21 @@ module EasyPost
87
89
 
88
90
  protected
89
91
 
92
+ def flatten_unsaved
93
+ values = {}
94
+ for key in @unsaved_values
95
+ value = @values[key]
96
+
97
+ values[key] = value
98
+
99
+ if value.is_a?(EasyPost::EasyPostObject)
100
+ values[key] = flatten_unsaved(value)
101
+ end
102
+ end
103
+
104
+ return values
105
+ end
106
+
90
107
  def metaclass
91
108
  class << self; self; end
92
109
  end
@@ -111,6 +128,18 @@ module EasyPost
111
128
  define_method(k_eq) do |v|
112
129
  @values[k] = v
113
130
  @unsaved_values.add(k)
131
+
132
+ cur = self
133
+ cur_parent = self.parent
134
+ param = {}
135
+ while cur_parent
136
+ if cur.name
137
+ cur_parent.unsaved_values.add(cur.name)
138
+ end
139
+
140
+ cur = cur_parent
141
+ cur_parent = cur.parent
142
+ end
114
143
  end
115
144
  end
116
145
  end
@@ -15,5 +15,11 @@ module EasyPost
15
15
  return self
16
16
  end
17
17
 
18
+ def cancel(params={})
19
+ response, api_key = EasyPost.request(:post, url + '/cancel', @api_key, params)
20
+ self.refresh_from(response, @api_key, true)
21
+
22
+ return self
23
+ end
18
24
  end
19
25
  end
@@ -0,0 +1,6 @@
1
+ module EasyPost
2
+ class PrintJob < Resource
3
+ end
4
+ end
5
+
6
+
@@ -0,0 +1,28 @@
1
+ module EasyPost
2
+ class Printer < Resource
3
+
4
+ def job
5
+ response, api_key = EasyPost.request(
6
+ :get, url + '/jobs', @api_key
7
+ )
8
+ return EasyPost::Util::convert_to_easypost_object(response, api_key)
9
+ end
10
+
11
+ def print(params={})
12
+ if params.instance_of?(EasyPost::PostageLabel)
13
+ temp = params.clone
14
+ params = {}
15
+ params[:postage_label] = temp
16
+ end
17
+
18
+ response, api_key = EasyPost.request(
19
+ :post, url + '/print_postage_label', @api_key, params
20
+ )
21
+ return true
22
+ rescue
23
+ return false
24
+ end
25
+
26
+ end
27
+ end
28
+
@@ -58,7 +58,17 @@ module EasyPost
58
58
  if @unsaved_values.length > 0
59
59
  values = {}
60
60
  @unsaved_values.each { |k| values[k] = @values[k] }
61
- response, api_key = EasyPost.request(:post, url, @api_key, values)
61
+
62
+ for key in @unsaved_values
63
+ value = values[key]
64
+ if value.is_a?(EasyPost::EasyPostObject)
65
+ values[key] = value.flatten_unsaved
66
+ end
67
+ end
68
+
69
+ wrapped_params = {self.class.class_name => values}
70
+
71
+ response, api_key = EasyPost.request(:put, url, @api_key, wrapped_params)
62
72
  refresh_from(response, api_key)
63
73
  end
64
74
  return self
@@ -41,6 +41,13 @@ module EasyPost
41
41
  return self
42
42
  end
43
43
 
44
+ def print(params={})
45
+ if params.instance_of?(EasyPost::Printer)
46
+ return params.print(self.postage_label)
47
+ end
48
+ return false
49
+ end
50
+
44
51
  def label(params={})
45
52
  if params.is_a?(String)
46
53
  temp = params.clone
@@ -1,5 +1,15 @@
1
1
  module EasyPost
2
2
  class Tracker < Resource
3
+ def self.create_list(params={}, api_key=nil)
4
+ url = self.url + '/create_list'
5
+ response, api_key = EasyPost.request(:post, url, api_key, params)
6
+ return true
7
+ end
3
8
 
9
+ def self.all_updated(params={}, api_key=nil)
10
+ url = self.url + '/all_updated'
11
+ response, api_key = EasyPost.request(:get, url, api_key, params)
12
+ return Util.convert_to_easypost_object(response, api_key)
13
+ end
4
14
  end
5
15
  end
@@ -0,0 +1,49 @@
1
+ module EasyPost
2
+ class User < Resource
3
+ def self.create(params={}, api_key=nil)
4
+ wrapped_params = {}
5
+ wrapped_params[self.class_name().to_sym] = params
6
+ response, api_key = EasyPost.request(:post, self.url, api_key, wrapped_params, {}, false)
7
+ return Util.convert_to_easypost_object(response, api_key)
8
+ end
9
+
10
+ def save
11
+ if @unsaved_values.length > 0
12
+ values = {}
13
+ @unsaved_values.each { |k| values[k] = @values[k] }
14
+
15
+ wrapped_params = {user: values}
16
+
17
+ response, api_key = EasyPost.request(:put, url, @api_key, wrapped_params)
18
+ refresh_from(response, api_key)
19
+ end
20
+ return self
21
+ end
22
+
23
+ def self.retrieve_me
24
+ self.all
25
+ end
26
+
27
+ def self.all_api_keys
28
+ response, api_key = EasyPost.request(:get, "/api_keys", @api_key)
29
+ return Util.convert_to_easypost_object(response, api_key)
30
+ end
31
+
32
+ def api_keys
33
+ api_keys = EasyPost::User.all_api_keys
34
+
35
+ if api_keys.id == self.id
36
+ my_api_keys = api_keys.keys
37
+ else
38
+ for child in api_keys.children
39
+ if child.id == self.id
40
+ my_api_keys = child.keys
41
+ break
42
+ end
43
+ end
44
+ end
45
+
46
+ my_api_keys
47
+ end
48
+ end
49
+ end
data/lib/easypost/util.rb CHANGED
@@ -15,8 +15,9 @@ module EasyPost
15
15
  end
16
16
  end
17
17
 
18
- def self.convert_to_easypost_object(response, api_key)
19
- types = { 'Address' => Address,
18
+ def self.convert_to_easypost_object(response, api_key, parent=nil, name=nil)
19
+ types = {
20
+ 'Address' => Address,
20
21
  'ScanForm' => ScanForm,
21
22
  'CustomsItem' => CustomsItem,
22
23
  'CustomsInfo' => CustomsInfo,
@@ -28,13 +29,20 @@ module EasyPost
28
29
  'Batch' => Batch,
29
30
  'Tracker' => Tracker,
30
31
  'Item' => Item,
32
+ 'Insurance' => Insurance,
31
33
  'Container' => Container,
32
34
  'Order' => Order,
33
35
  'Pickup' => Pickup,
34
36
  'PickupRate' => PickupRate,
35
- 'PostageLabel' => PostageLabel }
37
+ 'PostageLabel' => PostageLabel,
38
+ 'Printer' => Printer,
39
+ 'PrintJob' => PrintJob,
40
+ 'CarrierAccount' => CarrierAccount,
41
+ 'User' => User
42
+ }
36
43
 
37
- prefixes = { 'adr' => Address,
44
+ prefixes = {
45
+ 'adr' => Address,
38
46
  'sf' => ScanForm,
39
47
  'cstitem' => CustomsItem,
40
48
  'cstinfo' => CustomsInfo,
@@ -46,15 +54,21 @@ module EasyPost
46
54
  'batch' => Batch,
47
55
  'trk' => Tracker,
48
56
  'item' => Item,
57
+ 'ins' => Insurance,
49
58
  'container' => Container,
50
59
  'order' => Order,
51
60
  'pickup' => Pickup,
52
61
  'pickuprate' => PickupRate,
53
- 'pl' => PostageLabel }
62
+ 'pl' => PostageLabel,
63
+ 'printer' => Printer,
64
+ 'printjob' => PrintJob,
65
+ 'ca' => CarrierAccount,
66
+ 'user' => User
67
+ }
54
68
 
55
69
  case response
56
70
  when Array
57
- return response.map { |i| convert_to_easypost_object(i, api_key) }
71
+ return response.map { |i| convert_to_easypost_object(i, api_key, parent) }
58
72
  when Hash
59
73
  if cls_name = response[:object]
60
74
  cls = types[cls_name]
@@ -65,7 +79,7 @@ module EasyPost
65
79
  end
66
80
 
67
81
  cls ||= EasyPostObject
68
- return cls.construct_from(response, api_key)
82
+ return cls.construct_from(response, api_key, parent, name)
69
83
  else
70
84
  return response
71
85
  end
@@ -1,3 +1,3 @@
1
1
  module EasyPost
2
- VERSION = File.open(File.expand_path("../../../VERSION", __FILE__)).read()
2
+ VERSION = File.open(File.expand_path("../../../VERSION", __FILE__)).read().strip
3
3
  end
data/lib/easypost.rb CHANGED
@@ -18,6 +18,7 @@ require 'easypost/rate'
18
18
  require 'easypost/postage_label'
19
19
  require 'easypost/scan_form'
20
20
  require 'easypost/refund'
21
+ require 'easypost/insurance'
21
22
  require 'easypost/event'
22
23
  require 'easypost/batch'
23
24
  require 'easypost/tracker'
@@ -26,6 +27,10 @@ require 'easypost/container'
26
27
  require 'easypost/order'
27
28
  require 'easypost/pickup'
28
29
  require 'easypost/pickup_rate'
30
+ require 'easypost/printer'
31
+ require 'easypost/print_job'
32
+ require 'easypost/carrier_account'
33
+ require 'easypost/user'
29
34
 
30
35
  require 'easypost/error'
31
36
 
@@ -68,7 +73,8 @@ module EasyPost
68
73
  @@http_config ||= {
69
74
  timeout: 60,
70
75
  open_timeout: 30,
71
- verify_ssl: false
76
+ verify_ssl: false,
77
+ ssl_version: "TLSv1",
72
78
  }
73
79
  end
74
80
 
@@ -76,9 +82,11 @@ module EasyPost
76
82
  self.http_config.merge!(http_config_params)
77
83
  end
78
84
 
79
- def self.request(method, url, api_key, params={}, headers={})
85
+ def self.request(method, url, api_key, params={}, headers={}, api_key_required=true)
80
86
  api_key ||= @@api_key
81
- raise Error.new('No API key provided.') unless api_key
87
+ if api_key_required
88
+ raise Error.new('No API key provided.') unless api_key
89
+ end
82
90
 
83
91
  params = Util.objects_to_ids(params)
84
92
  url = self.api_url(url)