kapellmeister 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7407397a71996e03b0580710175b3fd438789401e3579f8a8facf386c75c2a0e
-  data.tar.gz: '0782eac547479dcc32c538e61b843dba8077f7780e9fcae704fd054b039185a1'
+  metadata.gz: 00ad63e15092782d16bc142285ca607c2431195140be3b4e36ec7748d912c5a6
+  data.tar.gz: a40c93cc46323f5e702313e9fe889e0d9733e2446dfca525badff7edf87d4d1f
 SHA512:
-  metadata.gz: 0c0cdcd112bb8dff59dae92dae984510096d612db6b49031fe6d366b78ef2a6bddd3a77298a0b6d3ff80dd6d83237c957bbf7bd6d9984df2bbb855f529159598
-  data.tar.gz: 9fb028655d16860571aee8d73e349831b1b5a3552516ad25ab95a192d601bc3d769a37f82d664a2e83554d286afe0829ad4d5b02dec4d64e9a0a88240679a426
+  metadata.gz: 34c19a5f6b955bab605f2af31a9b4f33c242ee684b0edfa6affce868a0dcedbd73c041733e40d1b12f12f50efb3b81d5351164f6ab1b27d63a8523b2f2e39e3e
+  data.tar.gz: 4279bb8b32269f64d1ddcedbd28ad6fea79b89c346892f8f54401f33d1b602019560ba2459f714e3814ddecb2129e6ca3d3c6979268b54c236252deed5acbe0e

data/.editorconfig

@@ -0,0 +1,18 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+[*]
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/
+doc/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,45 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1.1
+  DisplayCopNames: true
+  NewCops: enable
+
+  Exclude:
+    - bin/**/*
+    - db/**/*
+    - test/**/*
+    - node_modules/**/*
+    - tmp/**/*
+    - Gemfile
+    - vendor/**/*
+    - gemfiles/**/*
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Metrics/AbcSize:
+  Max: 25
+Layout/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 25
+Metrics/BlockLength:
+  Max: 30
+  Exclude:
+    - "Rakefile"
+    - "**/*.rake"
+    - "spec/**/*.rb"
+
+Performance/MethodObjectAsBlock:
+  Enabled: false
+Performance/OpenStruct:
+  Enabled: true

data/.ruby-gemset

@@ -0,0 +1 @@
+kapellmeister

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+ruby '3.1.1'
+
+gemspec
+
+# debug
+group :development do
+  gem 'byebug'
+  gem 'web-console'
+  gem 'listen'
+  gem 'rerun', git: 'https://github.com/alexch/rerun.git'
+end
+
+# listings
+group :development, :test do
+  gem 'rubocop', require: false
+  gem 'rubocop-performance'
+  gem 'rubocop-rspec'
+  gem 'rubycritic', require: false
+  gem 'ruby_gntp'
+end
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,79 @@
+# 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
+
+## Usage
+
+Add kapellmeister to your Gemfile:
+
+```ruby
+gem 'kapellmeister', '~> 0.0.1', require: false
+```
+
+### Add new third party configuration:
+
+    $ 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:
+
+``` Capfile
+└── app
+    └── lib
+        └── third_party_service
+            ├── client.rb
+            ├── configuration.rb
+            ├── responder.rb
+            └── routes.yml
+        └── third_party_service.rb  
+└── initializers
+    └── third_party_service.rb
+```
+
+    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.
+
+    app/lib/third_party_service.rb
+
+Main file of your integration. Make it module and include the Kapellmeister::Base
+
+    app/lib/third_party_service
+
+Folder contains `routes scheme`, `client`, `configuration` and optional `responder`.
+
+`routes.yml` — Routes to third party in nested format.
+
+``` yaml
+foo:                     => Wrapper for method
+  bar:                   => Method name
+    scheme:              => Scheme description
+      method: POST       => Request type
+      use_wrapper: true  => Default true
+      path: buz          => Real path
+      mock:              => Mock for development
+        token: blablabla
+
+# ThirdParty::Client.foo_bar { a: 'b' } => POST https://third_party.com/foo/buz DATA: { a: 'b' }
+```
+
+`client.rb` — Nested from main dispatcher and you can add some configuration methods, custom headers and requests options.
+
+`configuration.rb` — Add path to third party, config url and logger
+
+`responder.rb` — By default uses standard responders parsed response in json. But you can write your own.
+
+## Contributing
+
+Pull requests welcome: fork, make a topic branch, commit (squash when possible) *with tests* and I'll happily consider.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Copyright
+
+Copyright (c) 2022 Denis Arushanov aka DarkWater

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+require 'yard'
+YARD::Rake::YardocTask.new

data/bin/console

@@ -0,0 +1,12 @@
+ßrequire "bundler/setup"
+require "locum_best_practices"
+
+# 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

data/bin/setup

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

data/kapellmeister.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kapellmeister/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'kapellmeister'
+  gem.version       = Kapellmeister::VERSION
+  gem.authors       = %w[DarkWater]
+  gem.email         = %w[denis.arushanov@darkcreative.ru]
+
+  gem.summary       = 'HTTP requests dispatcher'
+  gem.description   = 'Contains third party routes parser'
+  gem.homepage      = 'https://github.com/DarkWater666/kapellmeister'
+
+  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
+
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/^(test|spec|features)/) }
+  gem.bindir        = 'exe'
+  gem.executables   = gem.files.grep(/^exe/) { |f| File.basename(f) }
+  gem.require_paths = %w[lib]
+
+  gem.required_ruby_version = '>= 2.4.2'
+
+  gem.add_development_dependency 'bundler', '~> 2.0', '>= 2.0.2'
+  gem.add_development_dependency 'redcarpet', '~> 1.17', '>= 1.17.0'
+  gem.add_development_dependency 'yard', '~> 0.7', '>= 0.7.5'
+end

data/lib/generators/kapellmeister/add_service_generator.rb

@@ -0,0 +1,52 @@
+module Kapellmeister
+  class AddServiceGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+
+    desc <<-EOF
+      Prepares application to possibility to get third parties requests.
+    EOF
+
+    class_option :responder, type: :boolean, default: false
+
+    argument :attributes, type: :array, default: [], banner: 'attribute'
+
+    def copy_initializer_file
+      template 'initializers/add_service_initializer.rb', "config/initializers/#{file_name}.rb"
+    end
+
+    def copy_base_file
+      template 'lib/add_service.rb', "app/lib/#{file_name}.rb"
+    end
+
+    def copy_lib_folder
+      copy_client_file
+      copy_configuration_file
+      copy_responder_file
+      copy_routes_file
+    end
+
+    private
+
+    def copy_client_file
+      template 'lib/add_service/client.rb', "app/lib/#{file_name}/client.rb"
+    end
+
+    def copy_configuration_file
+      template 'lib/add_service/configuration.rb', "app/lib/#{file_name}/configuration.rb"
+    end
+
+    def copy_responder_file
+      return unless options[:responder]
+
+      template 'lib/add_service/responder.rb', "app/lib/#{file_name}/responder.rb"
+    end
+
+    def copy_routes_file
+      template 'lib/add_service/routes.yml', "app/lib/#{file_name}/routes.yml"
+    end
+
+    def initialize_signatures
+      attributes.map { |attr| attr.name.to_sym }
+    end
+  end
+end

data/lib/generators/kapellmeister/templates/initializers/third_party_initializer.rb.tt

@@ -0,0 +1,7 @@
+Rails.application.config.to_prepare do
+  <%= class_name %>.configure do |config|
+  <%- initialize_signatures.each do |attr| -%>
+    <%= "config.#{attr} = '#{attr}'" %>
+  <%- end -%>
+  end
+end

data/lib/generators/kapellmeister/templates/lib/third_party/client.rb.tt

@@ -0,0 +1 @@
+class <%= class_name %>::Client < Kapellmeister::Dispatcher; end

data/lib/generators/kapellmeister/templates/lib/third_party/configuration.rb.tt

@@ -0,0 +1,16 @@
+class <%= class_name %>::Configuration
+  attr_accessor <%= initialize_signatures.join(', ') %>
+
+  def initialize
+    @path = ''
+    @logger = ::Logger.new(Rails.env.development? ? $stdout : 'log/<%=file_name %>.log')
+  end
+
+  def url
+    raise "No given host to #{self.class.name}" unless host
+
+    https = ssl.presence || true
+
+    "URI::HTTP#{https.to_b ? 'S' : ''}".build(host:, path: [path, version].join('/'))
+  end
+end

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

@@ -0,0 +1,11 @@
+# NOTE: Small docs
+#   foo:                    => Wrapper for method
+#     bar:                  => Method name
+#       scheme:             => Scheme description
+#         method: POST      => Request type
+#         use_wrapper: true => Default true
+#         path: buz         => Real path
+#         mock:             => Mock for development
+#           token: blablabla
+#
+# Client.foo_bar { a: 'b' } => POST http://host/foo/buz DATA: { a: 'b' }

data/lib/generators/kapellmeister/templates/lib/third_party.rb.tt

@@ -0,0 +1,14 @@
+module <%= class_name %>
+  ROUTES = ::Kapellmeister::Base.routes_scheme_parse('app/lib/<%= file_name %>/routes.yml')
+
+  class << self
+    include ::Kapellmeister::Base
+
+  <%- initialize_signatures.each do |attr| -%>
+    <%= "def #{attr}" %>
+      <%= "@#{attr} ||= configuration.#{attr}" %>
+    <%= "end" %>
+
+  <%- end -%>
+  end
+end

data/lib/kapellmeister/base.rb

@@ -0,0 +1,54 @@
+module Kapellmeister::Base
+  def configuration
+    @configuration ||= self::Configuration.new
+  end
+
+  def report(data)
+    responder.new(data)
+  end
+
+  def configure
+    yield(configuration)
+  end
+
+  def logger
+    @logger ||= configuration.logger
+  end
+
+  def requests
+    @requests ||= generate_routes(self::ROUTES).transform_values! do |value|
+      value.except!(:use_wrapper)
+    end
+  end
+
+  def responder
+    @responder ||= defined?(self::Responder) ? self::Responder : Kapellmeister::Responder
+  end
+
+  def self.routes_scheme_parse(path)
+    YAML.safe_load(ERB.new(File.read(path)).result, aliases: true, permitted_classes: [Time]).deep_symbolize_keys
+  end
+end
+
+def generate_routes(json_scheme)
+  json_scheme.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.length.zero?
+
+    generate_routes(value).map { |deep_key, deep_value| mapping(deep_key, deep_value, key, scheme) }
+  end
+end
+
+def mapping(deep_key, deep_value, key, scheme)
+  old_path = deep_value[:path]
+  name = old_path.split('/').map { |part| part.gsub(/%<.*?>/, '') }.reject(&:empty?)
+  deep_value[:path] = [key, old_path].join('/')
+
+  use_wrapper = deep_value.key?(:use_wrapper) ? deep_value[:use_wrapper] : true
+  new_key = if name.size == 1
+              deep_key
+            else
+              use_wrapper ? [name.first.presence || key, deep_key].join('_').to_sym : deep_key
+            end
+  scheme[new_key] = deep_value
+end

data/lib/kapellmeister/dispatcher.rb

@@ -0,0 +1,80 @@
+require 'faraday_middleware'
+
+class Kapellmeister::Dispatcher
+  def self.inherited(base)
+    base.extend(RequestsExtension)
+
+    delegate :report, :configuration, :logger, to: base.module_parent
+
+    def custom_headers
+      @custom_headers ||= try(:headers) || {}
+    end
+
+    def custom_request_options
+      @custom_request_options ||= try(:request_options) || {}
+    end
+  end
+
+  FailedResponse = Struct.new(:success?, :response, :payload)
+
+  def connection_by(method, path, data = {})
+    headers_params = data.delete(:headers) || {}
+    requests_data = data.delete(:request) || {}
+
+    generated_connection = connection(additional_headers: headers_params, requests_data:)
+
+    case method.upcase.to_sym
+    when :GET
+      process generated_connection.get([path, data.to_query].compact_blank!.join('?'))
+    when :POST
+      process generated_connection.post(path, data.to_json)
+    when :PUT
+      process generated_connection.put(path, data.to_json)
+    else
+      raise "Library can't process method #{method} yet"
+    end
+  rescue Faraday::ConnectionFailed, Faraday::TimeoutError => e
+    failed_response(details: e.message)
+  end
+
+  private
+
+  def connection(additional_headers:, requests_data:)
+    ::Faraday.new(url: configuration.url,
+                  headers: headers_generate(**additional_headers),
+                  request: requests_generate(**requests_data)) do |faraday|
+      faraday.request :authorization, *authorization
+      faraday.request :json, content_type: 'application/json'
+      faraday.request :multipart
+      faraday.response :logger, logger
+      faraday.response :json, content_type: 'application/json; charset=utf-8'
+      faraday.adapter :typhoeus do |http|
+        http.timeout = 20
+      end
+    end
+  end
+
+  def headers_generate(**additional)
+    {
+      authority: Credentials.send_it.host,
+      accept: 'application/json, text/plain, */*',
+      **additional,
+      **custom_headers
+    }
+  end
+
+  def requests_generate(**requests_data)
+    {
+      **requests_data,
+      **custom_request_options
+    }
+  end
+
+  def process(data)
+    report(data).result
+  end
+
+  def failed_response(**args)
+    FailedResponse.new(false, { message: "#{self.class} no connection" }, { status: 555, **args })
+  end
+end

data/lib/kapellmeister/requests_extension.rb

@@ -0,0 +1,25 @@
+module Kapellmeister::RequestsExtension
+  def self.request_processing
+    proc do |name, request_data|
+      define_method name do |data = {}|
+        proc { |method:, path:, mock:| # rubocop:disable Lint/UnusedBlockArgument:
+          # return mock if ENV['APP_ENV'] == 'development'
+
+          path = path.split('/').map do |part|
+            next part unless part.include? '%<'
+
+            data.delete(part.match(/%<(.*)>/).to_a.last.to_sym)
+          end.join('/')
+
+          new.connection_by(method, path, data)
+        }.call(**request_data)
+      end
+    end
+  rescue NoMethodError
+    raise "You need to define #{self} class with connection_by method"
+  end
+
+  def self.extended(base)
+    base.module_parent.requests.each(&request_processing)
+  end
+end

data/lib/kapellmeister/responder.rb

@@ -0,0 +1,30 @@
+class Kapellmeister::Responder
+  Result = Struct.new(:success?, :response, :payload)
+  attr_reader :response, :payload
+
+  delegate :body, :status, to: :response
+
+  def initialize(response, **args)
+    @response = response
+    @payload = args
+  end
+
+  def result
+    error = !/2\d{2}/.match?(status.to_s)
+
+    Result.new(!error, parsed_body, { status: status }.merge(payload))
+  rescue JSON::ParserError => e
+    Result.new(false, e)
+  end
+
+  private
+
+  def parsed_body
+    return body if body.length == 0
+
+    case body
+    when Hash then body
+    else JSON.parse(body, symbolize_names: true, quirks_mode: true)
+    end
+  end
+end

data/lib/kapellmeister/version.rb

@@ -0,0 +1,3 @@
+module Kapellmeister
+  VERSION = '0.0.2'.freeze
+end

data/lib/kapellmeister.rb

@@ -0,0 +1 @@
+module Kapellmeister; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kapellmeister
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - DarkWater
@@ -31,32 +31,77 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.2
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.17'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 1.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '1.17'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: 1.17.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.5
 description: Contains third party routes parser
 email:
 - denis.arushanov@darkcreative.ru
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kapellmeister.gemspec
+- lib/generators/kapellmeister/add_service_generator.rb
+- lib/generators/kapellmeister/templates/initializers/third_party_initializer.rb.tt
+- lib/generators/kapellmeister/templates/lib/third_party.rb.tt
+- lib/generators/kapellmeister/templates/lib/third_party/client.rb.tt
+- lib/generators/kapellmeister/templates/lib/third_party/configuration.rb.tt
+- lib/generators/kapellmeister/templates/lib/third_party/responder.rb.tt
+- lib/generators/kapellmeister/templates/lib/third_party/routes.yml.tt
+- lib/kapellmeister.rb
+- lib/kapellmeister/base.rb
+- lib/kapellmeister/dispatcher.rb
+- lib/kapellmeister/requests_extension.rb
+- lib/kapellmeister/responder.rb
+- lib/kapellmeister/version.rb
 homepage: https://github.com/DarkWater666/kapellmeister
 licenses:
 - MIT