spree_liqpay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b57dad854511cbc1cc40f1d9e433620117f8a45f
+  data.tar.gz: 6f4fad3cbfdbb54d4300e81d2865e73b116273b7
+SHA512:
+  metadata.gz: 8d716af5b00743b6abbc6b4d6fc6d229f2f313aa1f13d746088f906ca33cdd3959bcc7ccf768c5a30c3ff3ac00327702ea5c53823c4ed00ab261a9ee3fc6821c
+  data.tar.gz: 927650748d63870eeb2091dc01f3d3f1c1e0b8ca358a6f5fc4678801405dd0346c668a0dba575bd1375839ac8473c9f65bf3cc6b5af1a5de2a55590c5ded7d9a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Oleg Kukareka
+
+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,56 @@
+# Spree Liqpay
+
+[Liqpay.com](https://www.liqpay.com/en/) payment gateway API for [Spree E-Commerce](https://spreecommerce.com/).
+ 
+## Installation
+ 
+Update your `Gemfile`:
+
+```ruby
+gem 'spree_liqpay', github: 'kukareka/spree_liqpay'
+```
+
+Run `Bundler`:
+
+```
+bundle install
+```
+  
+## Configuration
+  
+1. Login to Spree Backend. 
+
+2. Open "Configurations -> Payment Methods"
+
+3. Click "New Payment Method".
+
+4. Choose provider "Spree::PaymentMethod::Liqpay".
+
+5. Enter any name and description. It will be visible to client during checkout. Click "Create".
+
+6. Enter your public and private keys retrieved from [liqpay.com](https://www.liqpay.com/en/).
+
+7. Enter order description (it will be visible to client during checkout on Liqpay site).
+
+8. Turn off the Test mode.
+  
+## How it works
+
+1. A client selects Liqpay payment method on Payment tab during checkout on our site.
+2. We redirect him to payment form on Liqpay.com where he makes the payment.
+3. Liqpay.com redirects the client back to our site.
+4. We wait for a callback from Liqpay.com (takes a few seconds) and redirect the client to "Order complete" page.
+
+## Tests
+
+Powered by [RSpec](http://rspec.info/), [Capybara](https://github.com/jnicklas/capybara) and [Selenium](http://www.seleniumhq.org/).
+
+Run `rake app:setup` before the tests to init the dummy app.  
+
+## References
+
+1. [Liqpay.com official Ruby SDK](https://github.com/liqpay/sdk-ruby) (not used by this gem)
+2. [Liqpay.com FAQ](https://www.liqpay.com/en/faq)
+3. [Liqpay.com API reference](https://www.liqpay.com/en/doc)
+
+

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path '../spec/dummy/Rakefile', __FILE__
+load 'rails/tasks/engine.rake'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new spec: 'app:setup'
+
+task default: :spec

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,17 @@
+module Spree
+  CheckoutController.class_eval do
+    def liqpay_result
+      update if has_completed_payments?
+    end
+
+    def liqpay_status
+      render json: {completed: has_completed_payments?}
+    end
+
+    private
+
+    def has_completed_payments?
+      @order.payments.completed.any?
+    end
+  end
+end

data/app/controllers/spree/liqpay_status_controller.rb

@@ -0,0 +1,25 @@
+module Spree
+  class LiqpayStatusController < ApplicationController
+
+    skip_before_filter :verify_authenticity_token
+
+    # callbacks from Liqpay server
+    def update
+      @payment_method = PaymentMethod.find params[:payment_method_id]
+      data = JSON.parse Base64.strict_decode64 params[:data]
+      render text: "Bad signature\n", status: 401 and return unless @payment_method.check_signature params[:data], params[:signature]
+      @order = Order.find data['order_id']
+
+      raise ArgumentError unless @order.payments.completed.empty? &&
+        data['currency'] == @order.currency &&
+        BigDecimal(data['amount']) == @order.total &&
+        data['type'] == 'buy' &&
+        (data['status'] == 'success' || (@payment_method.preferred_test_mode && data['status'] == 'sandbox'))
+
+      payment = @order.payments.create amount: @order.total, payment_method: @payment_method
+      payment.complete!
+
+      render text: "Thank you.\n"
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Spree
+  class PaymentMethod::Liqpay < PaymentMethod
+    preference :server, :string, default: 'https://www.liqpay.com'
+    preference :public_key, :string, default: ''
+    preference :private_key, :string, default: ''
+    preference :order_description, :string, default: -> {Spree::Store.current.name}
+    preference :test_mode, :boolean, default: true
+
+    def provider_class
+      ActiveMerchant::Billing::Liqpay
+    end
+
+    def provider
+      @provider ||= provider_class.new preferred_public_key, preferred_private_key
+    end
+
+    def source_required?
+      false
+    end
+
+    def checkout_url
+      "#{preferred_server}/api/checkout"
+    end
+
+    def cnb_form_fields order, result_url, server_url
+      provider.cnb_form_fields amount: order.total,
+                               currency: order.currency,
+                               description: preferred_order_description,
+                               order_id: order.id,
+                               result_url: result_url,
+                               server_url: server_url,
+                               sandbox: preferred_test_mode ? 1 : 0
+    end
+
+    def check_signature data, signature
+      provider.check_signature data, signature
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+<script>
+    $(function() {
+        setInterval(function(){
+            $.getJSON('<%= liqpay_status_order_checkout_url(@order, format: :json) %>', function(data) {
+                if (data.completed) location.reload();})}, 500)});
+</script>
+<div id="liqpay_spinner">
+  <!-- Here is the best place for some exciting animation -->
+</div>

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

@@ -0,0 +1,16 @@
+<script>
+  $(function() {
+      var checkout_form = $('#checkout_form_payment');
+      var checkout_form_action = checkout_form.prop('action');
+      var radio = $('#order_payments_attributes__payment_method_id_<%= payment_method.id %>')
+      var change_submit_url = function() {
+          checkout_form.prop('action', radio.prop('checked') ? '<%= payment_method.checkout_url %>' : checkout_form_action);
+      };
+      $('input[type=radio][name="order[payments_attributes][][payment_method_id]"]', checkout_form).change(change_submit_url);
+      change_submit_url();
+  })
+</script>
+<% payment_method.cnb_form_fields(@order, liqpay_result_order_checkout_url(@order),
+                                  liqpay_status_update_url(payment_method.id)).each do |name, value| %>
+  <%= hidden_field_tag name, value %>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,13 @@
+Spree::Core::Engine.routes.draw do
+  resources :orders do
+    resource :checkout, :controller => 'checkout' do
+      member do
+        get :liqpay_result
+        get :liqpay_status
+      end
+    end
+  end
+
+  post '/liqpay_status/:payment_method_id' => 'liqpay_status#update', :as => :liqpay_status_update
+
+end

data/lib/active_merchant/billing/liqpay.rb

@@ -0,0 +1,44 @@
+require 'base64'
+require 'digest/sha1'
+require 'json'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class Liqpay < Gateway
+
+      def initialize public_key, private_key
+        @public_key = public_key
+        @private_key = private_key
+      end
+
+      def cnb_form_fields options
+        params = {version: 3, public_key: @public_key}.merge options
+        data = encode params
+        {
+          data: data,
+          signature: encode_signature(data)
+        }
+      end
+
+      def encode data
+        encode64 encode_json data
+      end
+
+      def encode64 param
+        Base64.strict_encode64 param
+      end
+
+      def encode_json params
+        JSON.generate params
+      end
+
+      def encode_signature param
+        encode64 Digest::SHA1.digest @private_key + param + @private_key
+      end
+
+      def check_signature data, signature
+        signature == encode_signature(data)
+      end
+    end
+  end
+end

data/lib/spree_liqpay.rb

@@ -0,0 +1,3 @@
+require 'spree_core'
+require 'spree_frontend'
+require 'spree_liqpay/engine'

data/lib/spree_liqpay/engine.rb

@@ -0,0 +1,31 @@
+require 'spree_core'
+
+module SpreeLiqpay
+  class Engine < ::Rails::Engine
+    isolate_namespace Spree
+    engine_name 'spree_liqpay'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    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.liqpay.payment_methods', after: 'spree.register.payment_methods' do |app|
+      app.config.spree.payment_methods << ::Spree::PaymentMethod::Liqpay
+    end
+
+  end
+end

data/lib/spree_liqpay/factories.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :liqpay, class: Spree::PaymentMethod::Liqpay do
+    name 'Liqpay'
+    preferred_server 'http://localhost/'
+    preferred_private_key SecureRandom.hex 16
+    preferred_public_key  SecureRandom.hex 8
+    active true
+  end
+end

data/lib/spree_liqpay/version.rb

@@ -0,0 +1,3 @@
+module SpreeLiqpay
+  VERSION = '0.1.0'
+end

data/lib/tasks/spree_liqpay_tasks.rake

@@ -0,0 +1,8 @@
+desc 'Prepare test app'
+task :setup do
+  Rake::Task['app:spree:install:migrations'].invoke
+  Rake::Task['app:db:create'].invoke
+  Rake::Task['app:db:migrate'].invoke
+  Rake::Task['app:db:seed'].invoke
+  Rake::Task['app:assets:precompile'].invoke
+end

data/spec/controllers/spree/checkout_controller_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module Spree
+  describe CheckoutController, type: :controller do
+    routes { Spree::Core::Engine.routes }
+
+    let(:order) { create :order_with_line_items, state: 'payment' }
+
+    before do
+      expect(controller).to receive_messages current_order: order, check_authorization: true
+    end
+
+    describe '#liqpay_status' do
+      it 'returns false if the order has no completed payments' do
+        completed_payments false
+        get :liqpay_status, order_id: order
+        expect(response).to have_http_status :success
+        expect(JSON.parse(response.body)['completed']).to eq false
+      end
+
+      it 'returns true if the order has completed payments' do
+        completed_payments true
+        get :liqpay_status, order_id: order
+        expect(response).to have_http_status :success
+        expect(JSON.parse(response.body)['completed']).to eq true
+      end
+    end
+
+    describe '#liqpay_result' do
+      render_views
+
+      it 'waits for response from liqpay gateway' do
+        completed_payments false
+        get :liqpay_result, order_id: order
+        expect(response).to have_http_status :success
+        expect(response.body).to have_selector '#liqpay_spinner'
+      end
+
+      it 'redirects to update action after response from liqpay gateway' do
+        completed_payments true
+        get :liqpay_result, order_id: order
+        expect(response).to have_http_status :redirect
+      end
+    end
+
+    private
+
+    def completed_payments value
+      expect(controller).to receive(:has_completed_payments?).and_return value
+    end
+
+
+  end
+end

data/spec/controllers/spree/liqpay_status_controller_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper.rb'
+
+module Spree
+  describe LiqpayStatusController, type: :controller do
+    routes { Spree::Core::Engine.routes }
+
+    let(:liqpay) { create :liqpay }
+    let(:order) { create :order_with_line_items }
+    let(:data) do
+       {
+           order_id: order.id,
+           currency: order.currency,
+           amount: order.total,
+           type: 'buy',
+           status: 'sandbox'
+       }
+    end
+
+    it 'needs payment method' do
+      expect do
+        post :update, payment_method_id: liqpay.id * 100
+      end.to raise_error ActiveRecord::RecordNotFound
+    end
+
+    it 'checks signature' do
+      check_signature false
+      post :update, payment_method_id: liqpay, data: encode_json(data)
+      expect(response.status).to eq 401
+    end
+
+    context 'with correct signature' do
+      before do
+        check_signature true
+      end
+
+      it 'needs order' do
+        expect do
+          post :update, payment_method_id: liqpay, data: encode_json(order_id: order.id * 100)
+        end.to raise_error ActiveRecord::RecordNotFound
+      end
+
+      context 'order' do
+        before do
+          create :payment, order: order, state: :completed
+        end
+        it 'must not have complete payments' do
+          expect do
+            post :update, payment_method_id: liqpay, data: encode_json(order_id: order.id)
+          end.to raise_error ArgumentError
+        end
+      end
+
+      it 'checks currency' do
+        expect do
+          post :update, payment_method_id: liqpay, data: encode_json(data.merge currency: 'XXX')
+        end.to raise_error ArgumentError
+      end
+
+      it 'checks amount' do
+        expect do
+          post :update, payment_method_id: liqpay, data: encode_json(data.merge amount: (order.total * 2).to_digits)
+        end.to raise_error ArgumentError
+      end
+
+      it 'checks type' do
+        expect do
+          post :update, payment_method_id: liqpay, data: encode_json(data.merge type: 'sell')
+        end.to raise_error ArgumentError
+      end
+
+      it 'checks status' do
+        expect do
+          post :update, payment_method_id: liqpay, data: encode_json(data.merge status: 'fail')
+        end.to raise_error ArgumentError
+      end
+
+      it 'does not allow sandbox status without test mode' do
+        test_mode false
+        expect do
+          post :update, payment_method_id: liqpay, data: encode_json(data.merge status: 'sandbox')
+        end.to raise_error ArgumentError
+      end
+
+      it 'allows sandbox status in test mode' do
+        test_mode true
+        post :update, payment_method_id: liqpay, data: encode_json(data.merge status: 'sandbox')
+        expect(response).to have_http_status :success
+      end
+
+      it 'creates payment' do
+        post :update, payment_method_id: liqpay, data: encode_json(data)
+
+        expect(response).to have_http_status :success
+
+        expect(order.payments.count).to eq 1
+
+        payment = order.payments.first
+
+        expect(payment.payment_method).to eq liqpay
+        expect(payment.state).to eq 'completed'
+        expect(payment.amount).to eq order.total
+      end
+    end
+
+    private
+
+    def check_signature value
+      expect_any_instance_of(Spree::PaymentMethod::Liqpay).to receive(:check_signature).and_return value
+    end
+
+    def test_mode value
+      expect_any_instance_of(Spree::PaymentMethod::Liqpay).to receive(:preferred_test_mode).and_return value
+    end
+
+  end
+end