ms_header_trail 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6bc222d2e57099d4d6e318372f496e58a1bf549e0becf485b2fe11f5af0e9f2
+  data.tar.gz: da9b2a4f6fc1976441e305201801b9d34ffab86a21d156f614e9e84a052c3d96
+SHA512:
+  metadata.gz: 9c0471b0c4b26c6178a09dae300506d502af588b3fcb14d81ffcc027acb3b6f02249704779f16da4d95770c6e049278464a87e123c9fd6dd81f8236ef60b888d
+  data.tar.gz: b4186c2f09842f5fefc6f53a75ab1edcf2c8c5d8b3478c8fc4ad5d848eac96a6cad1ab5f3d0c9e1ea8567d3c5a6c578491ff658669969292ec37ae2861b82abe

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-04
+
+- Initial release
+- Process the data into headers and retrieve from header ENV

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Adriano Dadario
+
+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 @@
+# Microservice Header Trail
+
+The objective is pass through all microservices the information captured into first interface and sending them when it is necessary.
+
+This gem operates including the captured information and passing through the HTTP header.
+It contains an interface for defining the attributes, a rack middleware to retrieve from
+header, a faraday middleware to include the information for next microservice and a interface to retrieve the information.
+
+![Example usage](./doc/usage.jpg)
+
+## Installation
+
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ms_header_trail
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install ms_header_trail
+
+## Usage
+
+Setup the project with rack middleware and includes the middleware into the microsservices
+
+```ruby
+config.middleware.use Rack::MsHeaderTrail
+```
+
+When calling the the service, use the faraday middleware to call the microservice
+
+```ruby
+Faraday.new(configuration.host) do |builder|
+    builder.request :json
+    builder.response :json, content_type: /\bjson$/
+    builder.use Faraday::MsHeaderTrail
+    builder.adapter Faraday.default_adapter
+end
+```
+
+When start collect information, initiate the process using the code
+
+```ruby
+MsHeaderTrail.collect(
+  user_id: '123',
+  user_type: 'employee'
+  interface: 'portal'
+)
+```
+
+To retrieve the information on any microservice, just use:
+
+```ruby
+data = MsHeaderTrail.retrieve
+=>
+{
+  user_id: '123',
+  user_type: 'employee'
+  interface: 'portal'
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ms_header_trail.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/faraday/ms_header_trail.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "ms_header_trail"
+require "faraday"
+
+module Faraday
+  # Public: Faraday middleware that stores audit data local thread into http header
+  # request
+  #
+  # Examples
+  #
+  #  Faraday.new(configuration.host) do |builder|
+  #    builder.use Faraday::MsHeaderTrail
+  #
+  class MsHeaderTrail < Faraday::Middleware
+    RESPONSE_HEADER_PREFIX = "X-"
+
+    def initialize(app, options = nil)
+      super
+      @app = app
+    end
+
+    def call(env)
+      ::MsHeaderTrail.retrieve.each_pair do |key, value|
+        set_header(env, key, value)
+      end
+      @app.call(env)
+    end
+
+    private
+
+    def set_header(env, key, value)
+      env[:request_headers][header_attr_name(key)] = value
+    end
+
+    def header_attr_name(key)
+      "#{header_prefix_name}-#{header_key(key)}"
+    end
+
+    def header_key(key)
+      key.to_s.split(/[-_]/).map(&:capitalize).join("-")
+    end
+
+    def header_prefix_name
+      "#{RESPONSE_HEADER_PREFIX}#{::MsHeaderTrail.configuration.http_response_prefix_keyname}"
+    end
+  end
+end

data/lib/ms_header_trail/configuration.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MsHeaderTrail
+  # Class responsible for configure the process
+  class Configuration
+    # Key to identify the data included into process, default: msht-
+    attr_accessor :prefix_keyname
+
+    # If the header should be returned into rack response, default: false
+    attr_accessor :rack_header_response
+
+    def initialize
+      @prefix_keyname = "msht-"
+    end
+
+    def to_store(key)
+      "#{prefix_keyname}#{key}"
+    end
+
+    def from_store(key)
+      key.to_s.gsub(prefix_keyname, "").to_sym
+    end
+
+    def http_request_prefix_keyname
+      prefix_keyname.gsub("-", "_").upcase
+    end
+
+    def http_response_prefix_keyname
+      prefix_keyname.to_s.split(/[-_]/).map(&:capitalize).join("-")
+    end
+  end
+end

data/lib/ms_header_trail/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MsHeaderTrail
+  VERSION = "0.1.1"
+end

data/lib/ms_header_trail.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "ms_header_trail/version"
+
+# Rack autoload module
+module Rack
+  autoload :MsHeaderTrail, "rack/ms_header_trail"
+end
+
+# This service include the collected information passed into method `collect`
+# to be retrieved later where will be used. In rack process, faraday connection
+# or Bunny process
+module MsHeaderTrail
+  autoload :Configuration, "ms_header_trail/configuration"
+
+  class << self
+    # Public: Collect the given parameters, which is set by user on
+    # start the capture process or during the Rack middleware
+    def collect(attributes)
+      attributes.each_pair do |key, value|
+        set(configuration.to_store(key), value.to_s)
+      end
+    end
+
+    # Public: Retrive the stored parameters, which was set by user
+    # during the Rack middleware, faraday connection or manually
+    def retrieve
+      Thread.current
+            .keys
+            .select { |key| key.start_with?(configuration.prefix_keyname) }
+            .each_with_object({}) { |key, memo| memo[configuration.from_store(key)] = get(key) }
+    end
+
+    # Public: Execute a block code after data collected
+    def with(attributes)
+      collect(attributes)
+      yield
+    end
+
+    # Public: Retrieve the given key
+    def get(key)
+      Thread.current[key]
+    end
+
+    # Public: Set the given key to the given value
+    def set(key, value)
+      Thread.current[key] = value
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Public: Configure the process.
+    #
+    # Examples
+    #
+    #   MsHeaderTrail.configure do |config|
+    #     config.prefix_keyname = 'msht-'
+    #   end
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/rack/ms_header_trail.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Rack
+
+  # Public: Rack middleware that stores the collection data from header in a
+  # thread local variable.
+  #
+  # Examples
+  #
+  #   use Rack::MsHeaderTrail
+  class MsHeaderTrail
+    REQUEST_HEADER_PREFIX  = "HTTP_X_"
+    RESPONSE_HEADER_PREFIX = "X-"
+
+    def initialize(app, options = nil)
+      @app = app
+      @options = options
+    end
+
+    def call(env)
+      ::MsHeaderTrail.with(retrive_from_header(env)) do
+        status, headers, body = @app.call(env)
+
+        into_headers(headers) if ::MsHeaderTrail.configuration.rack_header_response
+
+        [status, headers, body]
+      end
+    end
+
+    private
+
+    def retrive_from_header(env)
+      env.keys
+         .select { |key| header_key?(key) }
+         .each_with_object({}) { |key, memo| memo[local_attr_name(key)] = env[key] }
+    end
+
+    def into_headers(headers)
+      ::MsHeaderTrail.retrieve.each_pair do |key, value|
+        headers[response_attr_name(key)] = value
+      end
+    end
+
+    def response_attr_name(key)
+      "#{response_prefix_name}-#{response_key(key)}"
+    end
+
+    def response_key(key)
+      key.to_s.split(/[-_]/).map(&:capitalize).join("-")
+    end
+
+    def header_key?(key)
+      key.to_s.start_with?(request_prefix_name)
+    end
+
+    def local_attr_name(key)
+      key.to_s.gsub(request_prefix_name, "").downcase
+    end
+
+    def response_prefix_name
+      "#{RESPONSE_HEADER_PREFIX}#{::MsHeaderTrail.configuration.http_response_prefix_keyname}"
+    end
+
+    def request_prefix_name
+      "#{REQUEST_HEADER_PREFIX}#{::MsHeaderTrail.configuration.http_request_prefix_keyname}"
+    end
+  end
+end

data/sig/ms_header_trail.rbs

@@ -0,0 +1,4 @@
+module MsHeaderTrail
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: ms_header_trail
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Adriano Dadario
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+description: 
+email:
+- dadario@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/usage.jpg
+- lib/faraday/ms_header_trail.rb
+- lib/ms_header_trail.rb
+- lib/ms_header_trail/configuration.rb
+- lib/ms_header_trail/version.rb
+- lib/rack/ms_header_trail.rb
+- sig/ms_header_trail.rbs
+homepage: https://github.com/dadario/ms_header_trail
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dadario/ms_header_trail
+  source_code_uri: https://github.com/dadario/ms_header_trail
+  changelog_uri: https://github.com/dadario/ms_header_trail/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Transport collected data through HTTP header from microservices requests.
+test_files: []