sbrf_merchant 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6a5b6f47d214d86d9060dc1f22a90bb1978869578d5b7260e1512b0046ede11
-  data.tar.gz: eff4894c9b2ec93d898d5ee12409c33a58a2ddb46bcb7ce1a0e9d864484fc4b5
+  metadata.gz: 0e29ff9dfedf968e73a6318f1cc014e9a106838f0695a86a99ec8aa2519c8e8a
+  data.tar.gz: bbef1d87432e6f353ee5cab58934db1f42c3b49a73557ae09a49b01f11738d54
 SHA512:
-  metadata.gz: 596032ff87d08f9c8629e888e98af091f193aeeb72531658a64929509229169f3a0f1d975e1b87ba342992da4089d80abbc0d162cebe6aa0c1e00f82ed7a1a1d
-  data.tar.gz: 751bba5276208ea197b5a5b86259e4d94b81520f831b83d2155af81d8600ed498a034ac861e7889e42429cd658ed78ab32581d6573a9f7d0f90c0907fe3e6c93
+  metadata.gz: 15e0ab7663e5695859e6af9ee159cb5e3dcfb70fbae6fd123e07a1a6916ad4cca05073e6e1a6aaa6629de1ed3bfdd200d161f0a0deef146966f3467cefdcc255
+  data.tar.gz: aa8e6a4b467ba45e06f09dd0fbcb0954aa8694fdb8f553b0d004482b14bfed9038b7a2faa0dcf7bfbfc019807f2629a7275d7261ffec373194730d567e0ff0b2

data/README.md

@@ -11,28 +11,36 @@ Ruby клиент для работы с платёжным шлюзом Сбе
 Ключевые особенности:
 - Простой (~200 LOC).
 - Расширяемый из коробки. Если В API появится новый метод то данный клиент будет его поддерживать без каких либо правок в исходный код
-- Написан в ОО + ФП стиле без "магии". Легко встроится в ваши сервисные объекты и юнит тесты
+- Написан в ОО стиле без "магии". Легко встроится в ваши сервисные объекты и юнит тесты
+
+# Содержание
+- [Установка](#установка)
+- [Документация](#документация)
+- [Примеры использования](#примеры-использования)
+  - [Регистрации заказа](#регистрация-заказа)
+  - [Замена HTTP клиента](#замена-http-клиента)
+  - [Замена JSON парсера](#замена-json-парсера)
 
 ## Установка
 
-### RubyGems.org ###
+### RubyGems.org
 
 ```sh
 % gem install sbrf_merchant
 ```
 
-### Bundler ###
+### Bundler
 
 ```ruby
 # Gemfile
 gem 'sbrf_merchant'
 ```
 ## Документация
-- [Site(RU)](https://securepayments.sberbank.ru/wiki/doku.php/integration:api:start)
+- [WEB(RU)](https://securepayments.sberbank.ru/wiki/doku.php/integration:api:start)
 - [PDF(RU)](http://cs.petrsu.ru/~vadim/sd2018/Merchant-Manual-SBRF.pdf)
 
-## Использование
-### Пример регистрации заказа
+## Примеры использования
+### Регистрация заказа
 ```ruby
 # Cоздаем клиент
 client = SBRF::Api::Client.new(
@@ -51,14 +59,14 @@ params = {
   order_number: "something_unique_string",
   return_url: 'localhost:3000'
 }
-response = client.call(:register, params)
+response = client.call(:register, **params)
 
 response.success? # => true
 # В ответе доступ к атрибутам в snake_case
 response.order_id #<order-id>
 
 ```
-### Использование альтернативного http клиента
+### Замена HTTP клиента
 По умолчанию гем использует ```Net::Http``` для отправки HTTP запросов. Если в вашем проекте используется другой Http клиент, например [Faraday](https://github.com/lostisland/faraday) то нужно реализовать callable класс или Proc и передать его в конструктор:
 ```ruby
 client = SBRF::Api::Client.new(
@@ -66,10 +74,18 @@ client = SBRF::Api::Client.new(
   password: '<Merchant Password>',
   host: '<Sberbank API Host>' # например https://3dsec.sberbank.ru',
   http_client: ->(uri, params) { Faraday.post(uri, params) }
-)  
+)
 ```
 
+### Замена JSON парсера
+По умолчанию гем использует класс```JSON``` для парсинга JSON строк. Если в вашем проекте используется другой парсер, например [Oj](https://github.com/ohler55/oj) то нужно реализовать callable класс или Proc и передать его в конструктор:
+```ruby
+client = SBRF::Api::Client.new(
+  user_name: '<Merchant Username>',
+  password: '<Merchant Password>',
+  host: '<Sberbank API Host>' # например https://3dsec.sberbank.ru',
+  json_parser: ->(json) { Oj.load(json, symbol_keys: true) }
+)
+```
 ## Copyright
-Copyright (c) 2018 Eugene Kozlov.
-
-[license]: LICENSE.md
+Copyright (c) 2019 Eugene Kozlov.

data/lib/sbrf_merchant/api/client.rb

@@ -3,6 +3,7 @@
 require 'sbrf_merchant/api/response/body_postprocessor'
 require 'sbrf_merchant/api/request/body_preprocessor'
 require 'sbrf_merchant/api/request/uri_builder'
+require 'sbrf_merchant/utils/json/to_hash_parser'
 require 'sbrf_merchant/utils/http/client'
 
 module SbrfMerchant
@@ -14,16 +15,18 @@ module SbrfMerchant
                   :response_body_postprocessor,
                   :http_client,
                   :uri_builder,
-                  :request_body_preprocessor
+                  :request_body_preprocessor,
+                  :json_parser
 
       def initialize(
         user_name:,
         password:,
         host:,
-        response_body_postprocessor: SbrfMerchant::Api::Response::BodyPostProcessor.new,
-        request_body_preprocessor: SbrfMerchant::Api::Request::BodyPreProcessor.new,
-        http_client: SbrfMerchant::Utils::Http::Client.new,
-        uri_builder: SbrfMerchant::Api::Request::UriBuilder.new
+        response_body_postprocessor: SBRF::Api::Response::BodyPostProcessor.new,
+        request_body_preprocessor: SBRF::Api::Request::BodyPreProcessor.new,
+        http_client: SBRF::Utils::Http::Client.new,
+        uri_builder: SBRF::Api::Request::UriBuilder.new,
+        json_parser: SBRF::Utils::JSON::ToHashParser.new
       )
         @user_name = user_name
         @password = password
@@ -32,14 +35,16 @@ module SbrfMerchant
         @http_client = http_client
         @uri_builder = uri_builder
         @request_body_preprocessor = request_body_preprocessor
+        @json_parser = json_parser
       end
 
       def call(method_name, **params)
         prepared_params = request_body_preprocessor.call(auth_params.merge(params))
         uri = uri_builder.call(host, method_name)
-
         response = http_client.call(uri, prepared_params)
-        response_body_postprocessor.call(response.body)
+        parsed_body = json_parser.call(response.body)
+
+        response_body_postprocessor.call(parsed_body)
       end
 
       private

data/lib/sbrf_merchant/api/request/body_preprocessor.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'sbrf_merchant/utils/high_order_functions/compose'
 require 'sbrf_merchant/utils/hash/to_camel_case_keys'
 
 module SbrfMerchant

data/lib/sbrf_merchant/api/response/append_success_flag_to_hash.rb

@@ -5,7 +5,7 @@ module SbrfMerchant
     module Response
       class AppendSuccessFlagToHash
         def call(hash)
-          hash.merge('success?' => success?(hash))
+          hash.merge(success?: success?(hash))
         end
 
         private
@@ -14,7 +14,7 @@ module SbrfMerchant
         # В успешном ответе на запрос register errorCode отсутствует,
         # поэтому проверяем по параметру formUrl
         def success?(hash)
-          !hash['formUrl'].nil? || hash['errorCode'] == '0'
+          !hash[:form_url].nil? || hash[:error_code] == '0'
         end
       end
     end

data/lib/sbrf_merchant/api/response/body_decorator.rb

@@ -5,24 +5,18 @@ require 'sbrf_merchant/utils/string/to_camel_case'
 module SbrfMerchant
   module Api
     module Response
-      # Проблема - API сбербанка возвращает ответ в формате camelCase,
-      # что не очень красиво выглядит в руби коде
-
-      # Решение - декоратор для хэша на котором будут вызываться методы в snake_case,
       class BodyDecorator
-        attr_reader :hash, :to_camel_case
+        attr_reader :hash
 
-        def initialize(hash, to_camel_case = ::SBRF::Utils::String::ToCamelCase.new)
+        def initialize(hash)
           @hash = hash
-          @to_camel_case = to_camel_case
         end
 
         def method_missing(meth, *args)
-          value = hash[key(meth)]
-
-          # Если значение не найдено то поведение по умолчанию
-          return super if value.nil?
+          # Если ключ отсутствует то поведение по умолчанию
+          return super unless hash.key?(meth)
 
+          value = hash[meth]
           # Если значение - хэш то возвращаем его, предварительно обернув в декоратор
           return self.class.new(value) if value.is_a?(Hash)
 
@@ -31,17 +25,11 @@ module SbrfMerchant
         end
 
         def respond_to?(meth)
-          hash.key?(key(meth))
+          hash.key?(meth)
         end
 
         def respond_to_missing?(meth)
-          hash.key?(key(meth))
-        end
-
-        private
-
-        def key(meth)
-          to_camel_case.call(meth.to_s)
+          hash.key?(meth)
         end
       end
     end

data/lib/sbrf_merchant/api/response/body_postprocessor.rb

@@ -1,20 +1,19 @@
 # frozen_string_literal: true
 
-require 'sbrf_merchant/utils/high_order_functions/compose'
-require 'sbrf_merchant/utils/json/to_hash_parser'
 require 'sbrf_merchant/api/response/append_success_flag_to_hash'
 require 'sbrf_merchant/api/response/body_decorator'
+require 'sbrf_merchant/utils/hash/to_snake_case_keys'
 
 module SbrfMerchant
   module Api
     module Response
       class BodyPostProcessor
-        def call(body)
-          ::SbrfMerchant::Utils::HighOrderFunctions::Compose.new(
-            ::SbrfMerchant::Utils::JSON::ToHashParser.new,
-            ::SbrfMerchant::Api::Response::AppendSuccessFlagToHash.new,
-            ->(hash) { ::SbrfMerchant::Api::Response::BodyDecorator.new(hash) }
-          ).call(body)
+        def call(hash)
+          result = ::SbrfMerchant::Utils::Hash::ToSnakeCaseKeys.new.call(hash)
+          result = ::SbrfMerchant::Api::Response::AppendSuccessFlagToHash.new.call(result)
+          result = ::SbrfMerchant::Api::Response::BodyDecorator.new(result)
+
+          result
         end
       end
     end

data/lib/sbrf_merchant/utils/hash/to_snake_case_keys.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'plissken'
+
+module SbrfMerchant
+  module Utils
+    module Hash
+      class ToSnakeCaseKeys
+        def call(hash)
+          hash.to_snake_keys
+        end
+      end
+    end
+  end
+end

data/lib/sbrf_merchant/utils/json/to_hash_parser.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'json/ext'
+require 'json'
 
 module SbrfMerchant
   module Utils
     module JSON
       class ToHashParser
         def call(json)
-          ::JSON.parse(json)
+          ::JSON.parse(json, symbolize_names: true)
         end
       end
     end

data/lib/sbrf_merchant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SbrfMerchant
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sbrf_merchant
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Eugene Kozlov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-24 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: plissken
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Sberbank Merchant API Client for Ruby
+description: Simple and flexible Sberbank acquiring API client for Ruby
 email:
 - kozlovea8@gmail.com
 executables: []
@@ -140,7 +140,7 @@ files:
 - lib/sbrf_merchant/api/response/body_decorator.rb
 - lib/sbrf_merchant/api/response/body_postprocessor.rb
 - lib/sbrf_merchant/utils/hash/to_camel_case_keys.rb
-- lib/sbrf_merchant/utils/high_order_functions/compose.rb
+- lib/sbrf_merchant/utils/hash/to_snake_case_keys.rb
 - lib/sbrf_merchant/utils/http/client.rb
 - lib/sbrf_merchant/utils/json/to_hash_parser.rb
 - lib/sbrf_merchant/utils/string/to_camel_case.rb

data/lib/sbrf_merchant/utils/high_order_functions/compose.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module SbrfMerchant
-  module Utils
-    module HighOrderFunctions
-      # Обьединяем несколько callable сущностей в одну
-      class Compose
-        attr_reader :functions
-
-        def initialize(*functions)
-          @functions = functions
-        end
-
-        def call(arg)
-          functions.inject(arg) { |acc, func| func.call(acc) }
-        end
-      end
-    end
-  end
-end