opentracing 0.1.0 → 0.2.0

data/lib/opentracing/carrier.rb

@@ -0,0 +1,25 @@
+module OpenTracing
+  # Carriers are used for inject and extract operations. A carrier should be a
+  # Hash or hash-like object. At a minimum, it should implement `[]`, `[]=`, and
+  # `each` shown here.
+  class Carrier
+    # [] retrieves a value by the given key
+    # @param key [String] key to retrieve the value
+    # @return [String] the desired value
+    def [](key)
+    end
+
+    # []= sets the value for the given key
+    # @param key [String] key to set
+    # @param value [String] value to set
+    def []=(key, value)
+    end
+
+    # each iterates over every key-value pair in the carrier
+    # @yield [key, value]
+    # @yieldparam key [String] the key of the tuple
+    # @yieldparam value [String] the value of the tuple
+    def each(&block)
+    end
+  end
+end

data/lib/opentracing/span.rb

@@ -0,0 +1,61 @@
+module OpenTracing
+  # Span represents an OpenTracer Span
+  #
+  # See http://www.opentracing.io for more information.
+  class Span
+    NOOP_INSTANCE = Span.new.freeze
+
+    # Set the name of the operation
+    def operation_name=(name)
+    end
+
+    # Span Context
+    def context
+      SpanContext::NOOP_INSTANCE
+    end
+
+    # Creates a new {Span}
+    #
+    # @param tracer [Tracer] the tracer that created this span
+    # @param context [SpanContext] the context of the span
+    # @return [Span] a new Span
+    def initialize(tracer:, context:)
+    end
+
+    # Set a tag value on this span
+    # @param key [String] the key of the tag
+    # @param value [String, Numeric, Boolean] the value of the tag. If it's not
+    # a String, Numeric, or Boolean it will be encoded with to_s
+    def set_tag(key, value)
+      self
+    end
+
+    # Set a baggage item on the span
+    # @param key [String] the key of the baggage item
+    # @param value [String] the value of the baggage item
+    def set_baggage_item(key, value)
+      self
+    end
+
+    # Get a baggage item
+    # @param key [String] the key of the baggage item
+    # @return Value of the baggage item
+    def get_baggage_item(key)
+      nil
+    end
+
+    # Add a log entry to this span
+    # @param event [String] event name for the log
+    # @param timestamp [Time] time of the log
+    # @param fields [Hash] Additional information to log
+    def log(event: nil, timestamp: Time.now, **fields)
+      nil
+    end
+
+    # Finish the {Span}
+    # @param end_time [Time] custom end time, if not now
+    def finish(end_time: Time.now)
+      nil
+    end
+  end
+end

data/lib/opentracing/span_context.rb

@@ -0,0 +1,15 @@
+module OpenTracing
+  # SpanContext holds the data for a span that gets inherited to child spans
+  class SpanContext
+    NOOP_INSTANCE = SpanContext.new.freeze
+
+    attr_reader :baggage
+
+    # Create a new SpanContext
+    # @param id the ID of the Context
+    # @param trace_id the ID of the current trace
+    # @param baggage baggage
+    def initialize(baggage: {})
+    end
+  end
+end

data/lib/opentracing/tracer.rb

@@ -0,0 +1,42 @@
+module OpenTracing
+  class Tracer
+    # Start a new span
+    # @param operation_name [String] The name of the operation represented by the span
+    # @param child_of [Span] A span to be used as the ChildOf reference
+    # @param start_time [Time] the start time of the span
+    # @param tags [Hash] Starting tags for the span
+    def start_span(operation_name, child_of: nil, start_time: nil, tags: nil)
+      Span::NOOP_INSTANCE
+    end
+
+
+    # Inject a span into the given carrier
+    # @param span_context [SpanContext]
+    # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
+    # @param carrier [Carrier]
+    def inject(span_context, format, carrier)
+      case format
+      when OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK
+        return nil
+      else
+        warn 'Unknown inject format'
+      end
+    end
+
+    # Extract a span from a carrier
+    # @param operation_name [String]
+    # @param format [OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK]
+    # @param carrier [Carrier]
+    # @param tracer [Tracer] the tracer the span will be attached to (for finish)
+    # @return [Span]
+    def extract(operation_name, format, carrier)
+      case format
+      when OpenTracing::FORMAT_TEXT_MAP, OpenTracing::FORMAT_BINARY, OpenTracing::FORMAT_RACK
+        return Span::NOOP_INSTANCE
+      else
+        warn 'Unknown extract format'
+        nil
+      end
+    end
+  end
+end

data/lib/opentracing/version.rb

@@ -0,0 +1,3 @@
+module OpenTracing
+  VERSION = "0.2.0"
+end

data/opentracing.gemspec

@@ -1,61 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: opentracing  ruby lib
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opentracing/version'
 
-Gem::Specification.new do |s|
-  s.name = "opentracing"
-  s.version = ""
+Gem::Specification.new do |spec|
+  spec.name          = "opentracing"
+  spec.version       = OpenTracing::VERSION
+  spec.authors       = ["ngauthier", "bcronin", "bensigelman"]
+  spec.email         = ["info@opentracing.io"]
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Dimitar Kostov"]
-  s.date = "2016-12-12"
-  s.description = "OpenTracing support for Ruby frameworks"
-  s.email = "mitko.kostov@gmail.com"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "lib/opentracing.rb",
-    "test/helper.rb",
-    "test/test_opentracing.rb"
-  ]
-  s.homepage = "http://github.com/mytrile/opentracing"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.8"
-  s.summary = "OpenTracing support for Ruby frameworks"
+  spec.summary       = %q{OpenTracing Ruby Platform API}
+  spec.homepage      = "https://github.com/opentracing/opentracing-ruby"
+  spec.license       = "MIT"
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
   end
-end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-console"
+end

metadata

@@ -1,73 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: opentracing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Dimitar Kostov
+- ngauthier
+- bcronin
+- bensigelman
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,26 +82,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: OpenTracing support for Ruby frameworks
-email: mitko.kostov@gmail.com
+description: 
+email:
+- info@opentracing.io
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.md
+extra_rdoc_files: []
 files:
-- ".document"
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
+- bin/console
+- bin/setup
 - lib/opentracing.rb
+- lib/opentracing/carrier.rb
+- lib/opentracing/span.rb
+- lib/opentracing/span_context.rb
+- lib/opentracing/tracer.rb
+- lib/opentracing/version.rb
 - opentracing.gemspec
-- test/helper.rb
-- test/test_opentracing.rb
-homepage: http://github.com/mytrile/opentracing
+homepage: https://github.com/opentracing/opentracing-ruby
 licenses:
 - MIT
 metadata: {}
@@ -119,8 +126,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: OpenTracing support for Ruby frameworks
+summary: OpenTracing Ruby Platform API
 test_files: []

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
--
-features/**/*.feature
-LICENSE

data/Gemfile.lock

@@ -1,81 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.0.0.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.4.0)
-    builder (3.2.2)
-    concurrent-ruby (1.0.2)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    docile (1.1.5)
-    faraday (0.9.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.3.0)
-    github_api (0.14.5)
-      addressable (~> 2.4.0)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8, < 0.10)
-      hashie (>= 3.4)
-      oauth2 (~> 1.0)
-    hashie (3.4.6)
-    highline (1.7.8)
-    i18n (0.7.0)
-    jeweler (2.0.1)
-      builder
-      bundler (>= 1.0)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-    json (1.8.3)
-    jwt (1.5.6)
-    mini_portile2 (2.1.0)
-    minitest (5.10.1)
-    multi_json (1.12.1)
-    multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    nokogiri (1.6.8.1)
-      mini_portile2 (~> 2.1.0)
-    oauth2 (1.2.0)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    rack (2.0.1)
-    rake (12.0.0)
-    rdoc (3.12.2)
-      json (~> 1.4)
-    shoulda (3.5.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.2.2)
-    shoulda-matchers (2.8.0)
-      activesupport (>= 3.0.0)
-    simplecov (0.12.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0)
-  jeweler (~> 2.0.1)
-  rdoc (~> 3.12)
-  shoulda
-  simplecov
-
-BUNDLED WITH
-   1.12.5