postman_pat 0.0.1.4

data/Gemfile

@@ -0,0 +1,25 @@
+source "http://rubygems.org"
+
+
+# Bundle edge Rails instead:
+# gem 'rails',     :git => 'git://github.com/rails/rails.git'
+gem 'acts_as_tree'
+gem 'aasm'
+
+group :development, :test do
+	gem 'mysql2'
+  gem 'jeweler'
+  gem 'ffaker'
+  gem 'yard'
+	gem 'rails', '3.1'
+  gem 'rspec-rails', '= 2.3'
+  #gem 'json_spec'
+	gem 'factory_girl_rails'
+	gem 'database_cleaner'
+  gem 'ruby-debug19'
+  gem 'mocha'
+end
+
+if RUBY_VERSION < '1.9'
+  gem "ruby-debug", ">= 0.10.3"
+end

data/Gemfile.lock

@@ -0,0 +1,145 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aasm (2.3.0)
+      activerecord
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
+      mail (~> 2.3.0)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    acts_as_tree (0.1.1)
+    archive-tar-minitar (0.5.2)
+    arel (2.2.1)
+    bcrypt-ruby (3.0.0)
+    builder (3.0.0)
+    columnize (0.3.4)
+    database_cleaner (0.6.7)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    factory_girl (2.1.0)
+    factory_girl_rails (1.2.0)
+      factory_girl (~> 2.1.0)
+      railties (>= 3.0.0)
+    ffaker (1.8.1)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    mime-types (1.16)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.0.3)
+    mysql2 (0.3.7)
+    polyglot (0.3.2)
+    rack (1.3.2)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.0)
+      actionmailer (= 3.1.0)
+      actionpack (= 3.1.0)
+      activerecord (= 3.1.0)
+      activeresource (= 3.1.0)
+      activesupport (= 3.1.0)
+      bundler (~> 1.0)
+      railties (= 3.1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2)
+    rdoc (3.9.4)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    rspec-rails (2.3.0)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.3.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aasm
+  acts_as_tree
+  database_cleaner
+  factory_girl_rails
+  ffaker
+  jeweler
+  mocha
+  mysql2
+  rails (= 3.1)
+  rspec-rails (= 2.3)
+  ruby-debug19
+  yard

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= PostmanPat
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PostmanPat'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/stylesheets/postman_pat/application.css

@@ -0,0 +1,8 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/
+

data/app/assets/stylesheets/postman_pat/postman_pat.css

@@ -0,0 +1,16 @@
+/* ------------------------------------------------------------------------------------- */
+/* Postman Pat Private Message Styles */
+/* Author: Kirk v. Quesnelle
+/* Last updated: Monday Sept. 5th 2011
+/* ------------------------------------------------------------------------------------- */
+div#pmp_mail_summary_container
+{
+
+}
+div.pmp_mail_summary_block
+{
+  border: 1px dotted #AAA;
+  padding: 8px;
+}
+
+

data/app/controllers/postman_pat/pm_mails_controller.rb

@@ -0,0 +1,107 @@
+
+class PostmanPat::PmMailsController < ApplicationController
+  before_filter :redirect_nologin
+
+  def index
+		@title = "Private Messages" 
+    @pm_mails = PostmanPat::PmMail.get_all_mail(current_user.id)
+
+		respond_to do |format|
+			format.html
+			format.json { render :json => @pm_mails.to_json } 
+		end
+  end
+
+  def show
+    @pm_mail = PostmanPat::PmMail.get_mail(current_user.id, (params[:id]).to_i) 
+    
+    if @pm_mail.nil?
+      flash[:error] = "Private message no longer exists."
+      redirect_to '/' and return
+    end
+    
+    # Mark the mail as read 
+    @pm_mail.mark_read!
+
+    @title = "Private Message: #{@pm_mail.pm_message.subject}"
+
+    respond_to do |format|
+      format.html 
+			format.json { render :json => @pm_mail.to_json } 
+    end  
+  end
+
+  def new
+    @title = "New Private Message"
+    @pm_mail = PostmanPat::PmMail.new 
+  end
+
+  def create
+    success = true
+    recipients = params[:recipients]
+    subject = params[:subject] 
+    message = params[:message]
+     
+    #[TODO] - do proper exception checking 
+    begin
+      result = PostmanPat::PmMail.compose(current_user, recipients, subject, message)
+      flash[:success] = "Message has been sent."
+    rescue Exception, "An error has occured with PmMail.compose method" 
+      success = false 
+      flash[:error] = "There was a problem sending your message."
+    end
+    
+    respond_to do |format|
+      format.html { redirect_to mail_index_path } 
+			format.json { render :json => "{\"success\":#{success}}"} 
+    end  
+  end
+
+  def update
+    success = true
+    pm_mail = PostmanPat::PmMail.get_mail(current_user.id, (params[:id]).to_i) 
+    
+    #[TODO] - do proper exception checking 
+    begin
+      pm_mail.reply(params[:message]) 
+      flash[:success] = "Reply has been sent."
+    rescue Exception
+      success = false
+      flash[:error] = "There was a probly sending your reply."
+    end
+      
+    respond_to do |format|
+      format.html { redirect_to mail_index_path } 
+			format.json { render :json => "{\"success\":#{success}}"} 
+    end  
+  end
+
+  def destroy
+    success = true
+    pm_mail = PostmanPat::PmMail.get_mail(current_user.id, params[:id])
+
+    #[TODO] - do proper exception checking 
+    begin
+      pm_mail.mark_deleted!
+      flash[:success] = "Your reply has been sent."
+    rescue Exception
+      success = false
+      flash[:error] = "There was an error sending your reply."
+    end
+
+    respond_to do |format|
+      format.html { redirect_to mail_index_path } 
+			format.json { render :json => "{\"success\":#{success}}"} 
+    end  
+  end
+
+  private
+
+  def redirect_nologin
+    if current_user.nil?
+			flash[:error] = "You must be signed in to access Private Messaging"
+			redirect_to '/' and return
+		end
+  end
+
+end

data/app/controllers/postman_pat/pm_messages_controller.rb

@@ -0,0 +1,4 @@
+class PostmanPat::PmMessagesController < ApplicationController
+  
+end
+

data/app/models/postman_pat/pm_mail.rb

@@ -0,0 +1,239 @@
+require 'aasm'
+module PostmanPat
+
+  class PmMail < ActiveRecord::Base
+		include ::AASM 
+		
+    # --------------------------------------------------------------------------------------------------
+    # Relationships 
+    # --------------------------------------------------------------------------------------------------
+    # [TODO] :class_name will have to be dynamic based on what model called
+    # acts_as_postman_pat, as well as :foreign_key
+    belongs_to :recipient, :class_name => "User"
+    belongs_to :pm_message, :class_name => "PostmanPat::PmMessage"
+   
+    #accepts_nested_attributes_for :pm_message
+
+    # --------------------------------------------------------------------------------------------------
+    # Validations 
+    # --------------------------------------------------------------------------------------------------
+    validates :recipient_id, :presence => true
+    validates :pm_message, :presence => true
+
+		# --------------------------------------------------------------------------------------------------
+    # State Machine 
+		# --------------------------------------------------------------------------------------------------
+		# [TODO] - write test for state machine transitions
+		aasm_initial_state :unread
+
+		aasm_state :unread
+		aasm_state :read
+		aasm_state :sent
+		aasm_state :deleted
+
+		# State Transitions Events
+		aasm_event :mark_read do
+			transitions :to => :read, :from => [:unread, :read, :sent, :deleted]
+		end
+
+		aasm_event :mark_unread do
+			transitions :to => :unread, :from => [:deleted, :read, :unread, :sent]
+		end
+
+		aasm_event :mark_sent do
+			transitions :to => :sent, :from => [:unread, :delete, :read, :sent]
+		end
+
+		aasm_event :mark_deleted do
+			transitions :to => :deleted, :from => [:read, :unread, :deleted, :sent]
+		end
+ 
+    # --------------------------------------------------------------------------------------------------
+    # Class Methods 
+    # --------------------------------------------------------------------------------------------------
+
+		# Creates and sends a new Private Message with subject and message to all recipients
+		#
+		# @param [User] user the sender of this message. 
+		# @param [Array] recipients user account ids that are to receive the message
+		# @param [optional, String] subject an optional subject for the new message. If no subject is given a default message of "[No Subject]" is provided. 
+		# @param [String] message the message content 
+		# @return [PmMessage] PmMessage object
+		def self.compose(author, recipients, subject, message)
+			recipients.map {|r| r.to_i}
+			
+			# Add default subject if non is provided
+			subject = "[No Subject]" if subject.blank?
+
+			msg = PostmanPat::PmMessage.new
+			msg.author = author
+			msg.subject = subject 
+			msg.message = message
+			
+			transaction do
+				msg.save!
+				# send a copy of the mail to the creator of the message and mark it as sent
+				mail = PostmanPat::PmMail.new
+				mail.recipient = author
+				mail.pm_message = msg
+				mail.mark_sent!
+				mail.save!
+
+				# create a new piece of mail for each collaborator in the message
+				recipients.each do |recipient|
+					mail = PostmanPat::PmMail.new
+					mail.recipient_id = recipient
+					mail.pm_message = msg
+					mail.save!	
+				end # each loop
+			end # transaction
+			msg
+		end
+
+		# Gets a specific pm mail by the user_id and mail_id
+		#
+		# @param [Integer] user_id the user id of the user to collect all mail for
+		# @param [Integer] mail_id the PmMail instance id of the mail you're trying to find
+		# @return [PmMail] PmMail instance or nil if the mail message of the user can not be found 
+		def self.get_mail(user_id, mail_id)
+			where(:id => mail_id).where(:recipient_id => user_id).first	
+		end	
+	 
+		# Gets all PmMail's for a user 
+		# 
+		# @param [Integer] user_id the user id of the user to fetch all the mail for
+		# @return [Array] an array of PmMail instances
+		def self.get_all_mail(user_id)
+			where(:recipient_id => user_id)
+		end
+
+
+    # Returns the total number of private mails for a particular user 
+    #
+    # @param [Integer] user_id user id of the user to find the total number of unread mails for
+    # @returns [Integer] the total number of mails
+    def self.num_mail(user_id)
+      where(:recipient_id => user_id).count
+    end
+
+
+    # Returns the number of unread private mail for a particular user
+    #
+    # @param [Integer] user_id user id of the user to find the number of unread mails for
+    # @returns [Integer] the number of unread mails. 
+    def self.num_unread_mail(user_id)
+      where(:recipient_id => user_id).where(:aasm_state => 'unread').count
+    end
+
+    # Returns the number of read private mail for a particular user
+    #
+    # @param [Integer] user_id user id of the user to find the number of read mails for
+    # @returns [Integer] the number of read mails. 
+    def self.num_read_mail(user_id)
+      where(:recipient_id => user_id).where(:aasm_state => 'read').count
+    end   
+
+    # Returns the number of deleted private mail for a particular user
+    #
+    # @param [Integer] user_id user id of the user to find the number of deleted mails for
+    # @returns [Integer] the number of deleted mails. 
+    def self.num_deleted_mail(user_id)
+      where(:recipient_id => user_id).where(:aasm_state => 'deleted').count
+    end   
+
+
+    # --------------------------------------------------------------------------------------------------
+    # Instance Methods 
+    # --------------------------------------------------------------------------------------------------
+		
+		# Return true or false if the mail is unread or not
+		#
+		# @returns [Boolean] true if the mail is unread, false otherwise
+		def is_unread?
+			self.aasm_state == "unread"	
+		end
+
+		# Return true or false if the mail has been read or not
+		#
+		# @returns [Boolean] true if the mail has been read, false otherwise
+		def is_read?
+			self.aasm_state == "read"	
+		end
+		
+		# Return true or false if the mail is in a state of sent 
+		#
+		# @returns [Boolean] true if the mail is the state of sent 
+		def is_sent?
+			self.aasm_state == "sent"	
+		end
+
+		# Return true or false if the mail has been deleted
+		#
+		# @returns [Boolean] true if the mail has been deleted by user
+		def is_deleted?
+			self.aasm_state == "deleted"	
+		end
+
+		# Reply to the mail message thread. 
+		#
+		# @param [String] message the reply message
+		def reply(message)
+			reply = PostmanPat::PmMessage.new
+			reply.parent_id = self.pm_message_id	
+			reply.author_id = self.recipient_id
+			reply.message = message
+
+			if reply.save!
+				# Set the message as unread again for all collaborators of the mail thread because
+				# one of them replied, thus making the mail "new" or "unseen" by all collaborators
+				set_all_to_unread
+
+				# Set the senders message state to 'sent'
+				self.mark_sent!
+			end
+			
+		end
+
+		# Tell us who the last user was to reply to the PmMail message thread.
+		# If nobody has replied, the author will be returned.
+		#
+		# @return [User] the last user to reply. Returns the author of the message if nobody has replied yet
+		def who_last_replied?
+			pm_message = PostmanPat::PmMessage.find(self.pm_message_id)
+			# [TODO] - raise exception if pm_message is nil
+			
+			if pm_message.children.count > 0
+				# [TODO] - link up the account/user model to be dynamic on whatever model called acts_as_postman_pat
+				User.find(pm_message.children.last.author_id)
+			else
+				# if nobody has replied, return creator
+				User.find(pm_message.author_id)
+			end
+			
+		end
+	
+		# Returns all the collaborators(users) of the PmMail/Message thread	
+		#
+		# @return [Array] array of users who are collaborating on the private message thread
+		def all_collaborators
+			collaborators = PostmanPat::PmMail.where(:pm_message_id => self.pm_message_id)	
+			ids = []
+			collaborators.each do |c|
+				ids << c.recipient_id
+			end
+			User.where(:id => ids)
+		end
+
+		private 
+					
+		# Set all mail of a given message thread to unread.
+		# @private
+		def set_all_to_unread
+			mails = PmMail.find_all_by_pm_message_id(self.pm_message_id)
+			mails.each do |mail|
+				mail.mark_unread!	
+			end									
+		end
+	
+  end
+end