spree_ideal 2.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ad0379ec12d43a06ef9436990bac9fa7bec5ce5
+  data.tar.gz: d313142a13cef028f744c11d92d355dcf7c75cd6
+SHA512:
+  metadata.gz: 51c71860729915e8ba8ecfbee8611c547f9e77775c6a533409d8541398f5ee3701c65b096a1b27cecbd7e399489db6740ea35442a7c25c890502c1b1a1b0ec67
+  data.tar.gz: cbd4104bf45100a07a4968258d58f36663369fdb228f580b523408ef9faea6bdb6f77b6abdebb5f0f96d1d1a00123dbabda30c439a7eef453982f5140d5064ab

data/.gitignore

@@ -0,0 +1,18 @@
+\#*
+*~
+.#*
+.DS_Store
+*.iml
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+log/
+nbproject
+pkg
+*.swp
+spec/dummy
+.ruby-gemset
+.ruby-version

data/.rspec

@@ -0,0 +1 @@
+--format documentation --colour

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+ruby '2.2.1'
+
+gem 'spree', :github => 'spree/spree', :branch => '2-4-stable'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', :branch => '2-4-stable'
+
+group :development, :test do
+  gem "therubyracer"
+	gem "byebug"
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+
+Copyright (c) 2014 Stefan Hartmann
+
+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,69 @@
+# SpreeIdeal
+
+Adds [iDEAL payment](https://www.ideal.nl/en/) Support to Spree through [ABN AMRO Internetkassa's iDEAL Integration](https://internetkassa.abnamro.nl).
+
+## Installation
+
+Add spree_ideal to your Gemfile:
+
+```ruby
+gem 'spree_ideal', :git => 'git://github.com/arein/spree_ideal.git'
+```
+
+For a specific version use the appropriate branch, for example
+
+```ruby
+gem 'spree_ideal', :git => 'git://github.com/arein/spree_ideal.git', :branch => '2-4-stable'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```bash
+bundle
+bundle exec rails g spree_ideal:install
+```
+
+## Setup
+
+Navigate to Spree Backend/Configuration/Payment Methods and add a new payment method with Provider "Spree::PaymentMethod::Ideal".
+
+Then log into either your testing or production [ABN AMRO Internetkassa Back Office here](https://internetkassa.abnamro.nl).
+
+Edit the following fields according to this doc:
+
+* ABN URL: https://internetkassa.abnamro.nl/ncol/test/orderstandard.asp for testing or https://internetkassa.abnamro.nl/ncol/prod/orderstandard.asp for production
+* PSPID: You'll find the PSPID in the footer of the Back Office
+* Accept URL: <shop base url>/ideal/accept
+* Decline URL: <shop base url>/ideal/decline
+* Exception URL: <shop base url>/ideal/exception
+* Cancel URL: <shop base url>/ideal/cancel
+* SHA IN Pass Phrase: Set this in the Back Office under Configuration -> Technical Information -> Data and Origin Verification -> SHA-IN Pass Phrase
+* SHA Out Pass Phrase: Set this in the Back Office under Configuration -> Technical Information -> Transaction Feedback -> SHA-OUT Pass Phrase (may not equal the SHA-IN Pass Phrase)
+* SHA Algorithm: Either "SHA-1", "SHA-256", or "SHA-512", according to the setting in the Back Office under Configuration -> Technical Information -> Global Security Parameters -> Hash Algorithm
+* Shop Base URL: <shop base url>
+
+
+__IMPORTANT__:In the backoffice you need to carry out a few actions:
+* Set Configuration -> Technical Information -> Transaction Feedback -> "I would like to receive transaction feedback parameters on the redirection URLs" to YES
+* Set Configuration -> Technical Information -> Transaction Feedback -> "Timing of the request" to "Always Deferred" and "Request Method" to "GET"
+* Set Configuration -> Technical Information -> Transaction Feedback -> "Dynamic e-Commerce parameters" to "ACCEPTANCE", "AMOUNT", "BRAND", "CARDNO", "CURRENCY", "NCERROR", "ORDERID", "PAYID", "PM", "STATUS"
+
+## Running the Tests
+
+1. Install dependencies `bundle install`
+2. Create a Dummy app `bundle exec rake test_app`
+3. Change Directory `cd spec/dummy`
+4. Create a Test Database `rake db:create RAILS_ENV=test`
+5. Migrate `rake db:migrate RAILS_ENV=test`
+6. Seed `bin/rake db:seed RAILS_ENV=test`
+7. Load sample data `bin/rake spree_sample:load RAILS_ENV=test`
+8. Change Directory `cd ../..`
+9. Run RSpec `rspec spec`
+
+
+## Acknowledgements
+
+This repository is inspired by [@hefan's](https://github.com/hefan) [Spree Sofort Plugin](https://github.com/hefan/spree_sofort)
+
+## License
+released under the New BSD License

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+
+task :default => [:spec]
+
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_ideal'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/admin/spree_ideal.js

@@ -0,0 +1 @@
+//= require admin/spree_core

data/app/assets/javascripts/store/spree_ideal.js

@@ -0,0 +1 @@
+//= require store/spree_core

data/app/assets/stylesheets/admin/spree_ideal.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_core
+*/

data/app/assets/stylesheets/store/spree_ideal.css

@@ -0,0 +1,3 @@
+/*
+ *= require store/spree_core
+*/

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,21 @@
+Spree::CheckoutController.class_eval do
+  before_filter :redirect_to_ideal, :only => [:update]
+
+  def redirect_to_ideal
+    return unless (params[:state] == "payment")
+    return unless params[:order][:payments_attributes]
+
+    payment_method = Spree::PaymentMethod.find(params[:order][:payments_attributes].first[:payment_method_id])
+
+    if payment_method.kind_of?(Spree::PaymentMethod::Ideal)
+      @order.update_from_params(params, permitted_checkout_attributes)
+
+      Spree::IdealService.instance.initial_request(@order)
+
+      # Create iDEAL Url
+      redirect_url = Spree::UrlFactory.create_ideal_checkout_url_from_payment(@order, payment_method, @order.last_payment.ideal_hash, I18n.locale)
+      redirect_to redirect_url, :status => 302
+    end
+  end
+
+end

data/app/controllers/spree/ideal_controller.rb

@@ -0,0 +1,160 @@
+require 'pp'
+require 'uri'
+
+class Spree::IdealController < ApplicationController
+
+  skip_before_filter :verify_authenticity_token, :only => :status
+
+  def success
+
+    if params[:orderID].blank?
+      flash[:error] = I18n.t("ideal.order_invalid_setup")
+      redirect_to '/checkout/payment', :status => 302
+      return
+    end
+
+    # Some Validation
+    if !params.has_key?("currency") || params[:currency].blank? ||
+       !params.has_key?("amount") || params[:amount].blank? ||
+       !params.has_key?("PM") || params[:PM].blank? ||
+       !params.has_key?("CARDNO") || params[:CARDNO].blank? ||
+       !params.has_key?("STATUS") || params[:STATUS].blank? ||
+       !params.has_key?("PAYID") || params[:PAYID].blank? ||
+       !params.has_key?("NCERROR") || params[:NCERROR].blank? ||
+       !params.has_key?("BRAND") || params[:BRAND].blank?
+      flash[:error] = I18n.t("ideal.order_invalid_setup")
+      redirect_to '/checkout/payment', :status => 302
+      return
+    end
+
+    order = Spree::Order.where(number: params[:orderID]).take
+
+    if params.blank? or order.blank?
+      flash[:error] = I18n.t("ideal.payment_not_found")
+      redirect_to '/checkout/payment', :status => 302
+      return
+    end
+
+    ideal_payment = order.last_payment
+
+    if params.blank? or ideal_payment.blank? or  !order.last_payment_method.kind_of? Spree::PaymentMethod::Ideal
+       flash[:error] = I18n.t("ideal.payment_not_found")
+       redirect_to '/checkout/payment', :status => 302
+       return
+    end
+
+    hash_algorithm = ideal_payment.payment_method.preferred_sha_algorithm
+    secret = ideal_payment.payment_method.preferred_sha_out_pass_phrase.to_s
+
+    # Some Validation
+    unless params.has_key?("SHASIGN")
+      flash[:error] = I18n.t("ideal.order_invalid_setup")
+      redirect_to '/checkout/payment', :status => 302
+      return
+    end
+
+    # Security Validation
+    shasign = ""
+    if params.has_key?("SHASIGN")
+      shasign = params[:SHASIGN].downcase
+    end
+
+    sha_out_hash = Spree::HashFactory.create_sha_out_hash(params, secret, hash_algorithm)
+
+    pp sha_out_hash
+    unless sha_out_hash.eql? shasign
+      flash[:error] = I18n.t("ideal.security_error")
+      redirect_to '/checkout/payment', :status => 302
+      return
+    end
+
+    order = ideal_payment.order
+    if order.blank?
+     	flash[:error] = I18n.t("ideal.order_not_found")
+     	redirect_to '/checkout/payment', :status => 302
+     	return
+    end
+
+    if not order.state.eql? "complete" and not order.state.eql? "payment" and not order.state.eql? "checkout"
+      flash[:error] = I18n.t("ideal.order_invalid_state")
+      redirect_to '/checkout/payment', :status => 302
+      return
+    end
+
+    if order.state.eql? "complete"  # complete again via browser back or recalling ideal "go" url
+      success_redirect order
+    else
+      ActiveRecord::Base.transaction do
+        ideal_payment.update_attribute(:ideal_transaction, params[:PAYID])
+        if ideal_payment.ideal_log.blank?
+          ideal_payment.update_attribute(:ideal_log, "payment_successful,")
+        else
+          ideal_payment.update_attribute(:ideal_log, ideal_payment.ideal_log + "payment_successful,")
+        end
+        ideal_payment.complete!
+        order.finalize!
+        order.state = "complete"
+        order.save!
+      end
+      session[:order_id] = nil
+      flash[:success] = I18n.t("ideal.completed_successfully")
+      success_redirect order
+    end
+
+  end
+
+  def decline
+    self.handle_status(params, "canceled")
+    flash[:error] = I18n.t("ideal.decline")
+    redirect_to '/checkout/payment', :status => 302
+  end
+
+  def exception
+    self.handle_status(params, "exception")
+    flash[:error] = I18n.t("ideal.exception")
+    redirect_to '/checkout/payment', :status => 302
+  end
+
+  def cancel
+    self.handle_status(params, "canceled")
+    flash[:error] = I18n.t("ideal.canceled")
+    redirect_to '/checkout/payment', :status => 302
+  end
+
+  private
+
+  def handle_status(params, message)
+    if params.blank? or params[:orderID].blank?
+      return
+    end
+
+    order = Spree::Order.where(number: params[:orderID]).take
+
+    if order.blank?
+      return
+    end
+
+    unless order.last_payment_method.kind_of? Spree::PaymentMethod::Ideal
+      return
+    end
+
+    ideal_payment = order.last_payment
+
+    if ideal_payment.blank?
+      return
+    end
+
+    if ideal_payment.ideal_log.blank?
+      ideal_payment.update_attribute(:ideal_log, message + ",")
+    else
+      ideal_payment.update_attribute(:ideal_log, ideal_payment.ideal_log + message + ",")
+    end
+    ideal_payment.save!
+
+  end
+
+  def success_redirect order
+    redirect_to "/orders/#{order.number}", :status => 302
+  end
+
+end

data/app/models/spree/hash_factory.rb

@@ -0,0 +1,64 @@
+class Spree::HashFactory
+  def self.create_hash(order, ideal_payment_settings, locale)
+
+    secret = ideal_payment_settings.preferred_sha_in_pass_phrase.to_s
+    
+    language = Spree::LocaleHelper.format_locale(locale)
+
+    if secret.blank?
+      secret = "" # Fallback if secret not set
+    end
+
+    total = (order.total * 100).to_i # Convert according to
+    to_hash = "ACCEPTURL=" + ideal_payment_settings.preferred_accept_url + secret + "" \
+              +  "AMOUNT=" + total.to_s + secret + ""\
+              +  "BACKURL=" + ideal_payment_settings.preferred_shop_base_url + "/orders/#{order.number}" + secret + "" \
+              +  "CANCELURL=" + ideal_payment_settings.preferred_cancel_url + secret + "" \
+              +  "CURRENCY=" + Spree::Config.currency.to_s + secret + "" \
+              +  "DECLINEURL=" + ideal_payment_settings.preferred_decline_url + secret + "" \
+              +  "EXCEPTIONURL=" + ideal_payment_settings.preferred_exception_url + secret + "" \
+              +  "LANGUAGE=" + language + secret + "" \
+              +  "ORDERID=" + order.number.to_s + secret + "" \
+              +  "PSPID=" + ideal_payment_settings.preferred_pspid.to_s + secret + "" \
+
+    case ideal_payment_settings.preferred_sha_algorithm
+      when "SHA-1"
+        Digest::SHA1.hexdigest to_hash
+      when "SHA-256"
+        Digest::SHA256.hexdigest to_hash
+      when "SHA-512"
+        Digest::SHA512.hexdigest to_hash
+      else
+        Digest::SHA1.hexdigest to_hash
+    end
+  end
+
+  def self.create_sha_out_hash(params, secret, hash_algorithm)
+
+    if secret.blank?
+      return secret
+    end
+
+    to_hash = "ACCEPTANCE=" + params[:ACCEPTANCE] + secret + ""\
+              +  "AMOUNT=" + params[:amount] + secret + "" \
+              +  "BRAND=" + params[:BRAND] + secret + "" \
+              +  "CARDNO=" + params[:CARDNO] + secret + "" \
+              +  "CURRENCY=" + params[:currency] + secret + "" \
+              +  "NCERROR=" + params[:NCERROR] + secret + "" \
+              +  "ORDERID=" + params[:orderID] + secret + "" \
+              +  "PAYID=" + params[:PAYID] + secret + "" \
+              +  "PM=" + params[:PM] + secret + "" \
+              +  "STATUS=" + params[:STATUS] + secret + "" \
+
+    case hash_algorithm
+      when "SHA-1"
+        Digest::SHA1.hexdigest to_hash
+      when "SHA-256"
+        Digest::SHA256.hexdigest to_hash
+      when "SHA-512"
+        Digest::SHA512.hexdigest to_hash
+      else
+        Digest::SHA1.hexdigest to_hash
+    end
+  end
+end

data/app/models/spree/locale_helper.rb

@@ -0,0 +1,48 @@
+class Spree::LocaleHelper
+  def self.format_locale(locale)
+    case locale
+      when "ar"
+        return "ar_AR"
+      when "cs"
+        return "cs_CZ"
+      when "dk"
+        return "dk_DK"
+      when "de"
+        return "de_DE"
+      when "es"
+        return "es_ES"
+      when "fi"
+        return "fi_FI"
+      when "fr"
+        return "fr_FR"
+      when "hu"
+        return "hu_HU"
+      when "it"
+        return "it_IT"
+      when "ja"
+        return "ja_JP"
+      when "ko"
+        return "ko_KR"
+      when "nl"
+        return "nl_NL"
+      when "no"
+        return "no_NO"
+      when "pl"
+        return "pl_PL"
+      when "pt"
+        return "pt_PT"
+      when "ru"
+        return "ru_RU"
+      when "se"
+        return "se_SE"
+      when "sk"
+        return "sk_SK"
+      when "tr"
+        return "tr_TR"
+      when "zh"
+        return "zh_CN"
+      else
+        return "en_US"
+    end
+  end
+end