easypost 2.1.1 → 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,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1d1cc5a734e2706f3cbeba923df0240405b0e0df
4
- data.tar.gz: fe44d1b81b62583f286e045e385cbdeab0818581
3
+ metadata.gz: 8deaad3af93387997d1bd5b4c3112ec58628a6bb
4
+ data.tar.gz: 16fef7e30f4b5de916e6057ef31b901a6d9c47ea
5
5
  SHA512:
6
- metadata.gz: 4afc2b2702cf588aed58d28413cd6b31ea74ce1ca08a8e1527f1ebc71f7299ca596af96bdc2020542c625fd1809d99d144becff5d26c80a1688d73374ea8c9fc
7
- data.tar.gz: d5f90684e2740529028f2e32431c882f939db7ea788849d6e0054865078a2dfb4d9dcdeb74010ad99a1576ca068a64bf797bb0fa5d4387c029c8095634d39156
6
+ metadata.gz: 6e3442b420f010160a89409c46893793949b993510d9807bdea7a5faed1eb806ee5ed7895d81c2fee6cc599090ffce3c4f2c0104ee49ec0ec2af1517b310bf0b
7
+ data.tar.gz: b07d522882ee05908622130530b9ae2820c65f79be71887ad380499bc7e72be62065376888f0ccb68ef9d79c2995ea1088d68b6ebb606d136e6295bbe7e39718
data/CHANGELOG CHANGED
@@ -1,3 +1,62 @@
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
+
1
60
  === 2.1.1 2015-04-15
2
61
 
3
62
  * CarrierAccount will now correctly save in-place modifications to credentials
data/README.md CHANGED
@@ -28,27 +28,27 @@ require 'easypost'
28
28
  EasyPost.api_key = 'cueqNZUb3ldeWTNX7MU3Mel8UXtaAMUi'
29
29
 
30
30
  to_address = EasyPost::Address.create(
31
- :name => 'Sawyer Bateman',
32
- :street1 => '1A Larkspur Cres.',
33
- :city => 'St. Albert',
34
- :state => 'AB',
35
- :zip => 't8n2m4',
36
- :country => 'CA',
37
- :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'
38
38
  )
39
39
  from_address = EasyPost::Address.create(
40
- :company => 'Simpler Postage Inc',
41
- :street1 => '388 Townsend Street',
42
- :street2 => 'Apt 20',
40
+ :company => 'EasyPost',
41
+ :street1 => '118 2nd Street',
42
+ :street2 => '4th Floor',
43
43
  :city => 'San Francisco',
44
44
  :state => 'CA',
45
- :zip => '94107',
45
+ :zip => '94105',
46
46
  :phone => '415-456-7890'
47
47
  )
48
48
 
49
49
  parcel = EasyPost::Parcel.create(
50
50
  :width => 15.2,
51
- :length => 18,
51
+ :length => 18,
52
52
  :height => 9.5,
53
53
  :weight => 35.1
54
54
  )
@@ -85,6 +85,10 @@ shipment.buy(
85
85
  :rate => shipment.lowest_rate
86
86
  )
87
87
 
88
+ shipment.insure(amount: 100)
89
+
90
+ puts shipment.insurance
91
+
88
92
  puts shipment.postage_label.label_url
89
93
 
90
94
  ```
data/VERSION CHANGED
@@ -1 +1 @@
1
- 2.1.1
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 = {}
@@ -14,7 +35,7 @@ module EasyPost
14
35
  verified_address = EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
15
36
  return verified_address
16
37
  else
17
- raise_verification_failure
38
+ raise Error.new("Unable to verify address.")
18
39
  end
19
40
  end
20
41
 
@@ -22,24 +43,16 @@ module EasyPost
22
43
  begin
23
44
  response, api_key = EasyPost.request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
24
45
  rescue
25
- raise_verification_failure
46
+ raise Error.new("Unable to verify address.")
26
47
  end
27
48
 
28
49
  if response.has_key?(:address)
29
- if response.has_key?(:message)
30
- response[:address][:message] = response[:message]
31
- end
32
- verified_address = EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
33
- return verified_address
50
+ return EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
34
51
  else
35
- raise_verification_failure
52
+ raise Error.new("Unable to verify address.")
36
53
  end
37
54
 
38
55
  return self
39
56
  end
40
-
41
- def raise_verification_failure
42
- raise Error.new("Unable to verify address.")
43
- end
44
57
  end
45
58
  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
@@ -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
+
@@ -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
data/lib/easypost/user.rb CHANGED
@@ -1,5 +1,12 @@
1
1
  module EasyPost
2
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
+
3
10
  def save
4
11
  if @unsaved_values.length > 0
5
12
  values = {}
data/lib/easypost/util.rb CHANGED
@@ -16,7 +16,8 @@ module EasyPost
16
16
  end
17
17
 
18
18
  def self.convert_to_easypost_object(response, api_key, parent=nil, name=nil)
19
- types = { 'Address' => Address,
19
+ types = {
20
+ 'Address' => Address,
20
21
  'ScanForm' => ScanForm,
21
22
  'CustomsItem' => CustomsItem,
22
23
  'CustomsInfo' => CustomsInfo,
@@ -28,15 +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
37
  'PostageLabel' => PostageLabel,
38
+ 'Printer' => Printer,
39
+ 'PrintJob' => PrintJob,
36
40
  'CarrierAccount' => CarrierAccount,
37
- 'User' => User }
41
+ 'User' => User
42
+ }
38
43
 
39
- prefixes = { 'adr' => Address,
44
+ prefixes = {
45
+ 'adr' => Address,
40
46
  'sf' => ScanForm,
41
47
  'cstitem' => CustomsItem,
42
48
  'cstinfo' => CustomsInfo,
@@ -48,13 +54,17 @@ module EasyPost
48
54
  'batch' => Batch,
49
55
  'trk' => Tracker,
50
56
  'item' => Item,
57
+ 'ins' => Insurance,
51
58
  'container' => Container,
52
59
  'order' => Order,
53
60
  'pickup' => Pickup,
54
61
  'pickuprate' => PickupRate,
55
62
  'pl' => PostageLabel,
63
+ 'printer' => Printer,
64
+ 'printjob' => PrintJob,
56
65
  'ca' => CarrierAccount,
57
- 'user' => User }
66
+ 'user' => User
67
+ }
58
68
 
59
69
  case response
60
70
  when Array
@@ -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,8 @@ 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'
29
32
  require 'easypost/carrier_account'
30
33
  require 'easypost/user'
31
34
 
@@ -79,9 +82,11 @@ module EasyPost
79
82
  self.http_config.merge!(http_config_params)
80
83
  end
81
84
 
82
- def self.request(method, url, api_key, params={}, headers={})
85
+ def self.request(method, url, api_key, params={}, headers={}, api_key_required=true)
83
86
  api_key ||= @@api_key
84
- 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
85
90
 
86
91
  params = Util.objects_to_ids(params)
87
92
  url = self.api_url(url)
data/spec/address_spec.rb CHANGED
@@ -1,6 +1,17 @@
1
1
  require 'spec_helper'
2
2
 
3
3
  describe EasyPost::Address do
4
+ describe ".create_and_verify" do
5
+ context "for a successful response without an address" do
6
+ it "should raise an error" do
7
+ expect(EasyPost).to receive(:request).and_return([{}, ""])
8
+ expect {
9
+ EasyPost::Address.create_and_verify(ADDRESS[:california])
10
+ }.to raise_error EasyPost::Error, /Unable to verify addres/
11
+ end
12
+ end
13
+ end
14
+
4
15
  describe '#create' do
5
16
  it 'creates an address object' do
6
17
  address = EasyPost::Address.create(ADDRESS[:california])
@@ -11,20 +22,21 @@ describe EasyPost::Address do
11
22
  end
12
23
 
13
24
  describe '#verify' do
14
- it 'verifies an address with message' do
15
- address = EasyPost::Address.create(ADDRESS[:california].reject {|k,v| k == :street2})
25
+ it 'verifies an address with an error' do
26
+ address = EasyPost::Address.create(
27
+ ADDRESS[:california].reject {|k,v| k == :street1 || k == :company}
28
+ )
16
29
 
17
- expect(address.company).to eq('EasyPost')
18
- expect(address.street1).to eq('164 Townsend Street')
30
+ expect(address.street1).to be_nil
31
+ expect(address.street2).to eq('Unit 1')
19
32
  expect(address.city).to eq('San Francisco')
20
33
  expect(address.state).to eq('CA')
21
34
  expect(address.zip).to eq('94107')
22
35
  expect(address.country).to eq('US')
23
- expect(address.street2).to be_nil
24
36
 
25
- verified_address = address.verify()
26
- expect(verified_address).to be_an_instance_of(EasyPost::Address)
27
- expect(verified_address[:message].length).to be > 0
37
+ expect {
38
+ address.verify()
39
+ }.to raise_error EasyPost::Error, /Unable to verify addres/
28
40
  end
29
41
 
30
42
  it 'verifies an address without message' do
@@ -37,8 +49,8 @@ describe EasyPost::Address do
37
49
  expect(verified_address[:message]).to be_nil
38
50
  end
39
51
 
40
- it 'verifies an address using fedex' do
41
- address = EasyPost::Address.create(ADDRESS[:california].reject {|k,v| k == :street2})
52
+ it 'verifies an address using a carrier' do
53
+ address = EasyPost::Address.create(ADDRESS[:california])
42
54
 
43
55
  expect(address.company).to eq('EasyPost')
44
56
  expect(address.street1).to eq('164 Townsend Street')
@@ -46,11 +58,9 @@ describe EasyPost::Address do
46
58
  expect(address.state).to eq('CA')
47
59
  expect(address.zip).to eq('94107')
48
60
  expect(address.country).to eq('US')
49
- expect(address.street2).to be_nil
50
61
 
51
- verified_address = address.verify(carrier: :fedex)
62
+ verified_address = address.verify(carrier: :usps)
52
63
  expect(verified_address).to be_an_instance_of(EasyPost::Address)
53
- expect(verified_address[:message].length).to be > 0
54
64
  end
55
65
 
56
66
  it 'is not able to verify address' do
@@ -63,7 +73,9 @@ describe EasyPost::Address do
63
73
  zip: '941abc07'
64
74
  )
65
75
 
66
- expect { verified_address = address.verify() }.to raise_error(EasyPost::Error, /Unable to verify addres/)
76
+ expect {
77
+ address.verify()
78
+ }.to raise_error(EasyPost::Error, /Unable to verify addres/)
67
79
  end
68
80
  end
69
81
  end