fedex_ship 0.1.0

data/spec/lib/fedex_ship/ground_close_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module FedexShip
+  describe Shipment do
+    let (:fedex) { Shipment.new(fedex_credentials) }
+
+    let(:filename) {
+      require 'tmpdir'
+      File.join(Dir.tmpdir, "manifest#{rand(15000)}.txt")
+    }
+
+    context "#ground_close" do
+      context "with shipment ready for close", :vcr do
+        before do
+          shipper = { :name => "Sender", :company => "Company", :phone_number => "555-555-5555", :address => "Main Street", :city => "Harrison", :state => "AR", :postal_code => "72601", :country_code => "US" }
+          recipient = { :name => "Recipient", :company => "Company", :phone_number => "555-555-5555", :address => "Main Street", :city => "Frankin Park", :state => "IL", :postal_code => "60131", :country_code => "US", :residential => true }
+          packages = [
+            {
+              :weight => {:units => "LB", :value => 2},
+              :dimensions => {:length => 10, :width => 5, :height => 4, :units => "IN" }
+            }
+          ]
+          # require 'tmpdir'
+          # filename = File.join(Dir.tmpdir, "label#{rand(15000)}.pdf")
+          options = { :shipper => shipper, :recipient => recipient, :packages => packages, :service_type => "FEDEX_GROUND"}#, :filename => filename }
+          fedex.ship(options)
+        end
+
+        it "completes with success result" do
+          # When running this spec you may need to uncomment the line below to allow shipment to be created before close request
+          #sleep(7)
+          expect{ fedex.ground_close(:up_to_time => Time.now, :filename => filename) }.to_not raise_error
+        end
+      end
+      context "raise an error when there aren't any existing shipments to close", :vcr do
+        it "raises an error" do
+          expect { fedex.ground_close(:up_to_time => Time.now) }.to raise_error(FedexShip::RateError, 'No Shipments to Close')
+        end
+      end
+    end
+  end
+end

data/spec/lib/fedex_ship/label_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'tmpdir'
+module FedexShip
+  describe Label do
+    describe "ship service for label" do
+      let(:fedex) { Shipment.new(fedex_credentials) }
+      let(:shipper) do
+        {:name => "Sender", :company => "Company", :phone_number => "555-555-5555", :address => "Main Street", :city => "Harrison", :state => "AR", :postal_code => "72601", :country_code => "US"}
+      end
+      let(:recipient) do
+        {:name => "Recipient", :company => "Company", :phone_number => "555-555-5555", :address => "Main Street", :city => "Frankin Park", :state => "IL", :postal_code => "60131", :country_code => "US", :residential => true }
+      end
+      let(:packages) do
+        [
+          {
+            :weight => {:units => "LB", :value => 2},
+            :dimensions => {:length => 10, :width => 5, :height => 4, :units => "IN" }
+          }
+        ]
+      end
+      let(:shipping_options) do
+        { :packaging_type => "YOUR_PACKAGING", :drop_off_type => "REGULAR_PICKUP" }
+      end
+
+      let(:label_specification) do
+        { :label_format_type => 'COMMON2D',
+          :image_type => 'PNG',
+        }
+      end
+
+      let(:filename) {
+        require 'tmpdir'
+        File.join(Dir.tmpdir, "label#{rand(15000)}.pdf")
+      }
+
+      let(:options) do
+        { :shipper => shipper,
+          :recipient => recipient,
+          :packages => packages,
+          :service_type => "FEDEX_GROUND",
+          :label_specification => label_specification,
+          :filename =>  filename
+        }
+      end
+
+      describe "label", :vcr do
+        before do
+          @label = fedex.label(options)
+        end
+
+        it "should create a label" do
+          expect(File).to exist(filename)
+        end
+
+        it "should return tracking number" do
+          expect(@label).to respond_to('tracking_number')
+        end
+
+        it "should expose complete response" do
+          expect(@label).to respond_to('response_details')
+        end
+        after do
+          require 'fileutils'
+          FileUtils.rm_r(filename) if File.exist?(filename)
+        end
+
+        it "should expose the file_name" do
+          expect(@label).to respond_to('file_name')
+        end
+      end
+    end
+  end
+end

data/spec/lib/fedex_ship/pickup_availability_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'fedex_ship/shipment'
+
+describe FedexShip::Request::Pickup do
+  describe "pickup availability service" do
+    let(:fedex) { FedexShip::Shipment.new(fedex_credentials) }
+    let(:dispatch_date) {(Date.today + 1).strftime('%Y-%m-%d')}
+
+    let(:options) do
+      {:country_code => 'IN', :postal_code => '400061', :request_type => 'FUTURE_DAY', :dispatch_date => dispatch_date, :carrier_code => 'FDXE'}
+    end
+
+    it "succeeds", :vcr do
+      expect {
+        @pickup_availability = fedex.pickup_availability(options)
+      }.to_not raise_error
+    end
+  end
+end

data/spec/lib/fedex_ship/pickup_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'fedex_ship/shipment'
+
+describe FedexShip::Request::Pickup do
+  describe "pickup service" do
+    let(:fedex) { FedexShip::Shipment.new(fedex_production_credentials) }
+    let(:pickup_location) do
+      {:name => "Sender", :company => "Company", :phone_number => "555-555-5555 ", :address => "Main Street",
+       :city => "Mumbai", :state => "MH", :postal_code => "400012", :country_code => "IN"}
+    end
+    let(:packages) do
+      {:weight => {:units => "LB", :value => 2}, :count => 2}
+    end
+    let(:ready_timestamp) { DateTime.now + 1 }
+    let(:close_time) { DateTime.now + 1.2 }
+
+    context "alternate address", :vcr do
+      let(:options) do
+        {:carrier_code => "FDXE", :packages => packages, :ready_timestamp => ready_timestamp,
+         :close_time => close_time, :pickup_location => pickup_location, :remarks => 'TEST. DO NOT PICKUP', :commodity_description => 'Ladies Item as per invoice',
+         :country_relationship => 'DOMESTIC'
+       }
+      end
+
+      it "succeeds" do
+        expect {
+          @pickup = fedex.pickup(options)
+        }.to_not raise_error
+      end
+    end
+  end
+end

data/spec/lib/fedex_ship/rate_spec.rb

@@ -0,0 +1,216 @@
+require 'spec_helper'
+
+module FedexShip
+  describe Shipment do
+    context "missing required parameters" do
+      it "should raise Rate exception" do
+        expect{ Shipment.new}.to raise_error(RateError)
+      end
+    end
+
+    context "required parameters present" do
+      subject { Shipment.new(fedex_credentials) }
+      it "should create a valid instance" do
+        expect(subject).to be_an_instance_of(Shipment)
+      end
+    end
+
+    describe "rate service" do
+      let(:fedex) { Shipment.new(fedex_credentials) }
+      let(:shipper) do
+        { :name => "Sender", :company => "Company", :phone_number => "555-555-5555", :address => "Main Street", :city => "Harrison", :state => "AR", :postal_code => "72601", :country_code => "US" }
+      end
+      let(:recipient) do
+        { :name => "Recipient", :company => "Company", :phone_number => "555-555-5555", :address => "Main Street", :city => "Frankin Park", :state => "IL", :postal_code => "60131", :country_code => "US", :residential => true }
+      end
+      let(:packages) do
+        [
+          {
+            :weight => { :units => "LB", :value => 2 },
+            :dimensions => { :length => 10, :width => 5, :height => 4, :units => "IN" }
+          },
+          {
+            :weight => { :units => "LB", :value => 6 },
+            :dimensions => { :length => 5, :width => 5, :height => 4, :units => "IN" }
+          }
+        ]
+      end
+      let(:shipping_options) do
+        { :packaging_type => "YOUR_PACKAGING", :drop_off_type => "REGULAR_PICKUP" }
+      end
+
+      context "domestic shipment", :vcr do
+        it "should return a rate" do
+          rates = fedex.rate({ :shipper => shipper, :recipient => recipient, :packages => packages, :service_type => "FEDEX_GROUND"})
+          expect(rates.first).to be_an_instance_of(Rate)
+        end
+        it "should return a transit time" do
+          rates = fedex.rate({ :shipper => shipper, :recipient => recipient, :packages => packages, :service_type => "FEDEX_GROUND"})
+          expect(rates.first.transit_time).not_to be_nil
+        end
+      end
+
+      context "canadian shipment", :vcr do
+        it "should return a rate" do
+          canadian_recipient = { :name => "Recipient", :company => "Company", :phone_number => "555-555-5555", :address=>"Address Line 1", :city => "Richmond", :state => "BC", :postal_code => "V7C4V4", :country_code => "CA", :residential => "true" }
+          rates = fedex.rate({ :shipper => shipper, :recipient => canadian_recipient, :packages => packages, :service_type => "FEDEX_GROUND" })
+          expect(rates.first).to be_an_instance_of(Rate)
+        end
+      end
+
+      context "canadian shipment including customs", :vcr do
+        it "should return a rate including international fees" do
+          canadian_recipient = { :name => "Recipient", :company => "Company", :phone_number => "555-555-5555", :address=>"Address Line 1", :city => "Richmond", :state => "BC", :postal_code => "V7C4V4", :country_code => "CA", :residential => "true" }
+          broker = {
+            :account_number => "510087143",
+            :tins => { :tin_type => "BUSINESS_NATIONAL",
+                       :number  => "431870271",
+                       :usage => "Usage" },
+            :contact => { :contact_id => "1",
+                          :person_name => "Broker Name",
+                          :title => "Broker",
+                          :company_name => "Broker One",
+                          :phone_number => "555-555-5555",
+                          :phone_extension => "555-555-5555",
+                          :pager_number => "555",
+                          :fax_number=> "555-555-5555",
+                          :e_mail_address => "contact@me.com" },
+            :address => { :street_lines => "Main Street",
+                          :city => "Franklin Park",
+                          :state_or_province_code => 'IL',
+                          :postal_code => '60131',
+                          :urbanization_code => '123',
+                          :country_code => 'US',
+                          :residential => 'false' }
+          }
+
+          clearance_brokerage = "BROKER_INCLUSIVE"
+
+          importer_of_record= {
+            :account_number => "22222",
+            :tins => { :tin_type => "BUSINESS_NATIONAL",
+                       :number  => "22222",
+                       :usage => "Usage" },
+            :contact => { :contact_id => "1",
+                          :person_name => "Importer Name",
+                          :title => "Importer",
+                          :company_name => "Importer One",
+                          :phone_number => "555-555-5555",
+                          :phone_extension => "555-555-5555",
+                          :pager_number => "555",
+                          :fax_number=> "555-555-5555",
+                          :e_mail_address => "contact@me.com" },
+            :address => { :street_lines => "Main Street",
+                          :city => "Chicago",
+                          :state_or_province_code => 'IL',
+                          :postal_code => '60611',
+                          :urbanization_code => '2308',
+                          :country_code => 'US',
+                          :residential => 'false' }
+          }
+
+          recipient_customs_id = { :type => 'COMPANY',
+                                   :value => '1254587' }
+
+
+          duties_payment = { :payment_type => "SENDER",
+                             :payor => { :account_number => "510087143",
+                                         :country_code => "US" } }
+
+          customs_value = { :currency => "USD",
+                            :amount => "200" }
+          commodities = [{
+              :name => "Cotton Coat",
+              :number_of_pieces => "2",
+              :description => "Cotton Coat",
+              :country_of_manufacture => "US",
+              :harmonized_code => "6103320000",
+              :weight => { :units => "LB", :value => "2" },
+              :quantity => "3",
+              :unit_price => { :currency => "USD", :amount => "50" },
+              :customs_value => { :currency => "USD", :amount => "150" }
+            },
+            {
+              :name => "Poster",
+              :number_of_pieces => "1",
+              :description => "Paper Poster",
+              :country_of_manufacture => "US",
+              :harmonized_code => "4817100000",
+              :weight => { :units => "LB", :value => "0.2" },
+              :quantity => "3",
+              :unit_price => { :currency => "USD", :amount => "50" },
+              :customs_value => { :currency => "USD", :amount => "150" }
+            }
+          ]
+
+          customs_clearance = { :broker => broker, :clearance_brokerage => clearance_brokerage, :importer_of_record => importer_of_record, :recipient_customs_id => recipient_customs_id, :duties_payment => duties_payment, :commodities => commodities }
+          rates = fedex.rate({ :shipper => shipper, :recipient => canadian_recipient, :packages => packages, :service_type => "FEDEX_GROUND", :customs_clearance => customs_clearance })
+          expect(rates.first).to be_an_instance_of(Rate)
+        end
+      end
+
+      context "with service type specified", :vcr do
+
+        let(:rates) {
+          fedex.rate({
+            :shipper => shipper,
+            :recipient => recipient,
+            :packages => packages,
+            :service_type => "FEDEX_GROUND"
+          })
+        }
+
+        it "returns a single rate" do
+          expect(rates.count).to eq 1
+        end
+
+        it "has service_type attribute" do
+          rates.first.service_type == 'FEDEX_GROUND'
+        end
+
+      end
+
+      context "with no service type specified", :vcr do
+
+        let(:rates) {
+          fedex.rate({
+            :shipper => shipper,
+            :recipient => recipient,
+            :packages => packages
+          })
+        }
+
+        it "returns multiple rates" do
+          expect(rates.count).to be >= 1
+        end
+
+        context "each rate" do
+
+          it 'has service type attribute' do
+            expect(rates.first).to respond_to(:service_type)
+          end
+
+        end
+
+      end
+
+      context "when there are no valid services available", :vcr do
+
+        let(:bad_shipper) { shipper.merge(state: 'Anywhere') }
+        let(:rates) {
+          fedex.rate({
+            :shipper => bad_shipper,
+            :recipient => recipient,
+            :packages => packages
+          })
+        }
+
+        it 'returns empty array' do
+          expect(rates).to eq []
+        end
+
+      end
+
+    end
+  end
+end

data/spec/lib/fedex_ship/service_availability_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module FedexShip
+  describe 'ServiceAvailability' do
+    let(:fedex)  { Shipment.new(fedex_credentials) }
+    let(:origin) do {:postal_code => '400012', :country_code => 'IN'} end
+    let(:destination) do { :postal_code => '400020', :country_code => 'IN'} end
+    let(:options) do {:origin => origin, :destination => destination, :ship_date => '2014-06-28', :carrier_code => 'FDXE'} end
+
+    context 'Check Availability', :vcr do
+      it "succeeds" do
+        expect {
+            @service_availability = fedex.service_availability(options)
+          }.to_not raise_error
+
+        expect(@service_availability.class).not_to eq(FedexShip::RateError)
+      end
+    end
+  end
+end

data/spec/lib/fedex_ship/shipment_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'fedex_ship/shipment'
+
+describe FedexShip::Request::Shipment do
+  describe "ship service" do
+    let(:fedex) { FedexShip::Shipment.new(fedex_credentials) }
+    let(:shipper) do
+      { :name => "Sender", :company => "Company", :phone_number => "555-555-5555", :address => "Main Street", :city => "Harrison", :state => "AR", :postal_code => "72601", :country_code => "US" }
+    end
+    let(:recipient) do
+      { :name => "Recipient", :company => "Company", :phone_number => "555-555-5555", :address => "Main Street", :city => "Frankin Park", :state => "IL", :postal_code => "60131", :country_code => "US", :residential => true }
+    end
+    let(:packages) do
+      [
+        {
+          :weight => {:units => "LB", :value => 2},
+          :dimensions => {:length => 10, :width => 5, :height => 4, :units => "IN" }
+        }
+      ]
+    end
+    let(:shipping_options) do
+      { :packaging_type => "YOUR_PACKAGING", :drop_off_type => "REGULAR_PICKUP" }
+    end
+    let(:payment_options) do
+      { :type => "SENDER", :account_number => fedex_credentials[:account_number], :name => "Sender", :company => "Company", :phone_number => "555-555-5555", :country_code => "US" }
+    end
+
+    let(:filename) {
+      require 'tmpdir'
+      File.join(Dir.tmpdir, "label#{rand(15000)}.pdf")
+    }
+
+    context "domestic shipment", :vcr do
+      let(:options) do
+        { :shipper => shipper, :recipient => recipient, :packages => packages, :service_type => "FEDEX_GROUND", :filename => filename }
+      end
+
+      it "succeeds" do
+        expect {
+          @shipment = fedex.ship(options)
+        }.to_not raise_error
+
+        expect(@shipment.class).not_to eq(FedexShip::RateError)
+      end
+
+      it "succeeds with payments_options" do
+        expect {
+          @shipment = fedex.ship(options.merge(:payment_options => payment_options))
+        }.to_not raise_error
+
+        expect(@shipment.class).not_to eq(FedexShip::RateError)
+      end
+
+      it "should return a transit time" do
+        @shipment = fedex.ship(options)
+        expect(@shipment[:completed_shipment_detail][:operational_detail][:transit_time]).to eql("TWO_DAYS")
+      end
+
+    end
+
+    context 'without service_type specified', :vcr do
+      let(:options) do
+        { :shipper => shipper, :recipient => recipient, :packages => packages, :filename => filename }
+      end
+
+      it 'raises error' do
+        expect {
+          @shipment = fedex.ship(options)
+        }.to raise_error('Missing Required Parameter service_type')
+      end
+    end
+
+    context 'with invalid payment_options' do
+      let(:options) do
+        { :shipper => shipper, :recipient => recipient, :packages => packages, :filename => filename, :payment_options => payment_options.merge(:account_number => nil) }
+      end
+
+      it 'raises error' do
+        expect {
+          @shipment = fedex.ship(options)
+        }.to raise_error('Missing Required Parameter account_number')
+      end
+    end
+
+  end
+end