spree_billing_sisow 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15f80e551ff72e9fe5eeae51c8371acef8d64b28f961c774f5bbf44ef6491cc4
-  data.tar.gz: 39f6b06bb1d503f7e0ca584ae13b1b805eb7564171abb68a7212775f003bf486
+  metadata.gz: d57da200dbf0042deb93aabd3a2a2128489890a02d72532acfca01d823156b69
+  data.tar.gz: f207bb916efc2f837425825bbba9a3f287db6acfe1fdf6d500f17131ee84c85d
 SHA512:
-  metadata.gz: c88fa7c6197a32527caff30760b251f51ee28640842d588a6032f752f409dcba4033f6d6e3878ade4bc318b3b535dfc2b8297a9bf06a93ed12d2a48753500ec6
-  data.tar.gz: e4a6454adde1f7b6acee07af8202f6ea0a80319c7fd12d2c2d4a8b6ade7ad47ef32ec282f7b5da0bbd8426431bb71cdace88d5951a16662d82ef76177673fc7d
+  metadata.gz: 4b691b09032dd8297939dd6b77eba612e354da092cadb0463c2d9ada1661d33b33884d15c91abb4707a0ac4c61d64ab1f26f8ca1760701e525ead447db4b1c90
+  data.tar.gz: 71fd5031b9df43a24892cd82d57445157fcb206c5fc3ef732488f8af749404daaf575126451c4c1ba094b435a1809ce53cfba700588dfcd002ba6e35c009bd79

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2013 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,54 @@
+Spree Billing Sisow
+=================
+[![Build Status](https://travis-ci.org/berkes/spree_billing_sisow.png)](https://travis-ci.org/berkes/spree_billing_sisow)
+[![Code Climate](https://codeclimate.com/github/berkes/spree_billing_sisow.png)](https://codeclimate.com/github/berkes/spree_billing_sisow)
+[![Test Coverage](https://codeclimate.com/github/berkes/spree_billing_sisow/badges/coverage.svg)](https://codeclimate.com/github/berkes/spree_billing_sisow)
+[![Dependency Status](https://gemnasium.com/badges/github.com/berkes/spree_billing_sisow.svg)](https://gemnasium.com/github.com/berkes/spree_billing_sisow)
+
+Spree Billing Integration for Sisow (Ideal / Bancontact / Sofort / Paypal) payments.
+This Gem is currently being build and tested, and is not yet released for use in production systems
+
+Installation
+------------
+
+Add spree_billing_sisow to your Gemfile:
+
+```ruby
+gem 'spree_billing_sisow'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_billing_sisow:install
+```
+
+Author
+------
+
+Developed by [xtr3me](https://github.com/xtr3me)
+
+[Other contributors](https://github.com/xtr3me/spree_billing_sisow/graphs/contributors)
+
+Currently maintained by [Bèr `berkes` Kessels](http://berk.es)
+
+Testing
+-------
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_billing_sisow/factories'
+```
+
+Copyright (c) 2013 Sjors Baltus, released under the New BSD License

data/app/controllers/spree/admin/sisow_controller.rb

@@ -0,0 +1,22 @@
+module Spree
+  module Admin
+    class SisowController < Spree::Admin::BaseController
+      def edit
+      end
+
+      def update
+        Spree::Config.set(update_params.to_hash)
+        redirect_to edit_admin_sisow_path, :notice => Spree.t(:sisow_settings_updated)
+      end
+
+      private
+
+      def update_params
+        params.require(:preferences).permit(:sisow_merchant_id,
+                                            :sisow_merchant_key,
+                                            :sisow_test_mode,
+                                            :sisow_debug_mode)
+      end
+    end
+  end
+end

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,70 @@
+module Spree
+  CheckoutController.class_eval do
+    before_action :confirm_sisow, only: [:update]
+
+    def sisow_return
+      handle_sisow_response
+      # We call +next+, not +next!+ because we don't want this to raise
+      # exceptions when the callback has already processed and completed the
+      # order.
+      @order.reload.next
+      if @order.complete?
+        flash.notice = Spree.t(:order_processed_successfully)
+        redirect_to order_path(@order, number: @order.number)
+      else
+        redirect_to checkout_state_path(@order.state)
+      end
+    end
+
+    def sisow_cancel
+      handle_sisow_response
+      redirect_to checkout_state_path(@order.state)
+    end
+
+    private
+
+    def handle_sisow_response
+      sisow = PaymentMethod::SisowBilling.new(@order)
+      sisow.process_response(params)
+
+      if sisow.cancelled?
+        flash.alert = Spree.t(:payment_has_been_cancelled)
+      end
+    end
+
+    def confirm_sisow
+      return unless confirm_params_valid?
+      return unless sisow_payment_method?(payment_method)
+
+      if payment_method.is_a?(PaymentMethod::SisowBilling::Ideal)
+        return_url_opts[:issuer_id] = params[:issuer_id]
+      end
+      redirect_to payment_method.redirect_url(@order, return_url_opts)
+    end
+
+    def return_url_opts
+      @return_url_opts ||= {
+        return_url: sisow_return_order_checkout_url(@order),
+        cancel_url: sisow_cancel_order_checkout_url(@order),
+        notify_url: sisow_status_update_url(@order),
+        callback_url: sisow_status_update_url(@order),
+      }
+    end
+
+    def payment_method_id_param
+      params[:order][:payments_attributes].first[:payment_method_id]
+    end
+
+    def confirm_params_valid?
+      (params[:state] == "payment") && params[:order][:payments_attributes]
+    end
+
+    def sisow_payment_method?(payment_method)
+      payment_method.is_a?(PaymentMethod::SisowBilling::SisowPaymentMethod)
+    end
+
+    def payment_method
+      @payment_method ||= PaymentMethod.find(payment_method_id_param)
+    end
+  end
+end

data/app/controllers/spree/sisow_status_controller.rb

@@ -0,0 +1,18 @@
+module Spree
+  class SisowStatusController < ApplicationController
+    def update
+      begin
+        order = Order.find_by_number!(params[:order_id])
+        sisow = PaymentMethod::SisowBilling.new(order)
+        sisow.process_response(params)
+
+        order.next unless order.completed?
+        head :ok
+      rescue ActiveRecord::RecordNotFound
+        logger.error "ERROR: Sisow reply failed, order (#{params[:order_id]}) not found"
+        head :internal_server_error
+      end
+    end
+
+  end
+end

data/app/models/spree/app_configuration_decorator.rb

@@ -0,0 +1,7 @@
+Spree::AppConfiguration.class_eval do
+  # Sisow Preferences
+  preference :sisow_merchant_id, :string, :default => '2537407799'
+  preference :sisow_merchant_key, :string, :default => '0f9b49d384b4836c543f76d23a923e2cd2cfaec6'
+  preference :sisow_test_mode, :boolean, :default => true
+  preference :sisow_debug_mode, :boolean, :default => false
+end

data/app/models/spree/billing_integration.rb

@@ -0,0 +1,38 @@
+class Spree::BillingIntegration
+  class SisowBilling
+    class Method < ::Spree::PaymentMethod
+      class << self
+        extend Gem::Deprecate
+        deprecate :new, "PaymentMethod", 2016, 10
+      end
+    end
+
+    class Bancontact < Method
+      def self.new(*attrs)
+        super
+        ::Spree::PaymentMethod::SisowBilling::Bancontact.new(*attrs)
+      end
+    end
+
+    class Creditcard < Method
+      def self.new(*attrs)
+        super
+        ::Spree::PaymentMethod::SisowBilling::Creditcard.new(*attrs)
+      end
+    end
+
+    class Ideal < Method
+      def self.new(*attrs)
+        super
+        ::Spree::PaymentMethod::SisowBilling::Ideal.new(*attrs)
+      end
+    end
+
+    class Sofort < Method
+      def self.new(*attrs)
+        super
+        ::Spree::PaymentMethod::SisowBilling::Sofort.new(*attrs)
+      end
+    end
+  end
+end

data/app/models/spree/payment_method/sisow_billing/bancontact.rb

@@ -0,0 +1,9 @@
+module Spree
+  class PaymentMethod::SisowBilling
+    class Bancontact < SisowPaymentMethod
+      def payment_type
+        "bancontact"
+      end
+    end
+  end
+end

data/app/models/spree/payment_method/sisow_billing/creditcard.rb

@@ -0,0 +1,9 @@
+module Spree
+  class PaymentMethod::SisowBilling
+    class Creditcard < SisowPaymentMethod
+      def payment_type
+        "creditcard"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  class PaymentMethod::SisowBilling
+    class Ideal < SisowPaymentMethod
+      def self.issuer_list
+        PaymentMethod::SisowBilling.configure
+        Sisow::Issuer.list
+      end
+
+      def payment_type
+        "ideal"
+      end
+    end
+  end
+end

data/app/models/spree/payment_method/sisow_billing/paypalec.rb

@@ -0,0 +1,9 @@
+module Spree
+  class PaymentMethod::SisowBilling
+    class Paypalec < SisowPaymentMethod
+      def payment_type
+        "paypalec"
+      end
+    end
+  end
+end

data/app/models/spree/payment_method/sisow_billing/purchase.rb

@@ -0,0 +1,19 @@
+module Spree
+  class PaymentMethod::SisowBilling::Purchase
+    def initialize(source)
+      @status = source.status.downcase
+    end
+
+    def success?
+      @status == "success"
+    end
+
+    def authorization
+      nil
+    end
+
+    def to_s
+      success? ? super : "Payment failed"
+    end
+  end
+end

data/app/models/spree/payment_method/sisow_billing/sisow_payment_method.rb

@@ -0,0 +1,24 @@
+module Spree
+  class PaymentMethod::SisowBilling::SisowPaymentMethod < PaymentMethod
+    def payment_profiles_supported?
+      false
+    end
+
+    def auto_capture?
+      true
+    end
+
+    def purchase(_amount, source, _opts)
+      PaymentMethod::SisowBilling::Purchase.new(source)
+    end
+
+    def redirect_url(order, opts = {})
+      sisow = PaymentMethod::SisowBilling.new(order)
+      sisow.start_transaction(payment_type, opts)
+    end
+
+    def payment_type
+      raise "this method should be overriden and return the type of payment"
+    end
+  end
+end

data/app/models/spree/payment_method/sisow_billing/sofort.rb

@@ -0,0 +1,9 @@
+module Spree
+  class PaymentMethod::SisowBilling
+    class Sofort < SisowPaymentMethod
+      def payment_type
+        "sofort"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+module Spree
+  class PaymentMethod::SisowBilling < PaymentMethod
+
+    def initialize(order)
+      @order = order
+      PaymentMethod::SisowBilling.configure
+    end
+
+    def success?
+      return false unless @payment
+      (@payment.completed? && @order.completed?)
+    end
+
+    def failed?
+      return true unless @payment
+      @payment.failed?
+    end
+
+    def cancelled?
+      return false unless @payment
+      @payment.void?
+    end
+
+    def process_response(response)
+      if @order.payments.where(:source_type => 'Spree::SisowTransaction').present?
+        initialize_callback(response)
+
+        if @callback.valid?
+          # Update the transaction with the callback details
+          @sisow_transaction.update_attributes(
+            status: @callback.status,
+            sha1: @callback.sha1)
+
+          @payment = @order.payments.where(
+            amount: @order.total,
+            source_id: @sisow_transaction,
+            payment_method_id: payment_method).first
+
+          if @callback.cancelled? && !@payment.void?
+            cancel_payment
+          end
+        end
+      end
+    end
+
+    def start_transaction(transaction_type, opts = {})
+      @sisow_transaction = SisowTransaction.create(
+        transaction_type: transaction_type,
+        status: "pending")
+
+      @payment = @order.payments.create(amount: @order.total,
+                                        source: @sisow_transaction,
+                                        payment_method: payment_method)
+
+      # Update the entrance code with the payment number
+      @sisow_transaction.update(entrance_code: @payment.number)
+
+      # Set the options needed for the Sisow payment url
+      opts[:description] = "#{Spree::Store.current.name} - Order: #{@order.number}"
+      opts[:purchase_id] = @order.number
+      opts[:amount] = (@order.total * 100).to_i
+      opts[:entrance_code] = @payment.number
+
+      # Initialize the provider
+      sisow = payment_provider(transaction_type, opts)
+
+      # Update the transaction id and entrance code on the sisow transaction
+      @sisow_transaction.update_attributes(
+        transaction_id: sisow.transaction_id,
+        entrance_code: @payment.number)
+
+      sisow.payment_url
+    end
+
+    def self.configure
+      Sisow.configure do |config|
+        config.merchant_id = Spree::Config.sisow_merchant_id
+        config.merchant_key = Spree::Config.sisow_merchant_key
+        config.test_mode = Spree::Config.sisow_test_mode
+        config.debug_mode = Spree::Config.sisow_debug_mode
+      end
+      HTTPI.logger = logger
+    end
+
+    private
+
+    def payment_provider(transaction_type, options)
+      case transaction_type
+      when "ideal" then Sisow::IdealPayment.new(options)
+      when "bancontact" then Sisow::BancontactPayment.new(options)
+      when "creditcard" then Sisow::CreditCardPayment.new(options)
+      when "sofort" then Sisow::SofortPayment.new(options)
+      when "paypalec" then Sisow::PaypalPayment.new(options)
+      else
+        raise "Unknown payment method (#{transaction_type})"
+      end
+    end
+
+    def payment_method
+      type = @sisow_transaction.transaction_type
+      class_name = "Spree::PaymentMethod::SisowBilling::#{type.classify}"
+      PaymentMethod.find_by!(type: class_name)
+    end
+
+    def initialize_callback(sisow_return_data)
+      @callback = Sisow::Api::Callback.new(
+          :transaction_id => sisow_return_data[:trxid],
+          :entrance_code => sisow_return_data[:ec],
+          :status => sisow_return_data[:status],
+          :sha1 => sisow_return_data[:sha1]
+      )
+
+      @sisow_transaction = SisowTransaction.where(
+        transaction_id: sisow_return_data[:trxid],
+        entrance_code: sisow_return_data[:ec]
+      ).first
+    end
+
+    def cancel_payment
+      @payment.void!
+    end
+  end
+end

data/app/models/spree/sisow_transaction.rb

@@ -0,0 +1,10 @@
+module Spree
+  class SisowTransaction < ActiveRecord::Base
+    has_many :payments, :as => :source
+   # attr_accessible :transaction_id, :transaction_type, :entrance_code, :status, :sha1
+    
+    def actions
+      []
+    end
+  end
+end

data/app/overrides/admin_decorator.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  original: "0faac568db7e03f5705d3f86553d21a58bda03aa",
+  virtual_path: "spree/admin/shared/sub_menu/_configuration",
+  name: "add_sisow_settings",
+  insert_bottom: "[data-hook='admin_configurations_sidebar_menu']",
+  partial: "spree/admin/shared/configurations_menu_sisow")

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

@@ -0,0 +1,8 @@
+<% content_for :head do %>
+  <script type="text/javascript">
+    jQuery(document).ready(function(){
+      $("label:contains('<%= payment_method.name %>')").hide();
+      $("label:contains('<%= payment_method.name %>') input").disable();
+    });
+  </script>
+<% end %>

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

@@ -0,0 +1,8 @@
+<% content_for :head do %>
+  <script type="text/javascript">
+    jQuery(document).ready(function(){
+      $("label:contains('<%= payment_method.name %>')").hide();
+      $("label:contains('<%= payment_method.name %>') input").disable();
+    });
+  </script>
+<% end %>

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

@@ -0,0 +1,8 @@
+<% content_for :head do %>
+  <script type="text/javascript">
+    jQuery(document).ready(function(){
+      $("label:contains('<%= payment_method.name %>')").hide();
+      $("label:contains('<%= payment_method.name %>') input").disable();
+    });
+  </script>
+<% end %>

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

@@ -0,0 +1,8 @@
+<% content_for :head do %>
+  <script type="text/javascript">
+    jQuery(document).ready(function(){
+      $("label:contains('<%= payment_method.name %>')").hide();
+      $("label:contains('<%= payment_method.name %>') input").disable();
+    });
+  </script>
+<% end %>

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

@@ -0,0 +1,33 @@
+<fieldset>
+  <legend><%= Spree.t(:sisow_bancontact) %></legend>
+
+  <table class="index">
+    <tr>
+      <th colspan="6"><%= Spree.t(:sisow_transaction) %></th>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_transaction_id) %>:</label></td>
+      <td>
+        <%= payment.source.transaction_id %>
+      </td>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_entrance_code) %>:</label></td>
+      <td>
+        <%= payment.source.entrance_code %>
+      </td>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_status) %>:</label></td>
+      <td>
+        <%= payment.source.status %>
+      </td>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_sha1) %>:</label></td>
+      <td>
+        <%= payment.source.sha1 %>
+      </td>
+    </tr>
+  </table>
+</fieldset>

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

@@ -0,0 +1,33 @@
+<fieldset>
+  <legend><%= Spree.t(:sisow_ideal) %></legend>
+
+  <table class="index">
+    <tr>
+      <th colspan="6"><%= Spree.t(:sisow_transaction) %></th>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_transaction_id) %>:</label></td>
+      <td>
+        <%= payment.source.transaction_id %>
+      </td>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_entrance_code) %>:</label></td>
+      <td>
+        <%= payment.source.entrance_code %>
+      </td>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_status) %>:</label></td>
+      <td>
+        <%= payment.source.status %>
+      </td>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_sha1) %>:</label></td>
+      <td>
+        <%= payment.source.sha1 %>
+      </td>
+    </tr>
+  </table>
+</fieldset>

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

@@ -0,0 +1,33 @@
+<fieldset>
+  <legend><%= Spree.t(:sisow_sofort) %></legend>
+
+  <table class="index">
+    <tr>
+      <th colspan="6"><%= Spree.t(:sisow_transaction) %></th>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_transaction_id) %>:</label></td>
+      <td>
+        <%= payment.source.transaction_id %>
+      </td>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_entrance_code) %>:</label></td>
+      <td>
+        <%= payment.source.entrance_code %>
+      </td>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_status) %>:</label></td>
+      <td>
+        <%= payment.source.status %>
+      </td>
+    </tr>
+    <tr>
+      <td><label><%= Spree.t(:sisow_sha1) %>:</label></td>
+      <td>
+        <%= payment.source.sha1 %>
+      </td>
+    </tr>
+  </table>
+</fieldset>

data/app/views/spree/admin/shared/_configurations_menu_sisow.html.erb

@@ -0,0 +1 @@
+<%= configurations_sidebar_menu_item Spree.t(:sisow_configuration), edit_admin_sisow_path %>