rpostf 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Phil Hofmann <pho@panter.ch>
+
+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/README.md

@@ -0,0 +1,27 @@
+# Rpostf
+
+Generate PostFinance (Swiss Post) URLs and vaildate responses.
+
+ * https://e-payment.postfinance.ch/
+
+## Example
+
+    pf = Rpostf.new(:login => 'your_login', :secret => 'your_secret', :local_host => 'your_domain')
+    p params = pf.params_for_post(:orderID => rand(1_000_000), :amount => 42)
+    p form = pf.form_for_post(:orderID => rand(1_000_000), :amount => 43)
+    p url = pf.url_for_get(:orderID => rand(1_000_000), :amount => 44)
+
+## Note on Patches/Pull Requests
+ 
+ * Fork the project.
+ * Make your feature addition or bug fix.
+ * Add tests for it. This is important so I don't break it in a
+   future version unintentionally.
+ * Commit, do not mess with rakefile, version, or history. (if you
+   want to have your own version, that is fine but bump version in a
+   commit by itself I can ignor e when I pull)
+ * Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Phil Hofmann <pho at panter dot ch>. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rpostf"
+    gem.summary = "PostFinance (Swiss Post) Payment Gateway API"
+    gem.description = "generate PostFinance (Swiss Post) URLs and vaildate responses"
+    gem.email = "phil@branch14.org"
+    gem.homepage = "http://github.com/branch14/rpostf"
+    gem.authors = ["Phil Hofmann"]
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rpostf #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def reverse_merge!(other_hash)
+    replace(other_hash.merge!(self))
+  end
+end

data/lib/rpostf.rb

@@ -0,0 +1,162 @@
+require 'logger'
+
+require File.join(File.dirname(__FILE__), %w(string))
+require File.join(File.dirname(__FILE__), %w(hash))
+
+# Rpostf -- Ruby POST Finance
+# a ruby library for the "Post Finance (SWISS POST)" payment gateway 
+#
+# usage:
+#
+#  pf = Rpostf.new(:login => 'asdf', :secret => 'xxxx', :local_host => 'http://bogus.net')
+#  url = pf.url_for_get(:orderID => bogus_id,
+#                       :amount => suspicious_amount)
+#
+#  # in rails something like
+#  form_tag url
+#
+#  # or as a link
+#  link_to 'Checkout', url, :method => :post
+#
+# as of EPay Docs +url+ should be used in a form with POST and iso-8859-1
+#
+class Rpostf
+
+  class MissingParameter < StandardError
+    
+    def initialize(param, logger=nil)
+      @param = param
+      @log = logger || Logger.new
+    end
+    
+    def message
+      "You have to provide #{@param}."
+    end
+    
+  end
+  
+  DEFAULT_OPTIONS = {
+    :base_url => 'https://e-payment.postfinance.ch/ncol/test/orderdirect.asp',
+    #:base_url => 'https://e-payment.postfinance.ch/ncol/test/orderstandard.asp',
+    :locale => 'de_DE',
+    :currency => 'CHF',
+    :local_port => 80,
+    :local_protocol => 'https',
+    :local_route => '/postfinance_payments'
+  }
+  
+  # mandatory keys for +options+ are
+  #  +:login+
+  #  +:secret+
+  #  +:local_host+
+  #
+  # optional keys for +options+ are
+  #  +:base_url+ default is ''
+  #  +:language+ default is 'de_DE'
+  #  +:currency+ default is 'CHF'
+  #  +:local_port+ default is 80
+  #  +:local_protocol+ default is 'https'
+  #  +:locale_route+ default is '/postfinance_payments'
+  #
+  def initialize(options={})
+    check_keys options, :login, :secret, :local_host
+    @options = options.reverse_merge!(DEFAULT_OPTIONS)
+  end
+
+  # returns a string containing a url for a GET
+  #
+  # hands options over to params_for_post
+  def url_for_get(options={})
+    options = params_for_post(options)
+
+    parameters = []
+    options.each { |p| parameters << p*'=' }
+
+    [@options[:base_url], parameters*'&'].join('?')
+  end
+
+  # returns a hash containing the params for a POST
+  #
+  # mandatory keys for +options+ are
+  #  +:orderID+
+  #  +:amount+
+  #
+  # optionsl keys for +options+ are
+  #  +:PSPID+
+  #  +:currency+
+  #  +:language+
+  #  +:accepturl+
+  #
+  def params_for_post(options={})
+    check_keys options, :orderID, :amount
+    
+    options.reverse_merge!({
+      :PSPID => @options[:login],
+      :currency => @options[:currency],
+      :language => @options[:locale],
+      :accepturl => [ @options[:local_protocol], '://',
+                      @options[:local_host], ':',
+                      @options[:local_port],
+                      @options[:local_route] ]*''
+    })
+    options[:SHASign] = generate_signature(options)
+
+    options
+  end
+
+  # returns a string containing html markup
+  # 
+  # hands options over to params_for_post
+  #
+  #  +:submit_value+ is the caption of the submit button
+  def form_for_post(options={})
+    submit_value = options.delete(:submit_value) || 'Checkout with Post Finance'
+    options = params_for_post(options)
+    (["<form action=\"#{@options[:base_url]}\" method=\"post\">"] + 
+     options.map { |n, v| hidden_field(n, v) } +
+     ["<input type=\"submit\" value=\"#{submit_value}\" />", '</form>']) * "\n"
+  end
+
+  # verifies a signature
+  def verify_signature(params)
+    keys = [:orderID, :currency, :amount, :PM, :ACCEPTANCE,
+            :STATUS, :CARDNO, :ALIAS, :PAYID, :NCERROR, :BRAND]
+    hash = (keys.map { |key| params[key] } << @options[:secret]).join('')
+    params[:SHASIGN] == hash.sha1
+  end
+  
+  private
+  
+  # generates a sha1 signature for the post finance url
+  def generate_signature(options)
+    [options[:orderID],
+     options[:amount],
+     [:currency, :login, :secret].map { |key| @options[:key]}
+    ].flatten.join('').sha1
+  end
+  
+  # ensures that the passed options hash includes all mandatory keys
+  def check_keys(*args)
+    options = args.shift
+    args.each do |key|
+      raise MissingParameter.new(key) unless options.key?(key)
+    end
+  end
+
+  # build a hidden field html tag
+  def hidden_field(name, value)
+    "<input type=\"hidden\" name=\"#{name}\" value=\"#{value}\" />"
+  end
+
+end
+
+# examples
+if $0 == __FILE__
+
+  pf = Rpostf.new(:login => 'your_login', :secret => 'your_secret', :local_host => 'your_domain')
+  p params = pf.params_for_post(:orderID => rand(1_000_000), :amount => 42)
+  puts form = pf.form_for_post(:orderID => rand(1_000_000), :amount => 43)
+  p url = pf.url_for_get(:orderID => rand(1_000_000), :amount => 44)
+
+end
+

data/lib/string.rb

@@ -0,0 +1,7 @@
+require 'digest/sha1'
+
+class String
+  def sha1
+    Digest::SHA1.hexdigest(self).upcase
+  end
+end

data/rpostf.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rpostf}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Phil Hofmann"]
+  s.date = %q{2010-08-26}
+  s.description = %q{generate PostFinance (Swiss Post) URLs and vaildate responses}
+  s.email = %q{phil@branch14.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/hash.rb",
+     "lib/rpostf.rb",
+     "lib/string.rb",
+     "rpostf.gemspec",
+     "test/helper.rb",
+     "test/test_rpostf.rb"
+  ]
+  s.homepage = %q{http://github.com/branch14/rpostf}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{PostFinance (Swiss Post) Payment Gateway API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_rpostf.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rpostf'
+
+class Test::Unit::TestCase
+end

data/test/test_rpostf.rb

@@ -0,0 +1,8 @@
+require 'helper'
+
+class TestRpostf < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    #flunk "hey buddy, you should probably rename this file and start testing for real"
+    #pass
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: rpostf
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Phil Hofmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-26 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: generate PostFinance (Swiss Post) URLs and vaildate responses
+email: phil@branch14.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/hash.rb
+- lib/rpostf.rb
+- lib/string.rb
+- rpostf.gemspec
+- test/helper.rb
+- test/test_rpostf.rb
+has_rdoc: true
+homepage: http://github.com/branch14/rpostf
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: PostFinance (Swiss Post) Payment Gateway API
+test_files: 
+- test/helper.rb
+- test/test_rpostf.rb