ups-ruby 0.8.3

data/lib/ups/data/canadian_states.rb

@@ -0,0 +1,21 @@
+require 'insensitive_hash'
+
+module UPS
+  module Data
+    CANADIAN_STATES = {
+      'British Columbia' => 'BC',
+      'Ontario' => 'ON',
+      'Newfoundland and Labrador' => 'NL',
+      'Nova Scotia' => 'NS',
+      'Prince Edward Island' => 'PE',
+      'New Brunswick' => 'NB',
+      'Quebec' => 'QC',
+      'Manitoba' => 'MB',
+      'Saskatchewan' => 'SK',
+      'Alberta' => 'AB',
+      'Northwest Territories' => 'NT',
+      'Nunavut' => 'NU',
+      'Yukon Territory' => 'YT'
+    }.insensitive
+  end
+end

data/lib/ups/data/ie_counties.rb

@@ -0,0 +1,10 @@
+module UPS
+  module Data
+    IE_COUNTIES = %w(
+      Antrim Armagh Carlow Cavan Clare Cork Derry Donegal Down Dublin Fermanagh
+      Galway Kerry Kildare Kilkenny Laois Leitrim Limerick Longford Louth Mayo
+      Meath Monaghan Offaly Roscommon Sligo Tipperary Tyrone Waterford Westmeath
+      Wexford Wicklow
+    )
+  end
+end

data/lib/ups/data/ie_county_prefixes.rb

@@ -0,0 +1,15 @@
+module UPS
+  module Data
+    IE_COUNTY_PREFIXES = [
+      'County',
+      'Cnty',
+      'CC.',
+      'CC',
+      'Ct.',
+      'Ct',
+      'Co.',
+      'Co',
+      'C.'
+    ]
+  end
+end

data/lib/ups/data/us_states.rb

@@ -0,0 +1,59 @@
+require 'insensitive_hash'
+
+module UPS
+  module Data
+    US_STATES = {
+      'Alabama' => 'AL',
+      'Alaska' => 'AK',
+      'Arizona' => 'AZ',
+      'Arkansas' => 'AR',
+      'California' => 'CA',
+      'Colorado' => 'CO',
+      'Connecticut' => 'CT',
+      'Delaware' => 'DE',
+      'District of Columbia' => 'DC',
+      'Florida' => 'FL',
+      'Georgia' => 'GA',
+      'Hawaii' => 'HI',
+      'Idaho' => 'ID',
+      'Illinois' => 'IL',
+      'Indiana' => 'IN',
+      'Iowa' => 'IA',
+      'Kansas' => 'KS',
+      'Kentucky' => 'KY',
+      'Louisiana' => 'LA',
+      'Maine' => 'ME',
+      'Maryland' => 'MD',
+      'Massachusetts' => 'MA',
+      'Michigan' => 'MI',
+      'Minnesota' => 'MN',
+      'Mississippi' => 'MS',
+      'Missouri' => 'MO',
+      'Montana' => 'MT',
+      'Nebraska' => 'NE',
+      'Nevada' => 'NV',
+      'New Hampshire' => 'NH',
+      'New Jersey' => 'NJ',
+      'New Mexico' => 'NM',
+      'New York' => 'NY',
+      'North Carolina' => 'NC',
+      'North Dakota' => 'ND',
+      'Ohio' => 'OH',
+      'Oklahoma' => 'OK',
+      'Oregon' => 'OR',
+      'Pennsylvania' => 'PA',
+      'Rhode Island' => 'RI',
+      'South Carolina' => 'SC',
+      'South Dakota' => 'SD',
+      'Tennessee' => 'TN',
+      'Texas' => 'TX',
+      'Utah' => 'UT',
+      'Vermont' => 'VT',
+      'Virginia' => 'VA',
+      'Washington' => 'WA',
+      'West Virginia' => 'WV',
+      'Wisconsin' => 'WI',
+      'Wyoming' => 'WY'
+    }.insensitive
+  end
+end

data/lib/ups/exceptions.rb

@@ -0,0 +1,7 @@
+module UPS
+  module Exceptions
+    class InvalidUrlException < StandardError; end
+    class InvalidAttributeError < StandardError; end
+    class AuthenticationRequiredException < StandardError; end
+  end
+end

data/lib/ups/packaging.rb

@@ -0,0 +1,27 @@
+module UPS
+  PACKAGING = {
+    '01' => 'UPS Letter',
+    '02' => 'Customer Supplied Package',
+    '03' => 'Tube',
+    '04' => 'Pak',
+    '21' => 'UPS Express Box',
+    '24' => 'UPS 25kg box',
+    '25' => 'UPS 10kg box',
+    '30' => 'Pallet',
+    '2a' => 'Small Express Box',
+    '2b' => 'Medium Express Box',
+    '2c' => 'Large Express Box',
+    '56' => 'Flats',
+    '57' => 'Parcels',
+    '58' => 'BPM',
+    '59' => 'First Class',
+    '60' => 'Priority',
+    '61' => 'Machinables',
+    '62' => 'Irregulars',
+    '63' => 'Parcel Post',
+    '64' => 'BPM Parcel',
+    '65' => 'Media Mail',
+    '66' => 'BPM Flat',
+    '67' => 'Standard Flat'
+  }
+end

data/lib/ups/parsers/parser_base.rb

@@ -0,0 +1,48 @@
+require 'uri'
+require 'ox'
+
+module UPS
+  module Parsers
+    class ParserBase < ::Ox::Sax
+      attr_accessor :switches,
+                    :status_code,
+                    :status_description,
+                    :error_description
+
+      def initialize
+        self.switches = {}
+      end
+
+      def start_element(name)
+        element_tracker_switch name, true
+      end
+
+      def end_element(name)
+        element_tracker_switch name, false
+      end
+
+      def value(value)
+        data = value.as_s
+        self.status_code = data if switch_active? :ResponseStatusCode
+
+        if switch_active?(:ResponseStatusDescription)
+          self.status_description = data
+        end
+
+        self.error_description = data if switch_active? :ErrorDescription
+      end
+
+      def element_tracker_switch(element, currently_in)
+        switches[element] = currently_in
+      end
+
+      def switch_active?(*elements)
+        elements.all? { |element| switches[element] == true }
+      end
+
+      def success?
+        ['1', 1].include? status_code
+      end
+    end
+  end
+end

data/lib/ups/parsers/rates_parser.rb

@@ -0,0 +1,60 @@
+module UPS
+  module Parsers
+    class RatesParser < ParserBase
+      attr_accessor :rated_shipments
+
+      def initialize
+        super
+        self.rated_shipments = []
+        @current_rate = {}
+      end
+
+      def start_element(name)
+        super
+      end
+
+      def end_element(name)
+        super
+        return unless name == :RatedShipment
+        rated_shipments << @current_rate.tap do |c|
+          if c.key? :negotiated_rate
+            c[:total] = c[:negotiated_rate]
+            c.delete :negotiated_rate
+          end
+        end
+        @current_rate = {}
+      end
+
+      def value(value)
+        super
+        if switch_active?(:RatedShipment, :Service, :Code)
+          parse_service_code value
+        elsif switch_active?(:RatedShipment, :TotalCharges)
+          parse_total_charges value
+        elsif switch_active?(:RatedShipment, :NegotiatedRates, :MonetaryValue)
+          parse_negotiated_rate value
+        elsif switch_active?(:RatedShipment, :RatedShipmentWarning)
+          parse_rated_shipment_warning value
+        end
+      end
+
+      def parse_negotiated_rate(value)
+        @current_rate[:negotiated_rate] = value.as_s
+      end
+
+      def parse_rated_shipment_warning(value)
+        @current_rate[:warnings] ||= []
+        @current_rate[:warnings] << value.as_s
+      end
+
+      def parse_service_code(value)
+        @current_rate[:service_code] = value.as_s
+        @current_rate[:service_name] = UPS::SERVICES[value.as_s]
+      end
+
+      def parse_total_charges(value)
+        @current_rate[:total] = value.as_s
+      end
+    end
+  end
+end

data/lib/ups/parsers/ship_accept_parser.rb

@@ -0,0 +1,52 @@
+require 'base64'
+require 'tempfile'
+
+module UPS
+  module Parsers
+    class ShipAcceptParser < ParserBase
+      attr_accessor :graphic_image,
+                    :graphic_extension,
+                    :html_image,
+                    :tracking_number
+
+      def value(value)
+        parse_graphic_image(value)
+        parse_html_image(value)
+        parse_tracking_number(value)
+        parse_graphic_extension(value)
+        super
+      end
+
+      def parse_graphic_image(value)
+        return unless switch_active?(:GraphicImage)
+        self.graphic_image = base64_to_file(value.as_s)
+      end
+
+      def parse_html_image(value)
+        return unless switch_active?(:HTMLImage)
+        self.html_image = base64_to_file(value.as_s)
+      end
+
+      def parse_tracking_number(value)
+        return unless switch_active?(:ShipmentIdentificationNumber)
+        self.tracking_number = value.as_s
+      end
+
+      def parse_graphic_extension(value)
+        return unless switch_active?(:LabelImageFormat, :Code)
+        self.graphic_extension = ".#{value.as_s.downcase}"
+      end
+
+      def base64_to_file(contents)
+        file_config = ['ups', graphic_extension]
+        Tempfile.new(file_config, nil, encoding: 'ascii-8bit').tap do |file|
+          begin
+            file.write Base64.decode64(contents)
+          ensure
+            file.rewind
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ups/parsers/ship_confirm_parser.rb

@@ -0,0 +1,16 @@
+module UPS
+  module Parsers
+    class ShipConfirmParser < ParserBase
+      attr_accessor :identification_number, :shipment_digest
+
+      def value(value)
+        if switch_active?(:ShipmentIdentificationNumber)
+          self.identification_number = value.as_s
+        elsif switch_active?(:ShipmentDigest)
+          self.shipment_digest = value.as_s
+        end
+        super
+      end
+    end
+  end
+end

data/lib/ups/services.rb

@@ -0,0 +1,21 @@
+module UPS
+  SERVICES = {
+    '01' => 'Next Day Air',
+    '02' => '2nd Day Air',
+    '03' => 'Ground',
+    '07' => 'Express',
+    '08' => 'Expedited',
+    '11' => 'UPS Standard',
+    '12' => '3 Day Select',
+    '13' => 'Next Day Air Saver',
+    '14' => 'Next Day Air Early AM',
+    '54' => 'Express Plus',
+    '59' => '2nd Day Air A.M.',
+    '65' => 'UPS Saver',
+    '82' => 'UPS Today Standard',
+    '83' => 'UPS Today Dedicated Courier',
+    '84' => 'UPS Today Intercity',
+    '85' => 'UPS Today Express',
+    '86' => 'UPS Today Express Saver'
+  }
+end

data/lib/ups/version.rb

@@ -0,0 +1,10 @@
+module UPS
+  module Version
+    MAJOR = 0
+    MINOR = 8
+    PATCH = 3
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+SimpleCov.start
+
+path = File.expand_path('../../', __FILE__)
+require "#{path}/lib/ups.rb"
+
+# Set default env parameters to prevent CI failing on pull requests
+ENV['UPS_LICENSE_NUMBER'] = '' unless ENV.key? 'UPS_LICENSE_NUMBER'
+ENV['UPS_USER_ID'] = '' unless ENV.key? 'UPS_USER_ID'
+ENV['UPS_PASSWORD'] = '' unless ENV.key? 'UPS_PASSWORD'
+ENV['UPS_ACCOUNT_NUMBER'] = '' unless ENV.key? 'UPS_ACCOUNT_NUMBER'
+
+require 'nokogiri'
+require 'minitest/autorun'
+
+require 'support/schema_path'
+require 'support/shipping_options'
+require 'support/xsd_validator'

data/spec/stubs/rates_negotiated_success.xml

@@ -0,0 +1,227 @@
+<?xml version="1.0"?>
+<RatingServiceSelectionResponse>
+    <Response>
+        <ResponseStatusCode>1</ResponseStatusCode>
+        <ResponseStatusDescription>Success</ResponseStatusDescription>
+    </Response>
+    <RatedShipment>
+        <Service>
+            <Code>11</Code>
+        </Service>
+        <RatedShipmentWarning>Your invoice may vary from the displayed reference rates</RatedShipmentWarning>
+        <BillingWeight>
+            <UnitOfMeasurement>
+                <Code>KGS</Code>
+            </UnitOfMeasurement>
+            <Weight>0.5</Weight>
+        </BillingWeight>
+        <TransportationCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>25.03</MonetaryValue>
+        </TransportationCharges>
+        <ServiceOptionsCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>0.00</MonetaryValue>
+        </ServiceOptionsCharges>
+        <TotalCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>25.03</MonetaryValue>
+        </TotalCharges>
+        <GuaranteedDaysToDelivery/>
+        <ScheduledDeliveryTime/>
+        <RatedPackage>
+            <TransportationCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </TransportationCharges>
+            <ServiceOptionsCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </ServiceOptionsCharges>
+            <TotalCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </TotalCharges>
+            <Weight>0.5</Weight>
+            <BillingWeight>
+                <UnitOfMeasurement>
+                    <Code/>
+                </UnitOfMeasurement>
+                <Weight/>
+            </BillingWeight>
+        </RatedPackage>
+        <NegotiatedRates>
+            <NetSummaryCharges>
+                <GrandTotal>
+                    <CurrencyCode>GBP</CurrencyCode>
+                    <MonetaryValue>24.78</MonetaryValue>
+                </GrandTotal>
+            </NetSummaryCharges>
+        </NegotiatedRates>
+    </RatedShipment>
+    <RatedShipment>
+        <Service>
+            <Code>65</Code>
+        </Service>
+        <RatedShipmentWarning>Your invoice may vary from the displayed reference rates</RatedShipmentWarning>
+        <BillingWeight>
+            <UnitOfMeasurement>
+                <Code>KGS</Code>
+            </UnitOfMeasurement>
+            <Weight>0.5</Weight>
+        </BillingWeight>
+        <TransportationCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>45.61</MonetaryValue>
+        </TransportationCharges>
+        <ServiceOptionsCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>0.00</MonetaryValue>
+        </ServiceOptionsCharges>
+        <TotalCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>45.61</MonetaryValue>
+        </TotalCharges>
+        <GuaranteedDaysToDelivery>1</GuaranteedDaysToDelivery>
+        <ScheduledDeliveryTime>12:00 Noon</ScheduledDeliveryTime>
+        <RatedPackage>
+            <TransportationCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </TransportationCharges>
+            <ServiceOptionsCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </ServiceOptionsCharges>
+            <TotalCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </TotalCharges>
+            <Weight>0.5</Weight>
+            <BillingWeight>
+                <UnitOfMeasurement>
+                    <Code/>
+                </UnitOfMeasurement>
+                <Weight/>
+            </BillingWeight>
+        </RatedPackage>
+        <NegotiatedRates>
+            <NetSummaryCharges>
+                <GrandTotal>
+                    <CurrencyCode>GBP</CurrencyCode>
+                    <MonetaryValue>45.15</MonetaryValue>
+                </GrandTotal>
+            </NetSummaryCharges>
+        </NegotiatedRates>
+    </RatedShipment>
+    <RatedShipment>
+        <Service>
+            <Code>54</Code>
+        </Service>
+        <RatedShipmentWarning>Your invoice may vary from the displayed reference rates</RatedShipmentWarning>
+        <BillingWeight>
+            <UnitOfMeasurement>
+                <Code>KGS</Code>
+            </UnitOfMeasurement>
+            <Weight>0.5</Weight>
+        </BillingWeight>
+        <TransportationCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>81.71</MonetaryValue>
+        </TransportationCharges>
+        <ServiceOptionsCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>0.00</MonetaryValue>
+        </ServiceOptionsCharges>
+        <TotalCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>81.71</MonetaryValue>
+        </TotalCharges>
+        <GuaranteedDaysToDelivery>1</GuaranteedDaysToDelivery>
+        <ScheduledDeliveryTime>9:00 A.M.</ScheduledDeliveryTime>
+        <RatedPackage>
+            <TransportationCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </TransportationCharges>
+            <ServiceOptionsCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </ServiceOptionsCharges>
+            <TotalCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </TotalCharges>
+            <Weight>0.5</Weight>
+            <BillingWeight>
+                <UnitOfMeasurement>
+                    <Code/>
+                </UnitOfMeasurement>
+                <Weight/>
+            </BillingWeight>
+        </RatedPackage>
+        <NegotiatedRates>
+            <NetSummaryCharges>
+                <GrandTotal>
+                    <CurrencyCode>GBP</CurrencyCode>
+                    <MonetaryValue>80.89</MonetaryValue>
+                </GrandTotal>
+            </NetSummaryCharges>
+        </NegotiatedRates>
+    </RatedShipment>
+    <RatedShipment>
+        <Service>
+            <Code>07</Code>
+        </Service>
+        <RatedShipmentWarning>Your invoice may vary from the displayed reference rates</RatedShipmentWarning>
+        <BillingWeight>
+            <UnitOfMeasurement>
+                <Code>KGS</Code>
+            </UnitOfMeasurement>
+            <Weight>0.5</Weight>
+        </BillingWeight>
+        <TransportationCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>47.56</MonetaryValue>
+        </TransportationCharges>
+        <ServiceOptionsCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>0.00</MonetaryValue>
+        </ServiceOptionsCharges>
+        <TotalCharges>
+            <CurrencyCode>GBP</CurrencyCode>
+            <MonetaryValue>47.56</MonetaryValue>
+        </TotalCharges>
+        <GuaranteedDaysToDelivery>1</GuaranteedDaysToDelivery>
+        <ScheduledDeliveryTime>10:30 A.M.</ScheduledDeliveryTime>
+        <RatedPackage>
+            <TransportationCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </TransportationCharges>
+            <ServiceOptionsCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </ServiceOptionsCharges>
+            <TotalCharges>
+                <CurrencyCode/>
+                <MonetaryValue/>
+            </TotalCharges>
+            <Weight>0.5</Weight>
+            <BillingWeight>
+                <UnitOfMeasurement>
+                    <Code/>
+                </UnitOfMeasurement>
+                <Weight/>
+            </BillingWeight>
+        </RatedPackage>
+        <NegotiatedRates>
+            <NetSummaryCharges>
+                <GrandTotal>
+                    <CurrencyCode>GBP</CurrencyCode>
+                    <MonetaryValue>47.08</MonetaryValue>
+                </GrandTotal>
+            </NetSummaryCharges>
+        </NegotiatedRates>
+    </RatedShipment>
+</RatingServiceSelectionResponse>