fedex 0.1.0 → 1.0.0

data/.gitignore

@@ -7,3 +7,4 @@ doc/*
 .yardoc/*
 pkg/*
 .yardopts
+fedex_credentials.yml

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/Readme.md

@@ -59,7 +59,7 @@ Create a Fedex::Shipment object using your FedEx credentials; mode should be eit
                                   :password => 'xxxx', 
                                   :account_number => 'xxxx', 
                                   :meter => 'xxx', 
-                                  :mode=>['production'|'development'])      
+                                  :mode=>'production')      
 
     rate = fedex.rate({:shipper=>shipper, :recipient => recipient, :packages => packages, :service_type => "FEDEX_GROUND", :shipping_details => shipping_details})    
     

data/lib/fedex/rate.rb

@@ -23,12 +23,14 @@ module Fedex
       @rate_type = options[:rate_type]
       @rate_zone = options[:rate_zone]
       @total_billing_weight = "#{options[:total_billing_weight][:value]} #{options[:total_billing_weight][:units]}"
-      @total_freight_discounts = options[:total_fright_discounts]
+      @total_freight_discounts = options[:total_freight_discounts]
       @total_net_charge = options[:total_net_charge][:amount]
       @total_taxes = options[:total_taxes][:amount]
       @total_net_freight = options[:total_net_freight][:amount]
       @total_surcharges = options[:total_surcharges][:amount]
       @total_base_charge = options[:total_base_charge][:amount]
+      @total_net_fedex_charge = (options[:total_net_fe_dex_charge]||={})[:amount] 
+      @total_rebates = (options[:total_rebates]||={})[:amount]
     end
   end
 end

data/lib/fedex/shipment.rb

@@ -6,7 +6,7 @@ module Fedex
     include HTTParty
     format :xml
     # If true the rate method will return the complete response from the Fedex Web Service
-    attr_accessor :raw_response
+    attr_accessor :debug
     # Fedex Text URL
     TEST_URL = "https://gatewaybeta.fedex.com:443/xml/"
     
@@ -25,6 +25,12 @@ module Fedex
     # List of available DropOffTypes
     DROP_OFF_TYPES = %w(BUSINESS_SERVICE_CENTER DROP_BOX REGULAR_PICKUP REQUEST_COURIER STATION)
     
+    # Clearance Brokerage Type
+    CLEARANCE_BROKERAGE_TYPE = %w(BROKER_INCLUSIVE BROKER_INCLUSIVE_NON_RESIDENT_IMPORTER BROKER_SELECT BROKER_SELECT_NON_RESIDENT_IMPORTER BROKER_UNASSIGNED)
+    
+    # Recipient Custom ID Type
+    RECIPIENT_CUSTOM_ID_TYPE = %w(COMPANY INDIVIDUAL PASSPORT)
+   
     # 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
@@ -50,7 +56,7 @@ module Fedex
     # @param [String] service_type, A valid fedex service type, to view a complete list of services Fedex::Shipment::SERVICE_TYPES
     def rate(options = {})
       requires!(options, :shipper, :recipient, :packages, :service_type)
-      @shipper, @recipient, @packages, @service_type = options[:shipper], options[:recipient], options[:packages], options[:service_type]
+      @shipper, @recipient, @packages, @service_type, @customs_clearance, @debug = options[:shipper], options[:recipient], options[:packages], options[:service_type], options[:customs_clearance], options[:debug]
       @shipping_options =  options[:shipping_options] ||={}
       process_request
     end
@@ -58,13 +64,13 @@ module Fedex
     # Sends post request to Fedex web service and parse the response, a Rate object is created if the response is successful 
     def process_request
       api_response = Shipment.post(api_url, :body => build_xml)
-      return api_response if @raw_response == true
+      puts api_response if @debug == true
       response = parse_response(api_response)
       if success?(response) 
         rate_details = [response[:rate_reply][:rate_reply_details][:rated_shipment_details]].flatten.first[:shipment_rate_detail]
         rate = Fedex::Rate.new(rate_details)
-    else
-        error_message = (response[:rate_reply].nil? ? api_response["Fault"]["detail"]["fault"]["details"]["ValidationFailureDetail"]["message"] : [response[:rate_reply][:notifications]].flatten.first[:message]) rescue "Unexpected error has occurred"
+      else
+        error_message = (response[:rate_reply].nil? ? api_response["Fault"]["detail"]["fault"]["reason"] : [response[:rate_reply][:notifications]].flatten.first[:message]) rescue $1
         raise RateError, error_message 
       end
     end
@@ -134,7 +140,7 @@ module Fedex
         add_shipper(xml)
         add_recipient(xml)
         add_shipping_charges_payment(xml)
-        add_commodities(xml) if @commoditites
+        add_customs_clearance(xml) if @customs_clearance
         xml.RateRequestTypes "ACCOUNT"
         add_packages(xml)
       }
@@ -209,48 +215,33 @@ module Fedex
       end  
     end
     
-    # Note: this method has not been implemented
-    def add_commodities(xml)
+    # Add customs clearance(for international shipments)
+    def add_customs_clearance(xml)
       xml.CustomsClearanceDetail{
-        xml.Broker{
-          xml.AccountNumber @account_number
-          xml.Tins {
-            xml.TinType "BUSINESS_NATIONAL" 
-            xml.Number "123456"
-            xml.Usage "Usage"
-          }
-        }
-        xml.DutiesPayment{
-          xml.PaymentType "SENDER"
-          xml.Payor{
-            xml.AccountNumber @account_number
-            xml.CountryCode @shipper[:country_code]
-          }
-        }  
-        xml.Commodities{
-           xml.Name 2
-           xml.NumberOfPieces 2
-           xml.Description "Cotton Coat"
-           xml.CountryOfManufacture "US"
-           xml.HarmonizedCode "6103320000"
-           xml.Weight {
-             xml.Units "LB"
-             xml.Value 2
-           }
-           xml.Quantity 3
-           xml.UnitPrice {
-             xml.Currency "US"
-             xml.Amount "50"
-           }
-           xml.CustomsValue {
-             xml.Currency "US"
-             xml.Amount "50"
-           }
-        }
+        customs_to_xml(xml, @customs_clearance)
       }
-      
     end
     
+    # Build nodes dinamically from the provided customs clearance hash
+    def customs_to_xml(xml, hash)
+      hash.each do |key, value|
+        if value.is_a?(Hash)
+          xml.send "#{camelize(key.to_s)}" do |x|
+            customs_to_xml(x, value)
+          end 
+        elsif value.is_a?(Array)
+          node = key
+          value.each do |v|
+            xml.send "#{camelize(node.to_s)}" do |x|
+              customs_to_xml(x, v)
+            end  
+          end  
+        else  
+          xml.send "#{camelize(key.to_s)}", value unless key.is_a?(Hash)
+        end  
+      end
+    end  
+    
     # Parse response, convert keys to underscore symbols
     def parse_response(response)
       response = sanitize_response_keys(response)
@@ -284,5 +275,11 @@ module Fedex
         @service_type
       end  
     end
+    
+    # String to CamelCase
+    def camelize(str)
+      str.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+    
   end
 end

data/lib/fedex/version.rb

@@ -1,4 +1,3 @@
-#Sept-2011
 module Fedex
-  VERSION = "0.1.0" 
+  VERSION = "1.0.0" 
 end

data/spec/config/fedex_credentials.example.yml

@@ -0,0 +1,13 @@
+development:
+  :key: 'xxx' 
+  :password: 'xxx'
+  :account_number: 'xxx'
+  :meter: 'xxx' 
+  :mode: 'test' 
+  
+production:  
+  :key: 'xxx' 
+  :password: 'xxx'
+  :account_number: 'xxx'
+  :meter: 'xxx' 
+  :mode: 'production'

data/spec/fedex_spec.rb

@@ -1,12 +1,6 @@
 require 'spec_helper'
 describe Fedex::Shipment do
-  let(:test_keys) do
-    {:key => "xxxx", :password => "xxxx", :account_number => "xxxx", :meter => "xxxx", :mode => "test"} 
-  end  
-  
-  let(:production_keys) do
-    {:key => "xxxx", :password => "xxxx", :account_number => "xxxx", :meter => "xxxx", :mode => "production"} 
-  end  
+  fedex_credentials ||= YAML.load(File.read("#{File.dirname(__FILE__)}/config/fedex_credentials.yml"))["development"]
   
   context "missing required parameters" do
     it "should raise Fedex::Rate exception" do
@@ -15,15 +9,15 @@ describe Fedex::Shipment do
   end
   
   context "required parameters present" do
-    subject { Fedex::Shipment.new(test_keys) }
+    subject { Fedex::Shipment.new(fedex_credentials) }
     it "should create a valid instance" do
       subject.should be_an_instance_of(Fedex::Shipment)
     end
   end
   
-  context "Published Rates(Development Mode)" do
+  describe "rate service" do
     before(:each) do
-      @fedex = Fedex::Shipment.new(test_keys)
+      @fedex = Fedex::Shipment.new(fedex_credentials)
       @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 = []
@@ -31,68 +25,112 @@ describe Fedex::Shipment do
                      :dimensions => {:length => 10, :width => 5, :height => 4, :units => "IN" } }
       @packages << { :weight => {:units => "LB", :value => 6}, 
                      :dimensions => {:length => 5, :width => 5, :height => 4, :units => "IN" } }
-      @shipping_options = { :packaging_type => "YOUR_PACKAGING", :drop_off_type => "REGULAR_PICKUP" }               
+      @shipping_options = { :packaging_type => "YOUR_PACKAGING", :drop_off_type => "REGULAR_PICKUP" }   
+
     end
-  
-    context "Domestic Shipment" do 
-      describe "rate" do
-        it "should return rate" do
-          rate = @fedex.rate({:shipper=>@shipper, :recipient => @recipient, :packages => @packages, :service_type => "FEDEX_GROUND"})
-          rate.should be_an_instance_of(Fedex::Rate)
-          puts rate.total_net_charge
-        
-        end
+    
+    context "domestic shipment" do
+      it "should return a rate" do
+        rate = @fedex.rate({:shipper => @shipper, :recipient => @recipient, :packages => @packages, :service_type => "FEDEX_GROUND"})
+        rate.should be_an_instance_of(Fedex::Rate)
       end
     end
-  
-    context "Canadian Shipment" do
-      describe "rate" do
-        it "shoule return international fees" do
-          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" }
-          rate = @fedex.rate({:shipper => @shipper, :recipient => recipient, :packages => @packages, :service_type => "FEDEX_GROUND", :shipping_options => @shipping_options })
-          rate.should be_an_instance_of(Fedex::Rate)
-          puts rate.total_net_charge
-        end
+    
+    context "canadian shipment" 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" }
+        rate = @fedex.rate({:shipper => @shipper, :recipient => canadian_recipient, :packages => @packages, :service_type => "FEDEX_GROUND"})
+        rate.should be_an_instance_of(Fedex::Rate)
       end
-    end  
-  end
-  
-  context "Discounted Rates(Production Mode)" do
-    before(:each) do
-      @fedex = Fedex::Shipment.new(production_keys)
-      @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 = []
-      @packages << { :weight => {:units => "LB", :value => 2}, 
-                     :dimensions => {:length => 10, :width => 5, :height => 4, :units => "IN" } }
-      @packages << { :weight => {:units => "LB", :value => 6}, 
-                     :dimensions => {:length => 5, :width => 5, :height => 4, :units => "IN" } }
-      @shipping_options = { :packaging_type => "YOUR_PACKAGING", :drop_off_type => "REGULAR_PICKUP" }               
     end
-  
-    context "Domestic Shipment" do 
-      describe "rate" do
-        it "should return rate" do
-          rate = @fedex.rate({:shipper=>@shipper, :recipient => @recipient, :packages => @packages, :service_type => "FEDEX_GROUND"})
-          rate.should be_an_instance_of(Fedex::Rate)
-          puts rate.total_net_charge
-        
-        end
+    
+    context "canadian shipment including customs" 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 = []                               
+        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" } }
+
+        commodities << { :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 }
+        rate = @fedex.rate({:shipper => @shipper, :recipient => canadian_recipient, :packages => @packages, :service_type => "FEDEX_GROUND", :customs_clearance => customs_clearance})
+        rate.should be_an_instance_of(Fedex::Rate)
       end
     end
-  
-    context "Canadian Shipment" do
-      describe "rate" do
-        it "shoule return international fees" do
-          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" }
-          rate = @fedex.rate({:shipper => @shipper, :recipient => recipient, :packages => @packages, :service_type => "FEDEX_GROUND", :shipping_options => @shipping_options })
-          rate.should be_an_instance_of(Fedex::Rate)
-          puts rate.total_net_charge
-        end
-      end
-    end  
   end
-
-end
+end  
+ 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fedex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-03 00:00:00.000000000Z
+date: 2012-03-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70151002532920 !ruby/object:Gem::Requirement
+  requirement: &70272415391000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70151002532920
+  version_requirements: *70272415391000
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70151002532420 !ruby/object:Gem::Requirement
+  requirement: &70272415390500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70151002532420
+  version_requirements: *70272415390500
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70151002531960 !ruby/object:Gem::Requirement
+  requirement: &70272415390040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70151002531960
+  version_requirements: *70272415390040
 description: Ruby Library to use Fedex Web Services(version 10)
 email:
 - jazminschroeder@gmail.com
@@ -61,6 +61,7 @@ files:
 - lib/fedex/rate.rb
 - lib/fedex/shipment.rb
 - lib/fedex/version.rb
+- spec/config/fedex_credentials.example.yml
 - spec/fedex_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jazminschroeder/fedex
@@ -88,5 +89,6 @@ signing_key:
 specification_version: 3
 summary: Fedex Rate Webservice
 test_files:
+- spec/config/fedex_credentials.example.yml
 - spec/fedex_spec.rb
 - spec/spec_helper.rb