uniform_notifier 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af156f048a5a329b12177c3f216ea1c37725913d
-  data.tar.gz: 93332d5a47dd8fe72b9bb96f32af84a00311d90c
+  metadata.gz: ef9b9fde70b51c9e9f5ddb5478cdbcd425d0329c
+  data.tar.gz: 3ea627b20c17915ae9c14553c5d01514ea0399e4
 SHA512:
-  metadata.gz: 0645408ab0c74162980903651b904181b815f3f9e0bcbcb3c2906c14e6c81765d989fcfa12893ee63692bb357abede0342df55db34c616eb1c3dadf43bb70f7a
-  data.tar.gz: b160237f909b1063cd442df10d434edccb9a1c4d41b978255b011e31d68cfc7b4e2c2f0d72e781494f1f6fddf7898b5f8741da7b004744fadf6e841245844e08
+  metadata.gz: c7dd7f936ecda2ef1c3cf4f4b52eda389256b55bb296d5d201050ba0f43743371d4defc17029a7ddfdf620a292209a99e555018004c8eabee3ed4fa4fea4c01a
+  data.tar.gz: d9516d3ed87ac936ffec1cfbadb669071ab2c7f9f8bc23883f82632d9bb6820bb04d96336081363eeb403d364886ebae942354666749e7e8d5d0f2a21fa6bb7b

data/lib/uniform_notifier.rb

@@ -8,13 +8,14 @@ require 'uniform_notifier/rails_logger'
 require 'uniform_notifier/customized_logger'
 require 'uniform_notifier/airbrake'
 require 'uniform_notifier/bugsnag'
+require 'uniform_notifier/slack'
 require 'uniform_notifier/raise'
 
 module UniformNotifier
   class NotificationError < StandardError; end
 
   class <<self
-    attr_accessor :alert, :console, :growl, :rails_logger, :xmpp, :airbrake, :bugsnag, :raise
+    attr_accessor :alert, :console, :growl, :rails_logger, :xmpp, :airbrake, :bugsnag, :slack, :raise
 
     NOTIFIERS = [JavascriptAlert, JavascriptConsole, Growl, Xmpp, RailsLogger, CustomizedLogger, AirbrakeNotifier, BugsnagNotifier, Raise]
 
@@ -34,6 +35,10 @@ module UniformNotifier
       UniformNotifier::CustomizedLogger.setup(logdev)
     end
 
+    def slack=(slack)
+      UniformNotifier::Slack.setup_connection(slack)
+    end
+
     def raise=(exception_class)
       UniformNotifier::Raise.setup_connection(exception_class)
     end

data/lib/uniform_notifier/slack.rb

@@ -0,0 +1,51 @@
+module UniformNotifier
+  class Slack < Base
+    POSSIBLE_OPTIONS = [:username, :channel]
+
+    @slack = nil
+
+    class << self
+      def active?
+        @slack
+      end
+
+      def setup_connection(config={})
+        webhook_url, options = parse_config(config)
+        fail_connection('webhook_url required for Slack notification') unless webhook_url
+
+        require 'slack-notifier'
+        @slack = ::Slack::Notifier.new webhook_url, options
+      rescue LoadError
+        fail_connection 'You must install the slack-notifier gem to use Slack notification: '\
+                        '`gem install slack-notifier`'
+      end
+
+      protected
+
+        def _out_of_channel_notify(data)
+          message = data.values.compact.join("\n")
+          notify(message)
+        end
+
+      private
+
+        def fail_connection(message)
+          @slack = nil
+          raise NotificationError.new(message)
+        end
+
+        def notify(message)
+          @slack.ping message
+        end
+
+        def parse_config(config)
+          options = config.select do |name, value|
+            POSSIBLE_OPTIONS.include?(name) && !value.nil?
+          end
+
+          return config[:webhook_url], options
+        end
+
+    end
+  end
+end

data/lib/uniform_notifier/version.rb

@@ -1,3 +1,3 @@
 module UniformNotifier
-  VERSION = "1.6.2"
+  VERSION = "1.7.0"
 end

data/spec/spec_helper.rb

@@ -3,4 +3,5 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 require "uniform_notifier"
 require "ruby-growl"
 require "xmpp4r"
+require "slack-notifier"
 require "rspec"

data/spec/uniform_notifier/slack_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe UniformNotifier::Slack do
+  context 'not enabled' do
+    it 'should not notify slack' do
+      expect_any_instance_of(Slack::Notifier).to_not receive(:ping)
+      expect(UniformNotifier::Slack.out_of_channel_notify(:title => 'notify slack')).to be_nil
+    end
+  end
+
+  context 'configuration' do
+    context 'no webhook_url is given' do
+      it 'should raise an error' do
+        expect{ UniformNotifier.slack = {} }.to raise_error(UniformNotifier::NotificationError)
+      end
+
+      it 'should not notify slack' do
+        begin
+          UniformNotifier.slack = {}
+        rescue UniformNotifier::NotificationError
+        ensure
+          expect_any_instance_of(Slack::Notifier).to_not receive(:ping)
+          expect(UniformNotifier::Slack.out_of_channel_notify(:title => 'notify slack')).to be_nil
+        end
+      end
+    end
+
+    it 'should remove invalid options' do
+      expect(Slack::Notifier).to receive(:new).with('http://some.slack.url', {}).and_return(true)
+      UniformNotifier.slack = { :webhook_url => 'http://some.slack.url', :pizza => 'pepperoni' }
+      expect(UniformNotifier::Slack.active?).to eq true
+    end
+
+    it 'should allow username and channel config options' do
+      expect(Slack::Notifier).to receive(:new).with('http://some.slack.url', { :username => 'The Dude', :channel => '#carpets' }).and_return(true)
+      UniformNotifier.slack = { :webhook_url => 'http://some.slack.url', :username => 'The Dude', :channel => '#carpets' }
+      expect(UniformNotifier::Slack.active?).to eq true
+    end
+  end
+
+  context 'properly configured' do
+    before(:each) do
+      @message = 'notify slack'
+      allow_any_instance_of(Slack::Notifier).to receive(:ping).and_return(@message)
+    end
+
+    it 'should notify slack' do
+      UniformNotifier.slack = { :webhook_url => 'http://some.slack.url' }
+      expect_any_instance_of(Slack::Notifier).to receive(:ping)
+      expect(UniformNotifier::Slack.out_of_channel_notify(:title => @message)).to eq @message
+    end
+  end
+end

data/uniform_notifier.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency %q<ruby-growl>, ["= 4.0"]
   s.add_development_dependency %q<ruby_gntp>, ["= 0.3.4"]
   s.add_development_dependency %q<xmpp4r>, ["= 0.5"]
+  s.add_development_dependency %q<slack-notifier>, [">= 1.0"]
   s.add_development_dependency %q<rspec>, ["> 0"]
 
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uniform_notifier
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-growl
@@ -52,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,7 @@ files:
 - lib/uniform_notifier/javascript_console.rb
 - lib/uniform_notifier/rails_logger.rb
 - lib/uniform_notifier/raise.rb
+- lib/uniform_notifier/slack.rb
 - lib/uniform_notifier/version.rb
 - lib/uniform_notifier/xmpp.rb
 - spec/spec_helper.rb
@@ -103,6 +118,7 @@ files:
 - spec/uniform_notifier/javascript_console_spec.rb
 - spec/uniform_notifier/rails_logger_spec.rb
 - spec/uniform_notifier/raise_spec.rb
+- spec/uniform_notifier/slack_spec.rb
 - spec/uniform_notifier/xmpp_spec.rb
 - uniform_notifier.gemspec
 homepage: http://rubygems.org/gems/uniform_notifier
@@ -124,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: uniform_notifier
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: uniform notifier for rails logger, customized logger, javascript alert, javascript
@@ -140,4 +156,5 @@ test_files:
 - spec/uniform_notifier/javascript_console_spec.rb
 - spec/uniform_notifier/rails_logger_spec.rb
 - spec/uniform_notifier/raise_spec.rb
+- spec/uniform_notifier/slack_spec.rb
 - spec/uniform_notifier/xmpp_spec.rb