cic_payment 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7a9ab1ef67d2fa58b5d65ea218357c23309af5f
+  data.tar.gz: d6fa62f8539328b668989efa02990321301e1f99
+SHA512:
+  metadata.gz: 90b86638090ab0a557fd21027e963ca72658475e01e42c34a659fd0a03399cd8059396cbc681b34e880e290d03b01fc03eaeb12b3146f67e5b4a439d33677688
+  data.tar.gz: 93bda4215ce221d1f59a429e37a1e48a252d9a791b01394fd6b8f96d3dc60b80558da008425d9a79aae37a55eaf5264e2742016e18a992670f29242c09e0e2c0

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/MIT-LICENSE

@@ -0,0 +1,84 @@
+#encoding: utf-8
+Copyright (c) 2009 Novelys
+
+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.
+
+#==============================================================================
+#
+# "Open source" kit for P@iement CM-CIC(TM).
+# Integration sample in a merchant site for Ruby
+#
+# Author   : Euro-Information/e-Commerce (contact: centrecom@e-i.com)
+# Version  : 1.0
+# Date     : 01/01/2009
+#
+# Copyright: (c) 2009 Euro-Information. 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 and the following disclaimer.
+  - Redistributions in binary form must reproduce the above copyright
+    notice and the following disclaimer in the documentation and/or
+    other materials provided with the distribution.
+  - Neither the name of Euro-Information 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 HOLDERS 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.
+
+Note: Euro-Information does not provide person-to-person technical
+      support for tryout of CM-CIC P@iement examples. We do however
+      welcome your feedback which can be sent to <centrecom@e-i.com>.
+
+#------------------------------------------------------------------------------
+
+This software uses RSA Data Security, Inc. MD5 Message-Digest Algorithm.
+
+License to copy and use this software is granted provided that it is
+identified as the "RSA Data Security, Inc. MD5 Message-Digest
+Algorithm" in all material mentioning or referencing this software or
+this function.
+License is also granted to make and use derivative works provided that
+such works are identified as "derived from the RSA Data Security,
+Inc. MD5 Message-Digest Algorithm" in all material mentioning or
+referencing the derived work.
+RSA Data Security, Inc. makes no representations concerning either the
+merchantability of this software or the suitability of this software
+for any particular purpose. It is provided "as is" without express or
+implied warranty of any kind.
+These notices must be retained in any copies of any part of this
+documentation and/or software.
+
+#==============================================================================

data/README.markdown

@@ -0,0 +1,105 @@
+# CIC Payment
+
+CIC Payment is a plugin to ease credit card payment with the CIC / Credit Mutuel banks system version 3.0.
+It's a Ruby on Rails port of the connexion kits published by the bank.
+
+* The banks payment [site](http://www.cmcicpaiement.fr)
+
+
+## INSTALL
+
+In your Gemfile
+
+    gem 'cic_payment'
+
+## USAGE
+
+### Setup
+
+Create a `cic_payment.yml` config file in the `Rails.root/config` directory:
+
+    base: &base
+      # Hmac key calculated with the js calculator given by CIC
+      hmac_key: "AA123456AAAAAA789123BBBBBB123456CCCCCC12345678"
+
+      # TPE number
+      tpe: "010203"
+
+      # Version
+      version: "3.0"
+
+      # Merchant name
+      societe: "marchantname"
+
+      # Auto response URL
+      url_retour: 'http://return.fr'
+
+      # Success return path
+      url_retour_ok: 'http://return.ok'
+
+      # Error/cancel return path
+      url_retour_err: 'http://return.err'
+
+      target_url: "https://paiement.creditmutuel.fr/test/paiement.cgi"
+
+    production:
+      <<: *base
+      target_url: "https://paiement.creditmutuel.fr/paiement.cgi"
+
+    development:
+      <<: *base
+
+    test:
+      <<: *base
+
+***Note:*** this file _must_ be named _exactly_ `cic_payment.yml` or an exception would be raised
+
+`target_url` needs to point to the controller method handling the bank response (e.g. see below `payments#create`)
+
+### In the controller :
+
+    class PaymentsController < ApplicationController
+
+      def index
+        # :montant and :reference are required, you can also add :texte_libre, :lgue and :mail arguements if needed
+        @request = CicPayment.new.request(:montant => '123', :reference => '456')
+      end
+
+### Then in the view, generate the form:
+
+  The form generated is populated with hidden fields that will be sent to the bank gateway
+
+    # :button_text and :button_class are optionnal, use them for style cutomization if needed
+    = cic_payment_form(@request, :button_text => 'Payer', :button_class => 'btn btn-pink')
+
+### Now, listen to the bank transaction result:
+
+  Just add a create action in your payment controller
+
+    class PaymentsController < ApplicationController
+
+      protect_from_forgery :except => [:create]
+
+      def index
+        # :montant and :reference are required, you can also add :texte_libre, :lgue and :mail arguements if needed
+        @request = CicPayment.new.request(:montant => '123', :reference => '456')
+      end
+
+      def create
+        @response = CicPayment.new.response(params)
+
+        # Save and/or process the order as you need it (or not)
+      end
+
+      ...
+
+  The @response variable contains all the regular rails params received from the bank, plus an extra :success boolean parameter.
+
+
+## Contributors
+* Novelys Team : original gem and cryptographic stuff
+* Guillaume Barillot : refactoring and usage simplification
+* Michael Brung : configuration file refactoring.
+
+## Licence
+released under the MIT license

data/cic_payment.gemspec

@@ -0,0 +1,18 @@
+#encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "cic_payment"
+  s.version     = "0.4"
+  s.date        = "2014-03-18"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Novelys Team", 'Guillaume Barillot', 'Regis Millet (aka Kulgar)']
+  s.email       = "kulgar@ct2c.fr"
+  s.homepage    = "https://github.com/Kulgar/cic_payment"
+  s.summary     = %q{CIC / Credit Mutuel credit card payment toolbox}
+  s.description = %q{CIC Payment is a gem to ease credit card payment with the CIC / Credit Mutuel banks system. It's a Ruby on Rails port of the connexion kits published by the bank.}
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+end

data/lib/cic_payment.rb

@@ -0,0 +1,172 @@
+#encoding: utf-8
+require 'digest/sha1'
+require 'openssl'
+require 'payment_settings'
+require "view_helpers/form_helpers"
+
+ActionView::Base.send :include, FormHelpers
+
+class CicPayment < PaymentSettings
+
+  cattr_accessor :target_url, :version, :hmac_key, :tpe, :societe, :url_retour, :url_retour_ok, :url_retour_err, :societe
+  attr_accessor :date, :montant, :reference, :texte_libre, :lgue, :mail
+
+  @@tpe            = ""
+  @@version        = ""
+  @@societe        = ""
+  @@hmac_key       = ""
+  @@target_url     = ""
+  @@url_retour     = ""
+  @@url_retour_ok  = ""
+  @@url_retour_err = ""
+
+  def initialize
+
+    settings = self.load_settings
+
+    @@tpe            = settings[:tpe]
+    @@version        = settings[:version]
+    @@societe        = settings[:societe]
+    @@hmac_key       = settings[:hmac_key]
+    @@target_url     = settings[:target_url]
+    @@url_retour     = settings[:url_retour]
+    @@url_retour_ok  = settings[:url_retour_ok]
+    @@url_retour_err = settings[:url_retour_err]
+
+  end
+
+  def request(payment)
+
+    params = self.load_params(payment)
+
+    @date        = Time.now.strftime(self.date_format)
+    @montant     = params[:montant]
+    @reference   = params[:reference]
+
+    @texte_libre = params[:texte_libre]
+    @lgue        = params[:lgue]
+    @mail        = params[:mail]
+
+    return self
+  end
+
+  def response(params)
+
+    if verify_hmac(params)
+
+      if params['code-retour'] == "Annulation"
+        params.update(:success => false)
+
+      elsif params['code-retour'] == "payetest"
+        params.update(:success => true)
+
+      elsif params['code-retour'] == "paiement"
+        params.update(:success => true)
+      end
+
+    else
+      params.update(:success => false)
+    end
+
+  end
+
+  def self.mac_string params
+    hmac_key = CicPayment.new
+    mac_string = [hmac_key.tpe, params['date'], params['montant'], params['reference'], params['texte-libre'], hmac_key.version, params['code-retour'], params['cvx'], params['vld'], params['brand'], params['status3ds'], params['numauto'], params['motifrefus'], params['originecb'], params['bincb'], params['hpancb'], params['ipclient'], params['originetr'], params['veres'], params['pares']].join('*') + "*"
+  end
+
+  def verify_hmac params
+    mac_string = [self.tpe, params['date'], params['montant'], params['reference'], params['texte-libre'], self.version, params['code-retour'], params['cvx'], params['vld'], params['brand'], params['status3ds'], params['numauto'], params['motifrefus'], params['originecb'], params['bincb'], params['hpancb'], params['ipclient'], params['originetr'], params['veres'], params['pares']].join('*') + "*"
+
+    params['MAC'] ? hmac = params['MAC'] : hmac = ""
+    self.valid_hmac?(hmac)
+  end
+
+  # Check if the HMAC matches the HMAC of the data string
+	def valid_hmac?(sent_mac)
+		hmac_token == sent_mac.downcase
+	end
+
+  # Return the HMAC for a data string
+	def hmac_token
+    # This chain must contains:
+    # <TPE>*<date>*<montant>*<reference>*<texte-libre>*<version>*<lgue>*<societe>*<mail>*
+    # <nbrech>*<dateech1>*<montantech1>*<dateech2>*<montantech2>*<dateech3>*<montantech3>*
+    # <dateech4>*<montantech4>*<options>
+    # For a regular payment, it will be somthing like this: 
+    # 1234567*05/12/2006:11:55:23*62.73EUR*ABERTYP00145*ExempleTexteLibre*3.0*FR*monSite1*internaute@sonemail.fr**********
+    #
+    # So the chain array must contains 9 filled elements + 9 unfilled elements + 1 final star
+    # <text-libre>, <lgue> and <mail> are optional, but don't forget to put them in the chain if you decide to add
+    # them to the form
+    #
+    # For a fragmented payment: 
+    # 1234567*05/12/2006:11:55:23*62.73EUR*ABERTYP00145*ExempleTexteLibre*3.0*FR*monSite1*internaute@sonemail.fr*
+    # 4*05/12/2006*16.23EUR*05/01/2007*15.5EUR*05/02/2007*15.5EUR*05/03/2007*15.5EUR*
+    chain = [self.tpe,
+        self.date,
+        self.montant,
+        self.reference,
+        self.texte_libre,
+        self.version,
+        self.lgue,
+        self.societe,
+        self.mail,
+        "", "", "", "", "", "", "", "", "", "" # 10 stars: 9 for fragmented unfilled params + 1 final star 
+    ].join("*")
+
+		hmac_sha1(usable_key(self.hmac_key), chain).downcase
+	end
+
+protected
+  def date_format
+    "%d/%m/%Y:%H:%M:%S"
+  end
+
+  def hmac_sha1(key, data)
+    length = 64
+
+    if (key.length > length)
+      key = [Digest::SHA1.hexdigest(key)].pack("H*")
+    end
+
+    key  = key.ljust(length, 0.chr)
+    ipad = ''.ljust(length, 54.chr)
+    opad = ''.ljust(length, 92.chr)
+
+    k_ipad = compute(key, ipad)
+    k_opad = compute(key, opad)
+
+    OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new("sha1"), key, data)
+  end
+
+private
+	# Return the key to be used in the hmac method
+	def usable_key(hmac_key)
+
+		hex_string_key  = hmac_key[0..37]
+		hex_final   = hmac_key[38..40] + "00";
+
+		cca0 = hex_final[0].ord
+
+		if cca0 > 70 && cca0 < 97
+			hex_string_key += (cca0 - 23).chr + hex_final[1..2]
+		elsif hex_final[1..2] == "M"
+			hex_string_key += hex_final[0..1] + "0"
+		else
+			hex_string_key += hex_final[0..2]
+		end
+
+		[hex_string_key].pack("H*")
+	end
+
+  def compute(key, pad)
+    raise ArgumentError, "Can't bitwise-XOR a String with a non-String" \
+      unless pad.kind_of? String
+    raise ArgumentError, "Can't bitwise-XOR strings of different length" \
+      unless key.length == pad.length
+
+    result = (0..key.length-1).collect { |i| key[i].ord ^ pad[i].ord }
+    result.pack("C*")
+  end
+end

data/lib/payment_settings.rb

@@ -0,0 +1,90 @@
+#encoding: utf-8
+
+class PaymentSettings
+  def initialize
+    @settings = {}
+  end
+
+  def load_settings
+    load_yaml_config
+  end
+
+  def load_params(payment)
+    required_params(payment)
+    optionnal_params(payment)
+  end
+
+private
+  def optionnal_params(payment)
+    @settings ||= {}
+    @settings.update(:texte_libre => (payment[:texte_libre] || ""))
+    @settings.update(:lgue        => (payment[:lgue]        || "FR"))
+    @settings.update(:mail        => (payment[:mail]       || ""))
+  end
+
+  def required_params(payment)
+
+    @settings ||= {}
+
+    if payment[:montant]
+      @settings.update(:montant => ("%.2f" % payment[:montant]) + "EUR")
+    else
+      raise "CicPayment error ! Missing required parameter :montant"
+    end
+
+    if payment[:reference]
+      @settings.update(:reference => payment[:reference])
+    else
+      raise "CicPayment error ! Missing required parameter :reference"
+    end
+
+  end
+
+  def load_yaml_config
+    @settings ||= {}
+
+    path = Rails.root.join('config', 'cic_payment.yml')
+
+    if File.exist?(path)
+      config = YAML::load(ERB.new(File.read(path)).result)
+    else
+      raise "File config/cic_payment.yml does not exist"
+    end
+
+    env = Rails.env
+
+    unless config[env]
+      raise "config/cic_payment.yml is missing a section for `#{env}`"
+    end
+
+    settings = {
+      :tpe            => config[env]['tpe'],
+      :version        => config[env]['version'],
+      :societe        => config[env]['societe'],
+      :hmac_key       => config[env]['hmac_key'],
+      :target_url     => config[env]['target_url']
+    }
+
+    %i(url_retour url_retour_ok url_retour_err).each do |k|
+      provided_setting_for_key = config[env][k.to_s]
+
+      if provided_setting_for_key.is_a? Hash
+        merged_setting_for_key = provided_setting_for_key.merge!(Rails.application.config.payments.default_url_options)
+        
+        settings[k] =  Rails.application.routes.url_helpers.url_for(merged_setting_for_key)
+      else
+        settings[k] = provided_setting_for_key
+      end
+    end
+
+    settings.each do |key, value|
+      if value
+        @settings.update(key => value)
+      else
+        raise "CicPayment error ! Missing parameter :#{key} in /config/cic_payment.yml config file"
+      end
+    end
+
+  end
+
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module CicPayment
+  VERSION = "0.4.0".freeze
+end

data/lib/view_helpers/form_helpers.rb

@@ -0,0 +1,32 @@
+#encoding: utf-8
+module FormHelpers
+
+  def cic_payment_form(payment, options = {})
+
+    options[:button_text] ||= 'Payer'
+    options[:button_class] ||= ''
+
+    html = "<form name='cic_payment_form' action='#{payment.target_url}' method='post'>\n"
+
+    html << "  <input type='hidden' name='version'           id='version'        value='#{payment.version}' />\n"
+    html << "  <input type='hidden' name='TPE'               id='TPE'            value='#{payment.tpe}' />\n"
+    html << "  <input type='hidden' name='date'              id='date'           value='#{payment.date}' />\n"
+    html << "  <input type='hidden' name='montant'           id='montant'        value='#{payment.montant}' />\n"
+    html << "  <input type='hidden' name='reference'         id='reference'      value='#{payment.reference}' />\n"
+    html << "  <input type='hidden' name='MAC'               id='MAC'            value='#{payment.hmac_token}' />\n"
+    html << "  <input type='hidden' name='url_retour'        id='url_retour'     value='#{payment.url_retour}' />\n"
+    html << "  <input type='hidden' name='url_retour_ok'     id='url_retour_ok'  value='#{payment.url_retour_ok}' />\n"
+    html << "  <input type='hidden' name='url_retour_err'    id='url_retour_err' value='#{payment.url_retour_err}' />\n"
+    html << "  <input type='hidden' name='lgue'              id='lgue'           value='#{payment.lgue}' />\n"
+    html << "  <input type='hidden' name='societe'           id='societe'        value='#{payment.societe}' />\n"
+    html << "  <input type='hidden' name='texte-libre'       id='texte-libre'    value='#{payment.texte_libre}' />\n"
+    html << "  <input type='hidden' name='mail'              id='mail'           value='#{payment.mail}' />\n"
+
+    html << "  <input type='submit' name='submit_cic_payment_form' value='#{options[:button_text]}' class='#{options[:button_class]}' />\n"
+    html << "</form>\n"
+
+    html.respond_to?(:html_safe) ? html.html_safe : html
+
+  end
+
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: cic_payment
+version: !ruby/object:Gem::Version
+  version: '0.4'
+platform: ruby
+authors:
+- Novelys Team
+- Guillaume Barillot
+- Regis Millet (aka Kulgar)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies: []
+description: CIC Payment is a gem to ease credit card payment with the CIC / Credit
+  Mutuel banks system. It's a Ruby on Rails port of the connexion kits published by
+  the bank.
+email: kulgar@ct2c.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- cic_payment.gemspec
+- lib/cic_payment.rb
+- lib/payment_settings.rb
+- lib/version.rb
+- lib/view_helpers/form_helpers.rb
+homepage: https://github.com/Kulgar/cic_payment
+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.2.2
+signing_key: 
+specification_version: 4
+summary: CIC / Credit Mutuel credit card payment toolbox
+test_files: []
+has_rdoc: