The Rubykassa gem

by Ruby Fire and Zero One

Yet another Ruby wrapper for Robokassa API. Make Robokassa to work with your Rails project without pain. Rubykassa took the best from robokassa gem and Active Merchant Robokassa integration but easier to use and setup. Supports Rails 5.

Have questions?

Installation

Add to your Gemfile:

gem "rubykassa", :git => "https://github.com/ElusiveSpirit/rubykassa.git"

Usage

Run rails g rubykassa:install, get an initializer with the following code:

Rubykassa.configure do |config|
  config.login = ENV["ROBOKASSA_LOGIN"]
  config.first_password = ENV["ROBOKASSA_FIRST_PASSWORD"]
  config.second_password = ENV["ROBOKASSA_SECOND_PASSWORD"]
  config.currency = ENV["ROBOKASSA_CURRENCY"]
  config.mode = :test # or :production
  config.http_method = :get # or :post
  config.xml_http_method = :get # or :post
  config.hash_algorithm = :md5 # or :ripemd160, :sha1, :sha256, :sha384, :sha512
end

and configure it with your credentials. NB! Keep in mind that we are using environment variables. So do not forget to configure your ENV. For example using figaro gem.

Also, you need to specify Result URL, Success URL and Fail URL at the "Technical Settings" (Технические настройки) in your Robokassa dashboard:

• Result URL: http://<your_domain>/robokassa/result
• Success URL: http://<your_domain>/robokassa/success
• Fail URL: http://<your_domain>/robokassa/fail

To define custom success/fail callbacks you can also use the initializer:

Rubykassa.configure do |config|
  ...
  config.success_callback = ->(notification) { render text: 'success' }
  config.fail_callback    = ->(notification) { redirect_to root_path }
  config.result_callback  = ->(notification) { render text: notification.success }
end

Lambdas are called in RobokassaController so you can respond with any kind that is supported by Rails.

NOTE: result_callback should always return "OK#{invoice_id}" string. So, implement your custom logic above render text: notification.success line.

IMPORTANT: Don't forget to restart web server after every change

Mode is :test by default. For production you have to use :production. http_method and xml_http_method are :get by default but can be configured as :post

Once you are done, simply use pay_url helper in your view:

<%= pay_url "Pay with Robokassa", ivoice_id, total_sum %>

Additionally you may want to pass extra options. There is no problem:

<%= pay_url "Pay with Robokassa", ivoice_id, total_sum, { description: "Invoice description", email: "[email protected]", currency: "WMZM", culture: :ru } %>

Or if you would like to pass some custom params use custom key in options hash:

<%= pay_url "Pay with Robokassa", ivoice_id, total_sum, { description: "Invoice description", email: "[email protected]", currency: "WMZM", culture: :ru, custom: { param1: "value1", param2: "value2" }} %>

Also pay_url helper can accept block:

<%= pay_url ivoice_id, total_sum do %>
  Pay with Robokassa
<% end %>

You can also pass some HTML options with html key in options hash (Bootstrap 3 example):

<%= pay_url "Pay with Robokassa", ivoice_id, total_sum, { html: { class: 'btn btn-primary btn-bg' }}

If you need to implement Robokassa's XML interface functionality you have to the following:

xml_interface = Rubykassa::XmlInterface.new do |interface|
  interface.invoice_id = your_invioce_id
  interface.total = your_total_sum
  interface.language = :ru # can be :en, :ru is default
end

then call whatever you need

xml_interface.get_currencies_list
xml_interface.get_payment_methods
xml_interface.get_rates
xml_interface.op_state
xml_interface.calc_out_summ

In test mode, op_state accepts hash with additional attributes you would like to get back with response, for example { 'StateCode' => 5 } (more about StateCode). Please note, that any additional parameters to op_state are discarded in production mode.

How to pay fee for yout client

Run total = xml_interface.calc_out_summ to get summ without RoboKassa fee and then use total in payment_url

<%= pay_url ivoice_id, total do %>
  Pay with Robokassa
<% end %>

Supported Rubies and Rails versions

See the CI build

License

This project rocks and uses MIT-LICENSE Copyright (c) 2013-2016 Zero One 2018 Ruby Fire