acts_as_chattable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd602c446ee80af094e8606a6f9195f128f2a174
+  data.tar.gz: a642a418bf4d939034a5aeeaa946d03d51b1876f
+SHA512:
+  metadata.gz: aca9ec1fd084ae06607fea02c19731509ac00b6767666a161e14a6ca4f04aa7c38bddd82ed59bb2080a85689407ffafb1eb48a4be6127987c975448a49c1d96b
+  data.tar.gz: fb7be8257ac061d105b83590e74095ffd11a32ffc6aa108da206076ccfb6f21b43397100316e13d4f3fd23dbcef717eeba3d86e57762af40f90dc91e48dbbca9

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--fail-fast
+--profile
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+acts_as_chattable

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "activerecord", ">= 3.0.0"
+gem "activesupport", ">= 3.0.0"
+gem "dragonfly", ">= 0.9.15"
+gem "railties", ">= 3.0.0"
+
+group :development do
+  gem "rspec", "~> 2.0"
+  gem "jeweler", "~> 1.8.0"
+  gem "sqlite3"
+  gem "coveralls", :require => false
+end

data/Gemfile.lock

@@ -0,0 +1,122 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    arel (4.0.0)
+    atomic (1.1.10)
+    builder (3.1.4)
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.4)
+    dragonfly (0.9.15)
+      multi_json (~> 1.0)
+      rack
+    erubis (2.7.0)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.4)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mime-types (1.23)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.0.0)
+  activesupport (>= 3.0.0)
+  coveralls
+  dragonfly (>= 0.9.15)
+  jeweler (~> 1.8.0)
+  railties (>= 3.0.0)
+  rspec (~> 2.0)
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Piotr Niełacny Inc.
+
+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,327 @@
+ActsAsChattable
+=================
+
+The Acts As Chattable allows communication between the models.
+
+[![Build Status](https://secure.travis-ci.org/LTe/acts-as-messageable.png)](http://travis-ci.org/LTe/acts-as-messageable)
+[![Dependency Status](https://gemnasium.com/LTe/acts-as-messageable.png)](https://gemnasium.com/LTe/acts-as-messageable)
+[![Code Climate](https://codeclimate.com/github/LTe/acts-as-messageable.png)](https://codeclimate.com/github/LTe/acts-as-messageable)
+[![Coverage Status](https://coveralls.io/repos/LTe/acts-as-messageable/badge.png?branch=master)](https://coveralls.io/r/LTe/acts-as-messageable?branch=master)
+[![Gem Version](https://badge.fury.io/rb/acts-as-messageable.png)](http://badge.fury.io/rb/acts-as-messageable)
+
+Usage
+=====
+
+To use it, add it to your Gemfile:
+
+### Rails 3 & 4
+
+```ruby
+gem 'acts_as_chattable'
+```
+
+Post instalation
+================
+
+```
+rails g acts_as_chattable:migration
+rake db:migrate
+```
+
+Usage
+=====
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_messageable :required   => :body                  # default [:body]
+                      :dependent  => :destroy               # default :nullify
+end
+```
+
+Send message
+============
+
+```ruby
+@alice = User.first
+@bob   = User.last
+
+@alice.send_message(@bob, "Message topic", "Hi bob!")
+@bob.send_message(@alice, "Re: Message topic", "Hi alice!")
+```
+
+## With hash
+
+```ruby
+@alice.send_message(@bob, { :body => "Hash body", :topic => "Hash topic" })
+```
+
+Custom required (validation)
+============================
+
+In User model
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_messageable :required => :body
+end
+```
+
+## With hash
+
+```ruby
+@alice.send_message(@bob, { :body => "Hash body" })
+```
+
+## Normal
+
+```ruby
+@alice.send_message(@bob, "body")
+```
+
+## Required sequence
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_messageable :required => [:body, :topic]
+end
+
+@alice.send_message(@bob, "body", "topic")
+```
+
+## First topic
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_messageable :required => [:topic, :body]
+end
+
+@alice.send_message(@bob, "topic", "body")
+```
+
+Custom class
+============
+
+You can use your own class that will represent the message object. First of all create custom class
+
+```ruby
+class CustomMessage < ActsAsMessageable::Message
+  def capitalize_title
+    title.capitalize
+  end
+end
+```
+
+After that you can sepcify custom class in options.
+
+```ruby
+class User
+  acts_as_messageable :class_name => "CustomMessage"
+end
+```
+
+From now on, your message has custom class.
+
+```ruby
+@message = @alice.send_message(@bob, "hi!")
+@message # => #<CustomMessage:0x000000024b6278>
+@message.capitalize_title # => "Hi!"
+```
+
+Conversation
+============
+
+You can get conversation list from messages scope. For example:
+
+```ruby
+@message = @alice.send_message(@bob, "Hello bob!", "How are you?")
+@reply_message = @bob.reply_to(@message, "Re: Hello bob!", "I'm fine!")
+
+@alice.received_messages.conversations # => [@reply_message]
+```
+
+should receive list of latest messages in conversations (like in facebook).
+
+To create conversation just reply to a message.
+
+```ruby
+@message = @alice.send_message(@bob, "Hello bob!", "How are you?")
+@message.reply("Re: Hello bob!", "I'm fine")
+```
+
+**Or with hash**
+
+```ruby
+@message.reply(:topic => "Re: Hello bob!", :body => "I'm fine")
+```
+
+**Or in old style**
+
+```ruby
+@message = @alice.send_message(@bob, "Hello bob!", "How are you?")
+@reply_message = @bob.reply_to(@message, "Re: Hello bob!", "I'm fine!")
+```
+
+## Get conversation for a specific message
+
+```ruby
+@message.conversation       #=> [@message, @reply_message]
+@reply_message.conversation #=> [@message, @reply_message]
+```
+
+Search
+======
+
+You can search text from messages and get the records where match exist. For example:
+
+### Search text from messages
+
+```ruby
+records = @alice.messages.search("Search me")  @alice seach text "Search me" from all messages
+```
+
+### Inbox
+```ruby
+@alice.received_messages
+```
+
+### Outbox
+```ruby
+@alice.sent_messages
+```
+### Inbox + Outbox. All messages connected with __@alice__
+```ruby
+@alice.messages
+```
+
+### Trash
+```ruby
+@alice.deleted_messages
+```
+
+## Filters
+==========
+
+```ruby
+@alice.messages.are_from(@bob) # all message form @bob
+@alice.messages.are_to(@bob) # all message to @bob
+@alice.messages.with_id(@id_of_message) # message with id id_of_message
+@alice.messages.readed # all readed @alice  messages
+@alice.messages.unreaded # all unreaded @alice messages
+```
+
+
+**You can use multiple filters at the same time**
+
+```ruby
+@alice.messages.are_from(@bob).are_to(@alice).readed # all message from @bob to @alice and readed
+@alice.deleted_messages.are_from(@bob) # all deleted messages from @bob
+```
+
+Read messages
+=============
+
+### Read message
+
+```ruby
+@message.open # open message
+@message.read
+@message.mark_as_read
+```
+
+### Unread message
+
+```ruby
+@message.close # unread message
+@message.mark_as_unread
+```
+
+
+Delete message
+==============
+
+**__We must know who delete message. That why we use *.process* method to save context__**
+
+```ruby
+@message = @alice.send_message(@bob, "Topic", "Body")
+
+@alice.messages.process do |message|
+  message.delete # @alice delete message
+end
+```
+
+Now we can find message in **trash**
+
+```ruby
+@alice.deleted_messages #=> [@message]
+```
+
+We can delete the message **permanently**
+
+```ruby
+@alice.deleted_messages.process do |message|
+  message.delete
+end
+
+@alice.delete_message #=> []
+```
+
+Message has been deleted **permanently**
+
+## Delete message without context
+
+```ruby
+@alice.delete_message(@message) # @alice delete @message
+```
+
+Restore message
+===============
+
+```ruby
+@alice.deleted_messages.process do |m|
+  m.restore # @alice restore 'm' message from trash
+end
+```
+
+## Restore message without context
+
+```ruby
+@alice.restore_message(@message) # @alice restore message from trash
+```
+
+Group message
+=============
+
+## Enable group messages
+
+```ruby
+class User
+  acts_as_messageable :group_messages => true
+end
+```
+
+## How to join other users's conversation
+
+```ruby
+@message =  @alice.send_message(@bob, :topic => "Helou bob!", :body => "What's up?")
+@reply_message = @sukhi.reply_to(@message, "Hi there!", "I would like to join to this conversation!")
+@sec_reply_message = @bob.reply_to(@message, "Hi!", "Fine!")
+@third_reply_message = @alice.reply_to(@reply_message, "hi!", "no problem")
+```
+
+## Know the people involved in conversation
+
+```ruby
+@message.people # will give you participants users object
+@message.people # => [@alice, @bob, @sukhi]
+```
+
+Search
+======
+
+## Search text from messages
+
+```ruby
+@alice.messages.search("Search me")  @alice seach text "Search me" from all messages
+```
+
+Copyright © 2011-2012 Piotr Niełacny (http://ruby-blog.pl), released under the MIT license