stall-atos 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daf588b4c8f1d06db827b602cc8eae3b4a137139
+  data.tar.gz: 34163d8ac6e761c506ce37d2ae8f8d01e2e55f2f
+SHA512:
+  metadata.gz: 8e136677ec3ac23ae433114051d390e2084065e758d96092850285224f125a35df9980d66eab82065cc358acba7ea6acdf4680e7b0049d152c4d53b46553c588
+  data.tar.gz: 048de03bba28c77bacc848f3fd228086b66973bc5a91a861998debca45332d31b40c1625e96f4b4f820208deeef8ded14cfe5907f10ebdaa24a4f361cd4a1ef0

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stall-atos.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 vala
+
+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,80 @@
+# Stall::Atos
+
+This gem allows integrating your [Stall](https://github.com/stall-rails/stall)
+e-commerce app with one of the Atos online payment gateway solutions.
+
+This gem is just the glue between [Stall](https://github.com/stall-rails/stall)
+and the provided Atos executable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stall-atos'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stall-atos
+
+Then use the install generator to copy the config template file :
+
+    $ rails generator stall:atos:install
+
+
+## Usage
+
+You first need to configure the gateway by filling the required variables in
+that were added to the stall config initialize.
+
+By default, it is configured to fetch from the variables from the environment,
+so ideally, just create the following env vars :
+
+- `ATOS_MERCHANT_ID`
+- `ATOS_SECRET_KEY`
+
+> **Note** : Test merchant id and secret key can be different than production
+ones.
+
+Now, go to the Stall initializer, and fill in the test and production URLs
+provdided by your bank in the `atos.test_payment_url` and `atos.payment_url`
+configuration.
+
+Restart your server, and you should now be able to use the CM-CIC payment
+gateway in test mode.
+
+When you're ready to switch to production, set the following environment
+variable :
+
+- `ATOS_PRODUCTION_MODE=true`
+
+Just like the other settings, you can change the way it's configured in the
+stall initializer file.
+
+### Automatic response URL
+
+You need to provide a payment response URL to your bank which will be :
+
+```text
+<http|http>://<YOUR_DOMAIN>/atos/payment/notify
+```
+
+You can find the route with :
+
+```bash
+rake routes | grep payment/notify
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stall-rails/stall-atos.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/views/stall/atos/_payment_form.html.haml

@@ -0,0 +1,7 @@
+%form.payment-gateway-form{ action: request.params.target_url, method: "post" }
+  %input#version{         name: "Data",             type: "hidden", value: request.params.data }
+  %input#tpe{             name: "Seal",             type: "hidden", value: request.params.seal }
+  %input#date{            name: "InterfaceVersion", type: "hidden", value: request.params.interface_version }
+
+  %button.btn.btn-primary{ name: "submit_cic_payment_form", type: "submit" }
+    = t('stall.payments.gateway.pay')

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stall/atos"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/stall/atos/install/install_generator.rb

@@ -0,0 +1,13 @@
+module Stall
+  module Atos
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config_template
+        inject_into_file 'config/initializers/stall.rb', after: "Stall.configure do |config|\n" do
+          File.read(File.join(self.class.source_root, 'config.rb'))
+        end
+      end
+    end
+  end
+end

data/lib/generators/stall/atos/install/templates/config.rb

@@ -0,0 +1,34 @@
+  # Atos payment gateway configuration
+  # Fill in the informations provided by your bank (Atos service provider)
+  #
+  config.payment.atos do |atos|
+    # Hmac key calculated with the js calculator given by CIC
+    atos.merchant_id = ENV['ATOS_MERCHANT_ID']
+    # Hmac key calculated with the js calculator given by CIC
+    atos.secret_key = ENV['ATOS_SECRET_KEY']
+
+    # Secret key version. Defaults to 1 when first generated, but you can update
+    # this value if you generated another key
+    #
+    # atos.key_version = '1'
+
+    # Test payment URL, provided by the bank
+    atos.test_payment_url = ''
+    # Production payment URL, provided by the bank
+    atos.payment_url = ''
+
+    # Atos / SIPS target version. Defaults to HP_2.9, but could need to be
+    # updated, depending on the bank provided version
+    #
+    # atos.interface_version = 'HP_2.9'
+
+    # Test or production mode, default to false, changes the payment
+    # gateway target URL
+    #
+    # By default, the test mode is activated in all environments but you just
+    # need to add `ATOS_PRODUCTION_MODE=true` in your environment variables
+    # and restart your server to switch to production mode
+    #
+    atos.test_mode = ENV['ATOS_PRODUCTION_MODE'] != 'true'
+  end
+

data/lib/stall/atos.rb

@@ -0,0 +1,16 @@
+require 'stall'
+
+module Stall
+  module Atos
+    extend ActiveSupport::Autoload
+
+    autoload :PaymentParams
+    autoload :PaymentResponse
+    autoload :Version
+
+    autoload :FakeGatewayPaymentNotification
+  end
+end
+
+require 'stall/atos/gateway'
+require 'stall/atos/engine'

data/lib/stall/atos/engine.rb

@@ -0,0 +1,6 @@
+module Stall
+  module Atos
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/stall/atos/fake_gateway_payment_notification.rb

@@ -0,0 +1,52 @@
+module Stall
+  module Atos
+    class FakeGatewayPaymentNotification < Stall::Payments::FakeGatewayPaymentNotification
+      delegate :currency, to: :cart
+
+      def params
+        {}.tap do |params|
+          params.merge!(options)
+        end
+      end
+
+      private
+
+      def options
+        @options ||= {
+          "Data" => data,
+          "Seal" => Stall::Atos::PaymentParams.calculate_seal_for(data),
+          "InterfaceVersion" => "HP_2.0",
+          "Encode" => ""
+        }
+      end
+
+      def data
+        @data ||= Stall::Atos::PaymentParams.serialize(
+          merchantId: gateway.merchant_id,
+          transactionReference: gateway.transaction_id,
+          keyVersion: gateway.key_version,
+          amount: cart.total_price.cents,
+          currencyCode: cart.currency.iso_numeric,
+          transactionDateTime: Time.now.iso8601,
+          captureDay: '0',
+          captureMode: 'AUTHOR_CAPTURE',
+          orderChannel: 'INTERNET',
+          responseCode: '00',
+          acquirerResponseCode: '00',
+          authorisationId: '12345',
+          guaranteeIndicator: 'N',
+          cardCSCResultCode: '4E',
+          panExpiryDate: '210001',
+          paymentMeanBrand: 'VISA',
+          paymentMeanType: 'CARD',
+          customerIpAddress: '127.0.0.1',
+          maskedPan: '4100##########00',
+          holderAuthentRelegation: 'N',
+          holderAuthentStatus: '3D_ERROR',
+          transactionOrigin: 'INTERNET',
+          paymentPattern: 'ONE_SHOT'
+        )
+      end
+    end
+  end
+end

data/lib/stall/atos/gateway.rb

@@ -0,0 +1,138 @@
+module Stall
+  module Atos
+    class Gateway < Stall::Payments::Gateway
+      register :atos
+
+      # Merchant ID
+      class_attribute :merchant_id
+      # Secret key found in the banks's download interface
+      class_attribute :secret_key
+      # Secret key version
+      class_attribute :key_version
+      self.key_version = '1'
+
+      # Test payment URL to send payment form to, provided by the bank
+      class_attribute :test_payment_url
+      # Production payment URL to send payment form to, provided by the bank
+      class_attribute :payment_url
+
+      # Interface version of the Atos / SIPS API
+      class_attribute :interface_version
+      self.interface_version = 'HP_2.9'
+
+      # Test or production mode, default to false, changes the payment
+      # gateway target URL
+      class_attribute :test_mode
+      self.test_mode = !Rails.env.production?
+
+      def self.request(cart)
+        Request.new(cart)
+      end
+
+      def self.response(request)
+        Response.new(request)
+      end
+
+      def self.fake_payment_notification_for(cart)
+        Stall::Atos::FakeGatewayPaymentNotification.new(cart)
+      end
+
+      def target_url
+        test_mode ? test_payment_url : payment_url
+      end
+
+      # The gateway interface only provides one return URL, so we use the
+      # payment notification state  to determine wether to forward the customer
+      # to the next checkout step or not.
+      #
+      def synchronous_payment_notification?
+        true
+      end
+
+      private
+
+      # Override the transaction id methods, since the Atos gateway only
+      # authorize numbers
+      def next_transaction_id
+        if (last_transaction = Payment.order("data->>'transaction_id' DESC").select(:data).first)
+          if (id = last_transaction.transaction_id)
+            index = id[-5..-1].to_i + 1
+            return transaction_id_for(index)
+          end
+        end
+
+        transaction_id_for(1)
+      end
+
+      def transaction_id_for(index)
+        super.gsub(/-/, '')
+      end
+
+      def transaction_id_format
+        '%{cart_id}%{transaction_index}'
+      end
+
+      class Request
+        attr_reader :cart
+
+        delegate :currency, to: :cart, allow_nil: true
+
+        def initialize(cart)
+          @cart = cart
+        end
+
+        def payment_form_partial_path
+          'stall/atos/payment_form'
+        end
+
+        def params
+          @params ||= Stall::Atos::PaymentParams.new(gateway)
+        end
+
+        def gateway
+          @gateway = Stall::Atos::Gateway.new(cart)
+        end
+      end
+
+      class Response
+        attr_reader :request
+
+        def initialize(request)
+          @request = request
+        end
+
+        def rendering_options
+          { nothing: true }
+        end
+
+        def success?
+          response.success?
+        end
+
+        def notify
+          cart.payment.pay! if success?
+        end
+
+        def valid?
+          response.valid?
+        end
+
+        def cart
+          @cart ||= Cart.find_by_payment_transaction_id(response.transaction_id)
+        end
+
+        def gateway
+          @gateway = Stall::Atos::Gateway
+        end
+
+        private
+
+        def response
+          @response ||= Stall::Atos::PaymentResponse.new(
+            gateway, Rack::Utils.parse_nested_query(request.raw_post)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stall/atos/payment_params.rb

@@ -0,0 +1,52 @@
+require 'digest'
+
+module Stall
+  module Atos
+    class PaymentParams
+      attr_reader :gateway
+
+      delegate :cart, :target_url, :interface_version, to: :gateway
+
+      def initialize(gateway)
+        @gateway = gateway
+      end
+
+      def data
+        @data ||= self.class.serialize(
+          amount: cart.total_price.cents,
+          currencyCode: cart.currency.iso_numeric,
+          merchantId: gateway.merchant_id,
+          transactionReference: gateway.transaction_id(refresh: true),
+          keyVersion: gateway.key_version,
+          automaticResponseUrl: gateway.payment_urls.payment_notification_url,
+          normalReturnUrl: gateway.payment_urls.payment_success_return_url
+        )
+      end
+
+      def seal
+        @seal ||= self.class.calculate_seal_for(data)
+      end
+
+      private
+
+      # Transforms the provided hash to the following Atos accepted format :
+      #
+      #   key1=value1|key2=value2|...|keyN=valueN
+      #
+      def self.serialize(hash)
+        hash.map { |item| item.map(&:to_s).join('=') }.join('|')
+      end
+
+      def self.unserialize(string)
+        string.split('|').each_with_object({}.with_indifferent_access) do |str, hash|
+          key, value = str.split('=')
+          hash[key] = value
+        end
+      end
+
+      def self.calculate_seal_for(data)
+        Digest::SHA256.hexdigest([data, Stall::Atos::Gateway.secret_key].join)
+      end
+    end
+  end
+end

data/lib/stall/atos/payment_response.rb

@@ -0,0 +1,88 @@
+# This object handles the internal processing of Atos payment gateway response,
+# handling params parsing, request origin verification, success tracking and
+# other data extracting tasks
+#
+module Stall
+  module Atos
+    class PaymentResponse
+      attr_reader :gateway, :params
+
+      def initialize(gateway, params)
+        @gateway = gateway
+        @params = params
+      end
+
+      def transaction_id
+        data['transactionReference']
+      end
+
+      def success?
+        data['responseCode'] == '00'
+      end
+
+      # Ensure the response comes from the Gateway by casting the seal from the
+      # provided key-value string data and the secret key
+      #
+      def valid?
+        params['Seal'] == Stall::Atos::PaymentParams.calculate_seal_for(params['Data'])
+      end
+
+      def data
+        @data ||= Stall::Atos::PaymentParams.unserialize(params['Data'])
+      end
+
+      private
+
+      # Response code that can be sent from the ATOS gateway. They're not used
+      # for now and here just for reference, but could be used some day to
+      # implement a way to bubble payment processing errors to the end user.
+      #
+      def response_code_messages
+        @response_code_messages ||= {
+          '00' => %(Transaction approuvée ou traitée avec succès),
+          '02' => %(Contactez l'émetteur du moyen de paiement),
+          '03' => %(Accepteur invalide),
+          '04' => %(Conservez le support du moyen de paiement),
+          '05' => %(Ne pas honorer),
+          '07' => %(Conservez le support du moyen de paiement, conditions spéciales),
+          '08' => %(Approuvez après l'identification),
+          '12' => %(Transaction invalide),
+          '13' => %(Montant invalide),
+          '14' => %(Coordonnées du moyen de paiement invalides),
+          '15' => %(Émetteur du moyen de paiement inconnu),
+          '17' => %(Paiement interrompu par l'acheteur),
+          '24' => %(Opération impossible),
+          '25' => %(Transaction inconnue),
+          '30' => %(Érreur de format),
+          '31' => %(Id de l'organisation d'acquisition inconnu),
+          '33' => %(Moyen de paiement expiré),
+          '34' => %(Suspicion de fraude),
+          '40' => %(Fonction non supportée),
+          '41' => %(Moyen de paiement perdu),
+          '43' => %(Moyen de paiement volé),
+          '51' => %(Provision insuffisante ou crédit dépassé),
+          '54' => %(Moyen de paiement expiré),
+          '56' => %(Moyen de paiement manquant dans le fichier),
+          '57' => %(Transaction non autorisée pour ce porteur),
+          '58' => %(Transaction interdite au terminal),
+          '59' => %(Suspicion de fraude),
+          '60' => %(L'accepteur du moyen de paiement doit contacter l'acquéreur),
+          '61' => %(Éxcède le maximum autorisé),
+          '62' => %(Transaction en attente de confirmation de paiement),
+          '63' => %(Règles de sécurité non respectées),
+          '65' => %(Nombre de transactions du jour dépassé),
+          '68' => %(Réponse non parvenue ou reçue trop tard),
+          '75' => %(Nombre de tentatives de saisie des coordonnées du moyen de paiement dépassé 87 Terminal inconnu),
+          '90' => %(Arrêt momentané du système),
+          '91' => %(Émetteur du moyen de paiement inaccessible),
+          '92' => %(La transaction ne contient pas les informations suffisantes pour être redirigées vers l'organisme d'autorisation),
+          '94' => %(Transaction dupliquée),
+          '96' => %(Mauvais fonctionnement du système),
+          '97' => %(Requête expirée: transaction refusée),
+          '98' => %(Serveur inaccessible),
+          '99' => %(Incident technique)
+        }
+      end
+    end
+  end
+end

data/lib/stall/atos/version.rb

@@ -0,0 +1,5 @@
+module Stall
+  module Atos
+    VERSION = "0.1.1"
+  end
+end

data/stall-atos.gemspec

@@ -0,0 +1,27 @@
+ # coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stall/atos/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stall-atos'
+  spec.version       = Stall::Atos::VERSION
+  spec.authors       = ['vala']
+  spec.email         = ['vala@glyph.fr']
+
+  spec.summary       = %q{Stall e-commerce CM-CIC payment gateway integration}
+  spec.description   = %q{Allows easy CM-CIC gateway integration in a Stall e-commerce app}
+  spec.homepage      = 'https://github.com/rails-stall/stall-atos'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'stall', '~> 0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: stall-atos
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- vala
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stall
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Allows easy CM-CIC gateway integration in a Stall e-commerce app
+email:
+- vala@glyph.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/stall/atos/_payment_form.html.haml
+- bin/console
+- bin/setup
+- lib/generators/stall/atos/install/install_generator.rb
+- lib/generators/stall/atos/install/templates/config.rb
+- lib/stall/atos.rb
+- lib/stall/atos/engine.rb
+- lib/stall/atos/fake_gateway_payment_notification.rb
+- lib/stall/atos/gateway.rb
+- lib/stall/atos/payment_params.rb
+- lib/stall/atos/payment_response.rb
+- lib/stall/atos/version.rb
+- stall-atos.gemspec
+homepage: https://github.com/rails-stall/stall-atos
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Stall e-commerce CM-CIC payment gateway integration
+test_files: []