correlation_id 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6266047a4e8c34208e1fa280278cc356e3c36521
+  data.tar.gz: a1d7e3b675b127b9ddd499b9cec20dfa96060fbe
+SHA512:
+  metadata.gz: 13a310538fcf3892aca406a97ebae211994375c0a7493a1cad30d217f17468ead75fc76314e7fcb5d4eb497cf86c50b80b4e41d9295a64f96ba88c6177518f09
+  data.tar.gz: ea0ffa171d5c879a6c43b97c41773e5e2877d6f34a1e6fe19f117df96252704b0194dd5c9e566c713f5a4028988440367b05a4cfc3334bbea75c2e2e6c3039fa

data/README.md

@@ -0,0 +1,92 @@
+# CorrelationId (System:MES,Squad:publisher,Type:Component)
+Provides correllation id implementation.
+
+## Technology
+* ruby
+
+## Build
+[![Build Status](https://travis-ci.com/glomex/correlation_id.svg?token=mwYidZuSA2BCP1MMZkGB&branch=master)](https://travis-ci.com/glomex/correlation_id)
+
+Allows correlation tracking from request down the network stack
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'correlation_id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install correlation_id
+
+
+## Usage
+
+### Rails
+
+You need just add gem to your Gemfile somewhere after `rails`.
+
+### Rack
+
+You need to add our middleware to the top of your middlewares `config.ru`.
+
+```ruby
+use CorrelationId::Middleware::Rack
+```
+
+### Airbrake
+
+You need to add our Airbrake filter after configuring Airbrake
+
+```ruby
+Airbrake.configure do |c|
+  c.project_id = ENV['AIRBRAKE_PROJECT_ID']
+  c.project_key = ENV['AIRBRAKE_PROJECT_KEY']
+end
+
+Airbrake.add_filter(CorrelationId::Middleware::Airbrake)
+```
+
+### Faraday
+
+You need to add gem after faraday and add middleware when you create Faraday connection.
+
+**Example:**
+
+```ruby
+conn = Faraday.new 'http://example.com' do |faraday|
+  faraday.request :correlation_id
+  faraday.adapter Faraday.default_adapter
+end
+conn.get('/page')
+```
+
+## 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 tags, 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/glomex/correlation_id. 
+This project is intended to be a safe, welcoming space for collaboration, and contributors are 
+expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/correlation_id.rb

@@ -0,0 +1,47 @@
+require 'securerandom'
+
+require 'correlation_id/version'
+
+require 'correlation_id/middleware/airbrake' if defined?(Airbrake)
+require 'correlation_id/middleware/faraday' if defined?(Faraday)
+require 'correlation_id/middleware/rack' if defined?(Rack)
+require 'correlation_id/middleware/railtie' if defined?(Rails)
+
+module CorrelationId
+  HEADER_KEY = 'X-Correlation-ID'.freeze
+  THREAD_KEY = 'CORRELATION_UUID'.freeze
+
+  class << self
+    def uuid
+      Thread.current[THREAD_KEY] ||= _uuid
+    end
+
+    def uuid!
+      Thread.current[THREAD_KEY] = _uuid
+    end
+
+    def uuid=(value)
+      Thread.current[THREAD_KEY] = value
+    end
+
+    def disable
+      using_uuid(_uuid) { yield }
+    end
+
+    def using_uuid(new_uuid)
+      old_uuid = uuid
+
+      self.uuid = new_uuid
+      result = yield
+      self.uuid = old_uuid
+
+      result
+    end
+
+    private
+
+    def _uuid
+      SecureRandom.uuid
+    end
+  end
+end

data/lib/correlation_id/middleware/airbrake.rb

@@ -0,0 +1,9 @@
+module CorrelationId
+  module Middleware
+    class Airbrake
+      def self.call(notice)
+        notice[:context][:correlation_id] = CorrelationId.uuid
+      end
+    end
+  end
+end

data/lib/correlation_id/middleware/faraday.rb

@@ -0,0 +1,12 @@
+module CorrelationId
+  module Middleware
+    class Faraday < ::Faraday::Middleware
+      def call(env)
+        env.request_headers[HEADER_KEY] = CorrelationId.uuid
+        @app.call(env)
+      end
+    end
+
+    ::Faraday::Request.register_middleware correlation_id: -> { Faraday }
+  end
+end

data/lib/correlation_id/middleware/rack.rb

@@ -0,0 +1,24 @@
+module CorrelationId
+  module Middleware
+    class Rack
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        CorrelationId.uuid = header_from_env(env)
+
+        status, headers, body = @app.call(env)
+
+        headers = headers.merge(HEADER_KEY => CorrelationId.uuid)
+        [status, headers, body]
+      end
+
+      private
+
+      def header_from_env(env)
+        env["HTTP_#{HEADER_KEY.upcase.tr('-', '_')}"]
+      end
+    end
+  end
+end

data/lib/correlation_id/middleware/railtie.rb

@@ -0,0 +1,12 @@
+module CorrelationId
+  module Middleware
+    class Railtie < ::Rails::Railtie
+      initializer('correlation_id.middleware') do |app|
+        app.config.middleware.insert(
+          0,
+          CorrelationId::Middleware::Rack
+        )
+      end
+    end
+  end
+end

data/lib/correlation_id/version.rb

@@ -0,0 +1,3 @@
+module CorrelationId
+  VERSION = '0.2.1'.freeze
+end

data/spec/correlation_id/middleware/airbrake_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe CorrelationId::Middleware::Airbrake do
+  let(:project_id) { 123_456 }
+  let(:project_key) { 'project_key' }
+  let(:airbrake_endpoint) do
+    "https://airbrake.io/api/v3/projects/#{project_id}/notices"
+  end
+
+  before do
+    Airbrake.configure do |c|
+      c.project_id = project_id
+      c.project_key = project_key
+    end
+
+    Airbrake.add_filter(CorrelationId::Middleware::Airbrake)
+  end
+
+  describe 'X-Correlation-ID' do
+    before do
+      stub_request(:post, airbrake_endpoint).to_return(status: 201)
+      Airbrake.notify_sync('my error')
+    end
+
+    it 'sets header' do
+      body = /"correlation_id":"#{CorrelationId.uuid}"/
+      expect(a_request(:post, airbrake_endpoint).with(body: body)).to have_been_made.once
+    end
+  end
+end

data/spec/correlation_id/middleware/faraday_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+RSpec.describe CorrelationId::Middleware::Faraday do
+  let(:conn) do
+    Faraday.new 'http://example.com' do |faraday|
+      faraday.request :correlation_id
+      faraday.adapter Faraday.default_adapter
+    end
+  end
+
+  describe 'X-Correlation-ID' do
+    let(:request) do
+      a_request(:get, 'http://example.com/').with(headers: { 'X-Correlation-ID' => uuid })
+    end
+
+    let!(:response) do
+      CorrelationId.uuid = uuid
+
+      stub_request(:get, 'http://example.com/')
+        .with(headers: { 'X-Correlation-ID' => uuid })
+        .to_return(status: 200, headers: { 'X-Correlation-ID' => uuid })
+
+      conn.get('/')
+    end
+
+    it 'sets header' do
+      expect(request).to have_been_made.once
+      expect(response.headers['X-Correlation-ID']).to eq(uuid)
+    end
+  end
+end

data/spec/correlation_id/middleware/rack_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+RSpec.describe CorrelationId::Middleware::Rack do
+  let(:app) do
+    Rack::Builder.app do
+      use CorrelationId::Middleware::Rack
+      use Rack::Heartbeat
+      run(proc {})
+    end
+  end
+
+  it_behaves_like 'rack app'
+end

data/spec/correlation_id/middleware/railtie_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+RSpec.describe CorrelationId::Middleware::Railtie do
+  let(:app) do
+    Rack::Builder.app do
+      run DummyApp
+    end
+  end
+
+  it_behaves_like 'rack app'
+end

data/spec/correlation_id_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+RSpec.describe CorrelationId do
+  it 'has a version number' do
+    expect(described_class::VERSION).not_to be nil
+  end
+
+  describe '.uuid' do
+    def subject
+      described_class.uuid
+    end
+
+    it 'generates uuid' do
+      expect(subject).to be
+    end
+
+    it 'generates same id for one request' do
+      expect(Array.new(5) { subject }.uniq).to be_one
+    end
+  end
+
+  describe '.uuid!' do
+    def subject
+      described_class.uuid!
+    end
+
+    it 'generates uuid' do
+      expect(subject).to be
+    end
+
+    it 'generates new id for each request' do
+      expect(Array.new(5) { subject }.uniq.length).to eq(5)
+    end
+
+    it 'stores uuid' do
+      generated = subject
+      retrieved = described_class.uuid
+
+      expect(generated).to eq(retrieved)
+    end
+  end
+
+  describe '.uuid=' do
+    let(:uuid) { SecureRandom.uuid }
+
+    before { described_class.uuid = uuid }
+
+    it 'sets uuid' do
+      expect(described_class.uuid).to eq(uuid)
+    end
+  end
+
+  describe '.disable' do
+    let(:uuid) { SecureRandom.uuid }
+
+    before { described_class.uuid = uuid }
+
+    it 'can be temporarily disable' do
+      expect(described_class.uuid).to eq(uuid)
+
+      described_class.disable do
+        expect(described_class.uuid).to be
+        expect(described_class.uuid).not_to eq(uuid)
+      end
+
+      expect(described_class.uuid).to eq(uuid)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+
+require 'airbrake'
+require 'net/http'
+require 'faraday'
+require 'rack/test'
+require 'rack-heartbeat'
+require 'webmock/rspec'
+require 'rails'
+require 'correlation_id'
+
+Dir['./spec/support/**/*'].sort.each(&method(:require))
+
+Rack::Heartbeat.heartbeat_path = ''
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.include Rack::Test::Methods
+
+  config.include SpecHelpers
+end

data/spec/support/dummy_app.rb

@@ -0,0 +1,21 @@
+require 'action_controller/railtie'
+
+class DummyApp < Rails::Application
+  config.session_store :cookie_store, key: 'd9cb0a8a7e5a2dd295fcb51ae81a2187'
+  config.secret_token = '94e56772b226b2b9fe20f9fd882e7f35'
+  config.secret_key_base = '80a0c6d167742a32428ec7a75edeea48'
+
+  config.eager_load = false
+
+  routes.draw do
+    get '/' => 'dummy#index'
+  end
+
+  class DummyController < ActionController::API
+    def index
+      render json: { hello: :world }
+    end
+  end
+end
+
+DummyApp.initialize!

data/spec/support/rack_app_behaviour.rb

@@ -0,0 +1,22 @@
+RSpec.shared_examples 'rack app' do
+  describe 'X-Correlation-ID' do
+    context 'without header' do
+      before { get '/' }
+
+      it 'is set' do
+        expect(last_response.headers).to have_key('X-Correlation-ID')
+      end
+    end
+
+    context 'with header' do
+      before do
+        header 'X-Correlation-ID', uuid
+        get '/'
+      end
+
+      it 'is proxied' do
+        expect(last_response.headers['X-Correlation-ID']).to eq(uuid)
+      end
+    end
+  end
+end

data/spec/support/spec_helpers.rb

@@ -0,0 +1,5 @@
+module SpecHelpers
+  extend RSpec::SharedContext
+
+  let(:uuid) { SecureRandom.uuid }
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: correlation_id
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Alex Tonkonozhenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rack-heartbeat
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Allows correlation tracking from request down the network stack
+email:
+- alex@tonkonozhenko.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/correlation_id.rb
+- lib/correlation_id/middleware/airbrake.rb
+- lib/correlation_id/middleware/faraday.rb
+- lib/correlation_id/middleware/rack.rb
+- lib/correlation_id/middleware/railtie.rb
+- lib/correlation_id/version.rb
+- spec/correlation_id/middleware/airbrake_spec.rb
+- spec/correlation_id/middleware/faraday_spec.rb
+- spec/correlation_id/middleware/rack_spec.rb
+- spec/correlation_id/middleware/railtie_spec.rb
+- spec/correlation_id_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_app.rb
+- spec/support/rack_app_behaviour.rb
+- spec/support/spec_helpers.rb
+homepage: https://github.com/glomex/correlation_id
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Allows correlation tracking from request down the network stack
+test_files:
+- spec/correlation_id/middleware/airbrake_spec.rb
+- spec/correlation_id/middleware/faraday_spec.rb
+- spec/correlation_id/middleware/rack_spec.rb
+- spec/correlation_id/middleware/railtie_spec.rb
+- spec/correlation_id_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_app.rb
+- spec/support/rack_app_behaviour.rb
+- spec/support/spec_helpers.rb