sermepa_web_tpv 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Ricard Forniol Agustí
+
+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,83 @@
+# Sermepa web TPV
+
+Add simple web payment tpv to your rails application
+
+
+Steps to use it:
+
+1. Create a new rails application
+
+	rails new payment_app
+
+2. Add sermepa_web_tpv to your Gemfile
+
+	gem 'sermepa_web_tpv'
+
+3. Add a transaction model with an amount and transaction_number fields
+
+	rails g model Transaction amount:float transaction_number:integer
+
+4. Configure tpv options
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    config.web_tpv.bank_url = 'https://sis-t.sermepa.es:25443/sis/realizarPago'
+    config.web_tpv.response_host = 'my_application_host.com'
+    config.web_tpv.merchant_code = '000000000'
+    config.web_tpv.terminal = 1
+    config.web_tpv.callback_response_path = '/payments/validate'
+    config.web_tpv.redirect_success_path = '/payments/success'
+    config.web_tpv.redirect_failure_path = '/payments/failure'
+    config.web_tpv.merchant_secret_key = 'superseeeecretstring'
+    config.web_tpv.currency = 978 # Euro
+
+    config.web_tpv.transaction_type = 0
+    config.web_tpv.language = '003' #Catala
+    config.web_tpv.merchant_name = 'MY MERCHANT NAME'
+  end
+end
+```
+
+5. Add a controller payment to perform a new request payment and receive payment result
+
+```ruby
+MyApp::Application.routes.draw do
+  get 'payments/new' => 'payments#new', :as => 'new_payment'
+  post 'payments/validate' => 'payments#validate', :as => 'payment_validate'
+  get  'payments/success' => 'payments#success', :as => 'payment_success'
+  get  'payments/failure' => 'payments#failure', :as => 'payment_failure'
+end
+```
+
+```ruby
+class PaymentsController
+  skip_before_filter :verify_authenticity_token
+
+  def new
+    transaction = Transaction.new(amount: 10)
+    request = SermepaWebTpv::Request.new(transaction, "Transaction description")
+    request.transact {|t| t.save }
+    render json: { options: sermepa_request.options, url: sermepa_request.bank_url }
+    # Submit a form with given options to the url
+  end
+
+  def success
+    flash[:notice] = "Payment done successfuly!"
+    redirect_to root_path
+  end
+
+  def failure
+    flash[:failure] = "Payment failed, try again later."
+    redirect_to root_path
+  end
+
+  def validate
+    response = SermepaWebTpv::Response.new(params)
+    if response.valid? && response.success?
+      # mark your transaction as finished
+    end
+  end
+end
+```
+

data/Rakefile

@@ -0,0 +1,33 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+
+  RDoc::Task = Rake::RDocTask
+end
+
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SermepaWebTpv'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+

data/lib/sermepa_web_tpv/persistence/active_record.rb

@@ -0,0 +1,20 @@
+module SermepaWebTpv
+  module Persistence
+    module ActiveRecord
+      def transaction_number
+        generate_transaction_number! if transaction.new_record?
+
+        transaction.send(transaction_number_attribute)
+      end
+
+      def transaction_amount
+        transaction.send(transaction_model_amount_attribute)
+      end
+
+      def generate_transaction_number!
+        number = Time.now.strftime('%y%m%d%H%M%S')
+        transaction.update_attribute(transaction_number_attribute, number)
+      end
+    end
+  end
+end

data/lib/sermepa_web_tpv/railtie.rb

@@ -0,0 +1,5 @@
+module SermepaWebTpv
+  class Railtie < Rails::Railtie
+    config.web_tpv = SermepaWebTpv
+  end
+end

data/lib/sermepa_web_tpv/request.rb

@@ -0,0 +1,84 @@
+require 'uri'
+require 'digest/sha1'
+
+module SermepaWebTpv
+  class Request < Struct.new(:transaction, :description)
+    include SermepaWebTpv::Persistence::ActiveRecord
+
+    def bank_url
+      SermepaWebTpv.bank_url
+    end
+
+    def options
+      optional_options.merge(must_options)
+    end
+
+    def transact(&block)
+      generate_transaction_number!
+      yield(transaction)
+      self
+    end
+
+    private
+
+    def transaction_number_attribute
+      SermepaWebTpv.transaction_model_transaction_number_attribute
+    end
+
+    def transaction_model_amount_attribute
+      SermepaWebTpv.transaction_model_amount_attribute
+    end
+
+    def amount
+      (transaction_amount * 100).to_i.to_s
+    end
+
+    def must_options
+      {
+        'Ds_Merchant_Amount' =>             amount,
+        'Ds_Merchant_Currency' =>           SermepaWebTpv.currency, #EURO
+        'Ds_Merchant_Order' =>              transaction_number,
+        'Ds_Merchant_ProductDescription' => description,
+        'Ds_Merchant_MerchantCode' =>       SermepaWebTpv.merchant_code,
+        'Ds_Merchant_MerchantSignature' =>  signature,
+        'Ds_Merchant_Terminal' =>           SermepaWebTpv.terminal,
+        'Ds_Merchant_TransactionType' =>    SermepaWebTpv.transaction_type,
+        'Ds_Merchant_ConsumerLanguage' =>   SermepaWebTpv.language,
+        'Ds_Merchant_MerchantURL' =>        url_for(:callback_response_path)
+      }
+    end
+
+    def signature
+      #Ds_Merchant_Amount + Ds_Merchant_Order +Ds_Merchant_MerchantCode + Ds_Merchant_Currency +Ds_Merchant_TransactionType + Ds_Merchant_MerchantURL + CLAVE SECRETA
+      merchant_code = SermepaWebTpv.merchant_code
+      currency = SermepaWebTpv.currency
+      transaction_type = SermepaWebTpv.transaction_type
+      callback_url = url_for(:callback_response_path)
+      merchant_secret_key = SermepaWebTpv.merchant_secret_key
+      Digest::SHA1.hexdigest("#{amount}#{transaction_number}#{merchant_code}#{currency}#{transaction_type}#{callback_url}#{merchant_secret_key}").upcase
+    end
+
+    # Available options
+    # redirect_success_path
+    # redirect_failure_path
+    # callback_response_path
+    def url_for(option)
+      host = SermepaWebTpv.response_host
+      path = SermepaWebTpv.send(option)
+
+      if host.present? && path.present?
+        URI.join("http://#{host}", path).to_s
+      end
+    end
+
+    def optional_options
+      {
+        'Ds_Merchant_Titular'      => SermepaWebTpv.merchant_name,
+        'Ds_Merchant_UrlKO'        => url_for(:redirect_failure_path),
+        'Ds_Merchant_UrlOK'        => url_for(:redirect_success_path)
+      }.delete_if {|key, value| value.blank? }
+    end
+
+
+  end
+end

data/lib/sermepa_web_tpv/response.rb

@@ -0,0 +1,25 @@
+require 'digest/sha1'
+
+module SermepaWebTpv
+  class Response < Struct.new(:params)
+    def valid?
+      params[:Ds_Signature] == signature
+    end
+
+    def success?
+      params[:Ds_Response].to_i == 0
+    end
+
+    private
+    def signature
+      response = %W(
+        #{params[:Ds_Amount]}
+        #{params[:Ds_Order]}
+        #{params[:Ds_MerchantCode]}
+        #{params[:Ds_Currency]}
+        #{params[:Ds_Response]}
+        #{SermepaWebTpv.merchant_secret_key}
+      ).join
+      Digest::SHA1.hexdigest(response).upcase
+  end
+end

data/lib/sermepa_web_tpv/version.rb

@@ -0,0 +1,3 @@
+module SermepaWebTpv
+  VERSION = "0.0.1"
+end

data/lib/sermepa_web_tpv.rb

@@ -0,0 +1,50 @@
+require 'active_support/core_ext/module/attribute_accessors'
+module SermepaWebTpv
+
+  mattr_accessor :transaction_model_transaction_number_attribute
+  @@transaction_model_transaction_number_attribute = :transaction_number
+
+  mattr_accessor :transaction_model_amount_attribute
+  @@transaction_model_amount_attribute = :amount
+
+  mattr_accessor :bank_url
+  @@bank_url = 'https://sis-t.sermepa.es:25443/sis/realizarPago'
+
+  mattr_accessor :terminal
+  @@terminal = 1
+
+  mattr_accessor :merchant_secret_key
+
+  mattr_accessor :currency
+  @@currency = 978 # Euro
+
+  mattr_accessor :merchant_code
+
+  mattr_accessor :transaction_type
+  @@transaction_type = 0
+
+  mattr_accessor :language
+  @@language = '003' #Catala
+
+  mattr_accessor :response_host
+  @@response_host = '' #'shop_name.com'
+
+  mattr_accessor :callback_response_path
+  @@callback_response_path = '' #"/payments/callback"
+
+  # Optional
+  mattr_accessor :merchant_name
+  @@merchant_name = '' #'shop name'
+
+  mattr_accessor :redirect_success_path
+  @@redirect_success_path = nil #"/payments/success"
+
+  mattr_accessor :redirect_failure_path
+  @@redirect_failure_path = nil #"/payments/failure"
+
+  autoload :Request, 'sermepa_web_tpv/request'
+  autoload :Response, 'sermepa_web_tpv/response'
+
+end
+require 'sermepa_web_tpv/persistence/active_record'
+require 'sermepa_web_tpv/railtie'

data/lib/tasks/sermepa_web_tpv.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :defaultable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: sermepa_web_tpv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ricard Forniol Agustí
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.17
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nyan-cat-formatter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple rails engine to add payments to your web application using sermepa
+  standard web tpv
+email:
+- ricard@forniol.cat
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sermepa_web_tpv/persistence/active_record.rb
+- lib/sermepa_web_tpv/railtie.rb
+- lib/sermepa_web_tpv/request.rb
+- lib/sermepa_web_tpv/response.rb
+- lib/sermepa_web_tpv/version.rb
+- lib/sermepa_web_tpv.rb
+- lib/tasks/sermepa_web_tpv.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://github.com/ritxi/sermepa_web_tpv
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Add simple web tpv from sermepa to your rails application
+test_files: []