active_shipping 0.1.4 → 0.9.1

data/CHANGELOG

@@ -1,3 +1,5 @@
+* Assume test_helper is in load path when running tests [cody]
+* Add support Kunaki rating service [cody]
 * Require active_support instead of activesupport to avoid deprecation warning in Rails 2.3.5 [cody]
 * Remove ftools for Rails 1.9 compatibility and remove xml logging, as logging is now included in the connection [cody]
 * Update connection code from ActiveMerchant [cody]

data/README.markdown

@@ -38,8 +38,6 @@ You will need to get [Git][] if you don't have it. Then:
   
 Active Shipping includes an init.rb file. This means that Rails will automatically load it on startup. Check out [git-archive][] for exporting the file tree from your repository to your vendor directory.
 
-Gem and tarball forthcoming on rubyforge.
-  
 [Git]:http://git.or.cz/
 [git-archive]:http://www.kernel.org/pub/software/scm/git/docs/git-archive.html
 
@@ -144,7 +142,6 @@ Gem and tarball forthcoming on rubyforge.
 
 * proper documentation
 * proper offline testing for carriers in addition to the remote tests
-* package into a gem
 * carrier code template generator
 * more carriers
 * integrate with ActiveMerchant

data/lib/active_merchant/common.rb

@@ -0,0 +1,14 @@
+module ActiveMerchant  
+  autoload :Connection,                'active_merchant/common/connection'
+  autoload :Country,                   'active_merchant/common/country'
+  autoload :ActiveMerchantError,       'active_merchant/common/error'
+  autoload :ConnectionError,           'active_merchant/common/error'
+  autoload :RetriableConnectionError,  'active_merchant/common/error'
+  autoload :ResponseError,             'active_merchant/common/error'
+  autoload :ClientCertificateError,    'active_merchant/common/error'
+  autoload :PostData,                  'active_merchant/common/post_data'
+  autoload :PostsData,                 'active_merchant/common/posts_data'
+  autoload :RequiresParameters,        'active_merchant/common/requires_parameters'
+  autoload :Utils,                     'active_merchant/common/utils'
+  autoload :Validateable,              'active_merchant/common/validateable'
+end

data/lib/{active_shipping/lib → active_merchant/common}/connection.rb

@@ -80,6 +80,8 @@ module ActiveMerchant
           raise ConnectionError, "The remote server reset the connection"
         rescue Errno::ECONNREFUSED => e
           raise RetriableConnectionError, "The remote server refused the connection"
+        rescue OpenSSL::X509::CertificateError => e
+          raise ClientCertificateError, "The remote server did not accept the provided SSL certificate"
         rescue Timeout::Error, Errno::ETIMEDOUT => e
           raise ConnectionError, "The connection to the remote server timed out"
         end

data/lib/active_merchant/common/error.rb

@@ -0,0 +1,26 @@
+module ActiveMerchant #:nodoc:
+  class ActiveMerchantError < StandardError #:nodoc:
+  end
+    
+  class ConnectionError < ActiveMerchantError # :nodoc:
+  end
+  
+  class RetriableConnectionError < ConnectionError # :nodoc:
+  end
+  
+  class ResponseError < ActiveMerchantError # :nodoc:
+    attr_reader :response
+
+    def initialize(response, message = nil)
+      @response = response
+      @message  = message
+    end
+
+    def to_s
+      "Failed with #{response.code} #{response.message if response.respond_to?(:message)}"
+    end
+  end
+  
+  class ClientCertificateError < ActiveMerchantError # :nodoc
+  end
+end

data/lib/active_merchant/common/post_data.rb

@@ -0,0 +1,24 @@
+require 'cgi'
+
+module ActiveMerchant
+  class PostData < Hash
+    class_inheritable_accessor :required_fields, :instance_writer => false
+    self.required_fields = []
+  
+    def []=(key, value)
+      return if value.blank? && !required?(key)
+      super
+    end
+  
+    def to_post_data
+      collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")  
+    end
+  
+    alias_method :to_s, :to_post_data
+  
+    private
+    def required?(key)
+      required_fields.include?(key)
+    end
+  end
+end

data/lib/active_shipping.rb

@@ -23,20 +23,19 @@
 
 $:.unshift File.dirname(__FILE__)
 
-require 'rubygems'
-require 'active_support'
+begin
+  require 'active_support/all'
+rescue LoadError => e
+  require 'rubygems'
+  gem "activesupport", ">= 2.3.5"
+  require "active_support/all"
+end
 
-require 'vendor/xml_node/lib/xml_node'
-require 'vendor/quantified/lib/quantified'
-require 'quantified/mass'
-require 'quantified/length'
+autoload :XmlNode, 'vendor/xml_node/lib/xml_node'
+autoload :Quantified, 'vendor/quantified/lib/quantified'
 
 require 'net/https'
-require 'active_shipping/lib/error'
-require 'active_shipping/lib/requires_parameters'
-require 'active_shipping/lib/connection'
-require 'active_shipping/lib/posts_data'
-require 'active_shipping/lib/country'
+require 'active_merchant/common'
 
 require 'active_shipping/shipping/base'
 require 'active_shipping/shipping/response'
@@ -45,17 +44,6 @@ require 'active_shipping/shipping/tracking_response'
 require 'active_shipping/shipping/package'
 require 'active_shipping/shipping/location'
 require 'active_shipping/shipping/rate_estimate'
-require 'active_shipping/shipping/location_response'
-require 'active_shipping/shipping/return_label_response'
-
-require 'active_shipping/shipping/contact'
-require 'active_shipping/shipping/party'
-require 'active_shipping/shipping/label'
-
-require 'active_shipping/shipping/shipment'
-require 'active_shipping/shipping/return_shipment'
-
 require 'active_shipping/shipping/shipment_event'
 require 'active_shipping/shipping/carrier'
 require 'active_shipping/shipping/carriers'
-

data/lib/active_shipping/shipping/base.rb

@@ -5,7 +5,8 @@ module ActiveMerchant
       self.mode = :production
       
       def self.carrier(name)
-        ActiveMerchant::Shipping::Carriers.all.find {|c| c.name.downcase == name}
+        ActiveMerchant::Shipping::Carriers.all.find {|c| c.name.downcase == name.to_s.downcase} ||
+          raise(NameError, "unknown carrier #{name}")
       end
     end
   end

data/lib/active_shipping/shipping/carrier.rb

@@ -45,11 +45,6 @@ module ActiveMerchant
       
       protected
       
-      def node_string_or_nil(xml_node)
-        text = node_text_or_nil(xml_node)
-        text ? text.to_s : nil
-      end
-      
       def node_text_or_nil(xml_node)
         xml_node ? xml_node.text : nil
       end

data/lib/active_shipping/shipping/carriers.rb

@@ -3,13 +3,14 @@ require 'active_shipping/shipping/carriers/ups'
 require 'active_shipping/shipping/carriers/usps'
 require 'active_shipping/shipping/carriers/fedex'
 require 'active_shipping/shipping/carriers/shipwire'
+require 'active_shipping/shipping/carriers/kunaki'
 
 module ActiveMerchant
   module Shipping
     module Carriers
       class <<self
         def all
-          [BogusCarrier, UPS, USPS, FedEx, Shipwire]
+          [BogusCarrier, UPS, USPS, FedEx, Shipwire, Kunaki]
         end
       end
     end

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

@@ -106,152 +106,8 @@ module ActiveMerchant
         response = commit(save_request(tracking_request), (options[:test] || false)).gsub(/<(\/)?.*?\:(.*?)>/, '<\1\2>')
         parse_tracking_response(response, options)
       end
-
-      def get_return_label(shipment, options = {})
-        req = build_return_label_request(shipment)
-        response = commit(save_request(req), (options[:test] || false)).gsub(/<(\/)?.*?\:(.*?)>/, '<\1\2>')
-
-        parse_return_label_response(response, shipment)
-      end
-
-      def validate_location(location, options = {})
-        req = build_location_validation_request(location)
-        response = commit(save_request(req), (options[:test] || false)).gsub(/<(\/)?.*?\:(.*?)>/, '<\1\2>')
-
-        parse_location_validation_request(response, location)
-      end
-
+      
       protected
-      def build_location_validation_request(location)
-        xml_request = XmlNode.new('AddressValidationRequest',
-          'xmlns' => 'http://fedex.com/ws/addressvalidation/v2') do |root_node|
-
-          root_node << build_request_header
-          root_node << XmlNode.new('Version') do |version_node|
-            version_node << XmlNode.new('ServiceId', 'aval')
-            version_node << XmlNode.new('Major', '2')
-            version_node << XmlNode.new('Intermediate', '0')
-            version_node << XmlNode.new('Minor', '0')
-          end
-
-          root_node << XmlNode.new('RequestTimestamp', Time.now)
-          root_node << XmlNode.new('Options', '')
-          root_node << XmlNode.new('AddressesToValidate') do |v|
-            v << build_party_location_node('Address', location)
-          end
-        end
-
-        xml_request.to_s
-      end
-
-      def parse_location_validation_request(response, location)
-        xml = REXML::Document.new(response)
-        success = response_success?(xml)
-        message = response_message(xml)
-
-        if success
-          parent = xml.elements.first
-          location.valid = parent.elements['//DeliveryPointValidation'][0] == 'CONFIRMED'
-          location.score = parent.elements['//Score'][0].to_s.to_i
-        else
-          location.valid = false
-          location.score = 0
-          message
-        end
-        LocationResponse.new(success, message, Hash.from_xml(response),
-          :xml => response,
-          :request => last_request,
-          :location => location
-        )
-      end
-
-      def parse_return_label_response(response, shipment)
-        xml = REXML::Document.new(response)
-        success = response_success?(xml)
-        message = response_message(xml)
-        
-        if success
-          parent = xml.elements.first
-          shipment.label.image = Base64.decode64(parent.elements['//Image'][0].to_s)
-          shipment.tracking_number = parent.elements['//TrackingNumber'][0].to_s
-          shipment.transit_time = parent.elements['//TransitTime'][0].to_s
-          
-          shipment
-        end
-        ReturnLabelResponse.new(success, message, Hash.from_xml(response),
-          :xml => response,
-          :request => last_request,
-          :shipment => shipment
-        )
-      end
-
-      def build_return_label_request(shipment)
-        xml_request = XmlNode.new('ProcessShipmentRequest', 
-          'xmlns' => 'http://fedex.com/ws/ship/v7') do |root_node|
-          root_node << build_request_header
-          root_node << XmlNode.new('Version') do |version_node|
-            version_node << XmlNode.new('ServiceId', 'ship')
-            version_node << XmlNode.new('Major', '7')
-            version_node << XmlNode.new('Intermediate', '0')
-            version_node << XmlNode.new('Minor', '0')
-          end
-          
-          root_node << XmlNode.new('RequestedShipment') do |rs|
-            rs << XmlNode.new('ShipTimestamp', shipment.ship_at || Time.now)
-            rs << XmlNode.new('DropoffType', shipment.dropoff_type)
-            rs << XmlNode.new('ServiceType', shipment.service)
-            rs << XmlNode.new('PackagingType', shipment.packaging_type)
-            rs << XmlNode.new('TotalWeight') do |t|
-              t << XmlNode.new('Units', shipment.total_weight_units)
-              t << XmlNode.new('Value', shipment.total_weight_value)
-            end
-            if shipment.total_insured_amount
-              rs << XmlNode.new('TotalInsuredValue') do |ins|
-                ins << XmlNode.new('Currency', shipment.total_insured_currency)
-                ins << XmlNode.new('Amount', shipment.total_insured_amount)
-              end
-            end
-            rs << build_party_node('Shipper', shipment.shipper)
-            rs << build_party_node('Recipient', shipment.recipient)
-            rs << XmlNode.new('ShippingChargesPayment') do |payment|
-              payment << XmlNode.new('PaymentType', shipment.payment_type)
-              payment << XmlNode.new('Payor') do |payor|
-                payor << XmlNode.new('AccountNumber', shipment.payor_account_number)
-                payor << XmlNode.new('CountryCode', shipment.payor_account_country.code(:alpha2))
-              end 
-            end
-
-            rs << XmlNode.new('SpecialServicesRequested') do |s|
-              s << XmlNode.new('SpecialServiceTypes', 'RETURN_SHIPMENT')
-              s << XmlNode.new('ReturnShipmentDetail') do |d| 
-                d << XmlNode.new('ReturnType', shipment.return_type)
-                d << XmlNode.new('Rma') do |rma|
-                  rma << XmlNode.new('Number', shipment.rma_number)
-                end
-              end
-            end
-
-            rs << XmlNode.new('LabelSpecification') do |spec|
-              spec << XmlNode.new('LabelFormatType', 
-                shipment.label.format_type || 'COMMON2D')
-              spec << XmlNode.new('ImageType', shipment.label.image_type)
-              spec << XmlNode.new('LabelStockType', 'PAPER_4X6')
-            end
-            rs << XmlNode.new('RateRequestTypes', shipment.rate_request_type)
-            rs << XmlNode.new('PackageCount', shipment.package_count)
-            rs << XmlNode.new('PackageDetail', 'PACKAGE_SUMMARY')
-            (1..shipment.package_count).each do |package_index|
-              rs << XmlNode.new('RequestedPackageLineItems') do |p|
-                p << XmlNode.new('SequenceNumber', package_index)
-              end 
-            end
-          end
-        end
-
-        xml_request.to_s
-      end
-
-
       def build_rate_request(origin, destination, packages, options={})
         imperial = ['US','LR','MM'].include?(origin.country_code(:alpha2))
 
@@ -349,47 +205,6 @@ module ActiveMerchant
         [web_authentication_detail, client_detail, trasaction_detail]
       end
             
-      def build_party_node(name, party)
-        XmlNode.new(name) do |xml_node|
-          if party.account_number
-            xml_node << XmlNode.new('AccountNumber', party.account_number)
-          end
-
-          if party.contact
-            xml_node << XmlNode.new('Contact') do |c|
-              c << XmlNode.new('PersonName', party.contact.name)
-              c << XmlNode.new('Title', party.contact.title)
-              c << XmlNode.new('CompanyName', party.contact.company_name)
-              c << XmlNode.new('PhoneNumber', party.contact.phone_number)
-              c << XmlNode.new('FaxNumber', party.contact.fax_number)
-              c << XmlNode.new('EMailAddress', party.contact.email_address)
-            end
-          end
-
-          
-          if party.location
-            xml_node << build_party_location_node('Address', party.location)
-          end
-        end
-      end
-
-      def build_party_location_node(name, location)
-        XmlNode.new(name) do |a|
-          if location.address1
-            a << XmlNode.new('StreetLines', location.address1) 
-          end
-
-          if location.address2
-            a << XmlNode.new('StreetLines', location.address2)
-          end
-
-          a << XmlNode.new('City', location.city)
-          a << XmlNode.new('StateOrProvinceCode', location.state)
-          a << XmlNode.new('PostalCode', location.zip)
-          a << XmlNode.new('CountryCode', location.country.code(:alpha2))
-        end
-      end
-
       def build_location_node(name, location)
         location_node = XmlNode.new(name) do |xml_node|
           xml_node << XmlNode.new('Address') do |address_node|
@@ -446,9 +261,8 @@ module ActiveMerchant
           tracking_number = tracking_details.get_text('TrackingNumber').to_s
           
           destination_node = tracking_details.elements['DestinationAddress']
-          
           destination = Location.new(
-                :country =>     destination_node.get_text('CountryCode').to_s.blank? ? 'US' : destination_node.get_text('CountryCode').to_s,
+                :country =>     destination_node.get_text('CountryCode').to_s,
                 :province =>    destination_node.get_text('StateOrProvinceCode').to_s,
                 :city =>        destination_node.get_text('City').to_s
               )
@@ -458,12 +272,14 @@ module ActiveMerchant
               :city => event.elements['Address'].get_text('City').to_s,
               :state => event.elements['Address'].get_text('StateOrProvinceCode').to_s,
               :postal_code => event.elements['Address'].get_text('PostalCode').to_s,
-              :country => event.elements['Address'].get_text('CountryCode').to_s.blank? ? 'US' : destination_node.get_text('CountryCode').to_s)
+              :country => event.elements['Address'].get_text('CountryCode').to_s)
             description = event.get_text('EventDescription').to_s
             
-            time = Time.parse(event.get_text('Timestamp').to_s)
+            # for now, just assume UTC, even though it probably isn't
+            time = Time.parse("#{event.get_text('Timestamp').to_s}")
+            zoneless_time = Time.utc(time.year, time.month, time.mday, time.hour, time.min, time.sec)
             
-            shipment_events << ShipmentEvent.new(description, time, location)
+            shipment_events << ShipmentEvent.new(description, zoneless_time, location)
           end
           shipment_events = shipment_events.sort_by(&:time)
         end

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

@@ -0,0 +1,165 @@
+require 'builder'
+
+module ActiveMerchant
+  module Shipping
+    class Kunaki < Carrier
+      self.retry_safe = true
+      
+      cattr_reader :name
+      @@name = "Kunaki"
+      
+      URL = 'https://Kunaki.com/XMLService.ASP'
+                   
+      CARRIERS = [ "UPS", "USPS", "FedEx", "Royal Mail", "Parcelforce", "Pharos", "Eurotrux", "Canada Post", "DHL" ]
+      
+      COUNTRIES = {
+        'AR' => 'Argentina',
+        'AU' => 'Australia',
+        'AT' => 'Austria',
+        'BE' => 'Belgium',
+        'BR' => 'Brazil',
+        'BG' => 'Bulgaria',
+        'CA' => 'Canada',
+        'CN' => 'China',
+        'CY' => 'Cyprus',
+        'CZ' => 'Czech Republic',
+        'DK' => 'Denmark',
+        'EE' => 'Estonia',
+        'FI' => 'Finland',
+        'FR' => 'France',
+        'DE' => 'Germany',
+        'GI' => 'Gibraltar',
+        'GR' => 'Greece',
+        'GL' => 'Greenland',
+        'HK' => 'Hong Kong',
+        'HU' => 'Hungary',
+        'IS' => 'Iceland',
+        'IE' => 'Ireland',
+        'IL' => 'Israel',
+        'IT' => 'Italy',
+        'JP' => 'Japan',
+        'LV' => 'Latvia',
+        'LI' => 'Liechtenstein',
+        'LT' => 'Lithuania',
+        'LU' => 'Luxembourg',
+        'MX' => 'Mexico',
+        'NL' => 'Netherlands',
+        'NZ' => 'New Zealand',
+        'NO' => 'Norway',
+        'PL' => 'Poland',
+        'PT' => 'Portugal',
+        'RO' => 'Romania',
+        'RU' => 'Russia',
+        'SG' => 'Singapore',
+        'SK' => 'Slovakia',
+        'SI' => 'Slovenia',
+        'ES' => 'Spain',
+        'SE' => 'Sweden',
+        'CH' => 'Switzerland',
+        'TW' => 'Taiwan',
+        'TR' => 'Turkey',
+        'UA' => 'Ukraine',
+        'GB' => 'United Kingdom',
+        'US' => 'United States',
+        'VA' => 'Vatican City',
+        'RS' => 'Yugoslavia',
+        'ME' => 'Yugoslavia'
+      }
+                        
+      def find_rates(origin, destination, packages, options = {})
+        requires!(options, :items)
+        commit(origin, destination, options)
+      end
+      
+      def valid_credentials?
+        true
+      end
+      
+      private      
+      def build_request(destination, options)
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        xml.tag! 'ShippingOptions' do
+          xml.tag! 'AddressInfo' do
+            xml.tag! 'Country', COUNTRIES[destination.country_code]
+            
+            state = ['US', 'CA'].include?(destination.country_code.to_s) ? destination.state : ''
+            
+            xml.tag! 'State_Province', state
+            xml.tag! 'PostalCode', destination.zip
+          end
+        
+          options[:items].each do |item|
+            xml.tag! 'Product' do
+              xml.tag! 'ProductId', item[:sku]
+              xml.tag! 'Quantity', item[:quantity]
+            end
+          end
+        end
+        xml.target!
+      end
+      
+      def commit(origin, destination, options)
+        request = build_request(destination, options)
+                
+        response = parse( ssl_post(URL, request, "Content-Type" => "text/xml") )
+        
+        RateResponse.new(success?(response), message_from(response), response, 
+          :rates => build_rate_estimates(response, origin, destination)
+        )
+      end
+      
+      def build_rate_estimates(response, origin, destination)
+        response["Options"].collect do |quote|
+          RateEstimate.new(origin, destination, carrier_for(quote["Description"]), quote["Description"],
+            :total_price  => quote["Price"],
+            :currency     => "USD"
+          )
+        end
+      end
+      
+      def carrier_for(service)
+        CARRIERS.dup.find{ |carrier| service.to_s =~ /^#{carrier}/i } || service.to_s.split(" ").first
+      end
+      
+      def parse(xml)
+        response = {}
+        response["Options"] = []
+        
+        document = REXML::Document.new(sanitize(xml))
+        
+        response["ErrorCode"] = parse_child_text(document.root, "ErrorCode")
+        response["ErrorText"] = parse_child_text(document.root, "ErrorText")
+             
+        document.root.elements.each("Option") do |e|
+          rate = {}
+          rate["Description"] = parse_child_text(e, "Description")
+          rate["Price"]       = parse_child_text(e, "Price")
+          response["Options"] << rate
+        end
+        response
+      end
+      
+      def sanitize(response)
+        result = response.to_s
+        result.gsub!("\r\n", "")
+        result.gsub!(/<(\/)?(BODY|HTML)>/, '')
+        result
+      end
+      
+      def parse_child_text(parent, name)
+        if element = parent.elements[name]
+          element.text
+        end
+      end
+      
+      def success?(response)
+        response["ErrorCode"] == "0"
+      end
+      
+      def message_from(response)
+        response["ErrorText"]
+      end
+    end
+  end
+end