redsys-rails 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b62aaf9562efda0dd97753c3fc5bd8134f49837
-  data.tar.gz: 17694548d97b8bc42b3de71262a00f019d1e8243
+  metadata.gz: 5b82968f40f5fc6e3c85abd2504ebf0a1bbb380f
+  data.tar.gz: 2df72a13f967db89c5324897f54c409acb73a2fc
 SHA512:
-  metadata.gz: 86061b3497e5b234885a22545a507a12bbb4a2804fe1dd0d69f385862020692d91da7bb9196b74f1d76561aab05e5ef1a4b877ad21d3eb7644add0332f5b5998
-  data.tar.gz: 6229ab27f6fae95d65ac54a411311d7e7d7015e9d575fdbc74a37fbc97e0ed22ddf04a6394a88eb2a6ea7523afa8122dd1c942405a54b238d16de171b1eccd17
+  metadata.gz: 4d85f101c14b361ab407069de6f2f2fbb67569ca9ecca43b27b2032f9a21867c5b1a433d85381efa3a81153ec5e00b6d71ce6cff4e0f5507576adf2a95965fe3
+  data.tar.gz: 035e5278265f1b4aabb372691a19795b5e274ddc1c042f07a4ab037f4860454bc54d929f8da59af2eee95d3613cd802c9395b1f92e99f7c191326df443c17d0f

data/README.md

@@ -1,33 +1,79 @@
 # Redsys::Rails
 
-Gem Payment platform Redsys
+Redsys-Rails es una pequeña solución para integrar de forma rápida y sencilla la pasarela de pago de [Redsys.es](http://www.redsys.es/).
 
-A Ruby gem for communicating with the payment platform of Redsys
+## Requerimientos
+- Esta gema solo proporciona las herramientas necesarias para integrar la opción de redirección desde la página web del comercio al TPV virtual contratado.
+- Es necesario disponer de las claves de acceso que la entidad financiera habrá proporcionado al comercio para poder instalar esta gema.
 
-## Installation
+## Instalación
 
-Add this line to your application's Gemfile:
+Añade la siguiente línea al Gemfile de tu aplicación:
 
 ```ruby
 gem 'redsys-rails'
 ```
 
-And then execute:
+Ejecuta:
 
     $ bundle
 
-Or install it yourself as:
+O instala la gema tu mismo:
 
     $ gem install redsys-rails
 
-## Usage
+Genera el inicializador ejecutando el generador:
 
+    $ rails g redsys:install
 
+Por último, configura los parámetros del TPV virutal en [config/initializers/redsys-rails.rb](lib/generators/templates/redsys-rails.rb)
 
-## Contributing
+## Utilización
 
-1. Fork it ( https://github.com/[my-github-username]/redsys-rails/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+En el controlador donde realice el tratamiento de su pedido, una vez obtenido el id único del mismo, 
+redireccione al formulario de salto del tpv virtual mediante el siguiente código.
+
+```ruby
+redirect_to redsys_form_path(amount: '', order: '', language: '')
+```
+
+Un ejemplo:
+
+```ruby
+redirect_to redsys_form_path(amount: '20.35', order: '0001', language: '001')
+```
+
+#### Códigos de idioma
+
+Castellano-001, Inglés-002, Catalán-003, Francés-004, Alemán-005, Holandés-006, Italiano-007, Sueco-008, Portugués-009,
+Valenciano-010, Polaco-011, Gallego-012 y Euskera-013
+
+#### URL de retorno
+
+Si no ha configurado las url's de retorno para transacción correcta y para transacción fallida en el panel de control de su comercio,
+puede proporcionarlas en la redirección mediante los parámetros url_ok y url_ko.
+
+Un ejemplo:
+
+```ruby
+redirect_to redsys_form_path(amount: '20.35', order: '0001', language: '001', url_ok: 'http://misite.com/pedido_ok', url_ko: 'http://misite.com/pedido_error')
+```
+
+## Notificación on-line
+
+Instalación del webhook para la notificación online.
+
+    $ rails g redsys:notifications
+
+El módulo es funcional y hace accesible una ruta para que el TPV virtual pueda notificar la transacción. Es aquí donde el comercio
+ha de realizar las acciones necesarias, como por ejemplo actualizar el estado de su pedido confirmando el pago.
+
+*Falta una explicación más detallada de esta funcionalidad.*
+
+## Contribuir
+
+1. Fork ( https://github.com/[my-github-username]/redsys-rails/fork )
+2. Crea la rama de tu funcionalidad (`git checkout -b my-new-feature`)
+3. Commita tus cambios (`git commit -am 'Add some feature'`)
+4. Push a la rama (`git push origin my-new-feature`)
+5. Crea un nuevo Pull Request

data/app/controllers/redsys/tpv_controller.rb

@@ -0,0 +1,23 @@
+module Redsys
+  class TpvController < ApplicationController
+    skip_before_filter :verify_authenticity_token, only: [:confirmation]
+
+    #
+    # Formulario de salto a la pasarela de pago
+    # - amount:decimal => Importe a cobrar
+    # - order:integer => identidificador del pedido/reserva, ha de ser único
+    # - language:string => '001' Español, '002' Inglés...
+    # - url_ok:string => url de vuelta del tpv para pago correcto
+    # - url_ko:string => url de vuelta del tpv cuando ocurre un error
+    #
+    def form
+      amount = BigDecimal.new(params[:amount] || '0')
+      order = Integer(params[:order] || '0')
+      language = params[:language]
+      url_ok = params[:url_ok]
+      url_ko = params[:url_ko]
+      @tpv = Redsys::Tpv.new(amount, order, language, redsys_notification_url, url_ok, url_ko)
+    end
+    
+  end
+end

data/app/models/redsys/tpv.rb

@@ -0,0 +1,87 @@
+require 'openssl'
+require 'base64'
+require 'json'
+
+module Redsys
+  class Tpv
+    attr_accessor :amount, :language, :order, :currency, :merchant_code, :terminal,
+                  :transaction_type, :merchant_url, :url_ok, :url_ko, :sha1, :signature
+
+    def self.tpv_url
+      Rails.configuration.redsys_rails[:url]
+    end
+
+    def self.signature_version
+      Rails.configuration.redsys_rails[:signature_version]
+    end
+
+    def initialize(amount, order, language, merchant_url = nil, url_ok = nil, url_ko = nil)
+      amount        ||= 0
+      order         ||= 0
+      language      ||= '001'
+      merchant_url  ||= ''
+      url_ok        ||= ''
+      url_ko        ||= ''
+
+      @amount = (amount * 100).to_i.to_s
+      @order = order.to_s.rjust(4, '0')
+      @language = language
+      @merchant_url = merchant_url
+      @url_ok = url_ok
+      @url_ko = url_ko
+
+      @currency = Rails.configuration.redsys_rails[:merchant_currency]
+      @merchant_code = Rails.configuration.redsys_rails[:merchant_code]
+      @terminal = Rails.configuration.redsys_rails[:merchant_terminal]
+      @transaction_type = Rails.configuration.redsys_rails[:merchant_transaction_type]
+    end
+
+    def merchant_params
+      "#{Base64.strict_encode64(merchant_params_json)}"
+    end
+
+    def merchant_params_json
+      merchant_parameters = { 
+        :DS_MERCHANT_AMOUNT => @amount,
+        :DS_MERCHANT_ORDER => @order,
+        :DS_MERCHANT_MERCHANTCODE => @merchant_code,
+        :DS_MERCHANT_CURRENCY => @currency,
+        :DS_MERCHANT_TRANSACTIONTYPE => @transaction_type,
+        :DS_MERCHANT_TERMINAL => @terminal,
+        :DS_MERCHANT_MERCHANTURL => @merchant_url,
+        :DS_MERCHANT_URLOK => @url_ok,
+        :DS_MERCHANT_URLKO => @url_ko 
+      }
+      JSON.generate(merchant_parameters)
+    end
+
+    def merchant_signature_3des
+      Base64.strict_encode64(encrypt_3DES(@order, Base64.strict_decode64(Rails.configuration.redsys_rails[:sha_256_key])))
+    end
+
+    def merchant_signature
+      key = Base64.strict_decode64(Rails.configuration.redsys_rails[:sha_256_key])
+      key = encrypt_3DES(@order, key)
+      encrypt_mac256(merchant_params, key)
+    end
+
+    private
+
+      def encrypt_mac256(data, key)
+        Base64.strict_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, data))
+      end
+    
+      def encrypt_3DES(data, key)
+        cipher = OpenSSL::Cipher::Cipher.new('DES3')
+        cipher.encrypt
+        cipher.key = key
+        cipher.padding = 0
+        block_length = 8
+        data_str = data
+        data_str += "\0" until data_str.bytesize % block_length == 0
+        output = cipher.update(data_str)
+        output << cipher.final
+        output
+      end
+  end
+end

data/app/views/redsys/tpv/form.html.erb

@@ -0,0 +1,8 @@
+<%= form_tag(Redsys::Tpv.tpv_url, id: 'redsys_tpv_form') do %>
+  <%= hidden_field_tag 'Ds_SignatureVersion', Redsys::Tpv.signature_version %>
+  <%= hidden_field_tag 'Ds_MerchantParameters', @tpv.merchant_params %>
+  <%= hidden_field_tag 'Ds_Signature', @tpv.merchant_signature %>
+<% end %>
+<script type="text/javascript">
+  document.getElementById("redsys_tpv_form").submit();
+</script>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get 'redsys/form' => 'redsys/tpv#form', as: :redsys_form
+end

data/lib/generators/redsys/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+module Redsys
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def copy_initializer
+        template "redsys-rails.rb", "config/initializers/redsys-rails.rb"
+      end
+    end
+  end
+end
+

data/lib/generators/redsys/notifications_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+module Redsys
+  module Generators
+    class NotificationsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def copy_controller
+        template "controllers/notifications_controller.rb", "app/controllers/redsys/notifications_controller.rb"
+      end
+
+      def add_routes
+        route "post 'redsys/notification' => 'redsys/notifications#notification', as: :redsys_notification"
+      end
+    end
+  end
+end

data/lib/generators/templates/controllers/notifications_controller.rb

@@ -0,0 +1,19 @@
+module Redsys
+  class NotificationsController < ApplicationController
+    skip_before_filter :verify_authenticity_token
+
+    #
+    # Tratamiento para la notificación online
+    # - Ds_Response == "0000" => Transacción correcta
+    #
+    def notification
+      json_params = JSON.parse(Base64.strict_decode64(params[:Ds_MerchantParameters]))
+      if json_params["Ds_Response"].present? && json_params["Ds_Response"] == "0000"
+        status = :ok
+      else
+        status = :bad_request
+      end
+      render nothing: true, layout: false, status: status
+    end
+  end
+end

data/lib/generators/templates/redsys-rails.rb

@@ -0,0 +1,12 @@
+#
+# * Valores proporcionados por su entidad financiera
+#
+Rails.configuration.redsys_rails = {
+  url: '',                            # * Url TPV
+  sha_256_key: '',                    # * Clave para firma HMAC SHA256
+  merchant_code: '',                  # * Código de comercio
+  merchant_terminal: '',              # * Terminal
+  merchant_transaction_type: '',      # * Tipo de transacción
+  merchant_currency: '978',           # * 978: euro, 840: dólares, 826: libras, 392: yenes
+  signature_version: 'HMAC_SHA256_V1' # Versión firma HMAC SHA256
+}

data/lib/redsys-rails/version.rb

@@ -1,5 +1,5 @@
 module RedsysRails
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redsys-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - guzmanweb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,7 +50,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/models/redsys_tpv.rb
+- app/controllers/redsys/tpv_controller.rb
+- app/models/redsys/tpv.rb
+- app/views/redsys/tpv/form.html.erb
+- config/routes.rb
+- lib/generators/redsys/install_generator.rb
+- lib/generators/redsys/notifications_generator.rb
+- lib/generators/templates/controllers/notifications_controller.rb
+- lib/generators/templates/redsys-rails.rb
 - lib/redsys-rails.rb
 - lib/redsys-rails/version.rb
 - redsys-rails.gemspec
@@ -74,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for communicating with the payment platform of Redsys

data/app/models/redsys_tpv.rb

@@ -1,69 +0,0 @@
-require 'openssl'
-require 'base64'
-require 'json'
-
-class RedsysTpv
-  attr_accessor :amount, :language, :order, :currency, :merchant_code, :terminal,
-                :transaction_type, :merchant_url, :url_ok, :url_ko, :sha1, :signature
-
-  def initialize(amount, order, language)
-    @amount = (amount * 100).to_i.to_s
-    @language = (language == :es) ? '001' : '002'
-    @order = order.to_s.rjust(4, '0')
-    
-    @currency = Rails.application.secrets.tpv_merchant_currency
-    @merchant_code = Rails.application.secrets.tpv_merchant_code
-    @terminal = Rails.application.secrets.tpv_merchant_terminal
-    @transaction_type = Rails.application.secrets.tpv_merchant_transaction_type
-    
-    #@merchant_url = "#{Rails.application.secrets.tpv_merchant_url}?booking_id=#{booking.id}&language=#{I18n.locale}"
-  end
-
-  def merchant_params
-    Base64.strict_encode64(merchant_params_json)
-  end
-
-  def merchant_params_json
-    merchant_parameters = { 
-      :DS_MERCHANT_AMOUNT => @amount,
-      :DS_MERCHANT_ORDER => @order,
-      :DS_MERCHANT_MERCHANTCODE => @merchant_code,
-      :DS_MERCHANT_CURRENCY => @currency,
-      :DS_MERCHANT_TRANSACTIONTYPE => @transaction_type,
-      :DS_MERCHANT_TERMINAL => @terminal,
-      :DS_MERCHANT_MERCHANTURL => @merchant_url,
-      :DS_MERCHANT_URLOK => @url_ok,
-      :DS_MERCHANT_URLKO => @url_ko 
-    }
-    JSON.generate(merchant_parameters)
-  end
-
-  def merchant_signature_3des
-    Base64.strict_encode64(encrypt_3DES(@order, Base64.strict_decode64(Rails.application.secrets.tpv_sha_256_key)))
-  end
-
-  def merchant_signature
-    key = Base64.strict_decode64(Rails.application.secrets.tpv_sha_256_key)
-    key = encrypt_3DES(@order, key)
-    encrypt_mac256(merchant_params, key)
-  end
-
-  private
-
-    def encrypt_mac256(data, key)
-      Base64.strict_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, data))
-    end
-  
-    def encrypt_3DES(data, key)
-      cipher = OpenSSL::Cipher::Cipher.new('DES3')
-      cipher.encrypt
-      cipher.key = key
-      cipher.padding = 0
-      block_length = 8
-      data_str = data
-      data_str += "\0" until data_str.bytesize % block_length == 0
-      output = cipher.update(data_str)
-      output << cipher.final
-      output
-    end
-end