active_shipping 0.9.2 → 0.9.3

data/CHANGELOG

@@ -1,3 +1,4 @@
+* Add carrier CanadaPost [william]
 * Update FedEx rates and added ability to auto-generate rate name from code that gets returned by FedEx [dennis]
 * Assume test_helper is in load path when running tests [cody]
 * Add support Kunaki rating service [cody]

data/README.markdown

@@ -16,6 +16,7 @@ Active Shipping is currently being used and improved in a production environment
 * [UPS](http://www.ups.com)
 * [USPS](http://www.usps.com)
 * [FedEx](http://www.fedex.com)
+* [Canada Post](http://www.canadapost.ca)
 * more soon!
 
 ## Prerequisites
@@ -43,6 +44,8 @@ Active Shipping includes an init.rb file. This means that Rails will automatical
 
 ## Sample Usage
 
+### Compare rates from different carriers
+
     require 'active_shipping'
     include ActiveMerchant::Shipping
   
@@ -91,21 +94,10 @@ Active Shipping includes an init.rb file. This means that Rails will automatical
     #     ["USPS Global Express Guaranteed Non-Document Rectangular", 9400],
     #     ["USPS Global Express Guaranteed", 9400]]
     
-    # FedEx
-    fdx = FedEx.new(:login => 'Your 9-digit FedEx Account #', :password => 'Your Meter Number')
-    response = fdx.find_rates(origin, destination, packages, :test => true)
-    response.rates.sort_by(&:price).collect {|rate| [rate.service_name, rate.price]}
-    # => [["FedEx Ground", 977], 
-    # ["FedEx Ground Home Delivery", 1388], 
-    # ["FedEx Express Saver", 2477], 
-    # ["FedEx 2 Day", 2718], 
-    # ["FedEx Standard Overnight", 4978], 
-    # ["FedEx Priority Overnight", 8636], 
-    # ["FedEx First Overnight", 12306]]
-    
-    # FedEx Tracking
-    fdx = FedEx.new(:login => '999999999', :password => '7777777')
-    tracking_info = fdx.find_tracking_info('tracking number here', :carrier_code => 'fedex_ground') # Ground package
+### Track a FedEx package
+
+    fedex = FedEx.new(:login => '999999999', :password => '7777777')
+    tracking_info = fedex.find_tracking_info('tracking-number', :carrier_code => 'fedex_ground') # Ground package
     
     tracking_info.shipment_events.each do |event|
       puts "#{event.name} at #{event.location.city}, #{event.location.state} on #{event.time}. #{event.message}"
@@ -117,34 +109,12 @@ Active Shipping includes an init.rb file. This means that Rails will automatical
     # Arrived at FedEx sort facility at KNOXVILLE, TN on Fri Oct 24 02:45:00 UTC 2008. 
     # Scanned at FedEx sort facility at KNOXVILLE, TN on Fri Oct 24 05:56:00 UTC 2008. 
     # Delivered at Knoxville, TN on Fri Oct 24 16:45:00 UTC 2008. Signed for by: T.BAKER
-    
-    tracking_info = fdx.find_tracking_info('tracking number here', :carrier_code => 'fedex_express') # Express package
-    
-    tracking_info.shipment_events.each do |event|
-      puts "#{event.name} at #{event.location.city}, #{event.location.state} on #{event.time}. #{event.message}"
-    end
-    # => Picked up by FedEx at NASHVILLE, TN on Wed Dec 03 16:46:00 UTC 2008. 
-    # Package status at MISSISSAUGA, ON on Wed Dec 03 18:00:00 UTC 2008. 
-    # Left FedEx Origin Location at NASHVILLE, TN on Wed Dec 03 20:27:00 UTC 2008. 
-    # Arrived at FedEx Ramp at NASHVILLE, TN on Wed Dec 03 20:43:00 UTC 2008. 
-    # Left FedEx Ramp at NASHVILLE, TN on Wed Dec 03 22:30:00 UTC 2008. 
-    # Arrived at Sort Facility at INDIANAPOLIS, IN on Thu Dec 04 00:31:00 UTC 2008. 
-    # Left FedEx Sort Facility at INDIANAPOLIS, IN on Thu Dec 04 01:14:00 UTC 2008. 
-    # Left FedEx Sort Facility at INDIANAPOLIS, IN on Thu Dec 04 04:48:00 UTC 2008. 
-    # Arrived at FedEx Ramp at MISSISSAUGA, ON on Thu Dec 04 06:26:00 UTC 2008. 
-    # Package status at MISSISSAUGA, ON on Thu Dec 04 07:03:00 UTC 2008. 
-    # Left FedEx Ramp at MISSISSAUGA, ON on Thu Dec 04 07:37:00 UTC 2008. 
-    # Arrived at FedEx Destination Location at TORONTO, ON on Thu Dec 04 08:42:00 UTC 2008. 
-    # On FedEx vehicle for delivery at TORONTO, ON on Thu Dec 04 09:04:00 UTC 2008. 
-    # Delivered to Non-FedEx clearance broker at TORONTO, ON on Thu Dec 04 10:15:00 UTC 2008.
 
 ## TODO
 
 * proper documentation
-* proper offline testing for carriers in addition to the remote tests
 * carrier code template generator
 * more carriers
-* integrate with ActiveMerchant
 * support more features for existing carriers
 * bin-packing algorithm (preferably implemented in ruby)
 * order tracking
@@ -164,6 +134,7 @@ The nicest way to submit changes would be to set up a GitHub account and fork th
 * Tobias Luetke (<http://blog.leetsoft.com>)
 * Cody Fauser (<http://codyfauser.com>)
 * Jimmy Baker (<http://jimmyville.com/>)
+* William Lang (<http://williamlang.net/>)
 
 ## Legal Mumbo Jumbo
 

data/lib/active_shipping/shipping/carriers.rb

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

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

@@ -0,0 +1,254 @@
+require 'cgi'
+
+module ActiveMerchant
+  module Shipping
+    
+    class CanadaPost < Carrier
+      
+      # NOTE!
+      # A Merchant CPC Id must be assigned to you by Canada Post
+      # CPC_DEMO_XML is just a public domain account for testing
+      
+      class CanadaPostRateResponse < RateResponse
+        
+        attr_reader :boxes, :postal_outlets
+        
+        def initialize(success, message, params = {}, options = {})
+          @boxes = options[:boxes]
+          @postal_outlets = options[:postal_outlets]
+          super
+        end
+        
+      end
+      
+      cattr_reader :name, :name_french
+      @@name = "Canada Post"
+      @@name_french = "Postes Canada"
+      
+      Box = Struct.new(:name, :weight, :expediter_weight, :length, :width, :height, :packedItems)
+      PackedItem = Struct.new(:quantity, :description)
+      PostalOutlet = Struct.new(:sequence_no, :distance, :name, :business_name, :postal_address, :business_hours)
+      
+      DEFAULT_TURN_AROUND_TIME = 24
+      URL = "http://sellonline.canadapost.ca:30000"
+      DOCTYPE = '<!DOCTYPE eparcel SYSTEM "http://sellonline.canadapost.ca/DevelopersResources/protocolV3/eParcel.dtd">'      
+      
+      RESPONSE_CODES = {
+       '1'     =>	"All calculation was done",
+       '2'     =>	"Default shipping rates are returned due to a problem during the processing of the request.",
+       '-2'    => "Missing argument when calling module",
+       '-5'	   => "No Item to ship",
+       '-6'	   => "Illegal Item weight",
+       '-7'	   => "Illegal item dimension",
+       '-12'   => "Can't open IM config file",
+       '-13'   => "Can't create log files",
+       '-15'   => "Invalid config file format",
+       '-102'  => "Invalid socket connection",
+       '-106'  => "Can't connect to server",
+       '-1000' => "Unknow request type sent by client",
+       '-1002' => "MAS Timed out",
+       '-1004' => "Socket communication break",
+       '-1005' => "Did not receive required data on socket.",
+       '-2000' => "Unable to estabish socket connection with RSSS",
+       '-2001' => "Merchant Id not found on server",
+       '-2002' => "One or more parameter was not sent by the IM to the MAS",
+       '-2003' => "Did not receive required data on socket.",
+       '-2004' => "The request contains to many items to process it.",
+       '-2005' => "The request received on socket is larger than the maximum allowed.",
+       '-3000' => "Origin Postal Code is illegal",
+       '-3001' => "Destination Postal Code/State Name/ Country  is illegal",
+       '-3002' => "Parcel too large to be shipped with CPC",
+       '-3003' => "Parcel too small to be shipped with CPC",
+       '-3004' => "Parcel too heavy to be shipped with CPC",
+       '-3005' => "Internal error code returned by the rating DLL",
+       '-3006' => "The pick up time format is invalid or not defined.",
+       '-4000' => "Volumetric internal error",
+       '-4001' => "Volumetric time out calculation error.",
+       '-4002' => "No bins provided to the volumetric engine.",
+       '-4003' => "No items provided to the volumetric engine.",
+       '-4004' => "Item is too large to be packed",
+       '-4005' => "Number of item more than maximum allowed",
+       '-5000' => "XML Parsing error",
+       '-5001' => "XML Tag not found",
+       '-5002' => "Node Value Number format error",
+       '-5003' => "Node value is empty",
+       '-5004' => "Unable to create/parse XML Document",
+       '-6000' => "Unable to open the database",
+       '-6001' => "Unable to read from the database",
+       '-6002' => "Unable to write to the database",
+       '-50000' => "Internal problem - Please contact Sell Online Help Desk"
+      }
+      
+      def requirements
+        [:login]
+      end
+      
+      def find_rates(origin, destination, line_items = [], options = {})
+        rate_request = build_rate_request(origin, destination, line_items, options)
+        commit(rate_request, origin, destination, options)
+      end
+      
+      def maximum_weight
+        Mass.new(30, :kilograms)
+      end
+      
+      def self.default_location
+        {
+          :country => 'CA',
+          :province => 'ON',
+          :city => 'Ottawa',
+          :address1 => '61A York St',
+          :postal_code => 'K1N5T2'
+        }
+      end
+
+      protected
+      
+      def commit(request, origin, destination, options = {})
+        response = parse_rate_response(ssl_post(URL, request), origin, destination, options)
+      end
+      
+      private
+      
+      def build_rate_request(origin, destination, line_items = [], options = {})
+        line_items = [line_items] if !line_items.is_a?(Array)
+        origin = origin.is_a?(Location) ? origin : Location.new(origin)
+        destination = destination.is_a?(Location) ? destination : Location.new(destination)
+
+        xml_request = XmlNode.new('eparcel') do |root_node|
+          root_node << XmlNode.new('language', @options[:french] ? 'fr' : 'en')
+          root_node << XmlNode.new('ratesAndServicesRequest') do |request|
+
+            request << XmlNode.new('merchantCPCID', @options[:login])
+            request << XmlNode.new('fromPostalCode', origin.postal_code)
+            request << XmlNode.new('turnAroundTime', options[:turn_around_time] ? options[:turn_around_time] : DEFAULT_TURN_AROUND_TIME)
+            request << XmlNode.new('itemsPrice', line_items.sum(&:value))
+
+            #line items
+            request << build_line_items(line_items)
+
+            #delivery info
+            #NOTE: These tags MUST be after line items
+            request << XmlNode.new('city', destination.city)
+            request << XmlNode.new('provOrState', destination.province)
+            request << XmlNode.new('country', destination.country)
+            request << XmlNode.new('postalCode', destination.postal_code)
+          end
+        end
+
+        DOCTYPE + xml_request.to_s
+      end
+
+      def parse_rate_response(response, origin, destination, options = {})
+        xml = REXML::Document.new(response)
+        success = response_success?(xml)
+        message = response_message(xml)
+
+        rate_estimates = []
+        boxes = []
+        if success
+          xml.elements.each('eparcel/ratesAndServicesResponse/product') do |product|
+            service_name = (@options[:french] ? @@name_french : @@name) + product.get_text('name').to_s
+            service_code = product.attribute('id').to_s
+            delivery_date = date_for(product.get_text('deliveryDate').to_s)
+
+            rate_estimates << RateEstimate.new(origin, destination, @@name, service_name,
+              :service_code => service_code,
+              :total_price => product.get_text('rate').to_s,
+              :delivery_date => delivery_date,
+              :currency => 'CAD'
+            )
+          end
+
+          boxes = xml.elements.collect('eparcel/ratesAndServicesResponse/packing/box') do |box|
+            b = Box.new
+            b.packedItems = []
+            b.name = box.get_text('name').to_s
+            b.weight = box.get_text('weight').to_s.to_f
+            b.expediter_weight = box.get_text('expediterWeight').to_s.to_f
+            b.length = box.get_text('length').to_s.to_f
+            b.width = box.get_text('width').to_s.to_f
+            b.height = box.get_text('height').to_s.to_f
+            b.packedItems = box.elements.collect('packedItem') do |item|
+              p = PackedItem.new
+              p.quantity = item.get_text('quantity').to_s.to_i
+              p.description = item.get_text('description').to_s
+              p
+            end
+            b
+          end
+
+          postal_outlets = xml.elements.collect('eparcel/ratesAndServicesResponse/nearestPostalOutlet') do |outlet|
+            postal_outlet = PostalOutlet.new
+            postal_outlet.sequence_no    = outlet.get_text('postalOutletSequenceNo').to_s
+            postal_outlet.distance       = outlet.get_text('distance').to_s
+            postal_outlet.name           = outlet.get_text('outletName').to_s
+            postal_outlet.business_name  = outlet.get_text('businessName').to_s
+
+            postal_outlet.postal_address = Location.new({
+              :address1     => outlet.get_text('postalAddress/addressLine').to_s,
+              :postal_code  => outlet.get_text('postalAddress/postal_code').to_s,
+              :city         => outlet.get_text('postalAddress/municipality').to_s,
+              :province     => outlet.get_text('postalAddress/province').to_s,
+              :country      => 'Canada',
+              :phone_number => outlet.get_text('phoneNumber').to_s
+            })
+
+            postal_outlet.business_hours = outlet.elements.collect('businessHours') do |hour|
+              { :day_of_week => hour.get_text('dayOfWeek').to_s, :time => hour.get_text('time').to_s }
+            end
+
+            postal_outlet
+          end
+        end
+
+        CanadaPostRateResponse.new(success, message, Hash.from_xml(response), :rates => rate_estimates, :xml => response, :boxes => boxes, :postal_outlets => postal_outlets)
+      end
+      
+      def date_for(string)
+        return if !string
+        return Time.parse(string)
+      end
+
+      def response_success?(xml)
+        value = xml.get_text('eparcel/ratesAndServicesResponse/statusCode').to_s
+        value == '1' || value == '2'
+      end
+      
+      def response_message(xml)
+        xml.get_text('eparcel/ratesAndServicesResponse/statusMessage').to_s
+      end
+      
+      # <!-- List of items in the shopping    -->
+      # <!-- cart                             -->
+      # <!-- Each item is defined by :        -->
+      # <!--   - quantity    (mandatory)      -->
+      # <!--   - size        (mandatory)      -->
+      # <!--   - weight      (mandatory)      -->
+      # <!--   - description (mandatory)      -->
+      # <!--   - ready to ship (optional)     -->
+      
+      def build_line_items(line_items)
+        xml_line_items = XmlNode.new('lineItems') do |line_items_node|
+          
+          line_items.each do |line_item|
+            
+            line_items_node << XmlNode.new('item') do |item|
+              item << XmlNode.new('quantity', 1)
+              item << XmlNode.new('weight', line_item.kilograms)
+              item << XmlNode.new('length', line_item.cm(:length).to_s)
+              item << XmlNode.new('width', line_item.cm(:width).to_s)
+              item << XmlNode.new('height', line_item.cm(:height).to_s)
+              item << XmlNode.new('description', line_item.options[:description] || ' ')
+              item << XmlNode.new('readyToShip', line_item.options[:ready_to_ship] || nil)
+              
+              # By setting the 'readyToShip' tag to true, Sell Online will not pack this item in the boxes defined in the merchant profile.
+            end
+          end
+        end
+        
+        xml_line_items
+      end
+    end
+  end
+end

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

@@ -175,9 +175,6 @@ module ActiveMerchant
             #                   * Shipment/DocumentsOnly element                      
             
             packages.each do |package|
-              debugger if package.nil?
-              
-              
               imperial = ['US','LR','MM'].include?(origin.country_code(:alpha2))
               
               shipment << XmlNode.new("Package") do |package_node|

data/lib/active_shipping/version.rb

@@ -1,3 +1,3 @@
 module ActiveShipping
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/lib/certs/eParcel.dtd

@@ -0,0 +1,111 @@
+<!-- EVERY REQUEST CONTAIN THE eparcel TAG -->
+<!ELEMENT eparcel (language?,
+					(  ratesAndServicesRequest |
+						ratesAndServicesResponse |
+						error
+					)+)>
+
+<!ELEMENT language (#PCDATA)>
+<!ELEMENT comment (#PCDATA)>
+
+
+<!-- Standard request to ask for rates and services -->
+<!ELEMENT ratesAndServicesRequest (	merchantCPCID,
+												fromPostalCode?,
+												turnAroundTime?,
+												itemsPrice?,
+												lineItems,
+												city?,
+												provOrState,
+												country,
+												postalCode)>
+	<!ELEMENT merchantID (#PCDATA)>
+	<!ELEMENT fromPostalCode (#PCDATA)>
+	<!ELEMENT turnAroundTime (#PCDATA)>
+	<!ELEMENT itemsPrice (#PCDATA)>
+	<!ELEMENT merchantCPCID (#PCDATA)>
+	<!ELEMENT lineItems (item)+>
+		<!ELEMENT item (quantity, weight, length, width, height, description, imageURL?, readyToShip)>
+			<!ELEMENT quantity (#PCDATA)>
+			<!ELEMENT weight (#PCDATA)>
+			<!ELEMENT length (#PCDATA)>
+			<!ELEMENT width (#PCDATA)>
+			<!ELEMENT height (#PCDATA)>
+			<!ELEMENT description (#PCDATA)>
+			<!ELEMENT imageURL (#PCDATA)>
+			<!ELEMENT readyToShip (#PCDATA)>
+	<!ELEMENT city (#PCDATA)>
+	<!ELEMENT provOrState (#PCDATA)>
+	<!ELEMENT country (#PCDATA)>
+	<!ELEMENT postalCode (#PCDATA)>
+
+<!-- Standard response for request for rates and services -->
+<!ELEMENT ratesAndServicesResponse (statusCode, 
+												statusMessage+, 
+												requestID, 
+												handling, 
+												language, 
+												product+,   
+												packing*, 
+												emptySpace*, 
+												shippingOptions, 
+												comment,
+												nearestPostalOutlet*)>
+
+	<!ELEMENT statusCode (#PCDATA)>
+	<!ELEMENT statusMessage (#PCDATA)>
+	<!ELEMENT requestID (#PCDATA)>
+	<!ELEMENT handling (#PCDATA)>
+
+	<!ELEMENT product (name, rate, shippingDate, deliveryDate, deliveryDayOfWeek, nextDayAM?, packingID)>
+		<!ATTLIST product       id    CDATA    		#REQUIRED>
+		<!ATTLIST product       sequence    CDATA    #REQUIRED>
+		<!ELEMENT name (#PCDATA)>
+		<!ELEMENT rate (#PCDATA)>
+		<!ELEMENT shippingDate (#PCDATA)>
+		<!ELEMENT deliveryDate (#PCDATA)>
+		<!ELEMENT deliveryDayOfWeek (#PCDATA)>
+		<!ELEMENT nextDayAM (#PCDATA)>
+		<!ELEMENT packingID (#PCDATA)>
+
+	<!ELEMENT packing (packingID, box+)>
+		<!ELEMENT box (name, weight, expediterWeight, length, width, height, packedItem+)>
+			<!ELEMENT expediterWeight (#PCDATA)>
+			<!ELEMENT packedItem (quantity, description)>
+
+	<!ELEMENT emptySpace (length, width, height, weight)>
+
+	<!ELEMENT shippingOptions (insurance, deliveryConfirmation, signature)>
+		<!ELEMENT insurance (#PCDATA)>
+		<!ELEMENT deliveryConfirmation (#PCDATA)>
+		<!ELEMENT signature (#PCDATA)>
+
+
+	<!-- *********************************************************  -->
+	<!-- * 'nearestPostalOutlet'  is optional and is returned    *  -->
+	<!-- * only if the merchant profile has this option enabled  *  -->
+	<!-- *********************************************************  -->
+	<!ELEMENT nearestPostalOutlet (postalOutletSequenceNo,
+											distance,
+										   outletName, 
+											businessName , 
+											postalAddress, 
+											phoneNumber, 
+											businessHours+)>
+		<!ELEMENT postalOutletSequenceNo		(#PCDATA)>
+		<!ELEMENT distance 			(#PCDATA)>
+		<!ELEMENT outletName 		(#PCDATA)>
+		<!ELEMENT businessName 		(#PCDATA)>
+		<!ELEMENT postalAddress (addressLine+, postalCode , municipality)>
+			<!ELEMENT addressLine 		(#PCDATA)>
+			<!ELEMENT municipality 		(#PCDATA)>
+		<!ELEMENT phoneNumber 		(#PCDATA)>
+		<!ELEMENT businessHours (dayId, dayOfWeek, time)>
+			<!ELEMENT dayId     					(#PCDATA)>
+			<!ELEMENT dayOfWeek 					(#PCDATA)>
+			<!ELEMENT time 						(#PCDATA)>
+
+
+<!-- Standard error format returned -->
+<!ELEMENT error (statusCode,statusMessage*)>
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_shipping
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: false
   segments: 
   - 0
   - 9
-  - 2
-  version: 0.9.2
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - James MacAulay
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 -04:00
+date: 2010-09-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,6 +73,7 @@ files:
 - lib/active_shipping/shipping/base.rb
 - lib/active_shipping/shipping/carrier.rb
 - lib/active_shipping/shipping/carriers/bogus_carrier.rb
+- lib/active_shipping/shipping/carriers/canada_post.rb
 - lib/active_shipping/shipping/carriers/fedex.rb
 - lib/active_shipping/shipping/carriers/kunaki.rb
 - lib/active_shipping/shipping/carriers/shipwire.rb
@@ -89,6 +90,7 @@ files:
 - lib/active_shipping/version.rb
 - lib/active_shipping.rb
 - lib/certs/cacert.pem
+- lib/certs/eParcel.dtd
 - lib/vendor/quantified/init.rb
 - lib/vendor/quantified/lib/quantified/attribute.rb
 - lib/vendor/quantified/lib/quantified/length.rb