paiementcic/README.markdown

# Paiement CIC

Paiement CIC is a plugin to ease credit card payment with the CIC / Crédit Mutuel banks system version 3.0.
It's a Ruby on Rails port of the connexion kits published by the bank.

* The Plugin [site](http://github.com/novelys/cicpayment)
* The banks payment [site](http://www.cmcicpaiement.fr)


## INSTALL

    gem 'paiement_cic'

## USAGE

### in an initializer (`config/initializers/paiement_cic.rb`) :

```ruby
PaiementCic.default_config.configure do |config|
  # here the hmac key calculated with the js calculator given by CIC
  config.hmac_key = "########################################"
  # Here the TPE number
  config.tpe = "#######"
  # Here the Merchant name
  config.societe = "xxxxxxxxxxxxx"

  # You can specify the target URL
  config.target_url = "https://ssl.paiement.cic-banques.fr/test/paiement.cgi"
  # Or used predefined ones by specifying environment and bank
  config.bank = :cm # or :cic
  config.env = :test # or :production
end
```

You can also specify different attributes when initializing `PaiementCic::TPE` and with `paiement_cic_hidden_fields` helper by passing an hash.
```ruby
{
  hmac_key: "########################################",
  tpe: "#######",
  societe: "xxxxxxxxxxxxx",
  env: :test,
}
```

### in the payment by card view :

```
- form_tag PaiementCic.default_config.target_url do
  = paiement_cic_hidden_fields(@order.reference, @order.amount, mail: 'email@example.com', url_retour: edit_order_url(order), url_retour_ok: bank_ok_order_transaction_url(order_transaction), url_retour_err: bank_err_order_transaction_url(order_transaction))
  = submit_tag "Accéder au site de la banque", :style => "font-weight: bold;"
  = image_tag "reassuring_pictograms.jpg", :alt => "Pictogrammes rassurants", :style => "width: 157px;"
```

### in a controller for call back from the bank :

```ruby
class OrderTransactionsController < ApplicationController

  protect_from_forgery :except => [:bank_callback]

  def bank_callback
    tpe = PaiementCic::TPE.new

    if tpe.verify_hmac(params)
      order_transaction = OrderTransaction.find_by_reference params[:reference], :last
      order = order_transaction.order

      code_retour = params['code-retour']

      if code_retour == "Annulation"
        order.cancel!
        order.update_attribute :description, "Paiement refusé par la banque."

      elsif code_retour == "payetest"
        order.pay!
        order.update_attribute :description, "TEST accepté par la banque."
        order_transaction.update_attribute :test, true

      elsif code_retour == "paiement"
        order.pay!
        order.update_attribute :description, "Paiement accepté par la banque."
        order_transaction.update_attribute :test, false
      end

      order_transaction.update_attribute :success, true

      receipt = "0"
    else
      order.transaction_declined!
      order.update_attribute :description, "Document Falsifie."
      order_transaction.update_attribute :success, false

      receipt = "1\n#{tpe.mac_string}"
    end
    render :text => "Pragma: no-cache\nContent-type: text/plain\n\nversion=2\ncdr=#{receipt}"
  end

  def bank_ok
    @order_transaction = OrderTransaction.find params[:id]
    @order = @order_transaction.order
  end

  def bank_err
    order_transaction = OrderTransaction.find params[:id]
    order = order_transaction.order
  end
end
```



## License
Copyright (c) 2008-2012 Novelys Team, released under the MIT license