cargowise 0.9.1 → 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e45da9312970fc9b5e9bc2064954fb8f73de8c40
+  data.tar.gz: a33f052ff5bf6b6d2269053664f15cf212b7c3c6
+SHA512:
+  metadata.gz: c0b72d0a208f4f8471bc291e586c8de0f760a1cc415275e9fa99759a84242300f7cfaa3d9d238af68cb126c483834a7a63735f4e1c66e8caa9e1d046a208627b
+  data.tar.gz: 697ec43dfe011f03aec193099a6b2327d074ec1e63c634d67984b72d5b0ad6b361ef0470127999ee7f896ff6ac91fa333ada71240faa7acae54ff6aa04473bb1

data/CHANGELOG

@@ -1,3 +1,9 @@
+v0.10.0 - 20th July 2013
+* switch from handsoap to savon for SOAP calls
+  * gives me more flexibility to control the SOAP requests and HTTP request
+    parameters. Useful for dealing with IIS 7.5 and poor SSL configs on servers
+  * no external API changes to this gem
+
 v0.9.1 - 13th February 2012
 * typo
 

data/lib/cargowise.rb

@@ -7,6 +7,7 @@ require "handsoap"
 # gems
 require 'mechanize'
 require 'andand'
+require 'savon'
 
 module Cargowise
   DEFAULT_NS = "http://www.edi.com.au/EnterpriseService/"
@@ -28,3 +29,7 @@ require 'cargowise/endpoint'
 require 'cargowise/abstract_search'
 require 'cargowise/order_search'
 require 'cargowise/shipment_search'
+
+# Make savon/httpi always use Net::HTTP for HTTP requests. It supports
+# forcing the connection to TLSv1 (needed for OHL)
+HTTPI.adapter = :net_http

data/lib/cargowise/abstract_client.rb

@@ -7,44 +7,40 @@ module Cargowise
   #
   # Not much to see here, just common methods
   #
-  class AbstractClient < Handsoap::Service # :nodoc:
-    def on_create_document(doc)
-      doc.alias 'tns', Cargowise::DEFAULT_NS
-    end
-
-    def on_response_document(doc)
-      doc.add_namespace 'ns', Cargowise::DEFAULT_NS
-    end
-
-    # test authentication, returns a string with your company name
-    # if successful
-    #
-    def hello(company_code, username, pass)
-      soap_action  = 'http://www.edi.com.au/EnterpriseService/Hello'
-      soap_headers = headers(company_code, username, pass)
-      response     = invoke('tns:Hello', :soap_action => soap_action, :soap_header => soap_headers, :http_options => cw_http_options)
-      response.document.xpath("//tns:HelloResponse/tns:HelloResult/text()", {"tns" => Cargowise::DEFAULT_NS}).to_s
-    end
+  class AbstractClient
 
     private
 
-    def cw_http_options
-      if File.file?(Cargowise::CA_CERT_FILE)
-        {:trust_ca_file => Cargowise::CA_CERT_FILE}
-      else
-        {}
-      end
-    end
-
-    def headers(company_code, username, pass)
-      {
-        "tns:WebTrackerSOAPHeader" => {
-          "tns:CompanyCode" => company_code,
-          "tns:UserName"    => username,
-          "tns:Password"    => pass
+    def build_client(wsdl_path, endpoint_uri, company_code, username, password)
+      Savon.client(
+        wsdl: wsdl_path,
+        endpoint: endpoint_uri,
+
+        # Cargowise servers can be super slow to respond, this gives them time
+        # to have a smoko before responding to our queries.
+        read_timeout: 120,
+
+        # OHL uses cargowise and has a load balancer that freaks out if we use
+        # the OpenSSL 1.0.1 default of TLS1.1.
+        ssl_version: :TLSv1,
+
+        # savon 2.2.0 ignores the above ssl_version unless this is set to
+        # false. Annoying.
+        ssl_verify_mode: :none,
+
+        # turn off logging to keep me sane. Change this to true when developing
+        log: false,
+
+        # the cargowsie API requires auth details in the SOAP header of every
+        # request
+        soap_header: {
+          "tns:WebTrackerSOAPHeader" => {
+            "tns:CompanyCode" => company_code,
+            "tns:UserName" => username,
+            "tns:Password" => password
+          }
         }
-      }
+      )
     end
-
   end
 end

data/lib/cargowise/abstract_result.rb

@@ -29,7 +29,7 @@ module Cargowise
 
     def inspect
       str = "<#{self.class}: "
-      str << inspectable_vars.map { |v| "#{v.tr('@','')}: #{instance_variable_get(v)}" }.join(" ")
+      str << inspectable_vars.map { |v| "#{v.to_s.tr('@','')}: #{instance_variable_get(v)}" }.join(" ")
       str << ">"
       str
     end
@@ -41,7 +41,7 @@ module Cargowise
     end
 
     def inspectable_vars
-      instance_variables.select { |var| var != "@node"}
+      instance_variables.select { |var| var.to_s != "@node"}
     end
 
     def node_array(path)
@@ -62,6 +62,8 @@ module Cargowise
     def time_value(path)
       val = text_value(path)
       val.nil? ? nil : DateTime.parse(val)
+    rescue ArgumentError
+      return nil
     end
 
     def decimal_value(path)

data/lib/cargowise/order_search.rb

@@ -15,8 +15,7 @@ module Cargowise
           }
         }
       }
-      OrdersClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
-      OrdersClient.get_order_list(ep.code, ep.user, ep.password, filter_hash)
+      OrdersClient.new.get_order_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
     end
 
     # find all orders with a ShipmentNumber that matches ref
@@ -30,8 +29,7 @@ module Cargowise
           }
         }
       }
-      OrdersClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
-      OrdersClient.get_order_list(ep.code, ep.user, ep.password, filter_hash)
+      OrdersClient.new.get_order_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
     end
 
     # find all orders still marked as incomplete.
@@ -40,8 +38,7 @@ module Cargowise
       filter_hash = {
         "tns:Filter" => { "tns:OrderStatus" => "INC" }
         }
-      OrdersClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
-      OrdersClient.get_order_list(ep.code, ep.user, ep.password, filter_hash)
+      OrdersClient.new.get_order_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
     end
 
   end

data/lib/cargowise/orders_client.rb

@@ -5,7 +5,7 @@ module Cargowise
   # SOAP client for retreiving order data. Not much to
   # see here, used by the Order resource class.
   #
-  class OrdersClient < AbstractClient # :nodoc:
+  class OrdersClient < AbstractClient
 
     # return an array of orders. Each order *should* correspond to a buyer PO.
     #
@@ -13,13 +13,31 @@ module Cargowise
     # XML fragment specifying the search criteria. See the WSDL documentation
     # for samples
     #
-    def get_order_list(company_code, username, pass, filter_hash)
-      soap_action  = 'http://www.edi.com.au/EnterpriseService/GetOrderList'
-      soap_headers = headers(company_code, username, pass)
-      response = invoke('tns:GetOrderList', :soap_action => soap_action, :soap_header => soap_headers, :soap_body => filter_hash, :http_options => cw_http_options)
-      response.document.xpath("//tns:GetOrderListResult/tns:WebOrder", {"tns" => Cargowise::DEFAULT_NS}).map do |node|
+    def get_order_list(endpoint_uri, company_code, username, pass, filter_hash)
+      client = build_client(order_wsdl_path, endpoint_uri, company_code, username, pass)
+      response = client.call(:get_order_list, message: filter_hash)
+      response.xpath("//tns:GetOrderListResult/tns:WebOrder", {"tns" => Cargowise::DEFAULT_NS}).map do |node|
         Cargowise::Order.new(node)
       end
     end
+
+    # test authentication, returns a string with your company name
+    # if successful
+    #
+    def hello(endpoint_uri, company_code, username, pass)
+      client = build_client(order_wsdl_path, endpoint_uri, company_code, username, pass)
+      response = client.call(:hello)
+      response.xpath("//tns:HelloResponse/tns:HelloResult/text()", {"tns" => Cargowise::DEFAULT_NS}).to_s
+    end
+
+    private
+
+    def order_wsdl_path
+      File.join(
+        File.dirname(__FILE__),
+        "order_wsdl.xml"
+      )
+    end
+
   end
 end

data/lib/cargowise/shipment.rb

@@ -134,6 +134,7 @@ module Cargowise
         base_uri = tracker_login_uri(via)
         login_uri = base_uri + "/Login/Login.aspx"
         agent = Mechanize.new
+        agent.agent.http.ssl_version = :TLSv1
         if File.file?(Cargowise::CA_CERT_FILE)
           agent.agent.http.ca_file = CA_CERT_FILE
         end

data/lib/cargowise/shipment_search.rb

@@ -26,8 +26,7 @@ module Cargowise
       filter_hash = {
         "tns:Filter" => { "tns:Status" => "Undelivered" }
         }
-      ShipmentsClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
-      ShipmentsClient.get_shipments_list(ep.code, ep.user, ep.password, filter_hash)
+      ShipmentsClient.new.get_shipments_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
     end
 
     # find all shipments that had some activity in the past fourteen days. This could
@@ -43,8 +42,7 @@ module Cargowise
           }
         }
       }
-      ShipmentsClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
-      ShipmentsClient.get_shipments_list(ep.code, ep.user, ep.password, filter_hash)
+      ShipmentsClient.new.get_shipments_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
     end
 
     # find all shipments that had were shipped in the past 14 days or will ship in
@@ -60,8 +58,7 @@ module Cargowise
           }
         }
       }
-      ShipmentsClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
-      ShipmentsClient.get_shipments_list(ep.code, ep.user, ep.password, filter_hash)
+      ShipmentsClient.new.get_shipments_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
     end
 
     private
@@ -75,8 +72,7 @@ module Cargowise
           }
         }
       }
-      ShipmentsClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
-      ShipmentsClient.get_shipments_list(ep.code, ep.user, ep.password, filter_hash)
+      ShipmentsClient.new.get_shipments_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
     end
 
   end

data/lib/cargowise/shipments_client.rb

@@ -5,7 +5,7 @@ module Cargowise
   # SOAP client for retreiving shipment data. Not much to
   # see here, used by the Shipment resource class.
   #
-  class ShipmentsClient < AbstractClient # :nodoc:
+  class ShipmentsClient < AbstractClient
 
     # return an array of shipments. Each shipment should correspond to
     # a consolidated shipment from the freight company.
@@ -14,14 +14,31 @@ module Cargowise
     # XML fragment specifying the search criteria. See the WSDL documentation
     # for samples
     #
-    def get_shipments_list(company_code, username, pass, filter_hash)
-      soap_action  = 'http://www.edi.com.au/EnterpriseService/GetShipmentsList'
-      soap_headers = headers(company_code, username, pass)
-      response     = invoke('tns:GetShipmentsList', :soap_action => soap_action, :soap_header => soap_headers, :soap_body => filter_hash, :http_options => cw_http_options)
-      response.document.xpath("//tns:GetShipmentsListResult/tns:WebShipment", {"tns" => Cargowise::DEFAULT_NS}).map do |node|
+    def get_shipments_list(endpoint_uri, company_code, username, pass, filter_hash)
+      client = build_client(shipment_wsdl_path, endpoint_uri, company_code, username, pass)
+      response = client.call(:get_shipments_list, message: filter_hash)
+      response.xpath("//tns:GetShipmentsListResult/tns:WebShipment", {"tns" => Cargowise::DEFAULT_NS}).map do |node|
         Cargowise::Shipment.new(node)
       end
     end
 
+    # test authentication, returns a string with your company name
+    # if successful
+    #
+    def hello(endpoint_uri, company_code, username, pass)
+      client = build_client(shipment_wsdl_path, endpoint_uri, company_code, username, pass)
+      response = client.call(:hello)
+      response.xpath("//tns:HelloResponse/tns:HelloResult/text()", {"tns" => Cargowise::DEFAULT_NS}).to_s
+    end
+
+    private
+
+    def shipment_wsdl_path
+      File.join(
+        File.dirname(__FILE__),
+        "shipment_wsdl.xml"
+      )
+    end
+
   end
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: cargowise
 version: !ruby/object:Gem::Version
-  version: 0.9.1
-  prerelease: 
+  version: 0.10.0
 platform: ruby
 authors:
 - James Healy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-13 00:00:00.000000000 Z
+date: 2013-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: curb
-  requirement: &21137820 !ruby/object:Gem::Requirement
-    none: false
+  name: andand
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21137820
-- !ruby/object:Gem::Dependency
-  name: andand
-  requirement: &21137380 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *21137380
 - !ruby/object:Gem::Dependency
-  name: handsoap
-  requirement: &21136840 !ruby/object:Gem::Requirement
-    none: false
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.7
+        version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *21136840
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &21136320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *21136320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: mechanize
-  requirement: &21135840 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *21135840
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Retrieve tracking and status information on your shipments from entpriseEDI
 email:
 - james@yob.id.au
@@ -73,21 +73,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/cargowise.rb
+- lib/cargowise/order_search.rb
+- lib/cargowise/consol.rb
 - lib/cargowise/invoice.rb
+- lib/cargowise/order.rb
+- lib/cargowise/document.rb
 - lib/cargowise/orders_client.rb
+- lib/cargowise/abstract_client.rb
 - lib/cargowise/shipment.rb
-- lib/cargowise/order.rb
 - lib/cargowise/shipments_client.rb
-- lib/cargowise/shipment_search.rb
-- lib/cargowise/abstract_search.rb
-- lib/cargowise/abstract_client.rb
-- lib/cargowise/endpoint.rb
-- lib/cargowise/order_search.rb
 - lib/cargowise/packing.rb
-- lib/cargowise/document.rb
+- lib/cargowise/abstract_search.rb
 - lib/cargowise/abstract_result.rb
-- lib/cargowise/consol.rb
-- lib/cargowise.rb
+- lib/cargowise/endpoint.rb
+- lib/cargowise/shipment_search.rb
 - README.markdown
 - CHANGELOG
 - TODO
@@ -96,6 +96,7 @@ files:
 homepage: http://github.com/yob/cargowise
 licenses:
 - mit
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --title
@@ -104,21 +105,19 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Wrapper around entpriseEDI SOAP API by cargowise
 test_files: []