shipping-calc 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.0.1 / 2008-03-09
+
+* Initial buggy release
+
+  * Don't try this at home!
+

data/Manifest.txt

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

data/README.txt

@@ -0,0 +1,64 @@
+= ShippingCalc
+
+* http://github.com/febuiles/shipping_calc/
+
+== DESCRIPTION:
+
+Shipping Calculator written in Ruby to get quick quotes from the major carriers (UPS, DHL, FedEX).
+
+== FEATURES/PROBLEMS:
+
+- Current version only supports DHL.
+
+== SYNOPSIS:
+
+	include ShippingCalc
+
+	opts = {
+	  :api_user => "your_user", 
+	  :api_password => "your_pwd",
+	  :shipping_key => "your_key",
+	  :account_num => "your_accnt",
+	  :date => "2008-03-10",
+	  :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
+
+== 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/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'hoe'
+require './lib/shipping_calc.rb'
+
+Hoe.new('shipping-calc', ShippingCalc::VERSION) do |p|
+  p.rubyforge_name = "shipping-calc"
+  p.developer('Federico Builes', 'federico.builes@gmail.com')
+  p.remote_rdoc_dir = ""  # publishes to root
+end
+

data/lib/shipping_calc.rb

@@ -0,0 +1,20 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'rexml/document'
+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.1"
+  
+end
+  
+

data/lib/shipping_calc/base.rb

@@ -0,0 +1,13 @@
+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

data/lib/shipping_calc/dhl.rb

@@ -0,0 +1,197 @@
+require 'rexml/document'
+require 'net/http'
+require 'net/https'
+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 < Base
+
+
+    # Obtains an estimate quote from the DHL site. 
+    # <tt>params</tt> is a hash with all the settings for the shipment. They are:
+    #
+    # :*api_user*:: API access username, provided by DHL.
+    # :*api_password*:: API access password, provided by DHL.
+    # :*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).
+    # :*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).
+    # :*shipment_code*:: ShipmentType code defined in the Rate Estimate Specification. "P" for Package or "L" for Letter. Defaults to "P".
+    # :*weight*:: Order's weight. If the shipment code is a "L" (letter) then the weight will be 0.
+    # :*to_zip*:: Recipient's zip code.
+    # :*to_country*:: Recipient's country. Not used, currently DHL only supports US.
+    # :*to_state*:: Recipient's state.
+
+    def quote(params)
+      @xml = xml = Document.new
+      xml << XMLDecl.new("1.0' encoding='UTF-8")
+
+      auth(params[:api_user], params[:api_password])
+      rate_estimate(params)
+      request
+    end
+
+    private 
+    # DHL gets the quotes 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"
+
+      user = Element.new "Requestor"
+      u_id = Element.new "ID"
+      u_id.text = api_user 
+
+      u_pwd = Element.new "Password"
+      u_pwd.text = api_password 
+
+      user << u_id
+      user << u_pwd
+
+      ecomm << user
+      @xml << ecomm
+    end
+
+    # 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).
+    #     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).
+    #     shipment_code: ShipmentType code defined in the Rate Estimate
+    #     Specification. "P" for Package or "L" for Letter. Defaults to "P".
+    #     weight: Order's weight. If the shipment code is a "L" (letter) then
+    #     the weight will be 0.
+    #     to_zip: Recipient's zip code.
+    #     to_country: Recipient's country. Not used, currently DHL only supports US.
+    #     to_state: Recipient's state.
+    def rate_estimate(params)
+      shipment = Element.new "Shipment"
+      shipment.attributes["action"] = "RateEstimate"
+      shipment.attributes["version"] = "1.0"
+
+      credentials = Element.new "ShippingCredentials"
+      key = Element.new "ShippingKey"
+      key.text = params[:shipping_key] 
+
+      account = Element.new "AccountNbr"
+      account.text = params[:account_num] 
+
+      credentials << key
+      credentials << account
+      shipment << credentials
+
+      detail = Element.new "ShipmentDetail"
+      date = Element.new "ShipDate"   
+
+      date.text = date(params[:date])
+      detail << 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
+
+      weight = Element.new "Weight"
+      weight.text = weight(params[:weight])
+      shipment << detail << weight
+
+      billing = Element.new "Billing"
+      b_party = Element.new "Party"
+      p_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
+
+      receiver = Element.new "Receiver"
+      r_addr = Element.new "Address"
+      r_state = Element.new "State"
+      r_country = Element.new "Country"
+      r_zipcode = Element.new "PostalCode"
+
+      r_state.text = state(params[:to_state])
+      r_country.text = "US"
+      r_zipcode.text = zip_code(params[:to_zip])
+
+      r_addr << r_state
+      r_addr << r_country
+      r_addr << r_zipcode
+      shipment << receiver << r_addr
+
+      root = @xml.elements["eCommerce"]
+      root.add shipment
+    end
+
+    # Sends the request to the web server and returns the response.
+    def request
+      server = Net::HTTP.new("eCommerce.airborne.com", 443)
+      path = path = "/ApiLandingTest.asp"
+      data = @xml.to_s
+      headers = { "Content-Type" => "text/xml"}
+      server.use_ssl = true
+      resp = server.post(path, data, headers)
+      price = parse_response(resp.body)
+    end
+
+    # Parses the server's response. Currently, it only returns the estimate
+    # value of the shipping.
+    def parse_response(resp)
+      doc = Document.new(resp)
+      result =  doc.elements["//Shipment/Result/Desc"].text 
+      
+      if result == "Shipment estimate successful."
+        doc.elements["//Shipment/EstimateDetail/RateEstimate/TotalChargeEstimate"].text.to_f
+      else
+        raise ShippingCalcError.new("Error calculating shipping costs: + #{result}")
+      end
+    end
+
+    def date(date)
+      date =~ /\d{4}-\d{2}-\d{2}/ ? date : Time.now.strftime("%Y-%m-%d")
+    end
+
+    def shipment_code(code)
+      ["P", "L"].include?(code) ? code : "P"
+    end
+
+    def service_code(code)
+      ["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."))
+    end
+
+    def state(s)
+      valid_state?(s) ? s : (raise ShippingCalcError.new("Invalid state for recipient"))
+    end
+
+    def valid_state?(s)
+      US_STATES.include?(s)
+    end
+
+    def zip_code(code)
+      code.to_s =~ /\d{5}/ ? code.to_s : (raise ShippingCalcError.new("Invalid zip code for recipient"))
+    end
+
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: shipping-calc
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Federico Builes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: Shipping Calculator written in Ruby to get quick quotes from the major carriers (UPS, DHL, FedEX).
+email: 
+- federico.builes@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- 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/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: shipping-calc
+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: []
+