slack_log_device 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32885688b1cd9ac6a722a1a6f33555c509eb165f
-  data.tar.gz: 74ccc8aaa57329d2290dee6601fd6d82f9e31663
+  metadata.gz: f7c2fbccccb4df5730e6f9ea792d23df250aeaae
+  data.tar.gz: 03700bccd9ef1366dfe3035d8ba31db4aa87002b
 SHA512:
-  metadata.gz: 5fbf9de73db847487a88e5dd455865c4d892ad47fa2bd95c687655165c7da7701970d4a785931c1eb7c32ce1733c10963e3654940aefc3ff1590ee266a08c882
-  data.tar.gz: 2345e2526588ca41890abbd5e9864311b2ac19fd58c108608766eda3f2547629cba76846ef1d20f2d0a06f55db689d4c1afcc00b62fe51aea96ce1405742c6d0
+  metadata.gz: 951dc372a3de3848fa203ad903e4bb5c2efde689a28f52249730cadd8555b0137365b845f1fd089f6860857e9faeb957702f110d8e7ca6bdcc105e73423b9993
+  data.tar.gz: 9735f2db5fd0ea7332023c9c8211d7974d07fc6365fc15e01bf87d66782dfc232c041792850ceb991b093ff9d08ae223c1c68ad444e3687fbc63307be777a99a

data/README.mdown

@@ -31,12 +31,26 @@ request.
 
 - `auto_flush`: To flush messages directly when a message is written (disabled
 by default).
-- `flush_delay`: The delay in seconds to flush messages (1 by default).
+- `channel`: The channel to post message on (webhook configured channel by
+default). It can be a channel (if starting with `#`) or a specific user (if
+starting with a `@`).
+- `flush_delay`: The delay in seconds to send buffered messages (1 by default).
 - `max_buffer_size`: The max buffer size to flush messages (8192 by default).
 - `timeout`: The timeout in seconds to send message to slack (5 by default).
 - `username`: The username to post message as (nil by default).
 - `webhook_url`: The URL of the webhook (mandatory).
 
+## Rails configuration
+
+For a rails application, it is recommanded to use following configuration into
+`config/environments/production.rb` file:
+
+```ruby
+config.logger = ActiveSupport::Logger.new(SlackLogDevice.new(webhook_url: 'https://hooks.slack.com/services/...', username: 'MyRailsApp'))
+config.logger.formatter = ::Logger::Formatter.new
+config.log_level = :warn
+```
+
 ## Executing test suite
 
 This project is fully tested with [Rspec 3](http://github.com/rspec/rspec).

data/VERSION

@@ -1 +1 @@
-2.0.1
+2.1.0

data/lib/slack_log_device.rb

@@ -5,14 +5,15 @@ require 'logger'
 
 class SlackLogDevice
 
-  attr_reader :flush_delay, :max_buffer_size, :timeout, :username, :webhook_url
+  attr_reader :channel, :flush_delay, :max_buffer_size, :timeout, :username, :webhook_url
 
   def initialize(options = {})
-    options.assert_valid_keys(:auto_flush, :flush_delay, :max_buffer_size, :timeout, :username, :webhook_url)
+    options.assert_valid_keys(:auto_flush, :channel, :flush_delay, :max_buffer_size, :timeout, :username, :webhook_url)
     @buffer = []
     @mutex = Mutex.new
     @flush_thread
     self.auto_flush = options[:auto_flush]
+    self.channel = options[:channel]
     self.flush_delay = options.key?(:flush_delay) ? options[:flush_delay] : 1
     self.max_buffer_size = options.key?(:max_buffer_size) ? options[:max_buffer_size] : 8192
     self.timeout = options.key?(:timeout) ? options[:timeout] : 5
@@ -28,6 +29,12 @@ class SlackLogDevice
     @auto_flush = value.present?
   end
 
+  def channel=(value)
+    channel = value.to_s.presence
+    raise ArgumentError.new("Invalid channel specified: #{value.inspect}, it must start with # or @ and be in lower case with no spaces or special chars and its length must not exceed 22 chars") if channel && channel !~ /^[@#][a-z0-9_-]{1,21}$/
+    @channel = channel
+  end
+
   def close
     # Does nothing, this method must exist to consider the LogDevice as an IO.
   end
@@ -40,6 +47,7 @@ class SlackLogDevice
       @buffer.clear
     end
     data = { 'text' => message.to_s }
+    data['channel'] = channel if channel.present?
     data['username'] = username if username.present?
     begin
       HTTParty.post(webhook_url, body: data.to_json, headers: { 'Content-Type': 'application/json' }, timeout: timeout)

data/spec/slack_log_device_spec.rb

@@ -34,6 +34,65 @@ describe SlackLogDevice do
 
   end
 
+  describe '#channel' do
+
+    it 'is null by default' do
+      options.delete(:channel)
+      expect(device.channel).to be_nil
+    end
+
+    it 'is nil if blank' do
+      options[:channel] = "  \n"
+      expect(device.channel).to be_nil
+    end
+
+    it 'can be set' do
+      expect {
+        device.channel = '#foo-bar_42abc'
+      }.to change { device.channel  }.from(nil).to('#foo-bar_42abc')
+    end
+
+    it 'raise an error if it contains spaces' do
+      expect {
+        device.channel = '#foo bar'
+      }.to raise_error(ArgumentError, 'Invalid channel specified: "#foo bar", it must start with # or @ and be in lower case with no spaces or special chars and its length must not exceed 22 chars')
+    end
+
+    it 'raise an error if it contains more than 22 chars (including #)' do
+      expect {
+        device.channel = "##{'a' * 22}"
+      }.to raise_error(ArgumentError)
+      device.channel = "##{'a' * 21}" # ok
+    end
+
+    it 'raise an error if it contains upper case letters' do
+      expect {
+        device.channel = '#Foo'
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'raise an error if it contains special chars' do
+      expect {
+        device.channel = '#f{oo'
+      }.to raise_error(ArgumentError)
+    end
+
+    it 'raise an error if it does not start with a # or @' do
+      expect {
+        device.channel = 'foo'
+      }.to raise_error(ArgumentError)
+      device.channel = '#foo' # ok
+      device.channel = '@foo' # ok
+    end
+
+    it 'raise an error if it only contains prefix' do
+      expect {
+        device.channel = '#'
+      }.to raise_error(ArgumentError)
+    end
+
+  end
+
   describe '#flush' do
 
     it 'sends a post to webhook URL with given given message and specified username' do
@@ -49,6 +108,13 @@ describe SlackLogDevice do
       device.flush
     end
 
+    it 'use specified channel' do
+      options[:channel] = '#foo'
+      device.write('BAM!')
+      expect(HTTParty).to receive(:post).with(options[:webhook_url], body: { 'text' => 'BAM!', 'channel': '#foo', 'username' => options[:username] }.to_json, headers: { 'Content-Type':  'application/json' }, timeout: 5)
+      device.flush
+    end
+
     it 'use specified timeout' do
       options[:timeout] = 12
       device.write('BAM!')
@@ -155,7 +221,7 @@ describe SlackLogDevice do
     it 'raise an error if an invalid option is given' do
       expect {
         SlackLogDevice.new(foo: 'bar')
-      }.to raise_error(ArgumentError, "Unknown key: :foo. Valid keys are: :auto_flush, :flush_delay, :max_buffer_size, :timeout, :username, :webhook_url")
+      }.to raise_error(ArgumentError, "Unknown key: :foo. Valid keys are: :auto_flush, :channel, :flush_delay, :max_buffer_size, :timeout, :username, :webhook_url")
     end
 
     it 'raise an error if webhook option is not given' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_log_device
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport