shipping-calc 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,6 @@
+=== 0.1.1
+* Usage examples for DHL and FreightQuote in the /examples directory.
+
 === 0.1.0
 * Proper support for FreightQuote quotes.
 FreightQuote uses an API that calculates the cost for a freight shipping

data/Manifest.txt

@@ -8,3 +8,5 @@ lib/shipping_calc/freight_quote.rb
 test/test_helper.rb
 test/dhl/dhl_test.rb
 test/freight_quote/freight_quote_test.rb
+examples/dhl_example.rb
+examples/fq_example.rb

data/README.txt

@@ -14,6 +14,10 @@ carriers (UPS, DHL, FedEX, 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'
 
@@ -36,8 +40,6 @@ carriers (UPS, DHL, FedEX, FreightQuote).
 	a = d.quote(opts)
 	p a
 
-An example of the other carrier's API can be found under the /examples directory.
-
 == 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

data/examples/dhl_example.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'shipping_calc'
+require 'yaml'
+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")
+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"
+  exit
+end
+
+api_user = auth_info["api_user"]
+api_pwd = auth_info["api_password"]
+api_key = auth_info["shipping_key"]
+api_accnt_num = auth_info["account_num"]
+
+opts = { 
+  :api_user => api_user,
+  :api_password => api_pwd,
+  :shipping_key => api_key,
+  :account_num => api_accnt_num,
+  :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
+  :to_zip => 10001,
+  :to_state => "NY" 
+}
+
+d = DHL.new
+q = d.quote(opts)
+puts "Quote: " << q.to_s << "\n"

data/examples/fq_example.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'shipping_calc'
+require 'yaml'
+include ShippingCalc
+
+opts = { 
+  :api_email => "xmltest@FreightQuote.com",
+  :api_password => "XML",
+  :from_zip => 75042,
+  :to_zip => 33166,
+  :weight => 150,
+  :dimensions => "12x23x12"
+}
+
+f = FreightQuote.new
+quotes = f.quote(opts)
+quotes.each do |k,v|
+  p k + " - " + v
+end
+
+

data/lib/shipping_calc.rb

@@ -32,7 +32,7 @@ require 'shipping_calc/freight_quote'
 module ShippingCalc
   class ShippingCalcError < StandardError
   end
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 
   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

@@ -29,11 +29,13 @@ module ShippingCalc
   # This API is based on version 03 of the Freight Quote's (FQ) connection test,
   # release on 2007 (and still used on 2008). When you first create the
   # account you'll receive a test account that works with your username and
-  # password. After having a stable system you should e-mail FQ asking for a
+  # password. 
+  #
+  # After having a stable system you should e-mail FQ asking for a
   # production key to the servers. If you want to test with a generic
-  # username and password you can use: "xmltest@FreightQuote.com" : "XML",
+  # username and password you can the user "xmltest@FreightQuote.com" with password "XML",
   # but this won't give you access to all the debugging info. associated with
-  # your account.
+  # your account (or so they say).
   class FreightQuote
 
     # Obtains some shipping quotes using freight carriers from FQ's site.
@@ -47,10 +49,8 @@ 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").
-    # :*description*:: Optional - Description of the stuff that's being
-    # shipped. Defaults to "NODESC".
+    # :*dimensions*:: 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".
     def quote(params)
       required_fields = [:api_email, :api_password, :to_zip, :from_zip,
                          :weight, :dimensions]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shipping-calc
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Federico Builes
@@ -43,6 +43,8 @@ files:
 - test/test_helper.rb
 - test/dhl/dhl_test.rb
 - test/freight_quote/freight_quote_test.rb
+- examples/dhl_example.rb
+- examples/fq_example.rb
 has_rdoc: true
 homepage: http://github.com/febuiles/shipping_calc/
 post_install_message: