kapellmeister 0.9.8 → 0.9.9.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00d0f29f4135cca35f1b74b9eb59e04686a30ce257e7448620fd7131faf73c6f
-  data.tar.gz: feeb5460b5771b5a1974c4a452d0b83f9046dcbc5b1b3e931b3d4c77febf862a
+  metadata.gz: 6d59e28eecf6117e627cd0108f64e27db9331837d972d8ae9911041e7dd1c03f
+  data.tar.gz: 6717303f7fbce49b91927ab5021312f3fe2ea761a8dcd07883d290cd91839d87
 SHA512:
-  metadata.gz: 321dd035242112e8ec715b68a7c2df4f10d0a14f8e47839d49b78e4bd81785c104aeac1a0c1a550b24f3badfd95950b79d0386db500c2e50b89d3177b16cda48
-  data.tar.gz: aff7e0ee44980ed3a92d5530ec57d97c7cba429f9d6cf8f876f59a06c7349fccfd4e7dc36f73e725a3dd71c8ffd4258b6ccd20e2f794f027adaa3409fb96032d
+  metadata.gz: 3296052e14e0aaf0b0553930be4ad02e8ffa102a13968fde326c1bd358274940b4afbfe2abc28a3bfc5e4cb6a60fa723d7739a1d0a332e4e303514bff2c41c44
+  data.tar.gz: d2d0a331dc45c3e084f9c46c5fb36f75dd067d6ec140c2f00a5f7f0e9f6676bc15e5100d192e23242163e4b954fa53c92506b9e96b1ae6c2fe39fd61f1a73df0

data/Gemfile

@@ -6,9 +6,9 @@ gemspec
 
 gem 'dry-schema'
 gem 'faraday'
-gem 'faraday_middleware'
+gem 'faraday-follow_redirects'
 gem 'faraday-cookie_jar'
-gem 'typhoeus'
+gem 'faraday-typhoeus'
 
 # debug
 group :development do
@@ -23,6 +23,6 @@ group :development, :test do
   gem 'rubocop', require: false
   gem 'rubocop-performance'
   gem 'rubocop-rspec'
-  gem 'rubycritic', require: false
+  gem 'rubycritic', '~> 4.9.1', require: false
   gem 'ruby_gntp'
 end

data/README.md

@@ -1,3 +1,132 @@
+# Диспетчер HTTP-запросов
+
+Этот шаблонизатор позволяет вам определять http-запросы к любым сторонним API с помощью упрощенного набора инструкций, включая анализатор маршрутов в формате yaml
+## Использование
+
+Добавьте kapellmeister в свой Gemfile:
+На данный момент послденяя версия 0.9.8 (Проект находится в стадии тестирования работоспособности, beta-test)
+```ruby
+gem 'kapellmeister', '~> 0.9.8'
+```
+
+### Добавьте новую конфигурацию для стороннего API:
+
+    $ bin/rails g kapellmeister:add_service %<ThirdPartyName> %<options> --%<flags>
+
+`ThirdPartyName` — Имя сервиса, может быть указан как КэмелКейсом (CamelCase) так и с нижним_подчёркиванием (under_scored)
+
+`options` — Укажите ключи конфигурации, обычно это хост, ключ и версия
+
+`flags` — Этот шаблонзатор пока что имеет один флаг.
+Флаг `responder`, `false` — значение по-умолчанию.
+Если вы установите для него значение `true`, то будет сгенерирован файл responder.rb используемый для анализа и парсинга ответа.
+
+Все инструкции — это легковесные файлы в каталоге /lib вашего приложения.
+Вот пример структуры:
+
+``` Capfile
+└── app
+    └── lib
+        └── third_party_service
+            ├── client.rb
+            ├── configuration.rb
+            ├── responder.rb (опционально)
+            └── routes.yml
+        └── third_party_service.rb  
+└── initializers
+    └── third_party_service.rb
+```
+
+Если вы используете Rails, в вашем приложении есть папка `initializers`. Добавьте секретные ключи в файле-инициализаторе
+
+    initializers/third_party_service.rb
+
+Основной файл вашей интеграции, миксин, включающий Kapellmeister::Base
+
+    app/lib/third_party_service.rb
+
+Каталог, содержащий `routes scheme`, `client`, `configuration` и опциональный `responder`.
+
+    app/lib/third_party_service
+
+
+
+`routes.yml` — Маршруты к стороннему API во вложенном формате.
+
+``` yaml
+foo:                     => Обёртка для метода
+  bar:                   => Наименование метода
+    scheme:              => Описание схемы
+      method: POST       => Тип запроса (* обязательный параметр!)
+      use_wrapper: true  => Обёрнуть ли метод для обеспечения уникальности. По умолчанию true
+      path: buz          => Настоящий путь (роут). Если параметра нет, то путь будет взят из наименования метода.
+      body:              => Dry-scheme (из набора гемов DRY) для проверки параметров. Если параметра нет, то проверки не будет.
+      query_params:      => Описание query-параметров. Если параметра нет, то подстановки параметров не будет.
+      mock:              => Структура или путь к файлу mock для тестов. Если параметра нет, в среде разработки будет возвращён реальный ответ на запрос.
+
+# Результат из примера выше:
+# client = ThirdParty::Client.new
+# client.foo_bar { a: 'b' } 
+# => POST https://third_party.com/foo/buz DATA: { a: 'b' }
+```
+#### Пояснение к параметрам:
+
+`body` — Вы можете использовать dry-scheme (из набора гемов DRY) для проверки параметров запроса.
+Если этот ключ не существует, проверка будет пропущена.
+Пример:
+
+```yaml
+body: DrySchema
+```
+
+`query_params` — Если для запроса требуется query-параметры.
+Работают как массивы, так и руби-хэши.
+Если этот ключ не существует, то подстановки параметров и их проверки не будет.
+For example:
+
+```yaml
+query_params:
+  dbAct: getCities       => Пример использования известных и неизменяемых параметров
+  optional:              => Пример использования опциональных параметров. Они будут подставлены при передачи их при запросе
+    - city
+    - state
+
+# Результат из примера выше:
+# /api?dbAct=getCities&city=Tokio
+```
+```yaml
+query_params:
+  - dbAct: getTarif
+  - org                => Пример использования обязательных параметров.
+  - dest
+  - weight
+  
+# Результат из примера выше:
+# /api?dbAct=getTarif&org=Tokio&dest=Beijing&weight=100
+```
+
+`mock` — Если вам нужно, чтобы реальные запросы не проходили во время тестирования,
+вы можете заменить их на mocks.
+Можно использовать как структуру yaml, так и путь к файлу yaml.
+Например:
+
+```yaml
+mock: spec/mocks/http_clients/public/cities.yml
+```
+
+#### Объяснение сгенерированных файлов
+
+`client.rb` — Унаследованный файл от главного диспетчера, и вы можете добавить некоторые методы настройки, пользовательские заголовки, параметры запросов, query-параметры.
+
+`configuration.rb` — Добавляем путь к стороннему API, URL-адрес конфигурации и логгер.
+
+`responder.rb` — По умолчанию используется стандартный обработчик ответов, обработанный в формате json. Но вы можете написать свой собственный.
+
+
+
+---
+### english
+
 # HTTP requests dispatcher
 
 This template-service allows you to define http requests to a third party through a lightweight set of instructions, including a route parser in yaml format
@@ -5,25 +134,25 @@ This template-service allows you to define http requests to a third party throug
 ## Usage
 
 Add kapellmeister to your Gemfile:
-
+At the moment, the latest version is 0.9.8 (The project is in the stage of performance testing, beta-test)
 ```ruby
 gem 'kapellmeister', '~> 0.9.6'
 ```
 
-### Add new third party configuration:
+### Add a new configuration for the third-party API:
 
     $ bin/rails g kapellmeister:add_service %<ThirdPartyName> %<options> --%<flags>
 
-`ThirdPartyName` — Pass the lib name, either CamelCased or under_scored
+`ThirdPartyName` — The name of the service, can be specified either CamelCased or under_scored
 
-`options` — Pass the configuration keys, usually host, key and version
+`options` — Specify the configuration keys, usually `host`, `key` and `version`
 
-`flags` — This generator have one flag.
-This flag is `responder`, default is `false`.
-If you set it to `true` will be generated responder.rb used for parsing response.
+`flags` — This generator has only one flag so far.
+The `responder` flag, `false` is the default value.
+If you set it to `true`, the responder.rb file will be generated, which is used for analyzing and parsing the response.
 
-All the instructions are lightweight files in your /lib folder.
-Here's the example of structure:
+All instructions are lightweight files in the /lib directory of your application.
+Here is an example of the structure:
 
 ``` Capfile
 └── app
@@ -40,83 +169,86 @@ Here's the example of structure:
 
     initializers/third_party_service.rb
 
-If you use the Rails gem you have the `initializers` folder in your application. Add the secret keys to config.
+If you are using Rails gem, there is a `initializers` folder in your application. Add the secret keys in the initializer file.
 
     app/lib/third_party_service.rb
 
-Main file of your integration. Make it module and include the Kapellmeister::Base
+The main file of your integration, a mixin that includes Kapellmeister::Base
 
     app/lib/third_party_service
 
-Folder contains `routes scheme`, `client`, `configuration` and optional `responder`.
+A directory containing `routes scheme`, `client`, `configuration` and an optional `responder`.
 
-`routes.yml` — Routes to third party in nested format.
+`routes.yml` — Routes to a third-party API in a nested format.
 
 ``` yaml
-foo:                     => Wrapper for method
-  bar:                   => Method name
-    scheme:              => Scheme description
+foo:                     => Wrapper of the method
+  bar:                   => Name of the method
+    scheme:              => Description of the scheme
       method: POST       => Request type (* required)
-      use_wrapper: true  => Wrap method for uniqueness. Default true
-      path: buz          => Real path
-      body:              => Dry schema for checking parameters. If key doesn't exist nothing happens
-      query_params:      => Query params. If key doesn't exist nothing happens
-      mock:              => Structure or Path to mock file for tests. If key doesn't exist nothing happens
+      use_wrapper: true  => Whether to wrap the method to ensure uniqueness. By default, true
+      path: buz          => The real path (route). If there is no parameter, the path will be taken from the method name.
+      body:              => Dry-scheme (from the set of DRY gems) to check the parameters. If there is no parameter, then there'll be no verification.
+      query_params:      => Description of the query parameters. If there is no parameter, then there'll be no parameter substitution.
+      mock:              => The structure or path to the mock file for the tests. If there is no parameter, the actual response to the request will be returned in the development environment.
 
+# The result from the example above:
 # client = ThirdParty::Client.new
 # client.foo_bar { a: 'b' } 
 # => POST https://third_party.com/foo/buz DATA: { a: 'b' }
 ```
-#### Parameters explanation:
+#### Explanation of the parameters:
 
-`body` — You can use dry-schema for validate request parameters.
-If this key doesn't exist validation will be skipped.
-For example:
+`body` — You can use the dry-scheme (from the set of DRY gems) to check the request parameters.
+If this key doesn't exist, the verification will be skipped.
+Example:
 
 ```yaml
-body: CreateSchema
+body: DrySchema
 ```
 
-`query_params` — If request needs a query string.
-Both arrays and hashes work.
-If this key doesn't exist validation will be skipped.
-For example:
+`query_params` — If the request requires query parameters.
+Both arrays and ruby-hashes work.
+If this key doesn't exist, then there'll be no parameter substitution and validation.
+Example:
 
 ```yaml
 query_params:
-  dbAct: getCities       => For known and unchangeable parameters
-  optional:              => For optional parameters
+  dbAct: getCities       => Example of using known and immutable parameters
+  optional:              => An example of using optional parameters. They'll be substituted when they are transmitted during the request
     - city
     - state
 
+# The result from the example above:
 # /api?dbAct=getCities&city=Tokio
 ```
 ```yaml
 query_params:
   - dbAct: getTarif
-  - org                => For required parameters
+  - org                => Example of using required parameters.
   - dest
   - weight
-  
+
+# The result from the example above:
 # /api?dbAct=getTarif&org=Tokio&dest=Beijing&weight=100
 ```
 
-`mock` — If you need real requests don't pass during the testing,
-then you can replace them with mocks.
-Both yaml structure or path to yaml file can be used.
-For example:
+`mock` —  If you need real requests not to pass during testing,
+you can replace them with mocks.
+You can use both the yaml structure and the path to the yaml-file.
+Example:
 
 ```yaml
 mock: spec/mocks/http_clients/public/cities.yml
 ```
 
-#### Generated files explanation
+#### Explanation of the generated files
 
-`client.rb` — Nested from main dispatcher and you can add some configuration methods, custom headers, requests options, query parameters.
+`client.rb` — An inherited file from the main dispatcher, and you can add some configuration methods, custom headers, request parameters, query-parameters.
 
-`configuration.rb` — Add path to third party, config url and logger
+`configuration.rb` — Add the path to the third-party API, the configuration URL and the logger.
 
-`responder.rb` — By default uses standard responders parsed response in json. But you can write your own.
+`responder.rb` —  By default, a standard response handler is used, parsed in json format. But you can write your own.
 
 ## Contributing
 

data/kapellmeister.gemspec

@@ -14,11 +14,9 @@ Gem::Specification.new do |gem|
 
   gem.license       = 'MIT'
 
-  if gem.respond_to?(:metadata)
-    gem.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
+  raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless gem.respond_to?(:metadata)
+
+  gem.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)/) }
   gem.bindir        = 'exe'
@@ -30,13 +28,13 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'dry-schema', '~> 1.13'
   gem.add_dependency 'faraday', '~> 2.10'
   gem.add_dependency 'faraday-cookie_jar', '~> 0.0.7'
-  gem.add_dependency 'faraday_middleware', '~> 1.2'
-  gem.add_dependency 'typhoeus', '~> 1.4.0'
+  gem.add_dependency 'faraday-follow_redirects', '~> 0.3.0'
+  gem.add_dependency 'faraday-typhoeus', '~> 1.1.0'
 
   gem.add_development_dependency 'bundler', '~> 2.0', '>= 2.0.2'
   gem.add_development_dependency 'rake', '~> 13.0'
   gem.add_development_dependency 'redcarpet', '~> 1.17', '>= 1.17.0'
-  gem.add_development_dependency 'rubocop', '~> 1.21'
+  gem.add_development_dependency 'rubocop', '~> 1.6'
   gem.add_development_dependency 'yard', '~> 0.7', '>= 0.7.5'
   gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/kapellmeister/base.rb

@@ -37,7 +37,7 @@ end
 def generate_routes(json_scheme)
   json_scheme.dup.each_with_object({}) do |(key, value), scheme|
     scheme[key] = value.delete(:scheme) if (value.is_a?(Hash) && value.key?(:scheme)) || value.is_a?(String)
-    next if value.nil? || value.length.zero?
+    next if value.nil? || value.empty?
 
     generate_routes(value).map { |deep_key, deep_value| mapping(deep_key, deep_value, key, scheme) }
   end

data/lib/kapellmeister/dispatcher.rb

@@ -1,12 +1,12 @@
-require 'faraday_middleware'
-require_relative './requests_extension'
+require 'faraday/follow_redirects'
+require_relative 'requests_extension'
 
 class Kapellmeister::Dispatcher
   def self.new(**args)
-    main_klass = self.module_parent.name.delete('::')
+    main_klass = module_parent.name&.delete('::')
 
-    self.module_parent.requests.each do |request|
-      self.include Kapellmeister::RequestsExtension.request_processing(main_klass, request)
+    module_parent.requests.each do |request|
+      include Kapellmeister::RequestsExtension.request_processing(main_klass, request)
     end
     super(**args)
   end
@@ -60,7 +60,7 @@ class Kapellmeister::Dispatcher
       faraday.request :multipart
       faraday.response :logger, logger
       faraday.response :json, content_type: 'application/json; charset=utf-8'
-      faraday.use FaradayMiddleware::FollowRedirects, limit: 5
+      faraday.response :follow_redirects
       faraday.adapter :typhoeus do |http|
         http.timeout = 20
       end

data/lib/kapellmeister/requests_extension.rb

@@ -3,7 +3,7 @@ module Kapellmeister::RequestsExtension
     mod = if Object.const_defined?("#{self}::#{klass}InstanceMethods")
             const_get("#{self}::#{klass}InstanceMethods")
           else
-            const_set("#{klass}InstanceMethods", Module.new)
+            const_set(:"#{klass}InstanceMethods", Module.new)
           end
 
     mod.module_eval do
@@ -37,7 +37,7 @@ def parsed_query(params, data)
 
   hash_data, filtered_query = *split_hashes(params)
   required_empty_query, default_data = *hash_data.partition { |elem| elem.values.compact_blank.blank? }
-  data = Hash[filtered_query.zip].compact_blank.merge(data) if data.is_a?(Hash)
+  data = filtered_query.zip([]).to_h.compact_blank.merge(data) if data.is_a?(Hash)
   _optional_data, default_data = *split_optional(default_data)
   data = data.merge(default_data) if !data.blank? || !default_data.blank?
 
@@ -79,7 +79,7 @@ def generate_path(original_path, data)
 end
 
 def valid_body?(data, body)
-  return if body.blank? || body.is_a?(Hash)
+  return true if body.blank? || body.is_a?(Hash)
 
   schema = Object.const_get(body).schema
   result = schema.call(data)
@@ -89,7 +89,7 @@ def valid_body?(data, body)
 end
 
 def valid_query?(data, query)
-  return if query.blank?
+  return true if query.blank?
 
   required_keys = query.map(&:to_sym)
 
@@ -99,7 +99,7 @@ def valid_query?(data, query)
   data[:query_params] = data[:query_params].to_h.merge!(from_data)
 
   different_keys = data[:query_params].transform_keys(&:to_sym)
-  return if required_keys.all? { |key| different_keys.key? key.to_sym }
+  return true if required_keys.all? { |key| different_keys.key? key.to_sym }
 
   raise ArgumentError, "Query params needs keys #{required_keys}"
 end

data/lib/kapellmeister/version.rb

@@ -1,3 +1,3 @@
 module Kapellmeister
-  VERSION = '0.9.8'.freeze
+  VERSION = '0.9.9.rc2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kapellmeister
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.9.rc2
 platform: ruby
 authors:
 - DarkWater
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.7
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: faraday-typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +140,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -217,9 +217,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key: