fedex 3.4.0 → 3.6.0

data/.gitignore

@@ -12,3 +12,4 @@ spec/vcr
 *.bbprojectd
 .DS_Store
 hacks
+.ruby-version

data/Readme.md

@@ -1,5 +1,5 @@
 # Fedex Rate Web Service
-
+## Fedex API Shipment Version: 13
 
 For more information visit [Fedex Web Services for Shipping](https://www.fedex.com/wpor/web/jsp/drclinks.jsp?links=wss/index.html).
 
@@ -11,14 +11,6 @@ Note: Please make sure to test your results.
 
 # Installation:
 
-Rails 3.x using Bundler's Gemfile:
-
-```ruby
-gem 'fedex'
-````
-
-Rails 2.x or without Rails or Bundler:
-
 ```ruby
 gem install fedex
 ```
@@ -28,6 +20,7 @@ gem install fedex
 Define the shipper:
 
 ```ruby
+
 shipper = { :name => "Sender",
             :company => "Company",
             :phone_number => "555-555-5555",
@@ -68,7 +61,7 @@ packages << {
 ```
 
 By default packaging type is "YOUR PACKAGING" and the drop off type is "REGULAR PICKUP".
-If you need something different you can pass an extra hash for shipping options
+If you need something different you can pass an extra hash for shipping options.
 
 ```ruby
 shipping_options = {
@@ -77,6 +70,20 @@ shipping_options = {
 }
 ```
 
+By default the shipping charges will be assigned to the sender. If you may
+change this by passing an extra hash of payment options.
+
+```ruby
+payment_options = {
+  :type => "THIRD_PARTY",
+  :account_number => "123456789",
+  :name => "Third Party Payor",
+  :company => "Company",
+  :phone_number => "555-555-5555",
+  :country_code => "US"
+}
+```
+
 Create a `Fedex::Shipment` object using your FedEx credentials; mode should be
 either production or development depending on what Fedex environment you want to use.
 
@@ -252,6 +259,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)
+- and more... (https://github.com/jazminschroeder/fedex/graphs/contributors)
 
 # Copyright/License:
 Copyright 2011 [Jazmin Schroeder](http://jazminschroeder.com)

data/fedex.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec",   '~> 2.9.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.files         = `git ls-files`.split("\n")

data/lib/fedex/request/address.rb

@@ -36,7 +36,7 @@ module Fedex
       # Build xml Fedex Web Service request
       def build_xml
         builder = Nokogiri::XML::Builder.new do |xml|
-          xml.AddressValidationRequest(:xmlns => "http://fedex.com/ws/addressvalidation/v2"){
+          xml.AddressValidationRequest(:xmlns => "http://fedex.com/ws/addressvalidation/v#{service[:version]}"){
             add_web_authentication_detail(xml)
             add_client_detail(xml)
             add_version(xml)

data/lib/fedex/request/base.rb

@@ -32,6 +32,9 @@ module Fedex
       # Recipient Custom ID Type
       RECIPIENT_CUSTOM_ID_TYPE = %w(COMPANY INDIVIDUAL PASSPORT)
 
+      # List of available Payment Types
+      PAYMENT_TYPE = %w(RECIPIENT SENDER THIRD_PARTY)
+
       # 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
@@ -44,9 +47,11 @@ module Fedex
       def initialize(credentials, options={})
         requires!(options, :shipper, :recipient, :packages)
         @credentials = credentials
-        @shipper, @recipient, @packages, @service_type, @customs_clearance, @debug = options[:shipper], options[:recipient], options[:packages], options[:service_type], options[:customs_clearance], options[:debug]
+        @shipper, @recipient, @packages, @service_type, @customs_clearance_detail, @debug = options[:shipper], options[:recipient], options[:packages], options[:service_type], options[:customs_clearance_detail], options[:debug]
         @debug = ENV['DEBUG'] == 'true'
         @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
         # Expects hash with addr and port
         if options[:http_proxy]
           self.class.http_proxy options[:http_proxy][:host], options[:http_proxy][:port]
@@ -101,7 +106,7 @@ module Fedex
           add_shipper(xml)
           add_recipient(xml)
           add_shipping_charges_payment(xml)
-          add_customs_clearance(xml) if @customs_clearance
+          add_customs_clearance(xml) if @customs_clearance_detail
           xml.RateRequestTypes "ACCOUNT"
           add_packages(xml)
         }
@@ -151,20 +156,20 @@ module Fedex
       # Add shipping charges to xml request
       def add_shipping_charges_payment(xml)
         xml.ShippingChargesPayment{
-          xml.PaymentType "SENDER"
+          xml.PaymentType @payment_options[:type] || "SENDER"
           xml.Payor{
-            if service[:version] >= 12
+            if service[:version].to_i >= Fedex::API_VERSION.to_i
               xml.ResponsibleParty {
-                xml.AccountNumber @credentials.account_number
+                xml.AccountNumber @payment_options[:account_number] || @credentials.account_number
                 xml.Contact {
-                  xml.PersonName @shipper[:name]
-                  xml.CompanyName @shipper[:company]
-                  xml.PhoneNumber @shipper[:phone_number]
+                  xml.PersonName @payment_options[:name] || @shipper[:name]
+                  xml.CompanyName @payment_options[:company] || @shipper[:company]
+                  xml.PhoneNumber @payment_options[:phone_number] || @shipper[:phone_number]
                 }
               }
             else
-              xml.AccountNumber @credentials.account_number
-              xml.CountryCode @shipper[:country_code]
+              xml.AccountNumber @payment_options[:account_number] || @credentials.account_number
+              xml.CountryCode @payment_options[:country_code] || @shipper[:country_code]
             end
           }
         }
@@ -271,7 +276,7 @@ module Fedex
       # Add customs clearance(for international shipments)
       def add_customs_clearance(xml)
         xml.CustomsClearanceDetail{
-          hash_to_xml(xml, @customs_clearance)
+          hash_to_xml(xml, @customs_clearance_detail)
         }
       end
 

data/lib/fedex/request/rate.rb

@@ -38,7 +38,7 @@ module Fedex
           add_shipper(xml)
           add_recipient(xml)
           add_shipping_charges_payment(xml)
-          add_customs_clearance(xml) if @customs_clearance
+          add_customs_clearance(xml) if @customs_clearance_detail
           xml.RateRequestTypes "ACCOUNT"
           add_packages(xml)
         }
@@ -59,7 +59,7 @@ module Fedex
       end
 
       def service
-        { :id => 'crs', :version => 10 }
+        { :id => 'crs', :version => Fedex::API_VERSION }
       end
 
       # Successful request

data/lib/fedex/request/shipment.rb

@@ -45,7 +45,7 @@ module Fedex
           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_customs_clearance(xml) if @customs_clearance_detail
           add_custom_components(xml)
           xml.RateRequestTypes "ACCOUNT"
           add_packages(xml)
@@ -96,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/v12"){
+          xml.ProcessShipmentRequest(:xmlns => "http://fedex.com/ws/ship/v#{service[:version]}"){
             add_web_authentication_detail(xml)
             add_client_detail(xml)
             add_version(xml)
@@ -107,7 +107,7 @@ module Fedex
       end
 
       def service
-        { :id => 'ship', :version => 12 }
+        { :id => 'ship', :version => Fedex::API_VERSION }
       end
 
       # Successful request

data/lib/fedex/version.rb

@@ -1,3 +1,4 @@
 module Fedex
-  VERSION = "3.4.0"
+  VERSION = "3.6.0"
+  API_VERSION = "13"
 end

data/spec/lib/fedex/document_spec.rb

@@ -93,7 +93,7 @@ module Fedex
         :packages => packages,
         :service_type => "INTERNATIONAL_PRIORITY",
         :shipping_details => shipping_options,
-        :customs_clearance => customs,
+        :customs_clearance_detail => customs,
         :shipping_document => document,
         :filenames => filenames
       }

data/spec/lib/fedex/rate_spec.rb

@@ -177,7 +177,7 @@ module Fedex
         }
 
         it "returns multiple rates" do
-          rates.count.should > 1
+          rates.count.should >= 1
         end
 
         context "each rate" do

data/spec/lib/fedex/shipment_spec.rb

@@ -21,6 +21,9 @@ describe Fedex::Request::Shipment do
     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'
@@ -39,6 +42,15 @@ describe Fedex::Request::Shipment do
 
         @shipment.class.should_not == Fedex::RateError
       end
+
+      it "succeeds with payments_options" do
+        expect {
+          @shipment = fedex.ship(options.merge(:payment_options => payment_options))
+        }.to_not raise_error
+
+        @shipment.class.should_not == Fedex::RateError
+      end
+
     end
 
     context 'without service_type specified', :vcr do
@@ -51,7 +63,18 @@ describe Fedex::Request::Shipment do
           @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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedex
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-11 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70203879296160 !ruby/object:Gem::Requirement
+  requirement: &70272120492060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.12.0
   type: :runtime
   prerelease: false
-  version_requirements: *70203879296160
+  version_requirements: *70272120492060
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70203879295600 !ruby/object:Gem::Requirement
+  requirement: &70272120491560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70203879295600
+  version_requirements: *70272120491560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70203879295140 !ruby/object:Gem::Requirement
+  requirement: &70272120491080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70203879295140
+  version_requirements: *70272120491080
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70203879294660 !ruby/object:Gem::Requirement
+  requirement: &70272120490580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *70203879294660
+  version_requirements: *70272120490580
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70203879294200 !ruby/object:Gem::Requirement
+  requirement: &70272120490100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,18 @@ dependencies:
         version: 1.8.0
   type: :development
   prerelease: false
-  version_requirements: *70203879294200
+  version_requirements: *70272120490100
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70272120489720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70272120489720
 description: Provides an interface to Fedex Web Services(version 10) - shipping rates,
   generate labels and address validation
 email: