cargowise 0.10.2 → 1.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c54964f5b53064306aafb7282ced14bd5ff19944
-  data.tar.gz: 07236921a7be196347a2a813b3ffd57fee952072
+  metadata.gz: 9817101a99e84ae1fdf68b2a1389e83a94298fb1
+  data.tar.gz: 0264a94a2cd8b1ed3d142d4829478343ed0ea37b
 SHA512:
-  metadata.gz: 0c2216ba6c46414161f597227fb3afb2277feb3da5c34ccfce12743f8c1f4a52ee1778b7394c6f50775b35633a7d69180c93bd58a3e95bf5bb03b8dd01d6a191
-  data.tar.gz: 9d192732f6b05ea510b7aaa1e60b30e57e78a3786201868f7ec14c27e9672c27ea12dededdf10051cb46324c677ce8655d8dd626c0bc5396262bb71ef65a6e46
+  metadata.gz: 6881b0677e349919f63fc6bcfaa96b451950b83c6a7930c6027d645078efa99f11d0193cb28e7817bfe22a4c022d0b14691eb14b97ae144ab16ca3690d559469
+  data.tar.gz: 79d5fe26d024a84cbcad27d6dccf0d06f403df8925c5edad34262879fdf2e244eb341f8ce50c47f8ab4dc6bfdbccaef6544316f66b639b84064e1157e5840ed6

data/CHANGELOG

@@ -1,3 +1,6 @@
+v1.0.0.alpha - 21st July 2013
+* new, simpler API
+
 v0.10.2 - 20th July 2013
 * increase the read timeout to allow for slow servers
 

data/README.markdown

@@ -27,21 +27,17 @@ either or both.
 Each company using the cargowise product hosts the server themselves, so you will
 need to register the URI and authentication details for the company you want to use.
 
-    Cargowise::Order.register(:ijs, :uri  => "http://visibility.ijsglobal.com/Tracker/WebService/OrderService.asmx",
-                                    :code => "company_code",
-                                    :user => "user@example.com",
-                                    :password => "secret")
-
-    Cargowise::Shipment.register(:ijs, :uri  => "http://visibility.ijsglobal.com/Tracker/WebService/ShipmentService.asmx",
-                                       :code => "company_code",
-                                       :user => "user@example.com",
-                                       :password => "secret")
+    client = Cargowise::Client.new(:order_uri => "http://visibility.ijsglobal.com/Tracker/WebService/OrderService.asmx",
+                                   :shipment_uri => "http://visibility.ijsglobal.com/Tracker/WebService/ShipmentService.asmx",
+                                   :company_code => "company_code",
+                                   :username => "user@example.com",
+                                   :password => "secret")
 
 In a rails app the registration should be done in a file like
 config/initializers/cargowise.rb.
 
-If you deal with multiple companies running cargowise you can register each using
-different identifiers.
+If you deal with multiple companies running cargowise you should create a client
+instance per company.
 
 See the Finding API Endpoints section below for tips on finding the correct URI
 to register.
@@ -55,11 +51,11 @@ the order.
 
 To find all orders with a certain order number:
 
-    Cargowise::Order.via(:ijs).by_order_number("123456")
+    client.orders.by_order_number("123456")
 
 To find all incomplete orders:
 
-    Cargowise::Order.via(:ijs).incomplete
+    client.orders.incomplete
 
 Cargowise::Shipment represents something being sent to you - like a carton,
 palet or truck load. It might be transported via air, sea, road or a combination.
@@ -67,15 +63,15 @@ palet or truck load. It might be transported via air, sea, road or a combination
 To find shipments by the shipment number (a reference number selected by your logistics
 company):
 
-    Cargowise::Shipment.via(:ijs).by_shipment_number("123456")
+    client.shipments.by_shipment_number("123456")
 
 To find undelivered shipments:
 
-    Cargowise::Shipment.via(:ijs).undelivered
+    client.shipments.undelivered
 
 To find shipments with activity in the past 14 days (or so):
 
-    Cargowise::Shipment.via(:ijs).with_recent_activity
+    client.shipments.with_recent_activity
 
 All Order and Shipment objects are read only, there are no write capabale
 methods exposed via the API. If you see errors, contact your logistics company.

data/lib/cargowise.rb

@@ -2,12 +2,10 @@
 
 # stdlib
 require "bigdecimal"
-require "handsoap"
 
 # gems
 require 'mechanize'
 require 'andand'
-require 'savon'
 
 module Cargowise
   DEFAULT_NS = "http://www.edi.com.au/EnterpriseService/"
@@ -15,20 +13,7 @@ module Cargowise
 end
 
 # this lib
-require 'cargowise/abstract_client'
-require 'cargowise/orders_client'
-require 'cargowise/shipments_client'
-require 'cargowise/abstract_result'
-require 'cargowise/order'
-require 'cargowise/shipment'
-require 'cargowise/packing'
-require 'cargowise/consol'
-require 'cargowise/document'
-require 'cargowise/invoice'
-require 'cargowise/endpoint'
-require 'cargowise/abstract_search'
-require 'cargowise/order_search'
-require 'cargowise/shipment_search'
+require 'cargowise/client'
 
 # Make savon/httpi always use Net::HTTP for HTTP requests. It supports
 # forcing the connection to TLSv1 (needed for OHL)

data/lib/cargowise/abstract_result.rb

@@ -8,25 +8,6 @@ module Cargowise
   #
   class AbstractResult # :nodoc:
 
-    def self.register(name, opts = {})
-      @endpoints ||= {}
-      @endpoints[name] = Endpoint.new(opts)
-    end
-
-    def self.endpoint(name)
-      @endpoints ||= {}
-      @endpoints[name]
-    end
-
-    def self.via(name)
-      @endpoints ||= {}
-      raise ArgumentError, "#{name} is not recognised, have you registered it?" if @endpoints[name].nil?
-
-      klass_name = (self.name[/Cargowise::(.+)/,1] + "Search")
-      search_klass = Cargowise.const_get(klass_name)
-      search_klass.new(@endpoints[name])
-    end
-
     def inspect
       str = "<#{self.class}: "
       str << inspectable_vars.map { |v| "#{v.to_s.tr('@','')}: #{instance_variable_get(v)}" }.join(" ")

data/lib/cargowise/client.rb

@@ -0,0 +1,113 @@
+# coding: utf-8
+
+require 'savon'
+require 'cargowise/order_search'
+require 'cargowise/shipment_search'
+
+module Cargowise
+
+  # The starting point for accessing data from your logistics provider. See
+  # the README for usage tips.
+  #
+  # You should create a new Client instance for each company API you plan
+  # to query.
+  #
+  class Client
+
+    def initialize(opts = {})
+      @order_uri = opts[:order_uri]
+      @shipment_uri = opts[:shipment_uri]
+      @code = opts[:company_code]
+      @username = opts[:username]
+      @password = opts[:password]
+    end
+
+    # begin an order search. See the docs for Cargowise::OrderSearch for info
+    # on what you can do with the object returned from this method.
+    def orders
+      OrderSearch.new(orders_client)
+    end
+
+    # begin a shipment search. See the docs for Cargowise::ShipmentSearch for
+    # info on what you can do with the object returned from this method.
+    def shipments
+      ShipmentSearch.new(shipments_client)
+    end
+
+    def orders_hello
+      response = orders_client.call(:hello)
+      response.xpath("//tns:HelloResponse/tns:HelloResult/text()", {"tns" => Cargowise::DEFAULT_NS}).to_s
+    end
+
+    def shipments_hello
+      response = shipments_client.call(:hello)
+      response.xpath("//tns:HelloResponse/tns:HelloResult/text()", {"tns" => Cargowise::DEFAULT_NS}).to_s
+    end
+
+    # Find the base URI for the web interface at this client
+    #
+    def base_uri
+      uri = @shipment_uri || @order_uri || ""
+      uri.to_s[/(.+)\/WebService.+/,1]
+    end
+
+    private
+
+    def orders_client
+      build_client(order_wsdl_path, @order_uri)
+    end
+
+    def order_wsdl_path
+      File.join(
+        File.dirname(__FILE__),
+        "order_wsdl.xml"
+      )
+    end
+
+    def shipments_client
+      build_client(shipment_wsdl_path, @shipment_uri)
+    end
+
+    def shipment_wsdl_path
+      File.join(
+        File.dirname(__FILE__),
+        "shipment_wsdl.xml"
+      )
+    end
+
+    # TODO: make some of these configurable via the initialize to Cargowise::Client. Will enable
+    #       providers that need special treatment to work (like OHL) to be configured differently
+    #       by the calling code
+    def build_client(wsdl_path, endpoint_uri)
+      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: 240,
+
+        # 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" => @code,
+            "tns:UserName" => @username,
+            "tns:Password" => @password
+          }
+        }
+      )
+    end
+  end
+end

data/lib/cargowise/consol.rb

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require 'cargowise/abstract_result'
+
 module Cargowise
 
   # Extra shipping detail associated with a Shipment. Not built

data/lib/cargowise/document.rb

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require 'cargowise/abstract_result'
+
 module Cargowise
 
   # A document that is associated with a Shipment. Not built

data/lib/cargowise/invoice.rb

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require 'cargowise/abstract_result'
+
 module Cargowise
 
   # An invoice that is associated with a Shipment. Not built

data/lib/cargowise/order.rb

@@ -1,5 +1,8 @@
 # coding: utf-8
 
+require 'cargowise/abstract_result'
+require 'cargowise/shipment'
+
 module Cargowise
 
   # A purchase order that is being shipped to from a supplier to

data/lib/cargowise/order_search.rb

@@ -1,8 +1,14 @@
 # coding: utf-8
 
+require 'cargowise/order'
+
 module Cargowise
 
-  class OrderSearch < AbstractSearch
+  class OrderSearch
+
+    def initialize(savon_client)
+      @savon_client = savon_client
+    end
 
     # find all orders with an OrderNumber that matches ref
     #
@@ -15,7 +21,7 @@ module Cargowise
           }
         }
       }
-      OrdersClient.new.get_order_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
+      get_order_list(filter_hash)
     end
 
     # find all orders with a ShipmentNumber that matches ref
@@ -29,7 +35,7 @@ module Cargowise
           }
         }
       }
-      OrdersClient.new.get_order_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
+      get_order_list(filter_hash)
     end
 
     # find all orders still marked as incomplete.
@@ -38,7 +44,22 @@ module Cargowise
       filter_hash = {
         "tns:Filter" => { "tns:OrderStatus" => "INC" }
         }
-      OrdersClient.new.get_order_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
+      get_order_list(filter_hash)
+    end
+
+    private
+
+    # return an array of orders. Each order *should* correspond to a buyer PO.
+    #
+    # filter_hash should be a hash that will be serialised into an
+    # XML fragment specifying the search criteria. See the WSDL documentation
+    # for samples
+    #
+    def get_order_list(filter_hash)
+      response = @savon_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
 
   end

data/lib/cargowise/packing.rb

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require 'cargowise/abstract_result'
+
 module Cargowise
 
   # Extra packing detail associated with a Shipment. Not built

data/lib/cargowise/shipment.rb

@@ -1,5 +1,11 @@
 # coding: utf-8
 
+require 'cargowise/abstract_result'
+require 'cargowise/packing'
+require 'cargowise/consol'
+require 'cargowise/document'
+require 'cargowise/invoice'
+
 module Cargowise
 
   # A shipment that is currently on its way to you. Could take on a
@@ -88,23 +94,23 @@ module Cargowise
 
     # lookup full Cargowise::Order objects for each order on this shipment.
     #
-    # 'via' is a symbol indicating which API endpoint to lookup.
+    # client is a Cargowise::Client instance to look for the related shipments on
     #
-    def orders(via)
-      @orders ||= Cargowise::Order.via(via).by_shipment_number(self.number)
+    def orders(client)
+      @orders ||= client.orders.by_shipment_number(self.number)
     end
 
     # lookup related Cargowise::Shipment objects. These are usually "child" shipments
     # grouped under a parent. Think a consolidated pallet (the parent) with cartons from
     # multiple suppliers (the children).
     #
-    # 'via' is a symbol indicating which API endpoint to lookup.
+    # client is a Cargowise::Client instance to look for the related shipments on
     #
-    def related_shipments(via)
+    def related_shipments(client)
       @related ||= @consols.map { |consol|
         consol.master_bill
       }.compact.map { |master_bill|
-        Cargowise::Shipment.via(via).by_masterbill_number(master_bill)
+        client.shipments.by_masterbill_number(master_bill)
       }.flatten.select { |shipment|
         shipment.number != self.number
       }.compact
@@ -115,9 +121,11 @@ module Cargowise
     # This data isn't available via the API, so we need to screen scrape the
     # website to get it.
     #
-    def order_ref(via)
-      if tracker_login_uri(via)
-        @order_ref ||= html_page(via).search(".//span[@id='Ztextlabel1']/text()").to_s.strip || ""
+    # client is a Cargowise::Client instance to look for the related shipments on
+    #
+    def order_ref(client)
+      if client.base_uri
+        @order_ref ||= html_page(client).search(".//span[@id='Ztextlabel1']/text()").to_s.strip || ""
       else
         nil
       end
@@ -127,12 +135,11 @@ module Cargowise
 
     # retrieve a Mechanize::Page object that containts info on this shipment
     #
-    def html_page(via)
-      return nil unless tracker_login_uri(via)
+    def html_page(client)
+      return nil unless client.base_uri
 
       @html_page ||= begin
-        base_uri = tracker_login_uri(via)
-        login_uri = base_uri + "/Login/Login.aspx"
+        login_uri = client.base_uri + "/Login/Login.aspx"
         agent = Mechanize.new
         agent.agent.http.ssl_version = :TLSv1
         if File.file?(Cargowise::CA_CERT_FILE)
@@ -147,11 +154,5 @@ module Cargowise
       end
     end
 
-    # Find a shipment with documents attached so we can discover the
-    # web interface uri
-    #
-    def tracker_login_uri(via)
-      Shipment.endpoint(via).uri.to_s[/(.+)\/WebService.+/,1]
-    end
   end
 end

data/lib/cargowise/shipment_search.rb

@@ -1,8 +1,14 @@
 # coding: utf-8
 
+require 'cargowise/shipment'
+
 module Cargowise
 
-  class ShipmentSearch < AbstractSearch
+  class ShipmentSearch
+
+    def initialize(savon_client)
+      @savon_client = savon_client
+    end
 
     # find all shipments with a MasterBillNumber that matches ref
     #
@@ -26,7 +32,7 @@ module Cargowise
       filter_hash = {
         "tns:Filter" => { "tns:Status" => "Undelivered" }
         }
-      ShipmentsClient.new.get_shipments_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
+      get_shipments_list(filter_hash)
     end
 
     # find all shipments that had some activity in the past fourteen days. This could
@@ -42,7 +48,7 @@ module Cargowise
           }
         }
       }
-      ShipmentsClient.new.get_shipments_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
+      get_shipments_list(filter_hash)
     end
 
     # find all shipments that had were shipped in the past 14 days or will ship in
@@ -58,7 +64,7 @@ module Cargowise
           }
         }
       }
-      ShipmentsClient.new.get_shipments_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
+      get_shipments_list(filter_hash)
     end
 
     private
@@ -72,7 +78,21 @@ module Cargowise
           }
         }
       }
-      ShipmentsClient.new.get_shipments_list(ep.uri, ep.code, ep.user, ep.password, filter_hash)
+      get_shipments_list(filter_hash)
+    end
+
+    # return an array of shipments. Each shipment should correspond to
+    # a consolidated shipment from the freight company.
+    #
+    # filter_hash should be a hash that will be serialised into an
+    # XML fragment specifying the search criteria. See the WSDL documentation
+    # for samples
+    #
+    def get_shipments_list(filter_hash)
+      response = @savon_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
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cargowise
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 1.0.0.alpha
 platform: ruby
 authors:
 - James Healy
@@ -66,7 +66,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Retrieve tracking and status information on your shipments from entpriseEDI
+description: Retrieve tracking and status information on your shipments from ediEnterprise
 email:
 - james@yob.id.au
 executables: []
@@ -77,16 +77,12 @@ files:
 - lib/cargowise/order_search.rb
 - lib/cargowise/consol.rb
 - lib/cargowise/invoice.rb
+- lib/cargowise/client.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/shipments_client.rb
 - lib/cargowise/packing.rb
-- lib/cargowise/abstract_search.rb
 - lib/cargowise/abstract_result.rb
-- lib/cargowise/endpoint.rb
 - lib/cargowise/shipment_search.rb
 - lib/cargowise/order_wsdl.xml
 - lib/cargowise/shipment_wsdl.xml
@@ -99,7 +95,18 @@ homepage: http://github.com/yob/cargowise
 licenses:
 - mit
 metadata: {}
-post_install_message: 
+post_install_message: |2+
+
+    ********************************************
+
+    v1.0.0 of cargowise introduced a new API. There are extensive
+    examples showing how to use it in the README and examples directory.
+
+    The old API has been removed, so you will need to update your code
+    before it will work with cargowise 1.0.0 or higher.
+
+    ********************************************
+
 rdoc_options:
 - --title
 - Cargowise
@@ -113,13 +120,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Wrapper around entpriseEDI SOAP API by cargowise
+summary: client library for the ediEnterprise SOAP API by cargowise
 test_files: []

data/lib/cargowise/abstract_client.rb

@@ -1,46 +0,0 @@
-# coding: utf-8
-
-module Cargowise
-
-  # Superclass of all clients, currently we have clients for
-  # orders and Shipments.
-  #
-  # Not much to see here, just common methods
-  #
-  class AbstractClient
-
-    private
-
-    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: 240,
-
-        # 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_search.rb

@@ -1,25 +0,0 @@
-# coding: utf-8
-
-module Cargowise
-
-  class AbstractSearch
-
-    def initialize(endpoint)
-      @endpoint = endpoint
-    end
-
-    private
-
-    def ep
-      @endpoint
-    end
-
-    def endpoint_hash
-      {
-        :uri => ep.uri,
-        :version => 2
-      }
-    end
-
-  end
-end

data/lib/cargowise/endpoint.rb

@@ -1,27 +0,0 @@
-# coding: utf-8
-
-module Cargowise
-
-  # Stores the details for connecting to a single logistics company.
-  #
-  # Generally created using the register() method on the Order and
-  # Shipment classes.
-  #
-  class Endpoint
-
-    attr_reader :uri
-    attr_reader :code, :user, :password
-
-    # create a new endpoint. All 4 options are compulsory.
-    #
-    def initialize(opts = {})
-      raise ArgumentError, "option :uri must be provided"      if opts[:uri].nil?
-      raise ArgumentError, "option :code must be provided"     if opts[:code].nil?
-      raise ArgumentError, "option :user must be provided"     if opts[:user].nil?
-      raise ArgumentError, "option :password must be provided" if opts[:password].nil?
-
-      @uri = opts[:uri]
-      @code, @user, @password = opts[:code], opts[:user], opts[:password]
-    end
-  end
-end

data/lib/cargowise/orders_client.rb

@@ -1,43 +0,0 @@
-# coding: utf-8
-
-module Cargowise
-
-  # SOAP client for retreiving order data. Not much to
-  # see here, used by the Order resource class.
-  #
-  class OrdersClient < AbstractClient
-
-    # return an array of orders. Each order *should* correspond to a buyer PO.
-    #
-    # filter_hash should be a hash that will be serialised into an
-    # XML fragment specifying the search criteria. See the WSDL documentation
-    # for samples
-    #
-    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/shipments_client.rb

@@ -1,44 +0,0 @@
-# coding: utf-8
-
-module Cargowise
-
-  # SOAP client for retreiving shipment data. Not much to
-  # see here, used by the Shipment resource class.
-  #
-  class ShipmentsClient < AbstractClient
-
-    # return an array of shipments. Each shipment should correspond to
-    # a consolidated shipment from the freight company.
-    #
-    # filter_hash should be a hash that will be serialised into an
-    # XML fragment specifying the search criteria. See the WSDL documentation
-    # for samples
-    #
-    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