spree_omnikassa 0.4.2

data/app/models/spree/omnikassa_payment_request.rb

@@ -0,0 +1,89 @@
+module Spree
+  # OmnikassaPaymentRequest deals with the data
+  # for the actual request to and fro Omnikassa.
+  #
+  # Not a persistent object: will not interact or
+  # get saved in the database.
+  #
+  # It requires amount and order_id to be passed in
+  # on creation.
+  class OmnikassaPaymentRequest
+    include Spree::Core::Engine.routes.url_helpers
+    attr_accessor :amount, :order_id, :payment_method
+
+    def initialize(amount, transaction_reference, response_code = nil)
+      @payment_method = Spree::PaymentMethod::Omnikassa.fetch_payment_method
+      if transaction_reference.to_s.include? merchant_id
+        @amount = amount
+        @order_id = transaction_reference.to_s.match(merchant_id).post_match
+        @response_code = response_code
+      else
+        raise "transactionReference cannot be parsed"
+      end
+    end
+
+    # Generates datastring according to omnikassa
+    # requirements §9. name=value|name=value.
+    def data
+      "amount=#{amount}|orderId=#{order_id}|currencyCode=#{currency_code}|merchantId=#{merchant_id}|normalReturnUrl=#{normal_return_url}|automaticResponseUrl=#{automatic_response_url}|transactionReference=#{transaction_reference}|keyVersion=#{key_version}"
+    end
+
+    def interface_version
+      "HP_1.0"
+    end
+
+    def seal
+      ::Digest::SHA2.hexdigest(data + @payment_method.preferred_secret_key)
+    end
+
+    # to_s magic method simply wraps the data string generator.
+    def to_s
+      data
+    end
+
+    def self.build_transaction_reference order_id
+      @payment_method ||= Spree::PaymentMethod::Omnikassa.fetch_payment_method
+      @payment_method.preferred_merchant_id + order_id.to_s
+    end
+
+    private
+    # @TODO implement size and format validation acc to §9.2.
+
+    def amount
+      (@amount * 100).to_i
+    end
+
+    def order_id
+      @order_id
+    end
+
+    # @TODO implement currency lookup from locales and map to table in §9.3.
+    def currency_code *args
+      978 #hardcoded to Euro.
+    end
+
+    def merchant_id
+      @payment_method.preferred_merchant_id
+    end
+
+    def normal_return_url
+      return_url_for_action "homecoming"
+    end
+
+    def automatic_response_url
+      return_url_for_action "reply"
+    end
+
+    def return_url_for_action action
+      url_for(:controller => 'spree/omnikassa_payments', :action => action, :host => Spree::Config.preferred_site_url)
+    end
+
+    def transaction_reference
+      Spree::OmnikassaPaymentRequest.build_transaction_reference order_id
+    end
+
+    def key_version
+      @payment_method.preferred_key_version
+    end
+  end
+end

data/app/models/spree/omnikassa_payment_response.rb

@@ -0,0 +1,129 @@
+module Spree
+  class OmnikassaPaymentResponse
+    attr_accessor :data
+    attr_reader :seal, :attributes, :payment_method
+
+    def initialize seal, data
+      @payment_method = Spree::PaymentMethod::Omnikassa.fetch_payment_method
+      @seal = seal
+      @data = data
+      @attributes = to_h
+    end
+
+    def valid?
+      return false unless @seal == ::Digest::SHA2.hexdigest(@data + @payment_method.preferred_secret_key)
+
+      required_attributes.each do |required_attribute|
+        return false unless @attributes.has_key? required_attribute.underscore.to_sym
+      end
+
+      true
+    end
+
+    # Finds a payment with provided parameters trough activeRecord.
+    def payment
+      Spree::Payment.find(:first, :conditions => {
+        :payment_method_id => @payment_method.id,
+        :order_id => @attributes[:order_id]} ) || raise(ActiveRecord::RecordNotFound)
+    end
+
+    # Finds the order trough ActiveRecord
+    def order
+      Spree::Order.find(@attributes[:order_id].to_i)
+    end
+
+    # Level can be :success, :pending, :cancelled or :failed
+    def response_level
+      response_codes.each do |level, codes|
+        if codes.include?(@attributes[:response_code].to_i)
+          return level
+        end
+      end
+
+      nil
+    end
+
+    private
+    def to_h
+      h = Hash.new
+      @data.split("|").each do |s|
+        k,v = s.split("=")
+        key = k.underscore
+        preparator = "prepare_#{key}"
+        if self.respond_to? preparator, true
+          v = self.send(preparator, v)
+        end
+        h[key.to_sym] = v if valid_attributes.include? k
+      end
+      h
+    end
+
+    # Callback for the to_h.
+    # Converts the amount to BigDecimal and from cents to currency.
+    def prepare_amount amount
+      BigDecimal.new(amount)/100
+    end
+
+    # As per "Tabel 5: Gegevenswoordenboek - beschrijving velden"
+    # from Rabo_OmniKassa_Integratiehandleiding_v200.pdf
+    def valid_attributes
+      %w[
+        amount
+        authorisationId
+        automaticResponseUrl
+        captureDay
+        captureMode
+        complementaryCode
+        complementaryInfo
+        currencyCode
+        customerLanguage
+        expirationdate
+        keyVersion
+        maskedPan
+        merchantId
+        normalReturnUrl
+        orderId
+        paymentMeanBrand
+        paymentMeanBrandList
+        paymentMeanType
+        responseCode
+        transactionDateTime
+        transactionReference
+      ]
+    end
+
+    # attributes required for working of the class.
+    def required_attributes
+      %w[
+        amount
+        transactionReference
+        orderId
+        responseCode
+      ]
+    end
+
+    def response_codes
+      {
+        :success => [00],
+        :pending => [
+          90,
+          99],
+        :cancelled => [
+          14, #invalid CSC or CVV
+          17, #cancelled by user
+          75], #number attempts to enter cardnumer exceeded.
+        :failed => [
+          02,
+          03,
+          05,
+          12,
+          30,
+          34,
+          40,
+          63,
+          94,
+          97]
+      }
+    end
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,33 @@
+Spree::Order.class_eval do
+  # StateMachine::Machine.ignore_method_conflicts = true
+  # Spree::Order.state_machines[:state] = StateMachine::Machine.new(Spree::Order, :initial => 'cart', :use_transactions => false)  do
+  #   event :next do
+  #     transition :from => 'cart',     :to => 'address'
+  #     transition :from => 'address',  :to => 'delivery'
+  #     transition :from => 'delivery', :to => 'complete'
+  #     transition :from => 'confirm',  :to => 'complete'
+  #   end
+
+  #   event :cancel do
+  #     transition :to => 'canceled', :if => :allow_cancel?
+  #   end
+  #   event :return do
+  #     transition :to => 'returned', :from => 'awaiting_return'
+  #   end
+  #   event :resume do
+  #     transition :to => 'resumed', :from => 'canceled', :if => :allow_resume?
+  #   end
+  #   event :authorize_return do
+  #     transition :to => 'awaiting_return'
+  #   end
+
+  #   before_transition :to => ['delivery'] do |order|
+  #     order.shipments.each { |s| s.destroy unless s.shipping_method.available_to_order?(order) }
+  #   end
+
+  #   after_transition :to => 'complete', :do => :finalize!
+  #   after_transition :to => 'delivery', :do => :create_tax_charge!
+  #   after_transition :to => 'resumed',  :do => :after_resume
+  #   after_transition :to => 'canceled', :do => :after_cancel
+  # end
+end

data/app/models/spree/payment_method/omnikassa.rb

@@ -0,0 +1,39 @@
+module Spree
+  class PaymentMethod::Omnikassa < PaymentMethod
+    preference :merchant_id, :string,  :default => "002020000000001"
+    preference :key_version, :integer, :default => 1
+    preference :secret_key,  :string,  :default => "002020000000001_KEY1"
+
+    def actions
+      %w{capture}
+    end
+
+    def can_capture?(payment)
+      ['checkout', 'pending'].include?(payment.state)
+    end
+
+    def capture(payment)
+      #payments with state "checkout" must be moved into state "pending" first:
+      payment.update_attribute(:state, "pending") if payment.state == "checkout"
+      payment.complete
+      true
+    end
+
+    def source_required?
+      false
+    end
+
+    def url
+      if self.environment == "production"
+        "https://payment-webinit.omnikassa.rabobank.nl/paymentServlet"
+      else
+        "https://payment-webinit.simu.omnikassa.rabobank.nl/paymentServlet"
+      end
+    end
+
+    def self.fetch_payment_method
+      name = "Omnikassa"
+      Spree::PaymentMethod.find(:first, :conditions => [ "lower(name) = ?", name.downcase ]) || raise(ActiveRecord::RecordNotFound)
+    end
+  end
+end

data/app/views/spree/checkout/omnikassa_edit.html.erb

@@ -0,0 +1,36 @@
+<% content_for :head do %>
+  <%= javascript_include_tag states_path %>
+<% end %>
+<div id="checkout" data-hook>
+  <%= render :partial => 'spree/shared/error_messages', :locals => { :target => @order } %>
+
+  <h1 data-hook="checkout_title"><%= t(:checkout) %></h1>
+  <ul id="checkout-steps-<%= @order.state %>" class="breadcrumbs progress-steps">
+    <% checkout_progress_states.each do |state| %>
+      <li class="<%= state.classes.join(" ") %>">
+        <%= state.text %>
+      </li>
+    <% end %>
+  </ul>
+
+  <%= form_tag(@payment_request.payment_method.url, :method => :post) do %>
+  <div class="row" data-hook="checkout_content">
+    <div class="six columns" data-hook="checkout_form_wrapper">
+        <p><%= t(:payment_options) %></p>
+        <div data-hook="checkout_payment_step">
+          <%= image_submit_tag("payment_logos.png") %>
+          <p class="note"><%= t(:payment_goes_offsite) %></p>
+          <%= hidden_field_tag "Data", @payment_request.data %>
+          <%= hidden_field_tag "InterfaceVersion", @payment_request.interface_version %>
+          <%= hidden_field_tag "Seal", @payment_request.seal %>
+          <div data-hook="coupon_code_field" data-hook></div>
+        </div>
+      </div>
+      <div class="six columns">
+        <%= render :partial => 'summary', :locals => { :order => @order } %>
+        <%= submit_tag t(:save_and_continue), :class => 'continue button fullwidth' %>
+      </div>
+    </div>
+  </div>
+  <% end %>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.routes.prepend do
+# SpreeOmnikassa::Engine.routes.draw do
+  post 'omnikassa_payments/homecoming', :to => 'omnikassa_payments#homecoming'
+  post 'omnikassa_payments/reply', :to => 'omnikassa_payments#reply'
+end

data/lib/generators/spree_omnikassa/install/install_generator.rb

@@ -0,0 +1,29 @@
+module SpreeOmnikassa
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def add_javascripts
+        append_file "app/assets/javascripts/store/all.js", "//= require store/spree_omnikassa\n"
+        append_file "app/assets/javascripts/admin/all.js", "//= require admin/spree_omnikassa\n"
+      end
+
+      def add_stylesheets
+        inject_into_file "app/assets/stylesheets/store/all.css", " *= require store/spree_omnikassa\n", :before => /\*\//, :verbose => true
+        inject_into_file "app/assets/stylesheets/admin/all.css", " *= require admin/spree_omnikassa\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_omnikassa'
+      end
+
+      def run_migrations
+         res = ask "Would you like to run the migrations now? [Y/n]"
+         if res == "" || res.downcase == "y"
+           run 'bundle exec rake db:migrate'
+         else
+           puts "Skiping rake db:migrate, don't forget to run it!"
+         end
+      end
+    end
+  end
+end

data/lib/spree_omnikassa.rb

@@ -0,0 +1,26 @@
+require 'spree_core'
+
+module SpreeOmnikassa
+  class Engine < Rails::Engine
+    engine_name 'spree_omnikassa'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+
+    initializer "spree.register.payment_methods" do |app|
+      app.config.spree.payment_methods << Spree::PaymentMethod::Omnikassa
+    end
+  end
+end

data/script/rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)

data/spec/controllers/spree/checkout_controller_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Spree::CheckoutController do
+  before(:each) do
+    @pm = Spree::PaymentMethod::Omnikassa.new(:name => "Omnikassa", :environment => "test")
+    @pm.save
+    @pm.preferred_merchant_id = @merchant_id
+    @pm.preferred_key_version = @key_version
+    @pm.preferred_secret_key = @secret_key
+    @routes = Spree::Core::Engine.routes  # render_views
+  end
+  let(:order) { mock_model(Spree::Order,
+                           :checkout_allowed? => true,
+                           :completed? => false,
+                           :update_attributes => true,
+                           :payment? => false,
+                           :insufficient_stock_lines => [],
+                           :coupon_code => nil,
+                           :state => "payment",
+                           :total => BigDecimal("123.45"),
+                           :payments => []).as_null_object }
+  before { controller.stub :current_order => order, :current_user => Spree::User.anonymous! }
+
+  it 'should show omnikassa form on payment' do
+    get :edit, {:state => 'payment'}
+    response.should render_template('spree/checkout/omnikassa_edit')
+  end
+end

data/spec/controllers/spree/omnikassa_payments_controller_spec.rb

@@ -0,0 +1,198 @@
+require "spec_helper"
+
+describe Spree::OmnikassaPaymentsController do
+
+  before(:each) do
+    @routes = Spree::Core::Engine.routes
+
+    @merchant_id = "123abc"
+    @key_version = "1"
+    @secret_key = "002020000000001_KEY1"
+
+    @pm = Spree::PaymentMethod::Omnikassa.new(:name => "Omnikassa", :environment => "test")
+    @pm.save
+    @pm.preferred_merchant_id = @merchant_id
+    @pm.preferred_key_version = @key_version
+    @pm.preferred_secret_key = @secret_key
+
+    Spree::Order.stub(:create_user)
+    Spree::Order.any_instance.stub(:payment_required?).and_return(true)
+    @order = Spree::Order.new(:email => "foo@example.com", :state => "delivery")
+    @order.save!
+
+    @data = "amount=24900|captureDay=0|captureMode=AUTHOR_CAPTURE|currencyCode=978|merchantId=002020000000001|orderId=#{@order.id}|transactionDateTime=2012-04-25T14:41:01+02:00|transactionReference=0020200000000011028|keyVersion=1|authorisationId=0020000006791167|paymentMeanBrand=IDEAL|paymentMeanType=CREDIT_TRANSFER|responseCode=00"
+    @seal = ::Digest::SHA2.hexdigest(@data + @secret_key)
+
+    @params = {
+      "InterfaceVersion"  => "HP_1.0",
+      "Data"              => @data,
+      "Encode"            => "",
+      "Seal"              => @seal
+    }
+    @payment_response = Spree::OmnikassaPaymentResponse.new(@params['Seal'], @params['Data'])
+    @payment = Spree::Payment.new(
+      :amount => @payment_response.attributes[:amount], 
+      :payment_method_id => 200123
+    )
+    @payment.order_id = @payment_response.attributes[:order_id]
+    @payment.id = 1234
+
+    Spree::Payment.stub(:new).and_return(@payment)
+
+    Spree::OmnikassaPaymentResponse.any_instance.stub(:payment).and_return(@payment)
+  end
+
+  response_args = %w[
+   Data
+   Seal
+  ]
+
+  response_codes = {
+    :success => [00],
+    :pending => [
+      90,
+      99],
+    :cancelled => [
+      14, #invalid CSC or CVV
+      17, #cancelled by user
+      75], #number attempts to enter cardnumer exceeded.
+    :failed => [
+      02,
+      03,
+      05,
+      12,
+      30,
+      34,
+      40,
+      63,
+      94,
+      97]
+  }
+
+  describe "#homecoming" do
+    it 'should redirect to root_url' do
+      post :homecoming, @params
+      response.should redirect_to(root_url)
+    end
+
+    describe "fields" do
+      describe "success" do
+        before :each do
+          Spree::OmnikassaPaymentResponse.any_instance.stub(:response_level).and_return(:success)
+        end
+        it 'should set a flash' do
+          post :homecoming, @params
+          flash[:info].should_not be_nil
+          flash[:info].downcase.should match /success/
+        end
+      end
+    end
+
+    it 'should remove order_id from session' do
+      session[:order_id] = 123
+      post :homecoming, @params
+      session[:order_id].should be_nil
+    end
+  end
+
+  describe '#reply' do
+    it 'should handle a post' do
+      post :reply, @params
+      response.status.should == 200
+    end
+
+    response_args.each do |field|
+      it "should recieve param #{field}" do
+        post :reply, @params
+        controller.params[field].should_not be_nil
+      end
+    end #describe fields
+
+    describe 'success (00)' do
+      before :each do
+        Spree::OmnikassaPaymentResponse.any_instance.stub(:response_level).and_return(:success)
+      end
+
+      it 'should set payment state to completed' do
+        post :reply, @params
+        @payment.state.should == "completed"
+      end
+      it 'should log the response with level :info' do
+        Rails.logger.should_receive(:info).with( /OmnikassaPaymentResponse posted: payment: .*; params: .*/ )
+        post :reply, @params
+      end
+      it 'should set the order state to completed' do
+        post :reply, @params
+        @payment_response.order.state.should == "complete"
+      end
+    end
+    describe "pending (#{response_codes[:pending].join(',')})" do
+      before :each do
+        Spree::OmnikassaPaymentResponse.any_instance.stub(:response_level).and_return(:pending)
+      end
+
+      it 'should set payment state to pending' do
+        post :reply, @params
+        @payment.state == "pending"
+      end
+      it 'should log the response with level :info' do
+        Rails.logger.should_receive(:info).with( /OmnikassaPaymentResponse posted: payment: .*; params: .*/ )
+        post :reply, @params
+      end
+      it 'should set the order state to payment' do
+        post :reply, @params
+        @payment_response.order.state.should == "payment"
+      end
+    end
+    describe "cancelled (#{response_codes[:cancelled].join(',')})" do
+      before :each do
+        Spree::OmnikassaPaymentResponse.any_instance.stub(:response_level).and_return(:cancelled)
+      end
+      it 'should set payment state to failed' do
+        post :reply, @params
+        @payment.state == "failed"
+      end
+      it 'should log the response with level :info' do
+        Rails.logger.should_receive(:info).with( /OmnikassaPaymentResponse posted: payment: .*; params: .*/ )
+        post :reply, @params
+      end
+      it 'should set the order state to cancelled' do
+        Spree::Order.any_instance.should_receive(:cancel)
+        post :reply, @params
+      end
+    end
+    describe "failed (#{response_codes[:failed].join(',')})" do
+      before :each do
+        Spree::OmnikassaPaymentResponse.any_instance.stub(:response_level).and_return(:failed)
+      end
+      it 'should set payment state to failed' do
+        post :reply, @params
+        @payment.state == "failed"
+      end
+      it 'should log the response with level :error' do
+        Rails.logger.should_receive(:error).with( /OmnikassaPaymentResponse posted: payment: .*; params: .*/ )
+        post :reply, @params
+      end
+      it 'should set the order state to cancelled' do
+        Spree::Order.any_instance.should_receive(:cancel)
+        post :reply, @params
+      end
+    end
+
+    it 'should add a payment to order if not exists' do
+      @payment.started_processing!
+      Spree::OmnikassaPaymentsController.any_instance.should_receive(:add_payment_if_not_exists)
+      post :reply, @params
+    end
+  end
+end
+
+=begin
+Spree Payment states from http://guides.spreecommerce.com/payments.html#payment
+checkout 	Checkout has not been completed
+processing 	The payment is being processed (temporary – intended to prevent double submission)
+pending 	The payment has been processed but not yet complete (ex. authorized but not captured)
+completed 	The payment is completed – only payments in this state count against the order total
+failed 	The payment was rejected (ex. credit card was declined)
+void 	The payment should not be counted against the order
+=end