payonline 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffecc72ab316af139858d166bad9f2f061fee703
-  data.tar.gz: e37aa7b384f956ab5a019081a9a8da21efbe042d
+  metadata.gz: 4eeed6efaf2e7fdf7739e8ffce53c6d490a43407
+  data.tar.gz: 8ae885feb0eafc060bebf8c39dd39f730b11cd03
 SHA512:
-  metadata.gz: 73e84b51ee88012b49eb71a948b7676a285dcc1a7000a0d1d5bd0ae9b81ce9432f6d01af43dde8933516dbefc2c6986442e5edf079e24fcca7bf72b53265f0b6
-  data.tar.gz: fa5ad0967fc1ed6b014ea35140332bfb9f89f5a2ec1496aeb3e22b97306aa9bec0a024fd4ea3111f3db45d8037e484b88dd54ac26b7f64ae2bc85677044e3f39
+  metadata.gz: 04328df7d7d41d4528fdf46456cce0e6d4707e0ab6398d0210a3ac785a0af96a435530d6a57110144d78692a194316f849600528b19616aa6ad082a33c392040
+  data.tar.gz: 0489c355b5f137c6015d5000fa6185bbcce0bd031c65a31acb10b7f74910536e5cce539b21746944eea9d22e222ab2c16e05a67fb0164fc1b06e60a2d049870c

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,16 @@
+Metrics/LineLength:
+  Max: 100
+Documentation:
+  Enabled: false
+NumericLiterals:
+  Enabled: false
+ClassAndModuleChildren:
+  Enabled: false
+SingleLineBlockParams:
+  Enabled: false
+FrozenStringLiteralComment:
+  Enabled: false
+MutableConstant:
+  Enabled: false
+MultilineMethodCallIndentation:
+  EnforcedStyle: indented

data/README.md

@@ -1,5 +1,7 @@
 ## Payonline
 
+[![Gem Version](https://badge.fury.io/rb/payonline.svg)](http://badge.fury.io/rb/payonline) [![Code Climate](https://codeclimate.com/github/yuri-zubov/payonline/badges/gpa.svg)](https://codeclimate.com/github/yuri-zubov/payonline)
+
 This is a thin wrapper library that makes using PayOnline API a bit easier.
 
 ## Installation
@@ -18,37 +20,40 @@ $ bundle
 
 ## Configuring
 
-Create initialize file. This file is usually located at /config/initializers/payonline.rb
+Create an initializer: `config/initializers/payonline.rb`:
+
 ```ruby
-Payonline.config do |c|
-  c.merchant_id = '12345'
-  c.private_security_key = '3844908d-4c2a-42e1-9be0-91bb5d068d22'
-  c.return_url = 'http://you_domain/payments/success'
-  c.fail_url = 'http://you_domain/payments/failed'
+Payonline.config do |config|
+  config.merchant_id = '12345'
+  config.private_security_key = 'your-private-security-key'
+  config.return_url = 'https://example.com/payments/success'
+  config.fail_url = 'https://example.com/payments/fail'
 end
 ```
 
 ## Usage
 
-Get payment link
+Get payment URL:
 
 ```ruby
-Payonline::PaymentGateway.new(order_id: 56789, amount: 9.99 , currency: 'USD').get_payment_url
+Payonline::PaymentGateway.new(order_id: 1, amount: 2.0, currency: 'RUB').payment_url
 ```
 
-Check Call-back
+Implement a callback action that will be called by PayOnline after a transaction is completed:
+
 ```ruby
- @paymant_response = Payonline::PaymentResponse.new(prms)
- if paymant_response.valid_payment?
-  Order.find(@paymant_response.order_id).pay
- end
+@response = Payonline::PaymentResponse.new(params)
+
+if @response.valid_payment?
+  Order.find(@response.order_id).set_paid!
+end
 ```
 
 ## Contributing
 
 1. Fork it
-2. Clone it `git clone http://github.com/path/to/your/fork`
+2. Clone it `git clone https://github.com/SumatoSoft/payonline`
 3. Create your feature branch `git checkout -b my-new-feature`
-4. Commit your changes `git commit -am 'Add some feature`
+4. Commit your changes `git commit -am 'Add some feature'`
 5. Push to the branch `git push origin my-new-feature`
 6. Create new pull request through Github

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/lib/payonline/payment_gateway.rb

@@ -1,70 +1,44 @@
 module Payonline
   class PaymentGateway
-    class Params < SimpleDelegator
-
-      REQUIED_PARAMS = %w(order_id amount currency valid_until order_description return_url fail_url return_url)
-
-      def initialize(params)
-        @params = prepare_params(params)
-
-        filter_params
-
-        __setobj__ @params
-      end
-
-      def to_query
-        @params.each_with_object({}) do |(k, v), params|
-          params[k.camelize] = v
-        end.to_query
-      end
-
-      private
-
-      def prepare_params(params)
-        params[:amount] = '%.2f' % params[:amount]
-
-        default_params = { return_url: return_url, fail_url: fail_url }
-        params.merge(default_params)
-      end
-
-      def filter_params
-        @params.select! { |k, v| REQUIED_PARAMS.include?(k) && v }
-      end
-
-      def return_url
-        @return_url ||= Payonline.configuration.return_url
-      end
-
-      def fail_url
-        @fail_url ||= Payonline.configuration.fail_url
-      end
-    end
+    BASE_URL = 'https://secure.payonlinesystem.com'
 
     SIGNED_PARAMS = %w(order_id amount currency valid_until order_description)
-
-    def initialize(params={})
-      @params = Params.new(params.with_indifferent_access)
+    PERMITTED_PARAMS = %w(
+      order_id amount currency valid_until order_description return_url fail_url
+    )
+
+    PAYMENT_TYPE_URL = {
+      qiwi: 'select/qiwi/',
+      webmoney: 'select/webmoney/',
+      yandexmoney: 'select/yandexmoney/',
+      masterpass: 'select/masterpass/'
+    }
+
+    def initialize(params = {})
+      @params = prepare_params(params)
     end
 
-    def get_payment_url(type = 'card')
-      params = Payonline::Signature.sign_params(@params, SIGNED_PARAMS)
+    def payment_url(type: :card, language: :ru)
+      params = Payonline::Signature.new(@params, SIGNED_PARAMS).sign
 
-      "#{url_by_kind_of_payment(type)}?#{params.to_query}"
+      "#{BASE_URL}/#{language}/payment/#{PAYMENT_TYPE_URL[type]}?#{params.to_query}"
     end
 
     private
 
-    def url_by_kind_of_payment(type, language = 'ru')
-      case type.to_s
-        when 'qiwi'
-          "https://secure.payonlinesystem.com/#{language}/payment/select/qiwi/"
-        when 'webmoney'
-          "https://secure.payonlinesystem.com/#{language}/payment/select/webmoney/"
-        when 'yandexmoney'
-          "https://secure.payonlinesystem.com/#{language}/payment/select/webmoney/"
-        when 'card'
-          "https://secure.payonlinesystem.com/#{language}/payment/"
-      end
+    def prepare_params(params)
+      params
+        .with_indifferent_access
+        .slice(*PERMITTED_PARAMS)
+        .merge(default_params){ |_, important, _| important }
+        .merge(amount: format('%.2f', params[:amount]))
+    end
+
+    def default_params
+      {
+        return_url: Payonline.configuration.return_url,
+        fail_url: Payonline.configuration.fail_url
+      }
     end
   end
 end

data/lib/payonline/payment_response.rb

@@ -2,31 +2,28 @@ module Payonline
   class PaymentResponse
     extend Forwardable
 
-    attr_accessor :response, :params
+    attr_accessor :data, :params
 
-    RESPONSE_PARAMS = %w(date_time transaction_id order_id amount currency)
+    SIGNED_PARAMS = %i(date_time transaction_id order_id amount currency)
 
-    def_delegators :params, *RESPONSE_PARAMS
+    def_delegators :data, *SIGNED_PARAMS
 
-    def initialize(response = {})
-      self.response = response
-      self.params = OpenStruct.new(normalize_params)
+    def initialize(params = {})
+      @params = prepare_params(params)
+      @data = OpenStruct.new(@params)
     end
 
     def valid_payment?
-      keys = RESPONSE_PARAMS.each_with_object([]).each do |key, array|
-        array << response.keys.select{ |e| e.underscore == key }.first
-      end
-
-      params.security_key == Payonline::Signature.digest(response, keys)
+      keys = SIGNED_PARAMS.select { |key| @params.key?(key) }
+      @params[:security_key] == Payonline::Signature.new(@params, keys, false).digest
     end
 
     private
 
-    def normalize_params
-      result = response.each_with_object({}) do |(k, v), params|
-        params[k.underscore] = v
-      end.with_indifferent_access
+    def prepare_params(params)
+      params
+        .transform_keys { |key| key.to_s.underscore }
+        .with_indifferent_access
     end
   end
 end

data/lib/payonline/rebill_gateway.rb

@@ -0,0 +1,40 @@
+module Payonline
+  class RebillGateway
+    SIGNED_PARAMS = %w(rebill_anchor order_id amount currency)
+    PERMITTED_PARAMS = %w(rebill_anchor order_id amount currency)
+    BASE_URL = 'https://secure.payonlinesystem.com'
+
+    def initialize(params = {})
+      @params = prepare_params(params)
+    end
+
+    # Perform the rebill operation and return the response
+    def rebill
+      response = HTTParty.get(rebill_url)
+      return false unless response.success?
+
+      Payonline::RebillResponse.new(response.body).success?
+    end
+
+    # Return the URL without performing a request
+    def rebill_url
+      params = Payonline::Signature.new(@params, SIGNED_PARAMS).sign
+
+      "#{BASE_URL}/payment/transaction/rebill/?#{params.to_query}"
+    end
+
+    private
+
+    def prepare_params(params)
+      params
+        .with_indifferent_access
+        .slice(*PERMITTED_PARAMS)
+        .merge(default_params)
+        .merge(amount: format('%.2f', params[:amount]))
+    end
+
+    def default_params
+      {}
+    end
+  end
+end

data/lib/payonline/rebill_response.rb

@@ -0,0 +1,26 @@
+module Payonline
+  class RebillResponse
+    SUCCESS_CODE = 'OK'
+
+    def initialize(response)
+      @response = parse_response(response)
+    end
+
+    def success?
+      @response[:result] == SUCCESS_CODE
+    end
+
+    def failure?
+      !success?
+    end
+
+    private
+
+    def parse_response(response)
+      CGI.parse(response)
+        .transform_keys { |key| key.to_s.underscore }
+        .transform_values(&:first)
+        .with_indifferent_access
+    end
+  end
+end

data/lib/payonline/signature.rb

@@ -1,23 +1,48 @@
 module Payonline
   class Signature
-    def self.digest(sign_params, keys=[])
-      if keys.present?
-        sign_params = sign_params.slice(*keys)
-      end
+    def initialize(params, keys, add_merchant_id = true)
+      @keys = keys
+
+      # The order of parameter keys matters
+      @params = prepare_params(params, add_merchant_id)
+
+      # Permitted content_type values: text, xml
+      @params[:security_key] = digest
+      @params[:content_type] = 'text'
+    end
+
+    # A signed copy of params
+    def sign
+      @params.transform_keys { |key| key.to_s.camelize }
+    end
 
-      sign_params.merge!({ private_security_key: Payonline.configuration.private_security_key })
-      Digest::MD5.hexdigest(sign_params.each.map{|k, v| "#{k.to_s.camelize}=#{v}"}.join('&'))
+    def digest
+      Digest::MD5.hexdigest(digest_data)
     end
 
-    def self.sign_params(params, keys=[], add_merchant_id = true)
-      params.reverse_merge!({ 'merchant_id' => Payonline.configuration.merchant_id }) if add_merchant_id
-      if keys.present?
-        keys.unshift 'merchant_id'  if add_merchant_id
+    private
+
+    # Prepend params hash with merchant_id
+    def prepare_params(params, add_merchant_id = true)
+      if add_merchant_id
+        params.reverse_merge!(merchant_id: Payonline.configuration.merchant_id)
+        @keys.unshift(:merchant_id)
       end
-      digest = self.digest(params, keys)
-      params.merge!({ 'security_key' => digest, 'content_type' => 'text' })
 
-      params
+      params.with_indifferent_access
+    end
+
+    # Prepare params for digest
+    def digest_data
+      digest_params = @params.slice(*@keys) if @keys.present?
+      digest_params[:private_security_key] = Payonline.configuration.private_security_key
+
+      # HACK: PayOnline sends OrderId but TransactionID (notice the letter case)
+      digest_params
+        .transform_keys { |key| key.to_s.camelize }
+        .transform_keys { |key| key == 'TransactionId' ? 'TransactionID' : key }
+        .map { |key, value| "#{key}=#{value}" }
+        .join('&')
     end
   end
 end

data/lib/payonline/version.rb

@@ -1,3 +1,3 @@
 module Payonline
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/lib/payonline.rb

@@ -1,12 +1,14 @@
-require 'yaml'
+require 'active_support/all'
+require 'httparty'
+
 require 'payonline/config'
 require 'payonline/payment_gateway'
 require 'payonline/payment_response'
+require 'payonline/rebill_gateway'
+require 'payonline/rebill_response'
 require 'payonline/signature'
 
 module Payonline
-  extend self
-
   def self.configuration
     @configuration ||= Config.new
   end

data/payonline.gemspec

@@ -1,24 +1,25 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'payonline/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "payonline"
+  spec.name          = 'payonline'
   spec.version       = Payonline::VERSION
-  spec.authors       = ["Yuri Zubov"]
-  spec.email         = ["I0Result86@gmail.com"]
+  spec.authors       = ['Yuri Zubov', 'SumatoSoft']
+  spec.email         = ['I0Result86@gmail.com']
 
-  spec.summary       = %q{This is a thin wrapper library that makes using PayOnline API a bit easier.}
-  spec.description   = %q{This is a thin wrapper library that makes using PayOnline API a bit easier.}
-  spec.homepage      = "https://github.com/I0Result/payonline"
-  spec.license       = "MIT"
+  spec.summary       = 'PayOnline API wrapper.'
+  spec.description   = 'This is a thin wrapper library that makes using PayOnline API a bit easier.'
+  spec.homepage      = 'https://github.com/SumatoSoft/payonline'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec)/}) }
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'activesupport', '>= 4.2'
+  spec.add_development_dependency 'rake', '~> 11.2'
 end

metadata

@@ -1,43 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: payonline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Yuri Zubov
+- SumatoSoft
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
 description: This is a thin wrapper library that makes using PayOnline API a bit easier.
 email:
 - I0Result86@gmail.com
@@ -45,7 +46,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -53,10 +56,12 @@ files:
 - lib/payonline/config.rb
 - lib/payonline/payment_gateway.rb
 - lib/payonline/payment_response.rb
+- lib/payonline/rebill_gateway.rb
+- lib/payonline/rebill_response.rb
 - lib/payonline/signature.rb
 - lib/payonline/version.rb
 - payonline.gemspec
-homepage: https://github.com/I0Result/payonline
+homepage: https://github.com/SumatoSoft/payonline
 licenses:
 - MIT
 metadata: {}
@@ -66,18 +71,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: This is a thin wrapper library that makes using PayOnline API a bit easier.
+summary: PayOnline API wrapper.
 test_files: []