null_statsd 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdcda9d6bbce5d1ed55cac57ca33e769c6bfc9b2e18b4a3b852d183f37258d90
-  data.tar.gz: 9cb8dd40167d522dd1eb21dfce10e7e1318b2b20492465d5e110e6ae9c043769
+  metadata.gz: 8a03895a65a1b40080b50230a67e3d78d1b2feebe4440a955fc7c5643d2934f0
+  data.tar.gz: ab2409351d7d8e46108689b7732fc6ed0e71e2b67cd7bbe80e9cb3cf88f0ceea
 SHA512:
-  metadata.gz: 4501b0cfc958c6c872ed08dcc2ed0ef0e2c0903f9211a067970fc0d6b3f2821dd2e8061958e12275860afb29ffdd99f114ac4bc064cb48914b1f577f8ac4f2e8
-  data.tar.gz: 5ce718a612489f86b4f2c5502c9eedf2e14f465696a2f09860c0403f05d82faef948465057c0d5c71b8c2785972568696a47d6d50c5d9b1488eab23b9d066989
+  metadata.gz: d1207c5fb60d4a4e39ecbffdf84ec0894e4e8fb7c693e08675164ec10a7e467556650dc1bd97791ed5859398c6dd0405d09a3f5d7dea631cab82200dd795fdd8
+  data.tar.gz: f201c0a149a66a10eb21b05feb63b069c0f6d27ea4816d7945e0fddf8b941d46b398a43899a2240b7d0d9bdd26f8a49ad1f753c41ca398713015bdc3929e9d8c

data/.gitignore

@@ -1,9 +1,5 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+*.gem
+coverage/

data/README.md

@@ -1,8 +1,8 @@
 # NullStatsd
 
-NullStatsd is a [Statsd](https://github.com/statsd/statsd) implementation which utilizes the
-[Null Object Pattern](https://en.wikipedia.org/wiki/Null_object_pattern), allowing for a fully
-stubbed Statsd object in your development and testing environments.
+NullStatsd is a [Null Object Pattern](https://en.wikipedia.org/wiki/Null_object_pattern)
+implementation of a [Statsd](https://github.com/statsd/statsd) client, allowing for
+conveniently stubbed Statsd objects in your development and testing environments.
 
 ## Installation
 
@@ -22,28 +22,36 @@ Or install it yourself as:
 
 ## Usage
 
-Create a thin wrapper around your Statsd implementation:
+Create a wrapper around your Statsd implementation:
 
 ```ruby
 module MyStatsd
   def self.new
-    if ENV["STATSD_HOST"] # OR if Rails.development || Rails.staging ...
-      Statsd.new(statsd_host, statsd_port, *additional_params)
+    if ENV["STATSD_HOST"] && ENV["STATSD_PORT"]
+      Statsd.new(ENV["STATSD_HOST"], ENV["STATSD_PORT"])
     else
-      NullStatsd::Statsd.new(host: statsd_host, port: statsd_port, logger: Rails.logger)
+      NullStatsd::Statsd.new(host: "fake.host", port: 1234, logger: Logger.new($stderr))
     end
   end
 end
+
+# or perhaps
+
+if Rails.env.production? || Rails.env.staging?
+  $statsd = Datadog::Statsd.new(ENV["DD_HOST"], ENV["DD_PORT"])
+else
+  $statsd = NullStatsd::Statsd.new(host: "fa.ke", port: 42, logger: Rails.logger)
+end
 ```
 
 Create an instance and use it as normal:
 
 ```ruby
 MyStatsd.new.increment(...)
+$statsd.increment(...)
 ```
 
-Notice that your `statsd` endpoint is _not_ receiving data. Also notice that your _logs_ are
-receiving data.
+Notice that your `statsd` endpoint is _not_ receiving data, but your logs are.
 
 ```
 [NullStatsD host:42] Incrementing media.book.consumed with opts {"genre":"science_fiction"}
@@ -51,118 +59,62 @@ receiving data.
 [NullStatsD host:42] Recording timing info in book.checkout -> 0.512917 sec
 ```
 
-### Supported API
+### Supported Calls
 
 ```ruby
-instance = NullStatsd::Statsd.new(host: "fake.com", port: 4242, logger: Logger.new($stdout))
-```
+statsd = NullStatsd::Statsd.new(host: "a.co" port: 42, logger: Logger.new($stdout))
+# => [NullStatsD a.co:42] Connecting to fake Statsd, pretending to be on fake.com:4242
 
-> [NullStatsD :-] Connecting to fake Statsd, pretending to be on fake.com:4242
+statsd.increment "media.book.consumed", genre: "horror"
+# => [NullStatsD a.co:42] Incrementing media.book.consumed with opts {"genre":"horror"}
 
-#### increment(stat, opts = {})
+statsd.decrement "media.book.on_hand", genre: "science fiction"
+# => [NullStatsD a.co:42] Decrementing media.book.on_hand with opts {"genre":"science fiction"}
 
-```ruby
-instance.increment "media.book.consumed", genre: "horror"
-```
+statsd.count "responses", 3
+# => [NullStatsD a.co:42] Increasing responses by 3
 
-> [NullStatsD :-] Incrementing media.book.consumed with opts genre:horror
+statsd.gauge "media.book.return_time", 12, measurement: "days"
+# => [NullStatsD a.co:42] Setting gauge media.book.return_time to 12 with opts {"measurement":"days"}
 
-#### decrement(stat, opts = {})
+statsd.histogram "media.book.lent.hour", 42
+# => [NullStatsD a.co:42] Logging histogram media.book.lent.hour -> 42
 
-```ruby
-instance.decrement "media.book.on_hand", genre: "science fiction"
-```
-
-> [NullStatsD :-] Decrementing media.book.on_hand with opts genre:science fiction
-
-#### count(stat, opts = {})
-
-```ruby
-instance.count "responses", 3
-```
+statsd.timing "book checkout", 94, tags: "speedy"
+# => [NullStatsD a.co:42] Timing book checkout at 94 ms with opts {"tags":"speedy"}
 
-> [NullStatsD :-] Increasing responses by 3
+statsd.set "media.book.lent", 10_000_000
+# => [NullStatsD a.co:42] Setting media.book.lent to 10000000
 
-#### guage(stat, opts = {})
+statsd.service_check "door.locked", "ok"
+# => [NullStatsD a.co:42] Service check door.locked: ok
 
-```ruby
-instance.guage "media.book.return_time", 12, measurement: "days"
-```
-
-> [NullStatsD :-] Setting guage media.book.return_time to 12 with opts measurement:days
-
-#### histogram(stat, opts = {})
-
-```ruby
-instance.histogram "media.book.lent.hour", 42
-```
-
-> [NullStatsD :-] Logging histogram media.book.lent.hour -> 42
-
-#### timing(stat, ms, opts = {})
-
-```ruby
-instance.timing "book checkout", 94, tags: "speedy"
-```
+statsd.event "Leak", "The library roof has a leak on the west end. Please take care"
+# => [NullStatsD a.co:42] Event Leak: The library roof has a leak on the west end. Please take care
 
-> [NullStatsD :-] Timing book checkout at 94 ms with opts tags:speedy
-
-#### set(stat, opts = {})
-
-```ruby
-instance.set "media.book.lent", 10_000_000
-```
-
-> [NullStatsD :-] Setting media.book.lent to 10000000
-
-#### service_check(stat, opts = {})
-
-```ruby
-instance.service_check "door.locked", "ok"
-```
-
-> [NullStatsD :-] Service check door.locked: ok
-
-#### event(stat, opts = {})
-
-```ruby
-instance.event "Leak", "The library roof has a leak on the west end. Please take care"
-```
-
-> [NullStatsD :-] Event Leak: The library roof has a leak on the west end. Please take care
-
-#### time(stat, opts = {})
-
-```ruby
-instance.time("media.movie.consume") do
+statsd.time("media.movie.consume") do
   Movie.new().watch
 end
-```
-
-> [NullStatsD :-] Recording timing info in media.movie.consumed -> 12323 sec
+# => [NullStatsD a.co:42] Recording timing info in media.movie.consumed -> 12323.23 sec
 
-#### close(stat, opts = {})
+statsd.close
+# => [NullStatsD a.co:42] Close called
 
-```ruby
-instance.close
+statsd.batch do |s|
+  s.increment "foo.bar"
+  s.increment "baz"
+end
+# This just executes the block, yielding the statsd instance to it.
 ```
 
-> [NullStatsD :-] Close called
-
 ## Testing
 
 `rake spec`
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+This gem is available as open source under the terms of the [MIT License](LICENSE.txt).
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
-
 Bug reports and pull requests are welcome on GitHub.

data/lib/null_statsd/version.rb

@@ -1,3 +1,3 @@
 module NullStatsd
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/null_statsd.gemspec

@@ -6,15 +6,21 @@ require "null_statsd/version"
 Gem::Specification.new do |spec|
   spec.name          = "null_statsd"
   spec.version       = NullStatsd::VERSION
-  spec.authors       = ["Imad Mouaddine"]
-  spec.email         = ["imouaddine@usertesting.com"]
-  spec.summary       = %q{Implements null pattern for Statsd client}
-  spec.description   = %q{Implements null pattern for Statsd client}
-  spec.homepage      = "https://github.com/usertesting/null_statsd"
+  spec.authors       = ["Imad Mouaddine", "Perry Lee", "Bob Ziuchkovski", "Andrew Selder", "Chris DiMartino", "Justin Aiken", "Eric Mueller"]
+  spec.email         = ["nevinera@gmail.com"]
+  spec.summary       = %q{Implements null-object pattern for Statsd client}
+  spec.description   = %q{Implements null-object pattern for Statsd client}
+  spec.homepage      = "https://github.com/nevinera/null_statsd"
   spec.license       = "MIT"
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|UserTesting.png)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.start_with?("spec") }
+  end
+
+  spec.bindir        = "bin"
+  spec.executables   = []
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.2"

metadata

@@ -1,12 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: null_statsd
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Imad Mouaddine
+- Perry Lee
+- Bob Ziuchkovski
+- Andrew Selder
+- Chris DiMartino
+- Justin Aiken
+- Eric Mueller
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
@@ -66,9 +72,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
-description: Implements null pattern for Statsd client
+description: Implements null-object pattern for Statsd client
 email:
-- imouaddine@usertesting.com
+- nevinera@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -88,7 +94,7 @@ files:
 - lib/null_statsd/statsd.rb
 - lib/null_statsd/version.rb
 - null_statsd.gemspec
-homepage: https://github.com/usertesting/null_statsd
+homepage: https://github.com/nevinera/null_statsd
 licenses:
 - MIT
 metadata: {}
@@ -110,5 +116,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Implements null pattern for Statsd client
+summary: Implements null-object pattern for Statsd client
 test_files: []