ontrac-web-services 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d905aab2d396bd1cf928cde23d9ecc87f4a9df4f
-  data.tar.gz: 40e4465e6fbaaf6c4d32915bea1e855715c7e1fb
+  metadata.gz: 7a04f96cc2b90d9c64fafda24e2536cfee3f3747
+  data.tar.gz: ba124932814b75aabd5b1cd29a01574487c587e3
 SHA512:
-  metadata.gz: 4e16fff7be931b660f77c0561a3b15490b2d9d2c20912421c5954de0dd068c5fd06b4604aab2d1c230f975865fa741f6d6a48b482f391224b7f0f96a891445d8
-  data.tar.gz: 400adfdb112f80af216710749209a8d5f0580e0d11028077b73e3ea5453851d2579d552c3a921f331e686ccbe9a95987579cf8a2bc9a6d4f42394f3f970023bb
+  metadata.gz: 3b5322b4e624ce098fce7352db33647887552d622df52b3add4246c54b5173361c79817b38250d87877eb517638c299bf085cd2ab9ab72ba3f01eefb0c9133ae
+  data.tar.gz: f439b51e2591b98bc953be328689cd447a29eefd155e774fff4563cdd58ecc1b581984b12ea340f60d58482dfc12cbf26620973ed25f192d83734c23a02a3cf5

data/README.md

@@ -6,57 +6,56 @@ This gem provides an interface to the OnTrac web services API.  It interfaces wi
 ### Creating a shipment with multiple packages
 
 ```ruby
-    require 'ontrac'
+require 'ontrac'
 
-    include ::Ontrac::WebServices
-    include ::Ontrac::WebServices::Definitions
+include ::Ontrac::WebServices
+include ::Ontrac::WebServices::Definitions
 
-    credentials = Service::Credentials.new("37", "testpass", "test")
-    service = Service.new(credentials, StringIO.new(debug_output = ""))
+credentials = Service::Credentials.new("37", "testpass", "test")
+service = Service.new(credentials, StringIO.new(debug_output = ""))
 
-    requests = [ 10.1, 22, 15 ].map do |package_weight|
-      ShipmentRequest.new.tap do |request|
-        request.shipper = Shipper.new.tap do |shipper|
-          shipper.Name    = "Fulfillment Circle"
-          shipper.Addr1   = "343 Third Street\nSuite 17"
-          shipper.City    = "sparks"
-          shipper.State   = "NV"
-          shipper.Zip     = "89434"
-          shipper.Contact = "John D."
-          shipper.Phone   = "(415) 350-2608"
-        end
-        request.consignee = Consignee.new.tap do |consignee|
-          consignee.Name    = "Joe Shmoe"
-          consignee.Addr1   = "123 4th St"
-          consignee.Addr2   = "Suite 315"
-          consignee.City    = "San Luis Obispo"
-          consignee.State   = "CA"
-          consignee.Zip     = "93401"
-          consignee.Phone   = "(805) 555-1234"
-        end
-        request.Service = SERVICE_TYPE_GROUND
-        request.SignatureRequired = false
-        request.Residential = true
-        request.SaturdayDel = false
-        request.Declared = 0
-        request.Weight = package_weight
-        request.LabelType = LABEL_TYPE_PDF
-        request.ShipDate = Time.new.strftime("%Y-%m-%d")
-      end
+requests = [ 10.1, 22, 15 ].map do |package_weight|
+  ShipmentRequest.new.tap do |request|
+    request.shipper = Shipper.new.tap do |shipper|
+      shipper.Name    = "Fulfillment Circle"
+      shipper.Addr1   = "343 Third Street\nSuite 17"
+      shipper.City    = "sparks"
+      shipper.State   = "NV"
+      shipper.Zip     = "89434"
+      shipper.Contact = "John D."
+      shipper.Phone   = "(415) 350-2608"
     end
-
-    begin
-      service.post_shipments(requests).each do |(tracking_number, label, charge)|
-        puts "tracking number: #{tracking_number}"
-        File.open("#{tracking_number}.pdf", "w") { |f| f << label }
-        puts "charge: #{charge}"
-      end
-    rescue ServiceException => err
-      $stderr.puts err.message, ""
-      $stderr.puts "Debug Output:", debug_output, ""
-      $stderr.puts "Root Error:", err.root_error, ""
-      $stderr.puts "Sub Errors:", err.sub_errors, ""
-      $stderr.puts "Backtrace:", $!.backtrace
+    request.consignee = Consignee.new.tap do |consignee|
+      consignee.Name    = "Joe Shmoe"
+      consignee.Addr1   = "123 4th St"
+      consignee.Addr2   = "Suite 315"
+      consignee.City    = "San Luis Obispo"
+      consignee.State   = "CA"
+      consignee.Zip     = "93401"
+      consignee.Phone   = "(805) 555-1234"
     end
+    request.Service = SERVICE_TYPE_GROUND
+    request.SignatureRequired = false
+    request.Residential = true
+    request.SaturdayDel = false
+    request.Declared = 0
+    request.Weight = package_weight
+    request.LabelType = LABEL_TYPE_PDF
+    request.ShipDate = Time.new.strftime("%Y-%m-%d")
+  end
+end
 
+begin
+  service.post_shipments(requests).each do |(tracking_number, label, charge)|
+    puts "tracking number: #{tracking_number}"
+    File.open("#{tracking_number}.pdf", "w") { |f| f << label }
+    puts "charge: #{charge}"
+  end
+rescue ServiceException => err
+  $stderr.puts err.message, ""
+  $stderr.puts "Debug Output:", debug_output, ""
+  $stderr.puts "Root Error:", err.root_error, ""
+  $stderr.puts "Sub Errors:", err.sub_errors, ""
+  $stderr.puts "Backtrace:", $!.backtrace
+end
 ```

data/lib/ontrac/version.rb

@@ -1,3 +1,3 @@
 module Ontrac
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/lib/ontrac/web_services/service.rb

@@ -10,18 +10,9 @@ module Ontrac::WebServices
   end
 
   class Service
-    class Credentials
-      attr_reader :account, :password, :environment
-
-      def initialize(account, password, environment)
-        @account = account or
-            raise ArgumentError.new("Missing OnTrac credential: account")
-        @password = password or
-            raise ArgumentError.new("Missing OnTrac credential: account")
-        @environment = environment or
-            raise ArgumentError.new("Missing OnTrac credential: environment")
-      end
-    end
+    Credentials = Struct.new(:account, :password)
+
+    API_BASE_URL = "https://www.shipontrac.net/OnTracWebServices/OnTracServices.svc/V2"
 
     attr_accessor :debug_output
 
@@ -31,12 +22,8 @@ module Ontrac::WebServices
     end
 
     def service_url(service_name)
-      url_base = (@credentials.environment.to_sym == :production) ?
-          "https://www.shipontrac.net/OnTracWebServices/OnTracServices.svc/V2" :
-          "https://www.shipontrac.net/OnTracTestWebServices/OnTracServices.svc/V2"
-
       "%s/%s/%s?pw=%s" % [
-        url_base, @credentials.account, service_name, CGI.escape(@credentials.password)
+        API_BASE_URL, @credentials.account, service_name, CGI.escape(@credentials.password)
       ]
     end
 
@@ -120,4 +107,4 @@ module Ontrac::WebServices
         raise err
       end
   end
-end
+end

data/test/test.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'ontrac'
+
+include ::Ontrac::WebServices
+include ::Ontrac::WebServices::Definitions
+
+credentials = Service::Credentials.new(ENV.fetch("ONTRAC_ACCOUNT"), ENV.fetch("ONTRAC_PASSWORD"))
+service = Service.new(credentials, StringIO.new(debug_output = ""))
+
+requests = [ 10.1, 22, 15 ].map do |package_weight|
+  ShipmentRequest.new.tap do |request|
+    request.shipper = Shipper.new.tap do |shipper|
+      shipper.Name    = "Fulfillment Circle"
+      shipper.Addr1   = "343 Third Street\nSuite 17"
+      shipper.City    = "sparks"
+      shipper.State   = "NV"
+      shipper.Zip     = "89434"
+      shipper.Contact = "John D."
+      shipper.Phone   = "(415) 350-2608"
+    end
+    request.consignee = Consignee.new.tap do |consignee|
+      consignee.Name    = "Joe Shmoe"
+      consignee.Addr1   = "123 4th St"
+      consignee.Addr2   = "Suite 315"
+      consignee.City    = "San Luis Obispo"
+      consignee.State   = "CA"
+      consignee.Zip     = "93401"
+      consignee.Phone   = "(805) 555-1234"
+    end
+    request.Service = SERVICE_TYPE_GROUND
+    request.SignatureRequired = false
+    request.Residential = true
+    request.SaturdayDel = false
+    request.Declared = 0
+    request.Weight = package_weight
+    request.LabelType = LABEL_TYPE_PDF
+    request.ShipDate = Time.new.strftime("%Y-%m-%d")
+  end
+end
+
+logger = Logger.new($stderr)
+begin
+  service.post_shipments(requests).each do |(tracking_number, label, charge)|
+    File.open("#{tracking_number}.pdf", "w") { |f| f << label }
+    logger.info("label: ./#{tracking_number}.pdf, charge: #{charge}")
+  end
+rescue ServiceException => err
+  logger.error("OnTrac Service Exception: #{err.message}")
+  logger.error("Root Error: #{err.root_error}") if (err.root_error && !err.root_error.empty?)
+  err.sub_errors.each do |uid, sub_error|
+    logger.error("Sub Error (#{uid}): #{sub_error}")
+  end
+  raise
+ensure
+  if ($! && !debug_output.empty?)
+    logger.debug("OnTrac HTTP debug output")
+    debug_output.each_line.map(&:strip).each(&logger.method(:debug))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ontrac-web-services
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Brian Abreu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-03 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -42,6 +42,7 @@ files:
 - lib/ontrac/web_services/definitions.rb
 - lib/ontrac/web_services/service.rb
 - ontrac-web-services.gemspec
+- test/test.rb
 homepage: https://github.com/brewski/ontrac-web-services
 licenses:
 - MIT
@@ -62,9 +63,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Interfaces with the OnTrac web services API to look up shipping rates, generate
   labels, and track shipments
-test_files: []
+test_files:
+- test/test.rb