rbook-pacstream 0.7.1 → 0.8

data/CHANGELOG

@@ -1,3 +1,6 @@
+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 don't really care.
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/testtask'
 require "rake/gempackagetask"
 require 'spec/rake/spectask'
 
-PKG_VERSION = "0.7.1"
+PKG_VERSION = "0.8"
 PKG_NAME = "rbook-pacstream"
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBYFORGE_PROJECT = 'rbook'

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/{pacstream.rb → list.rb}

@@ -7,7 +7,6 @@ require File.dirname(__FILE__) + '/../lib/rbook/pacstream'
 
 counter = 0
 
-RBook::Pacstream.get(:orders, :username => "myusername", :password => "mypass") do |order|
-  File.open("#{counter.to_s}.ord", "w") { |f| f.puts order }
-  counter += 1
+RBook::Pacstream.open(:username => "username", :password => "pass") do |pac|
+  puts pac.list(:orders).inspect
 end

data/lib/rbook/pacstream.rb

@@ -48,7 +48,7 @@ module RBook
         raise ArgumentError, 'username and password must be specified'
       end
 
-      @server   = args[0][:servername].to_s || "pacstream.tedis.com.au"
+      @server   = (args[0][:servername] || "pacstream.tedis.com.au").to_s
       @username = args[0][:username].to_s
       @password = args[0][:password].to_s
     end
@@ -85,6 +85,30 @@ module RBook
       @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
     # RBook::PacstreamConnectionError - Can't connect to server
     # RBook::PacstreamAuthError - Invalid username or password

data/specs/pacstream_spec.rb

@@ -76,6 +76,24 @@ context "The pacstream class" do
     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 = RBook::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

metadata

@@ -1,35 +1,40 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: rbook-pacstream
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
-date: 2007-10-24 00:00:00 +10:00
-summary: A library for interaction with the PACSTREAM service
-require_paths: 
-- lib
-email: jimmy@deefa.com
-homepage: http://rbook.rubyforge.org/
-rubyforge_project: rbook
-description: This library is designed to assist with using the PACSTREAM electronic ordering service used by the book industry in  Australia.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: "0.8"
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-03-26 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rbook-isbn
+  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/pacstream.rb
+- examples/list.rb
+- examples/get.rb
 - lib/rbook
 - lib/rbook/pacstream.rb
 - specs/pacstream_spec.rb
@@ -38,32 +43,35 @@ files:
 - COPYING
 - README
 - LICENSE
-test_files: 
-- specs/pacstream_spec.rb
+has_rdoc: true
+homepage: http://rbook.rubyforge.org/
+post_install_message: 
 rdoc_options: 
 - --title
 - pacstream Documentation
 - --main
 - README
 - -q
-extra_rdoc_files: 
-- README
-- COPYING
-- LICENSE
-- CHANGELOG
-executables: []
-
-extensions: []
-
+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: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rbook-isbn
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "1.0"
-    version: 
+rubyforge_project: rbook
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A library for interaction with the PACSTREAM service
+test_files: 
+- specs/pacstream_spec.rb