cargowise 0.5

data/CHANGELOG

@@ -0,0 +1,3 @@
+v0.5 - 27th August 2010
+
+* initial release

data/COPYING

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+     59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year  name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/LICENSE

@@ -0,0 +1,56 @@
+Cargowise is copyrighted free software produced by James Healy along with 
+community contributions.  See git log for authorship information.
+
+Licensing terms follow (License of Ruby 1.8):
+
+You can redistribute Cargowise and/or modify it under either the terms of the GPL
+(see COPYING file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+    modifications to Usenet or an equivalent medium, or by allowing
+    the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+    with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+    together with instructions (in the manual page or equivalent)
+    on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+    the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial). 
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.markdown

@@ -0,0 +1,111 @@
+## Overview
+
+EnterpriseEDI is a commercial shipping and logistics software package by
+Cargowise and used by logistics companies. Depending on the setup it often has
+a SOAP API for clients shipping stuff can check on it's progress. Think
+tracking your Fedex package but on a larger scale.
+
+This library provides a nice object based wrapper around the API so you can
+pretend the nasty SOAP behind it doesn't exist.
+
+I am in no way personally affiliated with Cargowise or companies that use
+EnterpriseEDI. This library was put together for a project that needed access
+to specific details of upcoming shipments.
+
+## Installation
+
+    gem install cargowise
+
+## Usage
+
+The cargowise API exposes two resources - Order and Shipment. Depending on your
+logistics company and what data they record there may be useful information on
+either or both.
+
+### Registering Endpoints
+
+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::Order.register(:ijs, :uri  => "http://visibility.ijsglobal.com/Tracker/WebService/ShipmentService.asmx",
+                                    :code => "company_code",
+                                    :user => "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.
+
+See the Finding API Endpoints section below for tips on finding the correct URI
+to register.
+
+### Querying
+
+Cargowise::Order is a purchase order. It's for tracking the status of an order
+as it makes it's way from a supplier to you. For these to exist you probably need to
+have an arrangement with the logistics company to send them copies when you place
+the order.
+
+To find all orders with a certain order number:
+
+    Cargowise::Order.via(:ijs).by_order_number("123456")
+
+To find all incomplete orders:
+
+    Cargowise::Order.via(:ijs).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.
+
+To find shipments by the shipment number (a reference number selected by your logistics
+company):
+
+    Cargowise::Shipment.via(:ijs).by_shipment_number("123456")
+
+To find undelivered shipments:
+
+    Cargowise::Shipment.via(:ijs).undelivered
+
+To find shipments with activity in the past 14 days (or so):
+
+    Cargowise::Shipment.via(:ijs).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.
+
+## Finding API Endpoints
+
+Logistics companies that run EnterpriseEDI often don't realise they have an API
+so tracking down information on how to set it up can be tricky.
+
+If they have a website for tracking you can start with that URL and then guess
+the rest.
+
+For example, OHLs web tracking site is at:
+
+* https://webtracking.ohl.com/
+
+Their two API endpoints are therefore:
+
+* https://webtracking.ohl.com/WebService/ShipmentService.asmx
+* https://webtracking.ohl.com/WebService/OrderService.asmx
+
+IJS global has a webtracking site at:
+
+* http://visibility.ijsglobal.com/
+
+Their two API endpoints are:
+
+* http://visibility.ijsglobal.com/Tracker/WebService/ShipmentService.asmx
+* http://visibility.ijsglobal.com/Tracker/WebService/OrderService.asmx
+
+## Links
+
+* Cargowise: http://www.cargowise.com/

data/TODO

@@ -0,0 +1,2 @@
+* make filter methods chainable (like named_scopes)
+* make via() method optional if only 1 endpoint is registered

data/lib/cargowise.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+# stdlib
+require "bigdecimal"
+require "handsoap"
+
+module Cargowise
+  DEFAULT_NS = "http://www.edi.com.au/EnterpriseService/"
+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/document'
+require 'cargowise/endpoint'
+require 'cargowise/abstract_search'
+require 'cargowise/order_search'
+require 'cargowise/shipment_search'

data/lib/cargowise/abstract_client.rb

@@ -0,0 +1,42 @@
+# 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 < 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)
+      response.document.xpath("//tns:HelloResponse/tns:HelloResult/text()", {"tns" => Cargowise::DEFAULT_NS}).to_s
+    end
+
+    private
+
+    def headers(company_code, username, pass)
+      {
+        "tns:WebTrackerSOAPHeader" => {
+          "tns:CompanyCode" => company_code,
+          "tns:UserName"    => username,
+          "tns:Password"    => pass
+        }
+      }
+    end
+
+  end
+end

data/lib/cargowise/abstract_result.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+module Cargowise
+
+  # Superclass of all objects built to contain results from
+  # the API. Not much to see here, mostly common helper methods
+  # for parsing values out of the XML response.
+  #
+  class AbstractResult # :nodoc:
+
+    def self.register(name, opts = {})
+      @endpoints ||= {}
+      @endpoints[name] = Endpoint.new(opts)
+    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.tr('@','')}: #{instance_variable_get(v)}" }.join(" ")
+      str << ">"
+      str
+    end
+
+    private
+
+    def node
+      @node
+    end
+
+    def inspectable_vars
+      instance_variables.select { |var| var != "@node"}
+    end
+
+    def node_array(path)
+      path = path.gsub("/","/tns:")
+      node.xpath("#{path}", "tns" => Cargowise::DEFAULT_NS)
+    end
+
+    def text_value(path)
+      path = path.gsub("/","/tns:")
+      node.xpath("#{path}/text()", "tns" => Cargowise::DEFAULT_NS).to_s
+    end
+
+    def time_value(path)
+      val = text_value(path)
+      val.nil? ? nil : DateTime.parse(val)
+    end
+
+    def decimal_value(path)
+      val = text_value(path)
+      val.nil? ? nil : BigDecimal.new(val)
+    end
+  end
+end

data/lib/cargowise/abstract_search.rb

@@ -0,0 +1,25 @@
+# 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/document.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+module Cargowise
+
+  # A document that is associated with a Shipment. Not built
+  # directly, but available via the documents() attribute
+  # of the Shipment model.
+  #
+  class Document < AbstractResult
+
+    attr_reader :date, :description, :link
+
+    def initialize(node)
+      @node = node
+
+      @date        = time_value("./Date")
+      @description = text_value("./Description")
+      @link        = text_value("./Link")
+    end
+  end
+end

data/lib/cargowise/endpoint.rb

@@ -0,0 +1,27 @@
+# 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/order.rb

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+module Cargowise
+
+  # A purchase order that is being shipped to from a supplier to
+  # you via a logistics company.
+  #
+  # Typcially you will setup an arrangement with your account manager
+  # where they are sent copies of POs so they can be entered into the
+  # database and tracked.
+  #
+  # All order objects are read-only, see the object attributes to see
+  # what information is available.
+  #
+  # Use class find methods to retrieve order info from your logistics
+  # company.
+  #
+  #     Order.find_by_order_number(...)
+  #     Order.find_incomplete(...)
+  #     etc
+  #
+  class Order < AbstractResult
+
+    attr_reader :order_number, :order_status, :description, :datetime
+    attr_reader :order_total, :transport_mode, :container_mode
+
+    attr_reader :buyer_name
+
+    attr_reader :supplier_name
+
+    attr_reader :shipments
+
+    def initialize(node)
+      @node = node
+
+      @order_number = text_value("./OrderIdentifier/OrderNumber")
+      @order_status = text_value("./OrderDetail/OrderStatus")
+      @description  = text_value("./OrderDetail/Description")
+      @datetime     = time_value("./OrderDetail/OrderDateTime")
+      @order_total  = decimal_value("./OrderDetail/OrderTotal")
+      @transport_mode = text_value("./OrderDetail/TransportMode")
+      @container_mode = text_value("./OrderDetail/ContainerMode")
+
+      @buyer_name   = text_value("./OrderDetail/Buyer/OrganisationDetails/Name")
+
+      @supplier_name = text_value("./OrderDetail/Supplier/OrganisationDetails/Name")
+
+      @shipments = node_array("./Shipment").map { |node|
+        Shipment.new(node)
+      }
+    end
+
+  end
+
+end

data/lib/cargowise/order_search.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+module Cargowise
+
+  class OrderSearch < AbstractSearch
+
+    # find all orders with an OrderNumber that matches ref
+    #
+    def by_order_number(ref)
+      filter_hash = {
+        "tns:Filter" => {
+          "tns:Number" => {
+            "tns:NumberSearchField" => "OrderNumber",
+            "tns:NumberValue" => ref
+          }
+        }
+      }
+      OrdersClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
+      OrdersClient.get_order_list(ep.code, ep.user, ep.password, filter_hash)
+    end
+
+    # find all orders still marked as incomplete.
+    #
+    def incomplete
+      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)
+    end
+
+  end
+end
+

data/lib/cargowise/orders_client.rb

@@ -0,0 +1,25 @@
+# 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 # :nodoc:
+
+    # 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(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)
+      response.document.xpath("//tns:GetOrderListResult/tns:WebOrder", {"tns" => Cargowise::DEFAULT_NS}).map do |node|
+        Cargowise::Order.new(node)
+      end
+    end
+  end
+end

data/lib/cargowise/shipment.rb

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+module Cargowise
+
+  # A shipment that is currently on its way to you. Could take on a
+  # variety of forms - carton, palet, truck? Could be travelling via
+  # air, sea, road, rail, donkey?
+  #
+  # Typcially you will lookup the status of a shipment you're aware of
+  # using the shipment number:
+  #
+  #     Shipment.find_by_shipment_number(...)
+  #
+  # If you want all recent shipments (delivered and undelivered) to
+  # ensure you know what's coming:
+  #
+  #     Shipment.find_with_recent_activity(...)
+  #
+  # All shipment objects are read-only, see the object attributes to see
+  # what information is available.
+  #
+  class Shipment < AbstractResult
+
+    attr_reader :number, :housebill, :goods_description, :service_level
+    attr_reader :origin, :destination, :etd, :eta, :delivered_date
+
+    attr_reader :shipper_name
+
+    attr_reader :consignee_name
+
+    attr_reader :documents
+
+    def initialize(node)
+      @node = node
+
+      @number    = text_value("./Number")
+      @housebill = text_value("./HouseBill")
+      @goods_description = text_value("./GoodsDescription")
+      @service_level = text_value("./ServiceLevel")
+      @origin        = text_value("./Origin")
+      @destination   = text_value("./Destination")
+      @etd           = time_value("./ETD")
+      @eta           = time_value("./ETA")
+      @delivered_date = time_value("./DeliveredDate")
+
+      @shipper_name = text_value("./Shipper/OrganisationDetails/Name")
+
+      @consignee_name = text_value("./Consignee/OrganisationDetails/Name")
+
+      @documents = node_array("./DocumentLinks/DocumentLink").map { |node|
+        Document.new(node)
+      }.sort_by { |doc|
+        doc.date
+      }
+    end
+
+  end
+end

data/lib/cargowise/shipment_search.rb

@@ -0,0 +1,56 @@
+# coding: utf-8
+
+module Cargowise
+
+  class ShipmentSearch < AbstractSearch
+
+    # find all shipments with a ShipmentNumber that matches ref
+    #
+    def by_shipment_number(ref)
+      filter_hash = {
+        "tns:Filter" => {
+          "tns:Number" => {
+            "tns:NumberSearchField" => "ShipmentNumber",
+            "tns:NumberValue" => ref
+          }
+        }
+      }
+      ShipmentsClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
+      ShipmentsClient.get_shipments_list(ep.code, ep.user, ep.password, filter_hash)
+    end
+
+    # find all shipments that haven't been delivered yet.
+    #
+    # This times out on some systems, possibly because the logistics company
+    # isn't correctly marking shipments as delivered, so the result is too
+    # large to transfer in a timely manner.
+    #
+    def undelivered
+      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)
+    end
+
+    # find all shipments that had some activity in the past seven days. This could
+    # include leaving port, being delivered or passing a milestone.
+    #
+    def with_recent_activity
+      filter_hash = {
+        "tns:Filter" => {
+          "tns:Date" => {
+            "tns:DateSearchField" => "ALL",
+            "tns:FromDate" => (Date.today - 14).strftime("%Y-%m-%d"),
+            "tns:ToDate" => (Date.today + 14).strftime("%Y-%m-%d")
+          }
+        }
+      }
+      ShipmentsClient.endpoint(endpoint_hash) # probably not threadsafe. oops.
+      ShipmentsClient.get_shipments_list(ep.code, ep.user, ep.password, filter_hash)
+    end
+
+
+  end
+end
+

data/lib/cargowise/shipments_client.rb

@@ -0,0 +1,27 @@
+# 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 # :nodoc:
+
+    # 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(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)
+      response.document.xpath("//tns:GetShipmentsListResult/tns:WebShipment", {"tns" => Cargowise::DEFAULT_NS}).map do |node|
+        Cargowise::Shipment.new(node)
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: cargowise
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  version: "0.5"
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-27 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: handsoap
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 1
+        - 7
+        version: 1.1.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id002
+description: Retrieve tracking and status information on your shipments from entpriseEDI
+email: james@yob.id.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cargowise/shipment.rb
+- lib/cargowise/shipments_client.rb
+- lib/cargowise/abstract_client.rb
+- lib/cargowise/abstract_search.rb
+- lib/cargowise/order.rb
+- lib/cargowise/abstract_result.rb
+- lib/cargowise/order_search.rb
+- lib/cargowise/document.rb
+- lib/cargowise/endpoint.rb
+- lib/cargowise/shipment_search.rb
+- lib/cargowise/orders_client.rb
+- lib/cargowise.rb
+- README.markdown
+- CHANGELOG
+- TODO
+- COPYING
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/yob/cargowise
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Cargowise
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper around entpriseEDI SOAP API by cargowise
+test_files: []
+