facteur 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
data/README.markdown CHANGED
@@ -18,7 +18,7 @@ First install the messaging system in your application :
18
18
 
19
19
  rails generate facteur:install
20
20
 
21
- This commands create two new models called __mailbox__ and __message__ in *'app/models'* (in the future the names will be changeable):
21
+ This commands creates two new models called __mailbox__ and __message__ in *'app/models'* (in the future the names will be changeable):
22
22
 
23
23
  class Mailbox < ActiveRecord::Base
24
24
  include Facteur::MailboxModel
@@ -92,6 +92,29 @@ To list the messages sent by a user :
92
92
 
93
93
  @john.messages_sent
94
94
 
95
+ ### More methods ###
96
+
97
+ This section list the other methods available for each elements of the messaging system :
98
+
99
+ #### User ####
100
+
101
+ mailboxes : mailboxes assigned to this user
102
+ messages_sent : messages sent by the user
103
+
104
+ #### Mailbox ####
105
+
106
+ addressee : who the mailbox is assigned to
107
+ messages : messages who are stored in the mailbox
108
+ name : the name of the mailbox
109
+
110
+ #### Message ####
111
+
112
+ mailbox : mailbox where the message is stored
113
+ author : user who send the message
114
+ addressee : who the message was sent to
115
+ body : body of the message
116
+ created_at : date of creation
117
+
95
118
  ## Testing the gem ##
96
119
 
97
120
  It is possible to test facteur by running the following command from the gem directory:
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.2.0
1
+ 0.2.1
@@ -5,7 +5,7 @@ class CreateMailboxes < ActiveRecord::Migration
5
5
  t.text :contents
6
6
  t.integer :addressee_id
7
7
  t.string :addressee_type
8
- t.boolean :default
8
+ t.boolean :default, :default => false
9
9
  end
10
10
  end
11
11
 
@@ -10,6 +10,7 @@ class CreateMessages < ActiveRecord::Migration
10
10
  t.boolean :deleted_by_addressee, :default => false
11
11
  t.datetime :deleted_by_addressee_at
12
12
  t.boolean :read, :default => false
13
+ t.timestamps
13
14
  end
14
15
  end
15
16
 
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: facteur
3
3
  version: !ruby/object:Gem::Version
4
- hash: 23
4
+ hash: 21
5
5
  prerelease: false
6
6
  segments:
7
7
  - 0
8
8
  - 2
9
- - 0
10
- version: 0.2.0
9
+ - 1
10
+ version: 0.2.1
11
11
  platform: ruby
12
12
  authors:
13
13
  - Rawane ZOSSOU