acts_as_notifiable_redmine 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6fb1c74cb7172a58728585e51cf267caf71195cc
+  data.tar.gz: 11352631b7152326cd2fddd6b87e919f80416cf0
+SHA512:
+  metadata.gz: 64a1b2ec08bc40ab7ac141ac4ab8053827549dbb69d6cb8f4080d74ce22162e6c87197ec1968ea9215f34c1925c74cc7d6b70fa7e9f888a90936fa77c2ad7ef8
+  data.tar.gz: 8abaed0ab9aef03e7e626e0327e57be5c425697032c3293b247185fb233aafcca43650f88df3c1bfd4689ef3a683ae0c0c634f0c19c53939db28445ff2c9e8e9

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2014 Nicolas Rodriguez (nrodriguez@jbox-web.com), JBox Web (http://www.jbox-web.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,35 @@
+### 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).
+
+## Code status
+
+* [![Code Climate](https://codeclimate.com/github/jbox-web/acts_as_notifiable_redmine.png)](https://codeclimate.com/github/jbox-web/acts_as_notifiable_redmine)
+
+## Requirements
+* Ruby 1.9.x or 2.0.x
+* a working [Redmine](http://www.redmine.org/) installation
+* an account on [Pusher](http://pusher.com)
+
+## Installation
+
+    gem install acts_as_notifiable_redmine
+
+## 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).
+
+Copyright (c) 2014 Nicolas Rodriguez (nrodriguez@jbox-web.com), JBox Web (http://www.jbox-web.com) [![endorse](https://api.coderwall.com/n-rodriguez/endorsecount.png)](https://coderwall.com/n-rodriguez)
+
+## Contribute
+
+You can contribute to this plugin in many ways such as :
+* Helping with documentation
+* Contributing code (features or bugfixes)
+* Reporting a bug
+* Submitting translations
+
+You can also donate :)
+
+[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FBT7E7DAVVEEU)

data/acts_as_notifiable_redmine.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "acts_as_notifiable_redmine/version"
+
+Gem::Specification.new do |s|
+  s.name        = "acts_as_notifiable_redmine"
+  s.version     = ActsAsNotifiableRedmine::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Nicolas Rodriguez"]
+  s.email       = ["nrodriguez@jbox-web.com"]
+  s.homepage    = "https://github.com/jbox-web/acts_as_notifiable_redmine"
+  s.summary     = %q{A Ruby gem who provides a small DSL to register Pusher channels and events in Redmine}
+  s.license     = 'MIT'
+
+  s.rubyforge_project = "acts_as_notifiable_redmine"
+
+  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

data/lib/acts_as_notifiable_redmine.rb

@@ -0,0 +1,7 @@
+module ActsAsNotifiableRedmine
+  require 'acts_as_notifiable_redmine/channel'
+  require 'acts_as_notifiable_redmine/event'
+  require 'acts_as_notifiable_redmine/notifications'
+  require 'acts_as_notifiable_redmine/couriers'
+  require 'acts_as_notifiable_redmine/couriers/pusher_courier'
+end

data/lib/acts_as_notifiable_redmine/channel.rb

@@ -0,0 +1,37 @@
+module ActsAsNotifiableRedmine
+  class Channel
+
+    attr_reader :name, :identifier, :events
+
+    def initialize(id, &block)
+      @id         = id.to_sym
+      @name       = @id
+      @identifier = "channel_#{name}"
+      @events     = []
+      @target     = "#{name}"
+
+      instance_eval(&block)
+    end
+
+
+    def target(target)
+      @target = target
+    end
+
+
+    def token
+      if @target.is_a?(Proc)
+        "#{@name}-#{@target.call(self)}"
+      else
+        @target
+      end
+    end
+
+
+    def event(name, options = {})
+      new_event = Event.new(name, options)
+      @events.push(new_event)
+    end
+
+  end
+end

data/lib/acts_as_notifiable_redmine/couriers.rb

@@ -0,0 +1,13 @@
+module ActsAsNotifiableRedmine
+  module Couriers
+
+    def self.factory(klass_name, &block)
+      klass = "ActsAsNotifiableRedmine::Couriers::#{klass_name.to_s.capitalize}Courier".constantize
+      klass.new(&block)
+    rescue => e
+      puts e.message
+      nil
+    end
+
+  end
+end

data/lib/acts_as_notifiable_redmine/couriers/pusher_courier.rb

@@ -0,0 +1,51 @@
+module ActsAsNotifiableRedmine
+  module Couriers
+
+    class PusherCourier
+
+      class << self
+        def def_field(*names)
+          class_eval do
+            names.each do |name|
+              define_method(name) do |*args|
+                args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
+              end
+            end
+          end
+        end
+      end
+
+      def_field :name, :app_id, :key, :secret, :encrypted
+
+
+      def initialize(&block)
+        @name      = 'Pusher'
+        @app_id    = ''
+        @key       = ''
+        @secret    = ''
+        @encrypted = true
+
+        instance_eval(&block)
+        setup_pusher
+      end
+
+
+      def send_notification(channels, event, options)
+        Pusher.trigger(channels, event, options)
+      end
+
+
+      private
+
+
+      def setup_pusher
+        Pusher.app_id    = @app_id
+        Pusher.key       = @key
+        Pusher.secret    = @secret
+        Pusher.encrypted = @encrypted
+      end
+
+    end
+
+  end
+end

data/lib/acts_as_notifiable_redmine/event.rb

@@ -0,0 +1,14 @@
+module ActsAsNotifiableRedmine
+  class Event
+
+    attr_reader :name, :sticky
+    alias :sticky? :sticky
+
+    def initialize(id, options = {})
+      @id     = id.to_sym
+      @name   = @id
+      @sticky = options[:sticky] || false
+    end
+
+  end
+end

data/lib/acts_as_notifiable_redmine/notifications.rb

@@ -0,0 +1,41 @@
+module ActsAsNotifiableRedmine
+  class Notifications
+
+    @@channels = {}
+    @@courier  = nil
+
+    class << self
+
+      def register_courier(type, &block)
+        @@courier = Couriers.factory(type, &block)
+      end
+
+
+      def register_channel(id, &block)
+        @@channels[id] = Channel.new(id, &block)
+      end
+
+
+      def channels
+        @@channels
+      end
+
+
+      def courier
+        @@courier
+      end
+
+
+      def find_by_id(id)
+        @@channels[id.to_sym]
+      end
+
+
+      def send_notification(channels, event, options)
+        @@courier.send_notification(channels, event, options)
+      end
+
+    end
+
+  end
+end

data/lib/acts_as_notifiable_redmine/version.rb

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

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_notifiable_redmine
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Nicolas Rodriguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-31 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- nrodriguez@jbox-web.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- acts_as_notifiable_redmine.gemspec
+- lib/acts_as_notifiable_redmine.rb
+- lib/acts_as_notifiable_redmine/channel.rb
+- lib/acts_as_notifiable_redmine/couriers.rb
+- lib/acts_as_notifiable_redmine/couriers/pusher_courier.rb
+- lib/acts_as_notifiable_redmine/event.rb
+- lib/acts_as_notifiable_redmine/notifications.rb
+- lib/acts_as_notifiable_redmine/version.rb
+homepage: https://github.com/jbox-web/acts_as_notifiable_redmine
+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: acts_as_notifiable_redmine
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem who provides a small DSL to register Pusher channels and events
+  in Redmine
+test_files: []
+has_rdoc: