yodeler 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa2389240d853b1e917ca4741cd9d8ca0c9bde03
-  data.tar.gz: 43aae361bf5632fea1641a3914f2b5390759cffe
+  metadata.gz: d67f1c41f3f2b01e9fb7f25a24f0f1fa937f1cdc
+  data.tar.gz: 91448d8ada39aec9c5210c350ebdab9ae62a4279
 SHA512:
-  metadata.gz: a081b0689cd5e2f0f2a3c192a54832459a0935f020aa7392a23ec3e4d9771fdff89280b120e57219e14507c597f38266ce71ae6150f67118ff7459fb42cf33be
-  data.tar.gz: 7eb2cd49a592a382610031303a10a1eeb4313c2893aa1c5d40e48ce0d7446dd04af2cd119aefaf5d2a5860f21f6252e4fa3401f6ef804f57f4b41ce4c6b9f1a7
+  metadata.gz: c2f5d3f51fc14366b6fd9b68db14f1591d388aa5c6628de2f6412f47448f355b60c850497bd347ad60a2baaefe127fa76e15259e9d73219f9ce75b803d61959d
+  data.tar.gz: 885e84f73efec668d70b20377c56770b53ff496f9bc045bf43fe5078453b25e45a02fae26c5bf866fe99bafc6b6886dadb431c613a02d8dadb72b4051c0d86c7

data/.codeclimate.yml

@@ -3,7 +3,7 @@ engines:
   brakeman:
     enabled: false
   bundler-audit:
-    enabled: true
+    enabled: false
   duplication:
     enabled: true
     config:

data/Guardfile

@@ -1,5 +1,5 @@
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
   # Feel free to open issues for suggestions and improvements

data/README.md

@@ -13,7 +13,7 @@ Spoutin' off noise to whoever is listening.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'yodeler', '~>0.1.1'
+gem 'yodeler', '~>0.1.2'
 ```
 
 And then execute:
@@ -40,6 +40,11 @@ Yodeler.configure do |client|
     # http.use_ssl = false
     # http.default_params = {}
   end
+
+  # if no timestamp_format is set, defaults to UTC ISO8601
+  client.timestamp_format = :iso8601
+  #client.timestamp_format = :epoch
+  #client.timestamp_format = -> { Time.now.whatever.you_feel_like! }
 end
 ```
 
@@ -102,7 +107,7 @@ Yodeler.configure do |client|
     }
 
     # Overwrite the default http dispatcher or overwrite an individual metric dispatcher
-    #   http.handle(:gauge){|url, metric, default_params| ... something cool ... }
+    #   http.handle(:gauge){ |url, metric, default_params| ... something cool ... }
     http.handle(:default) do |url, metric, default_params|
       # This is the default handler definition, but you could change it
       HTTP.post(url, json: default_params.merge(metric.to_hash))
@@ -195,3 +200,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/coryod
   * [ ] Custom adapter documentation
   * [ ] Client#format_options -> Metric.format_options
   * [ ] Client#default_endpoint_name accept array of names
+  * [ ] Dispatch to any object or proc, if adapter not registered
+    * client.endpoint(:dashboard).use(:something_that_responds_to_dispatch)
+    * client.endpoint(:dashboard).use{ |metric| MyWorker.perform_later(metric) }
+  * [ ] more yard docs

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "yodeler"
+require 'bundler/setup'
+require 'yodeler'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "yodeler"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/yodeler/adapter_not_registered_error.rb

@@ -5,7 +5,7 @@ module Yodeler
       @name = name
       msg = [
         "No Yodeler Adapter registed for: ':#{name}'",
-        "Register an adapter with:",
+        'Register an adapter with:',
         "Yodeler.register_adapter(:#{name}, CustomAdapterClass)"
       ].join("\n")
       super(msg)

data/lib/yodeler/adapters/http_adapter.rb

@@ -8,7 +8,7 @@ module Yodeler::Adapters
     attr_accessor :use_ssl
     attr_accessor :default_params
 
-    def initialize(host=nil, port:nil, path:nil, use_ssl:false, params:{})
+    def initialize(host = nil, port:nil, path:nil, use_ssl:false, params:{})
       @host = host
       @port = port
       @path = path
@@ -26,7 +26,8 @@ module Yodeler::Adapters
     end
 
     def dispatch(metric)
-      (@handlers[metric.type] || @handlers[:default]).call(url, metric, default_params)
+      dispatcher = @handlers[metric.type] || @handlers[:default]
+      dispatcher.call(url, metric, default_params)
     end
 
     def url
@@ -34,6 +35,7 @@ module Yodeler::Adapters
     end
 
     private
+
     def host_with_port
       if port
         "#{host}:#{port}"

data/lib/yodeler/adapters/void_adapter.rb

@@ -1,8 +1,7 @@
 module Yodeler::Adapters
   class VoidAdapter
-
     def dispatch(*)
-      #noop
+      # noop
     end
 
     Yodeler.register_adapter(:void, self)

data/lib/yodeler/client.rb

@@ -5,23 +5,40 @@ module Yodeler
     attr_accessor :default_endpoint_name
     attr_accessor :default_prefix
     attr_accessor :default_sample_rate
+    attr_accessor :timestamp_format
     attr_reader :endpoints
 
+    TIMESTAMP_FORMATS = {
+      iso8601: -> { Time.now.utc.iso8601 },
+      epoch:   -> { Time.now.to_i }
+    }
+
     def initialize
       @endpoints = {}
       @default_sample_rate = 1.0
       @default_prefix = nil
-      @hostname  = Socket.gethostname
+      @hostname = Socket.gethostname
+      @timestamp_format = :iso8601
+    end
+
+    def timestamp_generator
+      if timestamp_format.is_a?(Symbol) && TIMESTAMP_FORMATS[timestamp_format]
+        TIMESTAMP_FORMATS[timestamp_format].call
+      elsif timestamp_format.is_a?(Proc)
+        timestamp_format.call
+      else
+        raise ArgumentError, "Time format not recognized: #{timestamp_format}. \nOptions are #{TIMESTAMP_FORMATS.join(', ')} or a lamba"
+      end
     end
 
     # Register a new endpoint
     #
     # @param [Symbol|String] name of endpoint, must be unique
     # @return [Yodeler::Endpoint]
-    def endpoint(name=:default, &block)
-      raise DuplicateEndpointNameError.new(name: name) if @endpoints[name]
+    def endpoint(name = :default, &block)
+      fail DuplicateEndpointNameError.new(name: name) if @endpoints[name]
       @default_endpoint_name ||= name
-      @endpoints[name] = Endpoint.new(name,&block)
+      @endpoints[name] = Endpoint.new(name, &block)
     end
 
     # Get the default endpoint
@@ -40,8 +57,8 @@ module Yodeler
     # @param [Symbol] name registered adapter name
     # @param [Type] &block configuration for adapter
     # @return [~Yodeler::Adapters::Base] the adapter
-    def adapter(name ,&block)
-      endpoint() if @endpoints.empty?
+    def adapter(name, &block)
+      endpoint if @endpoints.empty?
       default_endpoint.use(name, &block)
     end
 
@@ -55,7 +72,7 @@ module Yodeler
     # @param [~Fixnum] value of the metric
     # @param [Hash] opts={} Examples {#format_options}
     # @return [Yodeler::Metric, nil] the dispatched metric, nil if not sampled
-    def gauge(name, value, opts={})
+    def gauge(name, value, opts = {})
       dispatch(:gauge, name, value, opts)
     end
 
@@ -70,8 +87,8 @@ module Yodeler
     # @param [~Fixnum] value=1 of the metric
     # @param [Hash] opts={} Examples {#format_options}
     # @return [Yodeler::Metric, nil] the dispatched metric, nil if not sampled
-    def increment(name, value=1, opts={})
-      if value.kind_of?(Hash)
+    def increment(name, value = 1, opts = {})
+      if value.is_a?(Hash)
         opts = value
         value = 1
       end
@@ -92,56 +109,60 @@ module Yodeler
     # @return [Yodeler::Metric, nil, Object]
     #   the dispatched metric, nil if not sampled
     #   if a block is given the result of the block is returned
-    def timing(name, value=nil, opts={})
-      if value.kind_of?(Hash)
+    def timing(name, value = nil, opts = {})
+      if value.is_a?(Hash)
         opts = value
         value = nil
       end
 
-      _retval = nil
-
+      retval = nil
       if block_given?
-        start = Time.now
-        _retval = yield
-        value = Time.now - start
+        start = Time.now.to_i
+        retval = yield
+        value = Time.now.to_i - start
       end
 
       metric = dispatch(:timing, name, value, opts)
-      _retval || metric
+      retval || metric
     end
 
     # Publish an event
     #
     # @example
     #   client.publish('item.sold', purchase.to_json)
-    #   client.publish('user.sign_up', {name: user.name, avatar: user.image_url})
+    #   client.publish('user.sign_up', {name: user.name, avatar: user.image})
     #
     # @param [~String] name of the metric
     # @param [~Hash] value of the metric
     # @param [Hash] opts={} Examples {#format_options}
     # @return [Yodeler::Metric, nil] the dispatched metric, nil if not sampled
-    def publish(name, payload, opts={})
+    def publish(name, payload, opts = {})
       dispatch(:event, name, payload, opts)
     end
 
     # Formats/Defaults metric options
     #
     # @param [Hash] opts metric options
-    # @option opts [Array<String,Symbol>, String, Symbol] :tags ([]) array of tags to apply to metric/event
+    # @option opts [Array<String,Symbol>, String, Symbol] :tags ([])
+    #   array of tags to apply to metric/event
     # @option opts [Float] :sample_rate (1.0) The sample rate to use
-    # @option opts [Array<Symbol>, Symbol] :to array of endpoint names to send the metric to. If not set will send to {Yodeler::Client#default_endpoint_name}
+    # @option opts [Array<Symbol>, Symbol] :to
+    #   array of endpoint names to send the metric to.
+    #   If not set will send to {Yodeler::Client#default_endpoint_name}
     # @return [Hash] formatted, defaulted options
     def format_options(opts)
       endpoint_names  = opts.delete(:to) || [default_endpoint_name]
       tags            = opts.delete(:tags)
       prefix          = opts.delete(:prefix) || default_prefix
+      timestamp       = opts.delete(:timestamp) || timestamp_generator
 
       {
         prefix:       prefix,
         to:           [endpoint_names].flatten.compact,
         sample_rate:  opts.delete(:sample_rate) || default_sample_rate,
         tags:         [tags].flatten.compact,
-        hostname:     @hostname
+        hostname:     @hostname,
+        timestamp:    timestamp
       }
     end
 
@@ -150,6 +171,7 @@ module Yodeler
     def dispatch(type, name, value, opts)
       opts = format_options(opts)
       destinations = opts.delete(:to)
+
       metric = Metric.new(type, name, value, opts)
 
       return nil unless metric.sample?

data/lib/yodeler/endpoint.rb

@@ -28,8 +28,6 @@ module Yodeler
       @adapter
     end
 
-    def adapter
-      @adapter
-    end
+    attr_reader :adapter
   end
 end

data/lib/yodeler/metric.rb

@@ -1,36 +1,54 @@
-class Yodeler::Metric
-  attr_reader :type, :value
-  attr_reader :sample_rate, :tags, :prefix
-  attr_reader :options
-
-  def initialize(type, name, value, opts={})
-    @type = type
-    @name = name
-    @value = value
-    @prefix = opts.delete(:prefix)
-    @sample_rate = opts.delete(:sample_rate)
-    @options = opts
-  end
+require 'securerandom'
 
-  def name
-    @prefix ? [@prefix, @name].join('.') : @name
-  end
+module Yodeler
+  class Metric
+    attr_reader :type, :value
+    attr_reader :sample_rate, :tags, :prefix
+    attr_reader :uuid
+    attr_reader :options
 
-  # @return [Boolean] Should this metric be sampled
-  def sample?
-    @_sample ||= !(rand()> @sample_rate)
-  end
+    TYPES = [:event, :increment, :gauge, :timing]
+
+    def initialize(type, name, value, opts = {})
+      @uuid = SecureRandom.uuid
+      @type = type
+      @name = name
+      @value = value
+      @prefix = opts.delete(:prefix)
+      @sample_rate = opts.delete(:sample_rate)
+      @timestamp = opts.delete(:timestamp)
+      @tags = opts.delete(:tags)
+      @hostname = opts.delete(:hostname)
+    end
+
+    def name
+      @prefix ? [@prefix, @name].join('.') : @name
+    end
+
+    # @return [Boolean] Should this metric be sampled
+    def sample?
+      @_sample ||= !(rand > @sample_rate)
+    end
+
+    def to_hash
+      hash = {
+        uuid: uuid,
+        name: name,
+        type: @type,
+        value: @value
+      }
 
-  def to_hash
-    hash = {
-      name: name,
-      type: @type,
-      value: @value,
-    }
+      hash[:timestamp] = @timestamp if @timestamp
+      hash[:tags] = @tags if @tags && @tags.any?
+      hash[:hostname] = @hostname if @hostname
 
-    hash[:tags] = options[:tags] if options[:tags] && options[:tags].any?
-    hash[:hostname] = options[:hostname] if options[:hostname]
+      hash
+    end
 
-    hash
+    TYPES.each do |type_meth|
+      define_method("#{type_meth}?") do
+        type_meth.to_sym == type
+      end
+    end
   end
 end

data/lib/yodeler/version.rb

@@ -1,3 +1,3 @@
 module Yodeler
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/lib/yodeler.rb

@@ -1,13 +1,13 @@
-require "yaml"
+require 'yaml'
 require 'forwardable'
 
-require "yodeler/version"
-require "yodeler/endpoint"
-require "yodeler/client"
-require "yodeler/metric"
+require 'yodeler/version'
+require 'yodeler/endpoint'
+require 'yodeler/client'
+require 'yodeler/metric'
 
-require "yodeler/duplicate_endpoint_name_error"
-require "yodeler/adapter_not_registered_error"
+require 'yodeler/duplicate_endpoint_name_error'
+require 'yodeler/adapter_not_registered_error'
 
 module Yodeler
   class << self
@@ -21,7 +21,7 @@ module Yodeler
       @registered_adapters = {}
     end
 
-    def register_adapter(name,klass)
+    def register_adapter(name, klass)
       @registered_adapters[name] = klass
     end
 
@@ -29,9 +29,7 @@ module Yodeler
     # @private
     def registered_adapters(name)
       klass = @registered_adapters[name]
-      if !klass
-        raise AdapterNotRegisteredError.new(name: name)
-      end
+      fail AdapterNotRegisteredError.new(name: name) unless klass
       @registered_adapters[name]
     end
 
@@ -40,9 +38,7 @@ module Yodeler
       setup!
     end
 
-    def client
-      @client
-    end
+    attr_reader :client
 
     def configure
       @client = Yodeler::Client.new
@@ -53,5 +49,5 @@ module Yodeler
 end
 
 Yodeler.setup!
-require "yodeler/adapters/memory_adapter"
-require "yodeler/adapters/http_adapter"
+require 'yodeler/adapters/memory_adapter'
+require 'yodeler/adapters/http_adapter'

data/yodeler.gemspec

@@ -4,26 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'yodeler/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "yodeler"
+  spec.name          = 'yodeler'
   spec.version       = Yodeler::VERSION
   spec.authors       = ["Cory O'Daniel"]
-  spec.email         = ["github@coryodaniel.com"]
-  spec.description   = "A generic instrumentation library thats supports reporting to multiple endpoints via pluggable backend adapters."
+  spec.email         = ['github@coryodaniel.com']
+  spec.description   = 'A generic instrumentation library thats supports reporting to multiple endpoints via pluggable backend adapters.'
   spec.summary       = "A generic instrumentation library thats supports reporting to multiple endpoints via pluggable backend adapters. Spoutin' off noise to whoever is listening."
-  spec.homepage      = "http://github.com/coryodaniel/yodeler"
+  spec.homepage      = 'http://github.com/coryodaniel/yodeler'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "http"
+  spec.add_dependency 'http'
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "rspec-mocks"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rspec-mocks'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yodeler
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Cory O'Daniel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http