sbrf_merchant 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c7b0abcb8bb7d3a491a2cdabb2c991a6bb2d082
+  data.tar.gz: 9b8475c67e089e38d5b382e964fe698f78ffc3a9
+SHA512:
+  metadata.gz: bde079a916f893446f0f08627155082455b56ac6782519c85fe1ca39b6ef778f5ac67a9cdb242aa0ff6cc61c76795d7d14eef5cddcfe39d33a37e6abb3dbbc31
+  data.tar.gz: 0f00b3553e6aad115ffc14042ca747219ebe0c5d779eb90b53f9ff49fb8ad5e9067f43d6416b68dff46ca7c95ec30826e140d2094bdfb94a7d7877c702fa82c8

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{sh,markdown}]
+indent_size = 4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+  - 2.2.10
+before_install: gem install bundler -v 1.16.5

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Changelog 0.1.1
+- Add support of OneStage Order (register, cancel, refund, status)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kozlovea8@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sberbank_merchant_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Eugene Kozlov
+
+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,75 @@
+# Sberbank Merchant [![Build Status](https://travis-ci.org/abstractart/sbrf_merchant.svg?branch=master)](https://travis-ci.org/abstractart/sbrf_merchant) [![Gem Version](https://badge.fury.io/rb/sbrf_merchant.svg)](https://badge.fury.io/rb/sbrf_merchant)
+Ruby wrapper for the Sberbank Merchant API. [Documentation (RU)](https://securepayments.sberbank.ru/wiki/doku.php/integration:api:start)
+## Installation
+
+### Manually from RubyGems.org ###
+
+```sh
+% gem install sbrf_merchant
+```
+
+### Or if you are using Bundler ###
+
+```ruby
+# Gemfile
+gem 'sbrf_merchant'
+```
+
+## Configuration
+
+```ruby
+SbrfMerchant.configure do |config|
+  config.userName = '<Merchant Username>'
+  config.password = '<Merchant Password>'
+  config.host =     '<Sberbank API Host>'
+end
+```
+
+# Usage Examples
+```ruby
+# First of all you need create order object
+new_order = SbrfMerchant::Order::OneStage.new(orderNumber: orderNumber)
+already_created_order = SbrfMerchant::Order::OneStage.new(orderNumber: orderNumber, orderId: orderId)
+```
+## Register Order
+```ruby
+require 'securerandom'
+order = SbrfMerchant::Order::OneStage.new(orderNumber: SecureRandom.hex)
+response = order.register(amount: 10000, returnUrl: 'http:/localhost:3000')
+
+order.orderId # returns unique Id in Sberbank system
+response.success? # true
+response.formUrl # "https://3dsec.sberbank.ru/payment/merchants/sbersafe/payment_ru.html?mdOrder=<orderId>"
+```
+## Order Status
+```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
+  ```
+## Supported Ruby Versions (Travis CI)
+
+- 2.5.1
+- 2.4.4
+- 2.3.7
+- 2.2.10
+
+## Copyright
+Copyright (c) 2018 Eugene Kozlov. See [LICENSE][] for details.
+
+[license]: LICENSE.md

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'sbrf_merchant'
+
+# 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"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sbrf_merchant.rb

@@ -0,0 +1,16 @@
+require 'sbrf_merchant/order/one_stage'
+
+module SbrfMerchant
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :host, :userName, :password
+  end
+end

data/lib/sbrf_merchant/api/action.rb

@@ -0,0 +1,13 @@
+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
+    end
+  end
+end

data/lib/sbrf_merchant/api/client.rb

@@ -0,0 +1,33 @@
+require 'faraday'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'json'
+
+module SbrfMerchant
+  module Api
+    class Client
+      attr_accessor :host, :userName, :password
+
+      def initialize(host:, userName:, password:)
+        @host = host
+        @userName = userName
+        @password = password
+      end
+
+      def process_request(path, params)
+        JSON.parse(http_client.post(path, params).body).with_indifferent_access
+      end
+
+      private
+
+      def http_client
+        @client ||= Faraday.new(
+          url: host,
+          params: {
+            userName: userName,
+            password: password
+          }
+        )
+      end
+    end
+  end
+end

data/lib/sbrf_merchant/api/error_code.rb

@@ -0,0 +1,7 @@
+module SbrfMerchant
+  module Api
+    module ErrorCode
+      SUCCESS = 0
+    end
+  end
+end

data/lib/sbrf_merchant/api/order_status.rb

@@ -0,0 +1,13 @@
+module SbrfMerchant
+  module Api
+    module OrderStatus
+      NOT_PAID = 0
+      PREAUTHORIZED_AMOUNT_HOLD = 1
+      COMPLETED = 2
+      CANCEL = 3
+      REFUND = 4
+      AUTH_ON_BANK_ISSUER_SIDE = 5
+      REJECTED = 6
+    end
+  end
+end

data/lib/sbrf_merchant/config/container.rb

@@ -0,0 +1,17 @@
+require 'dry-container'
+
+module SbrfMerchant
+  module Config
+    class Container
+      extend Dry::Container::Mixin
+
+      register 'api_client' do
+        SbrfMerchant::Api::Client.new(
+          host: SbrfMerchant.configuration.host,
+          userName: SbrfMerchant.configuration.userName,
+          password: SbrfMerchant.configuration.password
+        )
+      end
+    end
+  end
+end

data/lib/sbrf_merchant/order/one_stage.rb

@@ -0,0 +1,79 @@
+require 'sbrf_merchant/api/client'
+require 'sbrf_merchant/api/action'
+require 'sbrf_merchant/config/container'
+require 'dry-auto_inject'
+require 'sbrf_merchant/response/base'
+require 'sbrf_merchant/response/create_order'
+require 'sbrf_merchant/response/order_status'
+
+module SbrfMerchant
+  module Order
+    class OneStage
+      include Dry::AutoInject(Config::Container).hash['api_client']
+
+      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 initialize(orderId: nil, orderNumber: nil, api_client:)
+        @orderId = orderId
+        @orderNumber = orderNumber
+        @api_client = api_client
+      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
+
+      def orderId
+        @orderId.freeze
+      end
+
+      def orderNumber
+        @orderNumber.freeze
+      end
+
+      private
+
+      def default_request_params
+        params = {}
+
+        params[:orderId] = orderId if orderId
+        params[:orderNumber] = orderNumber if orderNumber
+
+        params
+      end
+    end
+  end
+end

data/lib/sbrf_merchant/response/base.rb

@@ -0,0 +1,17 @@
+require 'sbrf_merchant/api/error_code'
+module SbrfMerchant
+  module Response
+    class Base
+      attr_reader :errorCode, :errorMessage
+
+      def initialize(args = {})
+        @errorCode = args[:errorCode]
+        @errorMessage = args[:errorMessage]
+      end
+
+      def success?
+        errorCode == SbrfMerchant::Api::ErrorCode::SUCCESS
+      end
+    end
+  end
+end

data/lib/sbrf_merchant/response/create_order.rb

@@ -0,0 +1,17 @@
+module SbrfMerchant
+  module Response
+    class CreateOrder < Response::Base
+      attr_reader :formUrl, :orderId
+
+      def initialize(args = {})
+        super(args)
+        @formUrl = args[:formUrl]
+        @orderId = args[:orderId]
+      end
+
+      def success?
+        !formUrl.nil? && !orderId.nil?
+      end
+    end
+  end
+end

data/lib/sbrf_merchant/response/order_status.rb

@@ -0,0 +1,68 @@
+module SbrfMerchant
+  module Response
+    class OrderStatus < Response::Base
+      AVAILABLE_FIELDS = %i[
+        orderNumber
+        orderStatus
+        actionCode
+        actionCodeDescription
+        amount
+        currency
+        date
+        ip
+        merchantOrderParams
+        attributes
+        cardAuthInfo
+        authDateTime
+        terminalId
+        authRefnum
+        paymentAmountInfo
+        bankInfo
+      ].freeze
+
+      attr_reader(*AVAILABLE_FIELDS)
+
+      def initialize(args = {})
+        super(args)
+
+        AVAILABLE_FIELDS.each do |field|
+          instance_variable_set("@#{field}", args[field]) unless args[field].nil?
+        end
+      end
+
+      def not_paid?
+        status_equals?(OrderStatus::NOT_PAID)
+      end
+
+      def preauthorized?
+        status_equals?(OrderStatus::PREAUTHORIZED_AMOUNT_HOLD)
+      end
+
+      def completed?
+        status_equals?(OrderStatus::COMPLETED)
+      end
+
+      def cancelled?
+        status_equals?(OrderStatus::CANCEL)
+      end
+
+      def refunded?
+        status_equals?(OrderStatus::REFUND)
+      end
+
+      def auth_on_bank_issuer_side?
+        status_equals?(OrderStatus::AUTH_ON_BANK_ISSUER_SIDE)
+      end
+
+      def rejected?
+        status_equals?(OrderStatus::REJECTED)
+      end
+
+      private
+
+      def status_equals?(status)
+        orderStatus == status
+      end
+    end
+  end
+end

data/lib/sbrf_merchant/version.rb

@@ -0,0 +1,3 @@
+module SbrfMerchant
+  VERSION = '0.1.1'.freeze
+end

data/sbrf_merchant.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sbrf_merchant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sbrf_merchant'
+  spec.version       = SbrfMerchant::VERSION
+  spec.authors       = ['Eugene Kozlov']
+  spec.email         = ['kozlovea8@gmail.com']
+
+  spec.summary       = 'Sberbank Merchant'
+  spec.description   = 'Sberbank Merchant API Client for Ruby'
+  spec.homepage      = 'https://github.com/abstractart/sbrf_merchant'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'dry-auto_inject'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'json'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: sbrf_merchant
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Eugene Kozlov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-auto_inject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sberbank Merchant API Client for Ruby
+email:
+- kozlovea8@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sbrf_merchant.rb
+- lib/sbrf_merchant/api/action.rb
+- lib/sbrf_merchant/api/client.rb
+- lib/sbrf_merchant/api/error_code.rb
+- lib/sbrf_merchant/api/order_status.rb
+- lib/sbrf_merchant/config/container.rb
+- lib/sbrf_merchant/order/one_stage.rb
+- lib/sbrf_merchant/response/base.rb
+- lib/sbrf_merchant/response/create_order.rb
+- lib/sbrf_merchant/response/order_status.rb
+- lib/sbrf_merchant/version.rb
+- sbrf_merchant.gemspec
+homepage: https://github.com/abstractart/sbrf_merchant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Sberbank Merchant
+test_files: []