kschadeck-active_shipping 0.9.15

data/lib/active_shipping/shipping/package.rb

@@ -0,0 +1,147 @@
+module ActiveMerchant #:nodoc:
+  module Shipping #:nodoc:
+    class Package
+      include Quantified
+      
+      cattr_accessor :default_options
+      attr_reader :options, :value, :currency
+
+      # Package.new(100, [10, 20, 30], :units => :metric)
+      # Package.new(Mass.new(100, :grams), [10, 20, 30].map {|m| Length.new(m, :centimetres)})
+      # Package.new(100.grams, [10, 20, 30].map(&:centimetres))
+      def initialize(grams_or_ounces, dimensions, options = {})
+        options = @@default_options.update(options) if @@default_options
+        options.symbolize_keys!
+        @options = options
+        
+        @dimensions = [dimensions].flatten.reject {|d| d.nil?}
+        
+        imperial = (options[:units] == :imperial) ||
+          ([grams_or_ounces, *dimensions].all? {|m| m.respond_to?(:unit) && m.unit.to_sym == :imperial})
+        
+        @unit_system = imperial ? :imperial : :metric
+        
+        @weight = attribute_from_metric_or_imperial(grams_or_ounces, Mass, :grams, :ounces)
+        
+        if @dimensions.blank?
+          @dimensions = [Length.new(0, (imperial ? :inches : :centimetres))] * 3
+        else
+          process_dimensions
+        end
+        
+        @value = Package.cents_from(options[:value])
+        @currency = options[:currency] || (options[:value].currency if options[:value].respond_to?(:currency))
+        @cylinder = (options[:cylinder] || options[:tube]) ? true : false
+        @gift = options[:gift] ? true : false
+      end
+  
+      def cylinder?
+        @cylinder
+      end
+      alias_method :tube?, :cylinder?
+      
+      def gift?; @gift end
+      
+      def ounces(options={})
+        weight(options).in_ounces.amount
+      end
+      alias_method :oz, :ounces
+  
+      def grams(options={})
+        weight(options).in_grams.amount
+      end
+      alias_method :g, :grams
+  
+      def pounds(options={})
+        weight(options).in_pounds.amount
+      end
+      alias_method :lb, :pounds
+      alias_method :lbs, :pounds
+  
+      def kilograms(options={})
+        weight(options).in_kilograms.amount
+      end
+      alias_method :kg, :kilograms
+      alias_method :kgs, :kilograms
+  
+      def inches(measurement=nil)
+        @inches ||= @dimensions.map {|m| m.in_inches.amount }
+        measurement.nil? ? @inches : measure(measurement, @inches)
+      end
+      alias_method :in, :inches
+  
+      def centimetres(measurement=nil)
+        @centimetres ||= @dimensions.map {|m| m.in_centimetres.amount }
+        measurement.nil? ? @centimetres : measure(measurement, @centimetres)
+      end
+      alias_method :cm, :centimetres
+      
+      def weight(options = {})
+        case options[:type]
+        when nil, :actual
+          @weight
+        when :volumetric, :dimensional
+          @volumetric_weight ||= begin
+            m = Mass.new((centimetres(:box_volume) / 6.0), :grams)
+            @unit_system == :imperial ? m.in_ounces : m
+          end
+        when :billable
+          [ weight, weight(:type => :volumetric) ].max
+        end
+      end
+      alias_method :mass, :weight
+      
+      def self.cents_from(money)
+        return nil if money.nil?
+        if money.respond_to?(:cents)
+          return money.cents
+        else
+          case money
+          when Float
+            (money * 100).round
+          when String
+            money =~ /\./ ? (money.to_f * 100).round : money.to_i
+          else
+            money.to_i
+          end
+        end
+      end
+  
+      private
+      
+      def attribute_from_metric_or_imperial(obj, klass, metric_unit, imperial_unit)
+        if obj.is_a?(klass)
+          return value
+        else
+          return klass.new(obj, (@unit_system == :imperial ? imperial_unit : metric_unit))
+        end
+      end
+      
+      def measure(measurement, ary)
+        case measurement
+        when Fixnum then ary[measurement] 
+        when :x, :max, :length, :long then ary[2]
+        when :y, :mid, :width, :wide then ary[1]
+        when :z, :min, :height,:depth,:high,:deep then ary[0]
+        when :girth, :around,:circumference
+          self.cylinder? ? (Math::PI * (ary[0] + ary[1]) / 2) : (2 * ary[0]) + (2 * ary[1])
+        when :volume then self.cylinder? ? (Math::PI * (ary[0] + ary[1]) / 4)**2 * ary[2] : measure(:box_volume,ary)
+        when :box_volume then ary[0] * ary[1] * ary[2]
+        end
+      end
+      
+      def process_dimensions
+        @dimensions = @dimensions.map do |l|
+          attribute_from_metric_or_imperial(l, Length, :centimetres, :inches)
+        end.sort
+        # [1,2] => [1,1,2]
+        # [5] => [5,5,5]
+        # etc..
+        2.downto(@dimensions.length) do |n|
+          @dimensions.unshift(@dimensions[0])
+        end
+      end
+  
+    end
+  end
+end

data/lib/active_shipping/shipping/rate_estimate.rb

@@ -0,0 +1,62 @@
+module ActiveMerchant #:nodoc:
+  module Shipping #:nodoc:
+  
+    class RateEstimate
+      attr_reader :origin         # Location objects
+      attr_reader :destination  
+      attr_reader :package_rates  # array of hashes in the form of {:package => <Package>, :rate => 500}
+      attr_reader :carrier        # Carrier.name ('USPS', 'FedEx', etc.)
+      attr_reader :service_name   # name of service ("First Class Ground", etc.)
+      attr_reader :service_code
+      attr_reader :currency       # 'USD', 'CAD', etc.
+                                  # http://en.wikipedia.org/wiki/ISO_4217
+      attr_reader :delivery_date  # Usually only available for express shipments
+      attr_reader :delivery_range # Min and max delivery estimate in days
+        
+      def initialize(origin, destination, carrier, service_name, options={})
+        @origin, @destination, @carrier, @service_name = origin, destination, carrier, service_name
+        @service_code = options[:service_code]
+        if options[:package_rates]
+          @package_rates = options[:package_rates].map {|p| p.update({:rate => Package.cents_from(p[:rate])}) }
+        else
+          @package_rates = Array(options[:packages]).map {|p| {:package => p}}
+        end
+        @total_price = Package.cents_from(options[:total_price])
+        @currency = options[:currency]
+        @delivery_range = options[:delivery_range] ? options[:delivery_range].map { |date| date_for(date) }.compact : []
+        @delivery_date = @delivery_range.last
+      end
+
+      def total_price
+        begin
+          @total_price || @package_rates.sum {|p| p[:rate]}
+        rescue NoMethodError
+          raise ArgumentError.new("RateEstimate must have a total_price set, or have a full set of valid package rates.")
+        end
+      end
+      alias_method :price, :total_price
+      
+      def add(package,rate=nil)
+        cents = Package.cents_from(rate)
+        raise ArgumentError.new("New packages must have valid rate information since this RateEstimate has no total_price set.") if cents.nil? and total_price.nil?
+        @package_rates << {:package => package, :rate => cents}
+        self
+      end
+      
+      def packages
+        package_rates.map {|p| p[:package]}
+      end
+      
+      def package_count
+        package_rates.length
+      end
+
+      private
+      def date_for(date)
+        date && DateTime.strptime(date.to_s, "%Y-%m-%d")
+      rescue ArgumentError
+        nil
+      end
+    end
+  end
+end

data/lib/active_shipping/shipping/rate_response.rb

@@ -0,0 +1,19 @@
+module ActiveMerchant #:nodoc:
+  module Shipping
+    
+    class RateResponse < Response
+      
+      attr_reader :rates
+      
+      def initialize(success, message, params = {}, options = {})
+        @rates = Array(options[:estimates] || options[:rates] || options[:rate_estimates])
+        super
+      end
+      
+      alias_method :estimates, :rates
+      alias_method :rate_estimates, :rates
+      
+    end
+    
+  end
+end

data/lib/active_shipping/shipping/response.rb

@@ -0,0 +1,46 @@
+module ActiveMerchant #:nodoc:
+    
+  module Shipping #:nodoc:
+    
+    class Error < ActiveMerchant::ActiveMerchantError
+    end
+    
+    class ResponseError < Error
+      attr_reader :response
+      
+      def initialize(response = nil)
+        if response.is_a? Response
+          super(response.message)
+          @response = response
+        else
+          super(response)
+        end
+      end      
+    end
+    
+    class Response
+      
+      attr_reader :params
+      attr_reader :message
+      attr_reader :test
+      attr_reader :xml
+      attr_reader :request
+        
+      def initialize(success, message, params = {}, options = {})
+        @success, @message, @params = success, message, params.stringify_keys
+        @test = options[:test] || false
+        @xml = options[:xml]
+        @request = options[:request]
+        raise ResponseError.new(self) unless success
+      end
+    
+      def success?
+        @success ? true : false
+      end
+
+      def test?
+        @test ? true : false
+      end
+    end
+  end
+end

data/lib/active_shipping/shipping/shipment_event.rb

@@ -0,0 +1,14 @@
+module ActiveMerchant #:nodoc:
+  module Shipping
+      
+    class ShipmentEvent
+      attr_reader :name, :time, :location, :message
+      
+      def initialize(name, time, location, message=nil)
+        @name, @time, @location, @message = name, time, location, message
+      end
+      
+    end
+    
+  end
+end

data/lib/active_shipping/shipping/shipment_packer.rb

@@ -0,0 +1,48 @@
+module ActiveMerchant
+  module Shipping
+    class ShipmentPacker
+      class OverweightItem < StandardError
+      end
+
+      # items           - array of hashes containing quantity, grams and price.
+      #                   ex. [{:quantity => 2, :price => 1.0, :grams => 50}]
+      # dimensions      - [5.0, 15.0, 30.0]
+      # maximum_weight  - maximum weight in grams
+      # currency        - ISO currency code
+      def self.pack(items, dimensions, maximum_weight, currency)
+        items = items.map(&:symbolize_keys).map { |item| [item] * item[:quantity].to_i }.flatten
+        packages = []
+        state = :package_empty
+
+        while state != :packing_finished
+          case state
+          when :package_empty
+            package_weight, package_value = 0, 0
+            state = :filling_package
+          when :filling_package
+            item = items.shift
+            item_weight, item_price = item[:grams].to_i, Package.cents_from(item[:price])
+
+            if item_weight > maximum_weight
+              raise OverweightItem, "The item with weight of #{item_weight}g is heavier than the allowable package weight of #{maximum_weight}g"
+            end
+
+            if (package_weight + item_weight) <= maximum_weight
+              package_weight += item_weight
+              package_value  += item_price
+              state = :package_full if items.empty?
+            else
+              items.unshift(item)
+              state = :package_full
+            end
+          when :package_full
+            packages << ActiveMerchant::Shipping::Package.new(package_weight, dimensions, :value => package_value, :currency => currency)
+            state = items.any? ? :package_empty : :packing_finished
+          end
+        end
+
+        packages
+      end
+    end
+  end
+end

data/lib/active_shipping/shipping/tracking_response.rb

@@ -0,0 +1,47 @@
+module ActiveMerchant #:nodoc:
+  module Shipping
+    
+    class TrackingResponse < Response
+      attr_reader :carrier # symbol
+      attr_reader :carrier_name # string
+      attr_reader :status # symbol
+      attr_reader :status_code # string
+      attr_reader :status_description #string
+      attr_reader :scheduled_delivery_date # time
+      attr_reader :tracking_number # string
+      attr_reader :shipment_events # array of ShipmentEvents in chronological order
+      attr_reader :origin, :destination
+      
+      def initialize(success, message, params = {}, options = {})
+        @carrier = options[:carrier].parameterize.to_sym
+        @carrier_name = options[:carrier]
+        @status = options[:status]
+        @status_code = options[:status_code]
+        @status_description = options[:status_description]
+        @scheduled_delivery_date = options[:scheduled_delivery_date]
+        @tracking_number = options[:tracking_number]
+        @shipment_events = Array(options[:shipment_events])
+        @origin, @destination = options[:origin], options[:destination]
+        super
+      end
+
+      def latest_event
+        @shipment_events.last
+      end
+
+      def is_delivered?
+        @status == :delivered
+      end
+
+      def has_exception?
+        @status == :exception
+      end
+
+      alias_method(:exception_event, :latest_event)
+      alias_method(:delivered?, :is_delivered?)
+      alias_method(:exception?, :has_exception?)
+
+    end
+    
+  end
+end

data/lib/active_shipping/version.rb

@@ -0,0 +1,3 @@
+module ActiveShipping
+  VERSION = "0.9.15"
+end

data/lib/certs/eParcel.dtd

@@ -0,0 +1,111 @@
+<!-- EVERY REQUEST CONTAIN THE eparcel TAG -->
+<!ELEMENT eparcel (language?,
+					(  ratesAndServicesRequest |
+						ratesAndServicesResponse |
+						error
+					)+)>
+
+<!ELEMENT language (#PCDATA)>
+<!ELEMENT comment (#PCDATA)>
+
+
+<!-- Standard request to ask for rates and services -->
+<!ELEMENT ratesAndServicesRequest (	merchantCPCID,
+												fromPostalCode?,
+												turnAroundTime?,
+												itemsPrice?,
+												lineItems,
+												city?,
+												provOrState,
+												country,
+												postalCode)>
+	<!ELEMENT merchantID (#PCDATA)>
+	<!ELEMENT fromPostalCode (#PCDATA)>
+	<!ELEMENT turnAroundTime (#PCDATA)>
+	<!ELEMENT itemsPrice (#PCDATA)>
+	<!ELEMENT merchantCPCID (#PCDATA)>
+	<!ELEMENT lineItems (item)+>
+		<!ELEMENT item (quantity, weight, length, width, height, description, imageURL?, readyToShip)>
+			<!ELEMENT quantity (#PCDATA)>
+			<!ELEMENT weight (#PCDATA)>
+			<!ELEMENT length (#PCDATA)>
+			<!ELEMENT width (#PCDATA)>
+			<!ELEMENT height (#PCDATA)>
+			<!ELEMENT description (#PCDATA)>
+			<!ELEMENT imageURL (#PCDATA)>
+			<!ELEMENT readyToShip (#PCDATA)>
+	<!ELEMENT city (#PCDATA)>
+	<!ELEMENT provOrState (#PCDATA)>
+	<!ELEMENT country (#PCDATA)>
+	<!ELEMENT postalCode (#PCDATA)>
+
+<!-- Standard response for request for rates and services -->
+<!ELEMENT ratesAndServicesResponse (statusCode, 
+												statusMessage+, 
+												requestID, 
+												handling, 
+												language, 
+												product+,   
+												packing*, 
+												emptySpace*, 
+												shippingOptions, 
+												comment,
+												nearestPostalOutlet*)>
+
+	<!ELEMENT statusCode (#PCDATA)>
+	<!ELEMENT statusMessage (#PCDATA)>
+	<!ELEMENT requestID (#PCDATA)>
+	<!ELEMENT handling (#PCDATA)>
+
+	<!ELEMENT product (name, rate, shippingDate, deliveryDate, deliveryDayOfWeek, nextDayAM?, packingID)>
+		<!ATTLIST product       id    CDATA    		#REQUIRED>
+		<!ATTLIST product       sequence    CDATA    #REQUIRED>
+		<!ELEMENT name (#PCDATA)>
+		<!ELEMENT rate (#PCDATA)>
+		<!ELEMENT shippingDate (#PCDATA)>
+		<!ELEMENT deliveryDate (#PCDATA)>
+		<!ELEMENT deliveryDayOfWeek (#PCDATA)>
+		<!ELEMENT nextDayAM (#PCDATA)>
+		<!ELEMENT packingID (#PCDATA)>
+
+	<!ELEMENT packing (packingID, box+)>
+		<!ELEMENT box (name, weight, expediterWeight, length, width, height, packedItem+)>
+			<!ELEMENT expediterWeight (#PCDATA)>
+			<!ELEMENT packedItem (quantity, description)>
+
+	<!ELEMENT emptySpace (length, width, height, weight)>
+
+	<!ELEMENT shippingOptions (insurance, deliveryConfirmation, signature)>
+		<!ELEMENT insurance (#PCDATA)>
+		<!ELEMENT deliveryConfirmation (#PCDATA)>
+		<!ELEMENT signature (#PCDATA)>
+
+
+	<!-- *********************************************************  -->
+	<!-- * 'nearestPostalOutlet'  is optional and is returned    *  -->
+	<!-- * only if the merchant profile has this option enabled  *  -->
+	<!-- *********************************************************  -->
+	<!ELEMENT nearestPostalOutlet (postalOutletSequenceNo,
+											distance,
+										   outletName, 
+											businessName , 
+											postalAddress, 
+											phoneNumber, 
+											businessHours+)>
+		<!ELEMENT postalOutletSequenceNo		(#PCDATA)>
+		<!ELEMENT distance 			(#PCDATA)>
+		<!ELEMENT outletName 		(#PCDATA)>
+		<!ELEMENT businessName 		(#PCDATA)>
+		<!ELEMENT postalAddress (addressLine+, postalCode , municipality)>
+			<!ELEMENT addressLine 		(#PCDATA)>
+			<!ELEMENT municipality 		(#PCDATA)>
+		<!ELEMENT phoneNumber 		(#PCDATA)>
+		<!ELEMENT businessHours (dayId, dayOfWeek, time)>
+			<!ELEMENT dayId     					(#PCDATA)>
+			<!ELEMENT dayOfWeek 					(#PCDATA)>
+			<!ELEMENT time 						(#PCDATA)>
+
+
+<!-- Standard error format returned -->
+<!ELEMENT error (statusCode,statusMessage*)>
+