slack_log_device 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 138ff680ce85491730409fffa3ffd0f863d21fdd
+  data.tar.gz: 7a74013420ab719a33a9040ed538218a39fcfb7d
+SHA512:
+  metadata.gz: 94e144e14e8ac799a3255ad22aa0397352f0deba1dfb370f9df43fed6fb459498a1baba896021cf44e4a64de8e02eb27d8e63c0e5c96e58adc694c37491f50d4
+  data.tar.gz: 7dbee60ae209b3555f022c86f7ce23b03f0f364919e75337e751f1d117323e4dd6d4437f4593b8391b093bf5e589cb839e5d3a1a101adb8810fa1e659e873813

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+/.bundle/
+/.ruby-version
+/Gemfile.lock
+/pkg/

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--order random

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Alexis Toulotte
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.mdown

@@ -0,0 +1,30 @@
+# SlackLogDevice
+
+LogDevice implementation that post logs on a Slack channel.
+
+## Setup
+
+Just add this into your `Gemfile`:
+
+```ruby
+gem 'slack_log_device'
+```
+
+Then, just run a `bundle install`.
+
+## Usage
+
+```ruby
+require 'slack_log_device'
+
+logger = Logger.new(SlackLogDevice.new(webhook_url: 'https://hooks.slack.com/services/...', username: 'MyApp'))
+logger.level = Logger::INFO
+logger.warn('BAM!')
+```
+
+Then, the logged message will be writen to webhook's configured channel.
+
+## Executing test suite
+
+This project is fully tested with [Rspec 3](http://github.com/rspec/rspec).
+Just run `bundle exec rake` (after a `bundle install`).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: runs specs.'
+task default: :spec
+
+desc 'Run all specs in spec directory.'
+RSpec::Core::RakeTask.new(:spec)

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/slack_log_device.rb

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
+require 'httparty'
+require 'logger'
+
+class SlackLogDevice
+
+  attr_reader :timeout, :username, :webhook_url
+
+  def initialize(options = {})
+    options.assert_valid_keys(:timeout, :username, :webhook_url)
+    self.timeout = options.key?(:timeout) ? options[:timeout] : 5
+    self.username = options[:username]
+    self.webhook_url = options[:webhook_url]
+  end
+
+  def close
+    # Does nothing, this method must exist to consider the LogDevice as an IO.
+  end
+
+  def timeout=(value)
+    timeout = Integer(value) rescue nil
+    raise ArgumentError.new("Invalid timeout: #{value.inspect}") if timeout.nil?
+    @timeout = timeout
+  end
+
+  def username=(value)
+    @username = value.to_s.squish.presence
+  end
+
+  def webhook_url=(value)
+    raise ArgumentError.new('Webhook URL must be specified') if value.blank?
+    uri = URI(value.to_s) rescue nil
+    raise ArgumentError.new("Invalid Webhook URL: #{value.inspect}") if uri.nil? || !uri.is_a?(URI::HTTP)
+    @webhook_url = uri.to_s
+  end
+
+  def write(message)
+    data = { 'text' => message.to_s }
+    data['username'] = username if username.present?
+    HTTParty.post(webhook_url, body: data.to_json, headers: { 'Content-Type': 'application/json' }, timeout: timeout)
+    nil
+  end
+
+end

data/slack_log_device.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = 'slack_log_device'
+  s.version = File.read("#{File.dirname(__FILE__)}/VERSION").strip
+  s.platform = Gem::Platform::RUBY
+  s.author = 'Alexis Toulotte'
+  s.email = 'al@alweb.org'
+  s.homepage = 'https://github.com/alexistoulotte/slack_log_device'
+  s.summary = 'LogDevice for Slack'
+  s.description = 'LogDevice implementation that post logs on a Slack channel'
+  s.license = 'MIT'
+
+  s.rubyforge_project = 'slack_log_device'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activesupport', '>= 5.0.0', '< 6.0.0'
+  s.add_dependency 'httparty', '>= 0.14.0', '< 0.15.0'
+
+  s.add_development_dependency 'byebug', '>= 9.0.0', '< 10.0.0'
+  s.add_development_dependency 'rake', '>= 12.0.0', '< 13.0.0'
+  s.add_development_dependency 'rspec', '>= 3.5.0', '< 3.6.0'
+end

data/spec/slack_log_device_spec.rb

@@ -0,0 +1,187 @@
+require 'spec_helper'
+
+describe SlackLogDevice do
+
+  let(:device) { SlackLogDevice.new(options) }
+  let(:logger) { Logger.new(device).tap { |logger| logger.level = Logger::INFO } }
+  let(:options) { { username: 'MyApp', webhook_url: 'https://hooks.slack.com/services/test' } }
+
+  describe '#close' do
+
+    it 'does nothing' do
+      expect {
+        device.close
+      }.not_to raise_error
+    end
+
+  end
+
+  describe '#initialize' 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: :timeout, :username, :webhook_url")
+    end
+
+    it 'raise an error if webhook option is not given' do
+      expect {
+        SlackLogDevice.new(options.except(:webhook_url))
+      }.to raise_error(ArgumentError, 'Webhook URL must be specified')
+    end
+
+  end
+
+  describe '#timeout' do
+
+    it 'is 5 by default' do
+      expect(device.timeout).to eq(5)
+    end
+
+    it 'can be specified' do
+      options[:timeout] = 10
+      expect(device.timeout).to be(10)
+    end
+
+    it 'raise an error if invalid' do
+      options[:timeout] = 'foo'
+      expect {
+        device
+      }.to raise_error(ArgumentError, 'Invalid timeout: "foo"')
+    end
+
+    it 'is default value if blank' do
+      options[:timeout] = ' '
+      expect {
+        device
+      }.to raise_error(ArgumentError, 'Invalid timeout: " "')
+    end
+
+    it 'raise an error if set as nil' do
+      expect {
+        device.timeout = nil
+      }.to raise_error(ArgumentError, 'Invalid timeout: nil')
+    end
+
+    it 'can be specified as string' do
+      options[:timeout] = '42'
+      expect(device.timeout).to eq(42)
+    end
+
+    it 'can be set' do
+      expect {
+        device.timeout = 15
+      }.to change { device.timeout }.from(5).to(15)
+    end
+
+  end
+
+  describe '#username' do
+
+    it 'is username set at initialization' do
+      expect(device.username).to eq('MyApp')
+    end
+
+    it 'is nil if not specified' do
+      device = SlackLogDevice.new(options.except(:username))
+      expect(device.username).to be_nil
+    end
+
+    it 'is squished' do
+      options[:username] = "John   Doe\n "
+      expect(device.username).to eq('John Doe')
+    end
+
+    it 'is nil if blank' do
+      options[:username] = " \n"
+      expect(device.username).to be_nil
+    end
+
+    it 'can be set' do
+      expect {
+        device.username = 'John Doe'
+      }.to change { device.username }.from(options[:username]).to('John Doe')
+    end
+
+  end
+
+  describe '#webhook_url' do
+
+    it 'is webhook_url set at initialization' do
+      expect(device.webhook_url).to eq('https://hooks.slack.com/services/test')
+    end
+
+    it 'raise an error if invalid' do
+      options[:webhook_url] = 'foo'
+      expect {
+        device
+      }.to raise_error(ArgumentError, 'Invalid Webhook URL: "foo"')
+    end
+
+    it 'can be an HTTP URL' do
+      options[:webhook_url] = 'http://google.com'
+      expect(device.webhook_url).to eq('http://google.com')
+    end
+
+    it 'can be an HTTPs URL' do
+      options[:webhook_url] = 'https://google.com'
+      expect(device.webhook_url).to eq('https://google.com')
+    end
+
+    it 'raise an error if not an HTTP(s) url' do
+      options[:webhook_url] = 'ftp://google.com'
+      expect {
+        device
+      }.to raise_error(ArgumentError, 'Invalid Webhook URL: "ftp://google.com"')
+    end
+
+    it 'can be set' do
+      expect {
+        device.webhook_url = 'http://google.com'
+      }.to change { device.webhook_url }.from(options[:webhook_url]).to('http://google.com')
+    end
+
+  end
+
+  describe '#write' do
+
+    it 'sends a post to webhook URL with given given message and specified username' do
+      expect(HTTParty).to receive(:post).with(options[:webhook_url], body: { 'text' => 'BAM!', 'username' => options[:username] }.to_json, headers: { 'Content-Type':  'application/json' }, timeout: 5)
+      device.write('BAM!')
+    end
+
+    it 'returns nil' do
+      allow(HTTParty).to receive(:post)
+      expect(device.write('BAM!')).to be_nil
+    end
+
+    it 'does not send username if nil' do
+      options.delete(:username)
+      expect(HTTParty).to receive(:post).with(options[:webhook_url], body: { 'text' => 'BAM!' }.to_json, headers: { 'Content-Type':  'application/json' }, timeout: 5)
+      device.write('BAM!')
+    end
+
+    it 'does nothing if log level is lower than specified one' do
+      expect(HTTParty).not_to receive(:post)
+      logger.debug('BIM!')
+    end
+
+    it 'send HTTP request if log level is equal to specified one' do
+      expect(HTTParty).to receive(:post)
+      logger.info('BIM!')
+    end
+
+    it 'send HTTP request if log level is higher to specified one' do
+      expect(HTTParty).to receive(:post)
+      logger.warn('BIM!')
+    end
+
+    it 'use specified timeout' do
+      options[:timeout] = 12
+      expect(HTTParty).to receive(:post).with(options[:webhook_url], body: { 'text' => 'BAM!', 'username' => options[:username] }.to_json, headers: { 'Content-Type':  'application/json' }, timeout: 12)
+      device.write('BAM!')
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require File.expand_path("#{__dir__}/../lib/slack_log_device")
+require 'byebug'
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: slack_log_device
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexis Toulotte
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+description: LogDevice implementation that post logs on a Slack channel
+email: al@alweb.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- MIT-LICENSE
+- README.mdown
+- Rakefile
+- VERSION
+- lib/slack_log_device.rb
+- slack_log_device.gemspec
+- spec/slack_log_device_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alexistoulotte/slack_log_device
+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: slack_log_device
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: LogDevice for Slack
+test_files:
+- spec/slack_log_device_spec.rb
+- spec/spec_helper.rb