easypost 2.0.13 → 2.0.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 131297bd3896582b77eebf257940afee1118215c
+  data.tar.gz: 7ef855b3b817a0ba6b7314c4f7d92594640a066a
+SHA512:
+  metadata.gz: 48f352fc1099de1a4995e96b1dc077133f4bba456407baf89d73263990278676d204da5979f8b3cf3e87154798b1d799f42c03d3714484727640d9a5f544718e
+  data.tar.gz: 3a9ea6325239c5649348d8c08c9c73648ab469b6509eade346c2914584f8fa1dbd5ba4e071d19f4a6cd90137bfd9bb6b1c452b076a20499c2f8177ff3b5ce78c

data/.gitignore

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

data/CHANGELOG

@@ -1,3 +1,14 @@
+=== 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.

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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/VERSION

@@ -1 +1 @@
-2.0.13
+2.0.15

data/easypost.gemspec

@@ -13,12 +13,14 @@ Gem::Specification.new do |spec|
   spec.email       = 'contact@easypost.com'
   spec.homepage    = 'https://www.easypost.com/docs'
 
-  spec.files         = `git ls-files`.split("\n")
-  spec.test_files    = `git ls-files -- test/*`.split("\n")
-  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  spec.require_path  = 'lib'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
 
-  spec.add_dependency('rest-client', '~> 1.4')
-  spec.add_dependency('multi_json', '>= 1.0.4', '< 2')
-  spec.add_development_dependency('rspec', "~> 2.13.0")
+  spec.add_dependency 'rest-client', '~> 1.4'
+  spec.add_dependency 'multi_json', '>= 1.0.4', '< 2'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 2.13.0'
 end

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,21 @@
+module EasyPost
+  class CarrierAccount < Resource
+    def save
+      if @unsaved_values.length > 0
+        values = {}
+        @unsaved_values.each { |k| values[k] = @values[k] }
+
+        wrapped_params = {carrier_account: values}
+
+        response, api_key = EasyPost.request(:put, url, @api_key, wrapped_params)
+        refresh_from(response, api_key)
+      end
+      return self
+    end
+
+    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

@@ -32,11 +32,11 @@ 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)
         @transient_values.delete(k)

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

@@ -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,7 +52,9 @@ module EasyPost
         'order' => Order,
         'pickup' => Pickup,
         'pickuprate' => PickupRate,
-        'pl' => PostageLabel }
+        'pl' => PostageLabel,
+        'ca' => CarrierAccount,
+        'user' => User }
 
       case response
       when Array

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,83 @@
+require 'spec_helper'
+
+describe EasyPost::CarrierAccount 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"
+    retrieved_ca.description = updated_description
+    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)
+
+    updated_ca.delete
+
+    final_num_cas = EasyPost::CarrierAccount.all.count
+    expect(final_num_cas).to eq(original_num_cas)
+  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

data/spec/container_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe EasyPost::Container do
-
   describe '#create' do
     it 'creates a container object' do
       container = EasyPost::Container.create(
@@ -73,15 +72,5 @@ describe EasyPost::Container do
       expect(container_2.height).to eq(container_1.height)
       expect(container_1.type).to eq("BOX")
     end
-
-    it 'retrieves global containers' do
-      container_1 = EasyPost::Container.retrieve("container_USPSFR03")
-      container_2 = EasyPost::Container.retrieve("container_USPSFR02")
-
-      expect(container_1).to be_an_instance_of(EasyPost::Container)
-      expect(container_2).to be_an_instance_of(EasyPost::Container)
-      expect(container_1.reference).to eq(container_2.reference)
-    end
   end
-
 end