faraday-zipkin 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDY4YWE5Y2M1NTA1Mzg3ZDUzN2U1MmJkNDU3ZDQ1YjNiYjBiZGFjOQ==
+  data.tar.gz: !binary |-
+    MWFmOTVjMWIyOGEwZjRkODc2MDQ5YTY0ZWNiMWVmZTFmMDRlMDZhNA==
+SHA512:
+  metadata.gz: !binary |-
+    NjhiMzE5YWRlNzE3ZWVjODU3ZWYzZTI0ZTg4ZjIwMzQ0NDZmODI1YzVmMzVj
+    NWY2MmYyZTJjMDM4NDI4MmZmNjMzN2I2YjZiMmU5OWI2ODRkMGJiY2QxYTkx
+    NmEwN2ViNzQwM2I2OGVkOTQ5ZGZmNzZkOWJjYzNhMmVjMjUwZTQ=
+  data.tar.gz: !binary |-
+    MTAxZTc4NDEzNzgyZTVjNmM4NWVlZWUzYTBmNzQ1ZTI5YjZhNjhhNjIyOWJm
+    MTBiZjI0Y2FlODE5Y2U3NzViNDE1M2Y2MDE2NTZhM2ZmZWUzM2FjOWZkNDA0
+    YjM4MjQ2MzhkYjM1ZDkyNDU3ZTViZGU5ZDU5OTcyZWFkNmMzNGU=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in faraday-zipkin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ariel Salomon
+
+MIT License
+
+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,32 @@
+# Faraday::Zipkin
+
+Faraday middleware to generate Zipkin tracing headers.
+
+Note that you should also be using the zipkin-tracer Rack middleware
+to generate trace IDs around your requests:
+https://github.com/twitter/zipkin/tree/master/zipkin-gems/zipkin-tracer
+
+Zipkin tracing headers are documented at
+https://github.com/twitter/zipkin/blob/master/doc/collector-api.md
+ 
+## Usage
+
+Include Faraday::Zipkin::TraceHeaders as a Faraday middleware:
+
+    require 'faraday'
+    require 'faraday/zipkin'
+    
+    conn = Faraday.new(:url => 'http://localhost:9292/') do |faraday|
+      faraday.use Faraday::Zipkin::TraceHeaders
+      # default Faraday stack
+      faraday.request :url_encoded
+      faraday.adapter Faraday.default_adapter
+    end
+ 
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/faraday-zipkin/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/faraday-zipkin.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday/zipkin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday-zipkin"
+  spec.version       = Faraday::Zipkin::VERSION
+  spec.authors       = ["Ariel Salomon"]
+  spec.email         = ["asalomon@lookout.com"]
+  spec.summary       = %q{Faraday middleware to generate Zipkin tracing headers.}
+  spec.description   = %q{Faraday middleware to generate Zipkin tracing headers.}
+  spec.homepage      = "https://github.com/Oscil8/faraday-zipkin"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", ">= 0.8"
+  spec.add_dependency "thrift", "~> 0.9.0"
+  spec.add_dependency "finagle-thrift", "~> 1.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "thin" # required for finagle-thrift
+end

data/lib/faraday/zipkin/version.rb

@@ -0,0 +1,5 @@
+module Faraday
+  module Zipkin
+    VERSION = "0.0.1"
+  end
+end

data/lib/faraday/zipkin.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+
+require "faraday/zipkin/version"
+
+module Faraday
+  module Zipkin
+    class TraceHeaders < ::Faraday::Middleware
+      B3_HEADERS = {
+        :trace_id => "X-B3-TraceId",
+        :parent_id => "X-B3-ParentSpanId",
+        :span_id => "X-B3-SpanId",
+        :sampled => "X-B3-Sampled",
+        :flags => "X-B3-Flags"
+      }.freeze
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        trace_id = ::Trace.id
+        B3_HEADERS.each do |method, header|
+          env[:request_headers][header] = trace_id.send(method).to_s
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,80 @@
+require 'faraday/zipkin'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

data/spec/zipkin_trace_headers_spec.rb

@@ -0,0 +1,29 @@
+describe Faraday::Zipkin::TraceHeaders do
+  let(:middleware) { described_class.new(lambda{|env| env}) }
+
+  def process(body, headers={})
+    env = {
+      :body => body,
+      :request_headers => Faraday::Utils::Headers.new(headers),
+    }
+    middleware.call(env)
+  end
+
+  context 'request' do
+    context 'with tracing id' do
+      let(:trace_id) { ::Trace::TraceId.new(1, 2, 3, true, ::Trace::Flags::EMPTY) }
+
+      it 'sets the X-B3 request headers' do
+        result = nil
+        ::Trace.push(trace_id) do
+          result = process('')
+        end
+        expect(result[:request_headers]['X-B3-TraceId']).to eq('0000000000000001')
+        expect(result[:request_headers]['X-B3-ParentSpanId']).to eq('0000000000000002')
+        expect(result[:request_headers]['X-B3-SpanId']).to eq('0000000000000003')
+        expect(result[:request_headers]['X-B3-Sampled']).to eq('true')
+        expect(result[:request_headers]['X-B3-Flags']).to eq('0')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: faraday-zipkin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ariel Salomon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: thrift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: finagle-thrift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: thin
+  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: Faraday middleware to generate Zipkin tracing headers.
+email:
+- asalomon@lookout.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- faraday-zipkin.gemspec
+- lib/faraday/zipkin.rb
+- lib/faraday/zipkin/version.rb
+- spec/spec_helper.rb
+- spec/zipkin_trace_headers_spec.rb
+homepage: https://github.com/Oscil8/faraday-zipkin
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Faraday middleware to generate Zipkin tracing headers.
+test_files:
+- spec/spec_helper.rb
+- spec/zipkin_trace_headers_spec.rb