activity_notification 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a5bab367f956293fdbc2bab7e9b2ad767d2c582
-  data.tar.gz: bd432e9c7d6800f63d79f681584db7ca0bf619af
+  metadata.gz: 081985f450efdee936e92d5ad47423335fb56e64
+  data.tar.gz: 38ed7ad55624f099aabf907bebc63f32b9c46791
 SHA512:
-  metadata.gz: 7d70c2d58b4ff931e361db55bbd34194cd365e28e7fed65b4bab413de5cae2670f8cc56e8beb24a89af88afbaec34f3143884e9717e77ec019404a63f54b332b
-  data.tar.gz: b4b5f443a364f3d0e90d3f67cae2b5d0befe222bca969e3085ebcc5ec91d8840ef4df6b6b94b6638c31c5d282b38f9f8228aa2729ddd8bf18bfbbe15cd9ae4cc
+  metadata.gz: dbe7d56c0527df73da45b7dc006c3efd3d2871ffe0df7e50b0729ff82a6498f439ee643e24547aa7079e8ec53cc4bce8f9d48cd60478dfc9f476c65200fe0d74
+  data.tar.gz: f945b80426ee27de55a182382f36319f69bff5ba72b2c44d1df34e5ad2f05d98143303e3a9ed282013121ec08c88daac54f951497278059414bf388b04c09c02

data/.gitignore

@@ -44,6 +44,8 @@ build-iPhoneSimulator/
 ## Environment normalization:
 /.bundle/
 /vendor/bundle
+/gemfiles/.bundle/
+/gemfiles/vendor/bundle
 /lib/bundler/man/
 
 # for a library or gem, you might want to ignore these files since the code is

data/.travis.yml

@@ -8,8 +8,13 @@ rvm:
 
 gemfile:
   - Gemfile
+  - gemfiles/Gemfile.rails-5.0
+  - gemfiles/Gemfile.rails-4.2
 
 matrix:
+  exclude:
+    - rvm: 2.1.9
+      gemfile: gemfiles/Gemfile.rails-5.0
   allow_failures:
     - rvm: ruby-head
   fast_finish: true

data/.yardopts

@@ -0,0 +1,3 @@
+--no-private
+--hide-api private
+--plugin activesupport-concern

data/Gemfile

@@ -2,7 +2,12 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rails', '~> 4.2.7'
+gem 'sqlite3'
+gem 'jquery-rails'
+
 group :test do
+  gem 'ammeter'
   gem 'timecop'
   gem 'coveralls', require: false
 end

data/Gemfile.lock

@@ -1,44 +1,44 @@
 PATH
   remote: .
   specs:
-    activity_notification (0.0.9)
-      activerecord (>= 3.0)
+    activity_notification (0.0.10)
+      activerecord (>= 4.2.0)
       i18n (>= 0.5.0)
-      rails (~> 4.2)
+      railties (>= 4.2.0, < 5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.7)
-      actionpack (= 4.2.7)
-      actionview (= 4.2.7)
-      activejob (= 4.2.7)
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.7)
-      actionview (= 4.2.7)
-      activesupport (= 4.2.7)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       rack (~> 1.6)
       rack-test (~> 0.6.2)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.7)
-      activesupport (= 4.2.7)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (4.2.7)
-      activesupport (= 4.2.7)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
       globalid (>= 0.3.0)
-    activemodel (4.2.7)
-      activesupport (= 4.2.7)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
       builder (~> 3.1)
-    activerecord (4.2.7)
-      activemodel (= 4.2.7)
-      activesupport (= 4.2.7)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       arel (~> 6.0)
-    activesupport (4.2.7)
+    activesupport (4.2.7.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -52,12 +52,12 @@ GEM
     bcrypt (3.1.11)
     builder (3.2.2)
     concurrent-ruby (1.0.2)
-    coveralls (0.8.14)
+    coveralls (0.8.15)
       json (>= 1.8, < 3)
       simplecov (~> 0.12.0)
       term-ansicolor (~> 1.3)
       thor (~> 0.19.1)
-      tins (~> 1.6.0)
+      tins (>= 1.6.0, < 2)
     devise (4.2.0)
       bcrypt (~> 3.0)
       orm_adapter (~> 0.1)
@@ -72,10 +72,10 @@ GEM
     factory_girl_rails (4.7.0)
       factory_girl (~> 4.7.0)
       railties (>= 3.0.0)
-    globalid (0.3.6)
+    globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
-    jquery-rails (4.1.1)
+    jquery-rails (4.2.1)
       rails-dom-testing (>= 1, < 3)
       railties (>= 4.2.0)
       thor (>= 0.14, < 2.0)
@@ -97,16 +97,16 @@ GEM
     rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (4.2.7)
-      actionmailer (= 4.2.7)
-      actionpack (= 4.2.7)
-      actionview (= 4.2.7)
-      activejob (= 4.2.7)
-      activemodel (= 4.2.7)
-      activerecord (= 4.2.7)
-      activesupport (= 4.2.7)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.7)
+      railties (= 4.2.7.1)
       sprockets-rails
     rails-deprecated_sanitizer (1.0.3)
       activesupport (>= 4.2.0.alpha)
@@ -116,15 +116,15 @@ GEM
       rails-deprecated_sanitizer (>= 1.0.1)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (4.2.7)
-      actionpack (= 4.2.7)
-      activesupport (= 4.2.7)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (11.2.2)
-    responders (2.2.0)
+    responders (2.3.0)
       railties (>= 4.2.0, < 5.1)
-    rspec-core (3.5.1)
+    rspec-core (3.5.2)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -132,7 +132,7 @@ GEM
     rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
-    rspec-rails (3.5.1)
+    rspec-rails (3.5.2)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
@@ -146,7 +146,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    sprockets (3.6.3)
+    sprockets (3.7.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.1.1)
@@ -159,26 +159,32 @@ GEM
     thor (0.19.1)
     thread_safe (0.3.5)
     timecop (0.8.1)
-    tins (1.6.0)
+    tins (1.12.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     warden (1.2.6)
       rack (>= 1.0)
+    yard (0.9.5)
+    yard-activesupport-concern (0.0.1)
+      yard (>= 0.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activity_notification!
-  ammeter (~> 1.1.3)
+  ammeter
   coveralls
   devise (~> 4.2.0)
   factory_girl_rails (~> 4.7.0)
-  jquery-rails (~> 4.1.1)
+  jquery-rails
+  rails (~> 4.2.7)
   rspec-rails (~> 3.5.1)
   simplecov (~> 0.12.0)
-  sqlite3 (~> 1.3.11)
+  sqlite3
   timecop
+  yard (~> 0.9.5)
+  yard-activesupport-concern (~> 0.0.1)
 
 BUNDLED WITH
    1.12.5

data/README.md

@@ -4,11 +4,12 @@
 [![Coverage Status](https://coveralls.io/repos/github/simukappu/activity_notification/badge.svg?branch=master)](https://coveralls.io/github/simukappu/activity_notification?branch=master)
 [![Code Climate](https://codeclimate.com/github/simukappu/activity_notification/badges/gpa.svg)](https://codeclimate.com/github/simukappu/activity_notification)
 [![Gem Version](https://badge.fury.io/rb/activity_notification.svg)](https://badge.fury.io/rb/activity_notification)
+[![Inline docs](http://inch-ci.org/github/simukappu/activity_notification.svg?branch=master)](http://inch-ci.org/github/simukappu/activity_notification)
 [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](MIT-LICENSE)
 
 `activity_notification` provides integrated user activity notifications for Ruby on Rails. You can easily use it to configure multiple notification targets and make activity notifications with notifiable models, like adding comments, responding etc.
 
-Currently, `activity_notification` is only supported with ActiveRecord ORM in Rails 4.
+`activity_notification` supports Rails 5.0 and 4.2+. Currently, it is only supported with ActiveRecord ORM.
 
 
 ## Table of contents
@@ -29,11 +30,13 @@ Currently, `activity_notification` is only supported with ActiveRecord ORM in Ra
     2. [Rendering notifications](#rendering-notifications)
     3. [Notification views](#notification-views)
     4. [i18n for notifications](#i18n-for-notifications)
-    5. [Grouping notifications](#grouping-notifications)
-  9. [Configuring email notification](#configuring-email-notification)
+3. [Functions](#functions)
+  1. [Email notification](#email-notification)
     1. [Setup mailer](#setup-mailer)
     2. [Email templates](#email-templates)
     3. [i18n for email](#i18n-for-email)
+  2. [Grouping notifications](#grouping-notifications)
+  3. [Integration with Devise](#integration-with-devise)
 4. [Testing](#testing)
 5. [Documentation](#documentation)
 6. **[Common examples](#common-examples)**
@@ -44,7 +47,7 @@ Currently, `activity_notification` is only supported with ActiveRecord ORM in Ra
 * Notification API (creating notifications, query for notifications and managing notification parameters)
 * Notification controllers (managing open/unopen of notifications, link to notifiable activity page)
 * Notification views (presentation of notifications)
-* Notification grouping (grouping like `"Tom and other 7 people posted comments to this article"`)
+* Grouping notifications (grouping like `"Tom and other 7 people posted comments to this article"`)
 * Email notification
 * Integration with [Devise](https://github.com/plataformatec/devise) authentication
 
@@ -89,25 +92,25 @@ $ rake db:migrate
 #### Configuring target model
 
 Configure your target model (e.g. app/models/user.rb).
-Add `acts_as_notification_target` configuration to your target model to get notifications.
+Add `acts_as_target` configuration to your target model to get notifications.
 
 ```ruby
 class User < ActiveRecord::Base
-  # Example using confirmed_at of Device field
-  # to decide whether activity_notification sends notification email to this user
-  acts_as_notification_target email: :email, email_allowed: :confirmed_at
+  # acts_as_target configures your model as ActivityNotification::Target
+  # with parameters as value or custom methods defined in your model as lambda or symbol
+
+  # This is an example without any options (default configuration) as the target
+  acts_as_target
 end
 ```
 
-*Note*: `acts_as_target` is an alias for `acts_as_notification_target` and does the same.
-
-You can override several methods in your target model (e.g. `notification_index` or `notification_email_allowed?`).
+*Note*: `acts_as_notification_target` is an alias for `acts_as_target` and does the same.
 
 #### Configuring notifiable model
 
 Configure your notifiable model (e.g. app/models/comment.rb).
 Add `acts_as_notifiable` configuration to your notifiable model representing activity to notify.
-You have to define notification targets for all notifications from this notifiable model by `:targets` option. Other configurations are options.
+You have to define notification targets for all notifications from this notifiable model by `:targets` option. Other configurations are options. `:notifiable_path` option is a path to move when the notification will be opened by the target user.
 
 ```ruby
 class Article < ActiveRecord::Base
@@ -120,26 +123,27 @@ class Comment < ActiveRecord::Base
   belongs_to :article
   belongs_to :user
 
-  # Example that ActivityNotification::Notifiable is configured with custom methods in your model as lambda or symbol
+  # acts_as_notifiable configures your model as ActivityNotification::Notifiable
+  # with parameters as value or custom methods defined in your model as lambda or symbol
   acts_as_notifiable :users,
-    # Notify to users who commented to the same article and article auther, except comment owner self
-    targets: ->(comment, key) { (comment.article.commented_users.to_a - [comment.user] + [comment.article.user]).uniq },
-    group: :article,
-    notifier: :user,
-    email_allowed: true,
-    notifiable_path: :custom_notifiable_path
-
-  def custom_notifiable_path
+    # Notification targets as :targets is a necessary option
+    # Set to notify to author and users commented to the article, except comment owner self
+    targets: ->(comment, key) {
+      ([comment.article.user] + comment.article.commented_users.to_a - [comment.user]).uniq
+    },
+    # Path to move when the notification will be opened by the target user
+    # This is a optional since activity_notification uses polymorphic_path as default
+    notifiable_path: :article_notifiable_path
+
+  def article_notifiable_path
     article_path(article)
   end
 end
 ```
 
-You can override several methods in your notifiable model (e.g. `notifiable_path` or `notification_email_allowed?`).
-
 ### Configuring views
 
-`activity_notification` provides view templates to customize your notification views. The view generater can generate default views for all targets.
+`activity_notification` provides view templates to customize your notification views. The view generator can generate default views for all targets.
 
 ```console
 $ rails generate activity_notification:views
@@ -155,7 +159,7 @@ If you would like to generate only a few sets of views, like the ones for the `n
 you can pass a list of modules to the generator with the `-v` flag.
 
 ```console
-$ rails generate activity_notification:views -v mailer
+$ rails generate activity_notification:views -v notifications
 ```
 
 ### Configuring controllers
@@ -177,7 +181,15 @@ If the customization at the views level is not enough, you can customize each co
       # def index
       #   super
       # end
-      ...
+
+      # ...
+
+      # POST /:target_type/:target_id/notifcations/:id/open
+      # def open
+      #   super
+      # end
+
+      # ...
     end
     ```
 
@@ -194,11 +206,16 @@ If the customization at the views level is not enough, you can customize each co
     You can completely override a controller action
     ```ruby
     class Users::NotificationsController < ActivityNotification::NotificationsController
+      # ...
+
       # POST /:target_type/:target_id/notifcations/:id/open
       def open
-        # custom open-notification code
+        # Custom code to open notification here
+
+        # super
       end
-      ...
+
+      # ...
     end
     ```
 
@@ -207,15 +224,9 @@ If the customization at the views level is not enough, you can customize each co
 `activity_notification` also provides routing helper. Add notification routing to `config/routes.rb` for the target (e.g. `:users`):
 
 ```ruby
-# Simply
 Rails.application.routes.draw do
   notify_to :users
 end
-
-# Or integrated with devise
-Rails.application.routes.draw do
-  notify_to :users, with_devise: :users
-end
 ```
 
 ### Creating notifications
@@ -224,15 +235,17 @@ You can trigger notifications by setting all your required parameters and trigge
 on the notifiable model, like this:
 
 ```ruby
-@comment.notify :users key: 'comment.reply', group: @comment.article
+@comment.notify :users, key: "comment.reply"
 ```
 
 Or, you can call public API as `ActivityNotification::Notification.notify`
 
 ```ruby
-ActivityNotification::Notification.notify :users, @comment, group: @comment.article
+ActivityNotification::Notification.notify :users, @comment, key: "comment.reply"
 ```
 
+*Hint*: `:key` is a option. Default key `#{notifiable_type}.default` which means `comment.default` will be used without specified key.
+
 ### Displaying notifications
 
 #### Preparing target notifications
@@ -294,12 +307,6 @@ Then, content named :notification_index will be prepared and you can use it in y
 ...
 ```
 
-##### Layouts
-
-Under construction
-
-##### Locals
-
 Sometimes, it's desirable to pass additional local variables to partials. It can be done this way:
 
 ```erb
@@ -310,7 +317,7 @@ Sometimes, it's desirable to pass additional local variables to partials. It can
 
 `activity_notification` looks for views in `app/views/activity_notification/notifications/:target`.
 
-For example, if you have an notification with `:key` set to `"notification.article.comment.replied"` and rendered it with `:target` set to `:users`, the gem will look for a partial in `app/views/activity_notification/notifications/users/article/comment/_replied.html.(|erb|haml|slim|something_else)`.
+For example, if you have an notification with `:key` set to `"notification.comment.reply"` and rendered it with `:target` set to `:users`, the gem will look for a partial in `app/views/activity_notification/notifications/users/comment/_reply.html.(|erb|haml|slim|something_else)`.
 
 *Hint*: the `"notification."` prefix in `:key` is completely optional and kept for backwards compatibility, you can skip it in new projects.
 
@@ -361,9 +368,79 @@ notification:
         text: '[Admin] Article has been created'
 ```
 
-This structure is valid for notifications with keys `"notification.article.comment.replied"` or `"article.comment.replied"`. As mentioned before, `"notification."` part of the key is optional. In addition for above example, `%{notifier_name}` and `%{article_title}` are used from parameter field in the notification record.
+This structure is valid for notifications with keys `"notification.comment.reply"` or `"comment.reply"`. As mentioned before, `"notification."` part of the key is optional. In addition for above example, `%{notifier_name}` and `%{article_title}` are used from parameter field in the notification record.
+
+
+## Functions
+
+### Email notification
+
+`activity_notification` provides email notification to the notification targets.
+
+#### Setup mailer
+
+First, you need to set up the default URL options for the `activity_notification` mailer in each environment. Here is a possible configuration for `config/environments/development.rb`:
+
+```ruby
+config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+```
+
+Email notification is disabled as default. You can configure to enable email notification in initializer `activity_notification.rb`.
+
+```ruby
+config.email_enabled = true
+config.mailer_sender = 'your_notification_sender@example.com'
+```
+
+You can also configure them for each model by acts_as roles like these.
+
+```ruby
+class User < ActiveRecord::Base
+  # Example using confirmed_at of devise field
+  # to decide whether activity_notification sends notification email to this user
+  acts_as_notification_target email: :email, email_allowed: :confirmed_at
+end
+```
+
+```ruby
+class Comment < ActiveRecord::Base
+  belongs_to :article
+  belongs_to :user
+
+  acts_as_notifiable :users,
+    targets: ->(comment, key) {
+      ([comment.article.user] + comment.article.commented_users.to_a - [comment.user]).uniq
+    },
+    # Allow notification email
+    email_allowed: true,
+    notifiable_path: :article_notifiable_path
+
+  def article_notifiable_path
+    article_path(article)
+  end
+end
+```
+
+#### Email templates
+
+`activity_notification` will look for email template in the same way as notification views. For example, if you have an notification with `:key` set to `"notification.comment.reply"` and target_type `users`, the gem will look for a partial in `app/views/activity_notification/mailer/users/comment/_reply.html.(|erb|haml|slim|something_else)`.
+
+If this template is missing, the gem will look for a partial in `default` as the target type which means `activity_notification/mailer/default/_default.html.(|erb|haml|slim|something_else)`.
+
+#### i18n for email
+
+The subject of notification email can be put in your locale `.yml` files as `mail_subject` field:
 
-#### Grouping notifications
+```yaml
+notification:
+  user:
+    comment:
+      reply:
+        text: "<p>%{notifier_name} and %{group_member_count} people replied for your comments</p>"
+        mail_subject: 'New comment to your article'
+```
+
+### Grouping notifications
 
 `activity_notification` provides the function for automatically grouping notifications. When you created a notification like this, all *unopened* notifications to the same target will be grouped by `article` set as `:group` options:
 
@@ -393,80 +470,164 @@ And you can render them in a view like this:
 
 This presentation will be shown to target users as `Tom and other 7 people posted comments to your article "Let's use Ruby"`.
 
-### Configuring email notification
+You can also use `%{group_member_count}` in i18n text as a field:
 
-#### Setup mailer
+```yaml
+notification:
+  user:
+    comment:
+      reply:
+        text: "<p>%{notifier_name} and %{group_member_count} people replied for your comments</p>"
+        mail_subject: 'New comment to your article'
+```
 
-First, you need to set up the default URL options for the `activity_notification` mailer in each environment. Here is a possible configuration for `config/environments/development.rb`:
+Then, you will see `Tom and 7 people replied for your comments"`.
+
+### Integration with Devise
+
+`activity_notification` supports to integrate with devise authentication.
+
+First, add notification routing as integrated with devise to `config/routes.rb` for the target:
 
 ```ruby
-config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+Rails.application.routes.draw do
+  devise_for :users
+  # Integrated with devise
+  notify_to :users, with_devise: :users
+end
 ```
 
-Email notification is disabled as default. You can configure to enable email notification in initializer `activity_notification.rb`.
+Then `activity_notification` will use `notifications_with_devise_controller` as a notification controller. The controller actions automatically call `authenticate_user!` and the user will be restricted to access and operate own notifications only, not others'.
+
+*Hint*: HTTP 403 Forbidden will be returned for unauthorized notifications.
+
+You can also use different model from Devise resource as a target. When you will add this to `config/routes.rb`:
 
 ```ruby
-config.email_enabled = true
-config.mailer_sender = 'your_notification_sender@example.com'
+Rails.application.routes.draw do
+  devise_for :users
+  # Integrated with devise for different model
+  notify_to :admins, with_devise: :users
+end
 ```
 
-You can also configure them for each model by acts_as roles like these.
+and add `devise_resource` option to `acts_as_target` in the target model:
 
 ```ruby
-class User < ActiveRecord::Base
-  acts_as_notification_target email: :email, email_allowed: true
+class Admin < ActiveRecord::Base
+  belongs_to :user
+  acts_as_target devise_resource: :user
 end
 ```
 
+`activity_notification` will authenticate `:admins` notifications with devise authentication for `:users`.
+In this example `activity_notification` will confirm the `user` who `admin` belongs to with authenticated user by devise.
+
+
+## Testing
+
+### Testing your application
+
+First, you need to configure ActivityNotification as described above.
+
+#### Testing notifications with RSpec
+Prepare target and notifiable model instances to test generating notifications (e.g. `@user` and `@comment`).
+Then, you can call notify API and test if notifications of the target are generated.
 ```ruby
-class Comment < ActiveRecord::Base
-  acts_as_notifiable :users,
-    targets: :custom_notification_users,
-    email_allowed: :custom_notification_email_allowed?
+# Prepare
+@article_author = create(:user)
+@comment = @article_author.articles.create.comments.create
+expect(@article_author.notifications.unopened_only.count).to eq(0)
 
-  def custom_notification_email_allowed?(target, key)
-    # You can add enabled conditions from target and key
-    true
-  end
-end
+# Call notify API
+@comment.notify :users
+
+# Test generated notifications
+expect(@article_author_user.notifications.unopened_only.count).to eq(1)
+expect(@article_author_user.notifications.unopened_only.latest.notifiable).to eq(@comment)
 ```
 
-#### Email templates
+#### Testing email notifications with RSpec
+Prepare target and notifiable model instances to test sending notification email.
+Then, you can call notify API and test if notification email is sent.
+```ruby
+# Prepare
+@article_author = create(:user)
+@comment = @article_author.articles.create.comments.create
+expect(ActivityNotification::Mailer.deliveries.size).to eq(0)
 
-`activity_notification` will look for email template in the same way as notification views. For example, if you have an notification with `:key` set to `"notification.article.comment.replied"` and target_type `users`, the gem will look for a partial in `app/views/activity_notification/mailer/users/article/comment/_replied.html.(|erb|haml|slim|something_else)`.
+# Call notify API and send email now
+@comment.notify :users, send_later: false
 
-If this template is missing, the gem will look for a partial in `default` as the target type which means `activity_notification/mailer/default/_default.html.(|erb|haml|slim|something_else)`.
-
-#### i18n for email
+# Test sent notification email
+expect(ActivityNotification::Mailer.deliveries.size).to eq(1)
+expect(ActivityNotification::Mailer.deliveries.first.to[0]).to eq(@article_author.email)
+```
+Note that notification email will be sent asynchronously without false as `send_later` option.
+```ruby
+# Prepare
+include ActiveJob::TestHelper
+@article_author = create(:user)
+@comment = @article_author.articles.create.comments.create
+expect(ActivityNotification::Mailer.deliveries.size).to eq(0)
+
+# Call notify API and send email asynchronously as default
+# Test sent notification email with ActiveJob queue
+expect {
+  perform_enqueued_jobs do
+    @comment.notify :users
+  end
+}.to change { ActivityNotification::Mailer.deliveries.size }.by(1)
+expect(ActivityNotification::Mailer.deliveries.first.to[0]).to eq(@article_author.email)
+```
 
-The subject of notification email can be put in your locale `.yml` files as `mail_subject` field:
+### Testing gem alone
 
-```yaml
-notification:
-  user:
-    article:
-      comment:
-        reply:
-          text "<p>%{notifier_name} and %{group_member_count} people replied for your comments</p>"
-          mail_subject: 'New comment to your article'
+#### Testing with RSpec
+Pull git repository and execute RSpec.
+```console
+$ git pull https://github.com/simukappu/activity_notification.git
+$ cd activity_notification
+$ bundle install —path vendor/bundle
+$ bundle exec rspec
 ```
 
-## Testing
+#### Dummy Rails application
+Test module includes dummy Rails application. You can run the dummy application as common Rails application.
+```console
+$ cd spec/rails_app
+$ bin/rake db:migrate
+$ bin/rake db:seed
+$ bin/rails server
+```
+Then, you can access <http://localhost:3000> for the dummy application.
 
-Under construction
 
 ## Documentation
 
-Under construction
+See [API Reference](http://www.rubydoc.info/github/simukappu/activity_notification/index) for more details.
+
+RubyDoc.info does not support parsing methods in `included` and `class_methods` of `ActiveSupport::Concern` currently.
+To read complete documents, please generate YARD documents on your local environment:
+```console
+$ git pull https://github.com/simukappu/activity_notification.git
+$ cd activity_notification
+$ bundle install —path vendor/bundle
+$ bundle exec yard doc
+$ bundle exec yard server
+```
+Then you can see the documents at <http://localhost:8808/docs/index>.
 
 ## Common examples
 
 Under construction
 
+
 ## Help
 
 Under construction
 
+
 ## License
 
 `activity_notification` project rocks and uses [MIT License](MIT-LICENSE).