hosted_graphite 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a96d4721686e9b29cded57b6624a05bec73484c
-  data.tar.gz: e2350801a97eb3b09b97e2ea36e8c97241fd4463
+  metadata.gz: 4272720da2d9eb6e32be3a43dd1b7188fc363550
+  data.tar.gz: e12ca2cb51e10288ccf138740f3541f7fbad908d
 SHA512:
-  metadata.gz: 9f6f7351e6d2be3135e9a6f88772e6e3c5d81d1fb71baffa8558f5b4404ea7d4a3592f380b38e93f505013272220f574d0e69ae33c5fecdb97fea05b67d2106d
-  data.tar.gz: 4c93fd58f0c53687a8165f337eb532c404c4c132b54c8862eae29dbabad6ca06b7ebdfb19f602281ccf09b6c4b23dffd263a01b221fad703513d708dfbfde91d
+  metadata.gz: 7d6779726beaaeac6d344c0f26846d087a1d3cefc59884a01d5dc41a3ac427a921f6e08349c69c70c7b303a4106153f545180a879df6bb17a5b47882eebb7c17
+  data.tar.gz: '048f1ff89f556e12537c6b421d8cce685b31d5adfdf914de1dfd7d54605309dcd77f54de56f9c5d048ec7b0053c8308f8e42dfd07d87d08b23ea0acc2b8c72e2'

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.2
+  - 2.3.3
+  - 2.2.5
   - 2.1
   - 2.0.0
-  - 1.9.3
-  - jruby-19mode
-  - rbx-2
+  - ruby-head
+
+matrix:
+ allow_failures:
+  - rvm: ruby-head

data/CHANGELOG.md

@@ -1 +1,5 @@
-1.0.1 : Add sidekiq extension
+* 0.2.0 : 
+    * Added flag to enable metric sending #16
+    * Added namespace for statsd #15
+    * Remove unsupported version of ruby
+* 0.1.1 : Add sidekiq extension

data/README.md

@@ -32,10 +32,16 @@ Your API key can be found on your [account home](https://www.hostedgraphite.com/
 
 You can also set the hosted graphite API key programatically with:
 
-```bash
+```ruby
 HostedGraphite.api_key = 'YOUR API KEY'
 ```
 
+You may also specify a namespace for your metrics, which will be applied if you are using the StatsD backend:
+
+```bash
+HostedGraphite.namespace = 'our_app'
+```
+
 #### Sending a metric via UDP
 ```ruby
 HostedGraphite.protocol = :udp
@@ -81,17 +87,23 @@ HostedGraphite.time('newsletter.monthly') { @newsletter.deliver_now }
 
 ### Extensions
 #### Sidekiq
-```ruby 
-  require 'hosted_graphite/ext/sidekiq'
-
-  Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      # my_app is an optional namespace
-      # chain.prepend HostedGraphite::Ext::Sidekiq::StatsdMetrics, 'my_app'
-      # or
-      # chain.prepend HostedGraphite::Ext::Sidekiq::Metrics
-    end
+```ruby
+require 'hosted_graphite/ext/sidekiq'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    # my_app is an optional namespace
+    # chain.prepend HostedGraphite::Ext::Sidekiq::StatsdMetrics, 'my_app'
+    # or
+    # chain.prepend HostedGraphite::Ext::Sidekiq::Metrics
   end
+end
+```
+
+### Disable sends for local/test environments
+
+```ruby
+HostedGraphite.enabled = false unless Rails.env.production?
 ```
 
 ## Contributing

data/hosted_graphite.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'A Ruby client for HostedGraphite'
   spec.homepage      = 'https://github.com/seuros/hosted_graphite'
   spec.license       = 'Apache 2.0'
-  spec.required_ruby_version     = '>= 1.9.3'
+  spec.required_ruby_version     = '>= 2.0.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^(test)/})

data/lib/hosted_graphite.rb

@@ -6,11 +6,10 @@ require 'hosted_graphite/protocol'
 module HostedGraphite
   extend Forwardable
   extend self
-  attr_reader :namespace, :protocol
-  attr_writer :namespace, :api_key
 
-  def_delegators :protocol, :send_metric
-  module_function :send_metric
+  attr_accessor :namespace, :enabled
+  attr_reader :protocol
+  attr_writer :api_key
 
   class MissingAPIKey < StandardError
     def initialize
@@ -22,14 +21,25 @@ module HostedGraphite
     @api_key ||= ENV['HOSTEDGRAPHITE_APIKEY']
   end
 
-   def protocol=(protocol)
+  def enabled?
+    @enabled.nil? ? true : @enabled
+  end
+
+  def send_metric(*args)
+    protocol.send_metric(*args) if enabled?
+  end
+  module_function :send_metric
+
+  def protocol=(protocol)
     protocol   = protocol.to_s.downcase
     require "hosted_graphite/protocols/#{protocol}"
     @protocol = @registred_protocols[protocol].new
-   end
+  end
 
   @registred_protocols = {}
-  private def register(name, klass)
+  private
+
+  def register(name, klass)
     @registred_protocols[name] = klass
   end
 end

data/lib/hosted_graphite/protocols/statsd.rb

@@ -12,7 +12,11 @@ module HostedGraphite
     def initialize
       raise MissingAPIKey unless HostedGraphite.api_key
       super(HOST, PORT)
-      self.namespace = [HostedGraphite.api_key,HostedGraphite.namespace].join('.')
+      if HostedGraphite.namespace
+        self.namespace = [HostedGraphite.api_key,HostedGraphite.namespace].join('.')
+      else
+        self.namespace = HostedGraphite.api_key
+      end
     end
   end
 

data/lib/hosted_graphite/statsd.rb

@@ -1 +1 @@
-HostedGraphite.protocol = :stastd
+HostedGraphite.protocol = :statsd

data/lib/hosted_graphite/version.rb

@@ -1,3 +1,3 @@
 module HostedGraphite
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/test/test_enabling.rb

@@ -0,0 +1,35 @@
+require_relative 'helper'
+
+class DefaultBehaviourTest < Minitest::Test
+  def setup
+    HostedGraphite.protocol = :http
+  end
+
+  def test_enabled_by_default
+    assert_equal true, HostedGraphite.enabled?
+  end
+
+  def test_send_by_default
+    assert_send [HostedGraphite.protocol, :send_metric, *['foo', 1.2]]
+    HostedGraphite.send_metric 'foo', 1.2
+  end
+end
+
+
+class DisabledTest < Minitest::Test
+  def setup
+    @previous_api_key = HostedGraphite.api_key
+    HostedGraphite.api_key = nil
+    HostedGraphite.enabled = false
+  end
+
+  def teardown
+    HostedGraphite.enabled = nil
+    HostedGraphite.api_key = @previous_api_key
+  end
+
+  def test_metric_send
+    # Will raise HostedGraphite::MissingAPIKey if incorrect
+    HostedGraphite.send_metric 'foo', 1.2
+  end
+end

data/test/test_stastd.rb

@@ -28,4 +28,22 @@ class StatsDTest < Minitest::Test
   def test_respond_to_increment
     assert_respond_to HostedGraphite, :increment
   end
+
+  def test_initialize_without_namespace
+    old_namespace = HostedGraphite.namespace
+    HostedGraphite.namespace = nil
+
+    assert_equal HostedGraphite.api_key, HostedGraphite::STATSD.new.namespace
+
+    HostedGraphite.namespace = old_namespace
+  end
+
+  def test_initialize_with
+    old_namespace = HostedGraphite.namespace
+    HostedGraphite.namespace = "foo"
+
+    assert_equal "#{HostedGraphite.api_key}.foo", HostedGraphite::STATSD.new.namespace
+
+    HostedGraphite.namespace = old_namespace
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hosted_graphite
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ files:
 - lib/hosted_graphite/testing.rb
 - lib/hosted_graphite/version.rb
 - test/helper.rb
+- test/test_enabling.rb
 - test/test_http_protocol.rb
 - test/test_missing_apikey.rb
 - test/test_stastd.rb
@@ -97,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -105,12 +106,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A Ruby client for HostedGraphite
 test_files:
 - test/helper.rb
+- test/test_enabling.rb
 - test/test_http_protocol.rb
 - test/test_missing_apikey.rb
 - test/test_stastd.rb