acts_as_messagable 0.0.1

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+owngems

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.8.7

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb --no-private

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stefan Exner
+
+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,29 @@
+# ActsAsMessagable
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_messagable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_messagable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/acts_as_messagable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_messagable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'acts_as_messagable'
+  spec.version       = ActsAsMessagable::VERSION
+  spec.authors       = ['Stefan Exner']
+  spec.email         = ['stex@sterex.de']
+  spec.description   = %q{Handles Message sending between ActiveRecord instances}
+  spec.summary       = %q{Inter-Model message sending}
+  spec.homepage      = 'https://github.com/Stex/acts_as_messagable'
+  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_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'redcarpet', '~> 2.3.0'
+
+  spec.add_dependency 'activerecord', '< 3'
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/rails/init'

data/lib/acts_as_messagable.rb

@@ -0,0 +1 @@
+require 'acts_as_messagable/version'

data/lib/acts_as_messagable/version.rb

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

data/lib/stex/acts/messagable.rb

@@ -0,0 +1,338 @@
+module Stex
+  module Acts
+    module Messagable
+      #
+      # @return [Bool] +true+ if the given model +acts_as_messagable+
+      #
+      def self.messagable?(model)
+        model.respond_to?(:acts_as_messagable_options)
+      end
+
+      #
+      # Sets the class which is used to create messages in
+      # the system. Defaults to +Notification+
+      #
+      # @param [ActiveRecord::Base, String, Symbol] klass
+      #   Class to be used for message handling
+      #
+      def self.message_class=(klass)
+        @@message_class_name = klass.to_s
+      end
+
+      #
+      # @return [ActiveRecord::Base] (Notification)
+      #   The class used to create new messages in the system
+      #
+      def self.message_class
+        self.message_class_name.constantize
+      end
+
+      #
+      # @return [String]
+      #   The message class' name
+      #
+      def self.message_class_name
+        @@message_class_name ||= 'Notification'
+        @@message_class_name.classify
+      end
+
+      #
+      # Helper method to run certain +acts_as_messagable+ options.
+      # It basically determines the value's class and either
+      # directly runs given Proc objects or tries to handle symbols
+      # as instance method. The +:if+ options on ActiveRecord validations
+      # work the same way.
+      #
+      # @param [Messagable] instance
+      #   The sender or recipient the given option was defined in
+      #
+      # @param [Proc, String, Symbol] proc_or_symbol
+      #   Either a Proc object or an instance method name.
+      #   If a +String+ or +Symbol+ is given, a method with this name
+      #   has to be defined in +instance+
+      #
+      # @param [Object] default (nil)
+      #   If +proc_or_symbol+ is neither +Proc+ nor +String+ or +Symbol+,
+      #   this value is returned instead.
+      #
+      # @return [Object] The executed method or +default+
+      #
+      def self.run_method(instance, proc_or_symbol, default = nil)
+        if proc_or_symbol.is_a?(Symbol) || proc_or_symbol.is_a?(String)
+          raise Exception.new("Expected #{proc_or_symbol} to be an instance method of #{instance.class.name}") unless instance.respond_to?(proc_or_symbol)
+          instance.send(proc_or_symbol)
+        elsif proc_or_symbol.is_a?(Proc)
+          proc_or_symbol.call(instance)
+        else
+          default
+        end
+      end
+
+      #
+      # Follows possible forward and optional recipient chains down
+      # to the white rabb... final recipient which then either handles
+      # the message hash or receives a message through the system
+      #
+      # @param [Array<Messagable>] recipients
+      #   recipients to be inspected
+      #
+      # @return [Array<Messagable>]
+      #   Messagables which do not have a +:forward+-option set.
+      #
+      def self.determine_message_recipients(recipients = [])
+        result = []
+
+        Array(recipients).each do |recipient_or_array|
+
+          #Determine optional recipients and add them to the result set
+          if recipient_or_array.is_a?(Array)
+            recipient           = recipient_or_array.first
+            optional_recipients = Array(recipient_or_array.last).map { |i| recipient.messagable_accessor(:optional_recipients).assoc(i.to_sym).second }.flatten
+
+            result += determine_message_recipients(optional_recipients)
+          else
+            recipient = recipient_or_array
+          end
+
+          raise ArgumentError.new('Invalid Recipient: ' + recipient.inspect) unless Stex::Acts::Messagable.messagable?(recipient)
+
+          #Handle +forward_to+ options on the recipient record.
+          #If it's set, we don't want to add the current recipient to the result list,
+          #but rather the ones it's pointing at.
+          if recipient.messagable_accessor(:forward_to)
+            result += determine_message_recipients(recipient.messagable_accessor(:forward_to))
+          else
+            result << recipient
+          end
+        end
+
+        result
+      end
+
+      #
+      # Includes the class methods
+      #
+      # @private
+      #
+      def self.included(base)
+        base.class_eval do
+          base.send :extend, ClassMethods
+        end
+      end
+
+      module ClassMethods
+        #
+        # Adds the functionality to send and receive messages to this +ActiveRecord+ class
+        #
+        # @param [Hash] options
+        #   Available Options and overrides for this model class
+        #
+        # @option options [Proc, Symbol] :sender_name ("Class.human_name #self.id")
+        #   Proc or Proc Name to determine the sender name.
+        #
+        # @option options [Proc, Symbol] :recipient_name ("Class.human_name #self.id")
+        #   Proc or Instance Method Name to determine the recipient name.
+        #
+        # @option options [Proc, Symbol] :forward_to
+        #   Proc or Instance Method Name. If specified, the system will forward
+        #   received messages to the method's return value instead of to
+        #   the actual record
+        #
+        # @option options [Array<Array<Symbol, Proc|Symbol, String>>] :optional_recipients
+        #   One ore more recipients that may be included in a message
+        #   to an instance of this class. These should be selectable on the view part
+        #   of the application, e.g. checkboxes next to the actual recipient.
+        #   The elements are used as follows:
+        #
+        #   1. An identifier to access this optional recipient group,
+        #   2. The actual selector that should return the recipients,
+        #   3. A string or Proc that tells the system how to display this optional recipient
+        #
+        # @option options [Proc, Symbol] :handler
+        #   If given, messages are sent to the given proc object / instance method instead of
+        #   actually created in the database.
+        #   The handler method has to accept 2 arguments, the message sender and a +Hash+ of options
+        #   These options include:
+        #   - :subject
+        #   - :content
+        #   - :additional_recipients (optional)
+        #
+        # @option options [Bool, Symbol, Proc] :store_additional_recipients
+        #   If set or evaluating to +true+, all recipients (CC) are stored in a +Message+ record.
+        #   This might make sense in cases when e.g. an email should contain a list of
+        #   all the people that received it.
+        #   If the value is a Symbol, the system will assume that there is an instance method with that name.
+        #
+        # @example Forwarding group messages to its students and optionally include the tutors
+        #   acts_as_messagable :forward_to          => :students,
+        #                      :optional_recipients => [[:tutors, lambda { |r| r.tutors }, Tutor.human_name(:count => 2)]]
+        #   # The selector could simplified by +:tutors+ instead of the lambda expression
+        #
+        def acts_as_messagable(options = {})
+          klass = Stex::Acts::Messagable.message_class_name
+
+          #Add has_many associations for easy message management
+          has_many :received_messages, :class_name => klass, :as => :recipient, :conditions => {:sender_copy => false}
+          has_many :unread_messages, :class_name => klass, :as => :recipient, :conditions => {:read_at => nil, :sender_copy => false}
+          has_many :read_messages, :class_name => klass, :as => :recipient, :conditions => ['read_at IS NOT NULL AND sender_copy = ?', false]
+          has_many :sent_messages, :class_name => klass, :as => :sender, :conditions => {:sender_copy => true}
+
+          cattr_accessor :acts_as_messagable_options
+
+          coptions                       = {}
+
+          #Sender and recipient procs
+          coptions[:sender_name]         = options[:sender_name] || lambda { |r| "#{r.class.human_name}: #{r.id}" }
+          coptions[:recipient_name]      = options[:recipient_name] || lambda { |r| "#{r.class.human_name}: #{r.id}" }
+
+          #Forward and message handler proc
+          coptions[:forward_to]          = options[:forward_to] if options.has_key?(:forward_to)
+          coptions[:handler]             = options[:handler] if options.has_key?(:handler)
+
+          #optional recipients
+          coptions[:optional_recipients] = options[:optional_recipients] if options[:optional_recipients]
+
+          coptions[:store_additional_recipients] = options[:store_additional_recipients]
+
+          self.acts_as_messagable_options = coptions.freeze
+
+          include Stex::Acts::Messagable::InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+
+        #
+        # Accessor for acts_as_messagable options and helpers
+        #
+        # @param [String, Symbol] request
+        #   Requested option or helper, available values are:
+        #   - +:sender_name+ Returns a formatted representation of +self+
+        #     which is used in message sender display fields
+        #
+        #   - +:recipient_name+ Returns a formatted representation of +self+
+        #     which is used in message recipient display fields
+        #
+        #   - +:forward_to+ Returns the recipient(s) a message should be forwarded
+        #     to instead of being delivered to +self+ or +nil+ if not defined (see #acts_as_messagable)
+        #
+        #   - +:optional_recipients+ Returns an Array of Array<Symbol, *Messagable, String>,
+        #     for more details see #acts_as_messagable
+        #
+        #   - +:store_additional_recipients+ Returns true|false, depending on the given option
+        #     in #acts_as_messagable
+        #
+        def messagable_accessor(request)
+          @cached_accessors ||= {}
+          options           = self.class.acts_as_messagable_options
+
+          @cached_accessors[request.to_sym] ||= case request.to_sym
+                                                  when :sender_name
+                                                    Stex::Acts::Messagable.run_method(self, options[:sender_name])
+                                                  when :recipient_name
+                                                    Stex::Acts::Messagable.run_method(self, options[:recipient_name])
+                                                  when :forward_to
+                                                    Stex::Acts::Messagable.run_method(self, options[:forward_to])
+                                                  when :optional_recipients
+                                                    Array(options[:optional_recipients]).map do |identifier, proc, name|
+                                                      recipient_name = name.is_a?(String) ? name : Stex::Acts::Messagable.run_method(self, name)
+                                                      [identifier, Stex::Acts::Messagable.run_method(self, proc), recipient_name]
+                                                    end
+                                                  when :store_additional_recipients
+                                                    Stex::Acts::Messagable.run_method(self, options[:store_additional_recipients],
+                                                                                      options[:store_additional_recipients])
+                                                  else
+                                                    raise ArgumentError.new('Invalid Request Argument: ' + request.to_s)
+                                                end
+        end
+
+        #
+        # Sends a message from +self+ to the given list of recipients
+        # The whole sending happens in a transaction, so if one message creation
+        # fails, none of them are sent.
+        #
+        # @param [Array<Messagable>|Array<Hash>|Messagable] recipients
+        #   The message recipient(s), all have to be +messagable+
+        #   The value will be handled as an Array in every case, so if you only
+        #   have one recipient, you don't have to put it in brackets.
+        #   The array elements may either be +messagable+ objects or arrays,
+        #   mapping +messagable+ to Array<optional recipient identifiers>, see example.
+        #
+        # @param [String] subject
+        #   The message message's subject
+        #
+        # @param [String] content
+        #   The message message
+        #
+        # @example Recipient with optional recipient (see #acts_as_messagable)
+        #   my_user.send_message([[my_group, [:tutors]]], 'Subject', 'Body')
+        #
+        def send_message(recipients, subject, content, options = {})
+          recipients_with_cause = []
+          all_recipients        = []
+
+          #Create a new list of recipients together with the original recipients
+          #that caused their existance in this list.
+          #Also, determine whether additional recipients should be saved or not
+          Array(recipients).each do |recipient_or_array|
+            local_recipients = Stex::Acts::Messagable.determine_message_recipients([recipient_or_array])
+            recipient        = recipient_or_array.is_a?(Array) ? recipient_or_array.first : recipient_or_array
+
+            all_recipients += local_recipients
+
+            recipients_with_cause << {:cause             => recipient,
+                                      :store_additionals => recipient.class.acts_as_messagable_options[:store_additional_recipients] && local_recipients.size > 1,
+                                      :recipients        => local_recipients.uniq}
+
+          end
+
+          all_recipients.uniq!
+          processed_recipients = []
+
+          Stex::Acts::Messagable.message_class.transaction do
+            recipients_with_cause.each do |recipient_data|
+              recipient_data[:recipients].each do |recipient|
+
+                next if processed_recipients.include?(recipient)
+                processed_recipients << recipient
+
+                message                       = options.clone
+                message[:subject]             = subject
+                message[:content]             = content
+                message[:original_recipients] = Array(recipients)
+
+                #If the original recipient was set to store additional recipients, we store
+                #all recipients that were caused by the same original recipient
+                if recipient_data[:store_additionals]
+                  message[:additional_recipients] = recipient_data[:recipients] - [recipient]
+                  # If the recipient itself was set to store additional recipients, we store
+                  # all recipients this message is sent to, regardless of the original recipients
+                elsif recipient.class.acts_as_messagable_options[:store_additional_recipients] && final_recipients.size > 1
+                  message[:additional_recipients] = all_recipients - [recipient]
+                end
+
+                #It might happen that a messagable does not actually want to
+                #receive messages, but instead do something different.
+                if recipient.class.acts_as_messagable_options[:handler]
+                  recipient.class.acts_as_messagable_options[:handler].call(self, message)
+                else
+                  #Otherwise, a new message is created and sent to the given recipient
+                  Stex::Acts::Messagable.message_class.create!(message.merge({:sender => self, :recipient => recipient}))
+                end
+              end
+            end
+
+            #Create a copy of the message for the sender
+            Stex::Acts::Messagable.message_class.create!(:subject               => subject,
+                                                         :content               => content,
+                                                         :original_recipients   => Array(recipients),
+                                                         :additional_recipients => all_recipients,
+                                                         :sender                => self,
+                                                         :recipient             => self,
+                                                         :sender_copy           => true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stex/acts/messagable/extensions.rb

@@ -0,0 +1,181 @@
+module Stex
+  module Acts
+    module Messagable
+      module Extensions
+        def self.included(base)
+          base.class_eval do
+            base.send :extend,  ClassMethods
+          end
+        end
+
+        #----------------------------------------------------------------
+        #                        Class Methods
+        #----------------------------------------------------------------
+
+        module ClassMethods
+          def messagable?(recipient)
+            Stex::Acts::Messagable.messagable?(recipient)
+          end
+        end
+
+        #----------------------------------------------------------------
+        #                      Instance Methods
+        #----------------------------------------------------------------
+
+
+        #
+        # @return [Bool] +true+ if the notification was marked as read before
+        #
+        def read?
+          read_at.present?
+        end
+
+        #
+        # @see #read?
+        #
+        def unread?
+          !read?
+        end
+
+        #
+        # Sets the +read_at+ attribute to the current time
+        # and saves the record without validations
+        #
+        def mark_as_read!
+          self.read_at = Time.now
+          save(false)
+        end
+
+        #----------------------------------------------------------------
+        #                      Metadata Handling
+        #----------------------------------------------------------------
+
+        def url
+          metadata[:url]
+        end
+
+        def url=(url)
+          metadata[:url] = url
+        end
+
+        #
+        # @return [Messagable]
+        #   The additional recipients which were determined by the +send_message+ function
+        #
+        def additional_recipients
+          meta_record_list(:additional_recipients)
+        end
+
+        #
+        # Sets additional recipients in this message's metadata.
+        # This is automatically done by the +send_message+ function.
+        #
+        # @param [Array<Messagable>] recipients
+        #   The list of additional recipients
+        #
+        def additional_recipients=(recipients = [])
+          meta_record_list_update(:additional_recipients, recipients)
+        end
+
+        #
+        # @return [Array<String>]
+        #   The +recipient_name+s of all additional recipients. This uses the
+        #   +recipient_name+ option set in the recipient's model class.
+        #
+        def additional_recipient_names
+          additional_recipients.map {|r| r.messagable_accessor(:recipient_name) }
+        end
+
+        #
+        # @return [Array<Messagable>]
+        #   The original recipients which were initially given to the
+        #   +send_message+ function (so no derived recipients)
+        #
+        def original_recipients
+          result = []
+          metadata[:original_recipients].each do |recipient|
+
+            #Optional recipients included
+            if recipient.first.is_a?(Array)
+              recipient_class, recipient_id = recipient.first
+              result << [recipient_class.constantize.find(recipient_id), recipient.last]
+            else
+              recipient_class, recipient_id = recipient
+              result << recipient_class.constantize.find(recipient_id)
+            end
+          end
+          result
+        end
+
+        #
+        # @return [Array<String>]
+        #   The names of the +original_recipients+,
+        #   uses the +recipient_name+ option set in the recipient's model class
+        #
+        def original_recipient_names
+          original_recipients.map do |recipient_or_array|
+            if recipient_or_array.is_a?(Array)
+              recipient      = recipient_or_array.first
+              optional_names = recipient_or_array.last.map {|i| recipient.messagable_accessor(:optional_recipients).assoc(i.to_sym).third }
+              [recipient.messagable_accessor(:recipient_name), *optional_names]
+            else
+              recipient_or_array.messagable_accessor(:recipient_name)
+            end
+          end
+        end
+
+        #
+        # Stores the original recipients of this notification.
+        #
+        # @param recipients
+        #   An array of +Messagable+ which may also include optional recipients
+        #   as symbols (see +{Stex::Acts::Messagable#send_notification}+)
+        #
+        def original_recipients=(recipients = [])
+          result = []
+
+          recipients.each do |recipient_or_array|
+            if recipient_or_array.is_a?(Array)
+              recipient = recipient_or_array.first
+              result << [[recipient.class.to_s, recipient.id], recipient_or_array.last]
+            else
+              result << [recipient_or_array.class.to_s, recipient_or_array.id]
+            end
+          end
+
+          metadata[:original_recipients] = result
+        end
+
+        private
+
+        #
+        # @private
+        #
+        def meta_record_list(key)
+          return [] unless metadata[key]
+          @meta_record_list ||= {}
+          @meta_record_list[key] ||= metadata[key].map {|class_name, id| class_name.constantize.find(id)}
+        end
+
+        #
+        # @private
+        #
+        def meta_record_list_update(key, list = [])
+          @meta_record_list ||= {}
+          @meta_record_list[key] = list
+          metadata[key] = @meta_record_list[key].map {|r| [r.class.to_s, r.id] }
+        end
+
+        #
+        # Accessor method for all metadata
+        # Metadata can then be accessed using []
+        #
+        # @private
+        #
+        def metadata
+          self.serialized_metadata ||= {}
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,6 @@
+require 'stex/acts/messagable'
+require 'stex/acts/messagable/extensions'
+
+ActiveRecord::Base.class_eval do
+  include Stex::Acts::Messagable
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_messagable
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stefan Exner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-03-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: redcarpet
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id005
+description: Handles Message sending between ActiveRecord instances
+email: 
+- stex@sterex.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .yardopts
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_messagable.gemspec
+- init.rb
+- lib/acts_as_messagable.rb
+- lib/acts_as_messagable/version.rb
+- lib/stex/acts/messagable.rb
+- lib/stex/acts/messagable/extensions.rb
+- rails/init.rb
+homepage: https://github.com/Stex/acts_as_messagable
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Inter-Model message sending
+test_files: []
+
+has_rdoc: