postalmethods 1.0.1 → 1.1.0

data/spec/doc/default.rb

@@ -0,0 +1,379 @@
+require 'xsd/qname'
+
+# {PostalMethods}GetLetterStatusResult
+#   resultCode - SOAP::SOAPInt
+#   status - SOAP::SOAPInt
+#   lastUpdateTime - SOAP::SOAPDateTime
+class GetLetterStatusResult
+  attr_accessor :resultCode
+  attr_accessor :status
+  attr_accessor :lastUpdateTime
+
+  def initialize(resultCode = nil, status = nil, lastUpdateTime = nil)
+    @resultCode = resultCode
+    @status = status
+    @lastUpdateTime = lastUpdateTime
+  end
+end
+
+# {PostalMethods}GetLetterStatus_MultipleResult
+#   resultCode - SOAP::SOAPInt
+#   letterStatuses - ArrayOfLetterStatus
+class GetLetterStatus_MultipleResult
+  attr_accessor :resultCode
+  attr_accessor :letterStatuses
+
+  def initialize(resultCode = nil, letterStatuses = nil)
+    @resultCode = resultCode
+    @letterStatuses = letterStatuses
+  end
+end
+
+# {PostalMethods}ArrayOfLetterStatus
+class ArrayOfLetterStatus < ::Array
+end
+
+# {PostalMethods}LetterStatus
+#   iD - SOAP::SOAPInt
+#   status - SOAP::SOAPInt
+#   lastUpdateTime - SOAP::SOAPDateTime
+class LetterStatus
+  attr_accessor :iD
+  attr_accessor :status
+  attr_accessor :lastUpdateTime
+
+  def initialize(iD = nil, status = nil, lastUpdateTime = nil)
+    @iD = iD
+    @status = status
+    @lastUpdateTime = lastUpdateTime
+  end
+end
+
+# {PostalMethods}GetLetterStatus_RangeResult
+#   resultCode - SOAP::SOAPInt
+#   letterStatuses - ArrayOfLetterStatus
+class GetLetterStatus_RangeResult
+  attr_accessor :resultCode
+  attr_accessor :letterStatuses
+
+  def initialize(resultCode = nil, letterStatuses = nil)
+    @resultCode = resultCode
+    @letterStatuses = letterStatuses
+  end
+end
+
+# {PostalMethods}GetLetterDetailsResult
+#   resultCode - SOAP::SOAPInt
+#   iD - SOAP::SOAPInt
+#   price - SOAP::SOAPDecimal
+#   numOfSheets - SOAP::SOAPInt
+#   submitTime - SOAP::SOAPDateTime
+#   completionTime - SOAP::SOAPDateTime
+#   orientation - SOAP::SOAPString
+#   envelope - SOAP::SOAPString
+#   paper - SOAP::SOAPString
+#   printColor - SOAP::SOAPString
+#   printSides - SOAP::SOAPString
+#   nationalMailing - SOAP::SOAPString
+#   internationalMailing - SOAP::SOAPString
+class GetLetterDetailsResult
+  attr_accessor :resultCode
+  attr_accessor :iD
+  attr_accessor :price
+  attr_accessor :numOfSheets
+  attr_accessor :submitTime
+  attr_accessor :completionTime
+  attr_accessor :orientation
+  attr_accessor :envelope
+  attr_accessor :paper
+  attr_accessor :printColor
+  attr_accessor :printSides
+  attr_accessor :nationalMailing
+  attr_accessor :internationalMailing
+
+  def initialize(resultCode = nil, iD = nil, price = nil, numOfSheets = nil, submitTime = nil, completionTime = nil, orientation = nil, envelope = nil, paper = nil, printColor = nil, printSides = nil, nationalMailing = nil, internationalMailing = nil)
+    @resultCode = resultCode
+    @iD = iD
+    @price = price
+    @numOfSheets = numOfSheets
+    @submitTime = submitTime
+    @completionTime = completionTime
+    @orientation = orientation
+    @envelope = envelope
+    @paper = paper
+    @printColor = printColor
+    @printSides = printSides
+    @nationalMailing = nationalMailing
+    @internationalMailing = internationalMailing
+  end
+end
+
+# {PostalMethods}GetPDFResult
+#   resultCode - SOAP::SOAPInt
+#   fileData - SOAP::SOAPBase64
+class GetPDFResult
+  attr_accessor :resultCode
+  attr_accessor :fileData
+
+  def initialize(resultCode = nil, fileData = nil)
+    @resultCode = resultCode
+    @fileData = fileData
+  end
+end
+
+# {PostalMethods/AbstractTypes}StringArray
+class StringArray < ::Array
+end
+
+# {PostalMethods}SendLetter
+#   username - SOAP::SOAPString
+#   password - SOAP::SOAPString
+#   myDescription - SOAP::SOAPString
+#   fileExtension - SOAP::SOAPString
+#   fileBinaryData - SOAP::SOAPBase64
+class SendLetter
+  attr_accessor :username
+  attr_accessor :password
+  attr_accessor :myDescription
+  attr_accessor :fileExtension
+  attr_accessor :fileBinaryData
+
+  def initialize(username = nil, password = nil, myDescription = nil, fileExtension = nil, fileBinaryData = nil)
+    @username = username
+    @password = password
+    @myDescription = myDescription
+    @fileExtension = fileExtension
+    @fileBinaryData = fileBinaryData
+  end
+end
+
+# {PostalMethods}SendLetterResponse
+#   sendLetterResult - SOAP::SOAPInt
+class SendLetterResponse
+  attr_accessor :sendLetterResult
+
+  def initialize(sendLetterResult = nil)
+    @sendLetterResult = sendLetterResult
+  end
+end
+
+# {PostalMethods}SendLetterAndAddress
+#   username - SOAP::SOAPString
+#   password - SOAP::SOAPString
+#   myDescription - SOAP::SOAPString
+#   fileExtension - SOAP::SOAPString
+#   fileBinaryData - SOAP::SOAPBase64
+#   attentionLine1 - SOAP::SOAPString
+#   attentionLine2 - SOAP::SOAPString
+#   attentionLine3 - SOAP::SOAPString
+#   company - SOAP::SOAPString
+#   address1 - SOAP::SOAPString
+#   address2 - SOAP::SOAPString
+#   city - SOAP::SOAPString
+#   state - SOAP::SOAPString
+#   postalCode - SOAP::SOAPString
+#   country - SOAP::SOAPString
+class SendLetterAndAddress
+  attr_accessor :username
+  attr_accessor :password
+  attr_accessor :myDescription
+  attr_accessor :fileExtension
+  attr_accessor :fileBinaryData
+  attr_accessor :attentionLine1
+  attr_accessor :attentionLine2
+  attr_accessor :attentionLine3
+  attr_accessor :company
+  attr_accessor :address1
+  attr_accessor :address2
+  attr_accessor :city
+  attr_accessor :state
+  attr_accessor :postalCode
+  attr_accessor :country
+
+  def initialize(username = nil, password = nil, myDescription = nil, fileExtension = nil, fileBinaryData = nil, attentionLine1 = nil, attentionLine2 = nil, attentionLine3 = nil, company = nil, address1 = nil, address2 = nil, city = nil, state = nil, postalCode = nil, country = nil)
+    @username = username
+    @password = password
+    @myDescription = myDescription
+    @fileExtension = fileExtension
+    @fileBinaryData = fileBinaryData
+    @attentionLine1 = attentionLine1
+    @attentionLine2 = attentionLine2
+    @attentionLine3 = attentionLine3
+    @company = company
+    @address1 = address1
+    @address2 = address2
+    @city = city
+    @state = state
+    @postalCode = postalCode
+    @country = country
+  end
+end
+
+# {PostalMethods}SendLetterAndAddressResponse
+#   sendLetterAndAddressResult - SOAP::SOAPInt
+class SendLetterAndAddressResponse
+  attr_accessor :sendLetterAndAddressResult
+
+  def initialize(sendLetterAndAddressResult = nil)
+    @sendLetterAndAddressResult = sendLetterAndAddressResult
+  end
+end
+
+# {PostalMethods}GetLetterStatus
+#   username - SOAP::SOAPString
+#   password - SOAP::SOAPString
+#   iD - SOAP::SOAPInt
+class GetLetterStatus
+  attr_accessor :username
+  attr_accessor :password
+  attr_accessor :iD
+
+  def initialize(username = nil, password = nil, iD = nil)
+    @username = username
+    @password = password
+    @iD = iD
+  end
+end
+
+# {PostalMethods}GetLetterStatusResponse
+#   getLetterStatusResult - GetLetterStatusResult
+class GetLetterStatusResponse
+  attr_accessor :getLetterStatusResult
+
+  def initialize(getLetterStatusResult = nil)
+    @getLetterStatusResult = getLetterStatusResult
+  end
+end
+
+# {PostalMethods}GetLetterStatus_Multiple
+#   username - SOAP::SOAPString
+#   password - SOAP::SOAPString
+#   iD - SOAP::SOAPString
+class GetLetterStatus_Multiple
+  attr_accessor :username
+  attr_accessor :password
+  attr_accessor :iD
+
+  def initialize(username = nil, password = nil, iD = nil)
+    @username = username
+    @password = password
+    @iD = iD
+  end
+end
+
+# {PostalMethods}GetLetterStatus_MultipleResponse
+#   getLetterStatus_MultipleResult - GetLetterStatus_MultipleResult
+class GetLetterStatus_MultipleResponse
+  attr_accessor :getLetterStatus_MultipleResult
+
+  def initialize(getLetterStatus_MultipleResult = nil)
+    @getLetterStatus_MultipleResult = getLetterStatus_MultipleResult
+  end
+end
+
+# {PostalMethods}GetLetterStatus_Range
+#   username - SOAP::SOAPString
+#   password - SOAP::SOAPString
+#   minID - SOAP::SOAPInt
+#   maxID - SOAP::SOAPInt
+class GetLetterStatus_Range
+  attr_accessor :username
+  attr_accessor :password
+  attr_accessor :minID
+  attr_accessor :maxID
+
+  def initialize(username = nil, password = nil, minID = nil, maxID = nil)
+    @username = username
+    @password = password
+    @minID = minID
+    @maxID = maxID
+  end
+end
+
+# {PostalMethods}GetLetterStatus_RangeResponse
+#   getLetterStatus_RangeResult - GetLetterStatus_RangeResult
+class GetLetterStatus_RangeResponse
+  attr_accessor :getLetterStatus_RangeResult
+
+  def initialize(getLetterStatus_RangeResult = nil)
+    @getLetterStatus_RangeResult = getLetterStatus_RangeResult
+  end
+end
+
+# {PostalMethods}GetLetterDetails
+#   username - SOAP::SOAPString
+#   password - SOAP::SOAPString
+#   iD - SOAP::SOAPInt
+class GetLetterDetails
+  attr_accessor :username
+  attr_accessor :password
+  attr_accessor :iD
+
+  def initialize(username = nil, password = nil, iD = nil)
+    @username = username
+    @password = password
+    @iD = iD
+  end
+end
+
+# {PostalMethods}GetLetterDetailsResponse
+#   getLetterDetailsResult - GetLetterDetailsResult
+class GetLetterDetailsResponse
+  attr_accessor :getLetterDetailsResult
+
+  def initialize(getLetterDetailsResult = nil)
+    @getLetterDetailsResult = getLetterDetailsResult
+  end
+end
+
+# {PostalMethods}GetPDF
+#   username - SOAP::SOAPString
+#   password - SOAP::SOAPString
+#   iD - SOAP::SOAPInt
+class GetPDF
+  attr_accessor :username
+  attr_accessor :password
+  attr_accessor :iD
+
+  def initialize(username = nil, password = nil, iD = nil)
+    @username = username
+    @password = password
+    @iD = iD
+  end
+end
+
+# {PostalMethods}GetPDFResponse
+#   getPDFResult - GetPDFResult
+class GetPDFResponse
+  attr_accessor :getPDFResult
+
+  def initialize(getPDFResult = nil)
+    @getPDFResult = getPDFResult
+  end
+end
+
+# {PostalMethods}CancelDelivery
+#   username - SOAP::SOAPString
+#   password - SOAP::SOAPString
+#   iD - SOAP::SOAPInt
+class CancelDelivery
+  attr_accessor :username
+  attr_accessor :password
+  attr_accessor :iD
+
+  def initialize(username = nil, password = nil, iD = nil)
+    @username = username
+    @password = password
+    @iD = iD
+  end
+end
+
+# {PostalMethods}CancelDeliveryResponse
+#   cancelDeliveryResult - SOAP::SOAPInt
+class CancelDeliveryResponse
+  attr_accessor :cancelDeliveryResult
+
+  def initialize(cancelDeliveryResult = nil)
+    @cancelDeliveryResult = cancelDeliveryResult
+  end
+end

data/spec/doc/defaultMappingRegistry.rb

@@ -0,0 +1 @@
+require 'default.rb'

data/spec/get_letter_status_spec.rb

@@ -17,7 +17,9 @@ describe "Get Letter Status" do
   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)
+    # FIXME: this is a bad test as it doesn't really prove what we're trying to. 
+    # much better to have a different user make a new post etc..
+    lambda { @client.get_letter_status(1020000)}.should raise_error(PostalMethods::APIStatusCode3116Exception)
   end
   
   
@@ -26,7 +28,7 @@ describe "Get Letter Status" do
     1.upto(3) do
       @doc = open(File.dirname(__FILE__) + '/../spec/doc/sample.pdf')
       @client = PostalMethods::Client.new(PM_OPTS)
-      @client.prepare!      
+      @client.prepare!
       rv = @client.send_letter(@doc, "the long goodbye")
       rv.should > 0
       letters << rv

data/spec/postalmethods_spec.rb

@@ -1,26 +1,11 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
-describe "Client" do
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
   
-  it "should instantiate a client with a username and password" do
-    c = PostalMethods::Client.new(PM_OPTS)
-    c.class.should == PostalMethods::Client
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
   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/send_letter_spec.rb

@@ -31,15 +31,14 @@ describe "Send Letter" 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__) + '/../spec/doc/sample.pdf')
-    @addr = {:AttentionLine1 => "The Fonz", :Address1 => "Happy Days", :City => "Baja", :State => "CA", 
-             :PostalCode => "90210", :Country => "USA"}
+    @addr = {:AttentionLine1 => "George Washington", :Address1 => "The White House", :Address2 => "1600 Pennsylvania Ave", 
+      :City => "Washington", :State => "DC", :PostalCode => "20500", :Country => "USA"}
     @client = PostalMethods::Client.new(PM_OPTS)
   end
   

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -1,30 +1,10 @@
 begin
   require 'spec'
-  require 'mocha'
 rescue LoadError
   require 'rubygems'
+  gem 'rspec'
   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

@@ -38,11 +38,13 @@ describe "Utility Methods" do
     
     details.first.price.should == "0.00"
     details.first.iD.to_i.should == id ## be careful not to confuse with class id
+    details.last.should be_a_kind_of(String)
+    details.last.should == "Development"
   end
   
-  it "should raise an error when trying to get details of an invalid letter" do
+  it "should raise a letter does not exist (3116) 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)
+    lambda { @client.get_letter_details(1)}.should raise_error(PostalMethods::APIStatusCode3116Exception)
   end
   
   it "should cancel delivery of a letter" do
@@ -51,8 +53,8 @@ describe "Utility Methods" do
     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)
+  it "should raise a letter does not exist (3116) error when trying to cancel an invalid letter" do
+    lambda { @client.cancel_delivery(1)}.should raise_error(PostalMethods::APIStatusCode3116Exception)
   end
   
   

data/tasks/rspec.rake

@@ -19,15 +19,3 @@ 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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: postalmethods
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - James Cox
@@ -9,9 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-06 00:00:00 +01:00
+date: 2008-12-22 00:00:00 +00:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -20,11 +30,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 1.8.0
     version: 
-description: Wrapper for the Postal Methods API
+description: API wrapper library for the postal methods api.
 email: 
-- james-at-imaj.es
+- james@imaj.es
 executables: []
 
 extensions: []
@@ -34,50 +44,56 @@ extra_rdoc_files:
 - License.txt
 - Manifest.txt
 - PostInstall.txt
+- README.rdoc
 - README.txt
 files: 
 - History.txt
 - License.txt
 - Manifest.txt
 - PostInstall.txt
+- README.rdoc
 - README.txt
 - Rakefile
 - config/hoe.rb
 - config/requirements.rb
+- coverage/index.html
+- coverage/lib-postalmethods-document_processor_rb.html
+- coverage/lib-postalmethods-exceptions_rb.html
+- coverage/lib-postalmethods-get_letter_status_rb.html
+- coverage/lib-postalmethods-send_letter_rb.html
+- coverage/lib-postalmethods-utility_rb.html
+- coverage/lib-postalmethods_rb.html
 - 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
+- lib/postalmethods/version.rb
+- postalmethods.gemspec
 - script/console
 - script/destroy
 - script/generate
 - setup.rb
+- spec/doc/WSDL-Output
+- spec/doc/default.rb
+- spec/doc/defaultMappingRegistry.rb
+- spec/doc/sample.pdf
 - 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/send_letter_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- tasks/deployment.rake
-- tasks/environment.rake
+- spec/utility_spec.rb
 - 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
-  
+homepage: "Info: http://www.postalmethods.com/resources/quickstart"
+post_install_message: PostInstall.txt
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -98,6 +114,6 @@ rubyforge_project: postalmethods
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Wrapper for the Postal Methods API
+summary: API wrapper library for the postal methods api.
 test_files: []
 

data/tasks/deployment.rake

@@ -1,34 +0,0 @@
-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