ipizza 0.4.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+group :development, :test do
+  gem 'rspec', '2.2.0'
+end

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (= 2.2.0)

data/README.markdown

@@ -0,0 +1,101 @@
+Implements iPizza protocol to communicate with Estonian Banks.
+
+Usage
+=====
+
+Add gem dependency in your `Gemfile` and install the gem:
+
+    gem 'ipizza', :git => 'git://github.com/priithaamer/ipizza.git'
+
+Configuration
+=============
+
+Configuration can be made in two different ways, using `Ipizza::Config.configure` block or loading configuration properties from YAML file.
+
+Loading from YAML file:
+
+    Ipizza::Config.load_from_file('config.yml')
+
+Configuration values should be set in YAML file in **provider.attribute_value** format. See example YAML file below in "Configuration parameters" section.
+
+At any time, configuration can be modified with `Ipizza::Config.configure` block:
+
+    Ipizza::Config.configure do |c|
+      c.swedbank_service_url = 'http://foo.bar/swedbank'
+    end
+
+Configuration parameters
+------------------------
+
+    swedbank:
+      service_url: http://foo.bar/swedbank
+      return_url: http://mycompany.com/store
+      cancel_url: http://mycompany.com/cancel
+      
+      # Your private key file path. Can be specified relatively
+      # to YAML file
+      file_key: ./certificates/my_private.key
+      
+      # If your private key is protected with password,
+      # provide it here
+      key_secret: private_key_password
+      
+      # Path to bank's public key file. Can be specified
+      # relatively to YAML file
+      file_cert: ./certificates/bank_public.crt
+      snd_id: dealer
+      encoding: UTF-8
+
+Payment requests
+----------------
+
+### Building request
+
+    payment = Ipizza::Payment.new(
+      :stamp => 1, :amount => '123.34', :refnum => 1,
+      :message => 'Payment message', :currency => 'EUR'
+    )
+    request = Ipizza::Provider::Swedbank.new.payment_request(@payment)
+
+Authentication requests
+-----------------------
+
+### Building request
+
+    request = Ipizza::Provider::Swedbank.new.authentication_request
+
+### Validating response
+
+    response = Ipizza::Provider::Swedbank.new.authentication_response({'VK_PARAM_1' => 'VALUE 1', ...})
+    response.valid?
+
+Gateway specifications
+======================
+
+This library currently works with four Estonian Banks. Here are their respective interface specifications:
+
+* [Swedbank](https://www.swedbank.ee/static/pdf/business/d2d/paymentcollection/info_banklink_techspec_est.pdf)
+* [SEB](http://www.seb.ee/index/130212050201)
+* [Sampo](http://www.sampopank.ee/et/14732.html)
+* [Nordea](http://www.nordea.ee/Teenused+ärikliendile/E-lahendused/787802.html)
+
+Helpful links
+=============
+
+* [Repository](http://github.com/priithaamer/ipizza)
+* [Issue tracker](http://github.com/priithaamer/ipizza/issues)
+
+Todo
+====
+
+* Raise reasonable exception during configuration when certificates or keys cannot be loaded
+* Write ipizza-rails module:
+  * Proper Rails initialization
+  * Write Rails controller and model generator
+  * Rails helper to generate iPizza request forms
+
+Authors
+=======
+
+* Priit Haamer
+* Tarmo Talu (Thanks for the 7-3-1 algorithm)

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'ipizza'
+    
+    gemspec.summary = 'Implements iPizza protocol to communicate with Estonian Banks'
+    gemspec.description = <<-DESC
+      Simplifies generating payment requests and parsing responses from banks when using iPizza protocol.
+    DESC
+    
+    gemspec.email = 'priit@fraktal.ee'
+    gemspec.homepage = 'http://github.com/priithaamer/ipizza'
+    gemspec.authors = ['Priit Haamer']
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: gem install jeweler'
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/init.rb

@@ -0,0 +1 @@
+require 'ipizza'

data/ipizza.gemspec

@@ -0,0 +1,103 @@
+# 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{ipizza}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Priit Haamer"]
+  s.date = %q{2010-12-04}
+  s.description = %q{      Simplifies generating payment requests and parsing responses from banks when using iPizza protocol.
+}
+  s.email = %q{priit@fraktal.ee}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "Gemfile.lock",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "autotest/discover.rb",
+     "init.rb",
+     "ipizza.gemspec",
+     "lib/ipizza.rb",
+     "lib/ipizza/authentication_request.rb",
+     "lib/ipizza/authentication_response.rb",
+     "lib/ipizza/config.rb",
+     "lib/ipizza/payment.rb",
+     "lib/ipizza/payment_request.rb",
+     "lib/ipizza/payment_response.rb",
+     "lib/ipizza/provider/nordea.rb",
+     "lib/ipizza/provider/nordea/authentication_request.rb",
+     "lib/ipizza/provider/nordea/authentication_response.rb",
+     "lib/ipizza/provider/nordea/payment_request.rb",
+     "lib/ipizza/provider/nordea/payment_response.rb",
+     "lib/ipizza/provider/sampo.rb",
+     "lib/ipizza/provider/seb.rb",
+     "lib/ipizza/provider/swedbank.rb",
+     "lib/ipizza/request.rb",
+     "lib/ipizza/response.rb",
+     "lib/ipizza/util.rb",
+     "spec/certificates/bank.crt",
+     "spec/certificates/bank.csr",
+     "spec/certificates/bank.key",
+     "spec/certificates/bank.pub",
+     "spec/certificates/dealer.key",
+     "spec/certificates/dealer.pub",
+     "spec/certificates/nordea_test_priv",
+     "spec/certificates/seb_test_priv.pem",
+     "spec/certificates/seb_test_pub.crt",
+     "spec/certificates/seb_test_pub.pem",
+     "spec/config/config.yml",
+     "spec/config/plain_config.yml",
+     "spec/ipizza/authentication_response_spec.rb",
+     "spec/ipizza/config_spec.rb",
+     "spec/ipizza/provider/nordea/authentication_response_spec.rb",
+     "spec/ipizza/provider/nordea/payment_request_spec.rb",
+     "spec/ipizza/provider/nordea/payment_response_spec.rb",
+     "spec/ipizza/provider/nordea_spec.rb",
+     "spec/ipizza/provider/sampo_spec.rb",
+     "spec/ipizza/provider/seb_spec.rb",
+     "spec/ipizza/provider/swedbank_spec.rb",
+     "spec/ipizza/util_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/pizza.rb"
+  ]
+  s.homepage = %q{http://github.com/priithaamer/ipizza}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Implements iPizza protocol to communicate with Estonian Banks}
+  s.test_files = [
+    "spec/ipizza/authentication_response_spec.rb",
+     "spec/ipizza/config_spec.rb",
+     "spec/ipizza/provider/nordea/authentication_response_spec.rb",
+     "spec/ipizza/provider/nordea/payment_request_spec.rb",
+     "spec/ipizza/provider/nordea/payment_response_spec.rb",
+     "spec/ipizza/provider/nordea_spec.rb",
+     "spec/ipizza/provider/sampo_spec.rb",
+     "spec/ipizza/provider/seb_spec.rb",
+     "spec/ipizza/provider/swedbank_spec.rb",
+     "spec/ipizza/util_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/pizza.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/ipizza.rb

@@ -0,0 +1,13 @@
+require 'ipizza/config'
+require 'ipizza/util'
+require 'ipizza/payment'
+require 'ipizza/request'
+require 'ipizza/response'
+require 'ipizza/payment_request'
+require 'ipizza/payment_response'
+require 'ipizza/authentication_request'
+require 'ipizza/authentication_response'
+require 'ipizza/provider/swedbank'
+require 'ipizza/provider/seb'
+require 'ipizza/provider/sampo'
+require 'ipizza/provider/nordea'

data/lib/ipizza/authentication_request.rb

@@ -0,0 +1,4 @@
+module Ipizza
+  class AuthenticationRequest < Ipizza::Request
+  end
+end

data/lib/ipizza/authentication_response.rb

@@ -0,0 +1,24 @@
+module Ipizza
+  class AuthenticationResponse < Ipizza::Response
+    
+    def success?
+      return ['3002'].include?(@params['VK_SERVICE'])
+    end
+    
+    def valid?
+      return @valid
+    end
+
+    def authentication_info
+      @params['VK_INFO']
+    end
+    
+    def info_social_security_id
+      /ISIK:([^;.]+)/i.match(@params['VK_INFO'])[1] if @params['VK_INFO']
+    end
+    
+    def info_name
+      /NIMI:([^;.]+)/.match(@params['VK_INFO'])[1] if @params['VK_INFO']
+    end
+  end
+end

data/lib/ipizza/config.rb

@@ -0,0 +1,54 @@
+require 'yaml'
+
+module Ipizza
+  class Config
+    class << self
+
+      def load_from_file(yaml_path)
+        config = YAML::load_file(yaml_path)
+        
+        config.each do |bank, params|
+          params.each do |param, value|
+            value = normalize_file_location(yaml_path, value) if /^file_(cert|key)/ =~ param
+            
+            begin
+              self.send(:"#{bank}_#{param}=", value)
+            rescue NoMethodError; end
+          end
+        end
+      end
+      
+      def configure
+        yield self
+      end
+      
+      def method_missing(m, *args)
+        if /^(swedbank|seb|sampo|nordea)_(.*)=$/ =~ m.to_s
+          clz = Ipizza::Provider.const_get($1.capitalize)
+          if clz.respond_to?(:"#{$2}=")
+            return clz.send(:"#{$2}=", *args)
+          end
+        end
+
+        super
+      end
+      
+      private
+      
+      def normalize_file_location(yaml_path, file_path)
+        if File.exists?(file_path)
+          file_path
+        else
+          file_path = File.expand_path(File.join(File.dirname(yaml_path), file_path))
+        end
+        
+        if File.exists?(file_path)
+          file_path
+        else
+          raise "Could not load certificate from file '#{file_path}'"
+        end
+      end
+      
+    end
+  end
+end

data/lib/ipizza/payment.rb

@@ -0,0 +1,15 @@
+module Ipizza
+  class Payment
+    
+    attr_accessor :stamp, :amount, :currency, :refnum, :receiver_account, :receiver_name, :sender_account, :sender_name, :message, :transaction_id
+    
+    def initialize(attribs = {})
+      attribs.each do |key, value|
+        if self.respond_to?("#{key.to_s}=".to_sym)
+          self.send("#{key.to_s}=".to_sym, value)
+        end
+      end
+    end
+
+  end
+end

data/lib/ipizza/payment_request.rb

@@ -0,0 +1,4 @@
+module Ipizza
+  class PaymentRequest < Ipizza::Request
+  end
+end

data/lib/ipizza/payment_response.rb

@@ -0,0 +1,23 @@
+class Ipizza::PaymentResponse < Ipizza::Response
+
+  def success?
+    return ['1101'].include?(@params['VK_SERVICE'])
+  end
+  
+  def valid?
+    return @valid
+  end
+  
+  def automatic_message?
+    @params['VK_AUTO'] and @params['VK_AUTO'] == 'Y'
+  end
+  
+  def payment_info
+    @payment_info ||= Ipizza::Payment.new(
+      :stamp => @params['VK_STAMP'], :amount => @params['VK_AMOUNT'], :currency => @params['VK_CURR'],
+      :refnum => @params['VK_REF'], :message => @params['VK_MSG'], :transaction_id => @params['VK_T_NO'],
+      :receiver_account => @params['VK_REC_ACC'], :receiver_name => @params['VK_REC_NAME'],
+      :sender_account => @params['VK_SND_ACC'], :sender_name => @params['VK_SND_NAME']
+    )
+  end
+end

data/lib/ipizza/provider/nordea.rb

@@ -0,0 +1,77 @@
+module Ipizza::Provider
+  
+  # TODO: configure whether use sha-1 or md5 for signing and verification
+  class Nordea
+    
+    require 'ipizza/provider/nordea/payment_request'
+    require 'ipizza/provider/nordea/payment_response'
+    require 'ipizza/provider/nordea/authentication_request'
+    require 'ipizza/provider/nordea/authentication_response'
+        
+    class << self
+      attr_accessor :payments_service_url, :payments_return_url, :payments_reject_url, :payments_cancel_url
+      attr_accessor :payments_rcv_id, :payments_language
+      attr_accessor :auth_service_url, :auth_return_url, :auth_reject_url, :auth_cancel_url, :auth_language
+      attr_accessor :auth_rcv_id
+      attr_accessor :file_key, :rcv_account, :rcv_name, :confirm, :keyvers
+    end
+    
+    def payment_request(payment, service = 1002)
+      req = Ipizza::Provider::Nordea::PaymentRequest.new
+      req.service_url = self.class.payments_service_url
+      req.params = {
+        'VERSION' => '0003',
+        'STAMP' => payment.stamp,
+        'RCV_ID' => self.class.payments_rcv_id,
+        # 'RCV_ACCOUNT' => self.rcv_account,
+        # 'RCV_NAME' => self.rcv_name,
+        'LANGUAGE' => self.class.payments_language,
+        'AMOUNT' => sprintf('%.2f', payment.amount),
+        'REF' => Ipizza::Util.sign_731(payment.refnum),
+        'DATE' => 'EXPRESS',
+        'MSG' => payment.message,
+        'CONFIRM' => self.class.confirm,
+        'CUR' => payment.currency,
+        'KEYVERS' => self.class.keyvers,
+        'REJECT' => self.class.payments_reject_url,
+        'RETURN' => self.class.payments_return_url,
+        'CANCEL' => self.class.payments_cancel_url
+      }
+      
+      req.sign(self.class.file_key)
+      req
+    end
+    
+    def payment_response(params)
+      response = Ipizza::Provider::Nordea::PaymentResponse.new(params)
+      response.verify(self.class.key)
+      return response
+    end
+    
+    def authentication_request
+      req = Ipizza::Provider::Nordea::AuthenticationRequest.new
+      req.service_url = self.class.auth_service_url
+      req.params = {
+        'ACTION_ID' => '701',
+        'VERS' => '0002',
+        'RCVID' => self.class.auth_rcv_id,
+        'LANGCODE' => self.class.auth_language,
+        'STAMP' => Time.now.strftime('%Y%m%d%H%M%S'),
+        'IDTYPE' => '02',
+        'KEYVERS' => self.class.keyvers,
+        'RETLINK' => self.class.auth_return_url,
+        'CANLINK' => self.class.auth_cancel_url,
+        'REJLINK' => self.class.auth_reject_url,
+        'ALG' => '01'
+      }
+      req.sign(self.class.file_key)
+      req
+    end
+    
+    def authentication_response(params)
+      response = Ipizza::Provider::Nordea::AuthenticationResponse.new(params)
+      response.verify(self.class.file_key)
+      return response
+    end
+  end
+end