crier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb5415fa85424816676fe6ae83a4bc2eac4a52b4
+  data.tar.gz: 8f006ece5a90a38925788fbfb9a7db7f30fb0143
+SHA512:
+  metadata.gz: 9f15a7d2b94be0ed17a1fad2a22747011b738c1f7edfbd250d9dc85a630982c67506b2d6732beb68922f6c4a677bc850fea07537304b09ce65cbe030b067c846
+  data.tar.gz: 3ee4e43692408be9e213ed14769d45c109d580c21c4bb0723214d633a32f66e9a1fb62ee0d6cbc519a85fa0b9f567a7d18f7c31ea02f090a5f248a0048d4441c

data/README.md

@@ -0,0 +1,65 @@
+crier
+=====
+
+Simple notification system for the whole town
+
+## Installation
+
+### in your Gemfile
+
+```ruby
+gem 'crier'
+```
+
+### at the command line
+
+```bash
+rake crier:create_tables # not working yet
+```
+
+## Usage
+
+```ruby
+class User < ActiveRecord::Base
+   acts_as_crier
+end
+```
+
+### Notification Attributes
+
+* crier: Who did the crying
+* subject: What they were crying about
+* action: What action was being carried out
+* scope: A way to group notifications for easy querying
+* audience: An optional list of users who can see the notification
+* metadata: A hash of metadata to go along with the notification (automatically includes :crier, :subject, :action)
+
+### Public Crying
+
+```ruby
+# cry(message, metadata, audience)
+
+someuser.cry("Hello, my name is.")                                # Shout about yourself
+someuser.cry("The roof is on fire!", :subject => @house)          # Shout about the house
+someuser.cry("Bring out yer dead", :scope => :my_town)            # Shout within a custom scope for finding
+someuser.cry("Reticulating Splines", :action => :reticulated)     # Shout with a specific action verb for use in the view
+someuser.cry("This is why I'm hot!", :reasons => @reasons)        # Shout with custom metadata
+```
+
+### Private Crying
+
+Cries are public unless they have an audience.
+
+```ruby
+someuser.cry("Lend me your ears", {}, @other_users)               # Shout only to specific users
+someuser.cry("Lend me your ears").to(@other_users)                # Shout only to specific users, alternate syntax, non-transactional
+someuser.cry("Lend me your ears").to_others(@other_users)         # Shout only to specific users, alternate syntax, non-transactional, excludes crier from @other_users
+```
+
+### Listening
+
+```ruby
+Crier::Notification.heard_by(some_user)                           # Get all the notifications the user heard
+Crier::Notification.about(@record)                                # Get all the notifications with the given subject
+Crier::Notification.in_scope(:my_town)                            # Get all the notifications within the given scope
+```

data/lib/crier/acts_as_crier.rb

@@ -0,0 +1,35 @@
+module Crier
+  module ActMethod
+    def acts_as_crier(options = {})
+      has_many :listenings, :class_name => 'Crier::Listening', :dependent => :delete_all
+      has_many :private_notifications, :class_name => 'Crier::Notification', :source => :notification, :through => :listenings
+
+      extend Crier::ClassMethods
+      include Crier::InstanceMethods
+    end      
+  end
+
+  module ClassMethods
+  end
+
+  module InstanceMethods
+    def cry(message, metadata = {}, audience = nil)
+      Notification.create! do |n|
+        n.message   = message
+        n.crier     = metadata.delete(:crier) || self
+        n.subject   = metadata.delete(:subject) || self
+        n.action    = metadata.delete(:action)
+        n.metadata  = metadata
+        n.audience  = Array(audience)
+        n.scope     = Crier::HelperMethods.scope_for(n.subject)
+        n.private   = true if audience
+      end
+    end
+  end
+
+  module HelperMethods
+    def self.scope_for(record)
+      "#{record.class.name}##{record.id}"
+    end
+  end
+end

data/lib/crier/listening.rb

@@ -0,0 +1,11 @@
+module Crier
+  # If a notification has listeners, the notification is considered private and only available to those listeners
+  class Listening < ActiveRecord::Base
+    self.table_name = 'crier_listenings'
+    
+    belongs_to :notification
+    belongs_to :user
+
+    validates_presence_of :user_id, :notification_id
+  end
+end

data/lib/crier/notification.rb

@@ -0,0 +1,29 @@
+module Crier
+  class Notification < ActiveRecord::Base
+    self.table_name = 'crier_notifications'
+
+    belongs_to :crier, :class_name => 'User'
+    belongs_to :subject, :polymorphic => true
+
+    has_many :listenings, :dependent => :delete_all
+    has_many :audience, :through => :listenings, :source => :user # If any, this constitutes a private audience for this notification
+
+    store :metadata
+
+    scope :heard_by, lambda {|user| joins("LEFT OUTER JOIN #{Listening.table_name} ON #{Listening.table_name}.notification_id = #{table_name}.id").where("#{Listening.table_name}.user_id = #{user.id} OR NOT private")}
+    scope :about,    lambda {|subject| where(:subject_id => subject.id, :subject_type => subject.class) }
+    scope :in_scope, lambda {|scope| where(:scope => scope) }
+
+    # Shortcut for creating a private audience for this notification
+    def to(audience)
+      self.update_column(:private, true)
+      self.audience = (self.audience + Array(audience)).uniq
+
+      return self
+    end
+
+    def to_others(audience)
+      to(Array(audience) - [crier])
+    end
+  end
+end

data/lib/crier/version.rb

@@ -0,0 +1,3 @@
+module Crier
+  VERSION = '0.0.1'
+end

data/lib/crier.rb

@@ -0,0 +1,20 @@
+# Load the crier files
+require 'crier/acts_as_crier'
+require 'crier/listening'
+require 'crier/notification'
+
+# FIXME: This doesn't seem to connect to the database correctly
+# Load the rake tasks
+# require 'rails'
+# module Crier
+#   class Railtie < Rails::Railtie
+#     railtie_name :crier
+
+#     rake_tasks do
+#       load "tasks/crier_tasks.rake"
+#     end
+#   end
+# end
+
+# Load the act method
+ActiveRecord::Base.send :extend, Crier::ActMethod

data/lib/tasks/crier_tasks.rake

@@ -0,0 +1,32 @@
+# desc "Explaining what the task does"
+
+namespace :crier do 
+  task :create_tables do
+    ActiveRecord::Migration.create_table Crier::Notification.table_name, :force => true do |t|
+      t.string :scope
+      t.text :message
+
+      t.integer :crier_id
+
+      t.string :subject_type
+      t.integer :subject_id
+
+      t.string :action
+
+      t.text :metadata
+
+      t.boolean :private, :null => false, :default => false
+      t.timestamps
+    end
+
+    ActiveRecord::Migration.add_index Crier::Notification.table_name, :scope
+    
+    ActiveRecord::Migration.create_table Crier::Listening.table_name, :force => true do |t|
+      t.belongs_to :notification
+      t.belongs_to :user
+    end
+
+    ActiveRecord::Migration.add_index Crier::Listening.table_name, :notification_id
+    ActiveRecord::Migration.add_index Crier::Listening.table_name, :user_id
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: crier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Wallace
+- Nicholas Jakobsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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 notification for the whole town
+email:
+- contact@culturecode.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/crier.rb
+- lib/crier/acts_as_crier.rb
+- lib/crier/listening.rb
+- lib/crier/notification.rb
+- lib/crier/version.rb
+- lib/tasks/crier_tasks.rake
+homepage: 
+licenses: []
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Simple notification for the whole town
+test_files: []