stall-cmcic 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a914e16220b8089b5a56aba8e4b44430125a3fb0
+  data.tar.gz: 3b2e4f24fab5f541702dd37bbb8978622717d47f
+SHA512:
+  metadata.gz: 1c08e7b74c182a287e5d8307f935cc78a5f789d3563838c9d70caa2f1929a43ca84c5b170a5c64f32534cbcaecf8f10a2e7789dcd4a06b70f95df2fa744b1d8e
+  data.tar.gz: f7d7ff2892f5a1bcda448040b05537104c1274882f3d2f6b60cd41b9a02282965a68987e0474aa8cdfc6368003c9c83a9f9bde603fac21819076e9dbd903fccb

data/.gitignore

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

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-cmcic.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,74 @@
+# Stall::Cmcic
+
+This gem allows integrating your [Stall](https://github.com/stall-rails/stall)
+e-commerce app with the CM-CIC online payment gateway solution.
+
+This gem is just the glue between [Stall](https://github.com/stall-rails/stall)
+and the [cic_payment](https://github.com/Kulgar/cic_payment/) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stall-cmcic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stall-cmcic
+
+Then use the install generator to copy the config template file :
+
+    $ rails generator stall:cmcic: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 :
+
+- `CMCIC_HMAC_KEY`
+- `CMCIC_TPE`
+- `CMCIC_SOCIETE`
+
+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, juste set the following environment
+variable :
+
+- `CMCIC_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>/cmcic/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-cmcic.
+
+## 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/cmcic/_payment_form.html.haml

@@ -0,0 +1,17 @@
+%form.payment-gateway-form{ action: request.params.target_url, method: "post" }
+  %input#version{         name: "version",        type: "hidden", value: request.params.version }
+  %input#tpe{             name: "TPE",            type: "hidden", value: request.params.tpe }
+  %input#date{            name: "date",           type: "hidden", value: request.params.date }
+  %input#montant{         name: "montant",        type: "hidden", value: request.params.montant }
+  %input#reference{       name: "reference",      type: "hidden", value: request.params.reference }
+  %input#mac{             name: "MAC",            type: "hidden", value: request.params.hmac_token }
+  %input#url-retour{      name: "url_retour",     type: "hidden", value: request.params.url_retour }
+  %input#url-retour-ok{   name: "url_retour_ok",  type: "hidden", value: request.params.url_retour_ok }
+  %input#url-retour-err{  name: "url_retour_err", type: "hidden", value: request.params.url_retour_err }
+  %input#lgue{            name: "lgue",           type: "hidden", value: request.params.lgue }
+  %input#societe{         name: "societe",        type: "hidden", value: request.params.societe }
+  %input#texte-libre{     name: "texte-libre",    type: "hidden", value: request.params.texte_libre }
+  %input#mail{            name: "mail",           type: "hidden", value: request.params.mail }
+
+  %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/cmcic"
+
+# 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/cmcic/install/install_generator.rb

@@ -0,0 +1,13 @@
+module Stall
+  module Cmcic
+    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/cmcic/install/templates/config.rb

@@ -0,0 +1,21 @@
+  # CM-CIC payment gateway configuration
+  # Fill in the informations provided by your CM or CIC provider
+  #
+  config.payment.cmcic do |cmcic|
+    # Hmac key calculated with the js calculator given by CIC
+    cmcic.hmac_key = ENV['CMCIC_HMAC_KEY']
+    # TPE number
+    cmcic.tpe = ENV['CMCIC_TPE']
+    # Merchant name
+    cmcic.societe = ENV['CMCIC_SOCIETE']
+
+    # 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 `CMCIC_PRODUCTION_MODE=true` in your environment variables
+    # and restart your server to switch to production mode
+    #
+    cmcic.test_mode = ENV['CMCIC_PRODUCTION_MODE'] == 'true'
+  end
+

data/lib/stall/cmcic.rb

@@ -0,0 +1,16 @@
+require 'cic_payment'
+require 'stall'
+
+module Stall
+  module Cmcic
+    extend ActiveSupport::Autoload
+
+    autoload :CicPayment
+    autoload :Version
+    autoload :Utils
+    autoload :FakeGatewayPaymentNotification
+  end
+end
+
+require 'stall/cmcic/gateway'
+require 'stall/cmcic/engine'

data/lib/stall/cmcic/cic_payment.rb

@@ -0,0 +1,36 @@
+module Stall
+  module Cmcic
+    class CicPayment < ::CicPayment
+      # Override constructor to avoid loading a YAML file and use gateway's dynamic
+      # configuration instead
+      #
+      def initialize(gateway, parse_urls: false)
+        @@tpe            = gateway.tpe
+        @@version        = gateway.version
+        @@societe        = gateway.societe
+        @@hmac_key       = gateway.hmac_key
+
+        # Handle initialization from gateway class and not a gateway instance
+        if parse_urls
+          @@target_url     = gateway.target_url
+          @@url_retour     = gateway.payment_urls.payment_failure_return_url
+          @@url_retour_ok  = gateway.payment_urls.payment_success_return_url
+          @@url_retour_err = gateway.payment_urls.payment_failure_return_url
+        end
+      end
+
+      # Override this method to avoid implicit "EUR" currency appending
+      def required_params(payment)
+        @settings ||= {}
+
+        [:montant, :reference].each do |key|
+          if (value = payment[key])
+            @settings.update(key => value)
+          else
+            raise "CicPayment error ! Missing required parameter :#{ key }"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stall/cmcic/engine.rb

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

data/lib/stall/cmcic/fake_gateway_payment_notification.rb

@@ -0,0 +1,55 @@
+module Stall
+  module Cmcic
+    class FakeGatewayPaymentNotification < Stall::Payments::FakeGatewayPaymentNotification
+      include Stall::Cmcic::Utils
+
+      delegate :currency, to: :cart
+
+      def params
+        {}.tap do |params|
+          params.merge!(options)
+          params['MAC'] = bank_mac_key
+        end
+      end
+
+      private
+
+      def format_date(date)
+        date.strftime("%d/%m/%Y_a_%H:%M:%S")
+      end
+
+      def options
+        @options ||= {
+          'TPE' => Stall::Cmcic::Gateway.tpe,
+          'date' => format_date(Time.now),
+          'montant' => price_with_currency(cart.total_price),
+          'reference' => transaction_id,
+          'texte-libre' => cart.reference,
+          'code-retour' => "payetest",
+          'cvx' => "oui",
+          'vld' => "1219",
+          'brand' => "na",
+          'status3ds' => "-1",
+          'numauto' => 'xxxx',
+          'motifrefus' => "",
+          'originecb' => "00x",
+          'bincb' => "000001",
+          'hpancb' => "F6FBF44A7EC30941DA2E411AA8A50C77F174B2BB",
+          'ipclient' => "01.01.01.01",
+          'originetr' => "FRA",
+          'veres' => "",
+          'pares' => "",
+          'modepaiement' => "CB"
+        }
+      end
+
+      def bank_mac_key
+        @bank_mac_key ||= cic_payment.response_mac(options)
+      end
+
+      def cic_payment
+        @cic_payment ||= Stall::Cmcic::CicPayment.new(gateway)
+      end
+    end
+  end
+end

data/lib/stall/cmcic/gateway.rb

@@ -0,0 +1,119 @@
+module Stall
+  module Cmcic
+    class Gateway < Stall::Payments::Gateway
+      register :cmcic
+
+      # Hmac key calculated with the js calculator given by CIC
+      class_attribute :hmac_key
+      # TPE number
+      class_attribute :tpe
+      # Merchant name
+      class_attribute :societe
+
+      # Test or production mode, default to false, changes the payment
+      # gateway target URL
+      class_attribute :test_mode
+      self.test_mode = !Rails.env.production?
+
+      # Remote API version, should not change any time soon ...
+      class_attribute :version
+      self.version = "3.0"
+
+      def self.request(cart)
+        Request.new(cart)
+      end
+
+      def self.response(request)
+        Response.new(request)
+      end
+
+      def self.fake_payment_notification_for(cart)
+        Stall::Cmcic::FakeGatewayPaymentNotification.new(cart)
+      end
+
+      def target_url
+        if test_mode
+          "https://paiement.creditmutuel.fr/test/paiement.cgi"
+        else
+          "https://paiement.creditmutuel.fr/paiement.cgi"
+        end
+      end
+
+      class Request
+        include Stall::Cmcic::Utils
+
+        attr_reader :cart
+
+        delegate :currency, to: :cart, allow_nil: true
+
+        def initialize(cart)
+          @cart = cart
+        end
+
+        def payment_form_partial_path
+          'stall/cmcic/payment_form'
+        end
+
+        def params
+          @params ||= Stall::Cmcic::CicPayment.new(gateway, parse_urls: true).request(
+            montant: price_with_currency(cart.total_price),
+            reference: gateway.transaction_id,
+            texte_libre: cart.reference
+          )
+        end
+
+        def gateway
+          @gateway = Stall::Cmcic::Gateway.new(cart)
+        end
+      end
+
+      class Response
+        attr_reader :request
+
+        def initialize(request)
+          @request = request
+        end
+
+        def valid?
+          response.length > 1
+        end
+
+        def success?
+          response[:success]
+        end
+
+        def process
+          valid? && success?
+        end
+
+        def rendering_options
+          { text: "version=2\ncdr=#{ return_code }\n" }
+        end
+
+        def cart
+          @cart ||= ProductList.find_by_reference(response['texte-libre'])
+        end
+
+        def gateway
+          @gateway = Stall::Cmcic::Gateway
+        end
+
+        private
+
+        def response
+          @response ||= Stall::Cmcic::CicPayment.new(gateway).response(
+            Rack::Utils.parse_nested_query(request.raw_post)
+          )
+        end
+
+        def return_code
+          if success? || (response['code-retour'].try(:downcase) == 'annulation')
+            '0'
+          else
+            '1'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stall/cmcic/utils.rb

@@ -0,0 +1,14 @@
+module Stall
+  module Cmcic
+    module Utils
+      protected
+
+      def price_with_currency(price)
+        [
+          price.format(symbol: '', separator: '.', delimiter: ''),
+          currency
+        ].join
+      end
+    end
+  end
+end

data/lib/stall/cmcic/version.rb

@@ -0,0 +1,5 @@
+module Stall
+  module Cmcic
+    VERSION = "0.2.0"
+  end
+end

data/stall-cmcic.gemspec

@@ -0,0 +1,28 @@
+ # coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stall/cmcic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stall-cmcic'
+  spec.version       = Stall::Cmcic::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-cmcic'
+  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.3'
+  spec.add_dependency 'cic_payment', '~> 0.4'
+
+  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,134 @@
+--- !ruby/object:Gem::Specification
+name: stall-cmcic
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- vala
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stall
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: cic_payment
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !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/cmcic/_payment_form.html.haml
+- bin/console
+- bin/setup
+- lib/generators/stall/cmcic/install/install_generator.rb
+- lib/generators/stall/cmcic/install/templates/config.rb
+- lib/stall/cmcic.rb
+- lib/stall/cmcic/cic_payment.rb
+- lib/stall/cmcic/engine.rb
+- lib/stall/cmcic/fake_gateway_payment_notification.rb
+- lib/stall/cmcic/gateway.rb
+- lib/stall/cmcic/utils.rb
+- lib/stall/cmcic/version.rb
+- stall-cmcic.gemspec
+homepage: https://github.com/rails-stall/stall-cmcic
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Stall e-commerce CM-CIC payment gateway integration
+test_files: []