purolator-web-services 3.0.0

data/lib/purolator_web_services/version.rb

@@ -0,0 +1,3 @@
+module PurolatorWebServices
+  VERSION = "3.0.0"
+end

data/purolator-web-services.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'purolator_web_services/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "purolator-web-services"
+  spec.version       = PurolatorWebServices::VERSION
+  spec.authors       = ["Brian Abreu"]
+  spec.email         = ["brian@nuts.com"]
+  spec.description   = "Provies an interface to the Purolator web services API"
+  spec.summary       = "Interfaces with the Purolator SOAP API"
+  spec.homepage      = "https://github.com/brewski/purolator-web-services"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "soap4r-ruby1.9"
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/tasks/generate_definitions.rake

@@ -0,0 +1,21 @@
+task :generate_definitions do
+  require 'wsdl/soap/wsdl2ruby'
+
+  require 'fileutils'
+
+  module_path = File.join(%w(lib purolator_web_services soap))
+
+  Dir.glob(File.expand_path("../wsdl/*.wsdl", __FILE__)).each do |wsdl_file|
+    worker = WSDL::SOAP::WSDL2Ruby.new
+    worker.basedir = FileUtils.mkdir_p(File.join(module_path)).first
+    worker.location = File.new(wsdl_file).path
+    worker.logger.level = Logger::WARN
+    worker.opt.update(
+        "module_path"      => "PurolatorWebServices::Soap",
+        "mapping_registry" => nil,
+        "driver"           => nil,
+        "classdef"         => nil
+    )
+    worker.run
+  end
+end

data/tasks/test.rake

@@ -0,0 +1,5 @@
+namespace :purolator_web_services do
+  task :test do
+    Dir.glob(File.expand_path("../../test/*.rb", __FILE__)).each { |file| require file }
+  end
+end

data/test/integration_test.rb

@@ -0,0 +1,150 @@
+require 'minitest/autorun'
+require 'purolator_web_services'
+require 'purolator_web_services/soap'
+
+require 'date'
+require 'securerandom'
+
+class IntegrationTest < MiniTest::Unit::TestCase
+  include PurolatorWebServices::Soap
+
+  def setup
+    username, password, client_id = %w(USERNAME PASSWORD CLIENT_ID).map(&ENV.method(:[]))
+    unless (username && password && client_id)
+      $stderr.puts "missing environment variable USERNAME"  unless (username)
+      $stderr.puts "missing environment variable PASSWORD"  unless (password)
+      $stderr.puts "missing environment variable CLIENT_ID" unless (client_id)
+      exit
+    end
+
+    @credentials = CredentialInfo.new(username, password, client_id)
+    @api = PurolatorWebServices::Api.new(:test)
+  end
+
+  def test_add_order_request
+    add_order = AddOrder.new(order_request([ 10.5, 1.0 ]))
+    add_order_response = @api.addOrder(add_order)
+    assert_equal(0, add_order_response.status)
+    assert_equal(2, add_order_response.packages.size)
+  ensure
+    handle_service_exceptions
+  end
+
+  def test_closeout_request
+    add_order = AddOrder.new(order_request([ 10.0, 15.0, 12 ]))
+    add_order_response = @api.addOrder(add_order)
+    assert_equal(0, add_order_response.status)
+
+    closeout = Closeout.new(
+      CloseoutRequest.new.tap do |closeout_req|
+        closeout_req.credentials = @credentials
+        closeout_req.shipDate    = Date.today
+        closeout_req.packIDType  = "Pin"
+        closeout_req.skidCount   = 1
+        closeout_req.packageIDs  = add_order_response.packages.map(&:trackingNumber)
+      end
+    )
+    closeout_response = @api.closeout(closeout)
+    assert_equal(0, closeout_response.status)
+  ensure
+    handle_service_exceptions
+  end
+
+  def test_void_request
+    add_order_a = AddOrder.new(order_request([ 15, 12, 22, 13 ]))
+    add_order_b = AddOrder.new(order_request([ 15, 12 ]))
+
+    assert_equal(0, @api.addOrder(add_order_a).status)
+    assert_equal(0, @api.addOrder(add_order_b).status)
+
+    shipment_numbers = [ add_order_a.request.orderNumber, add_order_b.request.orderNumber ]
+    void_orders = VoidOrders.new(
+      OrderListRequest.new.tap do |order_list|
+        order_list.credentials = @credentials
+        order_list.orderNumbers = shipment_numbers
+      end
+    )
+    void_orders_response = @api.voidOrders(void_orders)
+    assert_equal(0, void_orders_response.status)
+  ensure
+    handle_service_exceptions
+  end
+
+  def test_rate_request
+    get_rates = GetRates.new(order_request([ 10.0, 15.0, 12.5 ]))
+    get_rates_response = @api.getRates(get_rates)
+    assert_equal(0, get_rates_response.status)
+  ensure
+    handle_service_exceptions
+  end
+
+  private
+    def handle_service_exceptions
+      if ($!.is_a?(PurolatorWebServices::Api::ServiceException))
+        flunk("error creating shipment: #{$!.message}")
+      end
+    end
+
+    def order_request(package_weights)
+      from_address = Address.new
+      from_address.name       = "Joe Shmoe"
+      from_address.add1       = "123 4th St."
+      from_address.city       = "San Luis Obispo"
+      from_address.stateProv  = "CA"
+      from_address.postalCode = "93401"
+      from_address.country    = "US"
+      from_address.phone      = "(123) 456 789"
+      from_address.email      = "joe@shmoe.com"
+
+      to_address = Address.new
+      to_address.name       = "Test Customer Name"
+      to_address.add1       = "560 Kings Road"
+      to_address.city       = "Sydney"
+      to_address.stateProv  = "NS"
+      to_address.postalCode = "B1S1B8"
+      to_address.country    = "CA"
+
+      packages = package_weights.map do |weight|
+        RequestPackage.new.tap do |package|
+          package.packageID    = SecureRandom.uuid
+          package.weightUOM    = "LB"
+          package.weight       = weight
+          package.dimensionUOM = "IN"
+          package.dimL         = nil
+          package.dimW         = nil
+          package.dimH         = nil
+        end
+      end
+
+      items = [
+        RequestItem.new.tap do |item|
+          item.sKU             = "SK401232"
+          item.customsDesc     = "Roasted Nuts"
+          item.quantity        = 11
+          item.totalValue      = "98.99"
+          item.currency        = "USD"
+          item.countryOfOrigin = "VN"
+          item.hSCode          = "2008199020"
+          item.nAFTAEligible   = false
+          item.fDAFood         = false
+          item.textile         = false
+        end
+      ]
+
+      request = OrderRequestV3.new
+      request.credentials     = @credentials
+      request.orderNumber     = SecureRandom.uuid
+      request.shipDate        = Date.today
+      request.shipMethod      = "Ground"
+      request.billingOption   = "Prepaid"
+      request.labelType       = "ZPL"
+      request.shipFromAddress = from_address
+      request.shipToAddress   = to_address
+      request.declaredValue   = "98.99"
+      request.currency        = "USD"
+      request.packages        = packages
+      request.items           = items
+
+      request
+    end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: purolator-web-services
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Brian Abreu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: soap4r-ruby1.9
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provies an interface to the Purolator web services API
+email:
+- brian@nuts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/purolator_web_services.rb
+- lib/purolator_web_services/api.rb
+- lib/purolator_web_services/railtie.rb
+- lib/purolator_web_services/soap.rb
+- lib/purolator_web_services/soap/default.rb
+- lib/purolator_web_services/soap/defaultDriver.rb
+- lib/purolator_web_services/soap/defaultMappingRegistry.rb
+- lib/purolator_web_services/version.rb
+- purolator-web-services.gemspec
+- tasks/generate_definitions.rake
+- tasks/test.rake
+- test/integration_test.rb
+homepage: https://github.com/brewski/purolator-web-services
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Interfaces with the Purolator SOAP API
+test_files:
+- test/integration_test.rb