notify_me 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 270fa941da8f9e238d0ffaf8949e76c89c008e66
+  data.tar.gz: 115f8bcb85cc68c61ef4ed575ad2017d7af0ca60
+SHA512:
+  metadata.gz: 745493d1165414e1c054566d0ca464c0c231b826fc45eb70451f992f97e8d049db8e9c19c7dea82062967a977552c1e2b730462715f92091a5978e0a3cdc0483
+  data.tar.gz: b360dbe5cfe10c20188962a1f0fb37ccc2ca7fe0525671686e979ce4a9af1196ef0b847648a39df06eb223070d982cd368ed07c422fb4f80de005febb51fe096

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+spec/internal/db/*sqlite

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Sam Clopton
+
+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 @@
+# Notify Me
+This is a gem that provides simple and generic notifications that can have 0
+or more actions associated with them.
+
+## Usage:
+``` ruby
+    class User < ActiveRecord::Base
+        has_many_notifications
+        ...
+    end
+    
+    class Task < ActiveRecord::Base
+        ...
+    end
+    
+    class TaskSwap < ActiveRecord::Base
+        belongs_to :from, class_name: "User"
+        belongs_to :to,     class_name: "User"
+        belongs_to :task
+    
+        def accept_swap(action)
+            ...
+        end
+    
+        def reject_swap(action)
+            ...
+        end
+    end
+```
+    
+A user wants to request a task swap
+
+``` ruby
+    swap_task = SwapTask.create(...)
+    notification = NotifyMe::Notification.create(message: "John Doe would like to swap tasks with you")
+    user.notifications << notification
+    
+    notification.actions.create(notification: notification, commandable: swap_task, commandable_action: "accept_swap", name: "Accept")
+    notification.actions.create(notification: notification, commandable: swap_task, commandable_action: "reject_swap", name: "Reject")
+```
+
+Likely in some controller somewhere
+
+``` ruby
+    action = Action.find(params[:id])
+    action.run_action() # if this was the action created above, this would call swap_task.accept_swap(action)
+```
+
+
+## Notification
+* belongs_to :notifyable
+* has_many :actions
+* message - String
+* message_details - String
+* categories - String
+
+## Action
+* belongs_to :notification
+* belongs_to :commandable
+    * can either be an instance
+    * or a class (set the :commandable_type String to the class name -- I.E. "User")
+* commandable_action - String
+    * must either be
+        * an action on the instance
+        * or an action on the class
+* response_identifier - String
+    * not required, but if it is provided it must be unique
+* has_been_processed - Boolean
+    * set to true after the action is processed.
+* name - String
+    * say you want a name to display in a UI, use this field here

data/app/models/notify_me/action.rb

@@ -0,0 +1,65 @@
+class NotifyMe::Action < ActiveRecord::Base
+	self.table_name = "notify_me_actions"
+
+	belongs_to :notification
+	belongs_to :commandable, 			:polymorphic => true
+
+	validates 	:notification, 			:presence => true
+	validates 	:commandable_type, 		:presence => true
+	validates 	:commandable_action,	:presence => true
+	validate 	:validate_uniqness_of_unprocessed_identifiers
+	validate 	:validate_pressence_of_action
+
+	def validate_uniqness_of_unprocessed_identifiers
+		if self.response_identifier != nil
+			if NotifyMe::Action.where("response_identifier = ? AND has_been_processed = ?",
+									  self.response_identifier, false).count > 0
+				errors.add(:base, "The response_identifier is not unique among unprocessed actions")
+			end
+		end
+	end
+
+	def validate_pressence_of_action
+		if self.commandable
+			unless self.commandable.respond_to?(self.commandable_action)
+				errors.add(:base, "The commandable action #{self.commandable_action} does not exist on the commandable instance")
+			end
+		else
+			begin
+				unless self.commandable_type.constantize.respond_to?(self.commandable_action)
+					errors.add(:base, "The commandable action #{self.commandable_action} does not exist on the commandable_type constant")
+				end
+			rescue NameError
+				errors.add(:base, "The commandable_type does not refer to a valid constant")
+			end
+		end
+	end
+
+	def self.process_by_identifier(identifier, *args)
+		action = self.where("response_identifier = ? AND has_been_processed = ?",
+				   identifier, false).first
+
+		if action
+			{:action => action, :rval => action.run_action(*args)}
+		else
+			nil
+		end
+	end
+
+	def run_command(*args)
+		if self.commandable
+			self.commandable.send(self.commandable_action, self, *args)
+		else
+			self.commandable_type.constantize.send(self.commandable_action, self, *args)
+		end
+	end
+
+	def run_action(*args)
+		rval = run_command(*args)
+
+		self.has_been_processed = true
+		self.save!
+
+		return rval
+	end
+end

data/app/models/notify_me/notification.rb

@@ -0,0 +1,8 @@
+class NotifyMe::Notification < ActiveRecord::Base
+	self.table_name = "notify_me_notifications"
+
+	has_many :actions, :class_name => 'NotifyMe::Action'
+	belongs_to :notifyable, :polymorphic => true
+
+	validates :message, :presence => true
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/db/migrate/1_notification_tables.rb

@@ -0,0 +1,43 @@
+class NotificationTables < ActiveRecord::Migration
+	def up
+		create_table :notify_me_notifications do |t|
+			t.integer 	:notifyable_id
+			t.string 	:notifyable_type
+
+			t.string 	:message
+			t.string	:message_details
+			t.boolean	:has_been_viewed, :required => true, :default => false
+			t.string	:categories
+		end
+
+		add_index :notify_me_notifications, [:notifyable_id, :notifyable_type],
+			:name => 'index_notifications_on_note_id_and_note_type'
+		add_index :notify_me_notifications, [:notifyable_id, :notifyable_type, :categories],
+			:name => 'index_notifications_on_note_id_and_note_type_and_categories'
+
+		create_table :notify_me_actions do |t|
+			t.integer 	:notification_id
+			t.integer	:commandable_id
+			t.string	:commandable_type
+			t.string	:commandable_action
+			t.string 	:response_identifier
+			t.boolean	:has_been_processed, :required => true, :default => false
+		end
+
+		add_index :notify_me_actions, :notification_id
+		add_index :notify_me_actions, :response_identifier
+		add_index :notify_me_actions, [:notification_id, :response_identifier],
+			:name => 'index_notifications_on_note_id_and_resp_ident'
+		add_index :notify_me_actions, [:commandable_id, :commandable_type, :notification_id],
+			:name => "index_actions_on_comm_id_and_comm_type_and_note_id"
+		add_index :notify_me_actions, [:commandable_id, :commandable_type, :response_identifier],
+			:name => "index_actions_on_comm_id_and_comm_type_and_resp_ident"
+		add_index :notify_me_actions, [:commandable_id, :commandable_type, :notification_id, :response_identifier],
+			:unique => true, :name => 'unique_actions'
+	end
+
+	def down
+		drop_table :notify_me_notifications
+		drop_table :notify_me_actions
+	end
+end

data/db/migrate/2_action_name.rb

@@ -0,0 +1,9 @@
+class ActionName < ActiveRecord::Migration
+	def up
+		add_column :notify_me_actions, :name, :string
+	end
+
+	def down
+		remove_column :notify_me_actions, :name
+	end
+end

data/db/migrate/3_timestamps.rb

@@ -0,0 +1,15 @@
+class TimeStamps < ActiveRecord::Migration
+	def up
+		add_column :notify_me_actions, :created_at, :datetime
+		add_column :notify_me_actions, :updated_at, :datetime
+		add_column :notify_me_notifications, :created_at, :datetime
+		add_column :notify_me_notifications, :updated_at, :datetime
+	end
+
+	def down
+		remove_column :notify_me_actions, :created_at
+		remove_column :notify_me_actions, :updated_at
+		remove_column :notify_me_notifications, :created_at
+		remove_column :notify_me_notifications, :updated_at
+	end
+end

data/lib/notify_me/active_record.rb

@@ -0,0 +1,12 @@
+require 'active_support/concern'
+
+module NotifyMe::ActiveRecord
+	extend ActiveSupport::Concern
+
+	module ClassMethods
+		def has_many_notifications
+			has_many :notifications, 	:as => :notifyable, :class_name => 'NotifyMe::Notification'
+			has_many :actions, 			:class_name => 'NotifyMe::Action', :through => :notifications
+		end
+	end
+end

data/lib/notify_me/config.rb

@@ -0,0 +1,15 @@
+require 'active_support/configurable'
+
+module NotifyMe
+	def self.configure(&block)
+		yield @config ||= NotifyMe::Configuration.new
+	end
+
+	def self.config
+		@config
+	end
+
+	class Configuration
+		include ActiveSupport::Configurable
+	end
+end

data/lib/notify_me/engine.rb

@@ -0,0 +1,9 @@
+require 'rails/engine'
+
+class NotifyMe::Engine < Rails::Engine
+	engine_name :notify_me
+
+	ActiveSupport.on_load :active_record do
+		include NotifyMe::ActiveRecord
+	end
+end

data/lib/notify_me/version.rb

@@ -0,0 +1,3 @@
+module NotifyMe
+	VERSION = '0.0.3'
+end

data/lib/notify_me.rb

@@ -0,0 +1,6 @@
+module NotifyMe
+	#
+end
+
+require 'notify_me/active_record'
+require 'notify_me/engine'

data/notify_me.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notify_me/version'
+
+Gem::Specification.new do |s|
+	s.name        = 'notify_me'
+	s.version     = NotifyMe::VERSION
+	s.authors     = ['Sam Clopton']
+	s.email       = ['samsinite@gmail.com']
+	s.homepage    = 'https://github.com/samsinite/notify_me'
+	s.summary     = 'Notfy Me'
+	s.description = 'This friendly library gives you generic notifications in your Rails app.'
+	s.license     = 'MIT'
+
+	s.files         = `git ls-files`.split("\n")
+	s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+	s.require_paths = ['lib']
+
+	s.add_runtime_dependency		'activerecord', '>= 3.2.0'
+	s.add_development_dependency	'combustion',	'~> 0.5.1'
+	s.add_development_dependency	'rspec-rails',	'~> 2.13'
+	s.add_development_dependency	'sqlite3',		'~> 1.3.7'
+end

data/spec/acceptance/actions_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe NotifyMe::Action do
+	let(:user) { User.create(username: "Test") }
+	let(:message_notification) { NotifyMe::Notification.create(message: "This is a test msg") }
+
+	it "can belong to a notification" do
+		action = NotifyMe::Action.new(:notification => message_notification,
+									  :commandable => user,
+									  :commandable_action => "view_notification")
+		action.should be_valid
+	end
+
+	it "must belong to a notification" do
+		action = NotifyMe::Action.new(:commandable => user,
+									  :commandable_action => "view_notification")
+		action.should_not be_valid
+	end
+
+	it "can belong to a commandable instance" do
+		action = NotifyMe::Action.new(:notification => message_notification,
+									  :commandable => user,
+									  :commandable_action => "view_notification")
+
+		action.should be_valid
+	end
+
+	it "can belong to a commandable constant" do
+		action = NotifyMe::Action.new(:notification => message_notification,
+									  :commandable_type => "User",
+									  :commandable_action => "do_something")
+
+		action.should be_valid
+	end
+
+	it "must belong to a existing commandable instance or a commandable constant" do
+		action = NotifyMe::Action.new(:notification => message_notification)
+
+		action.should_not be_valid
+	end
+
+	it "if it belongs to a commandable instance, it must belong to an existing instance" do
+		action = NotifyMe::Action.new(:notification => message_notification,
+									  :commandable_type => "User",
+									  :commandable_id => 2,
+									  :commandable_action => "view_notification")
+
+		action.should_not be_valid
+	end
+
+	it "if it belongs to a valid commandable instance, it must be able to process the action" do
+		action = NotifyMe::Action.new(:notification => message_notification,
+									  :commandable_type => "User",
+									  :commandable_id => 1,
+									  :commandable_action => "fail_please")
+
+		action.should_not be_valid
+	end
+
+	it "if it belongs to a valid commandable constant, it must be able to process the action" do
+		action = NotifyMe::Action.new(:notification => message_notification,
+									  :commandable_type => "User",
+									  :commandable_action => "fail_please")
+
+		action.should_not be_valid
+	end
+end
+
+describe "Adding and removing actions" do
+	let(:user) { User.create(username: "Test") }
+	let(:message_notification) { NotifyMe::Notification.create(:message => "This is a test msg") }
+
+	it "stores new actions" do
+		action = message_notification.actions.create(:notification => message_notification,
+													 :commandable => user,
+													 :commandable_action => "view_notification")
+
+		message_notification.actions.reload.should == [action]
+	end
+	
+	it "removes existing actions" do
+		action = message_notification.actions.create(:notification => message_notification,
+													 :commandable => user,
+													 :commandable_action => "view_notification")
+		message_notification.actions.delete action
+
+		user.notifications.reload.should == []
+	end
+end
+
+describe "Processing actions" do
+	let(:user) { User.create(username: "Test") }
+	let(:message_notification) { NotifyMe::Notification.create(:message => "This is a test msg") }
+
+	it "runs existing actions" do
+		action = message_notification.actions.create(:notification => message_notification,
+													 :commandable => user,
+													 :commandable_action => "view_notification")
+		action.run_action
+
+		message_notification.has_been_viewed.should be_true
+	end
+
+	it "marks ran actions as processed" do
+		action = message_notification.actions.create(:notification => message_notification,
+													 :commandable => user,
+													 :commandable_action => "view_notification")
+		action.run_action
+
+		action.has_been_processed.should be_true
+	end
+end

data/spec/acceptance/notifications_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe "Adding and removing notifications" do
+	let(:user) { User.create(username: "Test") }
+	let(:message_notification) { NotifyMe::Notification.create(:message => "This is a test msg")}
+
+	it "stores new notifications" do
+		user.notifications << message_notification
+
+		user.notifications.reload.should == [message_notification]
+	end
+	
+	it "removes existing notifications" do
+		user.notifications << message_notification
+		user.notifications.delete message_notification
+
+		user.notifications.reload.should == []
+	end
+end

data/spec/internal/app/models/user.rb

@@ -0,0 +1,14 @@
+class User < ActiveRecord::Base
+	has_many_notifications
+
+	def view_notification(action)
+		action.notification.has_been_viewed = true
+		action.notification.save!
+
+		true
+	end
+
+	def self.do_something(action)
+		puts "TADA!"
+	end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/db/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define do
+	create_table :users, :force => true do |t|
+		t.string :username
+		t.timestamps
+	end
+end

data/spec/internal/log/.gitignore

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

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'combustion'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :active_record
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+	config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: notify_me
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Sam Clopton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+description: This friendly library gives you generic notifications in your Rails app.
+email:
+- samsinite@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENCE
+- README.md
+- app/models/notify_me/action.rb
+- app/models/notify_me/notification.rb
+- config.ru
+- db/migrate/1_notification_tables.rb
+- db/migrate/2_action_name.rb
+- db/migrate/3_timestamps.rb
+- lib/notify_me.rb
+- lib/notify_me/active_record.rb
+- lib/notify_me/config.rb
+- lib/notify_me/engine.rb
+- lib/notify_me/version.rb
+- notify_me.gemspec
+- spec/acceptance/actions_spec.rb
+- spec/acceptance/notifications_spec.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/spec_helper.rb
+homepage: https://github.com/samsinite/notify_me
+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.3
+signing_key: 
+specification_version: 4
+summary: Notfy Me
+test_files: []