canvas_statsd 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20b65aeab0a367d302645a5fa07c71e7872cb01c
-  data.tar.gz: 5462c8e69bb13a7d9f45edec5798e6a14314fec9
+  metadata.gz: 7f93d09a249a24e64798dd4e4b1554b1132cf2e5
+  data.tar.gz: c104aae22f8fe8bf5f86d2e92aa2cda2218f1fb0
 SHA512:
-  metadata.gz: aee1dbcd4be2719c96495044846a917f422e2ce02e1cd1f0f142280afb50a4e25a30c92ee7055a1922be08b7c0299f6752cea06d90b9112b31b3ab25310f36f9
-  data.tar.gz: 49c787c0a6a4ee69f9f68370405218311428d68a7e1f4a1c8449b2eba1108bea6f4b2ecd464961807f08cc9078e6e6d9c1f056d3a6f2b644a7d21474bcbf9450
+  metadata.gz: dfe9e66cff26fe7687e592d6d668295609577228dfa46ae7c3f81cdd2295585cbe9ec571f1547554e0df429012d02d3d68111fb9167ae2ecb63dc70380d3ebc8
+  data.tar.gz: ab4ffc4acf17efc36669900d9e26400a18fc59e547162e59974e15146599129edae89dd4ef190a5e46e62ce9dea43cfb0b1795e4e46fb6f6d774d2c67ca9c6aa

data/lib/canvas_statsd.rb

@@ -3,6 +3,8 @@ require "aroi" if defined?(ActiveRecord)
 
 module CanvasStatsd
 
+  class ConfigurationError < StandardError; end
+
   require "canvas_statsd/statsd"
   require "canvas_statsd/request_stat"
   require "canvas_statsd/counter"
@@ -27,11 +29,20 @@ module CanvasStatsd
       append_hostname: env.fetch('CANVAS_STATSD_APPEND_HOSTNAME', nil),
     }
     config.delete_if {|k,v| v.nil?}
-    config[:append_hostname] = false if config[:append_hostname] == 'false';
-    config[:append_hostname] = true if config[:append_hostname] == 'true';
+    convert_bool(config, :append_hostname)
     config[:host] ? config : {}
   end
 
+  def self.convert_bool(hash, key)
+    value = hash[key]
+    return if value.nil?
+    unless ['true', 'false', true, false].include?(value)
+      message = "#{key} must be a boolean, or the string representation of a boolean, got: #{value}"
+      raise CanvasStatsd::ConfigurationError, message
+    end
+    hash[key] = (value == 'true' || value == true) ? true : false
+  end
+
   def self.track_default_metrics options={}
     CanvasStatsd::DefaultTracking.track_default_metrics options
   end

data/spec/canvas_statsd/canvas_statsd_spec.rb

@@ -66,6 +66,39 @@ describe CanvasStatsd do
     end
   end
 
+  describe ".convert_bool" do
+    it 'sets string true values to boolean true' do
+      config = {potential_string_bool: 'true'}
+      CanvasStatsd.convert_bool(config, :potential_string_bool)
+      expect(config[:potential_string_bool]).to be(true)
+    end
+    it 'sets boolean true values to boolean true' do
+      config = {potential_string_bool: true}
+      CanvasStatsd.convert_bool(config, :potential_string_bool)
+      expect(config[:potential_string_bool]).to be(true)
+    end
+    it 'sets false strings to boolean false' do
+      config = {potential_string_bool: 'false'}
+      CanvasStatsd.convert_bool(config, :potential_string_bool)
+      expect(config[:potential_string_bool]).to be(false)
+    end
+    it 'sets false booleans to boolean false' do
+      config = {potential_string_bool: false}
+      CanvasStatsd.convert_bool(config, :potential_string_bool)
+      expect(config[:potential_string_bool]).to be(false)
+    end
+    it 'makes no change for nil values' do
+      config = {foo: 'bar'}
+      CanvasStatsd.convert_bool(config, :potential_string_bool)
+      expect(config).to eq({foo: 'bar'})
+    end
+    it 'raises error for non true or false strings or booleans' do
+      config = {potential_string_bool: 'trrruuue'}
+      expect{CanvasStatsd.convert_bool(config, :potential_string_bool)}.to raise_error(CanvasStatsd::ConfigurationError)
+    end
+
+  end
+
   describe ".env_settings" do
     it 'returns empty hash when no CANVAS_STATSD_HOST found' do
       env = {
@@ -120,6 +153,31 @@ describe CanvasStatsd do
       }
       expect(CanvasStatsd.env_settings(env)).to eq(expected)
     end
+
+    it 'keeps boolean false values for append_hostname' do
+      env = {
+        'CANVAS_STATSD_HOST' => 'statsd.example.org',
+        'CANVAS_STATSD_APPEND_HOSTNAME' => false,
+      }
+      expected = {
+        host: 'statsd.example.org',
+        append_hostname: false,
+      }
+      expect(CanvasStatsd.env_settings(env)).to eq(expected)
+    end
+
+    it 'keeps boolean true values for append_hostname' do
+      env = {
+        'CANVAS_STATSD_HOST' => 'statsd.example.org',
+        'CANVAS_STATSD_APPEND_HOSTNAME' => true,
+      }
+      expected = {
+        host: 'statsd.example.org',
+        append_hostname: true,
+      }
+      expect(CanvasStatsd.env_settings(env)).to eq(expected)
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canvas_statsd
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Nick Cloward
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statsd-ruby