shipping-calc 0.1.1 → 0.1.2

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.1.2
+
+* Freight quote now supports FQ's classes. With this the shipment's
+dimensions are optional
+
 === 0.1.1
 * Usage examples for DHL and FreightQuote in the /examples directory.
 

data/README.txt

@@ -47,7 +47,7 @@ A simple DHL example:
 
 == INSTALL:
 
-* sudo gem install shipping_calc
+* sudo gem install shipping-calc
 
 == TEST
 

data/examples/dhl_example.rb

@@ -26,7 +26,7 @@ opts = {
   :date => Time.now,
   :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
+  :weight => 1, # weight in lbs
   :to_zip => 10001,
   :to_state => "NY" 
 }

data/examples/fq_example.rb

@@ -8,8 +8,8 @@ opts = {
   :api_password => "XML",
   :from_zip => 75042,
   :to_zip => 33166,
-  :weight => 150,
-  :dimensions => "12x23x12"
+  :weight => 5,
+  :dimensions => "1x1x1"
 }
 
 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.1"
+  VERSION = "0.1.2"
 
   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,14 +49,18 @@ module ShippingCalc
     # :*from_zip*:: Sender's zip code.
     # :*to_zip*:: Recipient's zip code.
     # :*weight*:: Total weight of the order in lbs.
-    # :*dimensions*:: Length, width and height of the shipment, described as a string: "[Length]x[Width]x[Height]" (e.g. "23x32x15").
+    # :*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.
     def quote(params)
       required_fields = [:api_email, :api_password, :to_zip, :from_zip,
-                         :weight, :dimensions]
+                         :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+/)
+      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
@@ -99,7 +103,8 @@ module ShippingCalc
       dest << dest_zip
       root << dest
 
-      root << shipment_item(params[:weight], params[:dimensions], params[:description])
+      root << shipment_item(params[:weight], params[:dimensions],
+      params[:description], params[:class])
       @xml << root
     end
 
@@ -127,7 +132,7 @@ module ShippingCalc
     end
 
     # Create a shipment item based on the weight, dimension and description.
-    def shipment_item(weight_, dim, desc)
+    def shipment_item(weight_, dim, desc, s_class = nil)
       raise ShippingCalcError.new("Invalid weight") if !(weight_ > 0)
       shipment = Element.new("SHIPMENT")
       weight = Element.new("WEIGHT")
@@ -138,19 +143,25 @@ module ShippingCalc
       description.text = desc
       shipment << description
 
-      dimensions = Element.new("DIMENSIONS")
-      d = dim.split("x")
-      l = Element.new("LENGTH")
-      w = Element.new("WIDTH")
-      h = Element.new("HEIGHT")
-      l.text = d[0]
-      w.text = d[1]
-      h.text = d[2]
-
-      dimensions << l
-      dimensions << w
-      dimensions << h
-      shipment << dimensions
+      if s_class.nil?
+        dimensions = Element.new("DIMENSIONS")
+        d = dim.split("x")
+        l = Element.new("LENGTH")
+        w = Element.new("WIDTH")
+        h = Element.new("HEIGHT")
+        l.text = d[0]
+        w.text = d[1]
+        h.text = d[2]
+
+        dimensions << l
+        dimensions << w
+        dimensions << h
+        shipment << dimensions
+      else
+        ship_class = Element.new("CLASS")
+        ship_class.text = s_class.to_s
+        shipment << ship_class
+      end
 
       pieces = Element.new("PIECES")
       pieces.text= "1"

data/test/freight_quote/freight_quote_test.rb

@@ -24,6 +24,14 @@ class FreightQuoteTest < Test::Unit::TestCase
     end
   end
 
+  def test_quote_with_class
+    @opts[:class] = 92.5
+    @opts[:dimensions] = nil
+    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.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Federico Builes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-15 00:00:00 -05:00
+date: 2008-03-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency