fedex 1.0.0 → 2.0.1

data/.gitignore

@@ -8,3 +8,4 @@ doc/*
 pkg/*
 .yardopts
 fedex_credentials.yml
+spec/vcr

data/Readme.md

@@ -2,91 +2,149 @@
 
 For more information visit [Fedex Web Services for Shipping](https://www.fedex.com/wpor/web/jsp/drclinks.jsp?links=wss/index.html).
 
-This version uses the Non-SOAP Web Services so there is no need to download the Fedex WSDL files, note however that you will need to apply for 
-development/production credentials.
+This version uses the Non-SOAP Web Services so there is no need to download the
+Fedex WSDL files, note however that you will need to apply for development/production credentials.
 
 Note: This is work in progress make sure to test your results.
 
 # Installation:
-    // Rails 3.x
-    $ gem 'fedex'
-    
-    // Rails 2.x
-    $ gem install fedex 
+
+Rails 3.x using Bundler's Gemfile:
+
+```ruby
+gem 'fedex'
+````
+
+Rails 2.x or without Rails or Bundler:
+
+```ruby
+gem install fedex
+```
 
 # Usage example:
-   
+
 Define the shipper:
-                                     
-    shipper = { :name => "Sender", 
-                :company => "Company", 
-                :phone_number => "555-555-5555", 
-                :address => "Main Street", 
-                :city => "Harrison", 
-                :state => "AR", 
-                :postal_code => "72601", 
-                :country_code => "US" }
-
-Define the recipient:    
-
-    recipient = { :name => "Recipient", 
-                    :company => "Company", 
-                    :phone_number => "555-555-5555", 
-                    :address => "Main Street", 
-                    :city => "Franklin Park", 
-                    :state => "IL", 
-                    :postal_code => "60131", 
-                    :country_code => "US", 
-                    :residential => "false" }
-Define the packages(multiple packages in a single shipment are allowed):
-Note that all the Dimensions must be integers
-                    
-    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" } }
-
-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 details
-
-    shipping_details = { :packaging_type => "YOUR_PACKAGING", :drop_off_type => "REGULAR_PICKUP" }  
-       
-    
-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.
-
-    require 'fedex'
-    fedex = Fedex::Shipment.new(:key => 'xxx', 
-                                  :password => 'xxxx', 
-                                  :account_number => 'xxxx', 
-                                  :meter => 'xxx', 
-                                  :mode=>'production')      
-
-    rate = fedex.rate({:shipper=>shipper, :recipient => recipient, :packages => packages, :service_type => "FEDEX_GROUND", :shipping_details => shipping_details})    
-    
-Fedex provides multiple total values; total_net_charge is the final amount you are looking for. 
-    
-    $ rate.total_net_charge => "34.03"     
-    # Complete response                              
-    $ <Fedex::Rate:0x1019ba5f8 
-          @total_net_charge="34.03", 
-          @total_surcharges="1.93", 
-          @total_billing_weight="8.0 LB", 
-          @total_taxes="0.0",   
-          @rate_type="PAYOR_ACCOUNT_PACKAGE", 
-          @total_base_charge="32.1", 
-          @total_freight_discounts=nil, 
-          @total_net_freight="32.1", 
-          @rate_zone="51"> 
-       
-           
+
+```ruby
+shipper = { :name => "Sender",
+            :company => "Company",
+            :phone_number => "555-555-5555",
+            :address => "Main Street",
+            :city => "Harrison",
+            :state => "AR",
+            :postal_code => "72601",
+            :country_code => "US" }
+```
+
+Define the recipient:
+
+```ruby
+recipient = { :name => "Recipient",
+              :company => "Company",
+              :phone_number => "555-555-5555",
+              :address => "Main Street",
+              :city => "Franklin Park",
+              :state => "IL",
+              :postal_code => "60131",
+              :country_code => "US",
+              :residential => "false" }
+```
+
+Define the packages; multiple packages in a single shipment are allowed:
+Note that all the dimensions must be integers.
+
+```ruby
+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" }
+}
+```
+
+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 details
+
+```ruby
+shipping_details = {
+  :packaging_type => "YOUR_PACKAGING",
+  :drop_off_type => "REGULAR_PICKUP"
+}
+```
+
+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.
+
+```ruby
+require 'fedex'
+fedex = Fedex::Shipment.new(:key => 'xxx',
+                            :password => 'xxxx',
+                            :account_number => 'xxxx',
+                            :meter => 'xxx',
+                            :mode => 'production')
+```
+
+### ** Getting Shipping Rates **
+
+To find a shipping rate:
+
+```ruby
+rate = fedex.rate(:shipper=>shipper,
+                  :recipient => recipient,
+                  :packages => packages,
+                  :service_type => "FEDEX_GROUND",
+                  :shipping_details => shipping_details)
+```
+
+Fedex provides multiple total values; `total_net_charge` is the final amount you are looking for.
+
+```ruby
+    $ rate.total_net_charge => "34.03"
+    # Complete response
+    $ <Fedex::Rate:0x1019ba5f8
+          @total_net_charge="34.03",
+          @total_surcharges="1.93",
+          @total_billing_weight="8.0 LB",
+          @total_taxes="0.0",
+          @rate_type="PAYOR_ACCOUNT_PACKAGE",
+          @total_base_charge="32.1",
+          @total_freight_discounts=nil,
+          @total_net_freight="32.1",
+          @rate_zone="51">
+```
+
+### ** Generate a shipping label(PDF) **
+
+To create a label for a shipment:
+
+```ruby
+label = fedex.label(:filename => "my_dir/example.pdf",
+                    :shipper=>shipper,
+                    :recipient => recipient,
+                    :packages => packages,
+                    :service_type => "FEDEX_GROUND",
+                    :shipping_details => shipping_details)
+```
+
+The label will be saved to the file system as the filename you specify and is Adobe PDF format.
+Note that you can currently print a label for a single package at a time.
+
 # Services/Options Available
 
-    Fedex::Shipment::SERVICE_TYPES
-    Fedex::Shipment::PACKAGING_TYPES
-    Fedex::Shipment::DROP_OFF_TYPES
+```ruby
+Fedex::Shipment::SERVICE_TYPES
+Fedex::Shipment::PACKAGING_TYPES
+Fedex::Shipment::DROP_OFF_TYPES
+````
 
-# Copyright/License:
-Copyright 2011 Jazmin Schroeder
+# Contributors:
+- [jazminschroeder](http://github.com/jazminschroeder) (Jazmin Schroeder)
+- [parndt](https://github.com/parndt) (Philip Arndt)
 
-This gem is made available under the MIT license
+# Copyright/License:
+Copyright 2011 [Jazmin Schroeder](http://jazminschroeder.com)
 
+This gem is made available under the MIT license.

data/fedex.gemspec

@@ -13,9 +13,13 @@ Gem::Specification.new do |s|
   s.description = %q{Ruby Library to use Fedex Web Services(version 10)}
 
   s.rubyforge_project = "fedex"
-  s.add_development_dependency "rspec",   '~> 2.6.0'
+
   s.add_dependency 'httparty',            '~> 0.8.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_runtime_dependency "rest-client"
 
   s.files         = `git ls-files`.split("\n")
@@ -23,5 +27,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  
+
 end

data/lib/fedex.rb

@@ -1,54 +1,55 @@
-require "fedex/shipment"
-require "fedex/rate"
+require 'fedex/shipment'
+
 # Get shipping rates trough Fedex Web Services
-# 
+#
 # In order to use the API you will need to apply for developer/production credentials,
 # Visit {http://www.fedex.com/us/developer/ Fedex Developer Center} for more information about how to obtain your keys.
 #
 # ===Usage example
 #    #Use your own Fedex Keys
-#    fedex = Fedex::Shipment.new(:key => 'xxx', 
-#                               :password => 'xxxx', 
-#                               :account_number => 'xxxx', 
-#                               :meter => 'xxx', 
+#    fedex = Fedex::Shipment.new(:key => 'xxx',
+#                               :password => 'xxxx',
+#                               :account_number => 'xxxx',
+#                               :meter => 'xxx',
 #                               :mode=>['production'|'development'])
-#    shipper = {:name => "Sender", 
-#               :company => "Company", 
-#               :phone_number => "555-555-5555", 
-#               :address => "Main Street", 
-#               :city => "Harrison", 
-#               :state => "AR", 
-#               :postal_code => "72601", 
+#    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 => "City", 
-#                  :state => "ST", 
-#                  :postal_code => "55555", 
-#                  :country_code => "US", 
+#    recipient = { :name => "Recipient",
+#                  :company => "Company",
+#                  :phone_number => "555-555-5555",
+#                  :address => "Main Street",
+#                  :city => "City",
+#                  :state => "ST",
+#                  :postal_code => "55555",
+#                  :country_code => "US",
 #                  :residential => "false" }
 #    packages = []
-#    packages << { :weight => {:units => "LB", :value => 2}, 
+#    packages << { :weight => {:units => "LB", :value => 2},
 #                 :dimensions => {:length => 10, :width => 5, :height => 4, :units => "IN" } }
-#    packages << { :weight => {:units => "LB", :value => 6}, 
+#    packages << { :weight => {:units => "LB", :value => 6},
 #                 :dimensions => {:length => 5, :width => 5, :height => 4, :units => "IN" } }
 #    # "YOUR PACKAGING" and "REGULAR PICKUP" are the default options for all shipments but you can easily change them by passing an extra hash for #    shipping_options
-#    shipping_options = { :packaging_type => "YOUR_PACKAGING", :drop_off_type => "REGULAR_PICKUP" } 
+#    shipping_options = { :packaging_type => "YOUR_PACKAGING", :drop_off_type => "REGULAR_PICKUP" }
 #    rate = fedex.rate({:shipper=>shipper, :recipient => recipient, :packages => packages, :service_type => "FEDEX_GROUND", :shipping_options => #shipping_options})
-#    
-#    $ <Fedex::Rate:0x1019ba5f8 @total_net_charge="34.03", 
-#        @total_surcharges="1.93", 
-#        @total_billing_weight="8.0 LB", 
-#        @total_taxes="0.0",   
-#        @rate_type="PAYOR_ACCOUNT_PACKAGE", 
-#        @total_base_charge="32.1", 
-#        @total_freight_discounts=nil, 
-#        @total_net_freight="32.1", 
+#
+#    $ <Fedex::Rate:0x1019ba5f8 @total_net_charge="34.03",
+#        @total_surcharges="1.93",
+#        @total_billing_weight="8.0 LB",
+#        @total_taxes="0.0",
+#        @rate_type="PAYOR_ACCOUNT_PACKAGE",
+#        @total_base_charge="32.1",
+#        @total_freight_discounts=nil,
+#        @total_net_freight="32.1",
 #        @rate_zone="51">
 module Fedex
+  require 'fedex/version'
   #Exceptions: Fedex::RateError
   class RateError < StandardError; end
 end

data/lib/fedex/credentials.rb

@@ -0,0 +1,26 @@
+require 'fedex/helpers'
+
+module Fedex
+  class Credentials
+    include Helpers
+    attr_reader :key, :password, :account_number, :meter, :mode
+
+    # 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
+    # @param [String] password - Fedex password
+    # @param [String] account_number - Fedex account_number
+    # @param [String] meter - Fedex meter number
+    # @param [String] mode - [development/production]
+    #
+    # return a Fedex::Credentials object
+    def initialize(options={})
+      requires!(options, :key, :password, :account_number, :meter, :mode)
+      @key = options[:key]
+      @password = options[:password]
+      @account_number = options[:account_number]
+      @meter = options[:meter]
+      @mode = options[:mode]
+    end
+  end
+end

data/lib/fedex/helpers.rb

@@ -0,0 +1,19 @@
+module Fedex
+  module Helpers
+
+    private
+    # String to CamelCase
+    def camelize(str)
+      str.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+
+    # Helper method to validate required fields
+    def requires!(hash, *params)
+       params.each { |param| raise RateError, "Missing Required Parameter #{param}" if hash[param].nil? }
+    end
+
+    def underscorize(key) #:nodoc:
+      key.to_s.sub(/^(v[0-9]+|ns):/, "").gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
+    end
+  end
+end

data/lib/fedex/label.rb

@@ -0,0 +1,11 @@
+module Fedex
+  class Label
+    attr_accessor :options
+
+    # Initialize Fedex::Label Object
+    # @param [Hash] options
+    def initialize(options = {})
+      @options = options
+    end
+  end
+end

data/lib/fedex/rate.rb

@@ -1,14 +1,14 @@
 module Fedex
   # Visit {http://www.fedex.com/us/developer/ Fedex Developer Center} for a complete list of values returned from the API
   #
-  # Rate totals are contained in the node 
+  # Rate totals are contained in the node
   #    response[:rate_reply][:rate_reply_details][:rated_shipment_details]
   class Rate
-    # Initialize Fedex::Rate Object 
-    # @param [Hash] options 
+    # Initialize Fedex::Rate Object
+    # @param [Hash] options
     #
     #
-    # return [Fedex::Rate Object] 
+    # return [Fedex::Rate Object]
     #     @rate_type #Type used for this specific set of rate data
     #     @rate_zone #Indicates the rate zone used(based on origin and destination)
     #     @total_billing_weight #The weight used to calculate these rates
@@ -29,8 +29,8 @@ module Fedex
       @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]
+      @total_net_fedex_charge = (options[:total_net_fe_dex_charge]||{})[:amount]
+      @total_rebates = (options[:total_rebates]||{})[:amount]
     end
   end
 end

data/lib/fedex/request/base.rb

@@ -0,0 +1,251 @@
+require 'httparty'
+require 'nokogiri'
+require 'fedex/helpers'
+require 'fedex/rate'
+
+module Fedex
+  module Request
+    class Base
+      include Helpers
+      include HTTParty
+      format :xml
+      # 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/"
+
+      # Fedex Production URL
+      PRODUCTION_URL = "https://gateway.fedex.com:443/xml/"
+
+      # Fedex Version number for the Fedex service used
+      VERSION = 10
+
+      # 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)
+
+      # List of available Packaging Type
+      PACKAGING_TYPES = %w(FEDEX_10KG_BOX FEDEX_25KG_BOX FEDEX_BOX FEDEX_ENVELOPE FEDEX_PAK FEDEX_TUBE YOUR_PACKAGING)
+
+      # 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
+      # @param [String] password - Fedex password
+      # @param [String] account_number - Fedex account_number
+      # @param [String] meter - Fedex meter number
+      # @param [String] mode - [development/production]
+      #
+      # return a Fedex::Request::Base object
+      def initialize(credentials, options={})
+        requires!(options, :shipper, :recipient, :packages, :service_type)
+        @credentials = credentials
+        @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] ||={}
+      end
+
+      # Sends post request to Fedex web service and parse the response.
+      # Implemented by each subclass
+      def process_request
+        raise NotImplementedError, "Override process_request in subclass"
+      end
+
+      private
+      # Add web authentication detail information(key and password) to xml request
+      def add_web_authentication_detail(xml)
+        xml.WebAuthenticationDetail{
+          xml.UserCredential{
+            xml.Key @credentials.key
+            xml.Password @credentials.password
+          }
+        }
+      end
+
+      # Add Client Detail information(account_number and meter_number) to xml request
+      def add_client_detail(xml)
+        xml.ClientDetail{
+          xml.AccountNumber @credentials.account_number
+          xml.MeterNumber @credentials.meter
+        }
+      end
+
+      # Add Version to xml request, using the latest version V10 Sept/2011
+      def add_version(xml)
+        xml.Version{
+          xml.ServiceId service_id
+          xml.Major VERSION
+          xml.Intermediate 0
+          xml.Minor 0
+        }
+      end
+
+      # Add information for shipments
+      def add_requested_shipment(xml)
+        xml.RequestedShipment{
+          xml.DropoffType @shipping_options[:drop_off_type] ||= "REGULAR_PICKUP"
+          xml.ServiceType service_type
+          xml.PackagingType @shipping_options[:packaging_type] ||= "YOUR_PACKAGING"
+          add_shipper(xml)
+          add_recipient(xml)
+          add_shipping_charges_payment(xml)
+          add_customs_clearance(xml) if @customs_clearance
+          xml.RateRequestTypes "ACCOUNT"
+          add_packages(xml)
+        }
+      end
+
+      # Add shipper to xml request
+      def add_shipper(xml)
+        xml.Shipper{
+          xml.Contact{
+            xml.PersonName @shipper[:name]
+            xml.CompanyName @shipper[:company]
+            xml.PhoneNumber @shipper[:phone_number]
+          }
+          xml.Address {
+            Array(@shipper[:address]).take(2).each do |address_line|
+              xml.StreetLines address_line
+            end
+            xml.City @shipper[:city]
+            xml.StateOrProvinceCode @shipper[:state]
+            xml.PostalCode @shipper[:postal_code]
+            xml.CountryCode @shipper[:country_code]
+          }
+        }
+      end
+
+      # Add recipient to xml request
+      def add_recipient(xml)
+        xml.Recipient{
+          xml.Contact{
+            xml.PersonName @recipient[:name]
+            xml.CompanyName @recipient[:company]
+            xml.PhoneNumber @recipient[:phone_number]
+          }
+          xml.Address {
+            Array(@recipient[:address]).take(2).each do |address_line|
+              xml.StreetLines address_line
+            end
+            xml.City @recipient[:city]
+            xml.StateOrProvinceCode @recipient[:state]
+            xml.PostalCode @recipient[:postal_code]
+            xml.CountryCode @recipient[:country_code]
+            xml.Residential @recipient[:residential]
+          }
+        }
+      end
+
+      # Add shipping charges to xml request
+      def add_shipping_charges_payment(xml)
+        xml.ShippingChargesPayment{
+          xml.PaymentType "SENDER"
+          xml.Payor{
+            xml.AccountNumber @credentials.account_number
+            xml.CountryCode @shipper[:country_code]
+          }
+        }
+      end
+
+      # Add packages to xml request
+      def add_packages(xml)
+        package_count = @packages.size
+        xml.PackageCount package_count
+        @packages.each do |package|
+          xml.RequestedPackageLineItems{
+            xml.GroupPackageCount 1
+            xml.Weight{
+              xml.Units package[:weight][:units]
+              xml.Value package[:weight][:value]
+            }
+            xml.Dimensions{
+              xml.Length package[:dimensions][:length]
+              xml.Width package[:dimensions][:width]
+              xml.Height package[:dimensions][:height]
+              xml.Units package[:dimensions][:units]
+            }
+          }
+        end
+      end
+
+      # Add customs clearance(for international shipments)
+      def add_customs_clearance(xml)
+        xml.CustomsClearanceDetail{
+          customs_to_xml(xml, @customs_clearance)
+        }
+      end
+
+      # Fedex Web Service Api
+      def api_url
+        @credentials.mode == "production" ? PRODUCTION_URL : TEST_URL
+      end
+
+      # Build xml Fedex Web Service request
+      # Implemented by each subclass
+      def build_xml
+        raise NotImplementedError, "Override build_xml in subclass"
+      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)
+      end
+
+      # Recursively sanitizes the response object by clenaing up any hash keys.
+      def sanitize_response_keys(response)
+        if response.is_a?(Hash)
+          response.inject({}) { |result, (key, value)| result[underscorize(key).to_sym] = sanitize_response_keys(value); result }
+        elsif response.is_a?(Array)
+          response.collect { |result| sanitize_response_keys(result) }
+        else
+          response
+        end
+      end
+
+      def service_id
+        'crs'
+      end
+
+      # Use GROUND_HOME_DELIVERY for shipments going to a residential address within the US.
+      def service_type
+        if @recipient[:residential].to_s =~ /true/i and @service_type =~ /GROUND/i and @recipient[:country_code] =~ /US/i
+          "GROUND_HOME_DELIVERY"
+        else
+          @service_type
+        end
+      end
+
+      # Successful request
+      def success?(response)
+        (!response[:rate_reply].nil? and %w{SUCCESS WARNING NOTE}.include? response[:rate_reply][:highest_severity])
+      end
+
+    end
+  end
+end