fedex 3.0.0 → 3.1.0

data/Readme.md

@@ -248,6 +248,8 @@ Fedex::Shipment::DROP_OFF_TYPES
 - [janders223] (https://github.com/janders223) (Jim Anders)
 - [jlambert121] (https://github.com/jlambert121) (Justin Lambert)
 - [sborsje] (https://github.com/sborsje) (Stefan Borsje)
+- [bradediger] (https://github.com/bradediger) (Brad Ediger)
+- [yevgenko] (https://github.com/yevgenko) (Yevgeniy Viktorov)
 
 # Copyright/License:
 Copyright 2011 [Jazmin Schroeder](http://jazminschroeder.com)

data/fedex.gemspec

@@ -14,12 +14,12 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "fedex"
 
-  s.add_dependency 'httparty',            '~> 0.10.0'
+  s.add_dependency 'httparty',            '~> 0.11.0'
   s.add_dependency 'nokogiri',            '~> 1.5.0'
 
   s.add_development_dependency "rspec",   '~> 2.9.0'
   s.add_development_dependency 'vcr',     '~> 2.0.0'
-  s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'webmock', '~> 1.8.0'
   # s.add_runtime_dependency "rest-client"
 
   s.files         = `git ls-files`.split("\n")

data/lib/fedex/document.rb

@@ -0,0 +1,51 @@
+module Fedex
+  class Document
+    attr_reader :tracking_number, :filenames, :response_details
+
+    # Initialize Fedex::Document Object
+    # @param [Hash] options
+    def initialize(shipment_details = {})
+      @response_details = shipment_details[:process_shipment_reply]
+      @filenames = shipment_details[:filenames]
+
+      # extract label and tracking number
+      package_details = @response_details[:completed_shipment_detail][:completed_package_details]
+      label = package_details[:label]
+      @tracking_number = package_details[:tracking_ids][:tracking_number]
+
+      # extract shipment documents
+      shipment_documents = @response_details[:completed_shipment_detail][:shipment_documents] || []
+
+      # unify iteration interface
+      unless shipment_documents.kind_of?(Array)
+        shipment_documents = [shipment_documents]
+      end
+
+      # keeps the filenames which actually saved
+      save(@filenames[:label], label)
+
+      # save shipment documents
+      shipment_documents.each do |doc|
+        doc_type = doc[:type].downcase.to_sym
+        save(@filenames[doc_type], doc)
+      end
+    end
+
+    def save(path, content)
+      return unless path && has_image?(content)
+
+      image = Base64.decode64(content[:parts][:image])
+      full_path = Pathname.new(path)
+      File.open(full_path, 'wb') do|f|
+        f.write(image)
+      end
+
+      full_path
+    end
+
+    def has_image?(content)
+      content[:parts] && content[:parts][:image]
+    end
+
+  end
+end

data/lib/fedex/request/address.rb

@@ -23,7 +23,7 @@ module Fedex
           error_message = if response[:address_validation_reply]
             [response[:address_validation_reply][:notifications]].flatten.first[:message]
           else
-            "#{api_response["Fault"]["detail"]["fault"]["reason"]}\n#{api_response["Fault"]["detail"]["fault"]["details"]["ValidationFailureDetail"]["message"]}"
+            "#{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

data/lib/fedex/request/base.rb

@@ -47,6 +47,10 @@ module Fedex
         @shipper, @recipient, @packages, @service_type, @customs_clearance, @debug = options[:shipper], options[:recipient], options[:packages], options[:service_type], options[:customs_clearance], options[:debug]
         @debug = ENV['DEBUG'] == 'true'
         @shipping_options =  options[:shipping_options] ||={}
+        # Expects hash with addr and port
+        if options[:http_proxy]
+          self.class.http_proxy options[:http_proxy][:host], options[:http_proxy][:port]
+        end
       end
 
       # Sends post request to Fedex web service and parse the response.
@@ -78,7 +82,7 @@ module Fedex
         }
       end
 
-      # Add Version to xml request, using the latest version V10 Sept/2011
+      # Add Version to xml request, using the version identified in the subclass
       def add_version(xml)
         xml.Version{
           xml.ServiceId service[:id]
@@ -149,8 +153,19 @@ module Fedex
         xml.ShippingChargesPayment{
           xml.PaymentType "SENDER"
           xml.Payor{
-            xml.AccountNumber @credentials.account_number
-            xml.CountryCode @shipper[:country_code]
+            if service[:version] >= 12
+              xml.ResponsibleParty {
+                xml.AccountNumber @credentials.account_number
+                xml.Contact {
+                  xml.PersonName @shipper[:name]
+                  xml.CompanyName @shipper[:company]
+                  xml.PhoneNumber @shipper[:phone_number]
+                }
+              }
+            else
+              xml.AccountNumber @credentials.account_number
+              xml.CountryCode @shipper[:country_code]
+            end
           }
         }
       end
@@ -174,14 +189,7 @@ module Fedex
                 xml.Units package[:dimensions][:units]
               }
             end
-            if package[:customer_refrences]
-              xml.CustomerReferences{
-              package[:customer_refrences].each do |value|
-                 xml.CustomerReferenceType 'CUSTOMER_REFERENCE'
-                 xml.Value                 value
-              end
-              }
-            end
+            add_customer_references(xml, package)
             if package[:special_services_requested] && package[:special_services_requested][:special_service_types]
               xml.SpecialServicesRequested{
                 if package[:special_services_requested][:special_service_types].is_a? Array
@@ -231,6 +239,29 @@ module Fedex
         end
       end
 
+      def add_customer_references(xml, package)
+        # customer_refrences is a legacy misspelling
+        if refs = package[:customer_references] || package[:customer_refrences]
+          refs.each do |ref|
+            xml.CustomerReferences{
+              if ref.is_a?(Hash)
+                # :type can specify custom type:
+                #
+                # BILL_OF_LADING, CUSTOMER_REFERENCE, DEPARTMENT_NUMBER,
+                # ELECTRONIC_PRODUCT_CODE, INTRACOUNTRY_REGULATORY_REFERENCE,
+                # INVOICE_NUMBER, P_O_NUMBER, RMA_ASSOCIATION,
+                # SHIPMENT_INTEGRITY, STORE_NUMBER
+                xml.CustomerReferenceType ref[:type]
+                xml.Value                 ref[:value]
+              else
+                xml.CustomerReferenceType 'CUSTOMER_REFERENCE'
+                xml.Value                 ref
+              end
+            }
+          end
+        end
+      end
+
       # Add customs clearance(for international shipments)
       def add_customs_clearance(xml)
         xml.CustomsClearanceDetail{

data/lib/fedex/request/document.rb

@@ -0,0 +1,45 @@
+require 'fedex/request/shipment'
+require 'fedex/document'
+
+module Fedex
+  module Request
+    class Document < Shipment
+
+      def initialize(credentials, options={})
+        super(credentials, options)
+
+        @shipping_document = options[:shipping_document]
+        @filenames = options.fetch(:filenames) { {} }
+      end
+
+      def add_custom_components(xml)
+        super
+
+        add_shipping_document(xml) if @shipping_document
+      end
+
+      private
+
+      # Add shipping document specification
+      def add_shipping_document(xml)
+        xml.ShippingDocumentSpecification{
+          Array(@shipping_document[:shipping_document_types]).each do |type|
+            xml.ShippingDocumentTypes type
+          end
+          hash_to_xml(xml, @shipping_document.reject{ |k| k == :shipping_document_types})
+        }
+      end
+
+      def success_response(api_response, response)
+        super
+
+        shipment_documents = response.merge!({
+          :filenames => @filenames
+        })
+
+        Fedex::Document.new shipment_documents
+      end
+
+    end
+  end
+end

data/lib/fedex/request/rate.rb

@@ -15,7 +15,7 @@ module Fedex
           error_message = if response[:rate_reply]
             [response[:rate_reply][:notifications]].flatten.first[:message]
           else
-            "#{api_response["Fault"]["detail"]["fault"]["reason"]}\n#{api_response["Fault"]["detail"]["fault"]["details"]["ValidationFailureDetail"]["message"]}"
+            "#{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
@@ -40,8 +40,9 @@ module Fedex
 
       # Build xml Fedex Web Service request
       def build_xml
+        ns = "http://fedex.com/ws/rate/v#{service[:version]}"
         builder = Nokogiri::XML::Builder.new do |xml|
-          xml.RateRequest(:xmlns => "http://fedex.com/ws/rate/v10"){
+          xml.RateRequest(:xmlns => ns){
             add_web_authentication_detail(xml)
             add_client_detail(xml)
             add_version(xml)

data/lib/fedex/request/shipment.rb

@@ -44,6 +44,7 @@ module Fedex
           add_shipper(xml)
           add_recipient(xml)
           add_shipping_charges_payment(xml)
+          add_special_services(xml) if @shipping_options[:return_reason]
           add_customs_clearance(xml) if @customs_clearance
           add_custom_components(xml)
           xml.RateRequestTypes "ACCOUNT"
@@ -65,12 +66,24 @@ module Fedex
         }
       end
 
+      def add_special_services(xml)
+        xml.SpecialServicesRequested {
+          xml.SpecialServiceTypes "RETURN_SHIPMENT"
+          xml.ReturnShipmentDetail {
+            xml.ReturnType "PRINT_RETURN_LABEL"
+            xml.Rma {
+              xml.Reason "#{@shipping_options[:return_reason]}"
+            }
+          }
+        }
+      end
+
       # Callback used after a failed shipment response.
       def failure_response(api_response, response)
         error_message = if response[:process_shipment_reply]
           [response[:process_shipment_reply][:notifications]].flatten.first[:message]
         else
-          "#{api_response["Fault"]["detail"]["fault"]["reason"]}\n#{api_response["Fault"]["detail"]["fault"]["details"]["ValidationFailureDetail"]["message"]}"
+          "#{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
@@ -83,7 +96,7 @@ module Fedex
       # Build xml Fedex Web Service request
       def build_xml
         builder = Nokogiri::XML::Builder.new do |xml|
-          xml.ProcessShipmentRequest(:xmlns => "http://fedex.com/ws/ship/v10"){
+          xml.ProcessShipmentRequest(:xmlns => "http://fedex.com/ws/ship/v12"){
             add_web_authentication_detail(xml)
             add_client_detail(xml)
             add_version(xml)
@@ -94,7 +107,7 @@ module Fedex
       end
 
       def service
-        { :id => 'ship', :version => 10 }
+        { :id => 'ship', :version => 12 }
       end
 
       # Successful request

data/lib/fedex/request/tracking_information.rb

@@ -39,7 +39,7 @@ module Fedex
           error_message = if response[:track_reply]
             response[:track_reply][:notifications][:message]
           else
-            "#{api_response["Fault"]["detail"]["fault"]["reason"]}\n#{api_response["Fault"]["detail"]["fault"]["details"]["ValidationFailureDetail"]["message"]}"
+            "#{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

data/lib/fedex/shipment.rb

@@ -3,6 +3,7 @@ require 'fedex/request/label'
 require 'fedex/request/rate'
 require 'fedex/request/tracking_information'
 require 'fedex/request/address'
+require 'fedex/request/document'
 
 module Fedex
   class Shipment
@@ -57,5 +58,16 @@ module Fedex
       Request::TrackingInformation.new(@credentials, options).process_request
     end
 
+    # @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 [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
+    def document(options = {})
+      Request::Document.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
+                :delivery_at, :events, :unique_tracking_number, :details
 
     def initialize(details = {})
       @details = details
@@ -50,4 +50,4 @@ module Fedex
     end
 
   end
-end
+end

data/lib/fedex/version.rb

@@ -1,3 +1,3 @@
 module Fedex
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/spec/lib/fedex/document_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+require 'tmpdir'
+
+module Fedex
+  describe Document do
+    let(:fedex) { Shipment.new(fedex_credentials) }
+    let(:shipper) do
+      {:name => "Sender", :company => "Company", :phone_number => "555-555-5555", :address => "King Street", :city => "Ashbourne", :postal_code => "DE6 1EA", :country_code => "GB"}
+    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(:customs) do
+      {
+        :duties_payment => {
+          :payment_type => 'SENDER',
+          :payor => {
+            :responsible_party => {
+              :account_number => fedex_credentials[:account_number],
+              :contact => {
+                :person_name => 'Mr. Test',
+                :phone_number => '12345678'
+              }
+            }
+          }
+        },
+        :document_content => 'NON_DOCUMENTS',
+        :customs_value => {
+          :currency => 'UKL', # UK Pounds Sterling
+          :amount => 155.79
+        },
+        :commercial_invoice => {
+          :terms_of_sale => 'DDU'
+        },
+        :commodities => [
+          {
+            :number_of_pieces => 1,
+            :description => 'Pink Toy',
+            :country_of_manufacture => 'GB',
+            :weight => {
+              :units => 'LB',
+              :value => 2
+            },
+            :quantity => 1,
+            :quantity_units => 'EA',
+            :unit_price => {
+              :currency => 'UKL',
+              :amount => 155.79
+            },
+            :customs_value => {
+              :currency => 'UKL', # UK Pounds Sterling
+              :amount => 155.79
+            }
+          }
+        ]
+      }
+    end
+    let(:document) do
+      {
+        :shipping_document_types => 'COMMERCIAL_INVOICE',
+        :commercial_invoice_detail => {
+          :format => {
+            :image_type => 'PDF',
+            :stock_type => 'PAPER_LETTER'
+          }
+        }
+      }
+    end
+
+    let(:filenames) {
+      require 'tmpdir'
+      {
+        :label => File.join(Dir.tmpdir, "label#{rand(15000)}.pdf"),
+        :commercial_invoice => File.join(Dir.tmpdir, "invoice#{rand(15000)}.pdf")
+      }
+    }
+
+    let(:options) do
+      {
+        :shipper => shipper,
+        :recipient => recipient,
+        :packages => packages,
+        :service_type => "INTERNATIONAL_PRIORITY",
+        :shipping_details => shipping_options,
+        :customs_clearance => customs,
+        :shipping_document => document,
+        :filenames => filenames
+      }
+    end
+
+    describe 'document service', :vcr do
+
+      context 'with document specification' do
+
+        before do
+          @document = fedex.document(options)
+        end
+
+        it "saves a label to file" do
+          File.should exist(filenames[:label])
+        end
+
+        it "saves invoice to file" do
+          File.should exist(filenames[:commercial_invoice])
+        end
+
+        it "returns tracking number" do
+          @document.should respond_to('tracking_number')
+        end
+
+        it "exposes complete response" do
+          @document.should respond_to('response_details')
+        end
+
+        it "exposes the filenames" do
+          @document.should respond_to('filenames')
+        end
+
+      end
+
+      context 'without document specification' do
+
+        before do
+          @document = fedex.document(
+            options.reject{|k| k == :shipping_document}
+          )
+        end
+
+        it "saves a label to file" do
+          File.should exist(filenames[:label])
+        end
+
+        it "has no others files" do
+          File.should_not exist(filenames[:commercial_invoice])
+        end
+
+      end
+
+      context 'filename missed' do
+        context 'for label' do
+          before do
+            filenames.delete(:label)
+            @document = fedex.document(options)
+          end
+
+          it "saves invoice to file" do
+            File.should exist(filenames[:commercial_invoice])
+          end
+        end
+
+        context 'for invoice' do
+          before do
+            filenames.delete(:commercial_invoice)
+            @document = fedex.document(options)
+          end
+
+          it "saves label to file" do
+            File.should exist(filenames[:label])
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/spec/lib/fedex/track_spec.rb

@@ -12,7 +12,7 @@ module Fedex
         }
       end
 
-      let(:uuid) { "12012~123456789012~FDEG" }
+      let(:uuid) { fedex.track(options).first.unique_tracking_number }
 
       it "returns an array of tracking information results" do
         results = fedex.track(options)
@@ -20,9 +20,7 @@ module Fedex
       end
 
       it "returns events with tracking information" do
-        options[:uuid] = uuid
-
-        tracking_info = fedex.track(options).first
+        tracking_info = fedex.track(options.merge(:uuid => uuid)).first
 
         tracking_info.events.should_not be_empty
       end
@@ -44,13 +42,11 @@ module Fedex
       end
 
       it "reports the status of the package" do
-        options[:uuid] = uuid
-
-        tracking_info = fedex.track(options).first
+        tracking_info = fedex.track(options.merge(:uuid => uuid)).first
 
-        tracking_info.status.should == "In transit"
+        tracking_info.status.should == "Shipment cancelled by sender"
       end
 
     end
   end
-end
+end

data/spec/support/vcr.rb

@@ -2,7 +2,7 @@ require 'vcr'
 
 VCR.configure do |c|
   c.cassette_library_dir  = File.expand_path('../../vcr', __FILE__)
-  c.hook_into :fakeweb
+  c.hook_into :webmock
 end
 
 RSpec.configure do |c|
@@ -12,4 +12,4 @@ RSpec.configure do |c|
     name = underscorize(example.metadata[:full_description].split(/\s+/, 2).join("/")).gsub(/[^\w\/]+/, "_")
     VCR.use_cassette(name) { example.call }
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedex
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-02 00:00:00.000000000 Z
+date: 2013-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70168051584480 !ruby/object:Gem::Requirement
+  requirement: &70277283362620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
   type: :runtime
   prerelease: false
-  version_requirements: *70168051584480
+  version_requirements: *70277283362620
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70168051583980 !ruby/object:Gem::Requirement
+  requirement: &70277283377800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70168051583980
+  version_requirements: *70277283377800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70168051583460 !ruby/object:Gem::Requirement
+  requirement: &70277283377140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70168051583460
+  version_requirements: *70277283377140
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70168051582920 !ruby/object:Gem::Requirement
+  requirement: &70277283376280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,18 +54,18 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *70168051582920
+  version_requirements: *70277283376280
 - !ruby/object:Gem::Dependency
-  name: fakeweb
-  requirement: &70168051582460 !ruby/object:Gem::Requirement
+  name: webmock
+  requirement: &70277283375680 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :development
   prerelease: false
-  version_requirements: *70168051582460
+  version_requirements: *70277283375680
 description: Provides an interface to Fedex Web Services(version 10) - shipping rates,
   generate labels and address validation
 email:
@@ -83,11 +83,13 @@ files:
 - lib/fedex.rb
 - lib/fedex/address.rb
 - lib/fedex/credentials.rb
+- lib/fedex/document.rb
 - lib/fedex/helpers.rb
 - lib/fedex/label.rb
 - lib/fedex/rate.rb
 - lib/fedex/request/address.rb
 - lib/fedex/request/base.rb
+- lib/fedex/request/document.rb
 - lib/fedex/request/label.rb
 - lib/fedex/request/rate.rb
 - lib/fedex/request/shipment.rb
@@ -98,6 +100,7 @@ files:
 - lib/fedex/version.rb
 - spec/config/fedex_credentials.example.yml
 - spec/lib/fedex/address_spec.rb
+- spec/lib/fedex/document_spec.rb
 - spec/lib/fedex/label_spec.rb
 - spec/lib/fedex/rate_spec.rb
 - spec/lib/fedex/shipment_spec.rb
@@ -132,6 +135,7 @@ summary: Fedex Web Services
 test_files:
 - spec/config/fedex_credentials.example.yml
 - spec/lib/fedex/address_spec.rb
+- spec/lib/fedex/document_spec.rb
 - spec/lib/fedex/label_spec.rb
 - spec/lib/fedex/rate_spec.rb
 - spec/lib/fedex/shipment_spec.rb