shipping 1.5.1 → 1.6.0

data/README

@@ -44,6 +44,7 @@ Alternately, you can instantiate the base class and then see both UPS and FedEx
 
 == Authors    
 * Lucas Carlson  (mailto:lucas@rufy.com)
+* Jimmy Baker (mailto:jimmyebaker@gmail.com)
 * Noah Zoschke (mailto:noah@bitscribe.net)
 
 This library is released under the terms of the GNU LGPL.

data/lib/shipping/base.rb

@@ -3,16 +3,16 @@
 # License::   LGPL
 
 module Shipping
-	VERSION = "1.5.1"
+	VERSION = "1.6.0"
 
 	class ShippingError < StandardError; end
 	class ShippingRequiredFieldError < StandardError; end
 
 	class Base
-		attr_reader :data, :response, :plain_response, :required
+		attr_reader :data, :response, :plain_response, :required, :services
 
 		attr_writer :ups_license_number, :ups_shipper_number, :ups_user, :ups_password, :ups_url, :ups_tool
-		attr_writer :fedex_account, :fedex_meter, :fedex_url
+		attr_writer :fedex_account, :fedex_meter, :fedex_url, :fedex_package_weight_limit_in_lbs
 
 		attr_accessor :name, :phone, :company, :email, :address, :address2, :city, :state, :zip, :country
 		attr_accessor :sender_name, :sender_phone, :sender_company, :sender_email, :sender_address, :sender_city, :sender_state, :sender_zip, :sender_country
@@ -20,6 +20,8 @@ module Shipping
 		attr_accessor :weight, :weight_units, :insured_value, :declared_value, :transaction_type, :description
 		attr_accessor :measure_units, :measure_length, :measure_width, :measure_height
 		attr_accessor :package_total, :packaging_type, :service_type
+		
+		attr_accessor :price, :discount_price, :eta, :time_in_transit
 
 		attr_accessor :ship_date, :dropoff_type, :pay_type, :currency_code, :image_type, :label_type
 
@@ -28,12 +30,22 @@ module Shipping
 			YAML.load(File.open(prefs)).each {|pref, value| eval("@#{pref} = #{value.inspect}")} if File.exists?(prefs)
 
 			@required = Array.new
+			@services = Array.new
 
 			# include all provided data
 			options.each do |method, value| 
 				instance_variable_set("@#{method}", value)
 			end
-
+			
+			case options[:carrier]
+		  when "fedex"
+		    fedex
+	    when "ups"
+	      ups
+      when nil
+      else
+        raise ShippingError, "unknown service"
+      end
 		end
 
 		# Initializes an instance of Shipping::FedEx with the same instance variables as the base object
@@ -45,6 +57,8 @@ module Shipping
 		def ups
 			Shipping::UPS.new prepare_vars
 		end
+		
+		
 
 		def self.state_from_zip(zip)
 			zip = zip.to_i
@@ -160,5 +174,15 @@ module Shipping
 			end
 
 			STATES = {"al" => "alabama", "ne" => "nebraska", "ak" => "alaska", "nv" => "nevada", "az" => "arizona", "nh" => "new hampshire", "ar" => "arkansas", "nj" => "new jersey", "ca" => "california", "nm" => "new mexico", "co" => "colorado", "ny" => "new york", "ct" => "connecticut", "nc" => "north carolina", "de" => "delaware", "nd" => "north dakota", "fl" => "florida", "oh" => "ohio", "ga" => "georgia", "ok" => "oklahoma", "hi" => "hawaii", "or" => "oregon", "id" => "idaho", "pa" => "pennsylvania", "il" => "illinois", "pr" => "puerto rico", "in" => "indiana", "ri" => "rhode island", "ia" => "iowa", "sc" => "south carolina", "ks" => "kansas", "sd" => "south dakota", "ky" => "kentucky", "tn" => "tennessee", "la" => "louisiana", "tx" => "texas", "me" => "maine", "ut" => "utah", "md" => "maryland", "vt" => "vermont", "ma" => "massachusetts", "va" => "virginia", "mi" => "michigan", "wa" => "washington", "mn" => "minnesota", "dc" => "district of columbia", "ms" => "mississippi", "wv" => "west virginia", "mo" => "missouri", "wi" => "wisconsin", "mt" => "montana", "wy" => "wyoming"}
+			
+			def self.initialize_for_fedex_service(xml)
+        s = Shipping::Base.new
+        s.fedex
+        s.eta = REXML::XPath.first(xml, "DeliveryDate").text unless REXML::XPath.match(xml, "DeliveryDate").empty?
+        s.service_type = REXML::XPath.first(xml, "Service").text
+        s.discount_price = REXML::XPath.first(xml, "EstimatedCharges/DiscountedCharges/BaseCharge").text
+        s.price = REXML::XPath.first(xml, "EstimatedCharges/DiscountedCharges/NetCharge").text
+        return s
+      end
 		end
 	end

data/lib/shipping/fedex.rb

@@ -68,7 +68,7 @@ module Shipping
 					b.PersonName @name
 					b.CompanyName @company
 					b.Department @department if @department
-					b.PhoneNumber @phone.gsub(/[^\d]/,"")
+					b.PhoneNumber @phone.to_s.gsub(/[^\d]/,"")
 					b.tag! :"E-MailAddress", @email
 				}
 				b.Address { |b|
@@ -401,6 +401,14 @@ module Shipping
 			return true
 		end
 		
+		def available_services(force=nil)
+		  if @services.empty? || force
+		    get_available_services
+		  else
+		    @services
+	    end
+	  end
+		
 	private
 
 		def get_price #:nodoc:
@@ -456,6 +464,60 @@ module Shipping
 			return "Error #{code}: #{message}"
 		end
 
+    def get_available_services
+      @required = [:zip, :sender_zip, :weight]
+			@required += [:fedex_account, :fedex_meter, :fedex_url]
+
+			@transaction_type = 'rate_services'
+			@weight = (@weight.to_f*10).round/10.0
+			
+			# Ground first
+			@services = []
+			rate_available_services_request('FDXG')
+			rate_available_services_request('FDXE')
+			
+			return @services
+    end
+    
+    def rate_available_services_request(carrier_code)
+      @data = String.new
+			b = Builder::XmlMarkup.new(:target => @data)
+			b.instruct!
+			b.FDXRateAvailableServicesRequest('xmlns:api' => 'http://www.fedex.com/fsmapi', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance', 'xsi:noNamespaceSchemaLocation' => 'FDXRateAvailableServicesRequest.xsd') { |b|
+				b.RequestHeader { |b|
+					b.AccountNumber @fedex_account
+					b.MeterNumber @fedex_meter
+					b.CarrierCode carrier_code
+				}
+				b.ShipDate @ship_date unless @ship_date.blank?
+				b.DropoffType DropoffTypes[@dropoff_type] || DropoffTypes['regular_pickup']
+				b.Packaging PackageTypes[@packaging_type] || PackageTypes['your_packaging']
+				b.WeightUnits @weight_units || 'LBS'
+				b.Weight @weight || '1.0'
+				b.ListRate 'false'
+				b.OriginAddress { |b|
+				  b.StateOrProvince @sender_state
+				  b.PostalCode @sender_zip
+				  b.CountryCode @sender_country_code || 'US'
+				}
+				b.DestinationAddress { |b|
+				  b.StateOrProvince @state
+				  b.PostalCode @zip
+				  b.CountryCode @country_code || 'US'
+				}
+				b.Payment { |b|
+				  b.PayorType PaymentTypes[@pay_type] || PaymentTypes['sender']
+				}
+				b.PackageCount @package_total || 1
+			}
+			get_response @fedex_url
+
+			REXML::XPath.each(@response, "//Entry") { |el|
+			  @services << Shipping::Base.initialize_for_fedex_service(el)
+			}
+			
+    end
+
 		# The following type hashes are to allow cross-api data retrieval
 
 		ServiceTypes = {

data/test/fedex/fedex_test.rb

@@ -64,6 +64,23 @@ class FedExTest < Test::Unit::TestCase
 		assert @ship.void(@label.tracking_number)
 	end
 	
+	def test_available_services
+	  @ship.name = "Package Receiver"
+		@ship.phone = "555-555-5555"
+		@ship.email = "lucas@rufy.com"
+		@ship.address = "Some address"
+		@ship.city = "Portland"
+	
+		@ship.sender_name = "Package Sender"
+		@ship.sender_phone = "333-333-3333"
+		@ship.sender_email = "john@doe.com"
+		@ship.sender_address = "Ok old address"
+		@ship.sender_city = "New York"
+		
+		assert_nothing_raised { @available_services = @ship.available_services }
+		assert_not_nil @available_services
+	end
+	
 	def test_void_fail
 		# made up tracking number
 		assert_raise(Shipping::ShippingError) { @ship.void('470012923511666') }

metadata

@@ -1,68 +1,75 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
-specification_version: 1
 name: shipping
 version: !ruby/object:Gem::Version 
-  version: 1.5.1
-date: 2007-07-10 00:00:00 -07:00
-summary: A general shipping module to find out the shipping prices via UPS or FedEx.
-require_paths: 
-- lib
-email: lucas@rufy.com
-homepage: http://shipping.rufy.com/
-rubyforge_project: 
-description: A general shipping module to find out the shipping prices via UPS or FedEx.
-autorequire: shipping
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.6.0
 platform: ruby
-signing_key: 
-cert_chain: 
 authors: 
 - Lucas Carlson
+autorequire: shipping
+bindir: bin
+cert_chain: []
+
+date: 2009-10-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+description: "   A general shipping module to find out the shipping prices via UPS or FedEx.\n"
+email: lucas@rufy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - lib/extensions.rb
-- lib/shipping
-- lib/shipping.rb
 - lib/shipping/base.rb
 - lib/shipping/fedex.rb
 - lib/shipping/ups.rb
-- test/base
-- test/fedex
-- test/test_helper.rb
-- test/ups
+- lib/shipping.rb
 - test/base/base_test.rb
 - test/fedex/fedex_test.rb
+- test/test_helper.rb
 - test/ups/ups_test.rb
 - LICENSE
 - Rakefile
 - README
-test_files: []
+has_rdoc: true
+homepage: http://shipping.rufy.com/
+licenses: []
 
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+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: 
 - An xml-builder library.
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: builder
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.0
-    version: 
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A general shipping module to find out the shipping prices via UPS or FedEx.
+test_files: []
+