sbrf_merchant 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a6f8d675873a5f9a0efdf2ab640a379306cb8fe
-  data.tar.gz: 6ded6355ba85cebfa88ddba68ef5eb80b454048c
+  metadata.gz: e0a432c1d76b9afe5994042bd2f89f68e38bfc2b
+  data.tar.gz: 3ca43386c3ebf92e68767b471d8a8288a1bcb0ed
 SHA512:
-  metadata.gz: 7a3e2c10f273bdadcb4b340f46d459796d8291b3bee82c9c75102623e47afe33d477d872f218e4b996b8adebb9dd17733ccae02c6c359b8c207a6c456dec5a8f
-  data.tar.gz: bc6a30710db9aa2f0220eddfd23ed35bd876f4dd069a9455221d4362b5c1aab4dc02d4deced54a8b3d94d9da442f60e70dfacc9b5f3d8cb345419776d41be992
+  metadata.gz: 154e51703e5758d3917478a853143bdf42e5308856cd7a4bc4b2b7391067b537b390116496d798af41064c642717966abbfda3ab813b0d2074df24e0062a879e
+  data.tar.gz: ce34420640e00c27428b4f84e1e171d8ae392caffb38f1a3cdd74bf9f98347abe9ac6ee7104a10f841817c094e3a07f7996064bd04bdd2b658bc78b919ddad9a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# Changelog 1.0.0
+- Replace Order::OneStage class with Order class
+- Add methods for working with two stage orders
+# Changelog 0.2.0
+- Replace external gems with Ruby standard library features
 # Changelog 0.1.3
 - Fix unexpected behaviour in Response::Base#success?
 

data/README.md

@@ -5,23 +5,31 @@
 [![Code Climate](https://codeclimate.com/github/abstractart/sbrf_merchant/badges/gpa.svg
 )](https://codeclimate.com/github/abstractart/sbrf_merchant)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/db86deaba446bac68ae1/test_coverage)](https://codeclimate.com/github/abstractart/sbrf_merchant/test_coverage)
-## Installation
 
-### Manually from RubyGems.org ###
+Ruby клиент для работы с платёжным шлюзом Сбербанка.
+
+Ключевые особенности:
+- Простой (~200 LOC).
+- Лёгкий (всего одна зависимость - JSON gem).
+- Написан в ОО стиле без "магии". Подходит для написания unit тестов.
+
+## Установка
+
+### RubyGems.org ###
 
 ```sh
 % gem install sbrf_merchant
 ```
 
-### Or if you are using Bundler ###
+### Bundler ###
 
 ```ruby
 # Gemfile
 gem 'sbrf_merchant'
 ```
 
-## Configuration
-
+## Конфигурация
+Перед использованием необходимо проинициализировать библиотеку
 ```ruby
 SbrfMerchant.configure do |config|
   config.userName = '<Merchant Username>'
@@ -29,48 +37,63 @@ SbrfMerchant.configure do |config|
   config.host =     '<Sberbank API Host>'
 end
 ```
-## API Documentation
-[RU](https://securepayments.sberbank.ru/wiki/doku.php/integration:api:start)
-
-# Usage Examples
+## Документация
+- [Site(RU)](https://securepayments.sberbank.ru/wiki/doku.php/integration:api:start)
+- [PDF(RU)](http://cs.petrsu.ru/~vadim/sd2018/Merchant-Manual-SBRF.pdf)
+## Использование
+### Терминология
 
-**orderId** - order identificator in Sberbank Payment Gateway
+- **orderId** - ID заказа в Сбербанке
+- **orderNumber** - ID заказа в Вашей системе
 
-**orderNumber** - order identificator in your system
-
-## OneStage Order
-### Register
+### Инициализация объекта заказа
+Если необходимо зарегистрировать новый заказ
+```ruby
+SbrfMerchant::Order.new(orderNumber: orderNumber)
+```
+Если необходимо поработать с уже существующим
+```ruby
+SbrfMerchant::Order.new(orderNumber: orderNumber, orderId: orderId)
+```
+### Аргументы вызываемых методов
+- передаются через keywords
+- имена аргументов такие же как и в документации
+### Ответы API
+Ответы API возвращаются как объекты. Доступ через reader(getter) методы. Также в классах есть методы упрощающие работу с телом ответа (проверка успешности запроса, определение статуса заказа)
+### Примеры работы
+#### Регистрация заказа
 ```ruby
 require 'securerandom'
-order = SbrfMerchant::Order::OneStage.new(orderNumber: SecureRandom.hex)
-response = order.register(amount: 10000, returnUrl: 'http:/localhost:3000')
+order = SbrfMerchant::Order.new(orderNumber: SecureRandom.hex)
+response = order.register_one_stage(amount: 10000, returnUrl: 'http:/localhost:3000')
 
-order.orderId # returns unique Id in Sberbank system
+order.orderId # "<orderId>"
 response.success? # true
 response.formUrl # "https://3dsec.sberbank.ru/payment/merchants/sbersafe/payment_ru.html?mdOrder=<orderId>"
 ```
-### Status
+Для создания двустадийного заказа используте метод ```register_two_stage```
+#### Статус заказа
 ```ruby
-order = SbrfMerchant::Order::OneStage.new(orderNumber: orderNumber, orderId: orderId)
 response = order.get_info
 response.not_paid? # true or false
 ```
-### Refund
+#### Возврат средств
 ```ruby
-
 refund_amount = 1000
-order = SbrfMerchant::Order::OneStage.new(orderNumber: orderNumber, orderId: orderId)
 response = order.refund(refund_amount)
 response.success? # true or false
 ```
-### Cancel
+#### Отмена заказа
 ```ruby
-
-order = SbrfMerchant::Order::OneStage.new(orderNumber: orderNumber, orderId: orderId)
 response = order.cancel
 response.success? # true or false
-  ```
-
+```
+#### Завершение заказа (двухстадийная оплата)
+```ruby
+complete_amount = 1000
+response = order.complete(complete_amount)
+response.success? # true or false
+```
 ## Copyright
 Copyright (c) 2018 Eugene Kozlov. See [LICENSE][] for details.
 

data/lib/sbrf_merchant/api/action.rb

@@ -2,12 +2,12 @@ module SbrfMerchant
   module Api
     module Action
       REST = '/payment/rest/'.freeze
-      module OneStage
-        REFUND_ORDER = "#{REST}refund.do".freeze
-        REGISTER_ORDER = "#{REST}register.do".freeze
-        ORDER_STATUS = "#{REST}getOrderStatusExtended.do".freeze
-        CANCEL_ORDER = "#{REST}reverse.do".freeze
-      end
+      REFUND_ORDER = "#{REST}refund.do".freeze
+      REGISTER_ORDER = "#{REST}register.do".freeze
+      ORDER_STATUS = "#{REST}getOrderStatusExtended.do".freeze
+      CANCEL_ORDER = "#{REST}reverse.do".freeze
+      REGISTER_PRE_AUTH = "#{REST}registerPreAuth.do".freeze
+      COMPLETE_ORDER = "#{REST}deposit.do".freeze
     end
   end
 end

data/lib/sbrf_merchant/order.rb

@@ -0,0 +1,84 @@
+require 'sbrf_merchant/api/client'
+require 'sbrf_merchant/api/action'
+require 'sbrf_merchant/response/base'
+require 'sbrf_merchant/response/create_order'
+require 'sbrf_merchant/response/order_status'
+
+module SbrfMerchant
+  class Order
+    attr_reader :api_client, :orderId, :orderNumber
+
+    def initialize(orderId: nil, orderNumber: nil, api_client: SbrfMerchant.api_client)
+      @orderId = orderId
+      @orderNumber = orderNumber
+      @api_client = api_client
+    end
+
+    def register_one_stage(**args)
+      register(SbrfMerchant::Api::Action::REGISTER_ORDER, args)
+    end
+
+    def register_two_stage(**args)
+      register(SbrfMerchant::Api::Action::REGISTER_PRE_AUTH, args)
+    end
+
+    def get_info
+      Response::OrderStatus.new(
+        api_client.process_request(
+          SbrfMerchant::Api::Action::ORDER_STATUS,
+          default_request_params
+        )
+      )
+    end
+
+    def cancel
+      Response::Base.new(
+        api_client.process_request(
+          SbrfMerchant::Api::Action::CANCEL_ORDER,
+          default_request_params
+        )
+      )
+    end
+
+    def refund(amount)
+      Response::Base.new(
+        api_client.process_request(
+          SbrfMerchant::Api::Action::REFUND_ORDER,
+          default_request_params.merge(amount: amount)
+        )
+      )
+    end
+
+    def complete(amount)
+      Response::Base.new(
+        api_client.process_request(
+          SbrfMerchant::Api::Action::COMPLETE_ORDER,
+          default_request_params.merge(amount: amount)
+        )
+      )
+    end
+
+    private
+
+    def default_request_params
+      params = {}
+
+      params[:orderId] = orderId if orderId
+      params[:orderNumber] = orderNumber if orderNumber
+
+      params
+    end
+
+    def register(path, args)
+      response = Response::CreateOrder.new(
+        api_client.process_request(
+          path,
+          args.merge(default_request_params)
+        )
+      )
+      @orderId = response.orderId
+
+      response
+    end
+  end
+end

data/lib/sbrf_merchant/response/order_status.rb

@@ -1,6 +1,5 @@
 require 'sbrf_merchant/api/order_status'
 
-
 module SbrfMerchant
   module Response
     class OrderStatus < Response::Base

data/lib/sbrf_merchant/version.rb

@@ -1,3 +1,3 @@
 module SbrfMerchant
-  VERSION = '0.2.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/sbrf_merchant.rb

@@ -1,4 +1,4 @@
-require 'sbrf_merchant/order/one_stage'
+require 'sbrf_merchant/order'
 
 module SbrfMerchant
   class << self

data/sbrf_merchant.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Sberbank Merchant API Client for Ruby'
   spec.homepage      = 'https://github.com/abstractart/sbrf_merchant'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.1.0'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sbrf_merchant
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Eugene Kozlov
@@ -132,7 +132,7 @@ files:
 - lib/sbrf_merchant/api/client.rb
 - lib/sbrf_merchant/api/error_code.rb
 - lib/sbrf_merchant/api/order_status.rb
-- lib/sbrf_merchant/order/one_stage.rb
+- lib/sbrf_merchant/order.rb
 - lib/sbrf_merchant/response/base.rb
 - lib/sbrf_merchant/response/create_order.rb
 - lib/sbrf_merchant/response/order_status.rb
@@ -150,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/sbrf_merchant/order/one_stage.rb

@@ -1,69 +0,0 @@
-require 'sbrf_merchant/api/client'
-require 'sbrf_merchant/api/action'
-require 'sbrf_merchant/response/base'
-require 'sbrf_merchant/response/create_order'
-require 'sbrf_merchant/response/order_status'
-
-module SbrfMerchant
-  module Order
-    class OneStage
-      attr_reader :api_client, :orderId, :orderNumber
-
-      def initialize(orderId: nil, orderNumber: nil, api_client: SbrfMerchant.api_client)
-        @orderId = orderId
-        @orderNumber = orderNumber
-        @api_client = api_client
-      end
-
-      def register(**args)
-        response = Response::CreateOrder.new(
-          api_client.process_request(
-            SbrfMerchant::Api::Action::OneStage::REGISTER_ORDER,
-            args.merge(default_request_params)
-          )
-        )
-        @orderId = response.orderId
-
-        response
-      end
-
-      def get_info
-        Response::OrderStatus.new(
-          api_client.process_request(
-            SbrfMerchant::Api::Action::OneStage::ORDER_STATUS,
-            default_request_params
-          )
-        )
-      end
-
-      def cancel
-        Response::Base.new(
-          api_client.process_request(
-            SbrfMerchant::Api::Action::OneStage::CANCEL_ORDER,
-            default_request_params
-          )
-        )
-      end
-
-      def refund(amount)
-        Response::Base.new(
-          api_client.process_request(
-            SbrfMerchant::Api::Action::OneStage::REFUND_ORDER,
-            default_request_params.merge(amount: amount)
-          )
-        )
-      end
-
-      private
-
-      def default_request_params
-        params = {}
-
-        params[:orderId] = orderId if orderId
-        params[:orderNumber] = orderNumber if orderNumber
-
-        params
-      end
-    end
-  end
-end