uniform_notifier 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in uniform_notifier.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    uniform_notifier (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-growl (3.0)
+    xmpp4r (0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  ruby-growl
+  uniform_notifier!
+  xmpp4r

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Richard Huang (flyerhzm@gmail.com)
+
+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.md

@@ -0,0 +1,71 @@
+UniformNotifier
+===============
+
+uniform_notifier is extracted from [bullet][0], it gives you the ability to send notification through rails logger, customized logger, javascript alert, javascript console, growl, and xmpp.
+
+Install
+-------
+
+1. install directly
+
+    gem install uniform_notifier
+
+if you want to notify by growl or xmpp, you should install them first
+
+    gem install ruby-growl
+    gem install xmpp4r
+
+2. add it into Gemfile (Bundler)
+
+    gem "uniform_notifier"
+
+you should add ruby-growl and xmpp4r gem if you want.
+
+Usage
+-----
+
+There are two types of notifications, one is <code>inline_notify</code>, for javascript alert and javascript console notifiers, which returns a string and will be combined, the other is <code>out_of_channel_notify</code>, for rails logger, customized logger, growl and xmpp, which doesn't return anything, just send the message to the notifiers.
+
+By default, all notifiers are disabled, you should enable them first.
+
+    # javascript alert
+    UniformNotifier.alert = true
+
+    # javascript console
+    UniformNotifier.console = true
+
+    # rails logger
+    UniformNotifier.rails_logger = true
+
+    # customized logger
+    logger = File.open('notify.log', 'a+')
+    logger.sync = true
+    UniformNotifier.customized_logger = logger
+
+    # growl without password
+    UniformNotifier.growl = true
+    # growl with passowrd
+    UniformNotifier.growl = { :password => 'growl password' }
+
+    # xmpp
+    UniformNotifier.xmpp = { :account => 'bullets_account@jabber.org',
+                             :password => 'bullets_password_for_jabber',
+                             :receiver => 'your_account@jabber.org',
+                             :show_online_status => true }
+
+After that, you can enjoy the notifiers, that's cool!
+
+    # the notify message will be notified to rails logger, customized logger, growl or xmpp.
+    UniformNotifier.active_notfiiers.out_of_channel_notify(notify_message)
+
+    # the notify message will be wrapped by <script type="text/javascript">...</script>,
+    # you should append the javascript_str at the bottom of http response body.
+    # for more information, please check https://github.com/flyerhzm/bullet/blob/master/lib/bullet/rack.rb
+    responses = []
+    UniformNotifier.active_notifiers.each do |notifier|
+      responses << notifier.inline_notify(notify_message)
+    end
+    javascript_str = responses.join("\n")
+
+
+[0]: https://github.com/flyerhzm/bullet

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/uniform_notifier/base.rb

@@ -0,0 +1,21 @@
+module UniformNotifier
+  class Base
+    def self.active?
+      false
+    end
+
+    def self.inline_notify( message )
+    end
+
+    def self.out_of_channel_notify( message )
+    end
+
+    def self.wrap_js_association( message )
+      <<-CODE
+<script type="text/javascript">/*<![CDATA[*/
+#{message}
+/*]]>*/</script>
+      CODE
+    end
+  end
+end

data/lib/uniform_notifier/customized_logger.rb

@@ -0,0 +1,24 @@
+module UniformNotifier
+  class CustomizedLogger < Base
+    @logger = nil
+
+    def self.active?
+      @logger
+    end
+
+    def self.out_of_channel_notify( message )
+      return unless active?
+      @logger.warn message
+    end
+
+    def self.setup(logdev)
+      require 'logger'
+
+      @logger = Logger.new( logdev )
+
+      def @logger.format_message( severity, timestamp, progname, msg )
+        "#{timestamp.strftime("%Y-%m-%d %H:%M:%S")}[#{severity}] #{msg}"
+      end
+    end
+  end
+end

data/lib/uniform_notifier/growl.rb

@@ -0,0 +1,38 @@
+module UniformNotifier
+  class Growl < Base
+    @growl = nil
+
+    def self.active?
+      @growl
+    end
+
+    def self.out_of_channel_notify( message )
+      return unless active?
+      notify( message )
+    end
+
+    def self.setup_connection( growl )
+      require 'ruby-growl'
+      @password = growl == true ? nil : growl[:password]
+      @growl = connect
+
+      notify 'Uniform Notifier Growl has been turned on'
+    rescue LoadError
+      @growl = nil
+      raise NotificationError.new( 'You must install the ruby-growl gem to use Growl notification: `gem install ruby-growl`' )
+    end
+
+    private
+      def self.connect
+        ::Growl.new 'localhost',
+                    'uniform_notifier',
+                    [ 'uniform_notifier' ],
+                    nil,
+                    @password
+      end
+
+      def self.notify( message )
+        @growl.notify( 'uniform_notifier', 'Uniform Notifier', message )
+      end
+  end
+end

data/lib/uniform_notifier/javascript_alert.rb

@@ -0,0 +1,13 @@
+module UniformNotifier
+  class JavascriptAlert < Base
+    def self.active?
+      UniformNotifier.alert
+    end
+
+    def self.inline_notify( message )
+      return unless self.active?
+
+      wrap_js_association "alert( #{message.inspect} );"
+    end
+  end
+end

data/lib/uniform_notifier/javascript_console.rb

@@ -0,0 +1,25 @@
+module UniformNotifier
+  class JavascriptConsole < Base
+    def self.active?
+      UniformNotifier.console
+    end
+
+    def self.inline_notify( message )
+      return unless active?
+
+      code = <<-CODE
+if (typeof(console) !== 'undefined' && console.log) {
+  if (console.groupCollapsed && console.groupEnd) {
+    console.groupCollapsed(#{"Uniform Notifier".inspect});
+    console.log(#{message.inspect});
+    console.groupEnd();
+  } else {
+    console.log(#{message.inspect});
+  }
+}
+CODE
+
+      wrap_js_association code
+    end
+  end
+end

data/lib/uniform_notifier/rails_logger.rb

@@ -0,0 +1,12 @@
+module UniformNotifier
+  class RailsLogger < Base
+    def self.active?
+      UniformNotifier.rails_logger
+    end
+
+    def self.out_of_channel_notify( message )
+      return unless active?
+      Rails.logger.warn message
+    end
+  end
+end

data/lib/uniform_notifier/version.rb

@@ -0,0 +1,3 @@
+module UniformNotifier
+  VERSION = "1.0.0"
+end

data/lib/uniform_notifier/xmpp.rb

@@ -0,0 +1,50 @@
+module UniformNotifier
+  class Xmpp < Base
+    @receiver = nil
+    @xmpp = nil
+    @password = nil
+
+    def self.active?
+      @xmpp
+    end
+
+    def self.out_of_channel_notify( message )
+      return unless active?
+      notify( message )
+    end
+
+    def self.setup_connection( xmpp_information )
+      require 'xmpp4r'
+
+      @receiver = xmpp_information[:receiver]
+      @password = xmpp_information[:password]
+      @account  = xmpp_information[:account]
+      @show_online_status = xmpp_information[:show_online_status]
+
+      connect
+    rescue LoadError
+      @xmpp = nil
+      raise NotificationError.new( 'You must install the xmpp4r gem to use XMPP notification: `gem install xmpp4r`' )
+    end
+
+    private
+      def self.connect
+        jid = Jabber::JID.new( @account )
+        @xmpp = Jabber::Client.new( jid )
+        @xmpp.connect
+        @xmpp.auth( @password )
+        @xmpp.send( presence_status ) if @show_online_status
+      end
+
+      def self.notify( message )
+        message = Jabber::Message.new( @receiver, message ).
+                                  set_type( :normal ).
+                                  set_subject( 'Uniform Notifier' )
+        @xmpp.send( message )
+      end
+
+      def self.presence_status
+        Jabber::Presence.new.set_status( "Uniform Notifier started on #{Time.now}" )
+      end
+  end
+end

data/lib/uniform_notifier.rb

@@ -0,0 +1,33 @@
+require 'uniform_notifier/base'
+require 'uniform_notifier/javascript_alert'
+require 'uniform_notifier/javascript_console'
+require 'uniform_notifier/growl'
+require 'uniform_notifier/xmpp'
+require 'uniform_notifier/rails_logger'
+require 'uniform_notifier/customized_logger'
+
+module UniformNotifier
+  class NotificationError < StandardError; end
+
+  class <<self
+    attr_accessor :alert, :console, :growl, :rails_logger, :xmpp
+
+    NOTIFIERS = [JavascriptAlert, JavascriptConsole, Growl, Xmpp, RailsLogger, CustomizedLogger]
+
+    def active_notifiers
+      NOTIFIERS.select { |notifier| notifier.active? }
+    end
+
+    def growl=(growl)
+      UniformNotifier::Growl.setup_connection(growl)
+    end
+
+    def xmpp=(xmpp)
+      UniformNotifier::Xmpp.setup_connection(xmpp)
+    end
+
+    def customized_logger=(logdev)
+      UniformNotifier::CustomizedLogger.setup(logdev)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "uniform_notifier"
+require "rspec"

data/spec/uniform_notifier/customized_logger_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe UniformNotifier::CustomizedLogger do
+  it "should not notify to customized logger" do
+    UniformNotifier::CustomizedLogger.out_of_channel_notify("notify rails logger").should be_nil
+  end
+
+  it "should notify to customized logger" do
+    logger = File.open( 'test.log', 'a+' )
+    logger.sync = true
+
+    now = Time.now
+    Time.stub!(:now).and_return(now)
+    UniformNotifier.customized_logger = logger
+    UniformNotifier::CustomizedLogger.out_of_channel_notify("notify rails logger")
+
+    logger.seek(0)
+    logger.read.should == "#{now.strftime("%Y-%m-%d %H:%M:%S")}[WARN] notify rails logger"
+
+    File.delete('test.log')
+  end
+end

data/spec/uniform_notifier/growl_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'ruby-growl'
+
+describe UniformNotifier::Growl do
+
+  it "should not notify growl" do
+    UniformNotifier::Growl.out_of_channel_notify('notify growl').should be_nil
+  end
+
+  it "should notify growl without password" do
+    growl = double('growl')
+    Growl.should_receive(:new).with('localhost', 'uniform_notifier', ['uniform_notifier'], nil, nil).and_return(growl)
+    growl.should_receive(:notify).with('uniform_notifier', 'Uniform Notifier', 'Uniform Notifier Growl has been turned on').ordered
+    growl.should_receive(:notify).with('uniform_notifier', 'Uniform Notifier', 'notify growl without password').ordered
+
+    UniformNotifier.growl = true
+    UniformNotifier::Growl.out_of_channel_notify('notify growl without password')
+  end
+
+  it "should notify growl with password" do
+    growl = double('growl')
+    Growl.should_receive(:new).with('localhost', 'uniform_notifier', ['uniform_notifier'], nil, '123456').and_return(growl)
+    growl.should_receive(:notify).with('uniform_notifier', 'Uniform Notifier', 'Uniform Notifier Growl has been turned on').ordered
+    growl.should_receive(:notify).with('uniform_notifier', 'Uniform Notifier', 'notify growl with password').ordered
+
+    UniformNotifier.growl = { :password => '123456' }
+    UniformNotifier::Growl.out_of_channel_notify('notify growl with password')
+  end
+end

data/spec/uniform_notifier/javascript_alert_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe UniformNotifier::JavascriptAlert do
+  it "should not notify message" do
+    UniformNotifier::JavascriptAlert.inline_notify("javascript alert!").should be_nil
+  end
+
+  it "should notify message" do
+    UniformNotifier.alert = true
+    UniformNotifier::JavascriptAlert.inline_notify("javascript alert!").should == <<-CODE
+<script type="text/javascript">/*<![CDATA[*/
+alert( "javascript alert!" );
+/*]]>*/</script>
+CODE
+  end
+end

data/spec/uniform_notifier/javascript_console_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe UniformNotifier::JavascriptConsole do
+  it "should not notify message" do
+    UniformNotifier::JavascriptConsole.inline_notify("javascript console!").should be_nil
+  end
+
+  it "should notify message" do
+    UniformNotifier.console = true
+    UniformNotifier::JavascriptConsole.inline_notify("javascript console!").should == <<-CODE
+<script type="text/javascript">/*<![CDATA[*/
+if (typeof(console) !== 'undefined' && console.log) {
+  if (console.groupCollapsed && console.groupEnd) {
+    console.groupCollapsed(#{"Uniform Notifier".inspect});
+    console.log(#{"javascript console!".inspect});
+    console.groupEnd();
+  } else {
+    console.log(#{"javascript console!".inspect});
+  }
+}
+
+/*]]>*/</script>
+    CODE
+  end
+end

data/spec/uniform_notifier/rails_logger_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+class Rails
+  # mock Rails
+end
+
+describe UniformNotifier::RailsLogger do
+  it "should not notify rails logger" do
+    UniformNotifier::RailsLogger.out_of_channel_notify("notify rails logger").should be_nil
+  end
+
+  it "should notify rails logger" do
+    logger = double("logger")
+    Rails.should_receive(:logger).and_return(logger)
+    logger.should_receive(:warn).with("notify rails logger")
+
+    UniformNotifier.rails_logger = true
+    UniformNotifier::RailsLogger.out_of_channel_notify("notify rails logger")
+  end
+end

data/spec/uniform_notifier/xmpp_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'xmpp4r'
+
+describe UniformNotifier::Xmpp do
+  it "should not notify xmpp" do
+    UniformNotifier::Xmpp.out_of_channel_notify("notify xmpp").should be_nil
+  end
+
+  it "should notify xmpp without online status" do
+    jid = double("jid")
+    xmpp = double("xmpp")
+    Jabber::JID.should_receive(:new).with('from@gmail.com').and_return(jid)
+    Jabber::Client.should_receive(:new).with(jid).and_return(xmpp)
+    xmpp.should_receive(:connect)
+    xmpp.should_receive(:auth).with('123456')
+
+    message = double("message")
+    Jabber::Message.should_receive(:new).with('to@gmail.com', 'notify xmpp').and_return(message)
+    message.should_receive(:set_type).with(:normal).and_return(message)
+    message.should_receive(:set_subject).with('Uniform Notifier').and_return(message)
+    xmpp.should_receive(:send).with(message)
+
+    UniformNotifier.xmpp = {:account => 'from@gmail.com', :password => '123456', :receiver => 'to@gmail.com', :show_online_status => false}
+    UniformNotifier::Xmpp.out_of_channel_notify('notify xmpp')
+  end
+
+  it "should notify xmpp with online status" do
+    jid = double("jid")
+    xmpp = double("xmpp")
+    Jabber::JID.should_receive(:new).with('from@gmail.com').and_return(jid)
+    Jabber::Client.should_receive(:new).with(jid).and_return(xmpp)
+    xmpp.should_receive(:connect)
+    xmpp.should_receive(:auth).with('123456')
+
+    presence = double("presence")
+    now = Time.now
+    Time.stub!(:now).and_return(now)
+    Jabber::Presence.should_receive(:new).and_return(presence)
+    presence.should_receive(:set_status).with("Uniform Notifier started on #{now}").and_return(presence)
+    xmpp.should_receive(:send).with(presence)
+
+    message = double("message")
+    Jabber::Message.should_receive(:new).with('to@gmail.com', 'notify xmpp').and_return(message)
+    message.should_receive(:set_type).with(:normal).and_return(message)
+    message.should_receive(:set_subject).with('Uniform Notifier').and_return(message)
+    xmpp.should_receive(:send).with(message)
+
+    UniformNotifier.xmpp = {:account => 'from@gmail.com', :password => '123456', :receiver => 'to@gmail.com', :show_online_status => true}
+    UniformNotifier::Xmpp.out_of_channel_notify('notify xmpp')
+  end
+end

data/uniform_notifier.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "uniform_notifier/version"
+
+Gem::Specification.new do |s|
+  s.name        = "uniform_notifier"
+  s.version     = UniformNotifier::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Richard Huang"]
+  s.email       = ["flyerhzm@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/uniform_notifier"
+  s.summary     = %q{uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp}
+  s.description = %q{uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp}
+
+  s.rubyforge_project = "uniform_notifier"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "ruby-growl"
+  s.add_development_dependency "xmpp4r"
+
+  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"]
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: uniform_notifier
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-19 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-growl
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp
+email: 
+- flyerhzm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/uniform_notifier.rb
+- lib/uniform_notifier/base.rb
+- lib/uniform_notifier/customized_logger.rb
+- lib/uniform_notifier/growl.rb
+- lib/uniform_notifier/javascript_alert.rb
+- lib/uniform_notifier/javascript_console.rb
+- lib/uniform_notifier/rails_logger.rb
+- lib/uniform_notifier/version.rb
+- lib/uniform_notifier/xmpp.rb
+- spec/spec_helper.rb
+- spec/uniform_notifier/customized_logger_spec.rb
+- spec/uniform_notifier/growl_spec.rb
+- spec/uniform_notifier/javascript_alert_spec.rb
+- spec/uniform_notifier/javascript_console_spec.rb
+- spec/uniform_notifier/rails_logger_spec.rb
+- spec/uniform_notifier/xmpp_spec.rb
+- uniform_notifier.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/uniform_notifier
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: uniform_notifier
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp
+test_files: 
+- spec/spec_helper.rb
+- spec/uniform_notifier/customized_logger_spec.rb
+- spec/uniform_notifier/growl_spec.rb
+- spec/uniform_notifier/javascript_alert_spec.rb
+- spec/uniform_notifier/javascript_console_spec.rb
+- spec/uniform_notifier/rails_logger_spec.rb
+- spec/uniform_notifier/xmpp_spec.rb