shipping 1.2.1 → 1.3.0

data/Rakefile

@@ -4,8 +4,14 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
+require File.dirname(__FILE__) + '/lib/shipping'
 
-PKG_VERSION = "1.2.1"
+PKG_VERSION = Shipping::VERSION
+PKG_NAME = "shipping"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+RUBY_FORGE_PROJECT = "shipping"
+RUBY_FORGE_USER = ENV['RUBY_FORGE_USER'] || "cardmagic"
+RELEASE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 
 PKG_FILES = FileList[
     "lib/**/*", "bin/*", "test/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
@@ -90,7 +96,156 @@ end
 
 desc "Publish new documentation"
 task :publish do
-   `ssh rufy update-shipping-doc`
-   `scp pkg/shipping-1.0.0.* rufy:www/shipping.rufy.com/docs/`
     Rake::RubyForgePublisher.new('shipping', 'cardmagic').upload
+    `ssh rufy update-shipping-doc`
+end
+
+desc "Publish the release files to RubyForge."
+task :upload => [:package] do
+    files = ["gem", "tgz", "zip"].map { |ext| "pkg/#{PKG_FILE_NAME}.#{ext}" }
+
+    if RUBY_FORGE_PROJECT then
+        require 'net/http'
+        require 'open-uri'
+
+        project_uri = "http://rubyforge.org/projects/#{RUBY_FORGE_PROJECT}/"
+        project_data = open(project_uri) { |data| data.read }
+        group_id = project_data[/[?&]group_id=(\d+)/, 1]
+        raise "Couldn't get group id" unless group_id
+
+        # This echos password to shell which is a bit sucky
+        if ENV["RUBY_FORGE_PASSWORD"]
+            password = ENV["RUBY_FORGE_PASSWORD"]
+        else
+            password = Proc.new do
+              sync = STDOUT.sync
+              begin
+                echo false
+                STDOUT.sync = true
+                print "#{RUBY_FORGE_USER}@rubyforge.org's password: "
+                STDIN.gets.chomp
+              ensure
+                echo true
+                STDOUT.sync = sync
+                puts
+              end
+            end.call
+        end
+
+        login_response = Net::HTTP.start("rubyforge.org", 80) do |http|
+            data = [
+                "login=1",
+                "form_loginname=#{RUBY_FORGE_USER}",
+                "form_pw=#{password}"
+            ].join("&")
+            http.post("/account/login.php", data)
+        end
+
+        cookie = login_response["set-cookie"]
+        raise "Login failed" unless cookie
+        headers = { "Cookie" => cookie }
+
+        release_uri = "http://rubyforge.org/frs/admin/?group_id=#{group_id}"
+        release_data = open(release_uri, headers) { |data| data.read }
+        package_id = release_data[/[?&]package_id=(\d+)/, 1]
+        raise "Couldn't get package id" unless package_id
+
+        first_file = true
+        release_id = ""
+
+        files.each do |filename|
+            basename  = File.basename(filename)
+            file_ext  = File.extname(filename)
+            file_data = File.open(filename, "rb") { |file| file.read }
+
+            puts "Releasing #{basename}..."
+
+            release_response = Net::HTTP.start("rubyforge.org", 80) do |http|
+                release_date = Time.now.strftime("%Y-%m-%d %H:%M")
+                type_map = {
+                    ".zip"    => "3000",
+                    ".tgz"    => "3110",
+                    ".gz"     => "3110",
+                    ".gem"    => "1400"
+                }; type_map.default = "9999"
+                type = type_map[file_ext]
+                boundary = "rubyqMY6QN9bp6e4kS21H4y0zxcvoor"
+
+                query_hash = if first_file then
+                  {
+                    "group_id" => group_id,
+                    "package_id" => package_id,
+                    "release_name" => RELEASE_NAME,
+                    "release_date" => release_date,
+                    "type_id" => type,
+                    "processor_id" => "8000", # Any
+                    "release_notes" => "",
+                    "release_changes" => "",
+                    "preformatted" => "1",
+                    "submit" => "1"
+                  }
+                else
+                  {
+                    "group_id" => group_id,
+                    "release_id" => release_id,
+                    "package_id" => package_id,
+                    "step2" => "1",
+                    "type_id" => type,
+                    "processor_id" => "8000", # Any
+                    "submit" => "Add This File"
+                  }
+                end
+
+                query = "?" + query_hash.map do |(name, value)|
+                    [name, URI.encode(value)].join("=")
+                end.join("&")
+
+                data = [
+                    "--" + boundary,
+                    "Content-Disposition: form-data; name=\"userfile\"; filename=\"#{basename}\"",
+                    "Content-Type: application/octet-stream",
+                    "Content-Transfer-Encoding: binary",
+                    "", file_data, ""
+                    ].join("\x0D\x0A")
+
+                release_headers = headers.merge(
+                    "Content-Type" => "multipart/form-data; boundary=#{boundary}"
+                )
+
+                target = first_file ? "/frs/admin/qrs.php" : "/frs/admin/editrelease.php"
+                http.post(target + query, data, release_headers)
+            end
+
+            if first_file then
+                release_id = release_response.body[/release_id=(\d+)/, 1]
+                raise("Couldn't get release id") unless release_id
+            end
+
+            first_file = false
+        end
+    end
+end
+
+begin
+  if !defined?(USE_TERMIOS) || USE_TERMIOS
+    require 'termios'
+  else
+    raise LoadError
+  end
+
+  # Enable or disable stdin echoing to the terminal.
+  def echo(enable)
+    term = Termios::getattr(STDIN)
+
+    if enable
+      term.c_lflag |= (Termios::ECHO | Termios::ICANON)
+    else
+      term.c_lflag &= ~Termios::ECHO
+    end
+
+    Termios::setattr(STDIN, Termios::TCSANOW, term)
+  end
+rescue LoadError
+  def echo(enable)
+  end
 end

data/lib/shipping.rb

@@ -24,6 +24,8 @@
 # Copyright:: Copyright (c) 2005 Lucas Carlson
 # License::   LGPL
 
+$:.unshift(File.dirname(__FILE__))
+
 begin
    require 'rubygems'
 rescue LoadError
@@ -35,6 +37,7 @@ require 'yaml'
 require 'rexml/document'
 require 'net/http'
 require 'net/https'
+require 'base64'
 
 require 'extensions'
 require 'shipping/base'

data/lib/shipping/base.rb

@@ -3,6 +3,8 @@
 # License::   LGPL
 
 module Shipping
+   VERSION = "1.3.0"
+   
    class ShippingError < StandardError; end
 
    class Base
@@ -11,13 +13,13 @@ module Shipping
       attr_writer :ups_account, :ups_user, :ups_password
       attr_writer :fedex_account, :fedex_meter, :fedex_url
 
-      attr_accessor :name, :phone, :email, :address, :address2, :city, :state, :zip, :country
+      attr_accessor :name, :phone, :company, :email, :address, :address2, :city, :state, :zip, :country
       attr_accessor :sender_name, :sender_phone, :sender_email, :sender_address, :sender_city, :sender_state, :sender_zip, :sender_country
 
       attr_accessor :weight, :weight_units, :insured_value, :declared_value, :transaction_type, :description
       attr_accessor :package_total, :packaging_type, :service_type
       
-		attr_accessor :ship_date, :dropoff_type, :pay_type, :currency_code
+      attr_accessor :ship_date, :dropoff_type, :pay_type, :currency_code, :image_type, :label_type
 
       def initialize(options = {})
          prefs = File.expand_path(options[:prefs] || "~/.shipping.yml")

data/lib/shipping/fedex.rb

@@ -6,22 +6,24 @@
 # See http://www.fedex.com/us/solutions/wis/pdf/xml_transguide.pdf?link=4 for the full XML-based API
 
 module Shipping
-   class FedEx < Base
-      # Gets the total price of the shipping
-      def price
-         get_price
-         return REXML::XPath.first(@response, "//FDXRateReply/EstimatedCharges/DiscountedCharges/NetCharge").text.to_f
-      rescue
-        raise ShippingError, get_error
-      end
-      
-      # Gets the base price of the shipping (with discounts taken into consideration)
-      def base_price
-         get_price
-         return REXML::XPath.first(@response, "//FDXRateReply/EstimatedCharges/DiscountedCharges/BaseCharge").text.to_f
-      rescue
-         raise ShippingError, get_error
-      end
+ class FedEx < Base
+   # Gets the list price the regular consumer would have to pay.  Discount price is what the 
+   # person with this particular account number will pay
+   def price
+     get_price
+     return REXML::XPath.first(@response, "//FDXRateReply/EstimatedCharges/ListCharges/NetCharge").text.to_f
+    rescue
+      raise ShippingError, get_error
+    end
+    
+    # Gets the discount price of the shipping (with discounts taken into consideration).
+    # "base price" doesn't include surcharges like fuel cost, so I don't think it is the correct price to get
+    def discount_price
+      get_price
+      return REXML::XPath.first(@response, "//FDXRateReply/EstimatedCharges/DiscountedCharges/NetCharge").text.to_f
+    rescue
+      raise ShippingError, get_error
+    end
       
 		# still not sure what the best way to handle this transaction's return data would be. Possibly a hash of the form {service => delivery_estimate}?
 		def express_service_availability
@@ -84,18 +86,159 @@ module Shipping
 		   
 		   return REXML::XPath.first(@response, "//FDXSubscriptionReply/MeterNumber").text
 		end
-		
+		                                                   
 		#     require 'fileutils'
 		#     fedex = Shipping::FedEx.new :name => 'John Doe', ... , :sender_zip => 97202
 		#     label = fedex.label
-		#		puts label.url
 		#     puts label.tracking_number
-		#		
-		#		In the future you will be able to do:
+    #     FileUtils.cp label.image.path, '/path/to/my/images/directory/'
+		#		                                                              
+		# There are several types of labels that can be returned by changing @image_type.
+		# PNG is selected by default.
 		#
-		#     FileUtils.cp label.image.path, '/path/to/my/images/directory/'
-		#
-		def label
+		def label     
+		   @required =  [:phone,        :email,        :address,        :city,        :state,        :zip        ]
+		   @required += [:sender_phone, :sender_email, :sender_address, :sender_city, :sender_state, :sender_zip ]
+		   @required += [:fedex_account, :fedex_url]
+
+		   @transaction_type ||= 'rate_ground'
+		   @weight = (@weight.to_f*10).round/10.0
+		   @declared_value = (@declared_value.to_f*100).round/100.0 unless @declared_value.blank?
+		   state = STATES.has_value?(@state.downcase) ? STATES.index(@state.downcase).upcase : @state.upcase
+		   sender_state = STATES.has_value?(@sender_state.downcase) ? STATES.index(@sender_state.downcase).upcase : @sender_state.upcase
+
+		   @data = String.new
+
+		   b = Builder::XmlMarkup.new :target => @data
+       b.instruct!
+       b.FDXShipRequest('xmlns:api' => 'http://www.fedex.com/fsmapi', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance', 'xsi:noNamespaceSchemaLocation' => 'FDXShipRequest.xsd') { |b|
+   		 b.RequestHeader { |b|
+   		 	b.AccountNumber @fedex_account
+   		 	b.MeterNumber @fedex_meter
+   		 	b.CarrierCode TransactionTypes[@transaction_type][1]
+   		 }
+   		 b.ShipDate((Time.now).strftime("%Y-%m-%d"))
+   		 b.ShipTime((Time.now).strftime("%H:%M:%S"))
+        	b.DropoffType @dropoff_type || 'REGULARPICKUP'
+   		 b.Service ServiceTypes[@service_type] || ServiceTypes['ground_service'] # default to ground service
+   		 b.Packaging PackageTypes[@packaging_type] || 'YOURPACKAGING'
+   		 b.WeightUnits @weight_units || 'LBS' # or KGS
+   		 b.Weight @weight
+   		 b.CurrencyCode @currency_code || 'USD'
+   		 b.Origin { |b|
+   		    b.Contact { |b|
+   		       if @sender_name.to_s.size > 2
+       		      b.PersonName @sender_name
+       		      b.CompanyName @sender_company unless @sender_company.blank?
+       		   elsif @sender_company.to_s.size > 2
+       		      b.PersonName @sender_name unless @sender_name.blank?
+       		      b.CompanyName @sender_company
+       		   else
+       		      raise ShippingError, "Either the sender_name or the sender_company value must be bigger than 2 characters."
+       		   end
+       		   b.Department @sender_department unless @sender_department.blank?
+       		   b.PhoneNumber @sender_phone.gsub(/[^\d]/,"")
+       		   b.PagerNumber @sender_pager.gsub(/[^\d]/,"") if @sender_pager.class == String
+       		   b.FaxNumber @sender_fax.gsub(/[^\d]/,"") if @sender_fax.class == String
+   		       b.tag! :"E-MailAddress", @sender_email
+   		    }
+   		    b.Address { |b|
+   		       b.Line1 @sender_address
+   		       b.Line2 @sender_address2 unless @sender_address2.blank?
+   		       b.City @sender_city
+   		       b.StateOrProvinceCode sender_state
+   		       b.PostalCode @sender_zip
+   		       b.CountryCode @sender_country || 'US'
+   		    }
+   		 }
+   		 b.Destination { |b|
+       	b.Contact { |b|
+       			if @name.to_s.size > 2
+       			   b.PersonName @name
+       			   b.CompanyName @company unless @company.blank?
+       			elsif @company.to_s.size > 2
+       			   b.PersonName @name unless @name.blank?
+       			   b.CompanyName @company
+       			else
+       			   raise ShippingError, "Either the name or the company value must be bigger than 2 characters."
+       			end
+       			b.Department @department unless @department.blank?
+       	   b.PhoneNumber @phone.gsub(/[^\d]/,"")
+       	   b.PagerNumber @pager.gsub(/[^\d]/,"") if @pager.class == String
+       	   b.FaxNumber @fax.gsub(/[^\d]/,"") if @fax.class == String
+       	   b.tag! :"E-MailAddress", @email
+       	}
+       	b.Address { |b|
+       	   b.Line1 @address
+       	   b.Line2 @address2 unless @address2.blank?
+       	   b.City @city
+       	   b.StateOrProvinceCode state
+       	   b.PostalCode @zip
+       	   b.CountryCode @country || 'US'
+       	}
+       }
+       b.Payment { |b|
+          b.PayorType PaymentTypes[@pay_type] || 'SENDER'
+          b.Payor { |b|
+             b.AccountNumber @payor_account_number
+             b.CountryCode @payor_country_code unless @payor_country_code.blank?
+          } unless @payor_account_number.blank?
+       }
+       b.RMA { |b|
+          b.Number @rma_number
+       } unless @rma_number.blank?
+       b.SpecialServices { |b|
+          b.EMailNotification { |b|
+             b.ShipAlertOptionalMessage @message
+             b.Shipper { |b|
+                b.ShipAlert @shipper_ship_alert ? 'true' : 'false'
+                b.LanguageCode @shipper_language || 'EN' # FR also available
+             }
+             b.Recipient { |b|
+       		      b.ShipAlert @recipient_ship_alert ? 'true' : 'false'
+       		      b.LanguageCode @recipient_language || 'EN' # FR also available
+             }
+             b.Other { |b|
+                b.tag! :"E-MailAddress", @other_email
+                b.ShipAlert @other_ship_alert ? 'true' : 'false'
+                b.LanguageCode @other_language || 'EN' # FR also available
+             } unless @other_email.blank?
+          }
+       } unless @message.blank?
+       b.Label { |b|
+          b.Type @label_type || '2DCOMMON'
+          b.ImageType @image_type || 'PNG'
+       }
+       }
+		   get_response @fedex_url
+
+		  begin  
+   		   response = Hash.new       
+   		   response[:tracking_number] = REXML::XPath.first(@response, "//FDXShipReply/Tracking/TrackingNumber").text
+   		   response[:encoded_image] = REXML::XPath.first(@response, "//FDXShipReply/Labels/OutboundLabel").text
+   		   response[:image] = Tempfile.new("shipping_label")
+   		   response[:image].write Base64.decode64( response[:encoded_image] )
+   		   response[:image].rewind
+   		rescue
+   		   raise ShippingError, get_error
+   		end
+
+		   # allows for things like fedex.label.url
+		   def response.method_missing(name, *args)
+		      has_key?(name) ? self[name] : super
+		   end
+
+		   # don't allow people to edit the response
+		   response.freeze
+		end
+
+		#     require 'fileutils'
+		#     fedex = Shipping::FedEx.new :name => 'John Doe', ... , :sender_zip => 97202
+		#     label = fedex.email_label
+		#	  	puts label.url
+		#     puts label.tracking_number
+		#		
+		def return_label
 		   @required =  [:phone,        :email,        :address,        :city,        :state,        :zip        ]
 		   @required += [:sender_phone, :sender_email, :sender_address, :sender_city, :sender_state, :sender_zip ]
 		   @required += [:fedex_account, :fedex_url, :weight                                                     ]
@@ -222,37 +365,18 @@ module Shipping
    		   response[:userid]    = REXML::XPath.first(@response, "//FDXEmailLabelReply/UserID").text
    		   response[:password]  = REXML::XPath.first(@response, "//FDXEmailLabelReply/Password").text
    		   response[:tracking_number] = REXML::XPath.first(@response, "//FDXEmailLabelReply/Package/TrackingNumber").text
-   		rescue
-   		   raise ShippingError, get_error
-   		end
+     	 rescue
+     	    raise ShippingError, get_error
+     	 end
 		   
-		   # allows for things like fedex.label.url
-		   def response.method_missing(name, *args)
-		      has_key?(name) ? self[name] : super
-		   end
+  		 # allows for things like fedex.label.url
+  		 def response.method_missing(name, *args)
+  		    has_key?(name) ? self[name] : super
+  		 end
 		   
-=begin
-# Initial work on the screen-grabbing necessary to grab the data of the image
-
-		   f = Tempfile.new response.password
-		   uri = URI.parse response.url
-		   
-		   http = Net::HTTP.new uri.host, uri.port
-		   if uri.port == 443
-		      http.use_ssl	= true
-		      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-		   end
-		   req = Net::HTTP::Get.new(uri.path)
-		   req.basic_auth response.userid, response.password
-		   res = http.request(req)
-		   f << res.body
-		   f.seek(0)
-		   response[:image] = f
-=end
-
-		   # don't allow people to edit the response
-		   return response.freeze
-		end
+  		 # don't allow people to edit the response
+  		 return response.freeze
+		  end
 
       private
 
@@ -278,6 +402,7 @@ module Shipping
          	b.Packaging PackageTypes[@packaging_type] || 'YOURPACKAGING'
          	b.WeightUnits @weight_units || 'LBS'
          	b.Weight @weight
+         	b.ListRate true #tells fedex to return list rates as well as discounted rates
          	b.OriginAddress { |b|
          	  b.StateOrProvinceCode self.class.state_from_zip(@sender_zip)
          		b.PostalCode @sender_zip
@@ -297,14 +422,14 @@ module Shipping
          get_response @fedex_url
       end
 	
-		def get_error
-			return if @response.class != REXML::Document
+  		def get_error
+  			return if @response.class != REXML::Document
 			
-			code = REXML::XPath.first(@response, "//Error/Code").text
-			message = REXML::XPath.first(@response, "//Error/Message").text
+  			code = REXML::XPath.first(@response, "//Error/Code").text
+  			message = REXML::XPath.first(@response, "//Error/Message").text
 			
-			return "Error #{code}: #{message}"
-		end
+  			return "Error #{code}: #{message}"
+  		end
 
       # The following type hashes are to allow cross-api data retrieval
       
@@ -327,30 +452,30 @@ module Shipping
          "international_ground_service" => "INTERNATIONALGROUND"
       }
 
-		PackageTypes = {
-			"fedex_envelope" => "FEDEXENVELOPE",
-			"fedex_pak" => "FEDEXPAK",
-			"fedex_box" => "FEDEXBOX",
-			"fedex_tube" => "FEDEXTUBE",
-			"fedex_10_kg_box" => "FEDEX10KGBOX",
-			"fedex_25_kg_box" => "FEDEX25KGBOX",
-			"your_packaging" => "YOURPACKAGING"
-		}
-		
-		DropoffTypes = {
-			'regular_pickup' => 'REGULARPICKUP',
-			'request_courier' => 'REQUESTCOURIER',
-			'dropbox' => 'DROPBOX',
-			'business_service_center' => 'BUSINESSSERVICECENTER',
-			'station' => 'STATION'
-		}
-		
-		PaymentTypes = {
-			'sender' => 'SENDER',
-			'recipient' => 'RECIPIENT',
-			'third_party' => 'THIRDPARTY',
-			'collect' => 'COLLECT'
- 		}
+    	PackageTypes = {
+    		"fedex_envelope" => "FEDEXENVELOPE",
+    		"fedex_pak" => "FEDEXPAK",
+    		"fedex_box" => "FEDEXBOX",
+    		"fedex_tube" => "FEDEXTUBE",
+    		"fedex_10_kg_box" => "FEDEX10KGBOX",
+    		"fedex_25_kg_box" => "FEDEX25KGBOX",
+    		"your_packaging" => "YOURPACKAGING"
+    	}
+	
+    	DropoffTypes = {
+    		'regular_pickup' => 'REGULARPICKUP',
+    		'request_courier' => 'REQUESTCOURIER',
+    		'dropbox' => 'DROPBOX',
+    		'business_service_center' => 'BUSINESSSERVICECENTER',
+    		'station' => 'STATION'
+    	}
+	
+    	PaymentTypes = {
+    		'sender' => 'SENDER',
+    		'recipient' => 'RECIPIENT',
+    		'third_party' => 'THIRDPARTY',
+    		'collect' => 'COLLECT'
+    		}
 
       
       TransactionTypes = {

data/test/fedex/fedex_test.rb

@@ -5,11 +5,12 @@ class FedExTest < Test::Unit::TestCase
 	end
 	
 	def test_price
-	   assert_equal 4.67, @ship.price
+	   assert_in_delta 5.00, @ship.price, 1
 	end
 	
-	def test_base_price
-	   assert_equal 5.07, @ship.base_price
+	def test_discount_price
+	   assert_in_delta 5.00, @ship.discount_price, 1
+	   assert @ship.discount_price < @ship.price
 	end
 	
 	def test_fails

data/test/ups/ups_test.rb

@@ -5,7 +5,7 @@ class UpsTest < Test::Unit::TestCase
 	end
 	
 	def test_price
-	   assert_equal 8.82, @ship.price
+	   assert_in_delta 8.82, @ship.price, 1
 	end
 	
 	def test_valid_address

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: shipping
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
-date: 2005-09-15
+  version: 1.3.0
+date: 2005-09-24
 summary: A general shipping module to find out the shipping prices via UPS or FedEx.
 require_paths: 
   - lib