uniform_notifier 1.0.0 → 1.0.1

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    uniform_notifier (0.0.1)
+    uniform_notifier (1.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)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.0)
+    rspec-expectations (2.3.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
+    rspec-mocks (2.3.0)
     ruby-growl (3.0)
     xmpp4r (0.5)
 
@@ -22,7 +22,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  rspec
-  ruby-growl
+  rspec (= 2.3.0)
+  ruby-growl (= 3.0)
   uniform_notifier!
-  xmpp4r
+  xmpp4r (= 0.5)

data/README.md

@@ -6,32 +6,34 @@ uniform_notifier is extracted from [bullet][0], it gives you the ability to send
 Install
 -------
 
-1. install directly
+### install directly
 
     gem install uniform_notifier
 
-if you want to notify by growl or xmpp, you should install them first
+  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)
+### add it into Gemfile (Bundler)
 
     gem "uniform_notifier"
 
-you should add ruby-growl and xmpp4r gem if you want.
+  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.
+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
+    # javascript console (Safari/Webkit browsers or Firefox w/Firebug installed)
     UniformNotifier.console = true
 
     # rails logger
@@ -48,15 +50,17 @@ By default, all notifiers are disabled, you should enable them first.
     UniformNotifier.growl = { :password => 'growl password' }
 
     # xmpp
-    UniformNotifier.xmpp = { :account => 'bullets_account@jabber.org',
-                             :password => 'bullets_password_for_jabber',
-                             :receiver => 'your_account@jabber.org',
+    UniformNotifier.xmpp = { :account => 'sender_account@jabber.org',
+                             :password => 'password_for_jabber',
+                             :receiver => 'recipient_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)
+    UniformNotifier.active_notifiers.each do |notifier|
+      notifier.out_of_channel_notify(args.join("\n"))
+    end
 
     # 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.
@@ -67,5 +71,33 @@ After that, you can enjoy the notifiers, that's cool!
     end
     javascript_str = responses.join("\n")
 
+Growl Support
+-------------
+
+To get Growl support up-and-running, follow the steps below:
+
+* Install the ruby-growl gem: <code>gem install ruby-growl</code>
+* Open the Growl preference pane in Systems Preferences
+* Click the "Network" tab
+* Make sure both "Listen for incoming notifications" and "Allow remote application registration" are checked. *Note*: If you set a password, you will need to set <code>UniformNotifier.growl_password = { :password => 'growl password' }</code> in the config file.
+* Restart Growl ("General" tab -> Stop Growl -> Start Growl)
+* Boot up your application. UniformNotifier will automatically send a Growl notification when Growl is turned on. If you do not see it when your application loads, make sure it is enabled in your initializer and double-check the steps above.
+
+### Ruby 1.9 issue
+
+ruby-growl gem has an issue about md5 in ruby 1.9, if you use growl and ruby 1.9, check this [gist][1]
+
+XMPP/Jabber Support
+-------------------
+
+To get XMPP support up-and-running, follow the steps below:
+
+* Install the xmpp4r gem: <code>gem install xmpp4r</code>
+* Make both the sender and the recipient account add each other as contacts.
+  This will require you to manually log into both accounts, add each other
+  as contact and confirm each others contact request.
+* Boot up your application. UniformNotifier will automatically send an XMPP notification when XMPP is turned on.
+
 
-[0]: https://github.com/flyerhzm/bullet
+[0]: https://github.com/flyerhzm/bullet
+[1]: https://gist.github.com/300184

data/Rakefile

@@ -1,2 +1,25 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require "rake"
+require "rake/rdoctask"
+require "rspec"
+require "rspec/core/rake_task"
+
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+Rspec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "uniform_notifier #{UniformNotifier::VERSION}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+task :default => :spec

data/lib/uniform_notifier/growl.rb

@@ -12,8 +12,9 @@ module UniformNotifier
     end
 
     def self.setup_connection( growl )
+      return unless growl
       require 'ruby-growl'
-      @password = growl == true ? nil : growl[:password]
+      @password = growl.instance_of?(Hash) ? growl[:password] : nil
       @growl = connect
 
       notify 'Uniform Notifier Growl has been turned on'
@@ -35,4 +36,4 @@ module UniformNotifier
         @growl.notify( 'uniform_notifier', 'Uniform Notifier', message )
       end
   end
-end
+end

data/lib/uniform_notifier/version.rb

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

data/lib/uniform_notifier/xmpp.rb

@@ -14,6 +14,8 @@ module UniformNotifier
     end
 
     def self.setup_connection( xmpp_information )
+      return unless xmpp_information
+
       require 'xmpp4r'
 
       @receiver = xmpp_information[:receiver]
@@ -47,4 +49,4 @@ module UniformNotifier
         Jabber::Presence.new.set_status( "Uniform Notifier started on #{Time.now}" )
       end
   end
-end
+end

data/spec/spec_helper.rb

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

data/spec/uniform_notifier/growl_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'ruby-growl'
 
 describe UniformNotifier::Growl do
 

data/spec/uniform_notifier/xmpp_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'xmpp4r'
 
 describe UniformNotifier::Xmpp do
   it "should not notify xmpp" do

data/uniform_notifier.gemspec

@@ -14,9 +14,9 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "uniform_notifier"
 
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "ruby-growl"
-  s.add_development_dependency "xmpp4r"
+  s.add_development_dependency "ruby-growl", "3.0"
+  s.add_development_dependency "xmpp4r", "0.5"
+  s.add_development_dependency "rspec", "2.3.0"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: uniform_notifier
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Richard Huang
@@ -15,49 +15,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-19 00:00:00 +08:00
+date: 2010-12-15 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: ruby-growl
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 7
         segments: 
+        - 3
         - 0
-        version: "0"
+        version: "3.0"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: ruby-growl
+  name: xmpp4r
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 1
         segments: 
         - 0
-        version: "0"
+        - 5
+        version: "0.5"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: xmpp4r
+  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
+        - 2
+        - 3
         - 0
-        version: "0"
+        version: 2.3.0
   type: :development
   version_requirements: *id003
 description: uniform notifier for rails logger, customized logger, javascript alert, javascript console, growl and xmpp