pacstream 0.9

data/CHANGELOG

@@ -0,0 +1,21 @@
+v0.9
+- API INCOMPATIBLE CHANGE: Moved out of the RBook namespace
+  - gem was been rename 'pacstream' to prevent breakage of users apps
+- Add support for sending an receiving BISAC PO files
+
+v0.8
+- Added support for listing files on the pacstream server without actually downloading them
+
+v0.7.1
+- wrap the quit call in a rescue block. Sometimes the remote server closes the 
+  connection so quickly, Net::FTP freaks out when the socket closes, and we 
+  really don't care.
+
+v0.7
+- tightened up syntax
+- added support for sending files
+- can download POAs and Invoices
+
+v0.6
+- basic release
+- can download orders only

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,11 @@
+= License Terms
+
+Distributed by James Healy under the user's choice* of the 
+{GPL version 2}[http://www.gnu.org/copyleft/gpl.html] (see COPYING for details)
+or the {Ruby software license}[http://www.ruby-lang.org/en/LICENSE.txt].
+
+Please email James[mailto:jimmy_AT_deefa.com] with any questions.
+
+*Note:  This license refers specifically to GPLv2.
+Distributing under other versions of the GPL require explicit permission from
+James Healy.

data/README

@@ -0,0 +1,13 @@
+A small library to assist with sending and receiving electronic ordering
+data with PACSTREAM.
+
+Getting the order formats right is left to the user, this is just a 
+wrapper around Net::FTP that puts files the right spot, etc.
+
+I am not connected in any way with the owners of the PACSTREAM service,
+The ECN Group. I just work for a company that uses PACSTREAM to send and
+receive orders with other companies.
+
+The PACSTREAM brand is © 2007 The ECN Group
+
+Official Service Site: http://www.pacstream.com.au/

data/Rakefile

@@ -0,0 +1,97 @@
+require "rubygems"
+require 'rake'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require "rake/gempackagetask"
+require 'spec/rake/spectask'
+
+PKG_VERSION = "0.9"
+PKG_NAME = "pacstream"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+RUBYFORGE_PROJECT = 'rbook'
+RUBYFORGE_USER = 'yob'
+
+CLEAN.include "**/.*.sw*"
+
+desc "Default Task"
+task :default => [ :spec ]
+
+desc "Cruise Control Tasks"
+task :cruise => [ :spec, :spec_report, :doc ]
+
+# run all rspecs
+desc "Run all rspec files"
+Spec::Rake::SpecTask.new("spec") do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  
+  if RUBY_VERSION >= "1.8.6" && RUBY_PATCHLEVEL >= 110
+    t.rcov = false
+  else
+    t.rcov = true
+  end
+
+  t.rcov_dir = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + "/rcov"
+  t.rcov_opts = ["--exclude","spec.*\.rb"]
+end
+
+# generate specdocs
+desc "Generate Specdocs"
+Spec::Rake::SpecTask.new("specdocs") do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  t.spec_opts = ["--format", "rdoc"]
+  t.out = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/specdoc.rd'
+end
+
+# generate failing spec report
+desc "Generate failing spec report"
+Spec::Rake::SpecTask.new("spec_report") do |t|
+  t.spec_files = FileList['specs/**/*.rb']
+  t.spec_opts = ["--format", "html", "--diff"]
+  t.out = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/spec_report.html'
+  t.fail_on_error = false
+end
+
+# Genereate the RDoc documentation
+desc "Create documentation"
+Rake::RDocTask.new("doc") do |rdoc|
+  rdoc.title = "RBook"
+  rdoc.rdoc_dir = (ENV['CC_BUILD_ARTIFACTS'] || 'doc') + '/rdoc'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('COPYING')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << "--inline-source"
+end
+
+spec = Gem::Specification.new do |spec|
+	spec.name = PKG_NAME
+	spec.version = PKG_VERSION
+	spec.platform = Gem::Platform::RUBY
+	spec.summary = "A library for interaction with the PACSTREAM service"
+	spec.files =  Dir.glob("{examples,lib,specs}/**/**/*") +
+                      ["Rakefile", "CHANGELOG", "COPYING", "README"]
+  
+  spec.require_path = "lib"
+  spec.test_files = Dir[ "specs/**/*.rb" ]
+	spec.has_rdoc = true
+	spec.extra_rdoc_files = %w{README COPYING LICENSE CHANGELOG}
+	spec.rdoc_options << '--title' << 'pacstream Documentation' <<
+	                     '--main'  << 'README' << '-q'
+  spec.add_dependency('rbook-isbn', '>= 1.0')
+  spec.author = "James Healy"
+	spec.email = "jimmy@deefa.com"
+	spec.rubyforge_project = "rbook"
+	spec.homepage = "http://rbook.rubyforge.org/"
+	spec.description = <<END_DESC
+  This library is designed to assist with using the PACSTREAM
+  electronic ordering service used by the book industry in 
+  Australia.
+END_DESC
+end
+
+desc "Generate a gem for rbook"
+Rake::GemPackageTask.new(spec) do |pkg|
+	pkg.need_tar = true
+end
+

data/examples/get.rb

@@ -0,0 +1,15 @@
+# assuming you have rbook installed via rubygems,
+# in a regular script you should replace the following require
+# line with these 2 lines:
+#   require 'rubygems'
+#   require 'rbook/pacstream'
+require File.dirname(__FILE__) + '/../lib/rbook/pacstream'
+
+counter = 0
+
+RBook::Pacstream.open(:username => "myusername", :password => "mypass") do |pac|
+  pac.get(:orders) do |order|
+    File.open("#{counter.to_s}.ord", "w") { |f| f.puts order }
+    counter += 1
+  end
+end

data/examples/list.rb

@@ -0,0 +1,12 @@
+# assuming you have rbook installed via rubygems,
+# in a regular script you should replace the following require
+# line with these 2 lines:
+#   require 'rubygems'
+#   require 'rbook/pacstream'
+require File.dirname(__FILE__) + '/../lib/rbook/pacstream'
+
+counter = 0
+
+RBook::Pacstream.open(:username => "username", :password => "pass") do |pac|
+  puts pac.list(:orders).inspect
+end

data/lib/pacstream.rb

@@ -0,0 +1,189 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/../")
+
+require 'net/ftp'
+require 'tempfile'
+
+# an error indicating pacstream authentication issues
+class PacstreamAuthError < RuntimeError; end
+
+# an error indocating a problem with executing a pacstream command
+class PacstreamCommandError < RuntimeError; end
+
+# an error indicating a problem connecting to the pacstream server
+class PacstreamConnectionError < RuntimeError; end
+
+# Ruby class for sending and retrieving electronic orders
+# via pacstream, a service run by the ECN Group 
+# (http://www.ecngroup.com.au/)
+#
+# = Basic Usage
+#
+#  pac = Pacstream.new(:username => "myusername", :password => "mypass")
+#  pac.login
+#  pac.get(:orders) do |order|
+#    puts order
+#  end
+#  pac.get(:poacks) do |poa|
+#    puts poa
+#  end
+#  pac.put(:order, 1000, order_text)
+#  pac.quit
+#
+# = Alternative Usage
+#  Pacstream.open(:username => "myusername", :password => "mypass") do |pac|
+#    pac.get(:orders) do |order|
+#      puts order
+#    end
+#    pac.put(:order, 1000, order_text)
+#  end
+class Pacstream
+
+  FILE_EXTENSIONS = { :bisac_orders => "BSC", :orders => "ORD", :invoices => "ASN", :poacks => "POA" }
+  FILE_EXTENSIONS_SINGULAR = { :bisac_order => "BSC", :order => "ORD", :invoice => "ASN", :poack => "POA" }
+
+  def initialize(*args)
+    if args[0][:username].nil? && args[0][:password].nil?
+      raise ArgumentError, 'username and password must be specified'
+    end
+
+    @server   = (args[0][:servername] || "pacstream.tedis.com.au").to_s
+    @username = args[0][:username].to_s
+    @password = args[0][:password].to_s
+  end
+
+  # download all documents of a particular type from the pacstream server
+  #
+  #   pac.get(:orders) do |order|
+  #     puts order
+  #   end
+  #
+  # Supported types: :bisac_orders, :orders, :invoices, :poacks
+  #
+  # WARNING: as soon as you download the order, the file is deleted from the server
+  #          and cannot be retrieved again
+  def get(type, &block)
+    raise PacstreamCommandError, "No current session open" unless @ftp
+    raise ArgumentError, 'unrecognised type' unless FILE_EXTENSIONS.include?(type.to_sym)
+
+    # determine the filename pattern we're searching for
+    file_regexp = Regexp.new(".*\.#{FILE_EXTENSIONS[type.to_sym]}$", Regexp::IGNORECASE)
+    @ftp.chdir("outgoing/")
+
+    # loop over each file in the outgoing dir and check if it matches the file type we're after
+    @ftp.nlst.each do |file|
+      if file.match(file_regexp)
+
+        # for all matching files, download to a temp file, return the contents, then delete the file
+        tempfile = Tempfile.new("pacstream")
+        tempfile.close
+        @ftp.getbinaryfile(file, tempfile.path)
+        yield File.read(tempfile.path)
+        tempfile.unlink
+      end
+    end
+
+    @ftp.chdir("..")
+  end
+
+  # list all documents of a particular type available on the pacstream server
+  #
+  #   pac.list(:orders) do |order|
+  #     puts order
+  #   end
+  def list(type, &block)
+    raise PacstreamCommandError, "No current session open" unless @ftp
+    raise ArgumentError, 'unrecognised type' unless FILE_EXTENSIONS.include?(type.to_sym)
+
+    ret = []
+
+    # determine the filename pattern we're searching for
+    file_regexp = Regexp.new(".*\.#{FILE_EXTENSIONS[type.to_sym]}$", Regexp::IGNORECASE)
+    @ftp.chdir("outgoing/")
+
+    # loop over each file in the outgoing dir and check if it matches the file type we're after
+    @ftp.nlst.each do |file|
+      ret << file if file.match(file_regexp)
+    end
+
+    @ftp.chdir("..")
+    return ret
+  end
+
+  # logs into to the pacstream server. Can raise several exceptions
+  # PacstreamConnectionError - Can't connect to server
+  # PacstreamAuthError - Invalid username or password
+  def login
+    begin
+      @ftp = Net::FTP.open(@server)
+      @ftp.login(@username, @password)
+    rescue Net::FTPPermError => e
+      raise PacstreamAuthError, e.message
+    rescue SocketError => e
+      raise PacstreamConnectionError, e.message
+    rescue Errno::ECONNREFUSED => e
+      raise PacstreamConnectionError, e.message
+    end
+  end
+
+  # upload a file to the pacstream server
+  # type    - :bisac_order, :order, invoice or :poack
+  # ref     - a reference number, used to name the file
+  # content - the content to upload
+  def put(type, ref, content)
+    raise PacstreamCommandError, "No current session open" unless @ftp
+    raise ArgumentError, 'unrecognised type' unless FILE_EXTENSIONS_SINGULAR.include?(type.to_sym)
+
+    remote_filename = "#{ref}.#{FILE_EXTENSIONS_SINGULAR[type.to_sym]}"
+    @ftp.chdir("incoming/")
+
+    tempfile = Tempfile.new("pacstream")
+    tempfile.write(content)
+    tempfile.close
+
+    @ftp.putbinaryfile(tempfile.path, remote_filename)
+
+    tempfile.unlink
+
+    @ftp.chdir("..")
+  end
+
+  # logout from the pacstream server
+  def quit
+    raise PacstreamCommandError, "No current session open" unless @ftp
+
+    begin
+      @ftp.quit
+    rescue Exception => e
+      # do nothing. Sometimes the server closes the connection and causes
+      # the ftp lib to freak out a little
+    end
+  end
+
+  # Deprecated way to download files from the pacstream server
+  #
+  # Document types available:
+  # 
+  # Purchase Orders (:orders)
+  # Purchase Order Acknowledgements (:poacks)
+  # Invoices (:invoices)
+  #
+  #  Pacstream.get(:orders, :username => "myusername", :password => "mypass") do |order|
+  #    puts order
+  #  end
+  def self.get(type = :orders, *args, &block)
+    pac = Pacstream.new(args[0])
+    pac.login
+    pac.get(type) do |content|
+      yield content
+    end
+    pac.quit
+  end
+
+  # Alternative, block syntax. See notes at the top of the class for usage
+  def self.open(*args, &block)
+    pac = Pacstream.new(args[0])
+    pac.login
+    yield pac
+    pac.quit
+  end
+end

data/specs/pacstream_spec.rb

@@ -0,0 +1,185 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../vendor')
+
+require 'pacstream'
+require 'not_a_mock'
+require 'rubygems'
+require 'spec'
+
+Spec::Runner.configure do |config|
+    config.mock_with NotAMock::RspecMockFrameworkAdapter
+end
+
+context "The pacstream class" do
+
+  setup do
+    @options = {:servername => "127.0.0.1",
+                :username   => "test",
+                :password   => "pass"}
+
+  end
+
+  specify "should open and close an ftp connection when login and logout are called in the right order" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    ftp = Net::FTP.stub_instance(:login => true, :quit => true)
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+
+    pac = Pacstream.new(@options)
+    pac.login
+    pac.quit
+
+    Net::FTP.should have_received(:open).once.with(@options[:servername])
+    ftp.should have_received(:login).once.with(@options[:username], @options[:password])
+    ftp.should have_received(:quit).once.without_args
+  end
+
+  specify "should return the contents of a invoice when looping over all available invoices's" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    # this stub will allow the user to call chdir, and pretends that there is a single invoice available
+    # for download
+    ftp = Net::FTP.stub_instance(:login => true, :chdir => true, :nlst => ["1.ASN"], :getbinaryfile => true, :quit => true)
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+    File.stub_method(:read => "this is an invoice")
+
+    pac = Pacstream.new(@options)
+    pac.login
+    pac.get(:invoices) do |ord|
+      ord.should eql("this is an invoice")
+    end
+    pac.quit
+
+    ftp.should have_received(:chdir).twice
+    ftp.should have_received(:nlst).once.without_args
+    ftp.should have_received(:getbinaryfile).once
+  end
+
+  specify "should return the contents of an order when looping over all available orders" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    # this stub will allow the user to call chdir, and rpretends that there is a single order available
+    # for download
+    ftp = Net::FTP.stub_instance(:login => true, :chdir => true, :nlst => ["1.ORD"], :getbinaryfile => true, :quit => true)
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+    File.stub_method(:read => "this is an order")
+
+    pac = Pacstream.new(@options)
+    pac.login
+    pac.get(:orders) do |ord|
+      ord.should eql("this is an order")
+    end
+    pac.quit
+
+    ftp.should have_received(:chdir).twice
+    ftp.should have_received(:nlst).once.without_args
+    ftp.should have_received(:getbinaryfile).once
+  end
+
+  specify "should return an array of waiting files on request, and not attempt to download them" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    # this stub will allow the user to call chdir, and pretends that there are two orders available
+    # for download
+    ftp = Net::FTP.stub_instance(:login => true, :chdir => true, :nlst => ["1.ORD","2.ORD"], :getbinaryfile => true, :quit => true)
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+
+    pac = Pacstream.new(@options)
+    pac.login
+    pac.list(:orders).should eql(["1.ORD","2.ORD"])
+    pac.quit
+
+    ftp.should have_received(:chdir).twice
+    ftp.should have_received(:nlst).once.without_args
+    ftp.should_not have_received(:getbinaryfile)
+  end
+
+  specify "should return the contents of a POA when looping over all available poa's" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    # this stub will allow the user to call chdir, and pretends that there is a single poa available
+    # for download
+    ftp = Net::FTP.stub_instance(:login => true, :chdir => true, :nlst => ["1.POA"], :getbinaryfile => true, :quit => true)
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+    File.stub_method(:read => "this is a poa")
+
+    pac = Pacstream.new(@options)
+    pac.login
+    pac.get(:poacks) do |ord|
+      ord.should eql("this is a poa")
+    end
+    pac.quit
+
+    ftp.should have_received(:chdir).twice
+    ftp.should have_received(:nlst).once.without_args
+    ftp.should have_received(:getbinaryfile).once
+  end
+
+  specify "should download a file correctly when the alternative, block syntax is used" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    ftp = Net::FTP.stub_instance(:login => true, :chdir => true, :nlst => ["1.ORD"], :getbinaryfile => true, :quit => true)
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+    File.stub_method(:read => "this is an order")
+
+    Pacstream.open(@options) do |pac|
+      pac.get(:orders) do |ord|
+        ord.should eql("this is an order")
+      end
+    end
+
+    Net::FTP.should have_received(:open).once.with(@options[:servername])
+    ftp.should have_received(:login).once.with(@options[:username], @options[:password])
+    ftp.should have_received(:chdir).twice
+    ftp.should have_received(:nlst).once.without_args
+    ftp.should have_received(:getbinaryfile).once
+    ftp.should have_received(:quit).once.without_args
+  end
+
+  specify "should raise an exception if incorrect login details are provided" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    ftp = Net::FTP.stub_instance(:login => Net::FTPPermError.new("530 incorrect login. not logged in."))
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+
+    pac = Pacstream.new(@options)
+    lambda { pac.login }.should raise_error(PacstreamAuthError)
+  end
+
+  specify "should raise an exception if an invalid server is provided" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    ftp = Net::FTP.stub_instance(:login => SocketError.new("getaddrinfo: Name or service not known"))
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+
+    pac = Pacstream.new(@options)
+    lambda { pac.login }.should raise_error(PacstreamConnectionError)
+  end
+
+  specify "should save an order to the server" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    # this stub will allow the user to call chdir, and pretends that there is a single poa available
+    # for download
+    ftp = Net::FTP.stub_instance(:login => true, :chdir => true, :putbinaryfile => true, :quit => true)
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+
+    pac = Pacstream.new(@options)
+    pac.login
+    pac.put(:order, 1, "order content")
+    pac.quit
+
+    ftp.should have_received(:chdir).twice
+    ftp.should have_received(:putbinaryfile).once
+  end
+
+  specify "should raise an exception if quit is called before login" do
+    # prevent a real ftp session from being opened. If the lib attempts to open
+    # a connection, just return a stubbed class
+    ftp = Net::FTP.stub_instance(:login => true, :quit => true)
+    Net::FTP.stub_method(:new => ftp, :open => ftp)
+
+    pac = Pacstream.new(@options)
+    lambda { pac.quit }.should raise_error(PacstreamCommandError)
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: pacstream
+version: !ruby/object:Gem::Version 
+  version: "0.9"
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-04 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rbook-isbn
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: This library is designed to assist with using the PACSTREAM electronic ordering service used by the book industry in  Australia.
+email: jimmy@deefa.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- COPYING
+- LICENSE
+- CHANGELOG
+files: 
+- examples/get.rb
+- examples/list.rb
+- lib/pacstream.rb
+- specs/pacstream_spec.rb
+- Rakefile
+- CHANGELOG
+- COPYING
+- README
+- LICENSE
+has_rdoc: true
+homepage: http://rbook.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --title
+- pacstream Documentation
+- --main
+- README
+- -q
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rbook
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A library for interaction with the PACSTREAM service
+test_files: 
+- specs/pacstream_spec.rb