fedex 3.6.1 → 3.8.0

data/Readme.md

@@ -70,6 +70,21 @@ shipping_options = {
 }
 ```
 
+If you pass a non-nil `:return_reason` as part of the shipping options, you will create
+a return shipment. The request to fedex will include the following additional XML.
+
+```xml
+<SpecialServicesRequested>
+  <SpecialServiceTypes>RETURN_SHIPMENT</SpecialServiceTypes>
+  <ReturnShipmentDetail>
+    <ReturnType>PRINT_RETURN_LABEL</ReturnType>
+    <Rma>
+      <Reason>YOUR RETURN REASON HERE</Reason>
+    </Rma>
+  </ReturnShipmentDetail>
+</SpecialServicesRequested>
+```
+
 By default the shipping charges will be assigned to the sender. If you may
 change this by passing an extra hash of payment options.
 
@@ -131,7 +146,7 @@ ship = fedex.ship(:shipper=>shipper,
                   :packages => packages,
                   :service_type => "FEDEX_GROUND",
                   :shipping_options => shipping_options)
-puts ship[:completed_shipment_detail][:operational_detail] [:transit_time]
+puts ship[:completed_shipment_detail][:operational_detail][:transit_time]
 ```
 Above code will give you the transit time.
 
@@ -189,6 +204,97 @@ shipment.save!
 
 Documentation for setting up Paperclip with Amazon S3 can be found in the Paperclip [README](https://github.com/thoughtbot/paperclip/#storage).
 
+### ** Generate shipping labels for multi-package shipments (MPS) **
+
+Multiple packages for a single pick-up, destination and payer can be combined into a single MPS shipment. The first label will provide a master tracking number which must be used in the subsequent calls for the remaining packages in the shipment.
+
+Parameters for the first label:
+```ruby
+label = fedex.label(
+  :filename => file_name,
+  :shipper => shipper,
+  :recipient => recipient,
+  :packages => packages,
+  :service_type => service_type,
+  :shipping_details => shipping_details,
+  :shipping_charges_payment => shipping_charges_payment,
+  :customs_clearance_detail => customs_clearance_detail,
+  :mps => {:package_count => package_count, :total_weight => total_weight, :sequence_number => '1'}
+  )
+```
+
+Parameters for labels 2 through 'n':
+```ruby
+fedex.label(
+  :filename => file_name,
+  :shipper => shipper,
+  :recipient => recipient,
+  :packages => packages,
+  :service_type => service_type,
+  :shipping_details => shipping_details,
+  :shipping_charges_payment => shipping_charges_payment,
+  :customs_clearance_detail => customs_clearance_detail,
+  :mps => {
+      :master_tracking_id => {:tracking_id_type => 'FEDEX', :tracking_number =>tracking_number},
+      :package_count => package_count,
+      :total_weight => {
+          :value => total_weight,
+          :units => 'KG'
+      }
+      :sequence_number => 'n'
+      }
+   )
+```
+
+### ** Create COD Shipment **
+
+To create a Cash On Delivery label for a shipment:
+
+change "commerical_invoice = {:purpose => 'SOLD'}" in customs_clearance_detail
+
+add shipping_options with {:cod => {:currency => "currency", :amount => "amount", :collection_type => 'PAYMENT COLLECTION TYPE'}
+
+PAYMENT COLLECTION TYPE - CASH, CHEQUE, DEMAND DRAFT
+
+### ** To add multiple commodities in customs_clearance_detail
+
+use this format commodities_1 .... commodities_N
+
+example 
+
+```
+
+customs_clearance_detail['commodites_1'] 
+customs_clearance_detail['commodites_2']
+
+```
+
+### ** Masking shipper details in label **
+
+this allows you hide shipper details on the label
+
+Add customer_specified_detail = {:masked_data_1 => 'SOMETHING', :masked_data_2 => 'SOMETHING'} in :label_specification key
+
+Example
+
+```
+  customer_specified_detail = {
+      :masked_data_1 => "SHIPPER_ACCOUNT_NUMBER",
+      :masked_data_2 => "TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_NUMBER",
+      :masked_data_3 => "DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER"
+  }
+
+```
+
+### ** Delete a shipment **
+
+If you do not intend to use a label you should delete it. This will notify FedEx that you will not be using the label and they won't charge you. 
+
+To delete a shipment:
+
+```ruby
+fedex.delete(:tracking_number => "1234567890123")
+```
 
 ### ** Tracking a shipment **
 
@@ -219,7 +325,7 @@ To verify an address is valid and deliverable:
 ```ruby
 
 address = {
-  :address     => "5 Elm Street",
+  :street     => "5 Elm Street",
   :city        => "Norwalk",
   :state       => "CT",
   :postal_code => "06850",
@@ -238,12 +344,58 @@ address_result.postal_code
 # => "06850-3901"
 ```
 
+### ** Requesting a Pickup **
+
+To request a pickup:
+
+```ruby
+
+pickup = fedex.pickup(:carrier_code => 'FDXE',
+                      :packages => {:weight => {:units => "LB", :value => 10}, :count => 2},
+                      :ready_timestamp => Date.today.to_datetime + 1.375,
+                      :close_time => Date.today.to_time + 60 * 60 * 17)
+puts pickup[:pickup_confirmation_number]
+```
+
+### ** Getting pickup availability details **
+
+To check for pickup availability:
+
+```ruby
+
+dispatch = Date.tomorrow.strftime('%Y-%m-%d')
+
+pickup_availability = fedex.pickup_availability(:country_code => 'IN',
+                                   :postal_code => '400061',
+                                   :request_type => 'FUTURE_DAY',
+                                   :dispatch_date => dispatch_date,
+                                   :carrier_code => 'FDXE')
+
+puts pickup_availability[:options]
+```
+
+### ** Getting service availability **
+
+To check service availability:
+
+```ruby
+
+origin = {:postal_code => '400012', :country_code => 'IN'}
+destination = { :postal_code => '400020', :country_code => 'IN'}
+fedex_service_hash = {:origin => origin, :destination => destination, :ship_date => '2014-06-28', :carrier_code => 'FDXE'}
+
+service = fedex.service_availability(fedex_service_hash)
+
+puts service[:options]
+```
+
 # Services/Options Available
 
 ```ruby
 Fedex::Shipment::SERVICE_TYPES
 Fedex::Shipment::PACKAGING_TYPES
 Fedex::Shipment::DROP_OFF_TYPES
+Fedex::Shipment::CARRIER_CODES
 ````
 
 # Contributors:
@@ -259,6 +411,7 @@ Fedex::Shipment::DROP_OFF_TYPES
 - [yevgenko] (https://github.com/yevgenko) (Yevgeniy Viktorov)
 - [smartacus] (https://github.com/smartacus) (Michael Lippold)
 - [jonathandean] (https://github.com/jonathandean) (Jonathan Dean)
+- [chirag7jain] (https://github.com/chirag7jain) (Chirag Jain)
 - and more... (https://github.com/jazminschroeder/fedex/graphs/contributors)
 
 # Copyright/License:

data/fedex.gemspec

@@ -16,14 +16,14 @@ Gem::Specification.new do |s|
 
   s.license = 'MIT'
 
-  s.add_dependency 'httparty',            '~> 0.13.0'
-  s.add_dependency 'nokogiri',            '~> 1.6.0'
+  s.add_dependency 'httparty',            '>= 0.8.3'
+  s.add_dependency 'nokogiri',            '>= 1.5.6'
 
-  s.add_development_dependency "rspec",   '~> 2.9.0'
+  s.add_development_dependency "rspec",   '~> 3.0.0'
   s.add_development_dependency 'vcr',     '~> 2.0.0'
   s.add_development_dependency 'webmock', '~> 1.8.0'
   s.add_development_dependency 'pry'
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency 'rake'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/fedex/ground_manifest.rb

@@ -0,0 +1,25 @@
+require 'base64'
+require 'pathname'
+
+module Fedex
+  class GroundManifest
+    attr_reader :manifest_data, :filename
+
+    # Initialize Fedex::GroundManifest Object
+    # @param [Hash] options
+    def initialize(options = {})
+      puts options
+      @filename = options[:filename]
+      @manifest_data = Base64.decode64(options[:manifest][:file])
+      save
+    end
+
+    def save
+      return if manifest_data.nil? || filename.nil?
+      full_path = Pathname.new(filename)
+      File.open(full_path, 'wb') do |f|
+        f.write(manifest_data)
+      end
+    end
+  end
+end

data/lib/fedex/label.rb

@@ -7,14 +7,19 @@ module Fedex
 
     # Initialize Fedex::Label Object
     # @param [Hash] options
-    def initialize(label_details = {})
-      @response_details = label_details[:process_shipment_reply]
-      package_details = label_details[:process_shipment_reply][:completed_shipment_detail][:completed_package_details]
-      @options = package_details[:label]
+    def initialize(label_details = {}, associated_shipments = false)
+      if associated_shipments
+        package_details = label_details
+        @options = package_details[:label]
+        @options[:tracking_number] = package_details[:tracking_id]
+      else
+        @response_details = label_details[:process_shipment_reply]
+        package_details = label_details[:process_shipment_reply][:completed_shipment_detail][:completed_package_details]
+        @options = package_details[:label]
+        @options[:tracking_number] = package_details[:tracking_ids][:tracking_number]
+      end
       @options[:format] = label_details[:format]
-      @options[:tracking_number] = package_details[:tracking_ids][:tracking_number]
       @options[:file_name] = label_details[:file_name]
-
       @image = Base64.decode64(options[:parts][:image]) if has_image?
 
       if file_name = @options[:file_name]
@@ -52,5 +57,15 @@ module Fedex
         f.write(@image)
       end
     end
+
+    def associated_shipments
+      if (label_details = @response_details[:completed_shipment_detail][:associated_shipments])
+        label_details[:format] = format
+        label_details[:file_name] = file_name
+        Label.new(label_details, true)
+      else
+        nil
+      end
+    end
   end
 end

data/lib/fedex/rate.rb

@@ -18,9 +18,10 @@ module Fedex
     #     @total_net_freight #The freight charge minus dicounts
     #     @total_surcharges #The total amount of all surcharges applied to this shipment
     #     @total_base_charge #The total base charge
-    attr_accessor :service_type, :rate_type, :rate_zone, :total_billing_weight, :total_freight_discounts, :total_net_charge, :total_taxes, :total_net_freight, :total_surcharges, :total_base_charge
+    attr_accessor :service_type, :transit_time, :rate_type, :rate_zone, :total_billing_weight, :total_freight_discounts, :total_net_charge, :total_taxes, :total_net_freight, :total_surcharges, :total_base_charge
     def initialize(options = {})
       @service_type = options[:service_type]
+      @transit_time = options[:transit_time]
       @rate_type = options[:rate_type]
       @rate_zone = options[:rate_zone]
       @total_billing_weight = "#{options[:total_billing_weight][:value]} #{options[:total_billing_weight][:units]}"
@@ -34,4 +35,4 @@ module Fedex
       @total_rebates = (options[:total_rebates]||{})[:amount]
     end
   end
-end
+end

data/lib/fedex/request/base.rb

@@ -12,10 +12,10 @@ module Fedex
       # If true the rate method will return the complete response from the Fedex Web Service
       attr_accessor :debug
       # Fedex Text URL
-      TEST_URL = "https://gatewaybeta.fedex.com:443/xml/"
+      TEST_URL = "https://wsbeta.fedex.com:443/xml/"
 
       # Fedex Production URL
-      PRODUCTION_URL = "https://gateway.fedex.com:443/xml/"
+      PRODUCTION_URL = "https://ws.fedex.com:443/xml/"
 
       # List of available Service Types
       SERVICE_TYPES = %w(EUROPE_FIRST_INTERNATIONAL_PRIORITY FEDEX_1_DAY_FREIGHT FEDEX_2_DAY FEDEX_2_DAY_AM FEDEX_2_DAY_FREIGHT FEDEX_3_DAY_FREIGHT FEDEX_EXPRESS_SAVER FEDEX_FIRST_FREIGHT FEDEX_FREIGHT_ECONOMY FEDEX_FREIGHT_PRIORITY FEDEX_GROUND FIRST_OVERNIGHT GROUND_HOME_DELIVERY INTERNATIONAL_ECONOMY INTERNATIONAL_ECONOMY_FREIGHT INTERNATIONAL_FIRST INTERNATIONAL_PRIORITY INTERNATIONAL_PRIORITY_FREIGHT PRIORITY_OVERNIGHT SMART_POST STANDARD_OVERNIGHT)
@@ -35,6 +35,9 @@ module Fedex
       # List of available Payment Types
       PAYMENT_TYPE = %w(RECIPIENT SENDER THIRD_PARTY)
 
+      # List of available Carrier Codes
+      CARRIER_CODES = %w(FDXC FDXE FDXG FDCC FXFR FXSP)
+
       # In order to use Fedex rates API you must first apply for a developer(and later production keys),
       # Visit {http://www.fedex.com/us/developer/ Fedex Developer Center} for more information about how to obtain your keys.
       # @param [String] key - Fedex web service key
@@ -52,6 +55,13 @@ module Fedex
         @shipping_options =  options[:shipping_options] ||={}
         @payment_options = options[:payment_options] ||={}
         requires!(@payment_options, :type, :account_number, :name, :company, :phone_number, :country_code) if @payment_options.length > 0
+        if options.has_key?(:mps)
+          @mps = options[:mps]
+          requires!(@mps, :package_count, :total_weight, :sequence_number)
+          requires!(@mps, :master_tracking_id) if @mps.has_key?(:sequence_number) && @mps[:sequence_number].to_i >= 2
+        else
+          @mps = {}
+        end
         # Expects hash with addr and port
         if options[:http_proxy]
           self.class.http_proxy options[:http_proxy][:host], options[:http_proxy][:port]
@@ -175,13 +185,32 @@ module Fedex
         }
       end
 
+      # Add Master Tracking Id (for MPS Shipping Labels, this is required when requesting labels 2 through n)
+      def add_master_tracking_id(xml)
+        if @mps.has_key? :master_tracking_id
+          xml.MasterTrackingId{
+            xml.TrackingIdType @mps[:master_tracking_id][:tracking_id_type]
+            xml.TrackingNumber @mps[:master_tracking_id][:tracking_number]
+          }
+        end
+      end
+
       # Add packages to xml request
       def add_packages(xml)
+        add_master_tracking_id(xml) if @mps.has_key? :master_tracking_id
         package_count = @packages.size
-        xml.PackageCount package_count
+        if @mps.has_key? :package_count
+          xml.PackageCount @mps[:package_count]
+        else
+          xml.PackageCount package_count
+        end
         @packages.each do |package|
           xml.RequestedPackageLineItems{
-            xml.GroupPackageCount 1
+            if @mps.has_key? :sequence_number
+              xml.SequenceNumber @mps[:sequence_number]
+            else
+              xml.GroupPackageCount 1
+            end
             if package[:insured_value]
               xml.InsuredValue{
                 xml.Currency package[:insured_value][:currency]
@@ -294,7 +323,14 @@ module Fedex
       # Build xml nodes dynamically from the hash keys and values
       def hash_to_xml(xml, hash)
         hash.each do |key, value|
-          element = camelize(key)
+          key_s_down = key.to_s.downcase
+          if key_s_down.match(/^commodities_\d{1,}$/)
+            element = 'Commodities'
+          elsif key_s_down.match(/^masked_data_\d{1,}$/)
+            element = 'MaskedData'
+          else
+            element = camelize(key)
+          end
           if value.is_a?(Hash)
             xml.send element do |x|
               hash_to_xml(x, value)

data/lib/fedex/request/delete.rb

@@ -0,0 +1,62 @@
+require 'fedex/request/base'
+
+module Fedex
+  module Request
+    class Delete < Base
+
+      attr_reader :tracking_number
+
+      def initialize(credentials, options={})
+        requires!(options, :tracking_number)
+
+        @tracking_number  = options[:tracking_number]
+        @deletion_control = options[:deletion_control] || 'DELETE_ALL_PACKAGES'
+        @credentials  = credentials
+      end
+
+      def process_request
+        api_response = self.class.post(api_url, :body => build_xml)
+        puts api_response if @debug == true
+        response = parse_response(api_response)
+        unless success?(response)
+          error_message = if response[:shipment_reply]
+            [response[:shipment_reply][:notifications]].flatten.first[:message]
+          else
+            "#{api_response["Fault"]["detail"]["fault"]["reason"]}\n
+            --#{api_response["Fault"]["detail"]["fault"]["details"]["ValidationFailureDetail"]["message"].join("\n--")}"
+          end rescue $1
+          raise RateError, error_message
+        end
+      end
+
+      private
+
+      # Build xml Fedex Web Service request
+      def build_xml
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.DeleteShipmentRequest(:xmlns => "http://fedex.com/ws/ship/v#{service[:version]}"){
+            add_web_authentication_detail(xml)
+            add_client_detail(xml)
+            add_version(xml)
+            xml.TrackingId {
+              xml.TrackingIdType 'FEDEX'
+              xml.TrackingNumber @tracking_number
+            }
+            xml.DeletionControl @deletion_control
+          }
+        end
+        builder.doc.root.to_xml
+      end
+
+      def service
+        { :id => 'ship', :version => Fedex::API_VERSION }
+      end
+
+      # Successful request
+      def success?(response)
+        response[:shipment_reply] &&
+          %w{SUCCESS WARNING NOTE}.include?(response[:shipment_reply][:highest_severity])
+      end
+    end
+  end
+end