shipping-calc 0.1.2 → 0.1.3

data/History.txt

@@ -1,3 +1,16 @@
+=== 0.1.3 / 2008-03-17
+
+* FreightQuote support improved
+
+Now you can query FQ's API with information for:
+
+  * Liftgates
+  * Loading docks
+  * Different types of shipping and receiving locations
+  * Inside deliveries 
+
+* Minor bugfixes
+
 === 0.1.2
 
 * Freight quote now supports FQ's classes. With this the shipment's

data/Manifest.txt

@@ -1,6 +1,7 @@
+README.txt
 History.txt
 Manifest.txt
-README.txt
+README.markdown
 Rakefile
 lib/shipping_calc.rb
 lib/shipping_calc/dhl.rb

data/README.markdown

@@ -0,0 +1,88 @@
+ShippingCalc
+============
+
+* http://github.com/febuiles/shipping_calc/
+* mailto:federico.builes@gmail.com
+
+DESCRIPTION:
+-----------
+
+Shipping Calculator written in Ruby to get quick quotes from the major
+carriers (UPS, DHL, FedEX, FreightQuote).
+
+FEATURES/PROBLEMS:
+-----------------
+- Current version only supports DHL and FreightQuote
+
+SYNOPSIS:
+--------
+You can find an example of each carrier's API under the /examples directory.
+
+A simple DHL example:
+
+	require 'rubygems'
+	require 'shipping_calc'
+
+	include ShippingCalc
+
+	opts = {
+	  :api_user => "your_user", 
+	  :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
+	  :weight => 34, # weight in lbs
+	  :to_zip => 10001,
+	  :to_state => "NY"
+	}
+
+	d = DHL.new
+	a = d.quote(opts)
+	p a
+
+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:
+-----
+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
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/examples/fq_example.rb

@@ -10,6 +10,7 @@ opts = {
   :to_zip => 33166,
   :weight => 5,
   :dimensions => "1x1x1"
+  :to_conditions => "BIZ_WITHOUT"
 }
 
 f = FreightQuote.new

data/lib/shipping_calc.rb

@@ -32,7 +32,7 @@ require 'shipping_calc/freight_quote'
 module ShippingCalc
   class ShippingCalcError < StandardError
   end
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 
   US_STATES = ['AK', 'AL', 'AR', 'AZ', 'CA', 'CO', 'CT', 'DC',
                'DE', 'FL', 'GA', 'HI', 'IA', 'ID', 'IL', 'IN',

data/lib/shipping_calc/freight_quote.rb

@@ -49,28 +49,19 @@ module ShippingCalc
     # :*from_zip*:: Sender's zip code.
     # :*to_zip*:: Recipient's zip code.
     # :*weight*:: Total weight of the order in lbs.
-    # :*dimensions*:: Optional - Length, width and height of the shipment, described as a string: "[Length]x[Width]x[Height]" (e.g. "23x32x15").
-    # :*description*:: Optional - Description of the stuff that's being shipped. Defaults to "NODESC".
-    # :*class*:: Optional - Freight quote class. Defaults to nil.
-    # 
-    # *Note* Both dimensions or class are optional but one of them has to be there. If both parameters are filled then priority will be give to class.
+    # :*dimensions*:: _Optional_ - Length, width and height of the shipment, described as a string: "[Length]x[Width]x[Height]" (e.g. "23x32x15").
+    # :*description*:: _Optional_ - Description of the stuff that's being shipped. Defaults to "NODESC".
+    # :*class*:: _Optional_ - Freightquote's shipping class. Defaults to nil.
+    # :*from_conditions*:: _Optional_ - String that indicates if the sending location is a residence ("RES"), a business with a forklift or dock ("BIZ_WITH") or a business without a forklift or dock ("BIZ_WITHOUT"). Defaults to "RES".
+    # :*to_conditions*:: _Optional_ - String that indicates if the receiving location is a residence ("RES"), a business with a forklift or dock ("BIZ_WITH") or a business without a forklift or dock ("BIZ_WITHOUT"). Defaults to "RES".
+    # :*liftgate*:: _Optional_ - A boolean indicating if a liftgate's required at the receiving location (API page 10). Defaults to false.
+    # :*inside_delivery*:: _Optional_ - A boolean indicating if inside delivery's required at the receiving location (API page 10). Defaults to false.
+    # *Note* Both dimensions or class are optional but one of them has to be there. If both parameters are filled then priority will be given to class.
     def quote(params)
-      required_fields = [:api_email, :api_password, :to_zip, :from_zip,
-                         :weight]
-
-      raise ShippingCalcError.new("Nil parameters for FreightQuote quote.") if params.nil?
-      raise ShippingCalcError.new("Invalid shipment dimensions") unless
-      ((params[:dimensions] =~ /\d+x\d+x\d+/) || (!params[:class].nil?))
-
-      required_fields.each do |f|
-        if params.has_key?(f) && !params[f].nil? # Cover all the mandatory fields
-          next
-        else
-          raise ShippingCalcError.new("Required field \"#{f}\" not found.")
-        end
-      end
-
+      validate params
       params[:description] ||= "NODESC"
+      params[:from_conditions] ||= "RES"
+      params[:to_conditions] ||= "RES"
 
       @xml = xml = Document.new
       xml << XMLDecl.new("1.0' encoding='UTF-8")
@@ -89,19 +80,9 @@ module ShippingCalc
       # We're only getting a quote, let's pretend the shipper's paying.
       root.attributes["BILLTO"] = "SHIPPER" 
 
-      origin = Element.new("ORIGIN")
-      orig_zip = Element.new("ZIPCODE")
-      orig_zip.text = params[:to_zip]
-
-      origin << orig_zip
-      root << origin
-
-      dest = Element.new("DESTINATION")
-      dest_zip = Element.new("ZIPCODE")
-      dest_zip.text = params[:from_zip]
-      
-      dest << dest_zip
-      root << dest
+      root << destination(params[:from_zip], params[:from_conditions],
+                     params[:liftgate], params[:inside_delivery]) 
+      root << origin(params[:from_zip], params[:from_conditions])
 
       root << shipment_item(params[:weight], params[:dimensions],
       params[:description], params[:class])
@@ -131,6 +112,67 @@ module ShippingCalc
       quotes
     end
 
+    # TODO Merge this method with destination's.
+    def origin (zip, conditions)
+      origin = Element.new("ORIGIN")
+      orig_zip = Element.new("ZIPCODE")
+      orig_zip.text = zip
+      origin << orig_zip
+
+      case conditions
+      when "RES"
+        residence = Element.new("RESIDENCE")
+        residence.text = "TRUE"
+        origin << residence
+      when "BIZ_WITH"
+        dock = Element.new("LOADINGDOCK")
+        dock.text = "TRUE"
+        origin << dock
+      when "BIZ_WITHOUT"
+        dock = Element.new("LOADINGDOCK")
+        dock.text = "FALSE"
+        origin << dock
+      end
+
+      origin
+    end
+
+    def destination(zip, conditions, liftgate, inside)
+      dest = Element.new("DESTINATION")
+      dest_zip = Element.new("ZIPCODE")
+      dest_zip.text = zip
+      dest << dest_zip
+
+      case conditions
+      when "RES"
+        residence = Element.new("RESIDENCE")
+        residence.text = "TRUE"
+        dest << residence
+      when "BIZ_WITH"
+        dock = Element.new("LOADINGDOCK")
+        dock.text = "TRUE"
+        dest << dock
+      when "BIZ_WITHOUT"
+        dock = Element.new("LOADINGDOCK")
+        dock.text = "FALSE"
+        dest << dock
+      end
+
+      if !liftgate.nil? && liftgate
+        liftgate = Element.new("LIFTGATEDELIVERY")
+        liftgate.text = "TRUE"
+        dest << liftgate
+      end
+      
+      if !inside.nil? && inside
+        inside = Element.new("INSIDEDELIVERY")
+        inside.text = "TRUE"
+        dest << inside
+      end
+
+      dest
+    end
+
     # Create a shipment item based on the weight, dimension and description.
     def shipment_item(weight_, dim, desc, s_class = nil)
       raise ShippingCalcError.new("Invalid weight") if !(weight_ > 0)
@@ -169,5 +211,42 @@ module ShippingCalc
 
       shipment
     end
+
+    def validate(params)
+      required_fields = [:api_email, :api_password, :to_zip, :from_zip,
+                         :weight]
+
+      raise ShippingCalcError.new("Nil parameters for FreightQuote quote.") if params.nil?
+      raise ShippingCalcError.new("Invalid shipment dimensions") unless
+        ((params[:dimensions] =~ /\d+x\d+x\d+/) || (!params[:class].nil?))
+
+      raise ShippingCalcError.new("Invalid receiving conditions") unless
+        valid_conditions(params[:to_conditions]) 
+      raise ShippingCalcError.new("Invalid shipping conditions") unless
+        valid_conditions(params[:from_conditions]) 
+
+      if !(params[:liftgate].nil?)
+        raise ShippingCalcError.new("Invalid liftgate option, only boolean values.") unless
+          (params[:liftgate].class == TrueClass || params[:liftgate].class == FalseClass)
+      end
+
+      if !(params[:inside_delivery].nil?)
+        raise ShippingCalcError.new("Invalid inside delivery option, only boolean values.") unless
+          (params[:inside_delivery].class == TrueClass || params[:inside_delivery].class == FalseClass)
+      end
+
+      required_fields.each do |f|
+        if params.has_key?(f) && !params[f].nil? # Cover all the mandatory fields
+          next
+        else
+          raise ShippingCalcError.new("Required field \"#{f}\" not found.")
+        end
+      end
+
+    end
+
+    def valid_conditions(cond)
+      cond.nil? || ((cond =~ /^(BIZ_WITH|RES|BIZ_WITHOUT)$/) == 0)
+    end
   end
 end

data/test/freight_quote/freight_quote_test.rb

@@ -14,7 +14,6 @@ class FreightQuoteTest < Test::Unit::TestCase
       :weight => 150,
       :dimensions => "12x23x12"
     }
-
   end
   
   def test_invalid_params
@@ -32,6 +31,54 @@ class FreightQuoteTest < Test::Unit::TestCase
     assert q.size > 0
   end
 
+  def test_quote_with_conditions
+    @opts[:to_conditions]  = "BIZ_WITH"
+    @opts[:from_conditions]  = "BIZ_WITHOUT"
+    f = FreightQuote.new
+    q = f.quote(@opts)
+    assert q.size > 0
+  end
+
+  def test_invalid_conditions
+    @opts[:to_conditions]  = "BIZ_WITH"
+    @opts[:from_conditions]  = "something weird goes here"
+    f = FreightQuote.new
+    assert_raise ShippingCalcError do
+      f.quote(@opts)
+    end
+  end
+
+  def test_with_liftgate_and_inside_delivery
+    @opts[:inside_delivery] = false
+    @opts[:liftgate] = true
+    f = FreightQuote.new
+    q = f.quote(@opts)
+    assert q.size > 0
+  end
+
+  def test_invalid_liftgate
+    @opts[:liftgate] = "something"
+    f = FreightQuote.new
+    assert_raise ShippingCalcError do
+      f.quote(@opts)
+    end
+  end
+
+  def test_invalid_inside_delivery
+    @opts[:inside_delivery] = 3
+    f = FreightQuote.new
+    assert_raise ShippingCalcError do
+      f.quote(@opts)
+    end
+  end
+
+  def test_quote_with_class_and_dimensions
+    @opts[:class] = 92.5
+    f = FreightQuote.new
+    q = f.quote(@opts)
+    assert q.size > 0
+  end
+
   def test_invalid_dimension
     @opts[:dimensions] = "12x3"
     f = FreightQuote.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shipping-calc
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Federico Builes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-16 00:00:00 -05:00
+date: 2008-03-17 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,13 +29,14 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- README.txt
 - History.txt
 - Manifest.txt
-- README.txt
 files: 
+- README.txt
 - History.txt
 - Manifest.txt
-- README.txt
+- README.markdown
 - Rakefile
 - lib/shipping_calc.rb
 - lib/shipping_calc/dhl.rb