shipping-calc 0.1.6 → 0.1.7

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.1.7 / 2008-06-24
+
+Improvements for DHL:
+  * Calculations now handle and print descriptive errors when a quote fails.
+  * Fixed a bug with the default ship date not being set
+  * Tests should now un in Mac OS X.
+
 === 0.1.6 / 2008-05-29
 
 * Fixed a bug in FreightQuote where the origin and destination zip code would

data/README.markdown

@@ -7,8 +7,8 @@ ShippingCalc
 DESCRIPTION:
 -----------
 
-Shipping Calculator written in Ruby to get quick quotes from the major
-carriers (UPS, DHL, FedEX, FreightQuote).
+Shipping Calculator written in Ruby to get quick quotes from DHL and Freight Carriers.
+We hope to support FedEx and UPS in a near future.	
 
 FEATURES/PROBLEMS:
 -----------------
@@ -30,22 +30,21 @@ A simple DHL example:
 	  :api_password => "your_pwd",
 	  :shipping_key => "your_key",
 	  :account_num => "your_accnt",
-	  :date => Time.now, # or something...
-	  :service_code => "E", # check the docs to find out what this means
-	  :shipment_code => "P", # check the docs to find out what this means
+	  :date => Time.now, 
+	  :service_code => "E", # check the DHL docs to find out what this means
+	  :shipment_code => "P", # check the DHL docs to find out what this means
 	  :weight => 34, # weight in lbs
 	  :to_zip => 10001,
 	  :to_state => "NY"
 	}
 
 	d = DHL.new
-	a = d.quote(opts)
-	p a
+	q = d.quote(opts)
+	puts q
 
 REQUIREMENTS:
 ---------------
 * You must obtain all the DHL ShipIt data (user, password, key and account) from http://www.dhl-usa.com/TechTools/detail/TTDetail.asp?nav=TechnologyTools/Shipping/OwnSoln
-* REXML
 
 INSTALL:
 -------

data/README.txt

@@ -5,8 +5,8 @@
 
 == DESCRIPTION:
 
-Shipping Calculator written in Ruby to get quick quotes from the major
-carriers (UPS, DHL, FedEX, FreightQuote).
+Shipping Calculator written in Ruby to get quick quotes from DHL and Freight Carriers.
+We hope to support FedEx and UPS in a near future.	
 
 == FEATURES/PROBLEMS:
 
@@ -28,28 +28,27 @@ A simple DHL example:
 	  :api_password => "your_pwd",
 	  :shipping_key => "your_key",
 	  :account_num => "your_accnt",
-	  :date => Time.now, # or something...
-	  :service_code => "E", # check the docs to find out what this means
-	  :shipment_code => "P", # check the docs to find out what this means
+	  :date => Time.now, 
+	  :service_code => "E", # check the DHL docs to find out what this means
+	  :shipment_code => "P", # check the DHL docs to find out what this means
 	  :weight => 34, # weight in lbs
 	  :to_zip => 10001,
 	  :to_state => "NY"
 	}
 
 	d = DHL.new
-	a = d.quote(opts)
-	p a
+	q = d.quote(opts)
+	puts q
 
 == REQUIREMENTS:
 
 * You must obtain all the DHL ShipIt data (user, password, key and account) from http://www.dhl-usa.com/TechTools/detail/TTDetail.asp?nav=TechnologyTools/Shipping/OwnSoln
-* REXML
 
 == INSTALL:
 
 * sudo gem install shipping-calc
 
-== TEST
+== TEST:
 
 To run the DHL tests you'll need to have a .dhl_info.yml file in your home directory with your auth info like this: 
     ~/.dhl_info.yml

data/examples/dhl_example.rb

@@ -1,12 +1,18 @@
 require 'rubygems'
 require 'shipping_calc'
 require 'yaml'
+require 'rbconfig'
 include ShippingCalc
 
 # This example requires you to have a .dhl_info.yml file in your home dir to
 # gather the login data. Check the Test secion in README.txt for more information.
 begin
-  auth_info = YAML.load_file("/home/#{ENV["USER"]}/.dhl_info.yml")
+  os = Config::CONFIG["host_os"]
+  if os =~ /darwin/
+    auth_info = YAML.load_file("/Users/#{ENV["USER"]}/.dhl_info.yml")
+    else      
+    auth_info = YAML.load_file("/home/#{ENV["USER"]}/.dhl_info.yml")
+  end
 rescue Exception
   print "You don't have a .dhl_info.yml file in your home directory. Please
 read the \"Test\" section in README.txt.\n"

data/lib/shipping_calc.rb

@@ -22,23 +22,22 @@
 $:.unshift(File.dirname(__FILE__))
 
 require 'rubygems'
-require 'rexml/document'
-require 'net/http'
-require 'net/https'
-require 'uri'
-
-require 'shipping_calc/dhl'
-require 'shipping_calc/freight_quote'
+require File.dirname(__FILE__) + "/shipping_calc/dhl"
+require File.dirname(__FILE__) + "/shipping_calc/freight_quote"
 module ShippingCalc
-  class ShippingCalcError < StandardError
-  end
-  VERSION = "0.1.6"
 
-  US_STATES = ['AK', 'AL', 'AR', 'AZ', 'CA', 'CO', 'CT', 'DC',
+  VERSION = "0.1.7" 
+
+  US_STATES =  ['AK', 'AL', 'AR', 'AZ', 'CA', 'CO', 'CT', 'DC',
                'DE', 'FL', 'GA', 'HI', 'IA', 'ID', 'IL', 'IN',
                'KS', 'KY', 'LA', 'MA', 'MD', 'ME', 'MI', 'MN',
                'MO', 'MS', 'MT', 'NC', 'ND', 'NE', 'NH', 'NJ',
                'NM', 'NV', 'NY', 'OH', 'OK', 'OR', 'PA', 'RI',
                'SC', 'SD', 'TN', 'TX', 'UT', 'VA', 'VT', 'WA',
-               'WI', 'WV']
+               'WI', 'WV'] 
+
+
+  class ShippingCalcError < StandardError
+  end
+
 end

data/lib/shipping_calc/dhl.rb

@@ -26,13 +26,13 @@ require 'uri'
 include REXML
 
 module ShippingCalc
-
   # Current version on their website is 1.0 and can be found in:
   # https://eCommerce.airborne.com/ApiLandingTest.asp . To get full access to
   # all their stuff you have to make sure they certify your application
   # against their live platform tests. The test bed should be enough to get
   # simple calculations.
   # Currently, only shipments made inside the US are available.
+
   class DHL
 
     # Obtains an estimate quote from the DHL site. 
@@ -53,6 +53,7 @@ module ShippingCalc
     def quote(params)
       @xml = xml = Document.new
       xml << XMLDecl.new("1.0' encoding='UTF-8")
+      raise ShippingCalcError.new("Invalid parameters") if params.nil?
       raise ShippingCalcError.new("Missing shipping parameters") unless params.keys.length == 10
       auth(params[:api_user], params[:api_password])
       rate_estimate(params)
@@ -60,25 +61,32 @@ module ShippingCalc
     end
 
     private 
-    # DHL gets the quotes in 2 steps, the first one is authentication. This
+
+    # DHL gets the quote in 2 steps, the first one is authentication. This
     # generates the XML for that.
     def auth(api_user, api_password)
-      ecomm = Element.new "eCommerce"
-      ecomm.attributes["action"] = "Request"
-      ecomm.attributes["version"] = "1.1"
+      # <eCommerce action="Request" version="1.1">
+      #   <Requestor>
+      #     <ID>username</ID>
+      #     <Password>password</Password>
+      #   </Requestor>
+      # </eCommerce>
+      ecommerce = Element.new "eCommerce"
+      ecommerce.attributes["action"] = "Request"
+      ecommerce.attributes["version"] = "1.1"
 
       user = Element.new "Requestor"
-      u_id = Element.new "ID"
-      u_id.text = api_user 
+      user_id = Element.new "ID"
+      user_id.text = api_user 
 
-      u_pwd = Element.new "Password"
-      u_pwd.text = api_password 
+      user_pwd = Element.new "Password"
+      user_pwd.text = api_password 
 
-      user << u_id
-      user << u_pwd
+      user << user_id
+      user << user_pwd
 
-      ecomm << user
-      @xml << ecomm
+      ecommerce << user
+      @xml << ecommerce
     end
 
     # After having the auth message ready, we create the RateEstimate request.
@@ -96,14 +104,20 @@ module ShippingCalc
     #     to_country: Recipient's country. Not used, currently DHL only supports US.
     #     to_state: Recipient's state.
     def rate_estimate(params)
+
+      # <Shipment action="RateEstimate" version="1.0">
       shipment = Element.new "Shipment"
       shipment.attributes["action"] = "RateEstimate"
       shipment.attributes["version"] = "1.0"
 
+      # <ShippingCredentials>
+      #   <ShippingKey>key</ShippingKey> 
+      #   <AccountNbr>number</AccountNbr>
+      # </ShippingCredentials>
       credentials = Element.new "ShippingCredentials"
+
       key = Element.new "ShippingKey"
       key.text = params[:shipping_key] 
-
       account = Element.new "AccountNbr"
       account.text = params[:account_num] 
 
@@ -111,50 +125,84 @@ module ShippingCalc
       credentials << account
       shipment << credentials
 
-      detail = Element.new "ShipmentDetail"
-      date = Element.new "ShipDate"   
-
-      date.text = date(params[:date])
-      detail << date
+      # <ShipmentDetail>
+      #   <ShiptDate>date</ShipDate>
+      shipment_detail = Element.new "ShipmentDetail"
+      ship_date = Element.new "ShipDate"   
+      ship_date.text = date(params[:date])
+      shipment_detail << ship_date
 
       # TODO: Implement SAT and 1030 services
-      service = Element.new "Service"
-      s_code = Element.new "Code"
-      s_code.text = service_code(params[:service_code])
-      detail << service << s_code
-
-      type = Element.new "ShipmentType"
-      t_code = Element.new "Code"
-      t_code.text = shipment_code(params[:shipment_code])
-      detail << type << t_code
 
+      #   <Service>
+      #     <Code>code</Code>
+      #   </Service>
+      service = Element.new "Service"
+      service_code = Element.new "Code"
+      service_code.text = service_code(params[:service_code])
+      service << service_code
+
+      shipment_detail << service
+
+      #   <ShipmentType>
+      #     <Code>code</Code>
+      #   </ShipmentType>
+      shipment_type = Element.new "ShipmentType"
+      shipment_type_code = Element.new "Code"
+      shipment_type_code.text = shipment_code(params[:shipment_code])
+      shipment_type << shipment_type_code
+      shipment_detail << shipment_type
+
+      #   <Weight>weight</Weight>
       weight = Element.new "Weight"
       weight.text = weight(params[:weight], params[:shipment_code])
-      shipment << detail << weight
 
+      # </ShipmentDetail>      
+      shipment_detail << weight
+
+      shipment << shipment_detail
+
+      # <Billing>
+      #   <Party>
+      #     <Code>S</Code>
+      #   </Party>
+      # </Billing>
       billing = Element.new "Billing"
-      b_party = Element.new "Party"
-      p_code = Element.new "Code"
+      billing_party = Element.new "Party"
+      billing_party_code = Element.new "Code"
+
       # Since we're just doing some quick calulations we don't want to be
       # worrying about who's gonna send the package. Just make the calulations 
       # assuming the sender pays for the shipping.
-      p_code.text = "S"
-      shipment << billing << b_party << p_code
+      billing_party_code.text = "S"
+
+      billing << billing_party << billing_party_code
 
+      shipment << billing
+
+      # <Receiver>
+      #   <Address>
+      #     <State>state</State>
+      #     <Country>country</Country>
+      #     <PostalCode>code</PostalCode>
+      #   </Address>
+      # </Receiver>
       receiver = Element.new "Receiver"
-      r_addr = Element.new "Address"
-      r_state = Element.new "State"
-      r_country = Element.new "Country"
-      r_zipcode = Element.new "PostalCode"
+      receiver_addr = Element.new "Address"
+      receiver_state = Element.new "State"
+      receiver_country = Element.new "Country"
+      receiver_zipcode = Element.new "PostalCode"
+
+      receiver_state.text = state(params[:to_state])
+      receiver_country.text = "US"
+      receiver_zipcode.text = zip_code(params[:to_zip])
 
-      r_state.text = state(params[:to_state])
-      r_country.text = "US"
-      r_zipcode.text = zip_code(params[:to_zip])
+      receiver_addr << receiver_state
+      receiver_addr << receiver_country
+      receiver_addr << receiver_zipcode
+      receiver << receiver_addr
 
-      r_addr << r_state
-      r_addr << r_country
-      r_addr << r_zipcode
-      shipment << receiver << r_addr
+      shipment << receiver
 
       root = @xml.elements["eCommerce"]
       root.add shipment
@@ -174,12 +222,10 @@ module ShippingCalc
     # Parses the server's response. Currently, it only returns the estimate
     # value of the shipping.
     def parse_response(resp)
-      p resp
       doc = Document.new(resp)
-      if resp =~ /Fault/
-        raise ShippingCalcError.new("DHL's system is currently offline.")
-        return
-      end
+
+      find_error_and_raise(doc) if errors_exist?(doc)
+
       result =  doc.elements["//Shipment/Result/Desc"].text 
       
       if result == "Shipment estimate successful."
@@ -189,8 +235,45 @@ module ShippingCalc
       end
     end
 
+    def errors_exist?(response)
+      not response.elements["//Faults"].nil?
+    end
+
+    def find_error_and_raise(response)
+    error_code = response.elements["//Code"]
+
+        # Special Services and Additional Protection are not supported        
+      case error_code.text.to_i
+          when 1000..1009 then msg = "Shipment Headers"
+          when 4000..4004 then msg = "ShippingKey"
+          when 4007       then msg = "Account Number"
+          when 4195..4198 then msg = "Account Number"
+          when 4100..4106 then msg = "Shipment Date"
+          when 4108..4117 then msg = "Service Type (Code)"
+          when 4118..4122 then msg = "Shipment Type Code"
+          when 4123..4124 then msg = "Weight"
+          when 4128..4131 then msg = "Dimensions"
+          when 4116       then msg = "Billing Party (Code)"
+          when 4147       then msg = "Billing Party (Code)"
+          when 4149..4152 then msg = "Billing Account Number"
+          when 4164..4166 then msg = "Receiver City"
+          when 4167       then msg = "Receiver State"
+          when 4164..4166 then msg = "Receiver City"
+          when 4169       then msg = "Receiver Country"
+          when 4170..4176 then msg = "Receiver Postal Code"
+          else                 msg = "API Request"
+      end
+
+      raise ShippingCalcError.new("DHL Error #{error_code.text}: Invalid #{msg}")
+    end
+
     def date(date)
-      if date.strftime("%A") == "Sunday"
+      date ||= Time.now
+      if date.kind_of?(String) && date =~ /\d{4}-\d{2}-\d{2}/ # Suppose it's valid
+        return date
+      end
+
+      if date.strftime("%A") == "Sunday"    
         (date + 86400).strftime("%Y-%m-%d") # DHL doesn't ship on Sundays, add 1 day.
       else
         date.strftime("%Y-%m-%d")

data/test/dhl/dhl_test.rb

@@ -1,5 +1,8 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require File.dirname(__FILE__) + "/../../lib/shipping_calc"
+
+require 'test/unit'
 require 'yaml'
+require 'rbconfig'
 
 include ShippingCalc
 
@@ -29,39 +32,59 @@ class DHLTest < Test::Unit::TestCase
   end
 
   def test_quote
-    assert_in_delta "172.5", @d.quote(@opts), 10
+    assert_in_delta "172.5", @d.quote(@opts), 45
+  end
+
+  def test_errors
+    @opts[:account_num] = "0123456789"
+    assert_raises ShippingCalc::ShippingCalcError do
+      @d.quote(@opts)
+    end
   end
 
   def test_params_empty
-    assert_raise NoMethodError do 
+    assert_raises ShippingCalc::ShippingCalcError do 
       @d.quote(nil)
     end
   end
 
+  def test_empty_date
+    @opts[:date] = nil
+    assert_nothing_raised do
+      quote = @d.quote(@opts)
+    end
+  end
+
   def test_not_enough_params
     @opts.delete(:weight)
-    assert_raise ShippingCalcError do 
+    assert_raises ShippingCalc::ShippingCalcError do 
       @d.quote(@opts)
     end
   end
 
   def test_invalid_weight
     @opts[:weight] = -1
-    assert_raise ShippingCalcError do 
+    assert_raises ShippingCalc::ShippingCalcError do 
       @d.quote(@opts)
     end
   end
 
   def test_invalid_zip_code
     @opts[:to_zip] = "10002"
-    assert_raise ShippingCalcError do
+    assert_raises ShippingCalc::ShippingCalcError do
       @d.quote(@opts)
     end
   end
 
   # Auth info is private, gotta load it this way.
   def auth_info_from_file
-    info = YAML.load_file("/home/#{ENV["USER"]}/.dhl_info.yml")
+    os = Config::CONFIG["host_os"]
+    if os =~ /darwin/
+      info = YAML.load_file("/Users/#{ENV["USER"]}/.dhl_info.yml")
+    else      
+      info = YAML.load_file("/home/#{ENV["USER"]}/.dhl_info.yml")
+    end
+    info
   end
 
 end

data/test/freight_quote/freight_quote_test.rb

@@ -1,4 +1,6 @@
-require File.dirname(__FILE__) + '/../test_helper'
+require File.dirname(__FILE__) + "/../../lib/shipping_calc"
+
+require 'test/unit'
 require 'yaml'
 
 include ShippingCalc
@@ -6,7 +8,6 @@ include ShippingCalc
 class FreightQuoteTest < Test::Unit::TestCase
 
   def setup
-
     @opts = { 
       :api_email => "xmltest@FreightQuote.com",
       :api_password => "XML",

data/test/test_helper.rb

@@ -1,5 +1,5 @@
-require 'test/unit'
-require 'shipping_calc'
+require File.dirname(__FILE__) + "/freight_quote/freight_quote_test"
+require File.dirname(__FILE__) + "/dhl/dhl_test"
+
+
 
-require 'dhl/dhl_test'
-require 'freight_quote/freight_quote_test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shipping-calc
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Federico Builes
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-29 00:00:00 -05:00
+date: 2008-06-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -21,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.3
     version: 
-description: Shipping Calculator written in Ruby to get quick quotes from the major carriers (UPS, DHL, FedEX, FreightQuote).
+description: Shipping Calculator written in Ruby to get quick quotes from DHL and Freight Carriers. We hope to support FedEx and UPS in a near future.
 email: 
 - federico.builes@gmail.com
 executables: []
@@ -69,9 +70,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: shipping-calc
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Shipping Calculator written in Ruby to get quick quotes from the major carriers (UPS, DHL, FedEX, FreightQuote).
+summary: Shipping Calculator written in Ruby to get quick quotes from DHL and Freight Carriers
 test_files: 
 - test/test_helper.rb