affiliation_id 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22c3498448dc238453b78b0ee487f46530e2f1f5f4df6795ddf84575c8688da5
-  data.tar.gz: 35fe8f9468138f049958da4d45bd831197f232ed80c4a3757ab18a630456ff62
+  metadata.gz: 35a5a46ef033ee61169a80dce4812d80ed06c0e53806dfe11f9758629b8e6e75
+  data.tar.gz: ec88467895ef1cd544ed846067d235dc3ddac81bed797a77f3f6530d40746fe3
 SHA512:
-  metadata.gz: 392593ddf433ed21d096440c3519b2e146cdab79d8e33616dd5e60544e850b24cc1bd4e57747bec2f6231406d3f018679a060272575f2e01c65cf37f8dca5024
-  data.tar.gz: da684bd4265d1907b6ccd7b42dcaf2c3aa8359854542399b8301e400942b19f1b6236dde0c7eb48acea7d994ddbb63c764ce4f229c528da8f645760b3d38fd73
+  metadata.gz: 0ed858f2409de3db4083879c2422d836b15d19b51aa4c365b17cf64d5cf51f414a2cb1e0cf0b063d01f50ad648a93cbfcb61859a783aa8b018ac98f44a23b7db
+  data.tar.gz: '09830569408ffc91ba83cfd7e35fb9d0847d6f5c60db0bbe3833a866652c2e32d1c927f4b5f80c2f1494a6dc3a7cf6b8a23367751bd34ed5f9af7c9c94b6afe2'

data/.overcommit.yml

@@ -0,0 +1,31 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+ RuboCop:
+   enabled: true
+   on_warn: fail # Treat all warnings as failures
+
+ TrailingWhitespace:
+   enabled: true
+
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rubocop.yml

@@ -1,5 +1,15 @@
 AllCops:
   TargetRubyVersion: 2.7
+  NewCops: enable
 
 Layout/LineLength:
   Max: 120
+
+# ====================================================
+# Metrics Cops
+# ====================================================
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - spec/**/*
+    - Guardfile

data/Gemfile

@@ -7,6 +7,12 @@ gemspec
 
 gem 'rake', '~> 13.0'
 
-gem 'rspec', '~> 3.0'
+group :test do
+  gem 'rspec', '~> 3.0'
+end
 
-gem 'rubocop', '~> 1.21'
+group :development, :test do
+  gem 'guard-rspec', '~> 4.7', '>= 4.7.3', require: false
+  gem 'overcommit', '~> 0.59.1', require: false
+  gem 'rubocop', '~> 1.21'
+end

data/Gemfile.lock

@@ -1,19 +1,65 @@
 PATH
   remote: .
   specs:
-    affiliation_id (0.1.0)
+    affiliation_id (0.2.0)
+      faraday (>= 0.17.0, < 3)
+      rack (>= 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    byebug (11.1.3)
+    childprocess (4.1.0)
+    coderay (1.1.3)
     diff-lcs (1.5.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.0)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    iniparse (1.5.0)
     json (2.6.2)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    overcommit (0.59.1)
+      childprocess (>= 0.6.3, < 5)
+      iniparse (~> 1.4)
+      rexml (~> 3.2)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.4)
     rainbow (3.1.1)
     rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -42,6 +88,9 @@ GEM
     rubocop-ast (1.19.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    shellany (0.0.1)
+    thor (1.2.1)
     unicode-display_width (2.2.0)
 
 PLATFORMS
@@ -49,6 +98,9 @@ PLATFORMS
 
 DEPENDENCIES
   affiliation_id!
+  byebug (~> 11.1, >= 11.1.3)
+  guard-rspec (~> 4.7, >= 4.7.3)
+  overcommit (~> 0.59.1)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/Guardfile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## NOTE: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,8 +1,21 @@
 # AffiliationId
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/affiliation_id`. To experiment with that code, run `bin/console` for an interactive prompt.
+AffiliationId is a middleware collection for different frameworks and gems with the purpose of making end-to-end request tracing as easy as possible.
 
-TODO: Delete this and the text above, and describe your gem
+The concept is really simple and it's meant to work like this:
+
+1. A request that reaches a web app or API it's the entry point and should have a unique ID.
+2. That ID is propagated throughout the app in all parts that are a consequence of the initial request, things like: requests to third-party APIs, Sidekiq jobs, error trackers, etc.
+3. The ID is included in  all the logs statements so they can be traced based on the ID
+
+Although there are tools like [OpenTelemetry](https://opentelemetry.io/), which is great, that is a much more complex tool and brings a lot of overhead that maybe is not worth it for some applications or teams.
+
+Currently implemented middleware:
+
+- Rack
+- Rails
+- Faraday
+- Sidekiq
 
 ## Installation
 
@@ -22,7 +35,125 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Under the hood AffiliationId uses `SecureRandom.uuid` to generate unique ID's when needed.
+
+```ruby
+# Get current ID
+AffiliationId.current_id
+=> '93f971bb-b889-4223-ac57-5d39f34051a4'
+```
+
+`.current_id` is memoized and subsequent calls will return the same value
+
+```ruby
+# Set ID
+AffiliationId.current_id = 'myID'
+
+AffiliationId.current_id
+=> 'myID'
+```
+
+```ruby
+# Overwrite current_id with a new generated value
+AffiliationId.current_id
+=> '93f971bb-b889-4223-ac57-5d39f34051a4'
+
+AffiliationId.renew_current_id!
+=>'55e94f67-5fce-4226-98d5-4c149684debe'
+
+AffiliationId.current_id
+=> '55e94f67-5fce-4226-98d5-4c149684debe'
+```
+
+```ruby
+# Reset/Clear current_id
+
+AffiliationId.current_id
+=> '55e94f67-5fce-4226-98d5-4c149684debe'
+
+AffiliationId.reset!
+=> nil
+```
+
+### Rack
+
+The middleware for rack based applications is inspired from the Rails version of this middleware [ActionDispatch::RequestId](https://api.rubyonrails.org/classes/ActionDispatch/RequestId.html).
+
+It looks at the `X-Affiliation-ID`, if the header is found and a value is present, this will be set as the `Affiliation.current_id` throughout the request, otherwise an random ID is generated.
+
+To use the middleware, it needs to be added to the app middleware stack.
+
+```ruby
+# config.ru
+require 'affiliation_id/middleware/rack'
+
+use AffiliationId::Middleware::Rack
+
+run MyApp.new
+```
+
+### Rails
+
+In true Rails fashion, this works out of the box after installing the gem. Although it still depends on [ActionDispatch::RequestId](https://api.rubyonrails.org/classes/ActionDispatch/RequestId.html) which is included by default in all new Rails apps.
+
+### Faraday
+
+By using the Faraday middleware the, all requests will include a header `X-Affiliation-ID` with the value of `AffiliationID.current_id`.
+
+```ruby
+require 'affiliation_id/middleware/faraday'
+
+# ...
+
+conn = Faraday.new do |f|
+  f.request :affiliation_id # include AffiliationID.current_id in the request headers
+  f.adapter :net_http # Use the Net::HTTP adapter
+end
+```
+
+### Sidekiq
+
+For more information on how [Sidekiq Middleware](https://github.com/mperham/sidekiq/wiki/Middleware) works, I suggest reading id directly from the Sidekiq documentation.
+
+Configuration example:
+
+```ruby
+# sidekiq_initializer.rb
+
+require 'affiliation_id/middleware/sidekiq_client'
+require 'affiliation_id/middleware/sidekiq_server'
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add AffiliationId::Middleware::SidekiqClient
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add AffiliationId::Middleware::SidekiqClient
+  end
+  config.server_middleware do |chain|
+    chain.add AffiliationId::Middleware::SidekiqServer
+  end
+end
+```
+
+## Configuration
+
+```ruby
+# affiliation_id_initializer.rb
+
+AffiliationId.configure do |config|
+  # By default AffiliationId.current_id will raise an AffiliationId::MissingCurrentId exception if the value was not previously set.
+  # To opt in to the behavior of generating the id automatically config the following setting to false.
+  # config.enforce_explicit_current_id = false (Default: true)
+
+  # AffiliationId uses 'X-Request-ID' as the default header name.
+  # This can be changed by the following config.
+  # config.header_name = 'My-Custom-Header' (Default: 'X-Request-ID')
+end
+```
 
 ## Development
 
@@ -32,7 +163,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/affiliation_id. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/affiliation_id/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/siklodi-mariusz/affiliation_id. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/siklodi-mariusz/affiliation_id/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +171,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the AffiliationId project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/affiliation_id/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the AffiliationId project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/siklodi-mariusz/affiliation_id/blob/main/CODE_OF_CONDUCT.md).

data/affiliation_id.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/affiliation_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'affiliation_id'
+  spec.version = AffiliationId::VERSION
+
+  spec.authors = ['Mariusz Siklodi']
+  spec.summary = 'Track requests by affiliating them with an uniq id.'
+  spec.homepage = 'https://github.com/siklodi-mariusz/affiliation_id'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'faraday', '>= 0.17.0', '< 3'
+  spec.add_dependency 'rack', '>= 1.4'
+
+  spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/setup

@@ -4,5 +4,6 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
+overcommit --install
 
 # Do any other automated setup that you need to do here

data/lib/affiliation_id/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module AffiliationId
+  class Configuration # :nodoc:
+    HEADER_NAME = 'X-Request-ID'
+    attr_accessor :enforce_explicit_current_id, :header_name
+
+    def initialize
+      @enforce_explicit_current_id = true
+      @header_name = HEADER_NAME
+    end
+  end
+end

data/lib/affiliation_id/middleware/faraday.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+require_relative '../../affiliation_id'
+
+module AffiliationId
+  module Middleware
+    #
+    # Faraday::Middleware for handling requests made with Faraday with affiliation_id
+    #
+    # Usage:
+    #   conn = Faraday.new do |f|
+    #     f.request :affiliation_id # include AffiliationID.current_id in the request headers
+    #     f.adapter :net_http # Use the Net::HTTP adapter
+    #    end
+    #
+    class Faraday < ::Faraday::Middleware
+      def call(env)
+        env[:request_headers][config.header_name] ||= AffiliationId.current_id
+
+        @app.call(env)
+      end
+
+      private
+
+      def config
+        AffiliationId.configuration
+      end
+    end
+  end
+end
+
+if Faraday::Request.respond_to? :register_middleware
+  Faraday::Request.register_middleware affiliation_id: AffiliationId::Middleware::Faraday
+end

data/lib/affiliation_id/middleware/rack.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../../affiliation_id'
+
+module AffiliationId
+  module Middleware
+    #
+    # Rack middleware to add Affiliation ID HTTP header to rack based web frameworks
+    #
+    class Rack
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        AffiliationId.current_id = header_from_env(env) || AffiliationId.renew_current_id!
+
+        @app.call(env).tap { |_status, headers, _body| headers[config.header_name] = AffiliationId.current_id }
+      ensure
+        AffiliationId.reset!
+      end
+
+      private
+
+      def header_from_env(env)
+        value = env["HTTP_#{config.header_name.upcase.tr('-', '_')}"]
+
+        value&.gsub(/[^\w\-@.]/, '')&.[](0...255)
+      end
+
+      def config
+        AffiliationId.configuration
+      end
+    end
+  end
+end

data/lib/affiliation_id/middleware/rails.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../../affiliation_id'
+
+module AffiliationId
+  module Middleware
+    class Rails # :nodoc:
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        req = ActionDispatch::Request.new env
+        AffiliationId.current_id = req.request_id
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/affiliation_id/middleware/sidekiq_client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative '../../affiliation_id'
+
+module AffiliationId
+  module Middleware
+    #
+    # Sidekiq client middleware to inject the AffiliationId.current_id in the Job
+    #
+    # When Sidekiq client pushes a job in queue, at minimum, the job contains the following attributes:
+    #
+    #   {
+    #     "class": "SomeWorker",
+    #     "jid": "b4a577edbccf1d805744efa9", // 12-byte random number as 24 char hex string
+    #     "args": [1, "arg", true],
+    #     "created_at": 1234567890,
+    #     "enqueued_at": 1234567890
+    #   }
+    #
+    # This middleware adds to this list of attributes the current value of AffiliationId.current_id.
+    # So, if AffiliationId.current_id returns a value of "93f971bb-b889-4223-ac57-5d39f34051a4",
+    # the end result will look something like this:
+    #
+    #   {
+    #     "class": "SomeWorker",
+    #     "jid": "b4a577edbccf1d805744efa9", // 12-byte random number as 24 char hex string
+    #     "args": [1, "arg", true],
+    #     "created_at": 1234567890,
+    #     "enqueued_at": 1234567890,
+    #     "affiliation_id": "93f971bb-b889-4223-ac57-5d39f34051a4"
+    #   }
+    #
+    #
+    class SidekiqClient
+      def call(_, job, _, _)
+        job[::AffiliationId::SIDEKIQ_JOB_KEY] = ::AffiliationId.current_id
+        yield
+      end
+    end
+  end
+end

data/lib/affiliation_id/middleware/sidekiq_server.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative '../../affiliation_id'
+
+module AffiliationId
+  module Middleware
+    #
+    # Sidekiq server middleware to set AffiliationId.current_id from the job hash
+    #
+    # Assuming AffiliationId::Middleware::SidekiqClient is used.
+    # All jobs pushed in the queue will include an affiliation_id
+    #
+    #   {
+    #     "class": "SomeWorker",
+    #     "jid": "b4a577edbccf1d805744efa9", // 12-byte random number as 24 char hex string
+    #     "args": [1, "arg", true],
+    #     "created_at": 1234567890,
+    #     "enqueued_at": 1234567890,
+    #     "affiliation_id": "93f971bb-b889-4223-ac57-5d39f34051a4"
+    #   }
+    #
+    # This middleware will take that value and set AffiliationId.current_id= to it.
+    #
+    # If there is no affiliation_id attribute in the job Hash, there is a fallback to AffiliationId.current_id,
+    # which depending on the configuration of :enforce_explicit_current_id raises an error or generates a new id.
+    #
+    class SidekiqServer
+      def call(_, job, _)
+        ::AffiliationId.current_id = job[::AffiliationId::SIDEKIQ_JOB_KEY] || ::AffiliationId.current_id
+        yield
+      ensure
+        AffiliationId.reset!
+      end
+    end
+  end
+end

data/lib/affiliation_id/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'middleware/rails'
+
+module AffiliationId
+  class Railtie < ::Rails::Railtie # :nodoc:
+    initializer 'affiliation_id.initializer' do |app|
+      app.middleware.insert_after ActionDispatch::RequestId, AffiliationId::Middleware::Rails
+    end
+
+    config.to_prepare do
+      AffiliationId.reset!
+    end
+  end
+end

data/lib/affiliation_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AffiliationId
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/affiliation_id.rb

@@ -1,8 +1,68 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 require_relative 'affiliation_id/version'
+require_relative 'affiliation_id/configuration'
+require_relative 'affiliation_id/middleware/faraday'
+require_relative 'affiliation_id/middleware/sidekiq_client'
+require_relative 'affiliation_id/middleware/sidekiq_server'
+require_relative 'affiliation_id/railtie' if defined?(Rails::Railtie)
+
+module AffiliationId # :nodoc:
+  THREAD_KEY      = 'AFFILIATION_ID'
+  SIDEKIQ_JOB_KEY = 'affiliation_id'
+
+  class << self
+    attr_writer :configuration
+
+    #
+    # Returns the current Affiliation ID
+    #
+    # @return [String] Uniq Affiliation ID
+    #
+    def current_id
+      raise MissingCurrentId if Thread.current[THREAD_KEY].nil? && configuration.enforce_explicit_current_id
+
+      Thread.current[THREAD_KEY] ||= SecureRandom.uuid
+    end
+
+    #
+    # Sets a new ID to be used as Affiliation ID
+    #
+    # @param [String] value of Affilication ID
+    #
+    # @return [String] Affiliation ID
+    #
+    def current_id=(value)
+      Thread.current[THREAD_KEY] = value
+    end
+
+    #
+    # Renew the current Affiliation ID with a new one
+    #
+    # @return [String] Affiliation ID
+    #
+    def renew_current_id!
+      Thread.current[THREAD_KEY] = SecureRandom.uuid
+    end
+
+    def reset!
+      Thread.current[THREAD_KEY] = nil
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
 
-module AffiliationId
-  class Error < StandardError; end
-  # Your code goes here...
+  class MissingCurrentId < StandardError # :nodoc:
+    def to_s
+      'Affiliation ID must be set explicitly'
+    end
+  end
 end

metadata

@@ -1,32 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: affiliation_id
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mariusz Siklodi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
-dependencies: []
+date: 2022-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
 description:
 email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- affiliation_id.gemspec
 - bin/console
 - bin/setup
 - lib/affiliation_id.rb
+- lib/affiliation_id/configuration.rb
+- lib/affiliation_id/middleware/faraday.rb
+- lib/affiliation_id/middleware/rack.rb
+- lib/affiliation_id/middleware/rails.rb
+- lib/affiliation_id/middleware/sidekiq_client.rb
+- lib/affiliation_id/middleware/sidekiq_server.rb
+- lib/affiliation_id/railtie.rb
 - lib/affiliation_id/version.rb
 homepage: https://github.com/siklodi-mariusz/affiliation_id
 licenses:
@@ -34,6 +98,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/siklodi-mariusz/affiliation_id
   source_code_uri: https://github.com/siklodi-mariusz/affiliation_id
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: