kapellmeister 0.9.6 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe79b6fb67ba56c68ef8f1ae0c8f617856027bd63092193f32c11ced913db7f8
-  data.tar.gz: 80f2ff06ffcb6b91da5610162d52a5c8648d60a0d22991ffe90a175998424bf3
+  metadata.gz: 62a0e8ed962461f5c86bd781a7b8d6c3003ddc30e0001edd8efcf0da42081d64
+  data.tar.gz: fd56000ef1fdd4c06feeed14650ca9c902b444f26fe2a453f613f8d2b055bc14
 SHA512:
-  metadata.gz: acfe492025285fe11843ba4bdd3a911f793ae3c980afb46281b9490df7096005f246f585722587d2103d1d56f9b4568aa3082392f29640fff61f35c5fd1926bb
-  data.tar.gz: 916c8280053a15b9fbccfc7ddab4941219d1309331b019e40879523fe0b05300ba802d5ad306e4492245a47871e919aca8c184f0cab17ad581d56fa24dfd18be
+  metadata.gz: f73144f388ef871cd0d4233ad9ae925513a79bc297f520c51ed91f3e81eb0b0a48a0bbdd28b2627f6fef976c6f314e64368c1076a91364109ec7555a07698aa1
+  data.tar.gz: 7d001a857e5fa55206a6932eb5c73c151718586731bd1fd11c60796d7a74df57a618692b45c411e51f1b1a848b64da83a7de0370e5336754d028fbcb4e3606dc

data/README.md

@@ -7,7 +7,7 @@ This template-service allows you to define http requests to a third party throug
 Add kapellmeister to your Gemfile:
 
 ```ruby
-gem 'kapellmeister', '~> 0.4.1'
+gem 'kapellmeister', '~> 0.9.6'
 ```
 
 ### Add new third party configuration:
@@ -15,10 +15,15 @@ gem 'kapellmeister', '~> 0.4.1'
     $ bin/rails g kapellmeister:add_service %<ThirdPartyName> %<options> --%<flags>
 
 `ThirdPartyName` — Pass the lib name, either CamelCased or under_scored
+
 `options` — Pass the configuration keys, usually host, key and version
-`flags` — This generator have one flag. This flag is `responder`, default is `false`. If you set to `true` will be generated responder.rb used for parsing response.
 
-All the instructions are lightweight files in your /lib folder. Here's the example of structure:
+`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.
+
+All the instructions are lightweight files in your /lib folder.
+Here's the example of structure:
 
 ``` Capfile
 └── app
@@ -51,16 +56,63 @@ Folder contains `routes scheme`, `client`, `configuration` and optional `respond
 foo:                     => Wrapper for method
   bar:                   => Method name
     scheme:              => Scheme description
-      method: POST       => Request type
-      use_wrapper: true  => Default true
+      method: POST       => Request type (* required)
+      use_wrapper: true  => Wrap method for uniqueness. Default true
       path: buz          => Real path
-      mock:              => Mock for development
-        token: blablabla
+      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
+
+# client = ThirdParty::Client.new
+# client.foo_bar { a: 'b' } 
+# => POST https://third_party.com/foo/buz DATA: { a: 'b' }
+```
+#### Parameters explanation:
+
+`body` — You can use dry-schema for validate request parameters.
+If this key doesn't exist validation will be skipped.
+For example:
+
+```yaml
+body: CreateSchema
+```
 
-# ThirdParty::Client.foo_bar { a: 'b' } => POST https://third_party.com/foo/buz DATA: { a: 'b' }
+`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:
+
+```yaml
+query_params:
+  dbAct: getCities       => For known and unchangeable parameters
+  optional:              => For optional parameters
+    - city
+    - state
+
+# /api?dbAct=getCities&city=Tokio
 ```
+```yaml
+query_params:
+  - dbAct: getTarif
+  - org                => For required parameters
+  - dest
+  - weight
+  
+# /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:
+
+```yaml
+mock: spec/mocks/http_clients/public/cities.yml
+```
+
+#### Generated files explanation
 
-`client.rb` — Nested from main dispatcher and you can add some configuration methods, custom headers and requests options.
+`client.rb` — Nested from main dispatcher and you can add some configuration methods, custom headers, requests options, query parameters.
 
 `configuration.rb` — Add path to third party, config url and logger
 

data/lib/generators/kapellmeister/templates/lib/third_party/routes.yml.tt

@@ -3,8 +3,8 @@
 #     bar:                  => Method name
 #       scheme:             => Scheme description
 #         method: POST      => Request type (* required)
-#         use_wrapper: true => Default true (* required)
-#         path: buz         => Real path (* required)
+#         use_wrapper: true => 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

data/lib/kapellmeister/base.rb

@@ -41,6 +41,8 @@ def generate_routes(json_scheme)
 
     generate_routes(value).map { |deep_key, deep_value| mapping(deep_key, deep_value, key, scheme) }
   end
+rescue TypeError
+  raise "It seems like wrong routes scheme. #{json_scheme}"
 end
 
 def mapping(deep_key, deep_value, key, scheme)

data/lib/kapellmeister/dispatcher.rb

@@ -44,7 +44,7 @@ class Kapellmeister::Dispatcher
     generated_connection = connection(additional_headers: additional_headers, requests_data: requests_data) # rubocop:disable Style/HashSyntax (for support ruby 2.4+)
 
     process generated_connection.run_request(method_name.downcase.to_sym,
-                                             url_with_params(path),
+                                             url_with_params(path, data, method_name),
                                              data_json,
                                              additional_headers)
 
@@ -90,15 +90,21 @@ class Kapellmeister::Dispatcher
     report(data).result
   end
 
-  def url_with_params(url)
+  def url_with_params(url, data, method_name)
     url = url.split('/').map do |url_part|
       url_part.ascii_only? ? url_part : CGI.escape(url_part)
     end.join('/')
 
+    url = url_repacking(url, data) if method_name == 'GET'
+
     return url if query_params.blank?
 
+    url_repacking(url, query_params)
+  end
+
+  def url_repacking(url, queries)
     uri = URI(url)
-    params = URI.decode_www_form(uri.query || '').to_h.merge(query_params)
+    params = URI.decode_www_form(uri.query || '').to_h.merge(queries)
     uri.query = URI.encode_www_form(params)
     uri.to_s
   end

data/lib/kapellmeister/requests_extension.rb

@@ -63,7 +63,7 @@ end
 def generate_full_path(original_path, data)
   path = generate_path(original_path, data)
   query = data.delete(:query_params)&.to_query
-  return "?#{query}" unless path
+  return "?#{query}" if path.blank?
 
   [path, query].compact_blank!.join('?')
 end

data/lib/kapellmeister/version.rb

@@ -1,3 +1,3 @@
 module Kapellmeister
-  VERSION = '0.9.6'.freeze
+  VERSION = '0.9.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kapellmeister
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors:
 - DarkWater
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-schema
@@ -206,7 +206,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: HTTP requests dispatcher
 test_files: []