notifi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8345a4a8b58f6a503421a1e19d73bf07f4f78fc2
+  data.tar.gz: bc4d59ffcd2f022c8da86950e93255eceac95446
+SHA512:
+  metadata.gz: 9b88901322aca4e2540c0cbb823f62ce541f4191301b75436d73f5984442603b6f1e428a2aa1e79dcb0d51104e724e9c937a0f07dd558721d1769cfd2e0bf5a0
+  data.tar.gz: fc026677730bb98cd890fd51dc89f207807f9840a8f31f804df0861fb99b6c4ddcfb72f6d86705f818c9ca0133f2cf01f944bfd14569cc01274e4dd09d9a08b0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hunter Haydel
+
+MIT License
+
+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,123 @@
+[![Code Climate](https://codeclimate.com/github/wedgex/notifi.png)](https://codeclimate.com/github/wedgex/notifi)
+
+# Notifi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'notifi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install notifi
+
+## Usage
+
+### Basic subscription & notification
+Setup subscribers and subscribable models:
+~~~~~ Ruby
+class User
+    include Mongoid::Document
+
+    # Include notifi base
+    include Notifi
+
+    # setup user as a subscriber
+    acts_as_subscriber
+end
+
+class Post
+    include Mongoid::Document
+
+    # Include notifi base
+    include Notifi
+
+    # setup posts as subscribable
+    acts_as_subscribable
+end
+~~~~
+
+You now have the ability to subscribe users to posts and notify users through the subscriptions.
+~~~~ Ruby
+post = Post.create
+user = User.create
+
+user.subscribe_to post
+
+user.notifications.count # => 0
+
+post.notify
+
+user.notifications.count # => 1
+~~~~
+
+### On notification events
+
+~~~ Ruby
+class User
+  include Mongoid::Document
+  include Notifi
+
+  acts_as_subscriber
+
+  on_notification do |notification|
+    # Do some sweet notification stuff here. Like maybe queue up an email
+    # or print a smiley face to the log.
+  end
+end
+~~~
+
+The block provided to on_notification in your subscriber class will be called after a notification for the subscriber is created.
+
+
+### Custom notification classes.
+
+You can customize notifications by extending the Notification class and configuring the subscribable to use the custom class for notifications.
+
+~~~ Ruby
+class CommentNotification < Notifi::Notification
+  field :message, type: String
+end
+
+class Post
+  include Mongoid::Document
+  include Notifi
+
+  acts_as_subscribable default: CommentNotification
+end
+
+post = Post.create
+user.subscribe_to post
+post.notify(set:{message: 'Someone commented on your post!'})
+
+user.notifications.first.message # => 'Someone commented on your post!'
+~~~
+
+### Notifying specific events
+
+~~~ Ruby
+
+  # ...
+
+  acts_as_subscribable default: CommentNotification, test: TestNotification
+
+  # ...
+
+  thing.notifiy(:test)
+~~~
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/notifi/base.rb

@@ -0,0 +1,16 @@
+module Notifi
+  module Base
+    def acts_as_subscriber
+      class_attribute :notification_event
+
+      include Subscriber
+    end
+
+    def acts_as_subscribable(subscribable_options={})
+      class_attribute :subscribable_options
+      self.subscribable_options = subscribable_options
+
+      include Subscribable
+    end
+  end
+end

data/lib/notifi/notification.rb

@@ -0,0 +1,30 @@
+module Notifi
+  class Notification
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    belongs_to :subscription
+    belongs_to :subscriber, polymorphic: true
+    belongs_to :notifier, polymorphic: true
+    belongs_to :subscribable, polymorphic: true
+
+    field :read, type: Boolean, default: false
+    field :message, type: String
+
+    after_create do |n|
+      n.fire_notification_event
+    end
+
+    def notification_event?
+      self.subscriber && self.subscriber.notification_event
+    end
+
+    def fire_notification_event
+      self.subscriber.notification_event.call(self) if self.notification_event?
+    end
+
+    def mark_as_read
+      self.update_attribute :read, true
+    end
+  end
+end

data/lib/notifi/subscribable.rb

@@ -0,0 +1,19 @@
+module Notifi
+  module Subscribable
+    def self.included(base)
+      base.has_many :subscriptions, as: :subscribable,
+                                    class_name: Subscription.name,
+                                    dependent: :destroy,
+                                    inverse_of: :subscribable
+
+      base.has_many :notifications, as: :subscribable,
+                                    class_name: Notification.name,
+                                    dependent: :destroy,
+                                    inverse_of: :subscribable
+    end
+
+    def notify(event=:default, notifier: nil, set: {})
+      self.subscriptions.each { |s| s.notify(event, notifier, set: set) }
+    end
+  end
+end

data/lib/notifi/subscriber.rb

@@ -0,0 +1,40 @@
+module Notifi
+  module Subscriber
+    def self.included(base)
+      base.has_many :subscriptions, class_name: Subscription.name, dependent: :destroy, inverse_of: :subscriber
+      base.has_many :triggered_notifications, class_name: Notification.name, dependent: :destroy, inverse_of: :notifier
+      base.has_many :notifications, class_name: Notification.name, dependent: :destroy, inverse_of: :subscriber do
+        def mark_as_read
+          self.each(&:mark_as_read)
+        end
+      end
+
+      base.extend ClassMethods
+    end
+
+    def subscribe_to(subscribable)
+      reject_non_subscribable! subscribable
+
+      self.subscriptions.find_or_create_by(subscriber: self, subscribable: subscribable)
+    end
+
+    def unsubscribe_from(subscribable)
+      reject_non_subscribable! subscribable
+
+      self.subscriptions.destroy_all(subscribable: subscribable)
+    end
+
+    module ClassMethods
+      def on_notification(&block)
+        self.notification_event = block
+      end
+    end
+
+    private
+    def reject_non_subscribable!(target)
+      unless target.kind_of? Subscribable
+        raise ArgumentError, "#{target.class} does not include Notifi::Subscribable"
+      end
+    end
+  end
+end

data/lib/notifi/subscription.rb

@@ -0,0 +1,27 @@
+module Notifi
+  class Subscription
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    belongs_to :subscriber, polymorphic: true
+    belongs_to :subscribable, polymorphic: true
+    has_many :notifications, dependent: :destroy, inverse_of: :subscription
+
+    def notify(event=:default, notifier=nil, set: {})
+      set[:subscription] = self
+      set[:notifier] = notifier
+      set[:subscriber] = self.subscriber
+      set[:subscribable] = self.subscribable
+
+      self.notification_class(event).create(set)
+    end
+
+    def subscribable_options
+      self.subscribable.subscribable_options
+    end
+
+    def notification_class(event)
+      subscribable_options[event] || subscribable_options[:default] || Notification
+    end
+  end
+end

data/lib/notifi/version.rb

@@ -0,0 +1,3 @@
+module Notifi
+  VERSION = "0.0.1"
+end

data/lib/notifi.rb

@@ -0,0 +1,14 @@
+require 'mongoid'
+
+require 'notifi/version'
+require 'notifi/base'
+require 'notifi/subscription'
+require 'notifi/notification'
+require 'notifi/subscribable'
+require 'notifi/subscriber'
+
+module Notifi
+  def self.included(base)
+    base.extend Base
+  end
+end

data/notifi.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notifi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "notifi"
+  spec.version       = Notifi::VERSION
+  spec.authors       = ["Hunter Haydel"]
+  spec.email         = ["haydh530@gmail.com"]
+  spec.description   = "Simple frame for creating subsciption and notificaton records"
+  spec.summary       = "Simple frame for creating subsciption and notificaton records"
+  spec.homepage      = "http://www.github.com/wedgex/notifi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mongoid", "~> 3.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "database_cleaner"
+end

data/spec/mongoid.yml

@@ -0,0 +1,7 @@
+test:
+  sessions:
+    default:
+      database: mongoid
+      hosts:
+        - localhost:27017
+

data/spec/notification_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'notification' do
+  let(:notification) { Notifi::Notification.create }
+
+  it 'should default to unread' do
+    notification.read?.should be false
+  end
+
+  it 'should be able to mark_as_read' do
+    notification.mark_as_read
+
+    notification.read?.should be true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'notifi'
+require 'database_cleaner'
+
+ENV["MONGOID_ENV"] = 'test'
+Mongoid.load!(File.dirname(__FILE__) + '/mongoid.yml')
+
+class User
+  include Mongoid::Document
+  include Notifi
+
+  acts_as_subscriber
+end
+
+class Post
+  include Mongoid::Document
+  include Notifi
+
+  acts_as_subscribable
+end
+
+class CommentNotification < Notifi::Notification
+  field :comment, type: String
+end
+
+class Comment
+  include Mongoid::Document
+  include Notifi
+
+  acts_as_subscribable default: CommentNotification
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/subscribable_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe 'subscribable' do
+  let(:subscribable) { Post.create }
+
+  it 'should be able to notify all subscribers' do
+    subscribers = [User.create, User.create]
+
+    subscribers.each { |s| s.subscribe_to subscribable }
+
+    subscribable.notify
+
+    subscribers.each do |s|
+      s.notifications.length.should eq 1
+    end
+  end
+
+  it 'should be able to provide a notifier' do
+    user = User.create
+    comment = Comment.create
+
+    user.subscribe_to comment
+
+    comment.notify(notifier: user)
+
+    user.notifications.first.notifier.should eq user
+  end
+
+  context 'custom notifications' do
+    it 'should be able to define notification type' do
+      user = User.create
+      comment = Comment.create
+
+      user.subscribe_to comment
+
+      comment.notify
+
+      user.notifications.first.should be_a CommentNotification
+    end
+
+    it 'should be able to set fields on notification' do
+      user = User.create
+      comment = Comment.create
+
+      user.subscribe_to comment
+
+      message = 'HELLO'
+
+      comment.notify(set: {comment: message})
+
+      user.notifications.first.comment.should eq message
+    end
+
+    it 'should be able to define notifications for different events' do
+      user = User.create
+      class Thing
+        include Mongoid::Document
+        include Notifi
+
+        acts_as_subscribable default: Notifi::Notification, test: CommentNotification
+      end
+      thing = Thing.create
+      user.subscribe_to thing
+      thing.notify :test
+      user.notifications.first.should be_a CommentNotification
+    end
+
+    it 'should fall back to default notification type if event not provided' do
+      user = User.create
+      class Thing
+        include Mongoid::Document
+        include Notifi
+
+        acts_as_subscribable default: CommentNotification
+      end
+      thing = Thing.create
+      user.subscribe_to thing
+      thing.notify
+      user.notifications.first.should be_a CommentNotification
+    end
+
+    it 'should fall back to default notification type if event not found' do
+      user = User.create
+      class Thing
+        include Mongoid::Document
+        include Notifi
+
+        acts_as_subscribable default: CommentNotification
+      end
+      thing = Thing.create
+      user.subscribe_to thing
+      thing.notify :test
+      user.notifications.first.should be_a CommentNotification
+    end
+  end
+
+  it 'should be able to provide a namespaced notification' do
+    module Notification
+      class Comment < Notifi::Notification; end
+    end
+
+    class Thing
+      include Mongoid::Document
+      include Notifi
+
+      acts_as_subscribable default: Notification::Comment
+    end
+
+    user = User.create
+    thing = Thing.create
+    user.subscribe_to thing
+    thing.notify
+    user.notifications.first.should be_a Notification::Comment
+  end
+end

data/spec/subscriber_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe 'subscriber' do
+  let(:subscriber) { User.create }
+  let(:subscribable) { Post.create }
+
+  it 'should have subscriptions' do
+    # TODO figure out why shoulda matchers are blowing up and do this right
+    subscriber.should respond_to(:subscriptions)
+  end
+
+  it 'should have notifications' do
+    subscriber.should respond_to(:notifications)
+  end
+
+  context 'subscribe_to' do
+    it 'should create a subscription' do
+      subscriber.subscribe_to(subscribable)
+
+      subscriber.subscriptions.count.should eq 1
+    end
+
+    it 'should throw exception if not given a subscribeble' do
+      -> { subscriber.unsubscribe_from(Object.new) }.should raise_error(ArgumentError)
+    end
+
+    it 'should not create duplicate subscriptions' do
+      subscriber.subscribe_to subscribable
+      subscriber.subscribe_to subscribable
+
+      subscriber.subscriptions.count.should eq 1
+    end
+
+    it 'should return a Subscription' do
+      subscription = subscriber.subscribe_to subscribable
+
+      subscription.should be_an_instance_of Notifi::Subscription
+    end
+  end
+
+
+
+  context 'unsubscribe_from' do
+    it 'should be able to unsubscribe' do
+      subscriber.subscribe_to subscribable
+
+      subscriber.unsubscribe_from subscribable
+
+      subscriber.subscriptions.inspect
+
+      subscriber.subscriptions.count.should eq 0
+    end
+
+    it 'should throw exception if not given a subscribeble' do
+      -> { subscriber.unsubscribe_from(Object.new) }.should raise_error(ArgumentError)
+    end
+  end
+
+  context 'on_notification' do
+    it 'should be called when notification is created' do
+      class Thing
+        include Mongoid::Document
+        include Notifi
+
+        acts_as_subscriber
+
+        attr_accessor :notified
+
+        @block_called = false
+        on_notification do |notification|
+          @block_called = true
+        end
+      end
+
+      thing = Thing.create
+
+      thing.subscribe_to subscribable
+      thing.subscriptions.first.notify
+
+      thing.class.instance_variable_get(:@block_called).should be true
+    end
+  end
+
+  context 'mark_as_read' do
+    it 'should set read to true on all notifications' do
+      subscription = subscriber.subscribe_to subscribable
+
+      subscription.notify
+      subscription.notify
+
+      subscriber.notifications.mark_as_read
+
+      subscriber.notifications.each { |n| n.read?.should be true }
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: notifi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hunter Haydel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple frame for creating subsciption and notificaton records
+email:
+- haydh530@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/notifi.rb
+- lib/notifi/base.rb
+- lib/notifi/notification.rb
+- lib/notifi/subscribable.rb
+- lib/notifi/subscriber.rb
+- lib/notifi/subscription.rb
+- lib/notifi/version.rb
+- notifi.gemspec
+- spec/mongoid.yml
+- spec/notification_spec.rb
+- spec/spec_helper.rb
+- spec/subscribable_spec.rb
+- spec/subscriber_spec.rb
+homepage: http://www.github.com/wedgex/notifi
+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: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Simple frame for creating subsciption and notificaton records
+test_files:
+- spec/mongoid.yml
+- spec/notification_spec.rb
+- spec/spec_helper.rb
+- spec/subscribable_spec.rb
+- spec/subscriber_spec.rb