faraday-zipkin 0.2.2 → 0.2.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmM0ZTc5MjhmMTJkODNiYjg1MjEyODM2MDJiMGI0YmNjMDJhMjRhZg==
+    Y2QxNTk2MzUxOTIwZTBkNTI0OTJmNzAxNzYzOTJmNTQ2MTgwZWE4Ng==
   data.tar.gz: !binary |-
-    NjI3MmUxMTFkNjVjODc5NTZhOThlODVkNTg4M2U5N2I1MmFkNTc4Yw==
+    NjZhNTUyYWY0YmQyOTZjNDM5ZTVhNDE2MzRmZTYxYWE1Yzc3MDhjYQ==
 SHA512:
   metadata.gz: !binary |-
-    MWNmNDA4ZGFjMWU5MzVlNDI4YjFmNDRkNzkyOGQ4NTZhY2Q0Y2IxZmQzMDZl
-    M2UyNTQ4ZTMzYWQ3MDEyNzRjMjMwYjFkODg3MGY4ZDkzYTdiNDYwM2FjMWEz
-    NzBiYTAxMjY2NzJiODhkOTk4YTM1ZDk3NzQ2MzkyZmY1ZWM4ZDQ=
+    NWI5NDExYTlmYWNmOWU5NGVkMzhjM2M2MGUxZjk3ZGFkYjRlYjE2YjFmOWY3
+    OTdiZDBjNjA4M2U3ZTczNTUyMzkzZjBiYmIzYmU0M2VmYzI3Y2JlMGRlMDgx
+    ZmZkZTRkNjk0M2RkMzUzMmZiNTU4MmVmYTQ0MWY3MTY4Y2Q4YWQ=
   data.tar.gz: !binary |-
-    NzNlNzBmZWEzNmQ5Njg1OTA1OWU1OTA4NjRiMmFmMGExZDkxN2VmMDQ3MTYx
-    ODY4MzI3YmQ0OWVjMzRmODVmY2ZiZjQ1Y2JkZDM0MTVlZDU3MTlmNjEwNGRi
-    MzQ2MzFkOTEzZDg4OGJlZTVkYTU3M2JiN2MzNDg1YjU4MWI2OGI=
+    MGRlZmU0ZWU5N2VjNWRkYzcyMmZhZjQyMjk1NTc0MmU4MTczOGYxMTYwNTcw
+    NDc4MmZhZWUwZGZjZjIyMGQ2YTA4NTRjNzkxMDRmNTY2ZTk3NzRlN2I1Nzdl
+    OWNjMjAyMDQ2N2RkYmJjNmFhOGRjNzVmZWI4ZjZjYjFhMjhmNmE=

data/.gitignore

@@ -12,3 +12,5 @@
 *.o
 *.a
 mkmf.log
+.ruby-gemset
+.ruby-version

data/CHANGELOG

@@ -0,0 +1,10 @@
+
+Supporting finagle-thrift v1.2.0
+v0.1.0 initial implementation of client trace code
+v0.2.0 added the optional service_name parameter, annotate correctly
+ v0.2.1 add annotation for http uri, method, response code
+ v0.2.2 fix serialization of response code
+ v0.2.3 minor gem cleanup, travis support; fix raise on DNS
+
+TODO:
+v0.3.0 - Upgrade to finagle-thrift v1.3.0

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in faraday-zipkin.gemspec
 gemspec
+
+# 0.9.1 adds thin dependency, prevents test on jruby
+gem 'thrift', '0.9.0'

data/README.md

@@ -1,5 +1,7 @@
 # Faraday::Zipkin
 
+[![Build Status](https://travis-ci.org/Oscil8/faraday-zipkin.svg?branch=master)](https://travis-ci.org/Oscil8/faraday-zipkin)
+
 Faraday middleware to generate Zipkin tracing headers.
 
 For more information about Zipkin, go to
@@ -21,10 +23,11 @@ https://github.com/twitter/zipkin/blob/master/doc/collector-api.md
 Include Faraday::Zipkin::TraceHeaders as a Faraday middleware:
 
     require 'faraday'
-    require 'faraday/zipkin'
+    require 'faraday-zipkin'
     
     conn = Faraday.new(:url => 'http://localhost:9292/') do |faraday|
-      faraday.use Faraday::Zipkin::TraceHeaders [, 'service_name']
+      # 'service_name' is optional (but recommended)
+      faraday.use Faraday::Zipkin::TraceHeaders, 'service_name'
       # default Faraday stack
       faraday.request :url_encoded
       faraday.adapter Faraday.default_adapter

data/faraday-zipkin.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'faraday/zipkin/version'
+require 'faraday-zipkin/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "faraday-zipkin"
@@ -24,6 +24,5 @@ Gem::Specification.new do |spec|
 
   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
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/faraday/zipkin.rb

@@ -1,49 +1 @@
-require 'faraday'
-require 'finagle-thrift'
-require 'finagle-thrift/trace'
-require 'uri'
-
-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"
-      }.freeze
-
-      def initialize(app, service_name=nil)
-        @app = app
-        @service_name = service_name
-      end
-
-      def call(env)
-        # handle either a URI object (passed by Faraday v0.8.x in testing), or something string-izable
-        url = env[:url].respond_to?(:host) ? env[:url] : URI.parse(env[:url].to_s)
-        service_name = @service_name || url.host.split('.').first # default to url-derived service name
-        endpoint = ::Trace::Endpoint.new(::Trace::Endpoint.host_to_i32(url.host), url.port, service_name)
-
-        trace_id = ::Trace.id
-        ::Trace.push(trace_id.next_id) do
-          B3_HEADERS.each do |method, header|
-            env[:request_headers][header] = ::Trace.id.send(method).to_s
-          end
-
-          # annotate with method (GET/POST/etc.) and uri path
-          ::Trace.set_rpc_name(env[:method].to_s.upcase)
-          ::Trace.record(::Trace::BinaryAnnotation.new("http.uri", url.path, "STRING", endpoint))
-          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_SEND, endpoint))
-          result = @app.call(env).on_complete do |renv|
-            # record HTTP status code on response
-            ::Trace.record(::Trace::BinaryAnnotation.new("http.status", [renv[:status]].pack('n'), "I16", endpoint))
-          end
-          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_RECV, endpoint))
-          result
-        end
-      end
-    end
-  end
-end
+require 'faraday-zipkin'

data/lib/faraday-zipkin/trace_headers.rb

@@ -0,0 +1,56 @@
+require 'faraday'
+require 'finagle-thrift'
+require 'finagle-thrift/trace'
+require 'uri'
+
+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"
+      }.freeze
+
+      def initialize(app, service_name=nil)
+        @app = app
+        @service_name = service_name
+      end
+
+      def call(env)
+        # handle either a URI object (passed by Faraday v0.8.x in testing), or something string-izable
+        url = env[:url].respond_to?(:host) ? env[:url] : URI.parse(env[:url].to_s)
+        service_name = @service_name || url.host.split('.').first # default to url-derived service name
+        endpoint = ::Trace::Endpoint.new(host_ip_for(url.host), url.port, service_name)
+
+        trace_id = ::Trace.id
+        ::Trace.push(trace_id.next_id) do
+          B3_HEADERS.each do |method, header|
+            env[:request_headers][header] = ::Trace.id.send(method).to_s
+          end
+
+          # annotate with method (GET/POST/etc.) and uri path
+          ::Trace.set_rpc_name(env[:method].to_s.upcase)
+          ::Trace.record(::Trace::BinaryAnnotation.new("http.uri", url.path, "STRING", endpoint))
+          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_SEND, endpoint))
+          result = @app.call(env).on_complete do |renv|
+            # record HTTP status code on response
+            ::Trace.record(::Trace::BinaryAnnotation.new("http.status", [renv[:status]].pack('n'), "I16", endpoint))
+          end
+          ::Trace.record(::Trace::Annotation.new(::Trace::Annotation::CLIENT_RECV, endpoint))
+          result
+        end
+      end
+
+      # get host IP for specified hostname, catching exceptions
+      def host_ip_for(hostname)
+        ::Trace::Endpoint.host_to_i32(hostname)
+      rescue
+        # default to 0.0.0.0 if lookup fails
+        0x00000000
+      end
+      private :host_ip_for
+    end
+  end
+end

data/lib/{faraday/zipkin → faraday-zipkin}/version.rb

@@ -1,5 +1,5 @@
 module Faraday
   module Zipkin
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

data/lib/faraday-zipkin.rb

@@ -0,0 +1,2 @@
+require 'faraday-zipkin/version'
+require 'faraday-zipkin/trace_headers'

data/spec/spec_helper.rb

@@ -1,80 +1,5 @@
-require 'faraday/zipkin'
+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

@@ -31,31 +31,36 @@ describe Faraday::Zipkin::TraceHeaders do
     middleware.call(env)
   end
 
-  # custom matchers for trace annotation
-  RSpec::Matchers.define :have_value do |v|
-    match { |actual| actual.value == v }
-  end
-
-  RSpec::Matchers.define :have_endpoint do |ip, svc|
-    match { |actual| actual.host.kind_of?(::Trace::Endpoint) &&
-                     actual.host.ipv4 == ip &&
-                     actual.host.service_name == svc }
-  end
-
   before(:each) {
     ::Trace.sample_rate = 0.1 # make sure initialized
     allow(::Trace::Endpoint).to receive(:host_to_i32).with(hostname).and_return(host_ip)
   }
 
   shared_examples 'can make requests' do
+    # helper to check host component of annotation
+    def expect_host(host, host_ip, service_name)
+      expect(host).to be_a_kind_of(::Trace::Endpoint)
+      expect(host.ipv4).to eq(host_ip)
+      expect(host.service_name).to eq(service_name)
+    end
+
     def expect_tracing
       # expect SEND then RECV
       expect(::Trace).to receive(:set_rpc_name).with('POST')
       expect(::Trace).to receive(:record).with(instance_of(::Trace::BinaryAnnotation)).twice # http.uri, http.status
-      expect(::Trace).to receive(:record).with(have_value(::Trace::Annotation::CLIENT_SEND).and(have_endpoint(host_ip, service_name))).ordered
-      expect(::Trace).to receive(:record).with(have_value(::Trace::Annotation::CLIENT_RECV).and(have_endpoint(host_ip, service_name))).ordered
+      expect(::Trace).to receive(:record).with(instance_of(::Trace::Annotation)) do |ann|
+        expect(ann.value).to eq(::Trace::Annotation::CLIENT_SEND)
+        expect_host(ann.host, host_ip, service_name)
+      end.ordered
+      expect(::Trace).to receive(:record).with(instance_of(::Trace::Annotation)) do |ann|
+        expect(ann.value).to eq(::Trace::Annotation::CLIENT_RECV)
+        expect_host(ann.host, host_ip, service_name)
+      end.ordered
     end
 
+    # Ruby 1.8 didn't support \h
+    HEX_REGEX = RUBY_VERSION >= "1.9.2" ? '\h' : '[0-9a-fA-F]'
+
     context 'with tracing id' do
       let(:trace_id) { ::Trace::TraceId.new(1, 2, 3, true) }
 
@@ -68,7 +73,7 @@ describe Faraday::Zipkin::TraceHeaders do
         expect(result[:request_headers]['X-B3-TraceId']).to eq('0000000000000001')
         expect(result[:request_headers]['X-B3-ParentSpanId']).to eq('0000000000000003')
         expect(result[:request_headers]['X-B3-SpanId']).not_to eq('0000000000000003')
-        expect(result[:request_headers]['X-B3-SpanId']).to match(/^\h{16}$/)
+        expect(result[:request_headers]['X-B3-SpanId']).to match(/^#{HEX_REGEX}{16}$/)
         expect(result[:request_headers]['X-B3-Sampled']).to eq('true')
       end
     end
@@ -79,12 +84,25 @@ describe Faraday::Zipkin::TraceHeaders do
       it 'generates a new ID, and sets the X-B3 request headers' do
         expect_tracing
         result = process('', url).env
-        expect(result[:request_headers]['X-B3-TraceId']).to match(/^\h{16}$/)
-        expect(result[:request_headers]['X-B3-ParentSpanId']).to match(/^\h{16}$/)
-        expect(result[:request_headers]['X-B3-SpanId']).to match(/^\h{16}$/)
+        expect(result[:request_headers]['X-B3-TraceId']).to match(/^#{HEX_REGEX}{16}$/)
+        expect(result[:request_headers]['X-B3-ParentSpanId']).to match(/^#{HEX_REGEX}{16}$/)
+        expect(result[:request_headers]['X-B3-SpanId']).to match(/^#{HEX_REGEX}{16}$/)
         expect(result[:request_headers]['X-B3-Sampled']).to match(/(true|false)/)
       end
     end
+
+    context 'when looking up hostname raises' do
+      let(:host_ip) { 0x00000000 } # expect stubbed 'null' IP
+
+      before(:each) {
+        allow(::Trace::Endpoint).to receive(:host_to_i32).with(hostname).and_raise(SocketError)
+      }
+
+      it 'traces with stubbed endpoint address' do
+        expect_tracing
+        process('', url)
+      end
+    end
   end
 
   context 'middleware configured (without service_name)' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-zipkin
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ariel Salomon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -84,30 +84,16 @@ dependencies:
   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'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: Faraday middleware to generate Zipkin tracing headers.
 email:
 - asalomon@lookout.com
@@ -118,13 +104,16 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - faraday-zipkin.gemspec
+- lib/faraday-zipkin.rb
+- lib/faraday-zipkin/trace_headers.rb
+- lib/faraday-zipkin/version.rb
 - 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
@@ -147,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Faraday middleware to generate Zipkin tracing headers.