spree_ideal 2.4.0

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,21 @@
+Spree::Order.class_eval do
+
+	def last_payment_method
+		return nil if last_payment.blank?
+		return last_payment.payment_method
+	end
+
+	def last_payment
+		return nil if payments.blank?
+		return payments.last
+	end
+
+  def ideal_ref_number
+		if last_payment_method.present?
+		  "#{number}"
+		else
+			number
+		end
+	end
+
+end

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

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+module Spree
+  class PaymentMethod::Ideal < PaymentMethod::Check
+    preference :abn_url, :string, :default => "https://internetkassa.abnamro.nl/ncol/test/orderstandard.asp"
+    preference :pspid, :string, :default => ""
+    preference :accept_url, :string, :default => ""
+    preference :decline_url, :string, :default => ""
+    preference :exception_url, :string, :default => ""
+    preference :cancel_url, :string, :default => ""
+    preference :sha_in_pass_phrase, :string, :default => ""
+    preference :sha_out_pass_phrase, :string, :default => ""
+    preference :sha_algorithm, :string, :default => "SHA-1"
+    preference :shop_base_url, :string, :default => ""
+  end
+end

data/app/models/spree/url_factory.rb

@@ -0,0 +1,21 @@
+class Spree::UrlFactory
+  def self.create_ideal_checkout_url_from_payment(order, ideal_payment_settings, hash, locale)
+
+    total = (order.total * 100).to_i # Convert according to
+
+    language = Spree::LocaleHelper.format_locale(locale)
+
+    url = ideal_payment_settings.preferred_abn_url + ""\
+        "?PSPID=" + ideal_payment_settings.preferred_pspid + ""\
+        "&ORDERID=" + order.number.to_s + ""\
+        "&AMOUNT=" + total.to_s + "" \
+        "&CURRENCY=" + Spree::Config.currency.to_s + "" \
+        "&LANGUAGE=" + language + ""\
+        "&SHASIGN=" + hash + ""\
+        "&ACCEPTURL=" + ideal_payment_settings.preferred_accept_url + ""\
+        "&DECLINEURL=" + ideal_payment_settings.preferred_decline_url + ""\
+        "&EXCEPTIONURL=" + ideal_payment_settings.preferred_exception_url + ""\
+        "&CANCELURL=" + ideal_payment_settings.preferred_cancel_url + ""\
+        "&BACKURL=" + ideal_payment_settings.preferred_shop_base_url + "/orders/#{order.number}"
+  end
+end

data/app/services/spree/ideal_service.rb

@@ -0,0 +1,33 @@
+require 'httparty'
+
+module Spree
+  class IdealService
+
+    include Singleton
+
+    # make the initialization request
+    def initial_request order, ref_number=nil
+      init_data_by_order(order) # Some Validation
+      # Security Validations
+      raise I18n.t("ideal.no_sha_in_passphrase") if @order.last_payment.payment_method.preferred_sha_in_pass_phrase.blank?
+      raise I18n.t("ideal.no_sha_out_passphrase") if @order.last_payment.payment_method.preferred_sha_out_pass_phrase.blank?
+      raise I18n.t("ideal.invalid_hash_algorithm") unless ["SHA-1", "SHA-256", "SHA-512"].include?(@order.last_payment.payment_method.preferred_sha_algorithm)
+
+      # Hash
+      hash = Spree::HashFactory.create_hash(order, order.last_payment.payment_method, I18n.locale).upcase
+      order.last_payment.update_attribute(:ideal_hash, hash)
+      order.save!
+    end
+
+    private
+
+    def init_data_by_order(order)
+      raise I18n.t("ideal.no_order_given") if order.blank?
+      @order = order
+
+      raise I18n.t("ideal.order_has_no_payment") if @order.last_payment.blank?
+      raise I18n.t("ideal.order_has_no_payment_method") if @order.last_payment_method.blank?
+      raise I18n.t("ideal.orders_payment_method_is_not_ideal") unless @order.last_payment_method.kind_of? Spree::PaymentMethod::Ideal
+    end
+  end
+end

data/app/views/spree/admin/payments/source_forms/_ideal.html.erb

@@ -0,0 +1 @@
+

data/app/views/spree/admin/payments/source_views/_ideal.html.erb

@@ -0,0 +1,2 @@
+<h4><%= I18n.t("ideal.transactionmsgs") %> <%= payment.ideal_transaction %>: </h4>
+<p>Log: <%= simple_format(payment.ideal_log) %></p>

data/app/views/spree/checkout/payment/_ideal.html.erb

@@ -0,0 +1,6 @@
+<div class="ideal">
+  <p><%= I18n.t("ideal.name") %><p>
+  <%= image_tag "http://www.ideal.nl/cms/themes/ideal_nl/img/ideal_logo.png" %>
+  <p><%= I18n.t("ideal.desc") %></p>
+  <p>&nbsp;</p>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,24 @@
+de:
+  ideal:
+    name: "iDEAL"
+    desc: "Use iDEAL to pay with your Bank Account"
+    completed_successfully: "iDEAL payment processed successfully"
+    canceled: "iDEAL payment canceled"
+    payment_not_found: "payment data for iDEAL payment could not be found"
+    order_not_found: "order for iDEAL payment could not be found"
+    no_payment_given: "no payment given"
+    no_payment_method_given: "no payment method given"
+    wrong_payment_method_given: "wrong payment method given"
+    no_order_given: "no order given"
+    order_has_no_payment: "order has no payment"
+    order_has_no_payment_method: "order has no payment method"
+    orders_payment_method_is_not_ideal: "orders payment method is not iDEAL payment"
+    transactionmsgs: "Transactions for iDEAL Transaction-ID"
+    order_invalid_state: "The order state is invalid to carry out this step"
+    order_invalid_setup: "The setup of iDEAL is invalid. Please get in touch with the site administrator"
+    security_error: "A security issue occurred. Please get in touch with the site administrator"
+    decline: "The payment was declined"
+    exception: "An Exception Occurred when updating the payment"
+    no_sha_in_passphrase: "The site administrator did not set security settings correctly"
+    no_sha_out_passphrase: "The site administrator did not set security settings correctly"
+    invalid_hash_algorithm: "The site administrator did not set security settings correctly"

data/config/routes.rb

@@ -0,0 +1,6 @@
+Spree::Core::Engine.routes.draw do
+  get '/ideal/accept', :to => 'ideal#success'
+  get '/ideal/decline', :to => 'ideal#decline'
+  get '/ideal/exception', :to => 'ideal#exception'
+  get '/ideal/cancel', :to => 'ideal#cancel'
+end

data/db/migrate/20150505204200_add_ideal_data_to_payments.rb

@@ -0,0 +1,9 @@
+class AddIdealDataToPayments < ActiveRecord::Migration
+
+  def change
+    add_column :spree_payments, :ideal_hash, :string
+    add_column :spree_payments, :ideal_transaction, :string
+    add_column :spree_payments, :ideal_log, :string
+  end
+
+end

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

@@ -0,0 +1,27 @@
+module SpreeIdeal
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+      end
+
+      def add_stylesheets
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_ideal'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_ideal.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_ideal/engine'

data/lib/spree_ideal/engine.rb

@@ -0,0 +1,26 @@
+module SpreeIdeal
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_ideal'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    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_ideal.register.payment_methods", :after => 'spree.register.payment_methods' do |app|
+      app.config.spree.payment_methods += [Spree::PaymentMethod::Ideal]
+		end
+
+  end
+end

data/lib/spree_ideal/factories.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+
+  factory :ideal, class: Spree::PaymentMethod::Ideal do
+		name "iDEAL payment"
+		type "Spree::PaymentMethod::Ideal"
+		active true
+		environment "test"
+  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/models/spree/hash_factory_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Spree::HashFactory do
+
+  before(:each) do
+    @order = FactoryGirl.create(:order)
+    @payment_method = FactoryGirl.create(:ideal)
+  end
+
+#-------------------------------------------------------------------------------------------------
+  context "create hash" do
+    it "regular hash" do
+      @order.number = 10
+      @order.total = 10.00
+      hash = Spree::HashFactory.create_hash(@order, @payment_method, "en")
+      hash.should eql("549eb11425c906d8e0b86e7d75e1ef2a2bae73ba")
+    end
+
+  end
+#-------------------------------------------------------------------------------------------------
+  after(:each) do
+    @order.destroy
+    @payment_method.destroy
+  end
+
+end

data/spec/models/spree/order_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Spree::Order do
+
+  before(:each) do
+    @order = FactoryGirl.create(:order)
+    @payment_method = FactoryGirl.create(:ideal)
+  end
+
+#-------------------------------------------------------------------------------------------------
+  context "it has no payment" do
+    it "last payment is null" do
+      @order.last_payment.should be_nil
+    end
+
+    it "last payment method is null" do
+      @order.last_payment_method.should be_nil
+    end
+
+    it "ideal ref number is only order number" do
+      @order.ideal_ref_number.should eql(@order.number);
+    end
+
+  end
+#-------------------------------------------------------------------------------------------------
+  context "it has a valid payment" do
+    before(:each) do
+      @payment = FactoryGirl.create(:payment, order: @order, payment_method: @payment_method)
+    end
+
+    it "last payment is given" do
+      @order.last_payment.should_not be_nil
+    end
+
+    it "last payment method is given" do
+      @order.last_payment_method.should_not be_nil
+    end
+
+    after(:each) do
+      @payment.destroy
+    end
+  end
+#-------------------------------------------------------------------------------------------------
+  after(:each) do
+    @order.destroy
+    @payment_method.destroy
+  end
+
+end

data/spec/models/spree/payment_method/ideal_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Spree::PaymentMethod::Ideal do
+
+  before(:all) do
+    @ideal = create(:ideal)
+  end
+
+  describe "save preferences" do
+
+    it "can save abn_url" do
+      @ideal.set_preference(:abn_url, "the url")
+      @ideal.save!
+      @ideal.get_preference(:abn_url).should eql("the url")
+    end
+
+    it "can save pspid" do
+      @ideal.set_preference(:pspid, "the url")
+      @ideal.save!
+      @ideal.get_preference(:pspid).should eql("the url")
+    end
+
+    it "can save accept_url" do
+      @ideal.set_preference(:accept_url, "the url")
+      @ideal.save!
+      @ideal.get_preference(:accept_url).should eql("the url")
+    end
+
+    it "can save decline_url" do
+      @ideal.set_preference(:decline_url, "the url")
+      @ideal.save!
+      @ideal.get_preference(:decline_url).should eql("the url")
+    end
+
+    it "can save exception_url" do
+      @ideal.set_preference(:exception_url, "the url")
+      @ideal.save!
+      @ideal.get_preference(:exception_url).should eql("the url")
+    end
+
+    it "can save cancel_url" do
+      @ideal.set_preference(:cancel_url, "the url")
+      @ideal.save!
+      @ideal.get_preference(:cancel_url).should eql("the url")
+    end
+
+    it "can save sha_in_pass_phrase" do
+      @ideal.set_preference(:sha_in_pass_phrase, "the pass phrase")
+      @ideal.save!
+      @ideal.get_preference(:sha_in_pass_phrase).should eql("the pass phrase")
+    end
+
+    it "can save sha_out_pass_phrase" do
+      @ideal.set_preference(:sha_out_pass_phrase, "the sha_out_pass_phrase")
+      @ideal.save!
+      @ideal.get_preference(:sha_out_pass_phrase).should eql("the sha_out_pass_phrase")
+    end
+
+    it "can save sha_algorithm" do
+      @ideal.set_preference(:sha_algorithm, "the sha_algorithm")
+      @ideal.save!
+      @ideal.get_preference(:sha_algorithm).should eql("the sha_algorithm")
+    end
+
+    it "can save shop_base_url" do
+      @ideal.set_preference(:shop_base_url, "the shop_base_url")
+      @ideal.save!
+      @ideal.get_preference(:shop_base_url).should eql("the shop_base_url")
+    end
+
+  end
+
+  after(:all) do
+    @ideal.destroy
+  end
+
+end

data/spec/models/spree/url_factory_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Spree::UrlFactory do
+
+  before(:each) do
+    @order = FactoryGirl.create(:order)
+    @payment_method = FactoryGirl.create(:ideal)
+  end
+
+#-------------------------------------------------------------------------------------------------
+  context "create hash" do
+    it "regular hash" do
+      @order.number = 10
+      @order.total = 10.00
+      hash = Spree::HashFactory.create_hash(@order, @payment_method, "en")
+      url = Spree::UrlFactory.create_ideal_checkout_url_from_payment(@order, @payment_method, hash, "en")
+      url.should eql("https://internetkassa.abnamro.nl/ncol/test/orderstandard.asp?PSPID=&ORDERID=1&AMOUNT=1000&CURRENCY=USD&LANGUAGE=en_US&SHASIGN=549eb11425c906d8e0b86e7d75e1ef2a2bae73ba&ACCEPTURL=&DECLINEURL=&EXCEPTIONURL=&CANCELURL=&BACKURL=/orders/10")
+    end
+
+  end
+#-------------------------------------------------------------------------------------------------
+  after(:each) do
+    @order.destroy
+    @payment_method.destroy
+  end
+
+end

data/spec/services/spree/ideal_service_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Spree::IdealService do
+
+  before(:each) do
+    @order = create(:order_with_line_items)
+    @ideal = create(:ideal)
+  end
+
+  describe "initial_request" do
+
+    context "fail" do
+
+      it "raise null order exception" do
+        expect {
+          Spree::IdealService.instance.initial_request(nil)
+        }.to raise_error(RuntimeError, "no order given")
+      end
+
+      it "raises no payment exception" do
+        expect {
+          Spree::IdealService.instance.initial_request(@order)
+        }.to raise_error(RuntimeError, "order has no payment")
+      end
+
+    end # context fail
+
+  end
+
+
+  after(:each) do
+    @order.destroy
+    @ideal.destroy
+  end
+
+end