rubykassa-fixed 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54d8c8b1a3a97c93010713ca5d875eb0fce98d1bf297c78c7c7f48c01d3edb2d
+  data.tar.gz: 2f985d14fe9e00888571396846fbf38e46abaf7f5d74c15250ba9e579c5183b6
+SHA512:
+  metadata.gz: e60209eb1a66887fa1073fd8566ae6681e6545898e6116c1a86831d8a476e6faa021cebd607bcd8b430cab0af949be345d27a59dc476473c699e37d98b7d70aa
+  data.tar.gz: 34a643e2287e1a1e303af4407c08703a29bd077c612ad2b324887cdbfef19ac9b24fbdcf0569bcfff0c1f6ee8ba4700ac2b6ec51000376d9e21eb7ad4817f9c3

data/.gitignore

@@ -0,0 +1,28 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/log
+spec/dummy/db/*.sqlite3
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+*.gem
+*.rbc
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+rdoc
+spec/reports
+spec/tmp
+spec/version_tmp
+tmp
+.DS_Store
+passenger.3000.log
+passenger.3000.pid.lock
+.idea
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+env:
+  - "RAILS_VERSION=3.2.18"
+  - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=4.1.0"
+  - "RAILS_VERSION=4.2.0"
+  - "RAILS_VERSION=master"
+matrix:
+  allow_failures:
+    - env: "RAILS_VERSION=master"
+    - env: "RAILS_VERSION=3.2.18"
+    - rvm: 1.9.3
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,71 @@
+## Edge (not released)
+
+* Change `XmlInterface` to support dynamic attributes in initialzer, add posibility to use it in test mode by @vidmantas [#23][], [#24][]
+* Update base URL to reflect the changes in Robokassa API.
+* Allow `pay_url` to accept block
+* Hash algorithms implemented (Алгоритм расчёта хэша — http://docs.robokassa.ru/#3733) [#29][]
+
+[#23]:https://github.com/ZeroOneStudio/rubykassa/pull/23
+[#24]:https://github.com/ZeroOneStudio/rubykassa/pull/24
+[#29]:https://github.com/ZeroOneStudio/rubykassa/pull/29
+
+## 0.4.2
+
+* force converting notification params to `HashWithIndifferentAccess` by @shir [#17][], [#18][]
+
+[#17]:https://github.com/ZeroOneStudio/rubykassa/pull/17
+[#18]:https://github.com/ZeroOneStudio/rubykassa/pull/18
+
+## 0.4.1
+
+* Add support html options in params by @JuraSN [#16][]
+
+[#16]:https://github.com/ZeroOneStudio/rubykassa/pull/16
+
+## 0.4.0
+
+* Simplify callbacks logic: no more necessity to pass `controller` variable to lambda. Thanks @BrainNya for active promotion.
+
+## 0.3.2
+
+* Add confugurable result callback [#14][]
+
+[#14]:https://github.com/ZeroOneStudio/rubykassa/pull/14
+
+## 0.3.1
+
+* Pass `controller` and `notification` variables to callback block by @1um [#12][]
+* Create `@notification` for `RobokassaController#fail` by @1um [#13][]
+
+[#12]:https://github.com/ZeroOneStudio/rubykassa/pull/12
+[#13]:https://github.com/ZeroOneStudio/rubykassa/pull/13
+
+## 0.3.0
+
+* Add confugurable success and fail callbacks
+
+## 0.2.6
+
+* Fix bug with wrong signature generating with custom user params
+
+## 0.2.5
+
+* Fix bug with passing custom params
+
+## 0.2.4
+
+* Fix naming issue with pay helper: rename 'link_to_pay' to 'pay_url'.
+
+## 0.2.3
+
+* Fix bug with calling incorrect signature validating method in `robokassa_controller#paid`. [#3][]
+* Fix bug with signatures comparison. Should compare downcased. [#4][]
+
+[#3]:https://github.com/ZeroOneStudio/rubykassa/issues/3
+[#4]:https://github.com/ZeroOneStudio/rubykassa/issues/4
+
+## 0.2.2
+
+* Fix description param name from `'InvDesc'` to `'Desc'`. Closes [#2][]
+
+[#2]: https://github.com/ZeroOneStudio/rubykassa/issues/2

data/Gemfile

@@ -0,0 +1,28 @@
+source "http://rubygems.org"
+
+rails_version = ENV["RAILS_VERSION"] || "default"
+
+rails = case rails_version
+when "master"
+  { github: "rails/rails" }
+when "3.0.0"
+  "~> 3.0.0"
+when "3.1.0"
+  "~> 3.1.0"
+when "3.2.0"
+  "~> 3.2.0"
+when "4.0.0"
+  "~> 4.0.0"     
+when "default"
+  "~> 4.0.0"   
+else
+  "~> #{rails_version}"
+end
+
+gem "rails", rails
+
+group :test do
+  gem "coveralls", require: false
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', version: 2, cli: "--color --format nested" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,121 @@
+## The Rubykassa gem
+
+[![Gem Version](https://badge.fury.io/rb/rubykassa.png)](http://badge.fury.io/rb/rubykassa)
+[![Build Status](https://secure.travis-ci.org/ZeroOneStudio/rubykassa.png)](http://travis-ci.org/ZeroOneStudio/rubykassa)
+[![Coverage Status](https://coveralls.io/repos/ZeroOneStudio/rubykassa/badge.png)](https://coveralls.io/r/ZeroOneStudio/rubykassa)
+[![Code Climate](https://codeclimate.com/github/ZeroOneStudio/rubykassa.png)](https://codeclimate.com/github/ZeroOneStudio/rubykassa)
+[![Dependency Status](https://gemnasium.com/ZeroOneStudio/rubykassa.png)](https://gemnasium.com/ZeroOneStudio/rubykassa)
+[![Inline docs](http://inch-ci.org/github/ZeroOneStudio/rubykassa.svg?branch=master)](http://inch-ci.org/github/ZeroOneStudio/rubykassa)
+
+by [Zero One][]
+
+[Zero One]: http://zeroone.st
+
+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.
+
+[Robokassa API]: http://robokassa.ru/ru/Doc/Ru/Interface.aspx
+[robokassa gem]: https://github.com/shaggyone/robokassa
+[Active Merchant Robokassa integration]: https://github.com/Shopify/active_merchant/tree/master/lib/active_merchant/billing/integrations/robokassa
+
+## Have questions?
+
+[![Gitter chat](https://badges.gitter.im/ZeroOneStudio/rubykassa.png)](https://gitter.im/ZeroOneStudio/rubykassa)
+
+## Installation
+
+Add to your `Gemfile`:
+
+    gem "rubykassa"
+
+## 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.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](https://github.com/laserlemon/figaro).
+
+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](http://guides.rubyonrails.org/layouts_and_rendering.html#creating-responses).
+
+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: "foo@bar.com", 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: "foo@bar.com", 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
+
+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](http://robokassa.ru/en/Doc/En/Interface.aspx#interfeys)). Please note, that any additional parameters to `op_state` are discarded in production mode.
+
+## Supported Rubies and Rails versions
+
+See the CI build [![Build Status](https://secure.travis-ci.org/ZeroOneStudio/rubykassa.png)](http://travis-ci.org/ZeroOneStudio/rubykassa)
+
+## License
+
+This project rocks and uses MIT-LICENSE
+Copyright (c) 2013-2016 [Zero One][]
+
+[ZERO.ONE]: http://www.zeroone.st
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ZeroOneStudio/rubykassa/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/robokassa_controller.rb

@@ -0,0 +1,33 @@
+class RobokassaController < ActionController::Base
+  before_action :create_notification
+
+  def result
+    if @notification.valid_result_signature?
+      instance_exec @notification, &Rubykassa.result_callback
+    else
+      instance_exec @notification, &Rubykassa.fail_callback
+    end
+  end
+
+  def success
+    if @notification.valid_success_signature?
+      instance_exec @notification, &Rubykassa.success_callback
+    else
+      instance_exec @notification, &Rubykassa.fail_callback
+    end
+  end
+
+  def fail
+    instance_exec @notification, &Rubykassa.fail_callback
+  end
+
+  private
+
+  def create_notification
+    if request.get?
+      @notification = Rubykassa::Notification.new request.query_parameters
+    elsif request.post?
+      @notification = Rubykassa::Notification.new request.request_parameters
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,12 @@
+Rails.application.routes.draw do
+  if Rubykassa::Client.configuration
+    scope :robokassa do
+      %w(result success fail).map do |route|
+        match route,
+              controller: :robokassa,
+              action: route,
+              via: Rubykassa.http_method
+      end
+    end
+  end
+end

data/lib/generators/rubykassa/install_generator.rb

@@ -0,0 +1,11 @@
+require 'rails/generators'
+
+module Rubykassa
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    def create_initializer_file
+      template 'rubykassa.rb',
+               File.join('config', 'initializers', 'rubykassa.rb')
+    end     
+  end
+end

data/lib/generators/rubykassa/templates/rubykassa.rb

@@ -0,0 +1,22 @@
+Rubykassa.configure do |config|
+  config.login = ENV['ROBOKASSA_LOGIN']
+  config.first_password = ENV['ROBOKASSA_FIRST_PASSWORD']
+  config.second_password = ENV['ROBOKASSA_SECOND_PASSWORD']
+  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
+
+  # Result callback is called in RobokassaController#result action if valid signature
+  # was generated. It should always return "OK#{ invoice_id }" string, so implement
+  # your custom logic above `render text: notification.success` line
+
+  config.result_callback = ->(notification) do
+    render text: notification.success
+  end
+
+  # Define success or failure callbacks here like:
+
+  # config.success_callback = ->(notification) { render text: 'success' }
+  # config.fail_callback = ->(notification) { redirect_to root_path }
+end

data/lib/rubykassa/action_view_extension.rb

@@ -0,0 +1,16 @@
+module Rubykassa
+  module ActionViewExtension
+    def pay_url(phrase, invoice_id, total, options = {}, &block)
+      total, invoice_id  = total.to_s, invoice_id.to_s
+      extra_params  = options.except :custom, :html
+      custom_params = options[:custom] ||= {}
+      html_params = options[:html] ||= {}
+      url = Rubykassa.pay_url invoice_id, total, custom_params, extra_params
+      if block_given?
+        link_to phrase, url, html_params, &block
+      else
+        link_to phrase, url, html_params
+      end
+    end
+  end
+end

data/lib/rubykassa/client.rb

@@ -0,0 +1,36 @@
+require 'rubykassa/configuration'
+
+module Rubykassa
+  class ConfigurationError < StandardError
+    ENV_MESSAGE =
+      'Invalid mode: only :test or :production are allowed'.freeze
+    HTTP_METHOD_MESSAGE =
+      'Invalid http method: only :get or :post are allowed'.freeze
+    HASH_ALGORITHM_MESSAGE = <<-MESSAGE.squish.freeze
+      Invalid hash algorithm: only
+      #{Configuration::HASH_ALGORITHMS.map(&:upcase).join ', '} are allowed
+    MESSAGE
+
+    def self.raise_errors_for(configuration)
+      if !configuration.correct_mode?
+        raise ConfigurationError, ENV_MESSAGE
+      end
+      if !configuration.correct_http_method? ||
+          !configuration.correct_xml_http_method?
+        raise ConfigurationError, HTTP_METHOD_MESSAGE
+      end
+      if !configuration.correct_hash_algorithm?
+        raise ConfigurationError, HASH_ALGORITHM_MESSAGE
+      end
+    end
+  end
+
+  class Client
+    cattr_accessor :configuration
+    def self.configure
+      self.configuration = Rubykassa::Configuration.new
+      yield self.configuration
+      ConfigurationError.raise_errors_for(self.configuration)
+    end
+  end
+end

data/lib/rubykassa/configuration.rb

@@ -0,0 +1,43 @@
+module Rubykassa
+  class Configuration
+    ATTRIBUTES = [
+      :login, :first_password, :second_password, :mode, :http_method,
+      :xml_http_method, :success_callback, :fail_callback, :result_callback,
+      :hash_algorithm
+    ]
+    HASH_ALGORITHMS = [:md5, :ripemd160, :sha1, :sha256, :sha384, :sha512]
+
+    attr_accessor *ATTRIBUTES
+
+    def initialize
+      self.login = 'your_login'
+      self.first_password   = 'first_password'
+      self.second_password  = 'second_password'
+      self.mode             = :test
+      self.http_method      = :get
+      self.xml_http_method  = :get
+      self.hash_algorithm   = :md5
+      self.success_callback = ->(notification) { render text: 'success' }
+      self.fail_callback    = ->(notification) { render text: 'fail' }
+      self.result_callback  = ->(notification) do
+        render text: notification.success
+      end
+    end
+
+    def correct_mode?
+      [:test, :production].include?(mode)
+    end
+
+    def correct_http_method?
+      [:get, :post].include?(http_method)
+    end
+
+    def correct_xml_http_method?
+      [:get, :post].include?(xml_http_method)
+    end
+
+    def correct_hash_algorithm?
+      HASH_ALGORITHMS.include?(hash_algorithm)
+    end
+  end
+end

data/lib/rubykassa/engine.rb

@@ -0,0 +1,9 @@
+require 'rubykassa/action_view_extension'
+
+module Rubykassa
+  class Engine < ::Rails::Engine
+    initializer 'rubykassa.action_view_extension' do
+      ActionView::Base.send :include, Rubykassa::ActionViewExtension
+    end
+  end
+end

data/lib/rubykassa/notification.rb

@@ -0,0 +1,27 @@
+require 'rubykassa/signature_generator'
+
+module Rubykassa
+  class Notification
+    include SignatureGenerator
+
+    attr_accessor :params
+    attr_reader :invoice_id, :total
+
+    def initialize(params = {})
+      @params = HashWithIndifferentAccess.new(params)
+      @invoice_id = @params['InvId']
+      @total = @params['OutSum']
+    end
+
+    %w(result success).map do |kind|
+      define_method "valid_#{kind}_signature?" do
+        @params['SignatureValue'].to_s.downcase ==
+            generate_signature_for(kind.to_sym)
+      end
+    end
+
+    def success
+      "OK#{@invoice_id}"
+    end
+  end
+end

data/lib/rubykassa/payment_interface.rb

@@ -0,0 +1,66 @@
+require 'rubykassa/signature_generator'
+
+module Rubykassa
+  class PaymentInterface
+    include SignatureGenerator
+
+    BASE_URL = 'https://auth.robokassa.ru/Merchant/Index.aspx'.freeze
+    PARAMS_CONFORMITY = {
+      login:       'MerchantLogin'.freeze,
+      total:       'OutSum'.freeze,
+      invoice_id:  'InvId'.freeze,
+      signature:   'SignatureValue'.freeze,
+      email:       'Email'.freeze,
+      currency:    'IncCurrLabel'.freeze,
+      description: 'Desc'.freeze,
+      culture:     'Culture'.freeze,
+      is_test:     'IsTest'.freeze,
+      receipt:     'Receipt'.freeze
+    }.freeze
+
+    attr_accessor :invoice_id, :total, :params
+
+    def initialize(&block)
+      instance_eval &block if block_given?
+      shpfy_params
+    end
+
+    def test_mode?
+      Rubykassa.mode == :test
+    end
+
+    def pay_url(extra_params = {})
+      @receipt = extra_params.delete(:receipt).to_json
+      extra_params = extra_params.slice :currency, :description, :email, :culture
+      result_params = initial_options.merge(extra_params).map do |key, value|
+        if key =~ /^shp/
+          "#{key}=#{value}"
+        else
+          "#{PARAMS_CONFORMITY[key]}=#{value}"
+        end
+      end
+      result_params << URI.encode_www_form([[PARAMS_CONFORMITY[:receipt], @receipt]])
+      BASE_URL.dup << '?' << result_params.compact.join('&')
+    end
+
+    def initial_options
+      result = {
+        login: Rubykassa.login,
+        total: @total,
+        invoice_id: @invoice_id,
+        is_test: test_mode? ? 1 : 0,
+        signature: generate_signature_for(:payment)
+      }
+      custom_params = @params.sort.map { |param_name| param_name.first 2 }
+      result.merge Hash[custom_params]
+    end
+
+    private
+
+    def shpfy_params
+      @params = @params.map do |param_name|
+        ["shp_#{param_name[0]}".to_sym, param_name[1]]
+      end
+    end
+  end
+end

data/lib/rubykassa/signature_generator.rb

@@ -0,0 +1,58 @@
+module Rubykassa
+  module SignatureGenerator
+    KIND_ERROR_MESSAGE =
+      'Available kinds are only :payment, :result or :success'.freeze
+
+    def generate_signature_for(kind)
+      unless [:success, :payment, :result].include?(kind)
+        raise ArgumentError, KIND_ERROR_MESSAGE
+      end
+      method(Rubykassa.hash_algorithm).call params_string(kind)
+    end
+
+    def params_string kind
+      result = case kind
+               when :payment
+                 [Rubykassa.login, @total, @invoice_id, @receipt, Rubykassa.first_password, custom_params]
+               when :result
+                 [@total, @invoice_id, Rubykassa.second_password, custom_params]
+               when :success
+                 [@total, @invoice_id, Rubykassa.first_password, custom_params]
+               end
+      result.flatten.join ':'
+    end
+
+    def custom_params
+      @params.sort.inject([]) do |result, element|
+        result << element.join('=') if element[0] =~ /^shp/
+        result
+      end
+    end
+
+    protected
+
+    def md5(data)
+      Digest::MD5.hexdigest data
+    end
+
+    def ripemd160(data)
+      Digest::RMD160.hexdigest data
+    end
+
+    def sha1(data)
+      Digest::SHA1.hexdigest data
+    end
+
+    def sha265(data)
+      Digest::SHA256.hexdigest data
+    end
+
+    def sha384(data)
+      Digest::SHA384.hexdigest data
+    end
+
+    def sha512(data)
+      Digest::SHA512.hexdigest data
+    end
+  end
+end

data/lib/rubykassa/version.rb

@@ -0,0 +1,3 @@
+module Rubykassa
+  VERSION = '0.4.2'
+end