active_shipping 0.12.4 → 0.12.5

data/lib/active_shipping/shipping/errors.rb

@@ -6,4 +6,4 @@ module ActiveMerchant
       end
     end
   end
-end
+end

data/lib/active_shipping/shipping/label_response.rb

@@ -0,0 +1,25 @@
+module ActiveMerchant #:nodoc:
+  module Shipping
+    # This is UPS specific for now; the hash is not at all generic
+    # or common between carriers.
+
+    class LabelResponse < Response
+      attr :params # maybe?
+
+      def initialize(success, message, params = {}, options = {})
+        @params = params
+        super
+      end
+
+      def labels
+        return @labels if @labels
+        packages = params["ShipmentResults"]["PackageResults"]
+        packages = [packages] if Hash === packages
+        @labels  = packages.map do |package|
+          { :tracking_number => package["TrackingNumber"],
+            :image           => package["LabelImage"] }
+        end
+      end
+    end
+  end
+end

data/lib/active_shipping/shipping/location.rb

@@ -1,8 +1,8 @@
 module ActiveMerchant #:nodoc:
   module Shipping #:nodoc:
     class Location
-      ADDRESS_TYPES = %w{residential commercial po_box}
-      
+      ADDRESS_TYPES = %w(residential commercial po_box)
+
       attr_reader :options,
                   :country,
                   :postal_code,
@@ -16,14 +16,14 @@ module ActiveMerchant #:nodoc:
                   :fax,
                   :address_type,
                   :company_name
-      
+
       alias_method :zip, :postal_code
       alias_method :postal, :postal_code
       alias_method :state, :province
       alias_method :territory, :province
       alias_method :region, :province
       alias_method :company, :company_name
-      
+
       def initialize(options = {})
         @country = (options[:country].nil? or options[:country].is_a?(ActiveMerchant::Country)) ?
                       options[:country] :
@@ -41,8 +41,8 @@ module ActiveMerchant #:nodoc:
 
         self.address_type = options[:address_type]
       end
-      
-      def self.from(object, options={})
+
+      def self.from(object, options = {})
         return object if object.is_a? ActiveMerchant::Shipping::Location
         attr_mappings = {
           :name => [:name],
@@ -74,13 +74,13 @@ module ActiveMerchant #:nodoc:
           end
         end
         attributes.delete(:address_type) unless ADDRESS_TYPES.include?(attributes[:address_type].to_s)
-        self.new(attributes.update(options))
+        new(attributes.update(options))
       end
-      
+
       def country_code(format = :alpha2)
         @country.nil? ? nil : @country.code(format).value
       end
-      
+
       def residential?; @address_type == 'residential' end
       def commercial?; @address_type == 'commercial' end
       def po_box?; @address_type == 'po_box' end
@@ -109,7 +109,7 @@ module ActiveMerchant #:nodoc:
         }
       end
 
-      def to_xml(options={})
+      def to_xml(options = {})
         options[:root] ||= "location"
         to_hash.to_xml(options)
       end
@@ -117,15 +117,15 @@ module ActiveMerchant #:nodoc:
       def to_s
         prettyprint.gsub(/\n/, ' ')
       end
-      
+
       def prettyprint
         chunks = []
-        chunks << [@name, @address1,@address2,@address3].reject {|e| e.blank?}.join("\n")
-        chunks << [@city,@province,@postal_code].reject {|e| e.blank?}.join(', ')
+        chunks << [@name, @address1, @address2, @address3].reject(&:blank?).join("\n")
+        chunks << [@city, @province, @postal_code].reject(&:blank?).join(', ')
         chunks << @country
-        chunks.reject {|e| e.blank?}.join("\n")
+        chunks.reject(&:blank?).join("\n")
       end
-      
+
       def inspect
         string = prettyprint
         string << "\nPhone: #{@phone}" unless @phone.blank?
@@ -144,7 +144,9 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def address2_and_3
+        [address2, address3].reject(&:blank?).join(", ")
+      end
     end
-      
   end
 end

data/lib/active_shipping/shipping/package.rb

@@ -1,7 +1,7 @@
 module ActiveMerchant #:nodoc:
   module Shipping #:nodoc:
-    # A package item is a unique item(s) that is physically in a package. 
-    # A single package can have many items. This is only required 
+    # A package item is a unique item(s) that is physically in a package.
+    # A single package can have many items. This is only required
     # for shipping methods (label creation) right now.
     class PackageItem
       include Quantified
@@ -12,8 +12,8 @@ module ActiveMerchant #:nodoc:
         @name = name
 
         imperial = (options[:units] == :imperial) ||
-          (grams_or_ounces.respond_to?(:unit) && m.unit.to_sym == :imperial)
-        
+                   (grams_or_ounces.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)
@@ -36,28 +36,28 @@ module ActiveMerchant #:nodoc:
             @unit_system == :imperial ? m.in_ounces : m
           end
         when :billable
-          [ weight, weight(:type => :volumetric) ].max
+          [weight, weight(:type => :volumetric)].max
         end
       end
       alias_method :mass, :weight
 
-      def ounces(options={})
+      def ounces(options = {})
         weight(options).in_ounces.amount
       end
       alias_method :oz, :ounces
-  
-      def grams(options={})
+
+      def grams(options = {})
         weight(options).in_grams.amount
       end
       alias_method :g, :grams
-  
-      def pounds(options={})
+
+      def pounds(options = {})
         weight(options).in_pounds.amount
       end
       alias_method :lb, :pounds
       alias_method :lbs, :pounds
-  
-      def kilograms(options={})
+
+      def kilograms(options = {})
         weight(options).in_kilograms.amount
       end
       alias_method :kg, :kilograms
@@ -72,12 +72,11 @@ module ActiveMerchant #:nodoc:
           return klass.new(obj, (@unit_system == :imperial ? imperial_unit : metric_unit))
         end
       end
-
     end
 
     class Package
       include Quantified
-      
+
       cattr_accessor :default_options
       attr_reader :options, :value, :currency
 
@@ -88,36 +87,35 @@ module ActiveMerchant #:nodoc:
         options = @@default_options.update(options) if @@default_options
         options.symbolize_keys!
         @options = options
-        
-        @dimensions = [dimensions].flatten.reject {|d| d.nil?}
 
-        
+        @dimensions = [dimensions].flatten.reject(&:nil?)
+
         imperial = (options[:units] == :imperial) ||
-            ([grams_or_ounces, *dimensions].all? {|m| m.respond_to?(:unit) && m.unit.to_sym == :imperial})
-        
+                   ([grams_or_ounces, *dimensions].all? { |m| m.respond_to?(:unit) && m.unit.to_sym == :imperial })
+
         weight_imperial = dimensions_imperial = imperial if options.include?(:units)
 
         if options.include?(:weight_units)
           weight_imperial = (options[:weight_units] == :imperial) ||
-              (grams_or_ounces.respond_to?(:unit) && m.unit.to_sym == :imperial)
+                            (grams_or_ounces.respond_to?(:unit) && m.unit.to_sym == :imperial)
         end
 
         if options.include?(:dim_units)
           dimensions_imperial = (options[:dim_units] == :imperial) ||
-              (dimensions && dimensions.all? {|m| m.respond_to?(:unit) && m.unit.to_sym == :imperial})
+                                (dimensions && dimensions.all? { |m| m.respond_to?(:unit) && m.unit.to_sym == :imperial })
         end
-        
+
         @weight_unit_system = weight_imperial ? :imperial : :metric
         @dimensions_unit_system = dimensions_imperial ? :imperial : :metric
-        
+
         @weight = attribute_from_metric_or_imperial(grams_or_ounces, Mass, @weight_unit_system, :grams, :ounces)
-        
+
         if @dimensions.blank?
           @dimensions = [Length.new(0, (dimensions_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
@@ -125,7 +123,7 @@ module ActiveMerchant #:nodoc:
         @oversized = options[:oversized] ? true : false
         @unpackaged = options[:unpackaged] ? true : false
       end
-  
+
       def unpackaged?
         @unpackaged
       end
@@ -133,48 +131,48 @@ module ActiveMerchant #:nodoc:
       def oversized?
         @oversized
       end
-    
+
       def cylinder?
         @cylinder
       end
       alias_method :tube?, :cylinder?
-      
+
       def gift?; @gift end
-      
-      def ounces(options={})
+
+      def ounces(options = {})
         weight(options).in_ounces.amount
       end
       alias_method :oz, :ounces
-  
-      def grams(options={})
+
+      def grams(options = {})
         weight(options).in_grams.amount
       end
       alias_method :g, :grams
-  
-      def pounds(options={})
+
+      def pounds(options = {})
         weight(options).in_pounds.amount
       end
       alias_method :lb, :pounds
       alias_method :lbs, :pounds
-  
-      def kilograms(options={})
+
+      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 }
+
+      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 }
+
+      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
@@ -185,11 +183,11 @@ module ActiveMerchant #:nodoc:
             @weight_unit_system == :imperial ? m.in_ounces : m
           end
         when :billable
-          [ weight, weight(:type => :volumetric) ].max
+          [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)
@@ -205,7 +203,7 @@ module ActiveMerchant #:nodoc:
           end
         end
       end
-  
+
       private
 
       def attribute_from_metric_or_imperial(obj, klass, unit_system, metric_unit, imperial_unit)
@@ -215,20 +213,20 @@ module ActiveMerchant #:nodoc:
           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 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
+        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 :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, @dimensions_unit_system, :centimetres, :inches)
@@ -236,11 +234,10 @@ module ActiveMerchant #:nodoc:
         # [1,2] => [1,1,2]
         # [5] => [5,5,5]
         # etc..
-        2.downto(@dimensions.length) do |n|
+        2.downto(@dimensions.length) do |_n|
           @dimensions.unshift(@dimensions[0])
         end
       end
-  
     end
   end
 end

data/lib/active_shipping/shipping/rate_estimate.rb

@@ -1,6 +1,5 @@
 module ActiveMerchant #:nodoc:
   module Shipping #:nodoc:
-
     class RateEstimate
       attr_reader :origin         # Location objects
       attr_reader :destination
@@ -9,20 +8,20 @@ module ActiveMerchant #:nodoc:
       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
+      # http://en.wikipedia.org/wiki/ISO_4217
       attr_reader :shipping_date
       attr_reader :delivery_date  # Usually only available for express shipments
       attr_reader :delivery_range # Min and max delivery estimate in days
       attr_reader :negotiated_rate
       attr_reader :insurance_price
 
-      def initialize(origin, destination, carrier, service_name, options={})
+      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])}) }
+          @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}}
+          @package_rates = Array(options[:packages]).map { |p| {:package => p} }
         end
         @total_price = Package.cents_from(options[:total_price])
         @negotiated_rate = options[:negotiated_rate] ? Package.cents_from(options[:negotiated_rate]) : nil
@@ -34,15 +33,13 @@ module ActiveMerchant #:nodoc:
       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
+        @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
       alias_method :price, :total_price
 
-      def add(package,rate=nil)
+      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}
@@ -50,7 +47,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def packages
-        package_rates.map {|p| p[:package]}
+        package_rates.map { |p| p[:package] }
       end
 
       def package_count
@@ -58,6 +55,7 @@ module ActiveMerchant #:nodoc:
       end
 
       private
+
       def date_for(date)
         date && DateTime.strptime(date.to_s, "%Y-%m-%d")
       rescue ArgumentError

data/lib/active_shipping/shipping/rate_response.rb

@@ -1,19 +1,15 @@
 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
+end