RedsysRuby

A Ruby gem for making payments with Redsys using the HMAC-SHA256 signature algorithm.

Note: This documentation and some parts of the code use Spanish terms because Redsys is a payment provider that operates in Spain.

Add this line to your application's Gemfile:

gem 'redsys-ruby'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install redsys-ruby

This gem includes a Rails Engine that provides a configuration interface, payment helpers, and premium success/failure pages.

Add the following to your config/routes.rb:

mount RedsysRuby::Engine => "/redsys_ruby"

Once mounted, the engine provides the following routes (assuming it is mounted at "/redsys_ruby"):

For security, it is highly recommended to manage your secrets (like merchant_key) using environment variables or Rails encrypted credentials.

Set the following environment variables in your system or using a gem like dotenv:

• REDSYS_MERCHANT_KEY: Your 256-bit merchant key (Base64 encoded).
• REDSYS_MERCHANT_CODE: Your 9-digit merchant code (FUC).
• REDSYS_TERMINAL: Your 3-digit terminal number.
• REDSYS_ENVIRONMENT: test or production.

You can also add these values to your encrypted credentials:

# bin/rails credentials:edit
redsys:
  merchant_key: "your_merchant_key_base64"
  merchant_code: "999008881"
  terminal: "001"
  environment: "test"

Alternatively, you can configure non-sensitive settings through the provided UI at /redsys_ruby/configuration/edit. Note that for security reasons, the merchant_key will not be saved to the config/redsys.yml file and should be provided via one of the methods above.

Security Note: By default, the configuration UI is unauthenticated. You should secure it by configuring an authentication method in an initializer:

# config/initializers/redsys.rb
RedsysRuby.configure do |config|
  # Specify the parent controller for the engine (default: "ActionController::Base")
  # Use your application's base controller to inherit its authentication and layout
  config.parent_controller = "ApplicationController"

  # Or provide a custom authentication block
  config.before_configuration_action = -> {
    # e.g., using Devise:
    # authenticate_user!
    # redirect_to root_path unless current_user.admin?
  }
end

In your views, you can use the redsys_payment_form helper to generate a payment form that redirects to Redsys:

<%= redsys_payment_form(amount: 10.50, order: "123456789012", description: "Product description") %>

The helper automatically includes:

• Ds_SignatureVersion
• Ds_MerchantParameters
• Ds_Signature
• Ds_Merchant_UrlOK: Points to the built-in premium success page.
• Ds_Merchant_UrlKO: Points to the built-in premium failure page.

The gem provides beautifully designed Ok and KO pages that match modern aesthetics, featuring:

• Inter typography.
• Smooth gradients and micro-animations.
• Responsive design.
• Backdrop blur effects.

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rspec to run the tests.

Bug reports and pull requests are welcome on GitHub at https://github.com/smallpush/redsys-ruby.