better_fx 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55b10acd6ff246c5c3079d2a7b758489b39bd724
+  data.tar.gz: e047c129bde742ccbb1912e3caac85ac5f9dbad1
+SHA512:
+  metadata.gz: 8de14bee27628714f05d675d0686df71a9d7cfca13cee16ea0258bc9f61af0c4a3dd3252ff8fa747eebcf5d3fd517a3bcb8ce9134d79360440a039621ccd557f
+  data.tar.gz: d234b348ef4051e3c373f63f4a3ea25cd32fe4a8598bead1cb0f8fdbd5c4233349b49f3f43e85fca7139013e05b5ea7e95a041e0db01e8a1a5ba94347eb5add8

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.idea
+.idea/
+.idea/*

data/.rubocop.yml

@@ -0,0 +1,75 @@
+inherit_from: .rubocop_todo.yml
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+
+Lint/UnusedBlockArgument:
+  Enabled: true
+
+Metrics/AbcSize:
+  Exclude:
+    - spec/**/*
+
+Style/DotPosition:
+  Enabled: true
+  EnforcedStyle: trailing
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()    # interpolated String
+    '%i': '[]'  # Array of symbols
+    '%q': ()    # Single quoted string
+    '%Q': ()    # Double quoted string
+    '%r': '{}'  # Regex
+    '%s': ()    # Symbol
+    '%w': '[]'  # Array of strings
+    '%W': '[]'  # Array of strings, interpolated
+    '%x': ()    # shell command
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/CollectionMethods:
+  Enabled: true
+  # Mapping from undesired method to desired_method
+  # e.g. use `detect` over `find`:
+  PreferredMethods:
+    find: 'detect'
+    find_all: 'select'
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/AndOr:
+  # Whether `and` and `or` are banned only in conditionals (conditionals)
+  # or completely (always).
+  EnforcedStyle: conditionals # and/or are sometimes used for flow control.
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/NumericLiterals:
+  MinDigits: 5
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,32 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-05-18 01:05:05 +0000 using RuboCop version 0.40.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 17
+
+# Offense count: 23
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 173
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/better_fx.rb'
+    - 'lib/better_fx/client.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'better_fx.gemspec'

data/README.md

@@ -0,0 +1,37 @@
+# BetterFx
+Making it _easier_ for you to quickly interact with SignalFx in an idiomatic fashion.
+
+## Usage
+
+Usually you just want to indicate that something occurred
+
+```ruby
+require "better_fx"
+bfx = BetterFx::Client.new
+# This will send the value 1 to the SignalFx counter metric named "beans" 
+#with the current unix timestamp and vanilla metadata dimensions
+bfx.increment_counter :beans
+```
+
+## Configuration
+
+To use BetterFx with the least amount of code, just set the environment variable
+`SIGNALFX_API_TOKEN` equal to your token.
+
+If you want to configure it imperatively then
+
+```ruby
+require "better_fx"
+BetterFx.configure do |c|
+    # The SignalFx api token you want to use when transmitting to SignalFx
+    c.signalfx_api_token = "ABCD12345"
+    # The list of environments for which you want to allow transmission of data to 
+    # SignalFx (if the current environment is not in this list then transmissions are
+    # skipped).
+    # Defaults to `[:production, :prod, "production", "prod"]`
+    c.supported_environments = [:local, :prod]
+    # The current environment
+    # Defaults to `ENV["APP_ENV"] || :production`
+    c.current_environment = :local
+end
+```

data/better_fx.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = "better_fx"
+  s.version     = "0.1.1"
+  s.license     = "MIT"
+  s.date        = "2016-05-17"
+  s.summary     = "A more idiomatic interface to SignalFx."
+  s.description = "A convenient gem for developers to interact with SignalFx with a trivial amount of effort"
+  s.authors     = ["Courtland Caldwell"]
+  s.email       = "engineering@mattermark.com"
+  s.files         = `git ls-files`.split("\n") - %w(Gemfile Gemfile.lock)
+  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
+  s.homepage =
+    "https://github.com/Referly/better_fx"
+  s.add_runtime_dependency "signalfx", "~> 0.1"                         # Apache2 - @link https://github.com/signalfx/signalfx-ruby
+  s.add_development_dependency "rspec", "~> 3.2"                        # MIT - @link https://github.com/rspec/rspec/blob/master/License.txt
+  s.add_development_dependency "byebug", "~> 3.5"                       # BSD (content is BSD) https://github.com/deivid-rodriguez/byebug/blob/master/LICENSE
+  s.add_development_dependency "simplecov", "~> 0.10"                   # MIT - @link https://github.com/colszowka/simplecov/blob/master/MIT-LICENSE
+  s.add_development_dependency "rubocop", "~> 0.31"                     # Create Commons Attribution-NonCommerical https://github.com/bbatsov/rubocop/blob/master/LICENSE.txt
+  s.add_development_dependency "rspec_junit_formatter", "~> 0.2"        # MIT https://github.com/sj26/rspec_junit_formatter/blob/master/LICENSE
+end

data/circle.yml

@@ -0,0 +1,15 @@
+machine:
+
+  timezone:
+    America/Los_Angeles # Set the timezone
+
+  # Version of ruby to use
+  ruby:
+    version:
+      2.1.3
+
+test:
+  override:
+    - bundle exec rubocop
+    - mkdir -p $CIRCLE_TEST_REPORTS/rspec
+    - bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec/rspec.xml spec --format progress

data/lib/better_fx/client.rb

@@ -0,0 +1,38 @@
+require "signalfx"
+module BetterFx
+  class Client
+    def initialize
+      # if BetterFx has not been configured then run the default configuration
+      BetterFx.configure unless BetterFx.configured?
+    end
+
+    # Increment a SignalFx counter (if the current environment is a supports using SignalFx)
+    #
+    # @params counter_name [Symbol, String] the name of the counter to be incremented
+    # @params value [Fixnum] what the incremental amount should be (default of 1)
+    # @params timestamp [Fixnum, String] the timestamp, in milliseconds since the unix epoch (defaults to the timestamp
+    #   on the host running your code)
+    # @params dimensions [Array<Hash>] the metadata dimensions to be associated with the counter
+    def increment_counter(counter_name, value: 1, timestamp: nil, dimensions: [])
+      return unless configuration.supported_environments.include? configuration.current_environment
+      timestamp ||= 1000 * Time.now.to_i
+      dimensions << { env: configuration.current_environment } if dimensions.empty?
+      signalfx_client.bf_xmit(counters: [
+                                metric:     counter_name.to_s,
+                                value:      value,
+                                timestamp:  timestamp.to_s,
+                                dimensions: dimensions,
+                              ])
+    end
+
+    private
+
+    def signalfx_client
+      SignalFx.new configuration.signalfx_api_token
+    end
+
+    def configuration
+      BetterFx.configuration
+    end
+  end
+end

data/lib/better_fx/configuration.rb

@@ -0,0 +1,14 @@
+module BetterFx
+  # Provides configuration management for the BetterFx gem
+  class Configuration
+    attr_accessor :signalfx_api_token,
+                  :supported_environments,
+                  :current_environment
+
+    def initialize
+      @signalfx_api_token       = ENV["SIGNALFX_API_TOKEN"]
+      @supported_environments   = [:production, :prod, "production", "prod"]
+      @current_environment      = ENV["APP_ENV"] || :production
+    end
+  end
+end

data/lib/better_fx.rb

@@ -0,0 +1,33 @@
+require "signalfx"
+# Monkey patch the SignalFxClient to alias the #send method to as #bf_xmit
+SignalFxClient.send :alias_method, :bf_xmit, :send
+require_relative "better_fx/configuration"
+require_relative "better_fx/client"
+module BetterFx
+  class << self
+    # Allows the user to set configuration options
+    #  by yielding the configuration block
+    #
+    # @param opts [Hash] an optional hash of options, supported options are `reset: true`
+    # @return [Configuration] the current configuration object
+    def configure(opts = {})
+      @configuration = nil if opts.key?(:reset) && opts[:reset]
+      yield(configuration) if block_given?
+      configuration
+    end
+
+    # Returns the singleton class's configuration object
+    #
+    # @return [Configuration] the current configuration object
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Returns true if BetterFx has been configured, false otherwise
+    #
+    # @return [Bool] true if BetterFx is configured, false otherwise
+    def configured?
+      !@configuration.nil?
+    end
+  end
+end

data/spec/better_fx/client_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe BetterFx::Client do
+  subject { described_class.new }
+
+  describe "#increment_counter" do
+    let(:value) { 1 }
+    let(:timestamp) { 12_345 }
+    let(:dimensions) { [{ env: BetterFx.configuration.current_environment }] }
+    let(:mock_fx_client) { FxMocks::MockFxClient.new }
+
+    before do
+      allow(SignalFx).to receive(:new).and_return mock_fx_client
+    end
+
+    it "sends the default incremental value to SignalFx for the specified counter" do
+      expect(mock_fx_client).
+        to receive(:bf_xmit).
+        with(counters: [
+               hash_including(
+                 metric: "sample_counter",
+                 value:  value
+               ),
+             ])
+
+      subject.increment_counter :sample_counter
+    end
+
+    describe "specifying the incremental value" do
+      let(:value) { 25 }
+      it "sends the user specified incremental value" do
+        expect(mock_fx_client).
+          to receive(:bf_xmit).
+          with(counters: [
+                 hash_including(
+                   metric: "sample_counter",
+                   value:  value
+                 ),
+               ])
+
+        subject.increment_counter :sample_counter, value: 25
+      end
+    end
+
+    describe "specifying the timestamp" do
+      let(:timestamp) { 1111 }
+      it "sends the user specified timestamp as a string" do
+        expect(mock_fx_client).
+          to receive(:bf_xmit).
+          with(counters: [
+                 hash_including(
+                   metric:    "sample_counter",
+                   value:     value,
+                   timestamp: timestamp.to_s
+                 ),
+               ])
+
+        subject.increment_counter :sample_counter, timestamp: timestamp
+      end
+    end
+
+    describe "specifying dimensional metadata" do
+      let(:dimensions) { [{ size: "Large" }] }
+      it "sends the user specified dimensional metadata" do
+        expect(mock_fx_client).
+          to receive(:bf_xmit).
+          with(counters: [
+                 hash_including(
+                   metric:     "sample_counter",
+                   value:      value,
+                   dimensions: dimensions
+                 ),
+               ])
+
+        subject.increment_counter :sample_counter, dimensions: dimensions
+      end
+    end
+  end
+end

data/spec/better_fx_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+
+describe BetterFx do
+  describe "configuring BetterFx" do
+    describe ".configure" do
+      it "yields an instance of BetterFx::Configuration to the provided configuration block" do
+        expect { |b| BetterFx.configure(&b) }.to yield_with_args BetterFx::Configuration
+      end
+      describe "configurable attributes" do
+        {
+          signalfx_api_token:     "123sdfss",
+          supported_environments: [:production, :staging],
+          current_environment:    :development,
+        }.each do |k, v|
+          describe k.to_s do
+            let(:key) { k }
+            let(:value) { v }
+
+            let(:configure_block) do
+              proc do |config|
+                config.send "#{key}=", value
+              end
+            end
+
+            it "is configurable" do
+              described_class.configure(&configure_block)
+
+              expect(described_class.configuration.public_send(k)).to eq v
+            end
+          end
+        end
+      end
+      it "allows the configuration to be reset" do
+        described_class.configure do |c|
+          c.signalfx_api_token = "original_api_token"
+        end
+        first_configuration = described_class.configuration
+
+        described_class.configure(reset: true) do |c|
+          c.current_environment = :staging
+        end
+
+        expect(described_class.configuration).not_to eq first_configuration
+        expect(described_class.configuration.signalfx_api_token).not_to eq "original_api_token"
+        expect(described_class.configuration.current_environment).to eq :staging
+      end
+    end
+  end
+
+  describe "accessing the current BetterFx configuration" do
+    describe ".configuration" do
+      context "when the BetterFx has been previously configured" do
+        before do
+          described_class.configure
+        end
+
+        it "is the current configuration of the BetterFx" do
+          expected_configuration = described_class.instance_variable_get :@configuration
+
+          expect(described_class.configuration).to eq expected_configuration
+        end
+      end
+
+      context "when the BetterFx has not been previously configured" do
+        it "sets the current configuration to a new instance of Configuration" do
+          described_class.configuration
+
+          expect(described_class.instance_variable_get(:@configuration)).to be_a BetterFx::Configuration
+        end
+
+        it "returns the new Configuration instance" do
+          expect(described_class.configuration).to eq described_class.instance_variable_get :@configuration
+        end
+      end
+    end
+  end
+end

data/spec/simplecov_custom_profile.rb

@@ -0,0 +1,4 @@
+require "simplecov"
+SimpleCov.profiles.define "better_fx" do
+  add_filter "/spec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require_relative "simplecov_custom_profile"
+SimpleCov.start "better_fx"
+require "better_fx"
+require "byebug"
+require_relative "support/mocks"

data/spec/support/mocks.rb

@@ -0,0 +1,6 @@
+module FxMocks
+  class MockFxClient
+    def bf_xmit(opts = {})
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: better_fx
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Courtland Caldwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: signalfx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.31'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: A convenient gem for developers to interact with SignalFx with a trivial
+  amount of effort
+email: engineering@mattermark.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
+- README.md
+- better_fx.gemspec
+- circle.yml
+- lib/better_fx.rb
+- lib/better_fx/client.rb
+- lib/better_fx/configuration.rb
+- spec/better_fx/client_spec.rb
+- spec/better_fx_spec.rb
+- spec/simplecov_custom_profile.rb
+- spec/spec_helper.rb
+- spec/support/mocks.rb
+homepage: https://github.com/Referly/better_fx
+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.4.2
+signing_key: 
+specification_version: 4
+summary: A more idiomatic interface to SignalFx.
+test_files:
+- spec/better_fx/client_spec.rb
+- spec/better_fx_spec.rb
+- spec/simplecov_custom_profile.rb
+- spec/spec_helper.rb
+- spec/support/mocks.rb
+has_rdoc: