postalmethods 1.0.0

data/spec/document_processor_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "Document Processing" do
+
+  before :each do
+    @client = PostalMethods::Client.new(PM_OPTS)
+  end
+  
+  it "should open a valid pre-opened document" do
+    @client.document = open(File.dirname(__FILE__) + '/../doc/sample.pdf')
+    @client.document.class.should == Hash
+  end
+  
+  it "should open a valid document path" do
+    @client.document = File.dirname(__FILE__) + '/../doc/sample.pdf'
+    @client.document.class.should == Hash
+  end
+  
+  it "should create a hash with the right elements" do
+    @client.document = File.dirname(__FILE__) + '/../doc/sample.pdf'
+    @client.document[:extension].should == "pdf"
+    @client.document[:bytes].length.should == 213312
+    @client.document[:name].should == "sample.pdf"
+    @client.document[:file_obj].class.should == File
+  end
+  
+  it "should return true on a valid document path" do
+    @client.document = File.dirname(__FILE__) + '/../doc/sample.pdf'
+    @client.document?.should == true
+  end
+  
+  it "should throw an exception on a false path" do
+    @doc = File.dirname(__FILE__) + '/../doc/does_not_exist.pdf'
+    lambda {@client.document = @doc}.should raise_error(Errno::ENOENT)
+  end
+  
+end

data/spec/get_letter_status_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "Get Letter Status" do
+  
+  before :each do
+    @doc = open(File.dirname(__FILE__) + '/../doc/sample.pdf')
+    @client = PostalMethods::Client.new(PM_OPTS)
+    @client.prepare!
+    sleep(10)
+  end
+  
+  it "should send a letter and get status" do
+    ## use a static known good id that has gone thru in dev mode
+    f = @client.get_letter_status(1023577)
+    f.length.should == 2
+    f.first.to_i.should == -1002
+  end
+  
+  it "should try to get status of a letter i don't have access to" do
+    lambda { @client.get_letter_status(1)}.should raise_error(PostalMethods::APIStatusCode3001Exception)
+  end
+  
+  
+  it "should send multiple letters and get their status" do
+    letters = []
+    1.upto(3) do
+      @doc = open(File.dirname(__FILE__) + '/../doc/sample.pdf')
+      @client = PostalMethods::Client.new(PM_OPTS)
+      @client.prepare!      
+      rv = @client.send_letter(@doc, "the long goodbye").sendLetterResult
+      rv.to_i.should > 0
+      letters << rv
+      #sleep(10) # api needs some time
+    end
+    
+    ret = @client.get_letter_status_multiple(letters)
+    ret.should be_an_instance_of(Array)
+    
+    # the return is an array [results, status]
+    recv_letters = ret.collect { |r| r.iD }
+  
+    recv_letters.should == letters
+  end
+
+  it "should attempt to request a multiple array of invalid letters" do
+    lambda { @client.get_letter_status_multiple([1,2,3]) }.should raise_error(PostalMethods::APIStatusCode3115Exception)
+  end
+
+  it "should request a range of letters and get their status" do
+    letters = []
+    1.upto(3) do
+      @doc = open(File.dirname(__FILE__) + '/../doc/sample.pdf')
+      @client = PostalMethods::Client.new(PM_OPTS)
+      @client.prepare!      
+      rv = @client.send_letter(@doc, "the long goodbye").sendLetterResult
+      rv.to_i.should > 0
+      letters << rv
+      #sleep(10) # api needs some time
+    end
+    
+    ret = @client.get_letter_status_range(letters.first, letters.last)
+    ret.should be_an_instance_of(Array)
+    
+    # the return is an array [results, status]
+    recv_letters = ret.collect { |r| r.iD }
+
+    recv_letters.should == letters
+  end
+
+  it "should attempt to request a range of invalid letters" do
+    lambda { @client.get_letter_status_range(1,3) }.should raise_error(PostalMethods::APIStatusCode3115Exception)
+  end
+
+end

data/spec/postalmethods_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "Client" do
+  
+  it "should instantiate a client with a username and password" do
+    c = PostalMethods::Client.new(PM_OPTS)
+    c.class.should == PostalMethods::Client
+  end
+  
+  it "should fail without a user/pass on instantiation" do
+    lambda {PostalMethods::Client.new()}.should raise_error(PostalMethods::NoCredentialsException)
+  end
+  
+  it "should create a driver client thru the factory" do
+    c = PostalMethods::Client.new(PM_OPTS)
+    c.prepare!
+    c.rpc_driver.class.should == SOAP::RPC::Driver
+  end
+  
+  it "should raise a connection error exception when the api is unreachable" do
+    c = PostalMethods::Client.new(PM_OPTS)
+    c.stubs(:api_uri).returns("http://invaliduri.tld/api_endpoint.wtf?")
+    lambda {c.prepare!}.should raise_error(PostalMethods::NoConnectionError)
+  end
+    
+end

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude "spec/*,gems/*"

data/spec/send_letter_spec.rb

@@ -0,0 +1,75 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "Send Letter" do
+  
+  before :each do
+    @doc = open(File.dirname(__FILE__) + '/../doc/sample.pdf')
+    @client = PostalMethods::Client.new(PM_OPTS)
+  end
+  
+  it "should instantiate and send a letter" do
+    @client.prepare!
+    rv = @client.send_letter(@doc, "the long goodbye")
+    rv.sendLetterResult.to_i.should > 0    
+  end
+  
+  it "should refuse to send letter before prepare" do
+    lambda {@client.send_letter(@doc, "the long goodbye")}.should raise_error(PostalMethods::NoPreparationException)
+  end  
+  
+  it "should raise the proper exception when trying to send textfile" do
+    @doc = open(File.dirname(__FILE__) + '/../README.txt')
+    @client.prepare!
+    lambda {@client.send_letter(@doc, "the long goodbye")}.should raise_error(PostalMethods::APIStatusCode3004Exception)
+  end
+  
+  it "should raise the proper exception when trying to send an empty string" do
+    @client.prepare!
+    lambda {@client.send_letter("", "the long goodbye")}.should raise_error(Errno::ENOENT)
+  end
+  
+  #it "should raise the proper exception when trying to send no description" do
+  #  @client.prepare!
+  #  lambda {@client.send_letter(@doc, nil)}.should raise_error(PostalMethods::APIStatusCode3004Exception)
+  #end
+  
+end
+
+describe "Send Letter With Address" do
+  
+  before :each do
+    @doc = open(File.dirname(__FILE__) + '/../doc/sample.pdf')
+    @addr = {:AttentionLine1 => "The Fonz", :Address1 => "Happy Days", :City => "Baja", :State => "CA", 
+             :PostalCode => "90210", :Country => "USA"}
+    @client = PostalMethods::Client.new(PM_OPTS)
+  end
+  
+  it "should instantiate and send a letter with address" do
+    @client.prepare!
+    rv = @client.send_letter_and_address(@doc, "Shark Jumping Notes", @addr)
+    rv.sendLetterAndAddressResult.to_i.should > 0
+  end
+  
+  it "should raise the proper exception when trying to send letter without valid attention line" do
+    @client.prepare!
+    addr = @addr.except(:AttentionLine1)
+    lambda {@client.send_letter_and_address(@doc, "the long goodbye", addr)}.should raise_error(PostalMethods::APIStatusCode4008Exception)
+  end
+  
+  it "should refuse to send letter before prepare" do
+    lambda {@client.send_letter_and_address(@doc, "the long goodbye", @addr)}.should raise_error(PostalMethods::NoPreparationException)
+  end  
+  
+  it "should raise the proper exception when trying to send textfile" do
+    @doc = open(File.dirname(__FILE__) + '/../README.txt')
+    @client.prepare!
+    lambda {@client.send_letter_and_address(@doc, "the long goodbye", @addr)}.should raise_error(PostalMethods::APIStatusCode3004Exception)
+  end
+  
+  it "should raise the proper exception when trying to send an empty string" do
+    @client.prepare!
+    lambda {@client.send_letter_and_address("", "the long goodbye", @addr)}.should raise_error(Errno::ENOENT)
+  end
+  
+  
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+specdoc
+--loadby
+mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+begin
+  require 'spec'
+  require 'mocha'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+  require 'mocha'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'postalmethods'
+
+$VERBOSE = nil ##silence annoying warnings from soap4r
+
+PM_OPTS = {:username => 'imajes', :password => 'rubyr00ls'}
+
+# hash hacks to make hacking in specs easier
+class Hash
+  # for excluding keys
+  def except(*exclusions)
+    self.reject { |key, value| exclusions.include? key.to_sym }
+  end
+ 
+  # for overriding keys
+  def with(overrides = {})
+    self.merge overrides
+  end
+end
+
+require "ruby-debug"

data/spec/utility_spec.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'base64'
+
+describe "Utility Methods" do
+  
+  before :each do
+    @doc = open(File.dirname(__FILE__) + '/../doc/sample.pdf')
+    @client = PostalMethods::Client.new(PM_OPTS)
+    @client.prepare!
+  end
+  
+  it "Should get a pdf returned for a file sent" do
+    rv = @client.get_pdf(1023117) ## use known static / magic file. sucks, but what can you do?
+    rv.length.should == 49606
+    f = open("test_output.pdf", "w")
+    
+    f.write(rv)
+    (`file test_output.pdf`).should == "test_output.pdf: PDF document, version 1.3\n"
+    system("rm test_output.pdf")
+  end
+  
+  it "should check for error for when there is no file yet" do
+    res = @client.send_letter(@doc, "the long goodbye")
+    id = res.sendLetterResult.to_i
+    
+    id.should > 0
+     #    
+    lambda {@client.get_pdf(id)}.should raise_error(PostalMethods::APIStatusCode3020Exception)
+  end
+  
+  it "should get the details of a letter" do
+    id = @client.send_letter(@doc, "the long goodbye").sendLetterResult.to_i
+    sleep(10) # because it's a tired little clients
+    details = @client.get_letter_details(id)
+    
+    # check the return...
+    details.should be_an_instance_of(Array)
+    
+    # and now the item...
+    details.first.should be_an_instance_of(SOAP::Mapping::Object)
+    
+    details.first.price.should == "0.00"
+    details.first.iD.to_i.should == id ## be careful not to confuse with class id
+  end
+  
+  it "should raise an error when trying to get details of an invalid letter" do
+    sleep(6) # got to wait 6 seconds...
+    lambda { @client.get_letter_details(1)}.should raise_error(PostalMethods::APIStatusCode3001Exception)
+  end
+  
+  it "should cancel delivery of a letter" do
+    id = @client.send_letter(@doc, "the long goodbye").sendLetterResult.to_i
+    rv = @client.cancel_delivery(id)
+    rv.should be_true  
+  end
+  
+  it "should raise an error when trying to cancel an invalid letter" do
+    lambda { @client.cancel_delivery(1)}.should raise_error(PostalMethods::APIStatusCode3001Exception)
+  end
+  
+  
+end

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,33 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = lambda do
+      IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: postalmethods
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- James Cox
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: Wrapper for the Postal Methods API
+email: 
+- james-at-imaj.es
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- PostInstall.txt
+- README.txt
+- Rakefile
+- config/hoe.rb
+- config/requirements.rb
+- lib/postalmethods.rb
+- lib/postalmethods/version.rb
+- lib/postalmethods/document_processor.rb
+- lib/postalmethods/exceptions.rb
+- lib/postalmethods/get_letter_status.rb
+- lib/postalmethods/send_letter.rb
+- lib/postalmethods/utility.rb
+- script/console
+- script/destroy
+- script/generate
+- setup.rb
+- spec/document_processor_spec.rb
+- spec/get_letter_status_spec.rb
+- spec/postalmethods_spec.rb
+- spec/send_letter_spec.rb
+- spec/utility_spec.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/deployment.rake
+- tasks/environment.rake
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://postalmethods.rubyforge.org
+post_install_message: |+
+  
+  For more information on working with Postal Methods, 
+  see the API reference here:
+  
+  http://www.postalmethods.com/resources/quickstart
+  
+rdoc_options: 
+- --main
+- README.txt
+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: postalmethods
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Wrapper for the Postal Methods API
+test_files: []
+