tomtaylor-viapost 0.0.2

data/History.txt

@@ -0,0 +1,7 @@
+== 0.0.2 2009-01-18
+
+* 0.0.1 was a bad build (forgot to update Manifest).
+
+== 0.0.1 2009-01-17
+
+* First release

data/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+documentation/ViaPostCustomer API v1.1.pdf
+lib/viapost.rb
+lib/viapost/interface.rb
+lib/viapost/letter.rb
+script/console
+script/destroy
+script/generate
+spec/spec.opts
+spec/spec_helper.rb
+spec/viapost/interface_spec.rb
+spec/viapost_spec.rb
+tasks/rspec.rake
+viapost.gemspec

data/README.rdoc

@@ -0,0 +1,61 @@
+= viapost
+
+* http://tomtaylor.co.uk/projects/viapost
+* http://www.viapost.com/
+
+== DESCRIPTION:
+
+A Ruby library that wraps the Viapost SOAP API, providing an easy way of sending post (you know, real letter box post) from your applications.
+
+The author, Tom Taylor, has no affiliation with Viapost other than thinking it's a useful service.
+
+== FEATURES/PROBLEMS:
+
+Supports:
+
+* Supports PDF upload
+* Fetching account balance
+* Sending of post
+
+Problems/missing:
+
+* Requires very strict address formats (Ensure 1, Road Name, not 1 Road Name, and so on. This is changing with an address cleanser in the upcoming Viapost 1.2 API).
+* No formatting of the PDF you send - you will need to position the address correctly for the address window.
+* No mail merge support.
+
+== SYNOPSIS:
+
+Coming soon.
+
+== REQUIREMENTS:
+
+* soap4r >= 1.5.8
+
+== INSTALL:
+
+* sudo gem install tomtaylor-viapost
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Tom Taylor
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,27 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/viapost'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('viapost', Viapost::VERSION) do |p|
+  p.developer('Tom Taylor', 'tom@tomtaylor.co.uk')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+      ['soap4r','>= 1.5.8'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/viapost.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+gem 'soap4r'
+require 'soap/wsdlDriver'
+require 'viapost/interface'
+require 'viapost/letter'
+
+module Viapost
+  VERSION = '0.0.2'
+end

data/lib/viapost/interface.rb

@@ -0,0 +1,77 @@
+require 'base64'
+
+module Viapost
+  
+  class Interface
+    
+    TEST_WSDL = 'http://apitest.viapost.com/viapostcustomer.asmx?WSDL'
+    LIVE_WSDL = 'http://api.viapost.com/Viapostcustomer.asmx?WSDL'
+    
+    class UnknownEnvironment < Exception; end
+    class InvalidUserOrPass < Exception; end
+    
+    attr_reader :driver, :login_token
+    
+    def initialize(user, pass, environment = :live)
+      @driver = SOAP::WSDLDriverFactory.new(wsdl(environment)).create_rpc_driver
+      @user = user
+      @pass = pass
+    end
+    
+    def balance
+      response = @driver.GetBalance(:sLoginToken => login_token)
+      response.dBalance.to_f
+    end
+    
+    def letters(query = '')
+      response = @driver.GetLetters(:sLoginToken => login_token, :sSearchDocumentName => query)
+      soap_letters = response.returnLetters.anyType
+      
+      # for some reason their API returns just the letter instead of an array if it only returns one letter
+      if soap_letters.is_a?(Array)
+        soap_letters.map { |l| Letter.build_from_soap_object(l) }
+      else
+        [Letter.build_from_soap_object(soap_letters)]
+      end
+    end
+    
+    def upload_letter(file, title, colour = false, double_sided = false)
+      file = File.open(file, 'r') if file.is_a?(String) # allow path instead of file
+      
+      response = @driver.UploadDocument(:sLoginToken => login_token, :sDocumentName => title, :DocumentData => file.read, :Colour => colour, :DoubleSided => double_sided)
+    end
+    
+    def send_letter(letter, name, address_1, address_2, address_3, address_4, address_5, postcode)
+      response = @driver.SendLetter(:sLoginToken => login_token, :myCustomerAPILetter => letter, :addressName => name, :address1 => address_1, :address2 => address_2, :address3 => address_3, :address4 => address_4, :address5 => address_5, :postcode => postcode)
+    end
+    
+    def letter(letter_id)
+      @driver.GetLetterByID(:sLoginToken => login_token, :LetterID => letter_id)
+    end
+    
+    # private
+    
+    def login_token
+      @login_response ||= @driver.SignIn(:sUserName => @user, :sPassword => @pass)
+      
+      if @login_response.signInResult == 'true' # i hate soap.
+        return @login_response.sLoginToken
+      else
+        raise InvalidUserOrPass
+      end
+    end
+    
+    def wsdl(environment)
+      case environment.to_sym
+      when :live
+        wsdl = LIVE_WSDL
+      when :test
+        wsdl = TEST_WSDL
+      else
+        raise UnknownEnvironment
+      end
+    end
+    
+  end
+  
+end

data/lib/viapost/letter.rb

@@ -0,0 +1,40 @@
+module Viapost
+
+  class Letter
+  
+    attr_reader :id, :file_name, :number_of_pages, :uploaded_at
+    
+    def LetterID
+      self.id
+    end
+    
+    def LetterFileName
+      self.file_name
+    end
+    
+    def NumberOfPages
+      self.number_of_pages
+    end
+    
+    def DateUploaded
+      self.uploaded_at
+    end
+  
+    def initialize(id, file_name, number_of_pages, uploaded_at)
+      @id = id
+      @file_name = file_name
+      @number_of_pages = number_of_pages
+      @uploaded_at = uploaded_at
+    end
+  
+    def self.build_from_soap_object(soap_object)
+      file_name = soap_object.letterFileName
+      id = soap_object.letterID.to_i
+      number_of_pages = soap_object.numberOfPages.to_i
+      uploaded_at = Time.parse(soap_object.dateUploaded)
+      return new(id, file_name, number_of_pages, uploaded_at)
+    end
+  
+  end
+  
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/viapost.rb'}"
+puts "Loading viapost gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'viapost'

data/spec/viapost/interface_spec.rb

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+

data/spec/viapost_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/tasks/rspec.rake

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

data/viapost.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name = %q{viapost}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Taylor"]
+  s.date = %q{2009-01-18}
+  s.description = %q{A Ruby library that wraps the Viapost SOAP API, providing an easy way of sending post (you know, real letter box post) from your applications.  The author, Tom Taylor, has no affiliation with Viapost other than thinking it's a useful service.}
+  s.email = ["tom@tomtaylor.co.uk"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
+  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "documentation/ViaPostCustomer API v1.1.pdf", "lib/viapost.rb", "lib/viapost/interface.rb", "lib/viapost/letter.rb", "script/console", "script/destroy", "script/generate", "spec/spec.opts", "spec/spec_helper.rb", "spec/viapost/interface_spec.rb", "spec/viapost_spec.rb", "tasks/rspec.rake", "viapost.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://tomtaylor.co.uk/projects/viapost}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{viapost}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A Ruby library that wraps the Viapost SOAP API, providing an easy way of sending post (you know, real letter box post) from your applications}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<soap4r>, [">= 1.5.8"])
+      s.add_development_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<soap4r>, [">= 1.5.8"])
+      s.add_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<soap4r>, [">= 1.5.8"])
+    s.add_dependency(%q<newgem>, [">= 1.2.3"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: tomtaylor-viapost
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Tom Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: soap4r
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A Ruby library that wraps the Viapost SOAP API, providing an easy way of sending post (you know, real letter box post) from your applications.  The author, Tom Taylor, has no affiliation with Viapost other than thinking it's a useful service.
+email: 
+- tom@tomtaylor.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- documentation/ViaPostCustomer API v1.1.pdf
+- lib/viapost.rb
+- lib/viapost/interface.rb
+- lib/viapost/letter.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/viapost/interface_spec.rb
+- spec/viapost_spec.rb
+- tasks/rspec.rake
+- viapost.gemspec
+has_rdoc: true
+homepage: http://tomtaylor.co.uk/projects/viapost
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: viapost
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Ruby library that wraps the Viapost SOAP API, providing an easy way of sending post (you know, real letter box post) from your applications
+test_files: []
+