easypost 2.0.11 → 2.0.12

data/CHANGELOG

@@ -1,3 +1,9 @@
+=== 2.0.12 2014-07-07
+
+* Added Item, Container, and Order resources.
+* Fixed and added a lot of tests.
+
+
 === 2.0.11 2013-12-16
 
 * Added Event.receive method for parsing events sent by webhook.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    easypost (2.0.10)
+    easypost (2.0.11)
       multi_json (>= 1.0.4, < 2)
       rest-client (~> 1.4)
 
@@ -9,8 +9,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.4)
-    mime-types (1.23)
-    multi_json (1.7.7)
+    mime-types (1.25.1)
+    multi_json (1.8.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
     rspec (2.13.0)

data/VERSION

@@ -1 +1 @@
-2.0.11
+2.0.12

data/lib/easypost.rb

@@ -21,6 +21,9 @@ require 'easypost/refund'
 require 'easypost/event'
 require 'easypost/batch'
 require 'easypost/tracker'
+require 'easypost/item'
+require 'easypost/container'
+require 'easypost/order'
 
 require 'easypost/error'
 

data/lib/easypost/container.rb

@@ -0,0 +1,4 @@
+module EasyPost
+  class Container < Resource
+  end
+end

data/lib/easypost/item.rb

@@ -0,0 +1,10 @@
+module EasyPost
+  class Item < Resource
+
+    def self.retrieve_reference(params={})
+      response, api_key = EasyPost.request(:get, url + '/retrieve_reference', @api_key, params)
+      return EasyPost::Util::convert_to_easypost_object(response, api_key) if response
+    end
+
+  end
+end

data/lib/easypost/order.rb

@@ -0,0 +1,19 @@
+module EasyPost
+  class Order < Resource
+
+    def buy(params={})
+      if params.instance_of?(EasyPost::Rate)
+        temp = params.clone
+        params = {}
+        params[:carrier] = temp.carrier
+        params[:service] = temp.service
+      end
+
+      response, api_key = EasyPost.request(:post, url + '/buy', @api_key, params)
+      self.refresh_from(response, @api_key, true)
+
+      return self
+    end
+
+  end
+end

data/lib/easypost/shipment.rb

@@ -1,12 +1,6 @@
 module EasyPost
   class Shipment < Resource
 
-    def self.track_with_code(params={})
-      response, api_key = EasyPost.request(:get, url + '/track', @api_key, params)
-
-      return response
-    end
-
     def get_rates(params={})
       response, api_key = EasyPost.request(:get, url + '/rates', @api_key, params)
       self.refresh_from(response, @api_key, true)
@@ -76,7 +70,7 @@ module EasyPost
       lowest = nil
 
       self.get_rates unless self.rates
-      
+
       if !carriers.is_a?(Array)
         carriers = carriers.split(',')
       end
@@ -125,13 +119,13 @@ module EasyPost
           next
         end
 
-        if lowest == nil || k.rate.to_f < lowest.rate.to_f          
+        if lowest == nil || k.rate.to_f < lowest.rate.to_f
             lowest = k
         end
       end
 
       raise Error.new('No rates found.') if lowest == nil
-      
+
       return lowest
     end
 

data/lib/easypost/util.rb

@@ -27,6 +27,9 @@ module EasyPost
         'Event' => Event,
         'Batch' => Batch,
         'Tracker' => Tracker,
+        'Item' => Item,
+        'Container' => Container,
+        'Order' => Order,
         'PostageLabel' => PostageLabel }
 
       prefixes = { 'adr' => Address,
@@ -40,6 +43,9 @@ module EasyPost
         'evt' => Event,
         'batch' => Batch,
         'trk' => Tracker,
+        'item' => Item,
+        'container' => Container,
+        'order' => Order,
         'pl' => PostageLabel }
 
       case response

data/spec/address_spec.rb

@@ -1,36 +1,26 @@
-require 'easypost'
-EasyPost.api_key = 'cueqNZUb3ldeWTNX7MU3Mel8UXtaAMUi'
+require 'spec_helper'
 
 describe EasyPost::Address do
   describe '#create' do
     it 'creates an address object' do
-      address = EasyPost::Address.create(
-        :name => 'Sawyer Bateman',
-        :street1 => '1A Larkspur Cres.',
-        :city => 'St. Albert',
-        :state => 'AB',
-        :zip => 't8n2m4',
-        :country => 'CA'
-      )
+      address = EasyPost::Address.create(ADDRESS[:california])
+
       expect(address).to be_an_instance_of(EasyPost::Address)
-      expect(address.name).to eq('Sawyer Bateman')
+      expect(address.company).to eq('EasyPost')
     end
   end
+
   describe '#verify' do
     it 'verifies an address with message' do
-      address = EasyPost::Address.create(
-        :company => 'Simpler Postage Inc',
-        :street1 => '388 Townsend Street',
-        :city => 'San Francisco',
-        :state => 'CA',
-        :zip => '94107'
-      )
-      expect(address.company).to eq('Simpler Postage Inc')
-      expect(address.street1).to eq('388 Townsend Street')
+      address = EasyPost::Address.create(ADDRESS[:california].reject {|k,v| k == :street2})
+
+      expect(address.company).to eq('EasyPost')
+      expect(address.street1).to eq('164 Townsend Street')
       expect(address.city).to eq('San Francisco')
       expect(address.state).to eq('CA')
       expect(address.zip).to eq('94107')
       expect(address.country).to eq('US')
+      expect(address.street2).to be_nil
 
       verified_address = address.verify()
       expect(verified_address).to be_an_instance_of(EasyPost::Address)
@@ -38,21 +28,9 @@ describe EasyPost::Address do
     end
 
     it 'verifies an address without message' do
-      address = EasyPost::Address.create(
-        :company => 'Simpler Postage Inc',
-        :street1 => '388 Townsend Street',
-        :street2 => 'Apt 20',
-        :city => 'San Francisco',
-        :state => 'CA',
-        :zip => '94107'
-      )
-      expect(address.company).to eq('Simpler Postage Inc')
-      expect(address.street1).to eq('388 Townsend Street')
-      expect(address.street2).to eq('Apt 20')
-      expect(address.city).to eq('San Francisco')
-      expect(address.state).to eq('CA')
-      expect(address.zip).to eq('94107')
-      expect(address.country).to eq('US')
+      address = EasyPost::Address.create(ADDRESS[:california])
+
+      expect(address.street2).to be
 
       verified_address = address.verify()
       expect(verified_address).to be_an_instance_of(EasyPost::Address)
@@ -64,9 +42,9 @@ describe EasyPost::Address do
         :company => 'Simpler Postage Inc',
         :street1 => '388 Junk Teerts',
         :street2 => 'Apt 20',
-        :city => 'San Francisco',
-        :state => 'CA',
-        :zip => '941abc07'
+        :city    => 'San Francisco',
+        :state   => 'CA',
+        :zip     => '941abc07'
       )
 
       expect { verified_address = address.verify() }.to raise_error(EasyPost::Error, /Address Not Found./)

data/spec/batch_spec.rb

@@ -4,42 +4,21 @@ describe EasyPost::Batch do
 
   describe '#create' do
     it 'creates a batch object' do
-      from_address = EasyPost::Address.create(
-        :name => "Benchmark Merchandising",
-        :street1 => "329 W 18th Street",
-        :city => "Chicago",
-        :state => "IL",
-        :zip => "60616"
-      )
-      to_address = EasyPost::Address.create(
-        :street1 => "902 Broadway 4th Floor",
-        :city => "New York",
-        :state => "NY",
-        :zip => "10010"
-      )
-      parcel = EasyPost::Parcel.create(
-        :weight => 7.2,
-        :height => 2,
-        :width => 7.5,
-        :length => 10.5
-      )
-
       batch = EasyPost::Batch.create({
         :shipment => [{
-          :from_address => from_address,
-          :to_address   => to_address,
-          :parcel       => parcel
+          :from_address => ADDRESS[:california],
+          :to_address   => ADDRESS[:missouri],
+          :parcel       => PARCEL[:dimensions]
         }, {
-          :from_address => from_address,
-          :to_address   => to_address,
-          :parcel       => parcel,
-          :reference    => 'refnum9173'
+          :from_address => ADDRESS[:california],
+          :to_address   => ADDRESS[:canada],
+          :parcel       => PARCEL[:dimensions],
         }],
-        :reference => "abc-123"
-        })
+        :reference => "batch123456789"
+      })
       expect(batch).to be_an_instance_of(EasyPost::Batch)
       expect(batch.num_shipments).to eq(2)
-      expect(batch.reference).to eq("abc-123")
+      expect(batch.reference).to eq("batch123456789")
       expect(batch.state).to eq("creating")
 
       # sleeps_left = 10
@@ -57,46 +36,21 @@ describe EasyPost::Batch do
 
   describe '#create_and_buy' do
     it 'creates a batch object and delayed jobs for purchasing the postage_labels' do
-      from_address = EasyPost::Address.create(
-        :name => "Benchmark Merchandising",
-        :street1 => "329 W 18th Street",
-        :city => "Chicago",
-        :state => "IL",
-        :zip => "60616"
-      )
-      to_address = EasyPost::Address.create(
-        :name => "Don Juan",
-        :street1 => "902 Broadway 4th Floor",
-        :city => "New York",
-        :state => "NY",
-        :zip => "10010"
-
-      )
-      parcel = EasyPost::Parcel.create(
-        :weight => 7.2,
-        :height => 2,
-        :width => 7.5,
-        :length => 10.5
-      )
-
-      batch = EasyPost::Batch.create_and_buy({:shipment =>
-        [
-          {
-            :from_address => from_address,
-            :to_address   => to_address,
-            :parcel       => parcel,
-            :carrier      => 'USPS',
-            :service      => 'Priority'
-          },
-          {
-            :from_address => from_address,
-            :to_address   => to_address,
-            :parcel       => parcel,
-            :reference    => 'refnum9173',
-            :carrier      => 'UPS',
-            :service      => '2ndDayAir'
-          }
-        ]
+      batch = EasyPost::Batch.create({
+        :shipment => [{
+          :from_address => ADDRESS[:california],
+          :to_address   => ADDRESS[:missouri],
+          :parcel       => PARCEL[:dimensions],
+          :carrier      => "usps",
+          :service      => "priority"
+        }, {
+          :from_address => ADDRESS[:california],
+          :to_address   => ADDRESS[:canada],
+          :parcel       => PARCEL[:dimensions],
+          :carrier      => "usps",
+          :service      => "prioritymailinternational"
+        }],
+        :reference => "batch123456789"
       })
       expect(batch).to be_an_instance_of(EasyPost::Batch)
       expect(batch.state).to eq("creating")

data/spec/container_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe EasyPost::Container do
+
+  describe '#create' do
+    it 'creates a container object' do
+      container = EasyPost::Container.create(
+        name: "Spec Box 1",
+        length: 6.2,
+        width: 12.8,
+        height: 13.5,
+        max_weight: 40.55,
+        reference: "SPECBOX",
+      )
+      expect(container).to be_an_instance_of(EasyPost::Container)
+      expect(container.max_weight).to eq(40.55)
+    end
+
+    it 'fails to create a container object' do
+      expect { EasyPost::Container.create(
+        name: "Missing dimension",
+        length: 6,
+        width: 12,
+        max_weight: 40
+      ) }.to raise_exception(EasyPost::Error, /Invalid request, if one dimension is provided all three are required./)
+    end
+
+    it 'creates a container object with default values' do
+      container = EasyPost::Container.create(name: "Defaults Box")
+      expect(container).to be_an_instance_of(EasyPost::Container)
+      expect(container.id).to be
+      expect(container.name).to eq("Defaults Box")
+      expect(container.length).to eq(0.0)
+      expect(container.width).to eq(0.0)
+      expect(container.height).to eq(0.0)
+      expect(container.max_weight).to eq(0.0)
+      expect(container.type).to eq("BOX")
+    end
+  end
+
+  describe '#retrieve' do
+    it 'retrieves a user created container by public_id' do
+      container_1 = EasyPost::Container.create(
+        name: "My Box",
+        length: 6.2,
+        width: 12.8,
+        height: 13.5,
+        max_weight: 40.55,
+        reference: "SPECBOX",
+        type: "BAG",
+      )
+      container_2 = EasyPost::Container.retrieve(container_1.id)
+
+      expect(container_1).to be_an_instance_of(EasyPost::Container)
+      expect(container_2).to be_an_instance_of(EasyPost::Container)
+      expect(container_2.id).to eq(container_1.id)
+      expect(container_1.type).to eq("BAG")
+    end
+
+    it 'retrieves a user created container by reference' do
+      container_1 = EasyPost::Container.create(
+        name: "Spec Box 2",
+        length: 6.2,
+        width: 12.8,
+        height: 133.94,
+        max_weight: 40.55,
+        reference: "SPECBOX4",
+      )
+      container_2 = EasyPost::Container.retrieve("SPECBOX4")
+
+      expect(container_1).to be_an_instance_of(EasyPost::Container)
+      expect(container_2).to be_an_instance_of(EasyPost::Container)
+      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

data/spec/fedex/domestic_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+describe 'fedex domestic' do
+  before(:all) do
+    @rates = {}
+  end
+
+  it 'buys a commercial ground label' do
+    shipment = EasyPost::Shipment.create(
+      :to_address   => ADDRESS[:california],
+      :from_address => ADDRESS[:missouri],
+      :parcel       => PARCEL[:dimensions]
+    )
+    shipment.buy(:rate => shipment.lowest_rate("fedex", "FEDEX_GROUND"))
+    label = open(shipment.postage_label.label_url)
+
+    expect(shipment).to be_an_instance_of(EasyPost::Shipment)
+    expect(shipment.selected_rate).to be_an_instance_of(EasyPost::Rate)
+    expect(shipment.selected_rate.service).to eq("FEDEX_GROUND")
+    expect(shipment.postage_label.label_url).to end_with(".png")
+    expect(shipment.tracking_code).to start_with("8000")
+    expect(label.size).to be > 5000
+
+    @rates[:commercial] = shipment.selected_rate
+  end
+
+   it 'buys a residential ground label' do
+    shipment = EasyPost::Shipment.create(
+      :to_address   => ADDRESS[:california],
+      :from_address => ADDRESS[:missouri],
+      :parcel       => PARCEL[:dimensions],
+      :options      => {:residential_to_address => true}
+    )
+    shipment.buy(:rate => shipment.lowest_rate("fedex", "GROUND_HOME_DELIVERY"))
+    label = open(shipment.postage_label.label_url)
+
+    expect(shipment.selected_rate.service).to eq("GROUND_HOME_DELIVERY")
+    expect(shipment.tracking_code).to start_with("8000")
+    expect(label.size).to be > 5000
+
+    @rates[:residential] = shipment.selected_rate
+  end
+
+  it 'buys a ground evening delivery label' do
+    shipment = EasyPost::Shipment.create(
+      :to_address   => ADDRESS[:california],
+      :from_address => ADDRESS[:missouri],
+      :parcel       => PARCEL[:dimensions],
+      :options      => {:residential_to_address => true,
+                        :delivery_time_preference => "evening"}
+    )
+    shipment.buy(:rate => shipment.lowest_rate("fedex", "GROUND_HOME_DELIVERY"))
+
+    expect(shipment.postage_label.label_url).to end_with(".png")
+
+    @rates[:residential_evening] = shipment.selected_rate
+  end
+
+  it 'raises error without recipient phone number' do
+    shipment = EasyPost::Shipment.create(
+      :to_address   => ADDRESS[:california_no_phone],
+      :from_address => ADDRESS[:missouri],
+      :parcel       => PARCEL[:dimensions]
+    )
+
+    expect { shipment.buy(rate: shipment.lowest_rate("fedex")) }.to raise_error(EasyPost::Error, /Unable to buy FedEx shipment without recipient phone number./)
+  end
+
+  it 'buys a label for an alcoholic shipment with epl2 label' do
+    shipment = EasyPost::Shipment.create(
+      :to_address   => ADDRESS[:california],
+      :from_address => ADDRESS[:missouri],
+      :parcel       => PARCEL[:dimensions],
+      :options      => {
+        :alcohol      => 1,
+        :label_format => "epl2"
+      }
+    )
+    shipment.buy(:rate => shipment.lowest_rate("fedex", "PRIORITY_OVERNIGHT"))
+
+    expect(shipment.postage_label.label_url).to end_with(".epl2")
+  end
+
+  it 'buys a label for a ground cod shipment' do
+    shipment = EasyPost::Shipment.create(
+      :to_address   => ADDRESS[:california],
+      :from_address => ADDRESS[:missouri],
+      :parcel       => PARCEL[:dimensions]
+    )
+    shipment_cod = EasyPost::Shipment.create(
+      :to_address   => ADDRESS[:california],
+      :from_address => ADDRESS[:missouri],
+      :parcel       => PARCEL[:dimensions],
+      :options      => {cod_amount: 19.99}
+    )
+    shipment_cod.buy(rate: shipment_cod.lowest_rate("fedex", "FEDEX_GROUND"))
+
+    expect(shipment.lowest_rate("fedex", "FEDEX_GROUND").rate.to_f).to be < (shipment_cod.lowest_rate("fedex", "FEDEX_GROUND").rate.to_f)
+    expect(shipment.lowest_rate("fedex", "PRIORITY_OVERNIGHT").rate.to_f).to be < (shipment_cod.lowest_rate("fedex", "PRIORITY_OVERNIGHT").rate.to_f)
+    expect(shipment_cod.postage_label.label_url).to be
+  end
+
+  it 'buys a label for a ground multi-parcel cod shipment' do
+    order = EasyPost::Order.create(
+      to_address: ADDRESS[:california],
+      from_address: ADDRESS[:missouri],
+      shipments: [{
+        parcel: {length: 8, width: 6, height: 4, weight: 12},
+        options: {cod_amount: 14.99}
+      },{
+        parcel: {length: 8, width: 6, height: 4, weight: 12},
+        options: {cod_amount: 18.75}
+      }]
+    )
+    order.buy(carrier: "fedex", service: "FEDEX_GROUND")
+
+    expect(order).to be_an_instance_of(EasyPost::Order)
+    expect(order.shipments.first).to be_an_instance_of(EasyPost::Shipment)
+    expect(order.shipments[0].postage_label.label_url).to be
+    expect(order.shipments[1].postage_label.label_url).to be
+  end
+
+  it 'buys a label for an express cod shipment' do
+    shipment = EasyPost::Shipment.create(
+      :to_address   => ADDRESS[:california],
+      :from_address => ADDRESS[:missouri],
+      :parcel       => PARCEL[:dimensions]
+    )
+    shipment_cod = EasyPost::Shipment.create(
+      :to_address   => ADDRESS[:california],
+      :from_address => ADDRESS[:missouri],
+      :parcel       => PARCEL[:dimensions],
+      :options      => {cod_amount: 19.99}
+    )
+    shipment_cod.buy(rate: shipment_cod.lowest_rate("fedex", "PRIORITY_OVERNIGHT"))
+
+    expect(shipment.lowest_rate("fedex", "FEDEX_GROUND").rate.to_f).to be < (shipment_cod.lowest_rate("fedex", "FEDEX_GROUND").rate.to_f)
+    expect(shipment.lowest_rate("fedex", "PRIORITY_OVERNIGHT").rate.to_f).to be < (shipment_cod.lowest_rate("fedex", "PRIORITY_OVERNIGHT").rate.to_f)
+    expect(shipment_cod.postage_label.label_url).to be
+  end
+
+  it 'buys a label for an express multi-parcel cod shipment' do
+    order = EasyPost::Order.create(
+      to_address: ADDRESS[:california],
+      from_address: ADDRESS[:missouri],
+      shipments: [{
+        parcel: {length: 8, width: 6, height: 4, weight: 12},
+        options: {cod_amount: 14.99}
+      },{
+        parcel: {length: 8, width: 6, height: 4, weight: 12},
+        options: {cod_amount: 18.75}
+      }]
+    )
+    order.buy(carrier: "fedex", service: "PRIORITY_OVERNIGHT")
+
+    expect(order).to be_an_instance_of(EasyPost::Order)
+    expect(order.shipments.first).to be_an_instance_of(EasyPost::Shipment)
+    expect(order.shipments[0].postage_label.label_url).to be
+    expect(order.shipments[1].postage_label.label_url).to be
+  end
+
+  after(:all) do
+    begin
+      expect(@rates[:residential_evening].rate.to_i).to be > @rates[:residential].rate.to_i
+      expect(@rates[:residential].rate.to_i).to be > @rates[:commercial].rate.to_i
+    rescue
+    end
+  end
+
+end