alfabank 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 240f816190cd982f668b2f7f819600e4521cbd5f3cbed3f2cbbaf5be53af13e9
-  data.tar.gz: ab180f05add97f32ec4e95509cd292c91ff672c389d0c2ffefb413b98e302b61
+  metadata.gz: f6ad3336a0939c00753f584fe9fa8102b477c96ef62e15944ed337e19f22517b
+  data.tar.gz: 64da11be6351507a206273486f876d8add0cad3f94baa4cad8103730748ec6e4
 SHA512:
-  metadata.gz: fbd34cc48a3e60914801d71e3e4e49402da7376d0238e94ebf6e927a484183ddab1341d7094a5899012661d4befd8ed661f3b084722f1abcae3c6c8d8fbae731
-  data.tar.gz: fa5f6349905f7b9c42f4204e6c12ac5619f7be6f4a541afa22aa8465833fc8654db58146175d293ddd90be09cc9dd9ad261ebdb6dae3b3fc7ffd6cc4b01ee02a
+  metadata.gz: 17a8e97513a81a810b82f92cdcf0a285d1267af2a50e2eeec4d7dfb7f789a54049d56b68be77caa152b5f08ed32e9465dc63213eb9ca13c66e716009cabddc5a
+  data.tar.gz: d46572d06bc579a2a8bf1c84c4b14846d769add0a0be0439b5aa2b250cfa618cec594c8873b9c0971401f46b4bb3fef92608ccb66b3abdbb9b5c4ffcbc2acbb1

data/.gitignore

@@ -1,9 +1,13 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock
+
+# macOS
+.DS_Store

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 2.2.9
-  - 2.3.6
-  - 2.4.3
-  - 2.5.0
-before_install: gem install bundler -v 1.11.2
+  - 2.5.5
+  - 2.6.3
+before_install: gem install bundler

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Timur Yanberdin
+Copyright (c) 2019 Timur Yanberdin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,5 @@
 # Alfabank
+
 [![Build Status](https://travis-ci.org/mendab1e/alfabank.svg?branch=master)](https://travis-ci.org/mendab1e/alfabank) [![Gem Version](https://badge.fury.io/rb/alfabank.svg)](https://badge.fury.io/rb/alfabank)
 
 This gem provides support for the API of [Alfabank acquiring gateway](https://engine.paymentgate.ru/ecommerce/).
@@ -21,35 +22,27 @@ Or install it yourself as:
 
 ## Usage
 
-Generate initializer,  model and migration:
-
-    $ rails g alfabank Payment
-
-Run migration
-
-    $ rake db:migrate
-
-Set credentials and other options in  `config/initializers/alfabank.rb`
-
-* Use `#register` to register a new order and obtain a payment form url.
+Configure the gem with the credentials provided by the bank. If you are using Ruby on Rails, you should do that in an initializer.
 
-* Use `#check_status` to get information about an order.
-
-Create a method to handle status request in your controller and insert a url for this method as a `return_url` param in `config/initializers/alfabank.rb`. Use `#check_status[:order_status]` to determine the status of an order and display it.
+```ruby
+# config/initializers/alfabank.rb
+Alfabank.configure do |config|
+  config.userName = Rails.application.credentials.dig(:alfabank, :userName)
+  config.password = Rails.application.credentials.dig(:alfabank, :password)
+  config.environment = Rails.application.credentials.dig(:alfabank, :environment) # 'production' or 'test'
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mendab1e/alfabank.
 
-
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require 'bundler/gem_tasks'

data/alfabank.gemspec

@@ -1,28 +1,26 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'alfabank/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "alfabank"
-  spec.version       = Alfabank::VERSION
-  spec.authors       = ["Timur Yanberdin"]
-  spec.email         = ["yanberdint@gmail.com"]
+  spec.name = 'alfabank'
+  spec.version = Alfabank::VERSION
+  spec.authors = ['Timur Yanberdin', 'Dan Kim']
+  spec.email = ['yanberdint@gmail.com']
 
-  spec.summary       = "Unofficial alfabank payment gateway gem"
-  spec.homepage      = "https://github.com/mendab1e/alfabank"
-  spec.license       = "MIT"
+  spec.summary = 'Unofficial alfabank payment gateway gem'
+  spec.homepage = 'https://github.com/mendab1e/alfabank'
+  spec.license = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 1.22"
-  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'vcr', '~> 4.0'
 
-  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency 'activesupport', '>= 5'
+  spec.add_dependency 'httparty', '~> 0.16'
 end

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "alfabank"
+require 'bundler/setup'
+require 'alfabank'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
+# require 'pry'
 # Pry.start
 
-require "irb"
-IRB.start
+require 'irb'
+IRB.start(__FILE__)

data/lib/alfabank.rb

@@ -1,26 +1,9 @@
-require "alfabank/version"
-require "alfabank/currency"
-require "alfabank/api"
-require "alfabank/configuration"
+require 'active_support'
 
-module Alfabank
-  def register(use_binding: false)
-    Api::Registration.new(self).process(use_binding: use_binding)
-  end
-
-  def check_status(use_binding: false)
-    Api::Status.new(self).process(use_binding: use_binding)
-  end
-
-  def payment_order_binding(binding_id)
-    Api::PaymentOrderBinding.new(self).process(binding_id)
-  end
+require 'alfabank/client'
+require 'alfabank/request'
+require 'alfabank/response'
 
-  class << self
-    attr_accessor :logger
-
-    def setup(&block)
-      yield Configuration
-    end
-  end
+module Alfabank
+  include ActiveSupport::Configurable
 end

data/lib/alfabank/client.rb

@@ -0,0 +1,31 @@
+module Alfabank
+  class Client
+    # https://web.rbsuat.com/ab/swagger/swagger.html#/register/registerOrderUsingPOST_7
+    def self.register(order_number:, amount:, return_url:, options: {})
+      params = options.merge(
+        orderNumber: order_number,
+        amount: amount,
+        returnUrl: return_url
+      )
+      Alfabank::Request.new('register.do', params).perform
+    end
+
+    # https://web.rbsuat.com/ab/swagger/swagger.html#/status/getOrderStatusExtendedUsingPOST_1
+    def self.status(order_id: nil, order_number: nil)
+      raise ArgumentError if order_id.nil? && order_number.nil?
+
+      params = { orderId: order_id, orderNumber: order_number }.compact
+      Alfabank::Request.new('getOrderStatusExtended.do', params).perform
+    end
+
+    # https://pay.alfabank.ru/ecommerce/instructions/merchantManual/pages/index/rest.html#zapros_provedenija_platezha_po_svjazke_rest_
+    def self.payment_order_binding(md_order:, binding_id:, ip:, options: {})
+      params = options.merge(
+        mdOrder: md_order,
+        binding_id: bindingId,
+        ip: ip
+      )
+      Alfabank::Request.new('paymentOrderBinding.do', params).perform
+    end
+  end
+end

data/lib/alfabank/request.rb

@@ -0,0 +1,38 @@
+require 'httparty'
+
+module Alfabank
+  class Request
+    BASE_URL = 'https://engine.paymentgate.ru/payment/rest/'
+    TEST_BASE_URL = 'https://web.rbsuat.com/ab/rest/'
+
+    def initialize(method, params)
+      @method = method
+      @params = default_params.merge(params)
+    end
+
+    def perform
+      request = HTTParty.post(url, query: @params, format: :json)
+      request.parsed_response
+    end
+
+    private
+
+    def default_params
+      {
+        currency: Alfabank.config.currency,
+        language: Alfabank.config.language,
+        password: Alfabank.config.password,
+        returnUrl: Alfabank.config.return_url,
+        userName: Alfabank.config.userName
+      }.compact
+    end
+
+    def url
+      if Alfabank.config.environment.to_s == 'production'
+        BASE_URL + @method
+      else
+        TEST_BASE_URL + @method
+      end
+    end
+  end
+end

data/lib/alfabank/response.rb

@@ -0,0 +1,15 @@
+module Alfabank
+  class Response
+    ORDER_STATUS_APPROVED = 2
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def approved?
+      @data['orderStatus'] == ORDER_STATUS_APPROVED
+    end
+  end
+end

data/lib/alfabank/version.rb

@@ -1,3 +1,3 @@
 module Alfabank
-  VERSION = "0.2.0"
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: alfabank
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Timur Yanberdin
+- Dan Kim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,84 +17,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.16'
 description: 
 email:
 - yanberdint@gmail.com
@@ -102,7 +89,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -112,19 +98,10 @@ files:
 - bin/console
 - bin/setup
 - lib/alfabank.rb
-- lib/alfabank/api.rb
-- lib/alfabank/api/base.rb
-- lib/alfabank/api/payment_order_binding.rb
-- lib/alfabank/api/registration.rb
-- lib/alfabank/api/status.rb
-- lib/alfabank/configuration.rb
-- lib/alfabank/currency.rb
+- lib/alfabank/client.rb
+- lib/alfabank/request.rb
+- lib/alfabank/response.rb
 - lib/alfabank/version.rb
-- lib/generators/alfabank/USAGE
-- lib/generators/alfabank/alfabank_generator.rb
-- lib/generators/alfabank/templates/config/initializers/alfabank.rb
-- lib/generators/alfabank/templates/create_table_migration.rb
-- lib/generators/alfabank/templates/model.rb
 homepage: https://github.com/mendab1e/alfabank
 licenses:
 - MIT
@@ -144,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Unofficial alfabank payment gateway gem

data/.rspec

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

data/lib/alfabank/api.rb

@@ -1,4 +0,0 @@
-require "alfabank/api/base"
-require "alfabank/api/registration"
-require "alfabank/api/status"
-require "alfabank/api/payment_order_binding"

data/lib/alfabank/api/base.rb

@@ -1,33 +0,0 @@
-require 'httparty'
-
-module Alfabank::Api
-  class Base
-    attr_reader :payment, :use_binding
-
-    def initialize(payment)
-      @payment = payment
-    end
-
-    private
-
-    def make_request
-      HTTParty.post(url, body: generate_params, format: :json)
-    end
-
-    def generate_params
-      fail NotImplementedError, "this method should be overridden"
-    end
-
-    def url
-      Alfabank::Configuration.mode == :production ? self.class::URL : self.class::TEST_URL
-    end
-
-    def credentials
-      if use_binding
-        Alfabank::Configuration.binding_credentials
-      else
-        Alfabank::Configuration.common_credentials
-      end
-    end
-  end
-end

data/lib/alfabank/api/payment_order_binding.rb

@@ -1,29 +0,0 @@
-module Alfabank::Api
-  class PaymentOrderBinding < Base
-    TEST_URL = 'https://web.rbsuat.com/ab/rest/paymentOrderBinding.do'
-    URL = "https://engine.paymentgate.ru/payment/rest/paymentOrderBinding.do"
-
-    def process(binding_id)
-      fail 'alfa_order_id is nil' if payment.alfa_order_id.nil?
-      @binding_id = binding_id
-
-      process_response(make_request.parsed_response)
-    end
-
-    private
-
-    def process_response(response)
-      response
-    end
-
-    def generate_params
-      params = {
-        userName: Alfabank::Configuration.binding_username,
-        password: Alfabank::Configuration.binding_password,
-        bindingId: @binding_id,
-        mdOrder: payment.alfa_order_id
-      }
-      params.map { |k, v| "#{k}=#{v}" }.join('&')
-    end
-  end
-end

data/lib/alfabank/api/registration.rb

@@ -1,50 +0,0 @@
-module Alfabank::Api
-  class Registration < Base
-    TEST_URL = 'https://web.rbsuat.com/ab/rest/register.do'
-    URL = "https://engine.paymentgate.ru/payment/rest/register.do"
-
-    def process(use_binding: false)
-      return {url: payment.alfa_form_url} if payment.alfa_order_id
-      @use_binding = use_binding
-
-      process_response(make_request.parsed_response)
-    end
-
-    private
-
-    def process_response(response)
-      if response.has_key?("orderId")
-        set_data_from_response(response)
-        {url: payment.alfa_form_url}
-      else
-        {error: response['errorMessage']}
-      end
-    end
-
-    def generate_params
-      params = credentials.merge(
-        description: payment.description,
-        language: Alfabank::Configuration.language,
-        orderNumber: order_number,
-        amount: payment.price * 100,
-        currency: Alfabank::Configuration.currency,
-        clientId: payment.user_id,
-        returnUrl: Alfabank::Configuration.return_url
-      )
-
-      params.map { |k, v| "#{k}=#{v}" }.join('&')
-    end
-
-    def set_data_from_response(response)
-      payment.update_attributes(
-        alfa_order_id: response["orderId"],
-        alfa_form_url: response["formUrl"]
-      )
-    end
-
-    def order_number
-      number = payment.to_order_number rescue payment.id
-      "#{Alfabank::Configuration.order_number_prefix}#{number}"
-    end
-  end
-end

data/lib/alfabank/api/status.rb

@@ -1,41 +0,0 @@
-module Alfabank::Api
-  class Status < Base
-    TEST_URL = 'https://web.rbsuat.com/ab/rest/getOrderStatus.do'
-    URL = "https://engine.paymentgate.ru/payment/rest/getOrderStatus.do"
-    PAID = 2
-
-    def process(use_binding: false)
-      @use_binding = use_binding
-
-      response = make_request.parsed_response
-      process_response(response)
-
-      {
-        order_status: response["OrderStatus"].to_i,
-        binding_id: response["bindingId"],
-        card_number: response["Pan"],
-        error_code: response["ErrorCode"].to_i,
-        error_message: response["ErrorMessage"]
-      }
-    end
-
-    private
-
-    def process_response(response)
-      return unless response["OrderStatus"].to_i == PAID
-
-      payment.paid = true
-      payment.card_number = response["Pan"] if payment.respond_to?(:card_number)
-      if payment.respond_to?(:binding_id)
-        payment.binding_id = response["bindingId"]
-      end
-      payment.save(validate: false)
-    end
-
-    def generate_params
-      credentials.merge(orderId: payment.alfa_order_id).map do |k, v|
-        "#{k}=#{v}"
-      end.join('&')
-    end
-  end
-end

data/lib/alfabank/configuration.rb

@@ -1,23 +0,0 @@
-module Alfabank
-  class Configuration
-    class << self
-      attr_accessor :username, :password, :language, :return_url
-      attr_accessor :currency, :order_number_prefix, :mode
-      attr_accessor :binding_username, :binding_password
-
-      def binding_credentials
-        {
-          userName: binding_username,
-          password: binding_password
-        }
-      end
-
-      def common_credentials
-        {
-          userName: username,
-          password: password
-        }
-      end
-    end
-  end
-end

data/lib/alfabank/currency.rb

@@ -1,5 +0,0 @@
-module Alfabank::Currency
-  RUB = 810
-  USD = 840
-  EUR = 978
-end

data/lib/generators/alfabank/USAGE

@@ -1,10 +0,0 @@
-Description:
-    Install alfabank to your app
-
-Example:
-    rails generate alfabank Payment
-
-    This will create:
-        config/initializers/alfabank.rb
-        db/migrate/create_payments.rb
-        app/models/payment.rb

data/lib/generators/alfabank/alfabank_generator.rb

@@ -1,22 +0,0 @@
-require 'rails/generators/active_record'
-
-class AlfabankGenerator < Rails::Generators::NamedBase
-  include Rails::Generators::Migration
-  source_root File.expand_path('../templates', __FILE__)
-
-  def generate_initializer
-    template "config/initializers/alfabank.rb"
-  end
-
-  def generate_migration
-    migration_template("create_table_migration.rb", "db/migrate/create_#{table_name}.rb")
-  end
-
-  def generate_model
-    template "model.rb", "app/models/#{file_name}.rb"
-  end
-
-  def self.next_migration_number(dirname)
-    ActiveRecord::Generators::Base.next_migration_number(dirname)
-  end
-end

data/lib/generators/alfabank/templates/config/initializers/alfabank.rb

@@ -1,13 +0,0 @@
-Alfabank.setup do |config|
-  config.username = 'username'
-  config.password = 'password'
-  config.language = 'ru'
-  config.return_url = 'finish.html'
-  config.currency = Alfabank::Currency::RUB
-  config.order_number_prefix = 'payment-'
-  config.binding_username = 'binding_username'
-  config.binding_password = 'binding_password'
-  config.mode = :test # :production
-end
-
-Alfabank.logger = Rails.logger

data/lib/generators/alfabank/templates/create_table_migration.rb

@@ -1,17 +0,0 @@
-class Create<%= table_name.camelize %> < ActiveRecord::Migration
-  def change
-    create_table :<%= table_name %> do |t|
-      t.integer :price, null: false
-      t.string :alfa_order_id
-      t.string :alfa_form_url
-      t.boolean :paid
-      t.string :description
-      t.integer :user_id
-
-      t.timestamps null: false
-    end
-
-    add_index :<%= table_name %>, :alfa_order_id
-    add_index :<%= table_name %>, :user_id
-  end
-end

data/lib/generators/alfabank/templates/model.rb

@@ -1,5 +0,0 @@
-class <%= class_name %> < ActiveRecord::Base
-  include Alfabank
-
-  validates_numericality_of :price, greater_than: 0
-end