active_merchant_sermepa 0.1.1

data/.gitignore

@@ -0,0 +1,5 @@
+tmp/*
+nbproject
+.svn
+.DS_Store
+*.swp

data/CHANGELOG

@@ -0,0 +1,3 @@
+
+v0.0.1. First import from active merchant repo
+

data/Gemfile

@@ -0,0 +1,4 @@
+
+source :rubygems
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    active_merchant_sermepa (0.0.1)
+      activemerchant (>= 1.9.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemerchant (1.11.0)
+      activesupport (>= 2.3.8)
+      braintree (>= 2.0.0)
+      builder (>= 2.0.0)
+    activemodel (3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.4)
+    braintree (2.8.0)
+      builder
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mocha (0.9.12)
+    money (3.5.5)
+      i18n (~> 0.4)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    tzinfo (0.3.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.0.3)
+  active_merchant_sermepa!
+  activemerchant (>= 1.9.4)
+  mocha (~> 0.9.10)
+  money (~> 3.5.4)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Samuel Lown
+
+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/Manifest

@@ -0,0 +1,15 @@
+CHANGELOG
+MIT-LICENSE
+Manifest
+README.rdoc
+Rakefile
+active_merchant_sermepa.gemspec
+lib/active_merchant/billing/integrations/sermepa.rb
+lib/active_merchant/billing/integrations/sermepa/helper.rb
+lib/active_merchant/billing/integrations/sermepa/notification.rb
+lib/active_merchant/billing/integrations/sermepa/return.rb
+lib/active_merchant_sermepa.rb
+test/test_helper.rb
+test/unit/integrations/helpers/sermepa_helper_test.rb
+test/unit/integrations/notifications/sermepa_notification_test.rb
+test/unit/integrations/sermepa_module_text.rb

data/README.rdoc

@@ -0,0 +1,158 @@
+= Active Merchant Sermepa Plugin
+
+Basic support for the Spanish SERMEPA Virtual POS payment gateway provided by Servired.
+Used by many banks in Spain and known locally as a "TPV Virtual".
+
+Include this library along with the standard active merchant package and a new
+Integration payment gateway will be available.
+
+
+== Install
+
+Add to your Gemfile as follows:
+
+    gem 'activemerchant_sermepa'
+
+That should automatically install a usable version of active merchant as a dependency.
+
+== Usage
+
+This is an integrated payment gateway and as such requires all credit card details
+to be provided outside of your own website's pages. The basic purchase process is:
+
+1. HTML form shown on website with payment details
+2. Form is submitted directly to Sermepa's servers
+3. User provides credit card and completes validatation proceedures (this can be a pain in the *** for your clients if they don't have the necessary login details, ask your bank to disable it if you get lots of complaints.)
+4. Optional: website receives notification from sermepa of sale result
+5. User forwarded back to your website. If the "Parameters in URL" (Parámetros en las URLs) option is set in the point of sale's configuration, the user will be forwarded with a set of parameters that can be used to validate the purchase.
+6. Confirm that the purchase is successful using either notification or parameters in URL.
+
+Sermepa, unlike the similar BBVA system, does not support manual requests to confirm
+the success of a sale. Validation must be done using the parameters received either
+from the notification or paremeters in forwarded URL.
+
+
+=== Configuration
+
+Your bank should provide you with three keys, known as the "terminal id", "commercial id",
+and "secret key". These when combined allow requests to be signed and incoming confirmations
+to be validated. A final option is available to set the the type of key used in the
+transactions. The "key type" can be set to either "sha1_complete" or "sha1_extended 
+according to whatever is set by your bank.
+
+These configuration options can either be set globally or on a per-request basis. The
+following would be included in an initializer to prepare the gateway for use:
+
+    ActiveMerchant::Billing::Integrations::Sermepa::Helper.credentials = {
+      :terminal_id   => '9',
+      :commercial_id => ''999008881,
+      :secret_key    => 'qwertyasdf0123456789',
+      :key_type      => 'sha1_complete'
+    }
+
+If the credentials are not set this way, they'll need to be included with each call to
+the library's methods.
+
+=== Form
+
+Active Merchant provides a helper called "payment_service_for" which handles the preparation
+of the request to the gateway. The following code sample shows what this might look like:
+
+    = payment_service_for @invoice.transactions.last.code, 'The Shop', :amount => @invoice.total.cents, :currency => 'EUR', :service => :sermepa do |service|
+      - service.description "Some description of the purchase"
+      - service.customer_name @invoice.client.name
+      - service.notify_url notify_invoice_url(@invoice)
+      - service.success_url complete_invoice_url(@invoice)
+      - service.failure_url complete_invoice_url(@invoice)
+
+      = submit_tag "Go to payment gateway!"
+
+A few important things to bare in mind:
+
+- Each request to the service *must* have a unique transaction or order id. This is the first parameter provided to the helper.
+- If a purchase fails, the order id *must* be updated.
+- As per the Sermepa documentation the transaction id must be between 4 and 12 digits long and always start with 4 numbers.
+- The credentials can be provided in the ":credentials" option to the helper if preferred.
+- The URLs set where the user will be sent after the purchase.
+
+
+=== Notification and Confirmation
+
+While confirming the purchase is optional, it is highly recommended as it allows you
+to let the client know instantly that the transaction has completed successfully.
+
+If HTTP notification has been enabled in the Sermepa configuration, a private
+request will be sent from the gateway to your website confirming the success of
+the transaction. The notification URL can be provided either in the form's parameters
+or in the administrator configuration. You'll most likely not be able to test this
+during development on your local machine for obvious reasons.
+
+Ensuring that the parameters are provided from the returning user is much more
+convenient for testing and allows for an instant response to the user.
+
+Both types work using the same parameters in the URL so can be handled with the same method.
+
+Your controller might have a actions like in the following example:
+
+    # Receive a direct notification from the gateway
+    def notify
+      notify = ActiveMerchant::Billing::Integrations::Sermepa.notification(request.query_parameters)
+      if notify.acknowledge
+        # Do something useful
+      end
+      render :text => 'OK'
+    end
+
+    # Handle the incoming user
+    def confirm
+      notify = ActiveMerchant::Billing::Integrations::Sermepa.notification(request.query_parameters)
+      if notify.acknowledge
+        # do something useful
+        render :action => 'success'
+      else
+        render :action => 'failure'
+      end
+    end
+
+These examples are greatly simplified. It would be much better to handle these operations in
+a model and provide support for recording each event that takes place.
+
+The acknowledge method also accepts a hash of credentials should you prefer this
+to setting them globally. It checks to see if by combining the received parameters
+the same signature can be generated using our secret key. Assuming the operation
+successful and the signature is valid, the purchase will be successful.
+
+
+== Authors
+
+Written by Sam Lown.
+
+Special thanks go to {rentages.es}[http://www.rentages.es] for supporting the initial development.
+
+Thanks should also go to {floresfrescas.com}[http://www.floresfrescas.com] for supporting the development of the BBVA TPV gateway method on which this is heavily based.
+
+And of course, many thanks to the ActiveMerchant[http://www.activemerchant.org] Shopify[http://www.shopify.com] team for releasing this library in the first place!
+
+== License
+
+Released under the MIT license.
+
+Copyright (c) 2010-2011 Samuel Lown
+
+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/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+
+desc "Run the unit test suite"
+task :default => 'test:units'
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.pattern = 'test/unit/**/*_test.rb'
+    t.ruby_opts << '-rubygems'
+    t.libs << 'test'
+    t.verbose = true
+  end
+end

data/active_merchant_sermepa.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_merchant_sermepa}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sam Lown"]
+  s.date = %q{2011-02-25}
+  s.description = %q{Add support to ActiveMerchant for the Sermepa payment gateway by Servired used by many banks in Spain}
+  s.summary = "ActiveMerchant support for Servired's Sermepa payment gateway"
+  s.email = %q{me@samlown.com}
+  s.extra_rdoc_files = ['MIT-LICENSE', 'CHANGELOG', 'README.rdoc']
+  s.homepage = %q{http://github.com/samlown/active_merchant_sermepa}
+  s.rubygems_version = "1.3.7"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("activemerchant", ">= 1.9.4")
+  s.add_development_dependency("mocha", "~> 0.9.10")
+  s.add_development_dependency("money", "~> 3.5.4")
+  s.add_development_dependency("actionpack", "~> 3.0.3")
+
+end

data/lib/active_merchant/billing/integrations/sermepa.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      # See the BbvaTpv::Helper class for more generic information on usage of
+      # this integrated payment method.
+      module Sermepa
+
+        autoload :Helper, 'active_merchant/billing/integrations/sermepa/helper.rb'
+        autoload :Return, 'active_merchant/billing/integrations/sermepa/return.rb'
+        autoload :Notification, 'active_merchant/billing/integrations/sermepa/notification.rb'
+       
+        mattr_accessor :service_test_url
+        self.service_test_url = "https://sis-t.sermepa.es:25443/sis/realizarPago"
+        mattr_accessor :service_production_url
+        self.service_production_url = "https://sis.sermepa.es/sis/realizarPago"
+
+        mattr_accessor :operations_test_url
+        self.operations_test_url = "https://sis-t.sermepa.es:25443/sis/operaciones"
+        mattr_accessor :operations_production_url
+        self.operations_production_url = "https://sis.sermepa.es/sis/operaciones"
+
+
+        def self.service_url 
+          mode = ActiveMerchant::Billing::Base.integration_mode
+          case mode
+          when :production
+            self.service_production_url
+          when :test
+            self.service_test_url
+          else
+            raise StandardError, "Integration mode set to an invalid value: #{mode}"
+          end
+        end
+
+        def self.operations_url
+          mode = ActiveMerchant::Billing::Base.integration_mode
+          case mode
+          when :production
+            self.operations_production_url
+          when :test
+            self.operations_test_url
+          else
+            raise StandardError, "Integration mode set to an invalid value: #{mode}"
+          end
+
+        end
+
+        def self.notification(post)
+          Notification.new(post)
+        end
+
+
+        def self.currency_code( name )
+          row = supported_currencies.assoc(name)
+          row.nil? ? supported_currencies.first[1] : row[1]
+        end
+
+        def self.currency_from_code( code )
+          row = supported_currencies.rassoc(code)
+          row.nil? ? supported_currencies.first[0] : row[0]
+        end
+
+        def self.language_code(name)
+          row = supported_languages.assoc(name.to_s.downcase.to_sym)
+          row.nil? ? supported_languages.first[1] : row[1]
+        end
+
+        def self.language_from_code( code )
+          row = supported_languages.rassoc(code)
+          row.nil? ? supported_languages.first[0] : row[0]
+        end
+
+        def self.transaction_code(name)
+          row = supported_transactions.assoc(name.to_sym)
+          row.nil? ? supported_transactions.first[1] : row[1]
+        end
+        def self.transaction_from_code(code)
+          row = supported_transactions.rassoc(code.to_s)
+          row.nil? ? supported_languages.first[0] : row[0]
+        end
+
+        def self.supported_currencies
+          [ ['EUR', '978'] ]
+        end
+
+        def self.supported_languages
+          [
+            [:es, '001'],
+            [:en, '002'],
+            [:ca, '003'],
+            [:fr, '004'],
+            [:de, '005'],
+            [:pt, '009']
+          ]
+        end
+
+        def self.supported_transactions
+          [
+            [:authorization,              '0'],
+            [:preauthorization,           '1'],
+            [:confirmation,               '2'],
+            [:automatic_return,           '3'],
+            [:reference_payment,          '4'],
+            [:recurring_transaction,      '5'],
+            [:successive_transaction,     '6'],
+            [:authentication,             '7'],
+            [:confirm_authentication,     '8'],
+            [:cancel_preauthorization,    '9'],
+            [:deferred_authorization,             'O'],
+            [:confirm_deferred_authorization,     'P'],
+            [:cancel_deferred_authorization,      'Q'],
+            [:inicial_recurring_authorization,    'R'],
+            [:successive_recurring_authorization, 'S']
+          ]
+        end
+
+        def self.response_code_message(code)
+          case code.to_i
+          when 0..99
+            nil
+          when 900
+           "Transacción autorizada para devoluciones y confirmaciones"
+          when 101
+            "Tarjeta caducada"
+          when 102
+            "Tarjeta en excepción transitoria o bajo sospecha de fraude"
+          when 104
+            "Operación no permitida para esa tarjeta o terminal"
+          when 116
+            "Disponible insuficiente"
+          when 118
+            "Tarjeta no registrada o Método de pago no disponible para su tarjeta"
+          when 129
+            "Código de seguridad (CVV2/CVC2) incorrecto"
+          when 180
+            "Tarjeta no válida o Tarjeta ajena al servicio o Error en la llamada al MPI sin controlar."
+          when 184
+            "Error en la autenticación del titular"
+          when 190
+            "Denegación sin especificar Motivo"
+          when 191
+            "Fecha de caducidad errónea"
+          when 202
+            "Tarjeta en excepción transitoria o bajo sospecha de fraude con retirada de tarjeta"
+          when 912,9912
+            "Emisor no disponible"
+          when 913
+            "Pedido repetido"
+          else
+            "Transacción denegada"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/sermepa/helper.rb

@@ -0,0 +1,187 @@
+# encoding: utf-8
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Sermepa
+        # Sermepa/Servired Spanish Virtual POS Gateway
+        #
+        # Support for the Spanish payment gateway provided by Sermepa, part of Servired,
+        # one of the main providers in Spain to Banks and Cajas.
+        #
+        # Requires the :terminal_id, :commercial_id, and :secret_key to be set in the credentials
+        # before the helper can be used. Credentials may be overwriten when instantiating the helper
+        # if required or instead of the global variable. Optionally, the :key_type can also be set to 
+        # either 'sha1_complete' or 'sha1_extended', where the later is the default case. This
+        # is a configurable option in the Sermepa admin which you may or may not be able to access.
+        # If nothing seems to work, try changing this.
+        #
+        # Ensure the gateway is configured correctly. Synchronization should be set to Asynchronous
+        # and the parameters in URL option (Parámetros en las URLs) should be set to true unless
+        # the notify_url is provided. During development on localhost ensuring this option is set
+        # is especially important as there is no other way to confirm a successful purchase.
+        #
+        # Your view for a payment form might look something like the following:
+        #
+        #   <%= payment_service_for @transaction.id, 'Company name', :amount => @transaction.amount, :currency => 'EUR', :service => :sermepa do |service| %>
+        #     <% service.description     @sale.description %>
+        #     <% service.customer_name   @sale.client.name %>
+        #     <% service.notify_url      notify_sale_url(@sale) %>
+        #     <% service.success_url     win_sale_url(@sale) %>
+        #     <% service.failure_url     fail_sale_url(@sale) %>
+        #    
+        #     <%= submit_tag "PAY!" %>
+        #   <% end %>
+        #
+        #
+        # 
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          include PostsData
+
+          class << self
+            # Credentials should be set as a hash containing the fields:
+            #  :terminal_id, :commercial_id, :secret_key, :key_type (optional)
+            attr_accessor :credentials
+          end
+
+          mapping :account,     'Ds_Merchant_MerchantName'
+
+          mapping :currency,    'Ds_Merchant_Currency'
+          mapping :amount,      'Ds_Merchant_Amount'
+
+          mapping :order,       'Ds_Merchant_Order'
+          mapping :description, 'Ds_Merchant_ProductDescription'
+          mapping :client,      'Ds_Merchant_Titular'
+
+          mapping :notify_url,  'Ds_Merchant_MerchantURL'
+          mapping :success_url, 'Ds_Merchant_UrlOK'
+          mapping :failure_url, 'Ds_Merchant_UrlKO'
+
+          mapping :language,    'Ds_Merchant_ConsumerLanguage'
+
+          mapping :transaction_type, 'Ds_Merchant_TransactionType'
+
+          mapping :customer_name, 'Ds_Merchant_Titular' 
+
+          #### Special Request Specific Fields ####
+          mapping :signature,   'Ds_Merchant_MerchantSignature'
+          ########
+
+          # ammount should always be provided in cents!
+          def initialize(order, account, options = {})
+            self.credentials = options.delete(:credentials) if options[:credentials]
+            super(order, account, options)
+
+            add_field 'Ds_Merchant_MerchantCode', credentials[:commercial_id]
+            add_field 'Ds_Merchant_Terminal', credentials[:terminal_id]
+            #add_field mappings[:transaction_type], '0' # Default Transaction Type
+            self.transaction_type = :authorization
+          end
+
+          # Allow credentials to be overwritten if needed
+          def credentials
+            @credentials || self.class.credentials
+          end
+          def credentials=(creds)
+            @credentials = (self.class.credentials || {}).dup.merge(creds)
+          end
+
+          def amount=(money)
+            cents = money.respond_to?(:cents) ? money.cents : money
+            if money.is_a?(String) || cents.to_i <= 0
+              raise ArgumentError, 'money amount must be either a Money object or a positive integer in cents.'
+            end
+            add_field mappings[:amount], cents.to_i
+          end
+
+          def order=(order_id)
+            order_id = order_id.to_s
+            if order_id !~ /^[0-9]{4}/ && order_id.length <= 8
+              order_id = ('0' * 4) + order_id
+            end
+            regexp = /^[0-9]{4}[0-9a-zA-Z]{0,8}$/
+            raise "Invalid order number format! First 4 digits must be numbers" if order_id !~ regexp
+            add_field mappings[:order], order_id
+          end
+
+          def currency=( value )
+            add_field mappings[:currency], Sermepa.currency_code(value) 
+          end
+
+          def language=(lang)
+            add_field mappings[:language], Sermepa.language_code(lang)
+          end
+
+          def transaction_type=(type)
+            add_field mappings[:transaction_type], Sermepa.transaction_code(type)
+          end
+
+          def form_fields
+            add_field mappings[:signature], sign_request
+            @fields
+          end
+
+
+          # Send a manual request for the currently prepared transaction.
+          # This is an alternative to the normal view helper and is useful
+          # for special types of transaction.
+          def send_transaction
+            body = build_xml_request
+
+            headers = { }
+            headers['Content-Length'] = body.size.to_s
+            headers['User-Agent'] = "Active Merchant -- http://activemerchant.org"
+            headers['Content-Type'] = 'application/x-www-form-urlencoded'
+  
+            # Return the raw response data
+            ssl_post(Sermepa.operations_url, "entrada="+CGI.escape(body), headers)
+          end
+
+          protected
+
+          def build_xml_request
+            xml = Builder::XmlMarkup.new :indent => 2
+            xml.DATOSENTRADA do
+              xml.DS_Version 0.1
+              xml.DS_MERCHANT_CURRENCY @fields['Ds_Merchant_Currency']
+              xml.DS_MERCHANT_AMOUNT @fields['Ds_Merchant_Amount']
+              xml.DS_MERCHANT_MERCHANTURL @fields['Ds_Merchant_MerchantURL']
+              xml.DS_MERCHANT_TRANSACTIONTYPE @fields['Ds_Merchant_TransactionType']
+              xml.DS_MERCHANT_MERCHANTDATA @fields['Ds_Merchant_Product_Description']
+              xml.DS_MERCHANT_TERMINAL credentials[:terminal_id]
+              xml.DS_MERCHANT_MERCHANTCODE credentials[:commercial_id]
+              xml.DS_MERCHANT_ORDER @fields['Ds_Merchant_Order']
+              xml.DS_MERCHANT_MERCHANTSIGNATURE sign_request
+            end
+            xml.target!
+          end
+
+
+          # Generate a signature authenticating the current request.
+          # Values included in the signature are determined by the the type of 
+          # transaction.
+          def sign_request
+            str = @fields['Ds_Merchant_Amount'].to_s +
+                  @fields['Ds_Merchant_Order'].to_s +
+                  @fields['Ds_Merchant_MerchantCode'].to_s +
+                  @fields['Ds_Merchant_Currency'].to_s
+
+            case Sermepa.transaction_from_code(@fields['Ds_Merchant_TransactionType'])
+            when :recurring_transaction
+              str += @fields['Ds_Merchant_SumTotal']
+            end
+
+            if credentials[:key_type].blank? || credentials[:key_type] == 'sha1_extended'
+              str += @fields['Ds_Merchant_TransactionType'].to_s +
+                     @fields['Ds_Merchant_MerchantURL'].to_s # may be blank!
+            end
+
+            str += credentials[:secret_key]
+
+            Digest::SHA1.hexdigest(str)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/sermepa/notification.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Sermepa
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          include PostsData
+
+          def complete?
+            status == 'Completed'
+          end 
+
+          def transaction_id
+            params['ds_order']
+          end
+
+          # When was this payment received by the client. 
+          def received_at
+            if params['ds_date']
+              (day, month, year) = params['ds_date'].split('/')
+              Time.parse("#{year}-#{month}-#{day} #{params['ds_hour']}")
+            else
+              Time.now # Not provided!
+            end
+          end
+
+          # the money amount we received in cents in X.2 format
+          def gross
+            sprintf("%.2f", params['ds_amount'].to_f / 100)
+          end
+
+          # Was this a test transaction?
+          def test?
+            false
+          end
+
+          def currency
+            Sermepa.currency_from_code( params['ds_currency'] ) 
+          end
+
+          # Status of transaction. List of possible values:
+          # <tt>Completed</tt>
+          # <tt>Failed</tt>
+          # <tt>Pending</tt>
+          def status
+            case error_code.to_i
+            when 0..99
+              'Completed'
+            when 900
+              'Pending'
+            else
+              'Failed'
+            end
+          end
+
+          def error_code
+            params['ds_response']
+          end
+
+          def error_message
+            msg = Sermepa.response_code_message(error_code)
+            error_code.to_s + ' - ' + (msg.nil? ? 'Operación Aceptada' : msg)
+          end
+
+          def secure_payment?
+            params['ds_securepayment'] == '1'
+          end
+
+          # Acknowledge the transaction.
+          #
+          # Validate the details provided by the gateway by ensuring that the signature
+          # matches up with the details provided.
+          #
+          # Optionally, a set of credentials can be provided that should contain a 
+          # :secret_key instead of using the global credentials defined in the Sermepa::Helper.
+          #
+          # Example:
+          # 
+          #   def notify
+          #     notify = Sermepa::Notification.new(request.query_parameters)
+          #
+          #     if notify.acknowledge
+          #       ... process order ... if notify.complete?
+          #     else
+          #       ... log possible hacking attempt ...
+          #     end
+          #
+          #
+          def acknowledge(credentials = nil)
+            return false if params['ds_signature'].blank?
+            str = 
+              params['ds_amount'].to_s +
+              params['ds_order'].to_s +
+              params['ds_merchantcode'].to_s + 
+              params['ds_currency'].to_s +
+              params['ds_response'].to_s
+            if xml?
+              str += params['ds_transactiontype'].to_s + params['ds_securepayment'].to_s
+            end
+
+            str += (credentials || Sermepa::Helper.credentials)[:secret_key]
+            sig = Digest::SHA1.hexdigest(str)
+            sig.upcase == params['ds_signature'].to_s.upcase
+          end
+
+          private
+
+          def xml?
+            !params['code'].blank?
+          end
+
+          # Take the posted data and try to extract the parameters.
+          #
+          # Posted data can either be a parameters hash, XML string or CGI data string
+          # of parameters.
+          #
+          def parse(post)
+            if post.is_a?(Hash)
+              post.each { |key, value|  params[key.downcase] = value }
+            elsif post.to_s =~ /<retornoxml>/i
+              # XML source
+              self.params = xml_response_to_hash(@raw)
+            else
+              for line in post.to_s.split('&')    
+                key, value = *line.scan( %r{^([A-Za-z0-9_.]+)\=(.*)$} ).flatten
+                params[key.downcase] = CGI.unescape(value)
+              end
+            end
+            @raw = post.inspect.to_s
+          end
+
+          def xml_response_to_hash(xml)
+            result = { }
+            doc = Nokogiri::XML(xml)
+            doc.css('RETORNOXML OPERACION').children().each do |child|
+              result[child.name.downcase] = child.inner_text
+            end
+            result['code'] = doc.css('RETORNOXML CODIGO').inner_text
+            result
+          end
+ 
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/sermepa/return.rb

@@ -0,0 +1,10 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module BbvaTpv
+        class Return < ActiveMerchant::Billing::Integrations::Return
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant_sermepa.rb

@@ -0,0 +1,10 @@
+
+require 'active_merchant'
+
+module ActiveMerchant
+  module Billing
+    module Integrations
+      autoload :Sermepa, 'active_merchant/billing/integrations/sermepa'
+    end
+  end
+end

data/lib/activemerchant_sermepa.rb

@@ -0,0 +1,3 @@
+
+require 'active_merchant_sermepa'
+

data/test/test_helper.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'rubygems'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'test/unit'
+require 'money'
+require 'mocha'
+require 'yaml'
+require 'active_merchant_sermepa'
+
+require 'action_controller'
+require 'action_view/template'
+begin
+  require 'action_dispatch/testing/test_process'
+rescue LoadError
+  require 'action_controller/test_process'
+end
+require 'active_merchant/billing/integrations/action_view_helper'
+
+ActiveMerchant::Billing::Base.mode = :test
+
+
+## Assertions copied from ActiveMerchant. This is lame, they should have them in a seperate file!
+
+module ActiveMerchant
+  module Assertions
+    AssertionClass = RUBY_VERSION > '1.9' ? MiniTest::Assertion : Test::Unit::AssertionFailedError
+    
+    def assert_field(field, value)
+      clean_backtrace do
+        assert_equal value, @helper.fields[field]
+      end
+    end
+    
+    # Allows the testing of you to check for negative assertions:
+    #
+    # # Instead of
+    # assert !something_that_is_false
+    #
+    # # Do this
+    # assert_false something_that_should_be_false
+    #
+    # An optional +msg+ parameter is available to help you debug.
+    def assert_false(boolean, message = nil)
+      message = build_message message, '<?> is not false or nil.', boolean
+    
+      clean_backtrace do
+        assert_block message do
+          not boolean
+        end
+      end
+    end
+    
+    # A handy little assertion to check for a successful response:
+    #
+    # # Instead of
+    # assert_success response
+    #
+    # # DRY that up with
+    # assert_success response
+    #
+    # A message will automatically show the inspection of the response
+    # object if things go afoul.
+    def assert_success(response)
+      clean_backtrace do
+        assert response.success?, "Response failed: #{response.inspect}"
+      end
+    end
+    
+    # The negative of +assert_success+
+    def assert_failure(response)
+      clean_backtrace do
+        assert_false response.success?, "Response expected to fail: #{response.inspect}"
+      end
+    end
+    
+    def assert_valid(validateable)
+      clean_backtrace do
+        assert validateable.valid?, "Expected to be valid"
+      end
+    end
+    
+    def assert_not_valid(validateable)
+      clean_backtrace do
+        assert_false validateable.valid?, "Expected to not be valid"
+      end
+    end
+    
+    private
+    def clean_backtrace(&block)
+      yield
+    rescue AssertionClass => e
+      path = File.expand_path(__FILE__)
+      raise AssertionClass, e.message, e.backtrace.reject { |line| File.expand_path(line) =~ /#{path}/ }
+    end
+  end
+end
+
+Test::Unit::TestCase.class_eval do
+  include ActiveMerchant::Assertions
+end
+

data/test/unit/integrations/helpers/sermepa_helper_test.rb

@@ -0,0 +1,73 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+
+class SermepaHelperTest < Test::Unit::TestCase
+  include ActiveMerchant::Billing::Integrations
+
+  def setup
+    Sermepa::Helper.credentials = {
+        :terminal_id => '9',
+        :commercial_id => '999008881',
+        :secret_key => 'qwertyasdf0123456789'
+    }
+    @helper = Sermepa::Helper.new('070803113316', 'Comercio Pruebas', :amount => 825, :currency => 'EUR')
+    @helper.description = "Alfombrilla para raton"
+    @helper.customer_name = "Sermepa"
+    @helper.notify_url = "https://sis-t.sermepa.es:25443/sis/pruebaCom.jsp"
+  end
+
+  def test_credentials_accessible
+    assert_instance_of Hash, @helper.credentials
+  end
+
+  def test_credentials_overwritable
+    @helper = Sermepa::Helper.new(29292929, 'cody@example.com', :amount => 1235, :currency => 'EUR', 
+                                 :credentials => {:terminal_id => 12})
+    assert_field 'Ds_Merchant_Terminal', '12'
+  end
+
+  def test_basic_helper_fields
+    assert_field 'Ds_Merchant_MerchantCode', '999008881'
+    assert_field 'Ds_Merchant_Amount', '825'
+    assert_field 'Ds_Merchant_Order', '070803113316'
+    assert_field 'Ds_Merchant_ProductDescription', 'Alfombrilla para raton'
+    assert_field 'Ds_Merchant_Currency', '978'
+    assert_field 'Ds_Merchant_TransactionType', '0'
+    assert_field 'Ds_Merchant_MerchantName', 'Comercio Pruebas'
+  end
+
+  def test_unknown_mapping
+    assert_nothing_raised do
+      @helper.company_address :address => '500 Dwemthy Fox Road'
+    end
+  end
+
+  def test_padding_on_order_id
+    @helper.order = 101
+    assert_field 'Ds_Merchant_Order', "0000101"
+  end
+
+  def test_no_padding_on_valid_order_id
+    @helper.order = 1010
+    assert_field 'Ds_Merchant_Order', "1010"
+  end
+
+  def test_error_raised_on_invalid_order_id
+    assert_raise RuntimeError do
+      @helper.order = "A0000000ABC"
+    end
+  end
+
+  def test_basic_signing_request
+    assert sig = @helper.send(:sign_request)
+    assert_equal "ca2bd747d365b4f0a87c670b270cc390b79670ce", sig
+  end
+
+  def test_build_xml_confirmation_request
+    # This also tests signing the request for differnet transactions
+    data = @helper.send(:build_xml_request)
+    assert data =~ /<DS_MERCHANT_TRANSACTIONTYPE>0<\/DS_MERCHANT_TRANSACTIONTYPE>/
+    assert data =~ /<DS_MERCHANT_MERCHANTCODE>999008881<\/DS_MERCHANT_MERCHANTCODE>/
+    assert data =~ /<DS_MERCHANT_MERCHANTSIGNATURE>ca2bd747d365b4f0a87c670b270cc390b79670ce<\/DS_MERCHANT_MERCHANTSIGNATURE>/
+  end
+
+end

data/test/unit/integrations/notifications/sermepa_notification_test.rb

@@ -0,0 +1,64 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+
+class SermepaNotificationTest < Test::Unit::TestCase
+  include ActiveMerchant::Billing::Integrations
+
+  def setup
+    Sermepa::Helper.credentials = {
+        :terminal_id => '1',
+        :commercial_id => '999008881',
+        :secret_key => 'qwertyasdf0123456789'
+    }
+    @sermepa = Sermepa::Notification.new(raw_params_data)
+  end
+
+  def test_accessors
+    assert @sermepa.complete?
+    assert_equal "Completed", @sermepa.status
+    assert_equal "070820124150", @sermepa.transaction_id
+    assert_equal "0.45", @sermepa.gross
+    assert_equal "EUR", @sermepa.currency
+    assert_equal Time.parse("2007-08-20 12:47"), @sermepa.received_at
+  end
+
+  def test_compositions
+    assert_equal Money.new(45, 'EUR'), @sermepa.amount
+  end
+
+  def test_respond_to_acknowledge
+    assert @sermepa.respond_to?(:acknowledge)
+  end
+
+  # Replace with real successful acknowledgement code
+  def test_acknowledgement    
+    assert @sermepa.acknowledge
+  end
+
+  def test_acknowledgement_with_xml
+    # Fake the presence of xml!
+    @sermepa.params['code'] = '123'
+    @sermepa.params["ds_signature"] = "49A8A907D86FE4763890180061E7907589DBE96A"
+    assert @sermepa.acknowledge
+  end
+
+  private
+  def raw_params_data
+    {
+      "Ds_AuthorisationCode" => "004022",
+      "Ds_SecurePayment" => "1",
+      "Ds_Hour" => "12:47",
+      "Ds_MerchantData" => "",
+      "Ds_Terminal" => "001",
+      "Ds_Card_Country" => "724",
+      "Ds_Response" => "0000",
+      "Ds_Currency" => "978",
+      "Ds_MerchantCode" => "999008881",
+      "Ds_ConsumerLanguage" => "1",
+      "Ds_TransactionType" => "0",
+      "Ds_Signature" => "E2E5A14D690B869183CF3BA36E2B6005BB21F9C5",
+      "Ds_Order" => "070820124150",
+      "Ds_Amount" => "45",
+      "Ds_Date" => "20/08/2007"
+    }
+  end
+end

data/test/unit/integrations/sermepa_module_text.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+class SermepaModuleTest < Test::Unit::TestCase
+  include ActiveMerchant::Billing::Integrations
+  
+  def test_notification_method
+    assert_instance_of Sermepa::Notification, Sermepa.notification('name=cody')
+  end
+
+  def test_currency_code
+    assert_equal '978', Sermepa.currency_code('EUR')
+  end
+  def test_currency_from_code
+    assert_equal 'EUR', Sermepa.currency_from_code('978')
+  end
+
+  def test_language_code
+    assert_equal Sermepa.language_code('es'), '001'
+    assert_equal Sermepa.language_code('CA'), '003'
+    assert_equal Sermepa.language_code(:pt), '009'
+  end
+  def test_language_from_code
+    assert_equal :ca, Sermepa.language_from_code('003')
+  end
+
+  def test_transaction_code
+    assert_equal '2', Sermepa.transaction_code(:confirmation)
+  end
+  def test_transaction_from_code
+    assert_equal :confirmation, Sermepa.transaction_from_code(2)
+  end
+
+  def test_response_code_message
+    assert_equal nil, Sermepa.response_code_message(23)
+    assert_equal nil, Sermepa.response_code_message('23')
+    assert_equal "Tarjeta caducada", Sermepa.response_code_message(101)
+  end
+
+end 

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: active_merchant_sermepa
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Sam Lown
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-25 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemerchant
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 9
+        - 4
+        version: 1.9.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 10
+        version: 0.9.10
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: money
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 5
+        - 4
+        version: 3.5.4
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :development
+  version_requirements: *id004
+description: Add support to ActiveMerchant for the Sermepa payment gateway by Servired used by many banks in Spain
+email: me@samlown.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- CHANGELOG
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- active_merchant_sermepa.gemspec
+- lib/active_merchant/billing/integrations/sermepa.rb
+- lib/active_merchant/billing/integrations/sermepa/helper.rb
+- lib/active_merchant/billing/integrations/sermepa/notification.rb
+- lib/active_merchant/billing/integrations/sermepa/return.rb
+- lib/active_merchant_sermepa.rb
+- lib/activemerchant_sermepa.rb
+- test/test_helper.rb
+- test/unit/integrations/helpers/sermepa_helper_test.rb
+- test/unit/integrations/notifications/sermepa_notification_test.rb
+- test/unit/integrations/sermepa_module_text.rb
+has_rdoc: true
+homepage: http://github.com/samlown/active_merchant_sermepa
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActiveMerchant support for Servired's Sermepa payment gateway
+test_files: []
+