acts_as_notifiable_redmine 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fb1c74cb7172a58728585e51cf267caf71195cc
-  data.tar.gz: 11352631b7152326cd2fddd6b87e919f80416cf0
+  metadata.gz: e5726f65e38236c68fc89eaee4993903cd29fa9c
+  data.tar.gz: 276818b7c41e1e55160b417b15a5745ef4b33b8f
 SHA512:
-  metadata.gz: 64a1b2ec08bc40ab7ac141ac4ab8053827549dbb69d6cb8f4080d74ce22162e6c87197ec1968ea9215f34c1925c74cc7d6b70fa7e9f888a90936fa77c2ad7ef8
-  data.tar.gz: 8abaed0ab9aef03e7e626e0327e57be5c425697032c3293b247185fb233aafcca43650f88df3c1bfd4689ef3a683ae0c0c634f0c19c53939db28445ff2c9e8e9
+  metadata.gz: a962403064e8c8c7e2923587fdd66fe953eaf25940a50259d9f921dea8c6328cd14826356bcb41d5146af04399afefef4ad6607dbe9df4a61e5006bb0af0a1bb
+  data.tar.gz: 9fd8bc029266aad45630b02964efad6faf57e361b121593d660457720c11e3357edff6ea1bf15f59220974eea21110a4ac5093164bed42fcf06bece691a8c1e2

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,11 +1,10 @@
 ### A gem which makes notifying your Redmine instance easy ;)
 
-This gem is designed to integrate the [Pusher Notification System](http://pusher.com) in Redmine.
-
-It must be used with [Redmine Pusher Notifications](https://github.com/jbox-web/redmine_pusher_notifications).
+This gem is designed to integrate the [Pusher Notification System](http://pusher.com) in Redmine but you may use it for other Rails apps ;)
 
 ## Code status
 
+* [![Gem Version](https://badge.fury.io/rb/acts_as_notifiable_redmine.svg)](http://badge.fury.io/rb/acts_as_notifiable_redmine)
 * [![Code Climate](https://codeclimate.com/github/jbox-web/acts_as_notifiable_redmine.png)](https://codeclimate.com/github/jbox-web/acts_as_notifiable_redmine)
 
 ## Requirements
@@ -17,6 +16,129 @@ It must be used with [Redmine Pusher Notifications](https://github.com/jbox-web/
 
     gem install acts_as_notifiable_redmine
 
+## Example usage
+First you need to configure you Pusher account :
+
+    ActsAsNotifiableRedmine::Notifications.register_courier :pusher do
+      app_id    'xxxxx'
+      key       'xxxxxxxxxxxxxxxxxxxx'
+      secret    'xxxxxxxxxxxxxxxxxxxx'
+      encrypted true
+    end
+
+Then you need to register your channels and events : each channel can have many events.
+It may also have an optional ```target``` parameter which can be a string or a Proc.
+
+    ActsAsNotifiableRedmine::Notifications.register_channel :channel_test do
+      target Proc.new { User.current.login }
+      event  :event1, :sticky => true
+      event  :event2, :sticky => false
+      event  :event3
+    end
+    
+    ActsAsNotifiableRedmine::Notifications.register_channel :broadcast do
+      target 'broadcast'
+      event  :event1, :sticky => true
+      event  :event2, :sticky => false
+      event  :event3
+    end
+
+Once done, you can get the registered channels and events with :
+
+    ActsAsNotifiableRedmine::Notifications.channels.each do |name, channel|
+      puts "#############"
+      puts "Channel :"
+      puts "name       : #{channel.name}"
+      puts "identifier : #{channel.identifier}"
+      puts "token      : #{channel.token}"
+      puts "events     :"
+      channel.events.each do |event|
+        puts "  * #{event.name} (sticky : #{event.sticky?})"
+      end
+      puts ""
+    end
+
+To get the Pusher parameters :
+
+    courier = ActsAsNotifiableRedmine::Notifications.courier
+    
+    puts "#############"
+    puts "Courier :"
+    puts "name      : #{courier.name}"
+    puts "app_id    : #{courier.app_id}"
+    puts "key       : #{courier.key}"
+    puts "secret    : #{courier.secret}"
+    puts "encrypted : #{courier.encrypted}"
+    
+Finally to send notifications :
+
+    ActsAsNotifiableRedmine::Notifications.send_notification([channel.token], event.name, {:title => 'Hello!', :message => 'This is a test message !'})
+
+**Note** : The logic to determine wether or not to send a notification is let to the developer. You can easily do this with callbacks :
+
+    class Comment < ActiveRecord::Base
+        has_many :watchers
+        after_create :send_notification
+        
+        private
+        
+            def send_notification
+                channels = []
+                watchers.each do |watcher|
+                    token = '<channel_name>-' + watcher.login
+                    channels.push(token)
+                end
+                ActsAsNotifiableRedmine::Notifications.send_notification(channels, <event_name>, {:title => 'Hello!', :message => 'This is a test message !'})
+            end
+    end
+
+And to display them (put this in the layout) :
+
+    <% if User.current.logged? %>
+
+      <%= javascript_tag do %>
+    
+        $(document).ready(function() {
+          $.extend($.gritter.options, {
+            fade_in_speed: 'fast',
+            fade_out_speed: 'fast',
+            time: 6000,
+          });
+
+          $(function() {
+            var pusher = new Pusher('<%= ActsAsNotifiableRedmine::Notifications.courier.key %>');
+    
+            <% ActsAsNotifiableRedmine::Notifications.channels.each do |name, channel| %>
+              var <%= j channel.identifier %> = pusher.subscribe('<%= channel.token %>');
+    
+              <%= channel.identifier %>.bind('subscription_error', function(status) {
+                $.gritter.add({
+                  title: 'Pusher : <%= channel.identifier %>',
+                  text: 'Subscription error'
+                });
+              });
+    
+              <% channel.events.each do |event| %>
+                <%= channel.identifier %>.bind('<%= event.name %>', function(data) {
+                  $.gritter.add({
+                    title: data.title,
+                    text: data.message,
+                    image: data.image,
+                    sticky: <%= event.sticky? %>,
+                  });
+                });
+    
+              <% end %>
+    
+            <% end %>
+    
+          });
+        });
+      <% end %>
+    <% end %>
+
+**Note** : [gritter](http://boedesign.com/blog/2009/07/11/growl-for-jquery-gritter/) is not bundled with the gem.
+
 ## Copyrights & License
 acts_as_notifiable_redmine is completely free and open source and released under the [MIT License](https://github.com/jbox-web/acts_as_notifiable_redmine/blob/devel/LICENSE.txt).
 

data/acts_as_notifiable_redmine.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "acts_as_notifiable_redmine"
 
+  s.add_dependency "pusher"
+
   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) }

data/lib/acts_as_notifiable_redmine/couriers/pusher_courier.rb

@@ -1,3 +1,5 @@
+require 'pusher'
+
 module ActsAsNotifiableRedmine
   module Couriers
 

data/lib/acts_as_notifiable_redmine/version.rb

@@ -1,3 +1,3 @@
 module ActsAsNotifiableRedmine
-  VERSION = "0.1"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_notifiable_redmine
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Nicolas Rodriguez
@@ -9,7 +9,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-05-31 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pusher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - nrodriguez@jbox-web.com
@@ -17,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md