kazkom_epay 1.0.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 178c7ba2aa4f284b66ad9cd595a937639536c1f5
-  data.tar.gz: 33c054747755e16eea22e55cb0a57d0b1ce293b8
+  metadata.gz: fa393b05a0f16735c6ed62a0d423f26231ddf254
+  data.tar.gz: 78b33420042950f9dbd3cca2b2ea75e3a33c208c
 SHA512:
-  metadata.gz: 110e2e595ed27bb9791360ad17eb66b76efd01bd78a80d0fe4a475206fc95fe1bceaac1db23a5915d6e2f36cae4023b208db51b0100be97e4e9c0b7eb78c942f
-  data.tar.gz: ea7b8e9b71e91f5307372f250ed61fed10389a70f3e5bbbcd06588efb8d55d1ac118d0de0f24a7b9bff7faa9782f31cc2384069b74d538d546e521d0e57cab55
+  metadata.gz: 1c718b8f7b845e4a79e3d4a833fea9e634ffbfe968145319fb2bbe87c27f3c2bd53b69e0f2d761b7cc194ba93ca2083c3ccb1382d2bd6e48fa855073e16c13cd
+  data.tar.gz: 782c0109d68406b457c61f2173ea7aa48077436f1a0d19891de4aa771ba0e8cd440f8265350bcaaac07f8648d45d0c730e5c7c366c6bd262cc1b8fe1f2c9e52d

data/.rspec

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

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in kazkom_epay.gemspec
 gemspec
 gem 'rspec'
-gem 'activesupport', '3.2.8'
+gem 'activesupport', '>= 3.2.13'

data/README.md

@@ -18,18 +18,30 @@ Gem для работы с платежным шлюзом ККБ ePay для и
 
 ## Использование (примеры с использованием Ruby On Rails)
 
+### Настройка
+
+Для использования гема его нужно предварительно настроить. Например, можно создать файл
+`config/initializers/epay.rb` с подобным содержимым:
+
+```ruby
+KazkomEpay.configure do |c|
+  c.cert_id '012345'
+  c.merchant_name 'Some Seller'
+  c.merchant_id '123456'
+  c.private_key_path Rails.root.join("config", "cert", "too_roga_i_kopyta_prv.pem")
+  c.private_key_password "$ecret"
+  c.public_key_path Rails.root.join("config", "cert", "kkbca.pem")
+end
+```
+
 ### Подпись 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 = YAML.load_file(path_to_yaml)
-      amount = ...
-      
       # здесь вы фиксируете Order_ID, который вы передадите банку
       # и по которому вы сможете в дальнейшем найти нужный платеж
       # и пользователя, чтобы зачислить деньги ему на счет
@@ -39,11 +51,9 @@ Gem для работы с платежным шлюзом ККБ ePay для и
       end
 
       order_id = payment_request.id
+      amount = ...
 
-      epay_credentials.merge!({amount: amount, order_id: order_id})
-      epay = KazkomEpay::Epay.setup(epay_credentials)
-
-      @base64_encoded_xml = epay.base64_encoded_signed_xml
+      @base64_encoded_xml = KazkomEpay::Signer.new(amount: amount, order_id: order_id).base64_encoded_signed_xml
       # ...
     end
     # ...
@@ -59,7 +69,7 @@ Gem для работы с платежным шлюзом ККБ ePay для и
     def process_payment
       xml = params[:response]
 
-      epay_response_is_okay = KazkomEpay::Epay.check_signed_xml xml
+      epay_response_is_okay = KazkomEpay.valid_xml_signature? xml
       if epay_response_is_okay
         epay_response = Hash.from_xml(xml)['document']['bank']
 
@@ -114,36 +124,6 @@ Gem для работы с платежным шлюзом ККБ ePay для и
 </form>
 ```
 
-## Пример epay.yml
-
-```yaml
-  ---
-  cert_id: abcd1234
-  merchant_id: '1234567'
-  private_key_path: 'your.prv.pem'
-  private_key_password: "s0me_p@$$w0rd"
-```
-
-*Важное замечание*
-В _private_key_path_ нужно указать либо полный путь к файлу ключа, либо обернуть Yaml в Erb:
-
-epay.yml.erb
-```yaml
-  ---
-  # ...
-  private_key_path: <%= Rails.root.join('app', 'cert', 'your.prv.pem') %>
-```
-
-и в коде использовать
-
-    epay_credentials = YAML.load(ERB.new(File.read(path_to_yaml)).result)
-
-вместо
-
-    epay_credentials = YAML.load_file(path_to_yaml)
-
-
-
 ## Пример
 
 TODO: сделать Rails-приложение для примера
@@ -151,10 +131,10 @@ TODO: сделать Rails-приложение для примера
 Для тестирования postlink (обработчика ответа банка) приложение должно быть доступно из интернета (имеется ввиду URL).
 
 
-## Хотите нарушить инкапсуляцию и посмотреть на данные, с которыми работает gem?
+## Хотите посмотреть на данные, с которыми работает gem?
 
 ```ruby
-KazkomEpay::Epay.setup(epay_credentials).class_variable_get(:'@@settings').to_yaml
+KazkomEpay.configure(epay_credentials).settings.to_yaml
 ```
 
 ## Хотите помочь?

data/kazkom_epay.gemspec

@@ -2,15 +2,15 @@
 require File.expand_path('../lib/kazkom_epay/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Dims"]
-  gem.email         = ["mail@dims.kz"]
+  gem.authors       = ["Semenyuk Dmitriy"]
+  gem.email         = ["mail@semenyukdmitriy.com"]
   gem.description   = %q{Модуль работы с платежным шлюзом KKB ePay}
   gem.summary       = %q{Модуль работы с платежным шлюзом KKB ePay}
-  gem.homepage      = "http://dims.kz"
+  gem.homepage      = "http://semenyukdmitriy.com"
 
   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.test_files    = gem.files.grep(%r{^(spec|features)/})
   gem.name          = "kazkom_epay"
   gem.require_paths = ["lib"]
   gem.version       = KazkomEpay::VERSION

data/lib/kazkom_epay.rb

@@ -1,114 +1,154 @@
 require "kazkom_epay/version"
+require "base64"
+require "openssl"
 
 module KazkomEpay
-  require 'base64'
-  require 'openssl'
-  require 'yaml'
+  CONFIGURABLE_ATTRIBUTES = [:cert_id, :merchant_id, :merchant_name,
+    :private_key_path, :private_key_password,
+    :public_key_path]
 
-  def self.root
+  def self.gem_root_path
     Pathname.new(File.expand_path '../..', __FILE__)
   end
 
-  class Epay
-    class << self
-      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
+  DEFAULTS = {
+    # test data
+    cert_id: "00C182B189",
+    merchant_name: "Some Merchant",
+    merchant_id: 92061101,
+
+    private_key_path: KazkomEpay.gem_root_path.join('cert', 'test', "test_prv.pem"),
+    private_key_password: "nissan",
+    public_key_path: KazkomEpay.gem_root_path.join('cert', 'test', "kkbca.pem")
+  }
+
+  # Выдача готового подписанного XML-документа для банка
+  #
+  # Пример использования:
+  #
+  #   signer = KazkomEpay::Signer.new(amount: 10, order_id: 242473)
+  #
+  #   # уже Base64-кодированного
+  #   signer.base64_encoded_signed_xml
+  #
+  #   # сырого (сам XML)
+  #   signer.signed_xml
+  #
+  class Signer
+    def initialize(options = {})
+      @amount, @order_id = options.fetch(:amount), options.fetch(:order_id)
+    end
 
-      def setup with_params
-        @@settings ||= settings
-        with_params.each_pair do |key, value|
-          @@settings[key.to_sym] = value
-        end
-        self
-      end
+    def base64_encoded_signed_xml
+      Base64.encode64(signed_xml).gsub("\n", '')
+    end
 
-      def key
-        settings[:key]
-      end
+    def signed_xml
+      ["<document>", xml, xml_signature, "</document>"].join
+    end
+
+    private
 
       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>|
+        %Q|<merchant cert_id="#{KazkomEpay.cert_id}" name="#{KazkomEpay.merchant_name}"><order order_id="#{@order_id}" amount="#{@amount}" currency="#{KazkomEpay.currency}"><department merchant_id="#{KazkomEpay.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])
+      def xml_signature
+        pkey = OpenSSL::PKey::RSA.new(File.read(KazkomEpay.send(:settings)[:private_key_path]), KazkomEpay.send(:settings)[:private_key_password])
 
         signature = pkey.sign(OpenSSL::Digest::SHA1.new, xml)
-        signature.reverse! if reverse_signature
+        signature.reverse! if KazkomEpay.send(: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>"
+        ['<merchant_sign type="RSA">', signature_base64_encoded_without_newlines, '</merchant_sign>'].join
       end
+  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'
+  # Проверка аутентичности XML-документа, пришедшего от банка
+  #
+  # Пример использования:
+  #
+  #   unless KazkomEpay.valid_xml_signature? some_xml_string
+  #     raise "Hack attempt!"
+  #   end
+  #
+  def valid_xml_signature?(xml)
+    # for `Hash.from_xml`
+    require 'active_support/core_ext/hash/conversions'
 
-        bank_sign_raw_base64 = Hash.from_xml(xml)['document']['bank_sign']
+    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>)/
+    bank_part_regexp = /\A<document>(.+)<bank_sign.*\z/
 
-        check_this = bank_part_regexp.match(xml)[1]
-        bank_sign_raw = Base64.decode64 bank_sign_raw_base64
-        bank_sign_raw.reverse! if reverse_signature
+    data_to_validate = 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
+    digest = OpenSSL::Digest::SHA1.new
+    cert = OpenSSL::X509::Certificate.new File.read(settings[:public_key_path])
 
-        check_result = public_key.verify digest, bank_sign_raw, check_this
-      end
+    cert.public_key.verify digest, bank_sign_raw, data_to_validate
+  end
 
-      alias_method :xml_correctly_signed?, :check_signed_xml
+  private
 
-      def cert_id
-        settings[:cert_id]
-      end
+    def settings
+      {
+        cert_id: cert_id,
+        currency: currency, # KZT
+        merchant_name: merchant_name,
+        merchant_id: merchant_id,
 
-      def merchant_name
-        settings[:merchant_name]
-      end
+        private_key_path: private_key[:path],
+        private_key_password: private_key[:password],
+        public_key_path: public_key[:path]
+      }
+    end
 
-      def order_id
-        settings[:order_id]
-      end
+    def reverse_signature
+      true
+    end
 
-      def amount
-        settings[:amount]
-      end
+    # Memoizers
+    def private_key
+      @private_key ||= {path: private_key_path, password: private_key_password}
+    end
+    def public_key
+      @public_key ||= {path: public_key_path}
+    end
 
-      def currency
-        settings[:currency]
+    module Configurator
+      require 'active_support/core_ext/module/attribute_accessors'
+
+      def configure_for_test
+        configure(DEFAULTS)
       end
+      
+      def configure(attrs = {})
+        attrs.each do |k, v|
+          self.send(:"#{k}=", v) if CONFIGURABLE_ATTRIBUTES.include?(k.to_sym)
+        end
+        yield self if block_given?
 
-      def merchant_id
-        settings[:merchant_id]
+        if (blank = CONFIGURABLE_ATTRIBUTES.map { |att| [att, self.send(att)] }.select{|_, val| val.nil?}).count > 0
+          blank_attribute_names = blank.map { |attr, _| attr }.join(", ")
+          raise "Some required attributes left blank: #{blank_attribute_names}"
+        end
+
+        self
       end
 
-      def reverse_signature
-        true
+      CONFIGURABLE_ATTRIBUTES.each do |att|
+        mattr_accessor att
       end
+
+      mattr_accessor :currency
+      @@currency = 398
     end
-  end
+
+
+    extend Configurator
+    extend self
 end

data/lib/kazkom_epay/version.rb

@@ -1,3 +1,3 @@
 module KazkomEpay
-  VERSION = "1.0.2"
+  VERSION = "1.5.0"
 end

data/spec/models/epay_spec.rb

@@ -1,27 +1,40 @@
 require 'spec_helper'
 require File.expand_path('lib/kazkom_epay')
 
-describe KazkomEpay::Epay do
+describe KazkomEpay do
   describe "Request to the bank" do
+    before(:all) do
+      KazkomEpay.configure(
+        cert_id: '00C182B189',
+        merchant_name: 'Autokupon',
+        merchant_id: '92061101',
+        # test keys:
+        private_key_path: KazkomEpay::DEFAULTS[:private_key_path],
+        private_key_password: KazkomEpay::DEFAULTS[:private_key_password],
+        public_key_path: KazkomEpay::DEFAULTS[:public_key_path]
+      )
+    end
+    let(:epay) { KazkomEpay::Signer.new(amount: 10, order_id: 242473) }
+
     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)
+
+      epay.base64_encoded_signed_xml.should eql xml_with_valid_signature
     end
   end
 
   describe "Response from the bank" do
+    let(:epay) { KazkomEpay.configure_for_test }
+
     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
+      epay.valid_xml_signature?(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
+      xml_with_invalid_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.valid_xml_signature?(xml_with_invalid_signature).should be false
     end
   end
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: kazkom_epay
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.5.0
 platform: ruby
 authors:
-- Dims
+- Semenyuk Dmitriy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
+date: 2013-05-28 00:00:00.000000000 Z
 dependencies: []
 description: Модуль работы с платежным шлюзом KKB ePay
 email:
-- mail@dims.kz
+- mail@semenyukdmitriy.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -30,7 +30,7 @@ files:
 - lib/kazkom_epay/version.rb
 - spec/models/epay_spec.rb
 - spec/spec_helper.rb
-homepage: http://dims.kz
+homepage: http://semenyukdmitriy.com
 licenses: []
 metadata: {}
 post_install_message: 
@@ -49,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Модуль работы с платежным шлюзом KKB ePay