rbook-pacstream 0.6 → 0.7

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/testtask'
 require "rake/gempackagetask"
 require 'spec/rake/spectask'
 
-PKG_VERSION = "0.6"
+PKG_VERSION = "0.7"
 PKG_NAME = "rbook-pacstream"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBYFORGE_PROJECT = 'rbook'
@@ -24,7 +24,13 @@ task :cruise => [ :spec, :spec_report, :doc ]
 desc "Run all rspec files"
 Spec::Rake::SpecTask.new("spec") do |t|
   t.spec_files = FileList['specs/**/*.rb']
-  t.rcov = true
+  
+  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

data/lib/rbook/pacstream.rb

@@ -5,21 +5,131 @@ require 'tempfile'
 
 module RBook
 
+  # 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
   #
-  #  RBook::Pacstream.get(:orders, :username => "myusername", :password => "mypass") do |order|
+  #  pac = RBook::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
+  #  RBook::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 = { :orders => "ORD", :invoices => "ASN", :poacks => "POA" }
+    FILE_EXTENSIONS_SINGULAR = { :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].to_s || "pacstream.tedis.com.au"
+      @username = args[0][:username].to_s
+      @password = args[0][:password].to_s
+    end
 
-    # Iterate over each document waiting on the pacstream server, returning
-    # it as a string
+    # download all documents of a particular type from the pacstream server
+    #
+    #   pac.get(:orders) do |order|
+    #     puts order
+    #   end
+    #
+    # 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
+
+    # logs into to the pacstream server. Can raise several exceptions
+    # RBook::PacstreamConnectionError - Can't connect to server
+    # RBook::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    - :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
+      @ftp.quit
+    end
+
+    # Deprecated way to download files from the pacstream server
     #
     # Document types available:
     # 
@@ -31,38 +141,20 @@ module RBook
     #    puts order
     #  end
     def self.get(type = :orders, *args, &block)
-      if args[0][:username].nil? && args[0][:password].nil?
-        raise ArgumentError, 'username and password must be specified'
+      pac = RBook::Pacstream.new(args[0])
+      pac.login
+      pac.get(type) do |content|
+        yield content
       end
+      pac.quit
+    end
 
-      raise ArgumentError, 'unrecognised type' unless FILE_EXTENSIONS.include?(type.to_sym)
-
-      server = args[0][:servername] || "pacstream.tedis.com.au"
-
-      begin
-        transaction_complete = false
-        Net::FTP.open(server) do |ftp|
-          
-            file_regexp = Regexp.new(".*\.#{FILE_EXTENSIONS[type.to_sym]}$", Regexp::IGNORECASE)
-            ftp.login(args[0][:username].to_s, args[0][:password].to_s)
-            ftp.chdir("outgoing/")
-            ftp.nlst.each do |file|
-              if file.match(file_regexp)
-                tempfile = Tempfile.new("pacstream")
-                tempfile.close
-                ftp.getbinaryfile(file, tempfile.path)
-                yield File.read(tempfile.path)
-                tempfile.unlink
-              end
-            end
-            transaction_complete = true
-            #ftp.quit
-        end
-      rescue EOFError
-        raise "Connection terminated by remote server" unless transaction_complete
-      rescue Net::FTPPermError
-        raise "Error while communicating with the pacstream server"
-      end
+    # Alternative, block syntax. See notes at the top of the class for usage
+    def self.open(*args, &block)
+      pac = RBook::Pacstream.new(args[0])
+      pac.login
+      yield pac
+      pac.quit
     end
   end
 end

data/specs/pacstream_spec.rb

@@ -0,0 +1,167 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../vendor')
+
+require 'rbook/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 = RBook::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 = RBook::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 = RBook::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 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 = RBook::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")
+
+    RBook::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 = RBook::Pacstream.new(@options)
+    lambda { pac.login }.should raise_error(RBook::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 = RBook::Pacstream.new(@options)
+    lambda { pac.login }.should raise_error(RBook::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 = RBook::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 = RBook::Pacstream.new(@options)
+    lambda { pac.quit }.should raise_error(RBook::PacstreamCommandError)
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: rbook-pacstream
 version: !ruby/object:Gem::Version 
-  version: "0.6"
-date: 2007-10-10 00:00:00 +10:00
+  version: "0.7"
+date: 2007-10-24 00:00:00 +10:00
 summary: A library for interaction with the PACSTREAM service
 require_paths: 
 - lib
@@ -32,12 +32,13 @@ files:
 - examples/pacstream.rb
 - lib/rbook
 - lib/rbook/pacstream.rb
+- specs/pacstream_spec.rb
 - Rakefile
 - README
 - COPYING
 - LICENSE
-test_files: []
-
+test_files: 
+- specs/pacstream_spec.rb
 rdoc_options: 
 - --title
 - pacstream Documentation