easypost 1.1.3 → 2.0.0

data/spec/address_spec.rb

@@ -0,0 +1,75 @@
+require 'easypost'
+EasyPost.api_key = 'cueqNZUb3ldeWTNX7MU3Mel8UXtaAMUi'
+
+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'
+      )
+      expect(address).to be_an_instance_of(EasyPost::Address)
+      expect(address.name).to eq('Sawyer Bateman')
+    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')
+      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')
+
+      verified_address = address.verify()
+      expect(verified_address).to be_an_instance_of(EasyPost::Address)
+      expect(verified_address[:message].length).to be > 0 
+    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')
+
+      verified_address = address.verify()
+      expect(verified_address).to be_an_instance_of(EasyPost::Address)
+      expect(verified_address[:message]).to raise_error(NoMethodError) 
+    end
+
+    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'
+      )
+
+      expect { verified_address = address.verify() }.to raise_error(EasyPost::Error, /Address Not Found./)
+    end
+  end
+end

data/spec/batch_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+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 => from_address,
+            :to_address   => to_address,
+            :parcel       => parcel,
+            :reference    => 'refnum9173'
+          }
+        ]
+      })
+      expect(batch).to be_an_instance_of(EasyPost::Batch)
+      expect(batch.status[:created]).to equal(2)
+      expect(batch.shipments.length).to equal(2)      
+    end
+  end
+
+  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'
+          }
+        ]
+      })
+      expect(batch).to be_an_instance_of(EasyPost::Batch)
+      expect(batch.status[:created]).to equal(2)
+      expect(batch.shipments.length).to equal(2)      
+    end
+  end
+
+end

data/spec/refund_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe EasyPost::Refund do
+  describe '#create' do
+    context 'tracking code string' do
+      before :all do
+        @tracking_codes = '12345, 39474, 26547, 18373'
+      end
+
+      it 'creates Refunds' do
+        refunds = EasyPost::Refund.create(
+          :carrier => 'USPS',
+          :tracking_codes => @tracking_codes
+        )
+        expect(refunds).to be_an_instance_of(Array)
+        expect(refunds.size).to eq(4)
+      end
+    end
+    context 'tracking code array' do
+      before :all do
+        @tracking_codes = ['12345', '39474, 26547', 18373, '22479']
+      end
+      
+      it 'creates Refunds' do
+        refunds = EasyPost::Refund.create(
+          :carrier => 'USPS',
+          :tracking_codes => @tracking_codes
+        )
+        expect(refunds).to be_an_instance_of(Array)
+        expect(refunds.size).to eq(5)
+      end
+
+      it 'fails to create without tracking codes' do
+        expect{EasyPost::Refund.create()}.to raise_error(EasyPost::Error)
+
+        begin
+          EasyPost::Refund.create()
+        rescue EasyPost::Error => e
+          expect(e.message).to eq('Invalid or missing param: tracking_codes')
+          expect(e.param).to eq('tracking_codes')
+        end
+      end
+    end
+  end
+  
+  describe '#retrieve' do
+    before :all do
+      @tracking_codes = '12345, 39474, 26547, 18373'
+    end
+    it 'retrieves refund' do
+      refunds = EasyPost::Refund.create(
+        :carrier => 'USPS',
+        :tracking_codes => @tracking_codes
+      )
+      refunds.each do |refund|
+        if refund.id
+          retrieved_refund = EasyPost::Refund.retrieve(refund.id)
+          expect(retrieved_refund).to be_an_instance_of(EasyPost::Refund)
+          break
+        end
+      end
+    end
+  end
+
+end

data/spec/scan_form_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe EasyPost::ScanForm do
+  describe '#create' do
+    context 'tracking code string' do
+      before :all do
+        @tracking_codes = '12345, 39474, 26547, 18373'
+      end
+
+      it 'creates a ScanForm' do
+        scan_form = EasyPost::ScanForm.create(
+          :from_address => address_california,
+          :tracking_codes => @tracking_codes
+        )
+        expect(scan_form).to be_an_instance_of(EasyPost::ScanForm)
+        expect(scan_form.tracking_codes).to be_an_instance_of(Array)
+        expect(scan_form.tracking_codes.size).to eq(4)
+      end
+    end
+    context 'tracking code array' do
+      before :all do
+        @tracking_codes = ['12345', '39474, 26547', 18373, '22479']
+      end
+      
+      it 'creates a ScanForm' do
+        scan_form = EasyPost::ScanForm.create(
+          :from_address => address_missouri,
+          :tracking_codes => @tracking_codes
+        )
+        expect(scan_form).to be_an_instance_of(EasyPost::ScanForm)
+        expect(scan_form.tracking_codes).to be_an_instance_of(Array)
+        expect(scan_form.tracking_codes.size).to eq(5)
+      end
+
+      it 'fails to create without tracking codes' do
+        expect{EasyPost::ScanForm.create()}.to raise_error(EasyPost::Error)
+
+        begin
+          EasyPost::ScanForm.create()
+        rescue EasyPost::Error => e
+          #puts e.inspect
+          expect(e.message).to eq('Invalid or missing param: tracking_codes')
+          expect(e.param).to eq('tracking_codes')
+        end
+      end
+    end
+  end
+  
+  describe '#retrieve' do
+    before :all do
+      @tracking_codes = '12345, 39474, 26547, 18373'
+    end
+    it 'retrieves scan_form' do
+      scan_form = EasyPost::ScanForm.create(
+        :from_address => address_california,
+        :tracking_codes => @tracking_codes
+      )
+      retrieved_scan_form = EasyPost::ScanForm.retrieve(scan_form.id)
+
+      expect(retrieved_scan_form).to be_an_instance_of(EasyPost::ScanForm)
+    end
+  end
+end

data/spec/shipment_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe EasyPost::Shipment do
+
+  describe '#create' do
+    it 'creates a shipment 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 
+      )
+            
+      shipment = EasyPost::Shipment.create(
+        :to_address => to_address,
+        :from_address => from_address,
+        :parcel => parcel
+      )
+      expect(shipment).to be_an_instance_of(EasyPost::Shipment)
+      
+    end
+  end
+
+  describe '#buy' do
+    it 'purchases postage for an international shipment' do
+      to_address = address_canada
+      from_address = address_california
+      expect(to_address).to be_an_instance_of(EasyPost::Address)
+      expect(from_address).to be_an_instance_of(EasyPost::Address)
+
+      parcel = parcel_dimensions
+      expect(parcel).to be_an_instance_of(EasyPost::Parcel)
+
+      customs_info = customs_info_poor
+      expect(customs_info).to be_an_instance_of(EasyPost::CustomsInfo)
+      
+      shipment = EasyPost::Shipment.create(
+        :to_address => to_address,
+        :from_address => from_address,
+        :parcel => parcel,
+        :customs_info => customs_info
+      )
+      expect(shipment).to be_an_instance_of(EasyPost::Shipment)
+
+      shipment.buy(
+        :rate => shipment.lowest_rate('usps')
+      )
+      expect(shipment.postage_label.label_url.length).to be > 0
+    end
+
+    it 'purchases postage for a domestic shipment' do
+      to_address = address_california
+      from_address = address_missouri
+      expect(to_address).to be_an_instance_of(EasyPost::Address)
+      expect(from_address).to be_an_instance_of(EasyPost::Address)
+
+      parcel = parcel_dimensions
+      expect(parcel).to be_an_instance_of(EasyPost::Parcel)
+
+      shipment = EasyPost::Shipment.create(
+        :to_address => to_address,
+        :from_address => from_address,
+        :parcel => parcel
+      )
+      expect(shipment).to be_an_instance_of(EasyPost::Shipment)
+
+      shipment.buy(
+        :rate => shipment.lowest_rate
+      )
+      expect(shipment.postage_label.label_url.length).to be > 0
+    end
+  end
+
+  describe '#stamp' do
+    it 'returns a stamp for a domestic shipment' do
+      to_address = address_california
+      from_address = address_missouri
+      expect(to_address).to be_an_instance_of(EasyPost::Address)
+      expect(from_address).to be_an_instance_of(EasyPost::Address)
+
+      parcel = parcel_dimensions
+      expect(parcel).to be_an_instance_of(EasyPost::Parcel)
+
+      shipment = EasyPost::Shipment.create(
+        :to_address => to_address,
+        :from_address => from_address,
+        :parcel => parcel
+      )
+      expect(shipment).to be_an_instance_of(EasyPost::Shipment)
+
+      shipment.buy(
+        :rate => shipment.lowest_rate(['USPS', 'UPS'], 'priority, express')
+      )
+
+      stamp_url = shipment.stamp
+
+      expect(stamp_url.length).to be > 0
+    end
+  end
+
+  describe '#barcode' do
+    it 'returns a barcode for a domestic shipment' do
+      to_address = address_california
+      from_address = address_missouri
+      expect(to_address).to be_an_instance_of(EasyPost::Address)
+      expect(from_address).to be_an_instance_of(EasyPost::Address)
+
+      parcel = parcel_dimensions
+      expect(parcel).to be_an_instance_of(EasyPost::Parcel)
+
+      shipment = EasyPost::Shipment.create(
+        :to_address => to_address,
+        :from_address => from_address,
+        :parcel => parcel
+      )
+      expect(shipment).to be_an_instance_of(EasyPost::Shipment)
+
+      shipment.buy(
+        :rate => shipment.lowest_rate('usps', ['Priority'])
+      )
+
+      barcode_url = shipment.barcode
+
+      expect(barcode_url.length).to be > 0
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,84 @@
+require 'easypost'
+EasyPost.api_key = 'cueqNZUb3ldeWTNX7MU3Mel8UXtaAMUi'
+# EasyPost.api_base = 'http://localhost:5000/v2'
+
+def address_canada
+  address = EasyPost::Address.create(
+    :name => 'Sawyer Bateman',
+    :street1 => '1A Larkspur Cres.',
+    :city => 'St. Albert',
+    :state => 'AB',
+    :zip => 't8n2m4',
+    :country => 'CA',
+    :phone => '780-273-8374'
+  )
+  return address
+end
+
+def address_california
+  address = EasyPost::Address.create(
+    :company => 'Simpler Postage Inc',
+    :street1 => '388 Townsend Street',
+    :street2 => 'Apt 20',
+    :city => 'San Francisco',
+    :state => 'CA',
+    :zip => '94107',
+    :phone => '415-456-7890'
+  )
+  return address
+end
+
+def address_missouri
+  address = EasyPost::Address.create(
+    :company => 'Airport Shipping',
+    :street1 => '601 Brasilia Avenue',
+    :city => 'Kansas City',
+    :state => 'MO',
+    :zip => '64153',
+    :phone => '314-924-0383',
+    :email => 'kansas_shipping@example.com'
+  )
+  return address
+end
+
+def parcel_dimensions
+  parcel = EasyPost::Parcel.create(
+    :width => 15.2,
+    :length => 18, 
+    :height => 9.5,
+    :weight => 35.1
+  )
+  return parcel
+end
+
+def parcel_package
+  parcel = EasyPost::Parcel.create(
+    :predefined_package => 'MediumFlatRateBox',
+    :weight => 17
+  )
+  return parcel
+end
+
+def customs_info_poor
+  customs_item = EasyPost::CustomsItem.create(
+    :description => 'EasyPost T-shirts',
+    :quantity => 2,
+    :value => 23.56,
+    :weight => 33,
+    :origin_country => 'us',
+    :hs_tariff_number => 123456
+  )
+  customs_info = EasyPost::CustomsInfo.create(
+    :integrated_form_type => 'form_2976',
+    :customs_certify => true,
+    :customs_signer => 'Dr. Pepper',
+    :contents_type => 'gift',
+    :contents_explanation => '', # only required when contents_type => 'other'
+    :eel_pfc => 'NOEEI 30.37(a)',
+    :non_delivery_option => 'abandon',
+    :restriction_type => 'none',
+    :restriction_comments => '',
+    :customs_items => [customs_item]
+  )
+  return customs_info
+end