fedex 3.6.1 → 3.8.0

data/lib/fedex/request/tracking_information.rb

@@ -32,8 +32,17 @@ module Fedex
         if success?(response)
           options = response[:track_reply][:track_details]
 
-          [options].flatten.map do |details|
-            Fedex::TrackingInformation.new(details)
+          if response[:track_reply][:duplicate_waybill].downcase == 'true'
+            shipments = []
+            [options].flatten.map do |details|
+              options = {:tracking_number => @package_id, :uuid => details[:tracking_number_unique_identifier]}
+              shipments << Request::TrackingInformation.new(@credentials, options).process_request
+            end
+            shipments.flatten
+          else
+            [options].flatten.map do |details|
+              Fedex::TrackingInformation.new(details)
+            end
           end
         else
           error_message = if response[:track_reply]

data/lib/fedex/shipment.rb

@@ -4,6 +4,11 @@ require 'fedex/request/rate'
 require 'fedex/request/tracking_information'
 require 'fedex/request/address'
 require 'fedex/request/document'
+require 'fedex/request/delete'
+require 'fedex/request/ground_close'
+require 'fedex/request/pickup'
+require 'fedex/request/pickup_availability'
+require 'fedex/request/service_availability'
 
 module Fedex
   class Shipment
@@ -23,7 +28,7 @@ module Fedex
 
     # @param [Hash] shipper, A hash containing the shipper information
     # @param [Hash] recipient, A hash containing the recipient information
-    # @param [Array] packages, An arrary including a hash for each package being shipped
+    # @param [Array] packages, An array including a hash for each package being shipped
     # @param [String] service_type, A valid fedex service type, to view a complete list of services Fedex::Shipment::SERVICE_TYPES
     # @param [String] filename, A location where the label will be saved
     # @param [Hash] label_specification, A hash containing the label printer settings
@@ -33,7 +38,7 @@ module Fedex
 
     # @param [Hash] shipper, A hash containing the shipper information
     # @param [Hash] recipient, A hash containing the recipient information
-    # @param [Array] packages, An arrary including a hash for each package being shipped
+    # @param [Array] packages, An array including a hash for each package being shipped
     # @param [String] service_type, A valid fedex service type, to view a complete list of services Fedex::Shipment::SERVICE_TYPES
     def rate(options = {})
       Request::Rate.new(@credentials, options).process_request
@@ -46,12 +51,21 @@ module Fedex
 
     # @param [Hash] shipper, A hash containing the shipper information
     # @param [Hash] recipient, A hash containing the recipient information
-    # @param [Array] packages, An arrary including a hash for each package being shipped
+    # @param [Array] packages, An array including a hash for each package being shipped
     # @param [String] service_type, A valid fedex service type, to view a complete list of services Fedex::Shipment::SERVICE_TYPES
     def ship(options = {})
       Request::Shipment.new(@credentials, options).process_request
     end
 
+    # @param [String] carrier_code, A valid fedex carrier code, to view a complete list of carrier codes Fedex::Shipment::CARRIER_CODES
+    # @param [Hash] packages, A hash containing the number of packages and their total weight
+    # @param [DateTime] ready_timestamp, A timestamp that indicates what day and time the package will be available for pickup
+    # @param [Time] close_time, The latest time that the business will be open to accept a pickup
+    # @param [Hash] pickup_location, A hash containing the pickup location information
+    def pickup(options = {})
+      Request::Pickup.new(@credentials, options).process_request
+    end
+
     # @param [Hash] package_id, A string with the requested tracking number
     # @param [Hash] package_type, A string identifitying the type of tracking number used. Full list Fedex::Track::PACKAGE_IDENTIFIER_TYPES
     def track(options = {})
@@ -60,14 +74,42 @@ module Fedex
 
     # @param [Hash] shipper, A hash containing the shipper information
     # @param [Hash] recipient, A hash containing the recipient information
-    # @param [Array] packages, An arrary including a hash for each package being shipped
+    # @param [Array] packages, An array including a hash for each package being shipped
     # @param [String] service_type, A valid fedex service type, to view a complete list of services Fedex::Shipment::SERVICE_TYPES
     # @param [Hash] customs_clearance, A hash containing customs clearance specification
     # @param [Hash] shipping_document, A hash containing shipping document specification
-    # @param [Array] filenames, A locations where the label and shipment documents will be saved
+    # @param [Array] filenames, A location where the label and shipment documents will be saved
     def document(options = {})
       Request::Document.new(@credentials, options).process_request
     end
 
+    # @param [Hash] package_id, A string with the tracking number to delete
+    def delete(options = {})
+      Request::Delete.new(@credentials, options).process_request
+    end
+
+    # @param [Date] up_to_time, A time up to which shipments are to be closed
+    # @param [String] filename, A location where the manifest (text file) will be saved
+    def ground_close(options = {})
+      Request::GroundClose.new(@credentials, options).process_request
+    end
+    # @param [String] country_code, A string containing country code
+    # @param [String] state_code, A string containing state code
+    # @param [String] postal_code, A string containing postal code
+    # @param [String] carrier_code, A string containing carrier code
+    # @param [String] request_type, A string with request type
+    # @param [String] dispatch_date, A string with dispatch date in YYYY-MM-DD format
+    def pickup_availability(options = {})
+      Request::PickupAvailability.new(@credentials, options).process_request
+    end
+    
+    # param [Hash] origin, A hash containing origin information
+    # param [Hash] destination, A hash containing destination information
+    # param [date] ship_date, A string containing ship date in YYYY-MM-DD format
+    # param [String] carrier_code, A string containing carrier code
+    def service_availability(options = {})
+      Request::ServiceAvailability.new(@credentials, options).process_request
+    end
+
   end
 end

data/lib/fedex/tracking_information.rb

@@ -29,7 +29,7 @@ module Fedex
     }
 
     attr_reader :tracking_number, :signature_name, :service_type, :status,
-                :delivery_at, :events, :unique_tracking_number, :details
+                :delivery_at, :events, :unique_tracking_number, :details, :other_identifiers
 
     def initialize(details = {})
       @details = details
@@ -39,6 +39,7 @@ module Fedex
       @signature_name         = details[:delivery_signature_name]
       @service_type           = details[:service_type]
       @status                 = details[:status_description]
+      @other_identifiers      = details[:other_identifiers]
 
       if details.has_key?(:actual_delivery_timestamp)
         @delivery_at = Time.parse(details[:actual_delivery_timestamp])

data/lib/fedex/tracking_information/event.rb

@@ -1,13 +1,15 @@
 module Fedex
   class TrackingInformation
     class Event
-      attr_reader :description, :type, :occured_at, :city, :state, :postal_code,
+      attr_reader :description, :type, :occurred_at, :city, :state, :postal_code,
                   :country, :residential, :exception_code, :exception_description
 
+      alias_method :occured_at, :occurred_at
+
       def initialize(details = {})
         @description           = details[:event_description]
         @type                  = details[:event_type]
-        @occured_at            = Time.parse(details[:timestamp])
+        @occurred_at            = Time.parse(details[:timestamp])
         @city                  = details[:address][:city]
         @state                 = details[:address][:state_or_province_code]
         @postal_code           = details[:address][:postal_code]
@@ -16,6 +18,7 @@ module Fedex
         @exception_code        = details[:status_exception_code]
         @exception_description = details[:status_exception_description]
       end
+
     end
   end
 end

data/lib/fedex/version.rb

@@ -1,4 +1,6 @@
 module Fedex
-  VERSION = "3.6.1"
+  VERSION = "3.8.0"
   API_VERSION = "13"
+  PICKUP_API_VERSION = "5"
+  SERVICE_AVAILABILITY_API_VERSION = "5"
 end

data/spec/lib/fedex/address_spec.rb

@@ -26,11 +26,11 @@ module Fedex
         it "validates the address" do
           address = fedex.validate_address(options)
 
-          address.residential.should be_true
-          address.business.should    be_false
-          address.score.should ==    100
+          expect(address.residential).to be_truthy
+          expect(address.business).to    be_falsey
+          expect(address.score).to eq(100)
 
-          address.postal_code.should == "06850-3901"
+          expect(address.postal_code).to eq("06850-3901")
         end
       end
 

data/spec/lib/fedex/delete_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Fedex
+  describe Shipment do
+    let (:fedex) { Shipment.new(fedex_credentials) }
+    context "#delete" do
+      context "delete shipment with tracking number", :vcr do
+        let(:options) do
+          { :tracking_number => '794608797150' }
+        end
+        it "deletes a shipment" do
+          expect{ fedex.delete(options) }.to_not raise_error
+        end
+      end
+      context "raise an error when the tracking number is invalid", :vcr do
+        let(:options) do
+          { :tracking_number => '111111111' }
+        end
+
+        it "raises an error" do
+          expect {fedex.delete(options) }.to raise_error(Fedex::RateError, 'Invalid tracking number')
+        end
+      end
+    end
+  end
+end

data/spec/lib/fedex/document_spec.rb

@@ -108,23 +108,23 @@ module Fedex
         end
 
         it "saves a label to file" do
-          File.should exist(filenames[:label])
+          expect(File).to exist(filenames[:label])
         end
 
         it "saves invoice to file" do
-          File.should exist(filenames[:commercial_invoice])
+          expect(File).to exist(filenames[:commercial_invoice])
         end
 
         it "returns tracking number" do
-          @document.should respond_to('tracking_number')
+          expect(@document).to respond_to('tracking_number')
         end
 
         it "exposes complete response" do
-          @document.should respond_to('response_details')
+          expect(@document).to respond_to('response_details')
         end
 
         it "exposes the filenames" do
-          @document.should respond_to('filenames')
+          expect(@document).to respond_to('filenames')
         end
 
       end
@@ -138,11 +138,11 @@ module Fedex
         end
 
         it "saves a label to file" do
-          File.should exist(filenames[:label])
+          expect(File).to exist(filenames[:label])
         end
 
         it "has no others files" do
-          File.should_not exist(filenames[:commercial_invoice])
+          expect(File).not_to exist(filenames[:commercial_invoice])
         end
 
       end
@@ -155,7 +155,7 @@ module Fedex
           end
 
           it "saves invoice to file" do
-            File.should exist(filenames[:commercial_invoice])
+            expect(File).to exist(filenames[:commercial_invoice])
           end
         end
 
@@ -166,7 +166,7 @@ module Fedex
           end
 
           it "saves label to file" do
-            File.should exist(filenames[:label])
+            expect(File).to exist(filenames[:label])
           end
         end
       end

data/spec/lib/fedex/ground_close_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Fedex
+  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(Fedex::RateError, 'No Shipments to Close')
+        end
+      end
+    end
+  end
+end

data/spec/lib/fedex/label_spec.rb

@@ -49,15 +49,15 @@ module Fedex
         end
 
         it "should create a label" do
-          File.should exist(filename)
+          expect(File).to exist(filename)
         end
 
         it "should return tracking number" do
-          @label.should respond_to('tracking_number')
+          expect(@label).to respond_to('tracking_number')
         end
 
         it "should expose complete response" do
-          @label.should respond_to('response_details')
+          expect(@label).to respond_to('response_details')
         end
         after do
           require 'fileutils'
@@ -65,7 +65,7 @@ module Fedex
         end
 
         it "should expose the file_name" do
-          @label.should respond_to('file_name')
+          expect(@label).to respond_to('file_name')
         end
       end
     end

data/spec/lib/fedex/pickup_availability_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'fedex/shipment'
+
+describe Fedex::Request::Pickup do
+  describe "pickup availability service" do
+    let(:fedex) { Fedex::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/pickup_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'fedex/shipment'
+
+describe Fedex::Request::Pickup do
+  describe "pickup service" do
+    let(:fedex) { Fedex::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/rate_spec.rb

@@ -4,14 +4,14 @@ module Fedex
   describe Shipment do
     context "missing required parameters" do
       it "should raise Rate exception" do
-        lambda{ Shipment.new}.should raise_error(RateError)
+        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
-        subject.should be_an_instance_of(Shipment)
+        expect(subject).to be_an_instance_of(Shipment)
       end
     end
 
@@ -42,7 +42,11 @@ module Fedex
       context "domestic shipment", :vcr do
         it "should return a rate" do
           rates = fedex.rate({ :shipper => shipper, :recipient => recipient, :packages => packages, :service_type => "FEDEX_GROUND"})
-          rates.first.should be_an_instance_of(Rate)
+          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
 
@@ -50,7 +54,7 @@ module Fedex
         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" })
-          rates.first.should be_an_instance_of(Rate)
+          expect(rates.first).to be_an_instance_of(Rate)
         end
       end
 
@@ -141,7 +145,7 @@ module Fedex
 
           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 })
-          rates.first.should be_an_instance_of(Rate)
+          expect(rates.first).to be_an_instance_of(Rate)
         end
       end
 
@@ -157,7 +161,7 @@ module Fedex
         }
 
         it "returns a single rate" do
-          rates.count.should eq 1
+          expect(rates.count).to eq 1
         end
 
         it "has service_type attribute" do
@@ -177,13 +181,13 @@ module Fedex
         }
 
         it "returns multiple rates" do
-          rates.count.should >= 1
+          expect(rates.count).to be >= 1
         end
 
         context "each rate" do
 
           it 'has service type attribute' do
-            rates.first.should respond_to(:service_type)
+            expect(rates.first).to respond_to(:service_type)
           end
 
         end
@@ -202,11 +206,11 @@ module Fedex
         }
 
         it 'returns empty array' do
-          rates.should eq []
+          expect(rates).to eq []
         end
 
       end
 
     end
   end
-end
+end