ups-ruby 0.8.3

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+  - ruby-head
+cache: bundler
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+  gem 'rake'
+  gem 'minitest'
+  gem 'nokogiri'
+end

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    ups-ruby (0.8.3)
+      excon (~> 0.45, >= 0.45.3)
+      insensitive_hash (~> 0.3.3)
+      levenshtein-ffi (~> 1.1)
+      ox (~> 2.2, >= 2.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    codeclimate-test-reporter (1.0.5)
+      simplecov
+    docile (1.1.5)
+    excon (0.54.0)
+    ffi (1.9.14)
+    insensitive_hash (0.3.3)
+    json (1.8.3)
+    levenshtein-ffi (1.1.0)
+      ffi (~> 1.9)
+    mini_portile (0.6.2)
+    minitest (5.7.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    ox (2.4.9)
+    rake (12.0.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter (~> 1.0.0)
+  minitest
+  nokogiri
+  rake
+  simplecov
+  ups-ruby!
+
+BUNDLED WITH
+   1.13.6

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (c) 2017 Paul Trippett and Veeqo Ltd
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,78 @@
+[![Gem Version](https://img.shields.io/gem/v/ups.svg?style=flat-square)](http://badge.fury.io/rb/ups)
+[![Dependency Status](https://img.shields.io/gemnasium/ptrippett/ups.svg?style=flat-square)](https://gemnasium.com/ptrippett/ups)
+[![Build Status](https://img.shields.io/travis/ptrippett/ups.svg?style=flat-square)](https://travis-ci.org/ptrippett/ups)
+[![Coverage Status](https://img.shields.io/codeclimate/coverage/github/ptrippett/ups.svg?style=flat-square)](https://codeclimate.com/github/ptrippett/ups/coverage)
+[![Code Climate](https://img.shields.io/codeclimate/github/ptrippett/ups.svg?style=flat-square)](https://codeclimate.com/github/ptrippett/ups)
+
+# UPS
+
+UPS Gem for accessing the UPS API from Ruby. Using the gem you can:
+  - Return quotes from the UPS API
+  - Book shipments
+  - Return labels and tracking numbers for a shipment
+
+This gem is currently used in production at [Veeqo](http://www.veeqo.com)
+
+## Installation
+
+    gem install ups-ruby
+
+...or add it to your project's [Gemfile](http://bundler.io/).
+
+## Documentation
+
+Yard documentation can be found at [RubyDoc](http://www.rubydoc.info/github/ptrippett/ups).
+
+## Sample Usage
+
+### Return rates
+
+```ruby
+require 'ups'
+server = UPS::Connection.new(test_mode: true)
+response = server.rates do |rate_builder|
+  rate_builder.add_access_request 'API_KEY', 'USERNAME', 'PASSWORD'
+  rate_builder.add_shipper company_name: 'Veeqo Limited',
+    phone_number: '01792 123456',
+    address_line_1: '11 Wind Street',
+    city: 'Swansea',
+    state: 'Wales',
+    postal_code: 'SA1 1DA',
+    country: 'GB',
+    shipper_number: 'ACCOUNT_NUMBER'
+  rate_builder.add_ship_from company_name: 'Veeqo Limited',
+    phone_number: '01792 123456',
+    address_line_1: '11 Wind Street',
+    city: 'Swansea',
+    state: 'Wales',
+    postal_code: 'SA1 1DA',
+    country: 'GB',
+    shipper_number: ENV['UPS_ACCOUNT_NUMBER']
+  rate_builder.add_ship_to company_name: 'Google Inc.',
+    phone_number: '0207 031 3000',
+    address_line_1: '1 St Giles High Street',
+    city: 'London',
+    state: 'England',
+    postal_code: 'WC2H 8AG',
+    country: 'GB'
+  rate_builder.add_package weight: '0.5',
+    unit: 'KGS'
+end
+```
+
+```ruby
+# Then use...
+response.success?
+response.graphic_image
+response.tracking_number
+```
+
+## Running the tests
+
+After installing dependencies with `bundle install`, you can run the unit tests using `rake`.
+
+## Contributers
+
+Thanks to the following contributers to this project.
+
+  - [CJ](https://github.com/chirag7jain) - Method to generate labels in available other formats [EPL, ZPL], Constant for packaging type.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs.push 'spec'
+end
+
+task default: :test
+
+task :console do
+  exec 'irb -r ups -I ./lib'
+end

data/lib/ups-ruby.rb

@@ -0,0 +1,2 @@
+# This file is automatically loaded by Bundler
+require 'ups'

data/lib/ups.rb

@@ -0,0 +1,33 @@
+module UPS
+  autoload :SERVICES,              'ups/services'
+  autoload :PACKAGING,             'ups/packaging'
+
+  autoload :Version,               'ups/version'
+  autoload :Connection,            'ups/connection'
+  autoload :Exceptions,            'ups/exceptions'
+
+  autoload :Data,                  'ups/data'
+  module Data
+    autoload :US_STATES,           'ups/data/us_states'
+    autoload :CANADIAN_STATES,     'ups/data/canadian_states'
+    autoload :IE_COUNTIES,         'ups/data/ie_counties'
+    autoload :IE_COUNTY_PREFIXES,  'ups/data/ie_county_prefixes'
+  end
+
+  module Parsers
+    autoload :ParserBase,          'ups/parsers/parser_base'
+    autoload :RatesParser,         'ups/parsers/rates_parser'
+    autoload :ShipConfirmParser,   'ups/parsers/ship_confirm_parser'
+    autoload :ShipAcceptParser,    'ups/parsers/ship_accept_parser'
+  end
+
+  module Builders
+    autoload :BuilderBase,         'ups/builders/builder_base'
+    autoload :RateBuilder,         'ups/builders/rate_builder'
+    autoload :AddressBuilder,      'ups/builders/address_builder'
+    autoload :ShipConfirmBuilder,  'ups/builders/ship_confirm_builder'
+    autoload :ShipAcceptBuilder,   'ups/builders/ship_accept_builder'
+    autoload :OrganisationBuilder, 'ups/builders/organisation_builder'
+    autoload :ShipperBuilder,      'ups/builders/shipper_builder'
+  end
+end

data/lib/ups/builders/address_builder.rb

@@ -0,0 +1,135 @@
+require 'ox'
+
+module UPS
+  module Builders
+    # The {AddressBuilder} class builds UPS XML Address Objects.
+    #
+    # @author Paul Trippett
+    # @since 0.1.0
+    # @attr [Hash] opts The Address Parts
+    class AddressBuilder < BuilderBase
+      include Ox
+
+      attr_accessor :opts
+
+      # Initializes a new {AddressBuilder} object
+      #
+      # @param [Hash] opts The Address Parts
+      # @option opts [String] :address_line_1 Address Line 1
+      # @option opts [String] :city City
+      # @option opts [String] :state State
+      # @option opts [String] :postal_code Zip or Postal Code
+      # @option opts [String] :country Country
+      # @raise [InvalidAttributeError] If the passed :state is nil or an
+      #   empty string and the :country is IE
+      def initialize(opts = {})
+        self.opts = opts
+        validate
+      end
+
+      # Changes :state part of the address based on UPS requirements
+      #
+      # @raise [InvalidAttributeError] If the passed :state is nil or an
+      #   empty string and the :country is IE
+      # @return [void]
+      def validate
+        opts[:state] = case opts[:country].downcase
+                       when 'us'
+                         normalize_us_state(opts[:state])
+                       when 'ca'
+                         normalize_ca_state(opts[:state])
+                       when 'ie'
+                         UPS::Data.ie_state_matcher(opts[:state])
+                       else
+                         ''
+                       end
+      end
+
+      # Changes :state based on UPS requirements for US Addresses
+      #
+      # @param [String] state The US State to normalize
+      # @return [String]
+      def normalize_us_state(state)
+        if state.to_str.length > 2
+          UPS::Data::US_STATES[state] || state
+        else
+          state.upcase
+        end
+      end
+
+      # Changes :state based on UPS requirements for CA Addresses
+      #
+      # @param [String] state The CA State to normalize
+      # @return [String]
+      def normalize_ca_state(state)
+        if state.to_str.length > 2
+          UPS::Data::CANADIAN_STATES[state] || state
+        else
+          state.upcase
+        end
+      end
+
+      # Returns an XML representation of address_line_1
+      #
+      # @return [Ox::Element] XML representation of address_line_1 address part
+      def address_line_1
+        element_with_value('AddressLine1', opts[:address_line_1][0..34])
+      end
+
+      # Returns an XML representation of address_line_2
+      #
+      # @return [Ox::Element] XML representation of address_line_2 address part
+      def address_line_2
+        data = (opts.key? :address_line_2) ? opts[:address_line_2][0..34] : ''
+        element_with_value('AddressLine2', data)
+      end
+
+      # Returns an XML representation of city
+      #
+      # @return [Ox::Element] XML representation of the city address part
+      def city
+        element_with_value('City', opts[:city][0..29])
+      end
+
+      # Returns an XML representation of state
+      #
+      # @return [Ox::Element] XML representation of the state address part
+      def state
+        element_with_value('StateProvinceCode', opts[:state])
+      end
+
+      # Returns an XML representation of postal_code
+      #
+      # @return [Ox::Element] XML representation of the postal_code address part
+      def postal_code
+        element_with_value('PostalCode', opts[:postal_code][0..9])
+      end
+
+      # Returns an XML representation of country
+      #
+      # @return [Ox::Element] XML representation of the country address part
+      def country
+        element_with_value('CountryCode', opts[:country][0..1])
+      end
+
+      def email_address
+        element_with_value('EmailAddress', opts[:email_address][0..49])
+      end
+
+      # Returns an XML representation of a UPS Address
+      #
+      # @return [Ox::Element] XML representation of the current object
+      def to_xml
+        Element.new('Address').tap do |address|
+          address << address_line_1
+          address << address_line_2
+          address << email_address if opts[:email_address]
+          address << city
+          address << state
+          address << postal_code
+          address << country
+        end
+      end
+    end
+  end
+end

data/lib/ups/builders/builder_base.rb

@@ -0,0 +1,216 @@
+require 'ox'
+
+module UPS
+  module Builders
+    # The {BuilderBase} class builds UPS XML Address Objects.
+    #
+    # @author Paul Trippett
+    # @since 0.1.0
+    # @abstract
+    # @attr [Ox::Document] document The XML Document being built
+    # @attr [Ox::Element] root The XML Root
+    # @attr [Ox::Element] shipment_root The XML Shipment Element
+    # @attr [Ox::Element] access_request The XML AccessRequest Element
+    # @attr [String] license_number The UPS API Key
+    # @attr [String] user_id The UPS Username
+    # @attr [String] password The UPS Password
+    class BuilderBase
+      include Ox
+      include Exceptions
+
+      attr_accessor :document,
+                    :root,
+                    :shipment_root,
+                    :access_request,
+                    :license_number,
+                    :user_id,
+                    :password
+
+      # Initializes a new {BuilderBase} object
+      #
+      # @param [String] root_name The Name of the XML Root
+      # @return [void]
+      def initialize(root_name)
+        initialize_xml_roots root_name
+
+        document << access_request
+        document << root
+
+        yield self if block_given?
+      end
+
+      # Initializes a new {BuilderBase} object
+      #
+      # @param [String] license_number The UPS API Key
+      # @param [String] user_id The UPS Username
+      # @param [String] password The UPS Password
+      # @return [void]
+      def add_access_request(license_number, user_id, password)
+        self.license_number = license_number
+        self.user_id = user_id
+        self.password = password
+
+        access_request << element_with_value('AccessLicenseNumber',
+                                             license_number)
+        access_request << element_with_value('UserId', user_id)
+        access_request << element_with_value('Password', password)
+      end
+
+      # Adds a Request section to the XML document being built
+      #
+      # @param [String] action The UPS API Action requested
+      # @param [String] option The UPS API Option
+      # @return [void]
+      def add_request(action, option)
+        root << Element.new('Request').tap do |request|
+          request << element_with_value('RequestAction', action)
+          request << element_with_value('RequestOption', option)
+        end
+      end
+
+      # Adds a Shipper section to the XML document being built
+      #
+      # @param [Hash] opts A Hash of data to build the requested section
+      # @option opts [String] :company_name Company Name
+      # @option opts [String] :phone_number Phone Number
+      # @option opts [String] :address_line_1 Address Line 1
+      # @option opts [String] :city City
+      # @option opts [String] :state State
+      # @option opts [String] :postal_code Zip or Postal Code
+      # @option opts [String] :country Country
+      # @option opts [String] :shipper_number UPS Account Number
+      # @return [void]
+      def add_shipper(opts = {})
+        shipment_root << ShipperBuilder.new(opts).to_xml
+      end
+
+      # Adds a ShipTo section to the XML document being built
+      #
+      # @param [Hash] opts A Hash of data to build the requested section
+      # @option opts [String] :company_name Company Name
+      # @option opts [String] :phone_number Phone Number
+      # @option opts [String] :address_line_1 Address Line 1
+      # @option opts [String] :city City
+      # @option opts [String] :state State
+      # @option opts [String] :postal_code Zip or Postal Code
+      # @option opts [String] :country Country
+      # @return [void]
+      def add_ship_to(opts = {})
+        shipment_root << OrganisationBuilder.new('ShipTo', opts).to_xml
+      end
+
+      # Adds a ShipFrom section to the XML document being built
+      #
+      # @param [Hash] opts A Hash of data to build the requested section
+      # @option opts [String] :company_name Company Name
+      # @option opts [String] :phone_number Phone Number
+      # @option opts [String] :address_line_1 Address Line 1
+      # @option opts [String] :city City
+      # @option opts [String] :state State
+      # @option opts [String] :postal_code Zip or Postal Code
+      # @option opts [String] :country Country
+      # @option opts [String] :shipper_number UPS Account Number
+      # @return [void]
+      def add_ship_from(opts = {})
+        shipment_root << OrganisationBuilder.new('ShipFrom', opts).to_xml
+      end
+
+      # Adds a Package section to the XML document being built
+      #
+      # @param [Hash] opts A Hash of data to build the requested section
+      # @return [void]
+      def add_package(opts = {})
+        shipment_root << Element.new('Package').tap do |org|
+          org << packaging_type
+          org << element_with_value('Description', 'Rate')
+          org << package_weight(opts[:weight], opts[:unit])
+          org << package_dimensions(opts[:dimensions]) if opts[:dimensions]
+        end
+      end
+
+      # Adds a PaymentInformation section to the XML document being built
+      #
+      # @param [String] ship_number The UPS Shipper Number
+      # @return [void]
+      def add_payment_information(ship_number)
+        shipment_root << Element.new('PaymentInformation').tap do |payment|
+          payment << Element.new('Prepaid').tap do |prepaid|
+            prepaid << Element.new('BillShipper').tap do |bill_shipper|
+              bill_shipper << element_with_value('AccountNumber', ship_number)
+            end
+          end
+        end
+      end
+
+      # Adds a RateInformation/NegotiatedRatesIndicator section to the XML
+      # document being built
+      #
+      # @return [void]
+      def add_rate_information
+        shipment_root << Element.new('RateInformation').tap do |rate_info|
+          rate_info << element_with_value('NegotiatedRatesIndicator', '1')
+        end
+      end
+
+      # Returns a String representation of the XML document being built
+      #
+      # @return [String]
+      def to_xml
+        Ox.to_xml document
+      end
+
+      private
+
+      def initialize_xml_roots(root_name)
+        self.document = Document.new
+        self.root = Element.new(root_name)
+        self.shipment_root = Element.new('Shipment')
+        self.access_request = Element.new('AccessRequest')
+        root << shipment_root
+      end
+
+      def packaging_type
+        code_description 'PackagingType', '02', 'Customer Supplied'
+      end
+
+      def package_weight(weight, unit)
+        Element.new('PackageWeight').tap do |org|
+          org << unit_of_measurement(unit)
+          org << element_with_value('Weight', weight)
+        end
+      end
+
+      def package_dimensions(dimensions)
+        Element.new('Dimensions').tap do |org|
+          org << unit_of_measurement(dimensions[:unit])
+          org << element_with_value('Length', dimensions[:length].to_s[0..8])
+          org << element_with_value('Width', dimensions[:width].to_s[0..8])
+          org << element_with_value('Height', dimensions[:height].to_s[0..8])
+        end
+      end
+
+      def unit_of_measurement(unit)
+        Element.new('UnitOfMeasurement').tap do |org|
+          org << element_with_value('Code', unit.to_s)
+        end
+      end
+
+      def element_with_value(name, value)
+        fail InvalidAttributeError, name unless value.respond_to?(:to_str)
+        Element.new(name).tap do |request_action|
+          request_action << value.to_str
+        end
+      end
+
+      def code_description(name, code, description)
+        multi_valued(name, Code: code, Description: description)
+      end
+
+      def multi_valued(name, params)
+        Element.new(name).tap do |e|
+          params.each { |key, value| e << element_with_value(key, value) }
+        end
+      end
+    end
+  end
+end