semlogr-faraday 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49b7851150bc4dc0e64ddb2a2b790888a3d5705f15df1656dc6dd35cf28521db
+  data.tar.gz: 07f786bd6eef15486aee52b3637a53ca8f078f1c8a62a127792e0176c16bc5ce
+SHA512:
+  metadata.gz: f694f3f36680d656b425bdb5dd41dc58e239ab2b8eaa1f89384347bb58daa08b6b8b503d9546e5c48c052a471be7c8751201ea8495df89ffe593367fe6f19569
+  data.tar.gz: 889fc17386e499d8f8ecd6364a4a3556e2670b45cf7ae2df593475587d7e7d3ba56b57bc7c8e84a69b3076f57e59c94a72a0ceaf0adcdd4b1ec2d39bdbce2ef1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Documentation:
+  Enabled: false
+OrderedGems:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Do not use Rubocop to enforce complexity rules, these will me
+# managed via the PR prorcess to not let in clearly complex code.
+Metrics/ClassLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+### 0.1.2
+
+- Change request logger to log only path without query string
+
+### 0.1.1
+
+- Add support for filtering requests by path for the request logger
+- Add log correlator middleware which provides the ability to propogate a correlation id from a request header to the Semlogr ambient log context
+
+### 0.1.0
+
+- Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Semlogr
+
+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,47 @@
+![Codeship Status for semlogr/semlogr-faraday](https://codeship.com/projects/48b7dd70-8499-0136-e016-5e4de864be62/status?branch=master)
+
+# Semlogr integration for Faraday
+
+This integration provides the ability to propogate a correlation id from the current log Semlogr context to
+your outgoing Faraday requests.
+
+## Installation
+
+To install:
+
+    gem install semlogr-faraday
+
+Or if using bundler, add semlogr to your Gemfile:
+
+    gem 'semlogr-faraday'
+
+then:
+
+    bundle install
+
+## Getting Started
+
+Simply configure the RequestCorrelator middleware on your Faraday instance, it will propogate the `correlation_id` property from your current Semlogr ambient log context as an outgoing X-Correlation-Id header on the request.
+
+This can be used in combination with the [semlogr-rack](https://github.com/semlogr/semlogr-rack) extension to
+provide a full end to end proprogation of correlation ids between your services.
+
+```ruby
+require 'semlogr/faraday'
+
+faraday = Faraday.new 'http://test.com' do |c|
+  c.request :semlogr_request_correlator
+
+  c.adapter Faraday.default_adapter
+end
+
+faraday.get('/test')
+```
+
+## Development
+
+After cloning the repository run `bundle install` to get up and running, to run the specs just run `rake spec`.
+
+## Contributing
+
+See anything broken or something you would like to improve? feel free to submit an issue or better yet a pull request!

data/Rakefile

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

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'semlogr/faraday'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/semlogr/faraday/request_correlator.rb

@@ -0,0 +1,20 @@
+require 'semlogr'
+
+module Semlogr
+  module Faraday
+    class RequestCorrelator
+      def initialize(app, opts = {})
+        @app = app
+        @id_property = opts[:id_property] || :correlation_id
+        @id_header = opts[:id_header] || 'X-Correlation-Id'
+      end
+
+      def call(env)
+        correlation_id = Semlogr::LogContext.get_property(@id_property)
+        env[:request_headers][@id_header] = correlation_id if correlation_id
+
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/semlogr/faraday/version.rb

@@ -0,0 +1,5 @@
+module Semlogr
+  module Faraday
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/semlogr/faraday.rb

@@ -0,0 +1,12 @@
+require 'semlogr/faraday/request_correlator'
+require 'faraday'
+
+module Semlogr
+  module Faraday
+    if ::Faraday::Middleware.respond_to?(:register_middleware)
+      ::Faraday::Request.register_middleware(
+        semlogr_request_correlator: -> { Semlogr::Faraday::RequestCorrelator }
+      )
+    end
+  end
+end

data/semlogr-faraday.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'semlogr/faraday/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'semlogr-faraday'
+  spec.version       = Semlogr::Faraday::VERSION
+  spec.authors       = ['Stefan Sedich']
+  spec.email         = ['stefan.sedich@gmail.com']
+
+  spec.summary       = 'Semlogr integration for faraday.'
+  spec.description   = 'Semlogr integration for faraday providing features such as correlation id propogation.'
+  spec.homepage      = 'https://github.com/semlogr/semlogr-faraday'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.12'
+  spec.add_dependency 'semlogr', '~> 0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.53'
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: semlogr-faraday
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Sedich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-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.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: semlogr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+description: Semlogr integration for faraday providing features such as correlation
+  id propogation.
+email:
+- stefan.sedich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/semlogr/faraday.rb
+- lib/semlogr/faraday/request_correlator.rb
+- lib/semlogr/faraday/version.rb
+- semlogr-faraday.gemspec
+homepage: https://github.com/semlogr/semlogr-faraday
+licenses: []
+metadata: {}
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Semlogr integration for faraday.
+test_files: []