photon 0.0.1 → 0.1.0

data/README

@@ -0,0 +1,104 @@
+Introducing Photon - the Dead Simple Rails messenger service
+
+Photon assumes very basic things about your schema. Right now, there is no config (it's coming, and the framework is there for it), and no migrations.
+
+It assumes you have the following 4 tables:
+
+Users
+
+Messages, containing:
+body
+subject
+delivery_id
+sender_id
+timestamps
+
+MessageThreads, containing:
+id, timestamps
+
+
+Deliveries, containing:
+user_id
+message_id
+read
+message_thread_id
+timestamps
+
+
+To setup the proper associations, there are the following model methods:
+
+User: acts_as_sender
+Delivery: acts_as_deliverable
+Message: acts_as_message
+MessageThread: acts_as_threadable
+
+This provides the following methods at this time:
+
+
+user#send_message(:to => User<object>, :subject => string, :body => string)
+
+Sends a message to a user. It starts a thread.
+
+
+
+user#reply_to(Message<object>, :subject => string, :body => string)
+
+Replies to one of the user's received messages
+
+
+
+user#sent_messages
+
+Array of sent messages
+
+
+user#unread_messages
+
+Array of unread messages
+
+
+user#read_messages
+
+Array of read messages
+
+
+user#read(Message<Object>)
+
+Marks the specified message object as read
+
+
+user#unread(Message<Object>)
+
+Marks the specified message object as unread
+
+
+Message#find_thread(User<Object>, Message<Object>)
+
+Finds the thread that the message and user belong to.
+
+
+
+EXAMPLE USAGE:
+
+user1 = User.create
+user2 = User.create
+
+user1.send_message(:to => user2, :subject => "Hello!", :body => "Hello world!")
+user1.sent_messages # => [#<Message id: 30, subject: "Hello!", body: "Hello world!", sender_id: 1>]
+unread_messages = user2.unread_messages # => [#<Message id: 30, subject: "Hello!", body: "Hello world!", sender_id: 1>] 
+user2.read(unread_messages[0])
+user2.read_messages # => [#<Message id: 30, subject: "Hello!", body: "Hello world!", sender_id: 1>]
+user2.reply_to(unread_messages[0], :subject => "Goodbye!", :body => "Hello again!")
+user1.unread_messages # => [#<Message id: 31, subject: "Goodbye!", body: "Hello again!", sender_id: 2>] 
+Message.find_thread(user1, user1.unread_messages[0]) # => [#<Message id: 30, subject: "Hello!", body: "Hello world!", sender_id: 1>, #<Message id: 31, subject: "Goodbye!", body: "Hello again!", sender_id: 2>] 
+
+
+TODO:
+
+Add configuration files
+Implement attachment support
+Make methods chainable - sending and replying should return the delivery object.
+Support external ActiveRecord databases - involving creating a lookup table on an external database based on current user ids.
+
+
+An extremely robust Riak version is coming soon.

data/lib/photon/delivers/core.rb

@@ -0,0 +1,72 @@
+module Photon
+  module Delivers
+    module Core
+      def self.included(base)
+        base.send :include, Photon::Delivers::Core::InstanceMethods
+        base.extend Photon::Delivers::Core::ClassMethods
+      end
+      
+      module ClassMethods
+      end
+
+      module InstanceMethods
+        def send_message(opts={})
+          if opts[:to].nil? || opts[:subject].nil? || opts[:body].nil?
+            false
+          else
+            opts[:message_thread_id] = opts[:message_thread_id] || constantize_model(Photon.thread).create.id
+            message = constantize_model(Photon.using).create!(:sender => self,
+                                                  :users => [opts[:to]].flatten,
+                                                  :subject => opts[:subject],
+                                                  :body => opts[:body]
+                                                 )
+
+            message.deliveries.update_all({:message_thread_id => opts[:message_thread_id], :scope_id => opts[:scope_id], :scope_type => opts[:scope_type]})
+          end
+        end
+
+        def sent_messages
+          constantize_model(Photon.using).where(:sender_id => self.id)
+        end
+
+        def unread_messages
+          through_string = Photon.through.to_s
+          constantize_model(Photon.using).where("#{through_string}.#{self.class.to_s.downcase}_id = ? AND #{through_string}.read IS NOT ?", self.id, true).joins(Photon.through)
+        end
+
+        def read_messages
+          through_string = Photon.through.to_s
+          constantize_model(Photon.using).where("#{through_string}.#{self.class.to_s.downcase}_id = ? AND #{through_string}.read IS ?", self.id, true).joins(Photon.through)
+        end
+
+        def read(message)
+          change_read_status(message, true)
+        end
+
+        def unread(message)
+          change_read_status(message, false)
+        end
+
+        def reply_to(message, opts = {})
+          if message.nil? || opts[:body].nil? || opts[:subject].nil?
+            false
+          else
+            delivery_object = constantize_model(Photon.through).where("#{self.class.to_s.downcase}_id = ? AND #{Photon.using.to_s.singularize}_id = ?", self.id, message.id).first
+            self.send_message(:to => message.sender, :message_thread_id => delivery_object.message_thread_id, :subject => opts[:subject], :body => opts[:body])
+          end
+        end
+
+
+        private
+        def change_read_status(message, status)
+          constantize_model(Photon.through).where("#{self.class.to_s.downcase}_id = ? AND #{Photon.using.to_s.singularize}_id = ?", self.id, message.id).update_all({:read => status})
+        end
+
+        def constantize_model(model_string)
+          model_string.to_s.singularize.classify.constantize
+        end
+      end
+
+    end
+  end
+end

data/lib/photon/delivers/message.rb

@@ -0,0 +1,20 @@
+module Photon
+  module Delivers
+    module Message
+      def self.included(base)
+        base.send :include, Photon::Delivers::Message::InstanceMethods
+        base.extend Photon::Delivers::Message::ClassMethods
+      end
+
+      module ClassMethods
+        def find_thread(user, message)
+          delivery_string = Photon.through.to_s
+          Photon.using.to_s.singularize.classify.constantize.joins(Photon.through).where("#{delivery_string}.#{Photon.thread.to_s.singularize}_id = (SELECT #{Photon.thread.to_s.singularize}_id FROM #{delivery_string} WHERE #{delivery_string}.#{Photon.to.to_s.singularize}_id = ? AND #{delivery_string}.#{Photon.using.to_s.singularize}_id = ?)", Photon.to.to_s.singularize.classify.constantize.first, Photon.using.to_s.singularize.classify.constantize.last)
+        end
+      end
+
+      module InstanceMethods
+      end
+    end
+  end
+end

data/lib/photon/delivers.rb

@@ -0,0 +1,38 @@
+module Photon
+  module Delivers
+    def acts_as_sender
+      class_eval do
+
+        has_many Photon.through
+        has_many Photon.using, :through => Photon.through
+
+        include Photon::Delivers::Core
+      end
+    end
+
+    def acts_as_deliverable
+      class_eval do
+        belongs_to Photon.to.to_s.singularize.to_sym
+        belongs_to Photon.using.to_s.singularize.to_sym
+        belongs_to Photon.thread.to_s.singularize.to_sym
+
+      end
+    end
+
+    def acts_as_message
+      class_eval do
+        has_many Photon.through
+        has_many Photon.to, :through => Photon.through
+        belongs_to :sender, :class_name => Photon.to.to_s.singularize.classify
+
+        include Photon::Delivers::Message
+      end
+    end
+    
+    def acts_as_threadable
+      class_eval do
+        has_many Photon.through
+      end
+    end
+  end
+end

data/lib/photon/delivery_helpers.rb

@@ -0,0 +1,5 @@
+module Photon
+  module DeliveryHelpers
+
+  end
+end

data/lib/photon/version.rb

@@ -1,3 +1,3 @@
 module Photon
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/photon.rb

@@ -1,3 +1,31 @@
 module Photon
-  # Your code goes here...
+  require "active_record"
+  require "action_view"
+
+  require 'photon/delivers'
+  require 'photon/delivery_helpers'
+  require 'photon/delivers/message'
+  require 'photon/delivers/core'
+
+  mattr_accessor :using
+  @@using = :messages
+  
+  mattr_accessor :through
+  @@through = :deliveries
+
+  mattr_accessor :to
+  @@to = :users
+
+  mattr_accessor :thread
+  @@thread = :message_threads
+
+  if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.extend Photon::Delivers
+  end
+
+  if defined?(ActionView::Base)
+    ActionView::Base.send :include, Photon::DeliveryHelpers
+  end
+
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: photon
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Gerred Dillon
@@ -31,8 +31,13 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README
 - Rakefile
 - lib/photon.rb
+- lib/photon/delivers.rb
+- lib/photon/delivers/core.rb
+- lib/photon/delivers/message.rb
+- lib/photon/delivery_helpers.rb
 - lib/photon/version.rb
 - photon.gemspec
 has_rdoc: true