ontrac-web-services 0.9.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ontrac-web-services.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Brian Abreu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# ontrac-web-services
+## Description
+This gem provides an interface to the OnTrac web services API.  It interfaces with its HTTP/POST API to generate labels (looking up shipping rates and tracking coming soon).
+
+## Examples
+### Creating a shipment with multiple packages
+
+```ruby
+  require 'ontrac'
+
+  include ::Ontrac::WebServices
+  include ::Ontrac::WebServices::Definitions
+
+  credentials = Service::Credentials.new("ACCOUNT #", "PASSWORD", "production")
+  service = Service.new(credentials)
+
+  shipper = ShipperData.new
+  shipper.name    = "Fulfillment Circle"
+  shipper.address = "343 third street"
+  shipper.suite   = "suite 17"
+  shipper.city    = "sparks"
+  shipper.state   = "nv"
+  shipper.zip     = "89434"
+  shipper.phone   = "(415) 350-2608"
+
+  recipient = DeliveryData.new
+  recipient.name     = "Joe Shmoe"
+  recipient.address  = "123 4th St"
+  recipient.address2 = "Suite 315"
+  recipient.city     = "San Luis Obispo"
+  recipient.state    = "CA"
+  recipient.zip      = "93401"
+  recipient.phone    = "(805) 555-1234"
+
+  responses = service.request_shipment(SERVICE_TYPE_GROUND, shipper, recipient, LABEL_TYPE_PDF,
+      [ 22.0, 15, 10 ]) do |package_data, package_num|
+
+    package_data.package_detail.residential = false
+    package_data.package_detail.reference = "order #1234"
+  end
+
+  tracking_numbers = responses.map do |(tracking_number, label, charge)|
+    puts "tracking number: #{tracking_number}"
+    puts "charge: #{charge.to_f}"
+    File.open("#{tracking_number}.pdf", "w") { |f| f << label }
+    tracking_number
+  end
+```

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/ontrac.rb

@@ -0,0 +1,2 @@
+require "ontrac/version"
+require "ontrac/web_services.rb"

data/lib/ontrac/version.rb

@@ -0,0 +1,3 @@
+module Ontrac
+  VERSION = "0.9.0"
+end

data/lib/ontrac/web_services.rb

@@ -0,0 +1,5 @@
+module Ontrac::WebServices
+end
+
+require 'ontrac/web_services/definitions'
+require 'ontrac/web_services/service'

data/lib/ontrac/web_services/definitions.rb

@@ -0,0 +1,24 @@
+module Ontrac::WebServices
+  module Definitions
+    SERVICE_TYPE_SUNRISE = 'S'
+    SERVICE_TYPE_GOLD    = 'G'
+    SERVICE_TYPE_GROUND  = 'C'
+    SERVICE_TYPE_FREIGHT = 'H'
+
+    LABEL_TYPE_PDF     = 1
+    LABEL_TYPE_JPG     = 2
+    LABEL_TYPE_BMP     = 3
+    LABEL_TYPE_GIF     = 4
+    LABEL_TYPE_EPL_4X3 = 5
+    LABEL_TYPE_EPL_4X5 = 6
+    LABEL_TYPE_ZPL_4X5 = 7
+  end
+end
+
+require 'ontrac/web_services/definitions/base'
+require 'ontrac/web_services/definitions/delivery_data'
+require 'ontrac/web_services/definitions/package'
+require 'ontrac/web_services/definitions/package_data'
+require 'ontrac/web_services/definitions/package_detail'
+require 'ontrac/web_services/definitions/shipment_request'
+require 'ontrac/web_services/definitions/shipper_data'

data/lib/ontrac/web_services/definitions/base.rb

@@ -0,0 +1,43 @@
+require 'active_support'
+require 'nokogiri'
+
+module Ontrac::WebServices::Definitions
+  class Base
+    include Nokogiri
+
+    def self.attr_accessor(*args)
+      (@attributes ||= []).concat(args)
+      super
+    end
+
+    def self.attributes
+      return (@attributes ||= [])
+    end
+
+    def self.basename
+      ActiveSupport::Inflector.camelize(self.name.gsub(/^.*::/, ''))
+    end
+
+    def to_xml
+      xml_builder = Nokogiri::XML::Builder.new
+
+      xml_builder.send(self.class.basename) do |xml|
+        self.class.attributes.each do |attribute_name|
+          (values = *self.send(attribute_name)).each do |attribute_value|
+            xml_attr_name = respond_to?("#{attribute_name}_to_xml_name") ?
+                send("#{attribute_name}_to_xml_name") :
+                ActiveSupport::Inflector.camelize(attribute_name, false)
+
+            if (attribute_value.is_a?(Base))
+              xml.doc.root << attribute_value.to_xml
+            else
+              xml.send(xml_attr_name, attribute_value)
+            end
+          end
+        end
+      end
+
+      xml_builder.doc.root
+    end
+  end
+end

data/lib/ontrac/web_services/definitions/delivery_data.rb

@@ -0,0 +1,32 @@
+module Ontrac
+  module WebServices
+    module Definitions
+      class DeliveryData < Base
+        attr_accessor :name
+        attr_accessor :address
+        attr_accessor :address2
+        attr_accessor :address3
+        attr_accessor :city
+        attr_accessor :state
+        attr_accessor :zip
+        attr_accessor :phone
+        attr_accessor :contact
+      end
+    end
+  end
+end
+
+# [ DeliveryData, Package, PackageData, PackageDetail, ShipmentRequest, ShipperData ].map do |cls|
+#   accessors = cls.attributes.map { |a| "        attr_accessor :#{a.to_s.underscore}" }
+# <<-CLSDEF
+# module Ontrac
+#   module WebServices
+#     module Definitions
+#       class #{cls.name.split("::").last} < Base
+# #{accessors * "\n"}
+#       end
+#     end
+#   end
+# end
+# CLSDEF
+# end

data/lib/ontrac/web_services/definitions/package.rb

@@ -0,0 +1,9 @@
+module Ontrac
+  module WebServices
+    module Definitions
+      class Package < Base
+        attr_accessor :package_data
+      end
+    end
+  end
+end

data/lib/ontrac/web_services/definitions/package_data.rb

@@ -0,0 +1,16 @@
+module Ontrac
+  module WebServices
+    module Definitions
+      class PackageData < Base
+        attr_accessor :uid
+        attr_accessor :shipper_data
+        attr_accessor :delivery_data
+        attr_accessor :package_detail
+
+        def uid_to_xml_name
+          "UID"
+        end
+      end
+    end
+  end
+end

data/lib/ontrac/web_services/definitions/package_detail.rb

@@ -0,0 +1,29 @@
+module Ontrac
+  module WebServices
+    module Definitions
+      class PackageDetail < Base
+        attr_accessor :ship_date
+        attr_accessor :reference
+        attr_accessor :tracking
+        attr_accessor :service
+        attr_accessor :declared
+        attr_accessor :cod
+        attr_accessor :cod_type
+        attr_accessor :saturday_delivery
+        attr_accessor :signature_rqd
+        attr_accessor :type
+        attr_accessor :weight
+        attr_accessor :bill_to
+        attr_accessor :instructions
+        attr_accessor :ship_email
+        attr_accessor :del_email
+        attr_accessor :label_type
+        attr_accessor :residential
+
+        def cod_type_to_xml_name
+          "cod_Type"
+        end
+      end
+    end
+  end
+end

data/lib/ontrac/web_services/definitions/shipment_request.rb

@@ -0,0 +1,16 @@
+module Ontrac
+  module WebServices
+    module Definitions
+      class ShipmentRequest < Base
+        attr_accessor :account
+        attr_accessor :password
+        attr_accessor :request_reference
+        attr_accessor :packages
+
+        def self.basename
+          "OntracShipmentRequest"
+        end
+      end
+    end
+  end
+end

data/lib/ontrac/web_services/definitions/shipper_data.rb

@@ -0,0 +1,16 @@
+module Ontrac
+  module WebServices
+    module Definitions
+      class ShipperData < Base
+        attr_accessor :name
+        attr_accessor :address
+        attr_accessor :suite
+        attr_accessor :city
+        attr_accessor :state
+        attr_accessor :zip
+        attr_accessor :phone
+        attr_accessor :contact
+      end
+    end
+  end
+end

data/lib/ontrac/web_services/service.rb

@@ -0,0 +1,118 @@
+require 'net/https'
+require 'nokogiri'
+require 'base64'
+
+module Ontrac::WebServices
+  class ServiceException < RuntimeError
+    attr_accessor :details
+  end
+
+  class Service
+    Credentials = Struct.new(:account, :password, :environment)
+
+    def initialize(credentials)
+      @credentials = credentials
+    end
+
+    def service_url(request_name)
+      (@credentials.environment.to_sym == :production) ?
+          "https://www.shipontrac.net/OnTracAPI/#{request_name}.ashx" :
+          "https://www.shipontrac.net/OnTracAPItest/#{request_name}.ashx"
+    end
+
+    def request_shipment(service, shipper_data, delivery_data,
+        label_type, package_weights, &process_contents)
+
+      label_base64_encoded =
+          label_type != Definitions::LABEL_TYPE_EPL_4X3 &&
+          label_type != Definitions::LABEL_TYPE_EPL_4X5
+
+      request = Definitions::ShipmentRequest.new
+      request.account = @credentials.account
+      request.password = @credentials.password
+
+      request.packages = package_weights.map.with_index do |weight, ndx|
+        Definitions::Package.new.tap do |package|
+          package.package_data = Definitions::PackageData.new.tap do |data|
+            data.shipper_data = shipper_data
+            data.delivery_data = delivery_data
+
+            data.package_detail = Definitions::PackageDetail.new.tap do |detail|
+              detail.service = service
+              detail.weight = weight
+              detail.ship_email = ""
+              detail.del_email = ""
+              detail.label_type = label_type
+            end
+          end
+
+          process_contents.call(package.package_data, ndx) if (process_contents)
+        end
+      end
+
+      package_data_path = "/OnTracShipmentResponse/Package/PackageData"
+      num_packages = package_weights.size
+
+      request_xml = Nokogiri::XML::Document.new
+      request_xml << request.to_xml
+
+      issue_request("ShipmentRequest", request_xml) do |response_xml|
+        %w(Label Tracking Charges/TotalCharge).each do |node_name|
+          count = response_xml.xpath("count(#{package_data_path}/#{node_name})")
+          if (response_xml.xpath("count(#{package_data_path}/#{node_name})") != num_packages)
+            raise "Expected #{num_packages} #{node_name} response(s), received #{count}"
+          end
+        end
+
+        response_xml.xpath("/OnTracShipmentResponse/Package/PackageData").map do |xml|
+          label_img = xml.xpath("Label").text
+          label_img = Base64.decode64(label_img) if (label_base64_encoded)
+
+          [
+            xml.xpath("Tracking").text,
+            label_img,
+            Float(xml.xpath("Charges/TotalCharge").text),
+            xml
+          ]
+        end
+      end
+    end
+
+    private
+      def issue_request(request_type, request_xml, &process_response)
+        uri = URI.parse(service_url(request_type))
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+
+        response = http.request_post(uri.request_uri, request_xml.to_s)
+        response_xml = Nokogiri::XML(response.body)
+
+        check_response(response_xml)
+        process_response.call(response_xml)
+      rescue Timeout::Error, SocketError => root_exception
+        err = ServiceException.new("Network communication error")
+        err.set_backtrace([ "#{__FILE__}:#{__LINE__ + 1}", *root_exception.backtrace ])
+        raise err
+      rescue Exception => root_exception
+        err = ServiceException.new(root_exception.message)
+        err.details = { request: request_xml, response: response_xml }
+        err.set_backtrace([ "#{__FILE__}:#{__LINE__ + 1}", *root_exception.backtrace ])
+        raise err
+      end
+
+      def check_response(response_xml)
+        status = response_xml.xpath("/OnTracShipmentResponse/Status").text
+        message = response_xml.xpath("/OnTracShipmentResponse/Message").text
+        package_messages = response_xml.xpath("//PackageData/Message")
+
+        if (status.empty? || status != "1" || response_xml.xpath("//PackageData/Status != 1"))
+          msg = "No status information was returned for the request"    if (status.empty?)
+          msg = message || "The request returned a status of #{status}" if (status != "1")
+
+          msg << " -- " + [ *package_messages.to_a ] * " ; " if (!package_messages.empty?)
+
+          raise msg
+        end
+      end
+  end
+end

data/ontrac-web-services.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ontrac/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brian Abreu"]
+  gem.email         = ["brian@nuts.com"]
+  gem.description   = %q{Provies an interface to the OnTrac web services API}
+  gem.summary       = %q{Interfaces with the OnTrac web services API to look up shipping rates, generate labels, and track shipments}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ontrac-web-services"
+  gem.require_paths = ["lib"]
+  gem.version       = Ontrac::VERSION
+
+  gem.required_ruby_version = '>= 1.9.0'
+  gem.add_dependency("activesupport")
+  gem.add_dependency("nokogiri")
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: ontrac-web-services
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Brian Abreu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provies an interface to the OnTrac web services API
+email:
+- brian@nuts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ontrac.rb
+- lib/ontrac/version.rb
+- lib/ontrac/web_services.rb
+- lib/ontrac/web_services/definitions.rb
+- lib/ontrac/web_services/definitions/base.rb
+- lib/ontrac/web_services/definitions/delivery_data.rb
+- lib/ontrac/web_services/definitions/package.rb
+- lib/ontrac/web_services/definitions/package_data.rb
+- lib/ontrac/web_services/definitions/package_detail.rb
+- lib/ontrac/web_services/definitions/shipment_request.rb
+- lib/ontrac/web_services/definitions/shipper_data.rb
+- lib/ontrac/web_services/service.rb
+- ontrac-web-services.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Interfaces with the OnTrac web services API to look up shipping rates, generate
+  labels, and track shipments
+test_files: []