kazkom_epay 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kazkom_epay.gemspec
+gemspec
+gem 'rspec'
+gem 'activesupport', '3.2.8'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Semenyuk Dmitriy
+
+MIT License
+
+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,139 @@
+# gem для работы с КазКоммерцБанк ePay
+
+Gem для работы с платежным шлюзом ККБ ePay для использования в проектах, использующих Ruby (Ruby On Rails, Sinatra и др.).
+
+## Установка
+
+Добавьте эту строку в ваш Gemfile:
+
+    gem 'kazkom_epay'
+
+Затем установите gem, используя bundler:
+
+    $ bundle
+
+Или выполните команду:
+
+    $ gem install kazkom_epay
+
+## Использование (примеры с использованием Ruby On Rails)
+
+### Подпись XML-запроса к банку
+
+```ruby
+  # encoding: UTF-8
+  class PayController < ApplicationController
+    before_filter :authenticate_user!
+    def epay
+      # ...
+      path_to_yaml = Rails.root.join('config', 'epay.yml')
+      epay_credentials = KazkomEpay::Epay.production_credentials path_to_yaml
+      amount = ...
+      
+      # здесь вы фиксируете Order_ID, который вы передадите банку
+      # и по которому вы сможете в дальнейшем найти нужный платеж
+      # и пользователя, чтобы зачислить деньги ему на счет
+      payment_request = PaymentRequest.create! do |r|
+        r.user = current_user
+        r.amount = amount
+      end
+
+      order_id = payment_request.id
+
+      epay_credentials.merge!({amount: amount, order_id: order_id})
+      epay = KazkomEpay::Epay.setup(epay_credentials)
+
+      @base64_encoded_xml = epay.base64_encoded_signed_xml
+      # ...
+    end
+    # ...
+  end
+```
+
+### Проверка XML-ответа от банка
+
+```ruby
+  # encoding: UTF-8
+  class PaymentsEpayController < PaymentsController
+    # ...
+    def process_payment
+      xml = params[:response]
+
+      epay_response_is_okay = KazkomEpay::Epay.check_signed_xml xml
+      if epay_response_is_okay
+        epay_response = Hash.from_xml(xml)['document']['bank']
+
+        begin
+          ActiveRecord::Base.transaction do
+            # Задача этого блока - увеличить счет пользователя
+
+            # Нужно найти Order_ID, который вы создали на этапе формировани
+            # XML для отправки в ePay.
+            # Например так (при условии, что у вас есть модель PaymentRequest):
+            payment_request = PaymentRequest.find epay_response['customer']['merchant']['order']['order_id']
+
+            # из него вы можете выяснить, счет какого пользователя увеличить:
+            user = payment_request.user
+          end
+        rescue => e
+          # Что-то пошло не так, зафиксируйте это в логах и сделайте все, чтобы
+          # вы об этом узнали (отошлите себе уведомление и пр.)
+          Rails.logger.fatal "Что-то пошло не так при оплате через ePay. Данные: " + params.to_json
+
+          # ...
+        end
+      else
+        # Подпись оказалась неверной. Возможно, вас пытаются взломать
+      end
+
+      # Обязательно выведите "0" и ничего больше, это требование ePay
+      render text: "0"
+    end
+  end
+```
+
+## Какой код я могу использовать для отсылки запроса на оплату в ePay?
+
+### Пример с использованием eRb:
+
+#### Пояснения
+
+Для тестирования используется 3dsecure.kkb.kz, иначе используется epay.kkb.kz, потому что при тестировании вы можете использовать тестовый закрытый ключ и тестовые данные кредитной карты.
+
+@base64_encoded_xml - это то, что отдал метод base64_encoded_signed_xml
+
+```html
+<% prefix_for_epay = Rails.env.development? ? '3dsecure' : 'epay' %>
+<form id="pay-epay" method="post" action="https://<%= prefix_for_epay %>.kkb.kz/jsp/process/logon.jsp" target="_blank">
+  <input type="hidden" name="Signed_Order_B64" value="<%= @base64_encoded_xml %>">
+  <input type="hidden" name="email" value="<%= current_user.email %>">
+  <input type="hidden" name="Language" value="rus">
+  <input type="hidden" name="BackLink" value="<%= root_url %>">
+  <input type="hidden" name="PostLink" value="<%= "обработчик_ответа_банка" %>">
+  <input type="submit" value="Оплатить">
+</form>
+```
+
+## Пример epay.yml
+
+```yaml
+  ---
+  cert_id: abcd1234
+  merchant_id: '1234567'
+  private_key_path: 'your.prv.pem' # делается предположение, что ключи находятся в app/cert
+  private_key_password: "s0me_p@$$w0rd"
+```
+
+## Пример
+
+TODO: сделать Rails-приложение для примера
+
+Для тестирования postlink (обработчика ответа банка) приложение должно быть доступно из интернета (имеется ввиду URL).
+
+## Хотите помочь?
+
+1. Fork'ните проект
+2. Создайте ветку для вашей функции (`git checkout -b my-new-feature`)
+3. Сделайте коммит для ваших изменений (`git commit -am 'Added some feature'`)
+4. Загрузите ветку на GitHub (`git push origin my-new-feature`)
+5. Сделайте Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/cert/test/kkbca.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDijCCAnKgAwIBAgIFAMGDJ+gwDQYJKoZIhvcNAQEEBQAwUzELMAkGA1UEBhMC
+S1oxDDAKBgNVBAoTA0tLQjELMAkGA1UECxMCQ0ExDzANBgNVBAMTBktLQiBDQTEY
+MBYGCSqGSIb3DQEJARYJY2FAa2tiLmt6MB4XDTA0MTAxODEwMzYwNloXDTA5MTAx
+NzEwMzYwNlowgYMxCzAJBgNVBAYTAktaMQ8wDQYDVQQHEwZBbG1hdHkxHDAaBgNV
+BAoTE0pTQyBLYXprb21tZXJ0c2JhbmsxEzARBgNVBAsTCkhlYWRPZmZpY2UxFDAS
+BgNVBAMTC0VQQVkgU1lTVEVNMRowGAYJKoZIhvcNAQkBFgtlcGF5QGtrYi5rejCB
+nzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAwNtnbUr82ALmO1E0tQ8Ejp1D+9GH
+EKPeqVTokLb95VhvXX3GoYCKPseFvXMD8x+P0I9x03nJnSRyP6hJ85W/jsElkuYj
+LzYWFfYhCeCQgit2lbSx9FbGVJ1B7M4ZMYuub4DlgtjQ8ebbqRACZ3Yw7LhciUcS
+235c4K+zmL7p5i0CAwEAAaOBtzCBtDAdBgNVHQ4EFgQU+7GVWbXvHRDbdxFSXqc6
+vd6VPQcwHwYDVR0jBBgwFoAU712nYyivxvN+d0LbneCElQZ9clMwDAYDVR0TBAUw
+AwEBADAOBgNVHQ8BAf8EBAMCBPAwNQYDVR0fBC4wLDAqoCigJoYkaHR0cDovL3d3
+dy5ra2Iua3ovY2VydHJvb3Qva2tiY2EuY3JsMB0GA1UdJQQWMBQGCCsGAQUFBwMC
+BggrBgEFBQcDBDANBgkqhkiG9w0BAQQFAAOCAQEAB0jZpXUO9O0uWJZAJP28ATnC
+PCMYa9jheM8MwKhSqe0m1IQ8mkPBzFnKqgmBdyPSp94Fy6xY2ciEnJ5oCEJGM9Nm
+L1kUeg4/HqiTcEUaZWtec4SvwEhKjfoXVwx/teV9KNQoQ8YNyQflEm6DMjiZ6GDM
+qLNV2ZLD5RytWKJYzqg/WScKpuGHYBlUmAi75Ew4nNx1PXi0ATZ9wc0aiXYlwAaP
+pDhNvvLcVLiBjjs/o/QhBgtKewAbltVnU97gf/+yQErbfrL2z+Hg4hF0R63vkjj5
+HsxOZ+pVNi0p+TzKyI1QcS4f53rxo0pMYxHn0LJQquCzbyDKcipkg9qrAFkxoA==
+-----END CERTIFICATE-----

data/cert/test/test_prv.pem

@@ -0,0 +1,12 @@
+-----BEGIN RSA PRIVATE KEY-----
+Proc-Type: 4,ENCRYPTED
+DEK-Info: DES-EDE3-CBC,25E4520A4E5EE17A
+
+r1Uz/b1FZpMJg0kh2efZoaXpLnEg9xR8rkU8nH5y5LTP7q15zldAWm0BqGax6ZHm
+5xe/zTjFcZKYjh7NeINlTKrAnbNNYZnYxqqj9GGUa1gEpvHn8TukXB83cEbvsDeS
+jrbvbj5itRqqa9fNNs4rzizVdaGFpQKVhCqx4u7lE8oWdR1WCUHOywpFpkpHznDr
+od/B2JSzG6OekuwCB4tnyZmJ1RYncbsM7NysOGcUZcT9ZmfzteYkVjPxZKcHzjTr
+pLzhlYeAr0by9jNhtodGaYoRHEs2cqK8zEPBRMmgDydVA9Fg2NIIDaBB7ugdjaUw
+XuWUo1y5JrU0hRnB7FdAEizO1g5CNG5aZ5UDcg9jbNeKEqrZy2VcBKARYxVDUIlm
+INB98tXargbAgbCRwKvn76m8R0ClBMlIHiMzP3LCTfQaJnCIIDirfA==
+-----END RSA PRIVATE KEY-----

data/kazkom_epay.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/kazkom_epay/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dims"]
+  gem.email         = ["mail@dims.kz"]
+  gem.description   = %q{Модуль работы с платежным шлюзом KKB ePay}
+  gem.summary       = %q{Модуль работы с платежным шлюзом KKB ePay}
+  gem.homepage      = "http://dims.kz"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "kazkom_epay"
+  gem.require_paths = ["lib"]
+  gem.version       = KazkomEpay::VERSION
+end

data/lib/kazkom_epay/version.rb

@@ -0,0 +1,3 @@
+module KazkomEpay
+  VERSION = "1.0.0"
+end

data/lib/kazkom_epay.rb

@@ -0,0 +1,122 @@
+require "kazkom_epay/version"
+
+module KazkomEpay
+  require 'base64'
+  require 'openssl'
+  require 'yaml'
+
+  def self.root
+    Pathname.new(File.expand_path '../..', __FILE__)
+  end
+
+  class Epay
+    class << self
+      def production_credentials yaml_file
+        yaml = YAML.load_file(yaml_file)
+        epay_credentials = {
+          cert_id: yaml['cert_id'],
+          merchant_id: yaml['merchant_id'],
+          private_key_path: KazkomEpay::root.join(yaml['private_key_path']),
+          private_key_password: yaml['private_key_password'],
+        }
+      end
+
+      def settings
+        @@settings ||= {
+          cert_id: "00C182B189", # test cert_id
+          currency: 398, # KZT
+          merchant_name: "Some Merchant",
+          merchant_id: 92061101, # test merchant_id
+
+          private_key_path: KazkomEpay::root.join('cert', 'test', "test_prv.pem"), # test private key path
+          private_key_password: "nissan", # test private key password
+          public_key_path: KazkomEpay::root.join('cert', 'test', "kkbca.pem")
+        }
+      end
+
+      def setup with_params
+        @@settings ||= settings
+        with_params.each_pair do |key, value|
+          @@settings[key.to_sym] = value
+        end
+        self
+      end
+
+      def key
+        settings[:key]
+      end
+
+      def xml
+        %Q|<merchant cert_id="#{cert_id}" name="#{merchant_name}"><order order_id="#{order_id}" amount="#{amount}" currency="#{currency}"><department merchant_id="#{merchant_id}" amount="#{amount}"/></order></merchant>|
+      end
+
+      def xml_sign
+        pkey = OpenSSL::PKey::RSA.new(File.read(settings[:private_key_path]), settings[:private_key_password])
+
+        signature = pkey.sign(OpenSSL::Digest::SHA1.new, xml)
+        signature.reverse! if reverse_signature
+
+        signature_base64_encoded_without_newlines = Base64.encode64(signature).gsub("\n", '')
+        '<merchant_sign type="RSA">' + signature_base64_encoded_without_newlines + '</merchant_sign>'
+      end
+
+      def signed_xml
+        "<document>" + xml + xml_sign + "</document>"
+      end
+
+      # КЛЮЧЕВОЙ МОМЕНТ при формировании запроса для банка
+      def base64_encoded_signed_xml
+        Base64.encode64(signed_xml).gsub("\n", '')
+      end
+
+      # КЛЮЧЕВОЙ МОМЕНТ при проверке ответа от банка
+      def check_signed_xml xml
+        # Hash.from_xml
+        require 'active_support/core_ext/hash/conversions'
+
+        bank_sign_raw_base64 = Hash.from_xml(xml)['document']['bank_sign']
+
+        bank_part_regexp = /\A<document>(.+)<bank_sign.*\z/
+        bank_sign_regexp = /(<bank_sign .+<\/bank_sign>)/
+
+        check_this = bank_part_regexp.match(xml)[1]
+        bank_sign_raw = Base64.decode64 bank_sign_raw_base64
+        bank_sign_raw.reverse! if reverse_signature
+
+        digest = OpenSSL::Digest::SHA1.new
+        cert = OpenSSL::X509::Certificate.new File.read(settings[:public_key_path])
+        public_key = cert.public_key
+
+        check_result = public_key.verify digest, bank_sign_raw, check_this
+      end
+
+      def cert_id
+        settings[:cert_id]
+      end
+
+      def merchant_name
+        settings[:merchant_name]
+      end
+
+      def order_id
+        settings[:order_id]
+      end
+
+      def amount
+        settings[:amount]
+      end
+
+      def currency
+        settings[:currency]
+      end
+
+      def merchant_id
+        settings[:merchant_id]
+      end
+
+      def reverse_signature
+        true
+      end
+    end
+  end
+end

data/spec/models/epay_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require File.expand_path('lib/kazkom_epay')
+
+describe KazkomEpay::Epay do
+  describe "Request to the bank" do
+    it "should give XML with valid signature for using as request to the bank" do
+      # xml = '<document><merchant cert_id="00C182B189" name="Autokupon"><order order_id="242473" amount="10" currency="398"><department merchant_id="92061101" amount="10"/></order></merchant><merchant_sign type="RSA">nU+OPJl5cwUaePrLjMt8omv9qJbnZewUarj66DWflDgkUIk+i80evth70eJ/S/td3fxItd/7EKV5tZliAYkvcA==</merchant_sign></document>'
+      xml_with_valid_signature = 'PGRvY3VtZW50PjxtZXJjaGFudCBjZXJ0X2lkPSIwMEMxODJCMTg5IiBuYW1lPSJBdXRva3Vwb24iPjxvcmRlciBvcmRlcl9pZD0iMjQyNDczIiBhbW91bnQ9IjEwIiBjdXJyZW5jeT0iMzk4Ij48ZGVwYXJ0bWVudCBtZXJjaGFudF9pZD0iOTIwNjExMDEiIGFtb3VudD0iMTAiLz48L29yZGVyPjwvbWVyY2hhbnQ+PG1lcmNoYW50X3NpZ24gdHlwZT0iUlNBIj5uVStPUEpsNWN3VWFlUHJMak10OG9tdjlxSmJuWmV3VWFyajY2RFdmbERna1VJaytpODBldnRoNzBlSi9TL3RkM2Z4SXRkLzdFS1Y1dFpsaUFZa3ZjQT09PC9tZXJjaGFudF9zaWduPjwvZG9jdW1lbnQ+'
+      @epay = KazkomEpay::Epay.setup({cert_id: '00C182B189', merchant_name: 'Autokupon', amount: 10, order_id: 242473, currency: 398, merchant_id: '92061101'})
+      @epay.base64_encoded_signed_xml.should eql(xml_with_valid_signature)
+    end
+  end
+
+  describe "Response from the bank" do
+    it "should check XML response from the bank with valid signature" do
+      @epay = KazkomEpay::Epay.setup({})
+      xml_with_valid_signature = '<document><bank name="Kazkommertsbank JSC"><customer name="YO MAN" mail="test@test.kz" phone=""><merchant cert_id="00C182B189" name="Autokupon"><order order_id="345009" amount="500" currency="398"><department merchant_id="92061101" amount="500"/></order></merchant><merchant_sign type="RSA"/></customer><customer_sign type="RSA"/><results timestamp="2012-09-07 12:47:25"><payment merchant_id="92061101" card="440564-XX-XXXX-6150" amount="500" reference="120907124725" approval_code="124725" response_code="00" Secure="Yes" card_bin="KAZ"/></results></bank><bank_sign cert_id="00C18327E8" type="SHA/RSA">A/8NoZc1y82G/Fzkciy1bPg6/2J5GGfcQ15HvfdpTnyJVW2tm+fd3sYkpTC+3mfUj2C/dux9ZLsh3K1yV6ZFKm8/0TaMztdd5+KMto2YcOrplIml/7ICT4yUiiB2kCz6NbWOa/RlqowrABPbwdhb1aeJkHtNBkH79rfDM/AAWb0=</bank_sign></document>'
+      @epay.check_signed_xml(xml_with_valid_signature).should be_true
+    end
+
+    it "should ban XML response from the bank with invalid signature" do
+      @epay = KazkomEpay::Epay.setup({})
+      xml_with_valid_signature = '<document><bank name="Hackbank JSC"><customer name="YO MAN" mail="test@test.kz" phone=""><merchant cert_id="00C182B189" name="Autokupon"><order order_id="345009" amount="500" currency="398"><department merchant_id="92061101" amount="500"/></order></merchant><merchant_sign type="RSA"/></customer><customer_sign type="RSA"/><results timestamp="2012-09-07 12:47:25"><payment merchant_id="92061101" card="440564-XX-XXXX-6150" amount="500" reference="120907124725" approval_code="124725" response_code="00" Secure="Yes" card_bin="KAZ"/></results></bank><bank_sign cert_id="00C18327E8" type="SHA/RSA">A/8NoZc1y82G/Fzkciy1bPg6/2J5GGfcQ15HvfdpTnyJVW2tm+fd3sYkpTC+3mfUj2C/dux9ZLsh3K1yV6ZFKm8/0TaMztdd5+KMto2YcOrplIml/7ICT4yUiiB2kCz6NbWOa/RlqowrABPbwdhb1aeJkHtNBkH79rfDM/AAWb0=</bank_sign></document>'
+      @epay.check_signed_xml(xml_with_valid_signature).should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: kazkom_epay
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Dims
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-08 00:00:00.000000000 Z
+dependencies: []
+description: Модуль работы с платежным шлюзом KKB ePay
+email:
+- mail@dims.kz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cert/test/kkbca.pem
+- cert/test/test_prv.pem
+- kazkom_epay.gemspec
+- lib/kazkom_epay.rb
+- lib/kazkom_epay/version.rb
+- spec/models/epay_spec.rb
+- spec/spec_helper.rb
+homepage: http://dims.kz
+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.24
+signing_key: 
+specification_version: 3
+summary: Модуль работы с платежным шлюзом KKB ePay
+test_files:
+- spec/models/epay_spec.rb
+- spec/spec_helper.rb
+has_rdoc: