easypost 2.1.0 → 2.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDRiZmUzZDYxMmEzNmNlNWRhNjMxNzZkYjdhMzQ4MGZjZTMxOTM5Mw==
-  data.tar.gz: !binary |-
-    ZTcxNzNjN2ZhMzYxODA3NmFhMGY5NzQ4NTg2ZTk5NmNjOTAwODI5ZA==
+SHA1:
+  metadata.gz: 1d1cc5a734e2706f3cbeba923df0240405b0e0df
+  data.tar.gz: fe44d1b81b62583f286e045e385cbdeab0818581
 SHA512:
-  metadata.gz: !binary |-
-    MzlmYzQ1YjZkMjQ0YWMzYTVjMzU5ZDI4NzJhYzAzODcxYmQ0MDBiMDVjYTAw
-    OTQ2NjE0YjQwMzcyZmY4ZTkyMzcwYjMxODBjM2I3Y2ZhMmQ0NzAzMThhOWNm
-    OTEzYjVkNzMzNmFmZTMyNmMyODBjNjJiYzRkZmM3N2Q0NDcxNjU=
-  data.tar.gz: !binary |-
-    NjNlMmY0ZmI5MDdjNWI1ODM0MDBkZTBhMjQ0OTk3NDhkMjIxNTNlMTZhOWQ0
-    OGVlYjVlYjRkMjhkMThiMDZlMmRhZmM4NTIxMWJmMWI4NTc1ODRmMDNjMzk1
-    ODExMzE1MmE0OWMxOTY4ZWRmMTg3YThiOWE4NGE2NWY1Mzk5ZGU=
+  metadata.gz: 4afc2b2702cf588aed58d28413cd6b31ea74ce1ca08a8e1527f1ebc71f7299ca596af96bdc2020542c625fd1809d99d144becff5d26c80a1688d73374ea8c9fc
+  data.tar.gz: d5f90684e2740529028f2e32431c882f939db7ea788849d6e0054865078a2dfb4d9dcdeb74010ad99a1576ca068a64bf797bb0fa5d4387c029c8095634d39156

data/.gitignore

@@ -25,4 +25,5 @@ doc/
 Icon
 ._*
 .Spotlight-V100
-.Trashes
+.Trashes
+vendor/

data/CHANGELOG

@@ -1,3 +1,27 @@
+=== 2.1.1 2015-04-15
+
+* CarrierAccount will now correctly save in-place modifications to credentials
+* Nested variables should now be saved correctly across all models
+* Fixed version numbering confusion (the previous version was 2.0.15, not 2.1.0)
+
+
+=== 2.0.15 2015-04-15
+
+* Added tracker to shipment buy response
+* Updated tracker tests
+
+
+=== 2.0.14 2015-04-15
+
+* Added User and CarrierAccount models with CRUD functionality
+
+
+=== 2.0.13 2014-10-30
+
+* Added Pickup, PickupRate resources.
+* Added ability to pass api_key to a few resources that were missing it.
+
+
 === 2.0.12 2014-07-07
 
 * Added Item, Container, and Order resources.

data/README.md

@@ -1,5 +1,8 @@
 # EasyPost Ruby Client Library
 
+[<img src="https://circleci.com/gh/EasyPost/easypost-ruby.png?circle-token=80adb5236ed1fdce20810b055af79c63c3d5796b">](https://circleci.com/gh/EasyPost/easypost-ruby)
+
+
 EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com
 
 Installation

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.1.1

data/lib/easypost.rb

@@ -26,6 +26,8 @@ require 'easypost/container'
 require 'easypost/order'
 require 'easypost/pickup'
 require 'easypost/pickup_rate'
+require 'easypost/carrier_account'
+require 'easypost/user'
 
 require 'easypost/error'
 
@@ -68,7 +70,8 @@ module EasyPost
     @@http_config ||= {
       timeout: 60,
       open_timeout: 30,
-      verify_ssl: false
+      verify_ssl: false,
+      ssl_version: "TLSv1",
     }
   end
 

data/lib/easypost/address.rb

@@ -14,12 +14,16 @@ module EasyPost
         verified_address = EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
         return verified_address
       else
-        raise Error.new("Unable to verify address.")
+        raise_verification_failure
       end
     end
 
     def verify(params={}, carrier=nil)
-      response, api_key = EasyPost.request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
+      begin
+        response, api_key = EasyPost.request(:get, url + '/verify?carrier=' + String(carrier), @api_key, params)
+      rescue
+        raise_verification_failure
+      end
 
       if response.has_key?(:address)
         if response.has_key?(:message)
@@ -28,11 +32,14 @@ module EasyPost
         verified_address = EasyPost::Util::convert_to_easypost_object(response[:address], api_key)
         return verified_address
       else
-        raise Error.new("Unable to verify address.")
+        raise_verification_failure
       end
 
       return self
     end
 
+    def raise_verification_failure
+      raise Error.new("Unable to verify address.")
+    end
   end
 end

data/lib/easypost/carrier_account.rb

@@ -0,0 +1,8 @@
+module EasyPost
+  class CarrierAccount < Resource
+    def self.types
+      response, api_key = EasyPost.request(:get, "/carrier_types", @api_key)
+      return Util.convert_to_easypost_object(response, api_key)
+    end
+  end
+end

data/lib/easypost/object.rb

@@ -2,19 +2,21 @@ module EasyPost
   class EasyPostObject
     include Enumerable
 
-    attr_accessor :api_key
+    attr_accessor :parent, :name, :api_key, :unsaved_values
     @@immutable_values = Set.new([:api_key, :id])
 
-    def initialize(id=nil, api_key=nil)
+    def initialize(id=nil, api_key=nil, parent=nil, name=nil)
       @api_key = api_key
       @values = {}
       @unsaved_values = Set.new
       @transient_values = Set.new
+      @parent = parent
+      @name = name
       self.id = id if id
     end
 
-    def self.construct_from(values, api_key=nil)
-      obj = self.new(values[:id], api_key)
+    def self.construct_from(values, api_key=nil, parent=nil, name=nil)
+      obj = self.new(values[:id], api_key, parent, name)
       obj.refresh_from(values, api_key)
       obj
     end
@@ -32,13 +34,13 @@ module EasyPost
       @api_key = api_key
 
       added = Set.new(values.keys - @values.keys)
-      
+
       instance_eval do
         add_accessors(added)
       end
-      
+
       values.each do |k, v|
-        @values[k] = Util.convert_to_easypost_object(v, api_key)
+        @values[k] = Util.convert_to_easypost_object(v, api_key, self, k)
         @transient_values.delete(k)
         @unsaved_values.delete(k)
       end
@@ -87,6 +89,21 @@ module EasyPost
 
     protected
 
+    def flatten_unsaved
+      values = {}
+      for key in @unsaved_values
+        value = @values[key]
+
+        values[key] = value
+
+        if value.is_a?(EasyPost::EasyPostObject)
+          values[key] = flatten_unsaved(value)
+        end
+      end
+
+      return values
+    end
+
     def metaclass
       class << self; self; end
     end
@@ -111,6 +128,18 @@ module EasyPost
           define_method(k_eq) do |v|
             @values[k] = v
             @unsaved_values.add(k)
+
+            cur = self
+            cur_parent = self.parent
+            param = {}
+            while cur_parent
+              if cur.name
+                cur_parent.unsaved_values.add(cur.name)
+              end
+
+              cur = cur_parent
+              cur_parent = cur.parent
+            end
           end
         end
       end

data/lib/easypost/resource.rb

@@ -58,7 +58,17 @@ module EasyPost
       if @unsaved_values.length > 0
         values = {}
         @unsaved_values.each { |k| values[k] = @values[k] }
-        response, api_key = EasyPost.request(:post, url, @api_key, values)
+
+        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, api_key = EasyPost.request(:put, url, @api_key, wrapped_params)
         refresh_from(response, api_key)
       end
       return self

data/lib/easypost/user.rb

@@ -0,0 +1,42 @@
+module EasyPost
+  class User < Resource
+    def save
+      if @unsaved_values.length > 0
+        values = {}
+        @unsaved_values.each { |k| values[k] = @values[k] }
+
+        wrapped_params = {user: values}
+
+        response, api_key = EasyPost.request(:put, url, @api_key, wrapped_params)
+        refresh_from(response, api_key)
+      end
+      return self
+    end
+
+    def self.retrieve_me
+      self.all
+    end
+
+    def self.all_api_keys
+      response, api_key = EasyPost.request(:get, "/api_keys", @api_key)
+      return Util.convert_to_easypost_object(response, api_key)
+    end
+
+    def api_keys
+      api_keys = EasyPost::User.all_api_keys
+
+      if api_keys.id == self.id
+        my_api_keys = api_keys.keys
+      else
+        for child in api_keys.children
+          if child.id == self.id
+            my_api_keys = child.keys
+            break
+          end
+        end
+      end
+
+      my_api_keys
+    end
+  end
+end

data/lib/easypost/util.rb

@@ -15,7 +15,7 @@ module EasyPost
       end
     end
 
-    def self.convert_to_easypost_object(response, api_key)
+    def self.convert_to_easypost_object(response, api_key, parent=nil, name=nil)
       types = { 'Address' => Address,
         'ScanForm' => ScanForm,
         'CustomsItem' => CustomsItem,
@@ -32,7 +32,9 @@ module EasyPost
         'Order' => Order,
         'Pickup' => Pickup,
         'PickupRate' => PickupRate,
-        'PostageLabel' => PostageLabel }
+        'PostageLabel' => PostageLabel,
+        'CarrierAccount' => CarrierAccount,
+        'User' => User }
 
       prefixes = { 'adr' => Address,
         'sf' => ScanForm,
@@ -50,11 +52,13 @@ module EasyPost
         'order' => Order,
         'pickup' => Pickup,
         'pickuprate' => PickupRate,
-        'pl' => PostageLabel }
+        'pl' => PostageLabel,
+        'ca' => CarrierAccount,
+        'user' => User }
 
       case response
       when Array
-        return response.map { |i| convert_to_easypost_object(i, api_key) }
+        return response.map { |i| convert_to_easypost_object(i, api_key, parent) }
       when Hash
         if cls_name = response[:object]
           cls = types[cls_name]
@@ -65,7 +69,7 @@ module EasyPost
         end
 
         cls ||= EasyPostObject
-        return cls.construct_from(response, api_key)
+        return cls.construct_from(response, api_key, parent, name)
       else
         return response
       end

data/spec/address_spec.rb

@@ -55,15 +55,15 @@ describe EasyPost::Address do
 
     it 'is not able to verify address' do
       address = EasyPost::Address.create(
-        :company => 'Simpler Postage Inc',
-        :street1 => '388 Junk Teerts',
-        :street2 => 'Apt 20',
-        :city    => 'San Francisco',
-        :state   => 'CA',
-        :zip     => '941abc07'
+        company: 'Simpler Postage Inc',
+        street1: '388 Junk Teerts',
+        street2: 'Apt 20',
+        city: 'San Francisco',
+        state: 'CA',
+        zip: '941abc07'
       )
 
-      expect { verified_address = address.verify() }.to raise_error(EasyPost::Error, /Unable to verify address./)
+      expect { verified_address = address.verify() }.to raise_error(EasyPost::Error, /Unable to verify addres/)
     end
   end
 end

data/spec/batch_spec.rb

@@ -1,61 +1,48 @@
 require 'spec_helper'
 
 describe EasyPost::Batch do
-
   describe '#create' do
     it 'creates a batch object' do
       batch = EasyPost::Batch.create({
-        :shipment => [{
-          :from_address => ADDRESS[:california],
-          :to_address   => ADDRESS[:missouri],
-          :parcel       => PARCEL[:dimensions]
+        shipment: [{
+          from_address: ADDRESS[:california],
+          to_address: EasyPost::Address.create(ADDRESS[:missouri]),
+          parcel: EasyPost::Parcel.create(PARCEL[:dimensions])
         }, {
-          :from_address => ADDRESS[:california],
-          :to_address   => ADDRESS[:canada],
-          :parcel       => PARCEL[:dimensions],
+          from_address: ADDRESS[:california],
+          to_address: EasyPost::Address.create(ADDRESS[:canada]),
+          parcel: EasyPost::Parcel.create(PARCEL[:dimensions]),
         }],
-        :reference => "batch123456789"
+        reference: "batch123456789"
       })
       expect(batch).to be_an_instance_of(EasyPost::Batch)
       expect(batch.num_shipments).to eq(2)
       expect(batch.reference).to eq("batch123456789")
       expect(batch.state).to eq("creating")
-
-      # sleeps_left = 10
-      # while (batch.state == "creating" && sleeps_left > 0) do
-      #   sleep(3)
-      #   batch.refresh
-      #   sleeps_left -= 1
-      # end
-
-      # expect(batch.state).to equal("created")
-      # expect(batch.status[:created]).to equal(2)
-
     end
   end
 
   describe '#create_and_buy' do
     it 'creates a batch object and delayed jobs for purchasing the postage_labels' do
       batch = EasyPost::Batch.create({
-        :shipment => [{
-          :from_address => ADDRESS[:california],
-          :to_address   => ADDRESS[:missouri],
-          :parcel       => PARCEL[:dimensions],
-          :carrier      => "usps",
-          :service      => "priority"
+        shipment: [{
+          from_address: ADDRESS[:california],
+          to_address: EasyPost::Address.create(ADDRESS[:missouri]),
+          parcel: EasyPost::Parcel.create(PARCEL[:dimensions]),
+          carrier: "usps",
+          service: "priority"
         }, {
-          :from_address => ADDRESS[:california],
-          :to_address   => ADDRESS[:canada],
-          :parcel       => PARCEL[:dimensions],
-          :carrier      => "usps",
-          :service      => "prioritymailinternational"
+          from_address: ADDRESS[:california],
+          to_address: EasyPost::Address.create(ADDRESS[:canada]),
+          parcel: EasyPost::Parcel.create(PARCEL[:dimensions]),
+          carrier: "usps",
+          service: "prioritymailinternational"
         }],
-        :reference => "batch123456789"
+        reference: "batch123456789"
       })
       expect(batch).to be_an_instance_of(EasyPost::Batch)
       expect(batch.state).to eq("creating")
       expect(batch.num_shipments).to eq(2)
     end
   end
-
 end

data/spec/carrier_account_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe EasyPost::CarrierAccount do
+  it 'performs retrieve on a carrier account' do
+    id = 'ca_r8hLl9jS'
+    ca = EasyPost::CarrierAccount.retrieve(id)
+
+    expect(ca.id).to eq(id)
+  end
+
+  context 'perform CRUD functions' do
+    it 'performs all basic CRUD actions on a CarrierAccount' do
+      original_num_cas = EasyPost::CarrierAccount.all.count
+
+      description = "A test Ups Account"
+      reference = "RubyClientUpsTestAccount"
+
+      created_ca = EasyPost::CarrierAccount.create(
+        type: "UpsAccount",
+        description: description,
+        reference: reference,
+        credentials: {
+          account_number: "A1A1A1",
+          user_id: "UPSDOTCOM_USERNAME",
+          password: "UPSDOTCOM_PASSWORD",
+          access_license_number: "UPS_ACCESS_LICENSE_NUMBER"
+        }
+      )
+
+      id = created_ca["id"]
+
+      interm_num_cas = EasyPost::CarrierAccount.all.count
+      expect(interm_num_cas).to eq(original_num_cas + 1)
+
+      retrieved_ca = EasyPost::CarrierAccount.retrieve(id)
+
+      expect(retrieved_ca["id"]).to eq(created_ca["id"])
+      expect(retrieved_ca["description"]).to eq(description)
+      expect(retrieved_ca["reference"]).to eq(reference)
+
+      updated_description = "An updated description for a test Ups Account"
+      updated_account_number = "B2B2B2B2"
+      retrieved_ca.description = updated_description
+      retrieved_ca.credentials = {
+        account_number: updated_account_number,
+        user_id: "UPSDOTCOM_USERNAME",
+        password: "UPSDOTCOM_PASSWORD",
+        access_license_number: "UPS_ACCESS_LICENSE_NUMBER"
+      }
+      retrieved_ca.save
+
+      updated_ca = EasyPost::CarrierAccount.retrieve(id)
+      expect(updated_ca["id"]).to eq(created_ca["id"])
+      expect(updated_ca["description"]).to eq(updated_description)
+      expect(updated_ca["credentials"]["account_number"]).to eq(updated_account_number)
+
+      reupdated_account_number = "C3C3C3C3C3"
+      updated_user_id = "A_NEW_UPS_USERNAME"
+      updated_ca.credentials[:account_number] = reupdated_account_number
+      updated_ca.credentials[:user_id] = updated_user_id
+      updated_ca.save
+
+      reupdated_ca = EasyPost::CarrierAccount.retrieve(id)
+      expect(reupdated_ca["id"]).to eq(created_ca["id"])
+      expect(reupdated_ca["credentials"]["account_number"]).to eq(reupdated_account_number)
+      expect(reupdated_ca["credentials"]["user_id"]).to eq(updated_user_id)
+
+      final_ca = reupdated_ca.save
+      expect(final_ca["id"]).to eq(created_ca["id"])
+      expect(final_ca["credentials"]["account_number"]).to eq(reupdated_account_number)
+      expect(final_ca["credentials"]["user_id"]).to eq(updated_user_id)
+
+      final_ca.delete
+
+      final_num_cas = EasyPost::CarrierAccount.all.count
+      expect(final_num_cas).to eq(original_num_cas)
+    end
+  end
+
+  describe '#types' do
+    let(:carrier_account_types) { [
+      "AsendiaAccount",
+      "AustraliaPostAccount",
+      "CanadaPostAccount",
+      "CanparAccount",
+      "ColisPriveAccount",
+      "DhlExpressAccount",
+      "DhlGlobalMailAccount",
+      "FastwayAccount",
+      "FedexAccount",
+      "FedexSmartpostAccount",
+      "GsoAccount",
+      "LasershipAccount",
+      "LsoAccount",
+      "NorcoAccount",
+      "NzpostAccount",
+      "OntracAccount",
+      "PurolatorAccount",
+      "RoyalMailAccount",
+      "SpeedeeAccount",
+      "TntExpressAccount",
+      "UpsAccount",
+      "UpsMailInnovationsAccount",
+      "UpsSurepostAccount"
+    ] }
+
+    it 'returns the expected list of types' do
+      types = EasyPost::CarrierAccount.types
+      account_types = types.map(&:type)
+
+      for account_type in carrier_account_types
+        expect(account_types).to include(account_type)
+      end
+    end
+  end
+end