active_shipping 0.9.11 → 0.9.12

data/CHANGELOG

@@ -1,3 +1,9 @@
+2011/04/21:
+* USPS updated to use new APIs [james]
+* new :gift boolean option for Package [james]
+* Location's :address_type can be "po_box" [james]
+
+Earlier:
 * New Zealand Post [AbleTech]
 * Include address name for rate requests to Shipwire if provided [dennis]
 * Add support for address name to Location [dennis]

data/lib/active_shipping/shipping/carriers/usps.rb

@@ -29,8 +29,8 @@ module ActiveMerchant
       TEST_RESOURCE = 'ShippingAPITest.dll'
       
       API_CODES = {
-        :us_rates => 'RateV3',
-        :world_rates => 'IntlRate',
+        :us_rates => 'RateV4',
+        :world_rates => 'IntlRateV2',
         :test => 'CarrierPickupAvailability'
       }
       USE_SSL = {
@@ -180,7 +180,7 @@ module ActiveMerchant
       end
       
       def world_rates(origin, destination, packages, options={})
-        request = build_world_rate_request(packages, destination.country)
+        request = build_world_rate_request(packages, destination)
          # never use test mode; rate requests just won't work on test servers
         parse_rate_response origin, destination, packages, commit(:world_rates,request,false), options
       end
@@ -204,7 +204,7 @@ module ActiveMerchant
       #                                  "machinability" entirely.
       def build_us_rate_request(packages, origin_zip, destination_zip, options={})
         packages = Array(packages)
-        request = XmlNode.new('RateV3Request', :USERID => @options[:login]) do |rate_request|
+        request = XmlNode.new('RateV4Request', :USERID => @options[:login]) do |rate_request|
           packages.each_with_index do |p,id|
             rate_request << XmlNode.new('Package', :ID => id.to_s) do |package|
               package << XmlNode.new('Service', US_SERVICES[options[:service] || :all])
@@ -212,9 +212,7 @@ module ActiveMerchant
               package << XmlNode.new('ZipDestination', strip_zip(destination_zip))
               package << XmlNode.new('Pounds', 0)
               package << XmlNode.new('Ounces', "%0.1f" % [p.ounces,1].max)
-              if p.options[:container] and [nil,:all,:express,:priority].include? p.service
-                package << XmlNode.new('Container', CONTAINERS[p.options[:container]])
-              end
+              package << XmlNode.new('Container', CONTAINERS[p.options[:container]])
               package << XmlNode.new('Size', USPS.size_code_for(p))
               package << XmlNode.new('Width', p.inches(:width))
               package << XmlNode.new('Length', p.inches(:length))
@@ -241,21 +239,34 @@ module ActiveMerchant
       # 
       # package.options[:mail_type] -- one of [:package, :postcard, :matter_for_the_blind, :envelope].
       #                                 Defaults to :package.
-      def build_world_rate_request(packages, destination_country)
-        country = COUNTRY_NAME_CONVERSIONS[destination_country.code(:alpha2).value] || destination_country.name
-        request = XmlNode.new('IntlRateRequest', :USERID => @options[:login]) do |rate_request|
+      def build_world_rate_request(packages, destination)
+        country = COUNTRY_NAME_CONVERSIONS[destination.country.code(:alpha2).value] || destination.country.name
+        request = XmlNode.new('IntlRateV2Request', :USERID => @options[:login]) do |rate_request|
           packages.each_index do |id|
             p = packages[id]
             rate_request << XmlNode.new('Package', :ID => id.to_s) do |package|
               package << XmlNode.new('Pounds', 0)
               package << XmlNode.new('Ounces', [p.ounces,1].max.ceil) #takes an integer for some reason, must be rounded UP
               package << XmlNode.new('MailType', MAIL_TYPES[p.options[:mail_type]] || 'Package')
-              if p.value && (p.value > 0) && (p.currency == 'USD')
-                package << XmlNode.new('ValueOfContents', p.value / 100.0)
+              package << XmlNode.new('GXG') do |gxg|
+                gxg << XmlNode.new('POBoxFlag', destination.po_box? ? 'Y' : 'N')
+                gxg << XmlNode.new('GiftFlag', p.gift? ? 'Y' : 'N')
+              end
+              value = if p.value && p.value > 0 && p.currency && p.currency != 'USD'
+                0.0
+              else
+                (p.value || 0) / 100.0
               end
+              package << XmlNode.new('ValueOfContents', value)
               package << XmlNode.new('Country') do |node|
                 node.cdata = country
               end
+              package << XmlNode.new('Container', p.cylinder? ? 'NONRECTANGULAR' : 'RECTANGULAR')
+              package << XmlNode.new('Size', USPS.size_code_for(p))
+              package << XmlNode.new('Width', [p.inches(:width), 0.01].max)
+              package << XmlNode.new('Length', [p.inches(:length), 0.01].max)
+              package << XmlNode.new('Height', [p.inches(:height), 0.01].max)
+              package << XmlNode.new('Girth', [p.inches(:girth), 0.01].max)
             end
           end
         end
@@ -285,41 +296,49 @@ module ActiveMerchant
             rate_hash = rates_from_response_node(xml, packages)
             unless rate_hash
               success = false
-              message = "Unknown root node in XML response: '#{root_node_name}'"
+              message = "Unknown root node in XML response: '#{xml.root.name}'"
             end
           end
           
         end
         
-        rate_estimates = rate_hash.keys.map do |service_name|
-          RateEstimate.new(origin,destination,@@name,"USPS #{service_name}",
-                                    :package_rates => rate_hash[service_name][:package_rates],
-                                    :service_code => rate_hash[service_name][:service_code],
-                                    :currency => 'USD')
+        if success
+          rate_estimates = rate_hash.keys.map do |service_name|
+            RateEstimate.new(origin,destination,@@name,"USPS #{service_name}",
+                                      :package_rates => rate_hash[service_name][:package_rates],
+                                      :service_code => rate_hash[service_name][:service_code],
+                                      :currency => 'USD')
+          end
+          rate_estimates.reject! {|e| e.package_count != packages.length}
+          rate_estimates = rate_estimates.sort_by(&:total_price)
         end
-        rate_estimates.reject! {|e| e.package_count != packages.length}
-        rate_estimates = rate_estimates.sort_by(&:total_price)
         
         RateResponse.new(success, message, Hash.from_xml(response), :rates => rate_estimates, :xml => response, :request => last_request)
       end
       
       def rates_from_response_node(response_node, packages)
         rate_hash = {}
-        return false unless (root_node = response_node.elements['/IntlRateResponse | /RateV3Response'])
-        domestic = (root_node.name == 'RateV3Response')
+        return false unless (root_node = response_node.elements['/IntlRateV2Response | /RateV4Response'])
+        domestic = (root_node.name == 'RateV4Response')
         
         domestic_elements = ['Postage', 'CLASSID', 'MailService', 'Rate']
         international_elements = ['Service', 'ID', 'SvcDescription', 'Postage']
         service_node, service_code_node, service_name_node, rate_node = domestic ? domestic_elements : international_elements
         
         root_node.each_element('Package') do |package_node|
-          package_index = package_node.attributes['ID'].to_i
+          this_package = packages[package_node.attributes['ID'].to_i]
           
           package_node.each_element(service_node) do |service_response_node|
             service_name = service_response_node.get_text(service_name_node).to_s
 
-            # workaround for USPS messing up and including unescaped html and asterisks in their rate names since Jan 2, 2011
-            service_name.gsub!(/&amp;lt;sup&amp;gt;&amp;amp;reg;&amp;lt;\/sup&amp;gt;|\*+$/, '')
+            # strips the double-escaped HTML for trademark symbols from service names
+            service_name.gsub!(/&amp;lt;\S*&amp;gt;/,'')
+            # ...leading "USPS"
+            service_name.gsub!(/^USPS/,'')
+            # ...trailing asterisks
+            service_name.gsub!(/\*+$/,'')
+            # ...surrounding spaces
+            service_name.strip!
 
             # aggregate specific package rates into a service-centric RateEstimate
             # first package with a given service name will initialize these;
@@ -327,7 +346,7 @@ module ActiveMerchant
             this_service = rate_hash[service_name] ||= {}
             this_service[:service_code] ||= service_response_node.attributes[service_code_node]
             package_rates = this_service[:package_rates] ||= []
-            this_package_rate = {:package => (this_package = packages[package_index]),
+            this_package_rate = {:package => this_package,
                                  :rate => Package.cents_from(service_response_node.get_text(rate_node).to_s.to_f)}
             
             package_rates << this_package_rate if package_valid_for_service(this_package,service_response_node)

data/lib/active_shipping/shipping/location.rb

@@ -1,6 +1,7 @@
 module ActiveMerchant #:nodoc:
   module Shipping #:nodoc:
     class Location
+      ADDRESS_TYPES = %w{residential commercial po_box}
       
       attr_reader :options,
                   :country,
@@ -34,8 +35,12 @@ module ActiveMerchant #:nodoc:
         @address3 = options[:address3]
         @phone = options[:phone]
         @fax = options[:fax]
-        raise ArgumentError.new('address_type must be either "residential" or "commercial"') if options[:address_type] and not (["residential", "commercial", ""]).include?(options[:address_type].to_s)
-        @address_type = options[:address_type].nil? ? nil : options[:address_type].to_s
+        if options[:address_type].present?
+          @address_type = options[:address_type].to_s
+          unless ADDRESS_TYPES.include?(@address_type)
+            raise ArgumentError.new("address_type must be one of #{ADDRESS_TYPES.map(&:inspect).join(', ')}")
+          end
+        end
       end
       
       def self.from(object, options={})
@@ -68,7 +73,7 @@ module ActiveMerchant #:nodoc:
             end
           end
         end
-        attributes.delete(:address_type) unless %w{residential commercial}.include?(attributes[:address_type].to_s)
+        attributes.delete(:address_type) unless ADDRESS_TYPES.include?(attributes[:address_type].to_s)
         self.new(attributes.update(options))
       end
       
@@ -76,8 +81,9 @@ module ActiveMerchant #:nodoc:
         @country.nil? ? nil : @country.code(format).value
       end
       
-      def residential?; (@address_type == 'residential') end
-      def commercial?; (@address_type == 'commercial') end
+      def residential?; @address_type == 'residential' end
+      def commercial?; @address_type == 'commercial' end
+      def po_box?; @address_type == 'po_box' end
       
       def to_s
         prettyprint.gsub(/\n/, ' ')

data/lib/active_shipping/shipping/package.rb

@@ -32,6 +32,7 @@ module ActiveMerchant #:nodoc:
         @value = Package.cents_from(options[:value])
         @currency = options[:currency] || (options[:value].currency if options[:value].respond_to?(:currency))
         @cylinder = (options[:cylinder] || options[:tube]) ? true : false
+        @gift = options[:gift] ? true : false
       end
   
       def cylinder?
@@ -39,6 +40,8 @@ module ActiveMerchant #:nodoc:
       end
       alias_method :tube?, :cylinder?
       
+      def gift?; @gift end
+      
       def ounces(options={})
         weight(options).in_ounces.amount
       end

data/lib/active_shipping/version.rb

@@ -1,3 +1,3 @@
 module ActiveShipping
-  VERSION = "0.9.11"
+  VERSION = "0.9.12"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_shipping
 version: !ruby/object:Gem::Version 
-  hash: 45
-  prerelease: false
+  hash: 35
+  prerelease: 
   segments: 
   - 0
   - 9
-  - 11
-  version: 0.9.11
+  - 12
+  version: 0.9.12
 platform: ruby
 authors: 
 - James MacAulay
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-30 00:00:00 -04:00
+date: 2011-04-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: active_shipping
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Shipping API extension for Active Merchant