rails-alerter 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db24886c3f4f6847206d8e304b4491437247e1dc
+  data.tar.gz: 3ec40c899dbb26fdbe9862807ab96942a0733b42
+SHA512:
+  metadata.gz: e0ee4dc0c52768b6cd8d5a4984befde66bd1e8ddd163e8b0bc379f5129c0d4cf01d5191906f0c2e8ebfb221141821814cff8024a31e2f6d9884cffa4bf31e7e7
+  data.tar.gz: 6030051ea01e9c5369d501c8d0e8d15c5be5909f083450b588216b75c49f95faee8f99fd0a160c448730e57352501bcfcc351113e3a450224fa75658dcf1335d

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/log/*.lck
+spec/dummy/tmp/
+spec/dummy/.project
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+log/*.log
+pkg/
+**.tmp_*
+.idea
+.project
+.document
+.settings/
+.yardoc/*
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.ruby-gemset

@@ -0,0 +1 @@
+alerter

data/.ruby-version

@@ -0,0 +1 @@
+2.2

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails3.2" do
+  gem "rails", "~> 3.2.17"
+end
+
+appraise "rails4.0" do
+  gem "rails", "~> 4.0.4"
+end
+
+appraise "rails4.1" do
+  gem "rails", "~> 4.1.0"
+end

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 DaKaZ
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Michael Kazmier
+
+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,111 @@
+# Alerter
+
+### This is ALPHA software 
+
+We are still building out the mailers for everything except email...
+
+## Overview
+
+Alerter is a Rails gem for managing notifications within a standard Rails app.  Notifications are getting more complex
+as applications now typically have multiple faces (web, mobile, social, etc) and users are requesting varying 
+delivery methods for notifications (in-app, mobile push, email, text, social, etc).
+
+Alter is largely derived from the outstanding Mailboxer app (https://github.com/mailboxer/mailboxer) but solving a 
+very different problem: Notifications
+
+Alerter provides 4 basic functions:
+* Extend your user object with acts-as-notifiable
+* Manage multiple Notification Types (these are application specific, ex: Billing, Support, Sales, Achievement, etc)
+* Send and track delivery state for the notification providing a full audit history
+* Provide notification preferences for users
+  * Allow users to specify which methods (email, text, none, etc) they would like be notified on for different Notification Types
+
+
+We need help with testing and documention, please jump in!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails-alerter'
+
+And then execute:
+
+    $ bundle install
+
+Run the install script
+
+    $ rails g alerter:install
+    
+Migrate the DB
+    
+    $ rake db:migrate
+    
+Generate your own email templates
+
+    $ rails g alerter:views
+
+In your model:
+
+    class User < ActiveRecord::Base
+      acts_as_notifiable
+    end
+    
+## Usage
+
+Alerter uses a `Alerter::Message` object that requires a short_msg and long_msg to accomidate different delivery
+platforms.  You can configure the maximum length of these in the initializer:
+
+     Alerter.setup do |config|
+       config.short_msg_length = 144 # Up to String length for your DB
+       config.long_msg_length  = 512 # Any length you want
+       ...
+     end   
+
+
+How can I send a message to a user?
+
+    #Send a message to beta
+    Alerter::Message.notify_all(beta, "Short Message", "Long Message")
+    
+Or you can include an array of recipients
+
+    recipients = [ alice, john, steve ]
+    Alerter::Message.notify_all(recipients, "Short Message", "Long Message")    
+    
+How can I retrieve my conversations?
+    
+    #alfa wants to retrieve all his messages (read and unread)
+    alfa.mailbox.inbox
+    
+    #alfa gets the last message (chronologically, the first in the inbox)
+    message = alfa.mailbox.inbox.first
+    
+    # get only unread messages
+    alfa.mailbox.inbox.unread
+    
+You can mark a message as read, unread or deleted or one or more users
+
+    # for user alpha
+    message.mark_as_read(alfa)
+    message.mark_as_unread(alfa)
+    message.mark_as_deleted(alfa)
+
+
+You can change the way in which emails, SMS or mobile Push notifications are delivered by specifying a custom implementation of the mailer
+
+    Alerter.setup do |config|
+      config.email_message_mailer = CustomEmailMessageMailer
+      config.sms_message_mailer   = CustomSmsMessageMailer
+      config.push_message_mailer  = CustomPushMessageMailer
+      ...
+    end
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/alerter/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require "bundler/gem_tasks"
+
+require 'appraisal'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/alerter.gemspec

@@ -0,0 +1,60 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alerter/version'
+
+Gem::Specification.new do |s|
+  s.name = "rails-alerter"
+  s.version = Alerter::VERSION
+
+  s.authors = ["Michael Kazmier"]
+  s.summary = "Messaging system for rails apps."
+  s.description = "Many apps need to send basic notifications to users, often using multiple " +
+      "delivery methods (like email, push notifications, SMS, twitter, etc).  This gem is designed to " +
+      "make that process easy and track the state of the notification in a centralized fashion."
+  s.email = [ "dakazmier@gmail.com" ]
+  s.homepage = "https://github.com/DaKaZ/alerter"
+  s.files = `git ls-files`.split("\n")
+  s.license = 'MIT'
+
+  # Gem dependencies
+  #
+  # SQL foreign keys
+  s.add_runtime_dependency('foreigner', '>= 0.9.1')
+
+  # Development Gem dependencies
+  s.add_runtime_dependency('rails', '>= 3.2.0')
+
+  if RUBY_ENGINE == "rbx" && RUBY_VERSION >= "2.1.0"
+    # Rubinius has it's own dependencies
+    s.add_runtime_dependency     'rubysl'
+    s.add_development_dependency 'racc'
+  end
+  # Specs
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-rails'
+  s.add_development_dependency 'rspec-rails', '~> 3.0'
+  s.add_development_dependency 'rspec-its', '~> 1.1'
+  s.add_development_dependency 'rspec-collection_matchers', '~> 1.1'
+  s.add_development_dependency('appraisal', '~> 1.0.0')
+  s.add_development_dependency('shoulda-matchers')
+  s.add_development_dependency('simplecov')
+  # Fixtures
+  #if RUBY_VERSION >= '1.9.2'
+  # s.add_development_dependency('factory_girl', '>= 3.0.0')
+  #else
+  #s.add_development_dependency('factory_girl', '~> 2.6.0')
+  #end
+  s.add_development_dependency('factory_girl', '~> 3.3.0')
+  # Population
+  s.add_development_dependency('forgery', '>= 0.3.6')
+  # Integration testing
+  s.add_development_dependency('capybara', '>= 0.3.9')
+  # Testing database
+  if RUBY_PLATFORM == 'java'
+    s.add_development_dependency('jdbc-sqlite3')
+    s.add_development_dependency('activerecord-jdbcsqlite3-adapter', '1.3.0.rc1')
+  else
+    s.add_development_dependency('sqlite3')
+  end
+end

data/app/builders/alerter/base_builder.rb

@@ -0,0 +1,26 @@
+class Alerter::BaseBuilder
+
+  attr_reader :params
+
+  def initialize(params)
+    @params = params.with_indifferent_access
+  end
+
+  def build
+    klass.new.tap do |object|
+      params.keys.each do |field|
+        object.send("#{field}=", get(field)) unless get(field).nil?
+      end
+    end
+  end
+
+  protected
+
+  def get(key)
+    respond_to?(key, true) ? send(key) : params[key]
+  end
+
+  def recipients
+    Array(params[:recipients]).uniq
+  end
+end

data/app/builders/alerter/message_builder.rb

@@ -0,0 +1,16 @@
+class Alerter::MessageBuilder < Alerter::BaseBuilder
+
+  protected
+
+  def klass
+    Alerter::Message
+  end
+
+  def short_msg
+    params[:short_msg] || ''
+  end
+
+  def long_msg
+    params[:long_msg] || ''
+  end
+end

data/app/builders/alerter/receipt_builder.rb

@@ -0,0 +1,13 @@
+class Alerter::ReceiptBuilder < Alerter::BaseBuilder
+
+  protected
+
+  def klass
+    Alerter::Receipt
+  end
+
+  def mailbox_type
+    params.fetch(:mailbox_type, 'inbox')
+  end
+
+end

data/app/mailers/alerter/base_mailer.rb

@@ -0,0 +1,15 @@
+class Alerter::BaseMailer < ActionMailer::Base
+  default :from => Alerter.default_from
+
+  private
+
+  def set_subject()
+    @subject ||= Alerter.default_subject
+    strip_tags(@subject)
+  end
+
+  def strip_tags(text)
+    ::Alerter::Cleaner.instance.strip_tags(text)
+  end
+
+end

data/app/mailers/alerter/message_mailer.rb

@@ -0,0 +1,12 @@
+class Alerter::MessageMailer < Alerter::BaseMailer
+  #Sends and email with the message
+  def send_email(message, receiver)
+    @message  = message
+    @receiver = receiver
+    set_subject
+    mail :to => receiver.send(Alerter.email_method),
+         :subject =>  @subject,
+         :template_name => 'new_message_email'
+  end
+
+end

data/app/models/alerter/mailbox.rb

@@ -0,0 +1,74 @@
+class Alerter::Mailbox
+  attr_reader :notifiable
+
+  #Initializer method
+  def initialize(notifiable)
+    @notifiable = notifiable
+  end
+
+  #Returns the messages for the messageable
+  def all_messages(options = {})
+    #:type => nil is a hack not to give Messages as Notifications
+    messages = Alerter::Message.receipts(@notifiable).where(:type => nil).order("alerter_messages.created_at DESC")
+    if options[:read] == false || options[:unread]
+      messages = messages.unread
+    end
+
+    messages
+  end
+
+  #Returns the conversations for the messageable
+  #
+  #Options
+  #
+  #* :mailbox_type
+  #  * "inbox"
+  #  * "trash"
+  #
+  #* :read=false
+  #* :unread=true
+  #
+  def messages(options = {})
+    messages = get_messages(options[:mailbox_type])
+
+    if options[:read] == false || options[:unread]
+      messages = messages.unread #(notifiable)
+    end
+
+    messages
+  end
+
+  #Returns the messages in the inbox of notifiable
+  #
+  #Same as conversations({:mailbox_type => 'inbox'})
+  def inbox(options={})
+    options = options.merge(:mailbox_type => 'inbox')
+    messages(options)
+  end
+
+  def trash(options={})
+    options = options.merge(:mailbox_type => 'trash')
+    messages(options)
+  end
+
+
+  #Returns all the receipts of notifiable from Messages
+  def receipts(options = {})
+    Alerter::Receipt.where(options).recipient(notifiable)
+  end
+
+
+  private
+
+  def get_messages(mailbox)
+    case mailbox
+      when 'inbox'
+        Alerter::Message.inbox(notifiable)
+      when 'trash'
+        Alerter::Message.trash(notifiable)
+    end
+
+  end
+
+
+end