shipping-calc 0.0.1 → 0.0.2

data/Manifest.txt

@@ -3,5 +3,4 @@ Manifest.txt
 README.txt
 Rakefile
 lib/shipping_calc.rb
-lib/shipping_calc/base.rb
 lib/shipping_calc/dhl.rb

data/README.txt

@@ -1,6 +1,7 @@
 = ShippingCalc
 
 * http://github.com/febuiles/shipping_calc/
+* mailto:federico.builes@gmail.com
 
 == DESCRIPTION:
 
@@ -12,6 +13,9 @@ Shipping Calculator written in Ruby to get quick quotes from the major carriers
 
 == SYNOPSIS:
 
+	require 'rubygems'
+	require 'shipping_calc'
+
 	include ShippingCalc
 
 	opts = {
@@ -40,6 +44,19 @@ Shipping Calculator written in Ruby to get quick quotes from the major carriers
 
 * sudo gem install shipping_calc
 
+== 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
+
+    api_user: your_user
+    api_password: your_password
+    shipping_key: your_key
+    account_num: your_accnt_num
+
+This is necessary only for the tests and it'll be ignored for the actual
+usage of the the library. 
+
 == LICENSE:
 
 Copyright (c) 2008 Federico Builes

data/lib/shipping_calc.rb

@@ -6,15 +6,19 @@ require 'net/http'
 require 'net/https'
 require 'uri'
 
-require 'shipping_calc/base'
 require 'shipping_calc/dhl'
 
 module ShippingCalc
   class ShippingCalcError < StandardError
   end
+  VERSION = "0.0.2"
 
-  VERSION = "0.0.1"
-  
+  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']
 end
-  
 

data/lib/shipping_calc/dhl.rb

@@ -12,8 +12,7 @@ module ShippingCalc
   # 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 < Base
-
+  class DHL
 
     # Obtains an estimate quote from the DHL site. 
     # <tt>params</tt> is a hash with all the settings for the shipment. They are:
@@ -33,7 +32,7 @@ module ShippingCalc
     def quote(params)
       @xml = xml = Document.new
       xml << XMLDecl.new("1.0' encoding='UTF-8")
-
+      raise ShippingCalcError.new("Missing shipping parameters") unless params.keys.length == 10
       auth(params[:api_user], params[:api_password])
       rate_estimate(params)
       request
@@ -64,8 +63,7 @@ module ShippingCalc
     # After having the auth message ready, we create the RateEstimate request.
     #     shipping_key: API shipping key, provided by DHL.
     #     account_num: Account number, provided by DHL.
-    #     date: Date for the shipping in format YYYY-MM-DD (defaults to
-    #     Time.now).
+    #     date: Date for the shipping. Must be a Ruby "Time" object.
     #     service_code: Service code defined in Rate Estimate Specification
     #     (E, N, S, G). 1030 and SAT are not supported yet. Defaults to G
     #     (ground service).
@@ -110,7 +108,7 @@ module ShippingCalc
       detail << type << t_code
 
       weight = Element.new "Weight"
-      weight.text = weight(params[:weight])
+      weight.text = weight(params[:weight], params[:shipment_code])
       shipment << detail << weight
 
       billing = Element.new "Billing"
@@ -161,12 +159,16 @@ module ShippingCalc
       if result == "Shipment estimate successful."
         doc.elements["//Shipment/EstimateDetail/RateEstimate/TotalChargeEstimate"].text.to_f
       else
-        raise ShippingCalcError.new("Error calculating shipping costs: + #{result}")
+        raise ShippingCalcError.new(doc.to_s)
       end
     end
 
     def date(date)
-      date =~ /\d{4}-\d{2}-\d{2}/ ? date : Time.now.strftime("%Y-%m-%d")
+      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")
+      end
     end
 
     def shipment_code(code)
@@ -177,8 +179,12 @@ module ShippingCalc
       ["E", "N", "S", "G"].include?(code) ? code : "G"
     end
 
-    def weight(w)
-      (w > 0 && w <= 150) ? w.to_s : (raise ShippingCalcError.new("Invalid weight - Must be between 1 and 150 lbs."))
+    def weight(w, type)
+      if type == "L"
+        "0"
+      else
+        (w > 0 && w <= 150) ? w.to_s : (raise ShippingCalcError.new("Invalid weight - Must be between 1 and 150 lbs."))
+      end
     end
 
     def state(s)
@@ -186,10 +192,13 @@ module ShippingCalc
     end
 
     def valid_state?(s)
-      US_STATES.include?(s)
+      ShippingCalc::US_STATES.include?(s)
     end
 
     def zip_code(code)
+      if code.class != Fixnum
+        raise ShippingCalcError.new("Zip Code must be a number. Perhaps you are using a string?")
+      end
       code.to_s =~ /\d{5}/ ? code.to_s : (raise ShippingCalcError.new("Invalid zip code for recipient"))
     end
 

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'test/unit'
+require 'shipping_calc'
+
+require 'dhl/dhl_test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shipping-calc
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Federico Builes
@@ -38,7 +38,6 @@ files:
 - README.txt
 - Rakefile
 - lib/shipping_calc.rb
-- lib/shipping_calc/base.rb
 - lib/shipping_calc/dhl.rb
 has_rdoc: true
 homepage: http://github.com/febuiles/shipping_calc/
@@ -67,5 +66,5 @@ rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
 summary: Shipping Calculator written in Ruby to get quick quotes from the major carriers (UPS, DHL, FedEX).
-test_files: []
-
+test_files: 
+- test/test_helper.rb

data/lib/shipping_calc/base.rb

@@ -1,13 +0,0 @@
-module ShippingCalc
-
-  class Base
-    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']
-  end
-  
-end