activity_notification 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1233ff17443dc741c5c016057dc8c8f86e9c8ae0
-  data.tar.gz: e5a4f6930f8ecdd5789a49e082a8ac570bfb43a8
+  metadata.gz: f2a8ddee8ebe99622eaabfc2827b1163625f5eaa
+  data.tar.gz: d55b69c877f4cf2d04ad1fc3397314b71da72333
 SHA512:
-  metadata.gz: 99c10ba18583a79dff88da3b12ab4e491f96d1906b9ebf448e31ec3d0e3139abf20d46bef8994b112b0794c20c072f02013f3ebfaa5804c266c59fd8368f6df3
-  data.tar.gz: 7f885776939b37d430638fb7a6b84937b7c86dfbcae5c2060e84b5f36b98b557c5497c823567d9f220f052e04d9e82c4450fa6c444129c13c7f5a2636476b659
+  metadata.gz: 795e3e038b7e329b567018afc4b9ae2eb4d98fcb4283500092267fb6bbbdf34a5abf1f66823ed5677bd840856c519fa6e3b1b1bf9e41e2dd2d2dea1abbe478f2
+  data.tar.gz: 7f6d257a66540873366c4122632beceee21126598467c82243cd526953ea3050d4a054b9ba11f8c833c2c117f65d3400cef65af4b6b9831e717018cbc328120e

data/CHANGELOG.md

@@ -1,9 +1,20 @@
+## 1.4.2 / 2017-07-22
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v1.4.1...v1.4.2)
+
+Enhancements:
+
+* Add function to override the subject of notification email
+
+Bug Fixes:
+
+* Fix a bug which ActivityNotificaion.config.mailer configuration was ignored
+
 ## 1.4.1 / 2017-05-17
 [Full Changelog](http://github.com/simukappu/activity_notification/compare/v1.4.0...v1.4.1)
 
 Enhancements:
 
-* Remove dependency on *activerecord* from gem runtime dependency
+* Remove dependency on *activerecord* from gemspec
 
 ## 1.4.0 / 2017-05-10
 [Full Changelog](http://github.com/simukappu/activity_notification/compare/v1.3.0...v1.4.0)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activity_notification (1.4.1)
+    activity_notification (1.4.2)
       i18n (>= 0.5.0)
       jquery-rails (>= 3.1.1)
       railties (>= 4.2.0, < 5.2)
@@ -9,39 +9,39 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.1.1)
-      actionpack (= 5.1.1)
+    actioncable (5.1.2)
+      actionpack (= 5.1.2)
       nio4r (~> 2.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.1.1)
-      actionpack (= 5.1.1)
-      actionview (= 5.1.1)
-      activejob (= 5.1.1)
+    actionmailer (5.1.2)
+      actionpack (= 5.1.2)
+      actionview (= 5.1.2)
+      activejob (= 5.1.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.1.1)
-      actionview (= 5.1.1)
-      activesupport (= 5.1.1)
+    actionpack (5.1.2)
+      actionview (= 5.1.2)
+      activesupport (= 5.1.2)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.1.1)
-      activesupport (= 5.1.1)
+    actionview (5.1.2)
+      activesupport (= 5.1.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.1.1)
-      activesupport (= 5.1.1)
+    activejob (5.1.2)
+      activesupport (= 5.1.2)
       globalid (>= 0.3.6)
-    activemodel (5.1.1)
-      activesupport (= 5.1.1)
-    activerecord (5.1.1)
-      activemodel (= 5.1.1)
-      activesupport (= 5.1.1)
+    activemodel (5.1.2)
+      activesupport (= 5.1.2)
+    activerecord (5.1.2)
+      activemodel (= 5.1.2)
+      activesupport (= 5.1.2)
       arel (~> 8.0)
-    activesupport (5.1.1)
+    activesupport (5.1.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -51,18 +51,18 @@ GEM
       railties (>= 3.0)
       rspec-rails (>= 2.2)
     arel (8.0.0)
-    aws-sdk (2.9.19)
-      aws-sdk-resources (= 2.9.19)
-    aws-sdk-core (2.9.19)
+    aws-sdk (2.10.15)
+      aws-sdk-resources (= 2.10.15)
+    aws-sdk-core (2.10.15)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.9.19)
-      aws-sdk-core (= 2.9.19)
-    aws-sigv4 (1.0.0)
+    aws-sdk-resources (2.10.15)
+      aws-sdk-core (= 2.10.15)
+    aws-sigv4 (1.0.1)
     bcrypt (3.1.11)
-    bson (4.2.1)
+    bson (4.2.2)
     builder (3.2.3)
-    bullet (5.5.1)
+    bullet (5.6.0)
       activesupport (>= 3.0.0)
       uniform_notifier (~> 1.10.0)
     concurrent-ruby (1.0.5)
@@ -84,7 +84,7 @@ GEM
     dotenv-rails (2.2.1)
       dotenv (= 2.2.1)
       railties (>= 3.2, < 5.2)
-    erubi (1.6.0)
+    erubi (1.6.1)
     factory_girl (4.8.0)
       activesupport (>= 3.0.0)
     factory_girl_rails (4.8.0)
@@ -92,7 +92,7 @@ GEM
       railties (>= 3.0.0)
     globalid (0.4.0)
       activesupport (>= 4.2.0)
-    i18n (0.8.1)
+    i18n (0.8.6)
     jmespath (1.3.1)
     jquery-rails (4.3.1)
       rails-dom-testing (>= 1, < 3)
@@ -101,39 +101,39 @@ GEM
     json (2.1.0)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
-    mail (2.6.5)
+    mail (2.6.6)
       mime-types (>= 1.16, < 4)
     method_source (0.8.2)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
-    mini_portile2 (2.1.0)
-    minitest (5.10.2)
-    mongo (2.4.1)
+    mini_portile2 (2.2.0)
+    minitest (5.10.3)
+    mongo (2.4.2)
       bson (>= 4.2.1, < 5.0.0)
-    mongoid (6.1.0)
-      activemodel (~> 5.0)
+    mongoid (6.2.0)
+      activemodel (~> 5.1)
       mongo (>= 2.4.1, < 3.0.0)
-    mysql2 (0.4.6)
-    nio4r (2.0.0)
-    nokogiri (1.7.2)
-      mini_portile2 (~> 2.1.0)
+    mysql2 (0.4.8)
+    nio4r (2.1.0)
+    nokogiri (1.8.0)
+      mini_portile2 (~> 2.2.0)
     orm_adapter (0.5.0)
-    pg (0.20.0)
+    pg (0.21.0)
     rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (5.1.1)
-      actioncable (= 5.1.1)
-      actionmailer (= 5.1.1)
-      actionpack (= 5.1.1)
-      actionview (= 5.1.1)
-      activejob (= 5.1.1)
-      activemodel (= 5.1.1)
-      activerecord (= 5.1.1)
-      activesupport (= 5.1.1)
+    rails (5.1.2)
+      actioncable (= 5.1.2)
+      actionmailer (= 5.1.2)
+      actionpack (= 5.1.2)
+      actionview (= 5.1.2)
+      activejob (= 5.1.2)
+      activemodel (= 5.1.2)
+      activerecord (= 5.1.2)
+      activesupport (= 5.1.2)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 5.1.1)
+      railties (= 5.1.2)
       sprockets-rails (>= 2.0.0)
     rails-controller-testing (1.0.2)
       actionpack (~> 5.x, >= 5.0.1)
@@ -144,9 +144,9 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.1.1)
-      actionpack (= 5.1.1)
-      activesupport (= 5.1.1)
+    railties (5.1.2)
+      actionpack (= 5.1.2)
+      activesupport (= 5.1.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
@@ -175,8 +175,8 @@ GEM
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    slack-notifier (2.1.0)
+    simplecov-html (0.10.1)
+    slack-notifier (2.2.2)
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -189,8 +189,8 @@ GEM
       tins (~> 1.0)
     thor (0.19.4)
     thread_safe (0.3.6)
-    timecop (0.8.1)
-    tins (1.14.0)
+    timecop (0.9.1)
+    tins (1.15.0)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
     uniform_notifier (1.10.0)
@@ -216,8 +216,8 @@ DEPENDENCIES
   dotenv-rails
   factory_girl_rails (~> 4.8.0)
   mongoid (>= 4.0.0)
-  mysql2 (~> 0.4.6)
-  pg (~> 0.20.0)
+  mysql2 (~> 0.4.8)
+  pg (~> 0.21.0)
   rails (~> 5.1)
   rails-controller-testing
   rspec-rails (~> 3.6.0)

data/README.md

@@ -10,7 +10,7 @@
 
 *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.
 
-*activity_notification* supports Rails 4.2+ with ActiveRecord and [Mongoid](http://mongoid.org) ORM. It is tested for MySQL, PostgreSQL, SQLite with ActiveRecord and MongoDB with Mongoid.
+*activity_notification* supports Rails 4.2+ with ActiveRecord and [Mongoid](http://mongoid.org) ORM. It is tested for MySQL, PostgreSQL, SQLite3 with ActiveRecord and MongoDB with Mongoid.
 
 
 ## About
@@ -49,11 +49,12 @@
 - [Setup](#setup)
   - [Gem installation](#gem-installation)
   - [Database setup](#database-setup)
-    - [Using ActiveRecord ORM](#using_activerecord_orm)
-    - [Using Mongoid ORM](#using_mongoid_orm)
+    - [Using ActiveRecord ORM](#using-activerecord-orm)
+    - [Using Mongoid ORM](#using-mongoid-orm)
   - [Configuring models](#configuring-models)
-    - [Configuring target model](#configuring-target-model)
-    - [Configuring notifiable model](#configuring-notifiable-model)
+    - [Configuring target models](#configuring-target-models)
+    - [Configuring notifiable models](#configuring-notifiable-models)
+      - [Advanced notifiable path](#advanced-notifiable-path)
   - [Configuring views](#configuring-views)
   - [Configuring routes](#configuring-routes)
   - [Creating notifications](#creating-notifications)
@@ -64,7 +65,7 @@
     - [Rendering notifications](#rendering-notifications)
     - [Notification views](#notification-views)
     - [i18n for notifications](#i18n-for-notifications)
-  - [Customizing controllers (optional)](#customizing-controllers-optional-)
+  - [Customizing controllers (optional)](#customizing-controllers-optional)
 - [Functions](#functions)
   - [Email notification](#email-notification)
     - [Mailer setup](#mailer-setup)
@@ -91,6 +92,9 @@
   - [Testing gem alone](#testing-gem-alone)
 - [Documentation](#documentation)
 - **[Common examples](#common-examples)**
+- [Help](#help)
+- [Contributing](#contributing)
+- [License](#license)
 
 
 ## Setup
@@ -129,6 +133,19 @@ $ bin/rails generate activity_notification:migration
 $ bin/rake db:migrate
 ```
 
+If you are using a different table name from *"notifications"*, change the settings in your *config/initializers/activity_notification.rb* file, e.g., if you're using the table name *"activity_notifications"* instead of the default *"notifications"*:
+
+```ruby
+config.notification_table_name = "activity_notifications"
+```
+
+The same can be done for the subscription table name, e.g., if you're using the table name *"notifications_subscriptions"* instead of the default *"subscriptions"*:
+
+```ruby
+config.subscription_table_name = "notifications_subscriptions"
+```
+
+
 #### Using Mongoid ORM
 
 When you use *activity_notification* with [Mongoid](http://mongoid.org) ORM, set **AN_ORM** environment variable to **mongoid**:
@@ -147,12 +164,12 @@ You need to configure Mongoid in your Rails application for your MongoDB environ
 
 ### Configuring models
 
-#### Configuring target model
+#### Configuring target models
 
 Configure your target model (e.g. *app/models/user.rb*).
 Add **acts_as_target** configuration to your target model to get notifications.
 
-##### Target as ActiveRecord model
+##### Target as an ActiveRecord model
 
 ```ruby
 class User < ActiveRecord::Base
@@ -163,7 +180,7 @@ class User < ActiveRecord::Base
 end
 ```
 
-##### Target as  Mongoid model
+##### Target as a Mongoid model
 
 ```ruby
 require 'mongoid'
@@ -172,7 +189,7 @@ class User
   include Mongoid::Timestamps
   include GlobalID::Identification
 
-  # You need include ActivityNotification::Models except models which extends ActiveRecord::Base
+  # You need include ActivityNotification::Models except models which extend ActiveRecord::Base
   include ActivityNotification::Models
   acts_as_target
 end
@@ -180,13 +197,13 @@ end
 
 *Note*: *acts_as_notification_target* is an alias for *acts_as_target* and does the same.
 
-#### Configuring notifiable model
+#### Configuring notifiable models
 
 Configure your notifiable model (e.g. *app/models/comment.rb*).
 Add **acts_as_notifiable** configuration to your notifiable model representing activity to notify for each of your target model.
 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 is opened by the target user.
 
-##### Notifiable as ActiveRecord model
+##### Notifiable as an ActiveRecord model
 
 ```ruby
 class Article < ActiveRecord::Base
@@ -218,7 +235,7 @@ class Comment < ActiveRecord::Base
 end
 ```
 
-##### Notifiable as Mongoid model
+##### Notifiable as a Mongoid model
 
 ```ruby
 require 'mongoid'
@@ -240,7 +257,7 @@ class Comment
   include Mongoid::Timestamps
   include GlobalID::Identification
 
-  # You need include ActivityNotification::Models except models which extends ActiveRecord::Base
+  # You need include ActivityNotification::Models except models which extend ActiveRecord::Base
   include ActivityNotification::Models
   acts_as_notifiable :users,
     targets: ->(comment, key) {
@@ -254,6 +271,20 @@ class Comment
 end
 ```
 
+###### Advanced notifiable path
+
+Sometimes it might be necessary to provide extra information in the *notifiable_path*. In those cases, passing a lambda function to the *notifiable_path* will give you the notifiable object and the notifiable key to play around with:
+
+```ruby
+acts_as_notifiable :users,
+  targets: ->(comment, key) {
+    ([comment.article.user] + comment.article.commented_users.to_a - [comment.user]).uniq
+  },
+  notifiable_path: ->(comment, key) { "#{comment.article_notifiable_path}##{key}" }
+```
+
+This will attach the key of the notification to the notifiable path.
+
 ### Configuring views
 
 *activity_notification* provides view templates to customize your notification views. The view generator can generate default views for all targets.
@@ -746,13 +777,17 @@ class User < ActiveRecord::Base
 end
 ```
 
-If you do not have subscriptions table in you database, create migration for subscriptions and migrate the database in your Rails project:
+If you do not have a subscriptions table in you database, create a migration for subscriptions and migrate the database in your Rails project:
 
 ```console
 $ bin/rails generate activity_notification:migration CreateSubscriptions -t subscriptions
 $ bin/rake db:migrate
 ```
+If you are using a different table name than the default "subscriptions", change the settings in your config/initializers/activity_notification.rb file, e.g, if you use the table name "notifications_subscription" instead:
 
+```
+config.subscription_table_name = "notifications_subscriptions"
+```
 
 #### Managing subscriptions
 
@@ -1171,7 +1206,15 @@ To be prepared. See dummy Rails application in *spec/rails_app*.
 
 ## Help
 
-Contact us by email of this repository.
+We are welcome your Github issues for gem problems or enhancement requests. If you have any questions or problems for your own application environment, contact us by email of this repository.
+
+
+## Contributing
+
+We are welcome all of your pull requests! Please check out the followings:
+* Write tests with RSpec
+* Write code docs and README if necessary
+* Send your pull request to *development* branch (Do NOT send to *master* branch)
 
 
 ## License

data/activity_notification.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'jquery-rails', '>= 3.1.1'
 
   s.add_development_dependency 'sqlite3', '~> 1.3.13'
-  s.add_development_dependency 'mysql2', '~> 0.4.6'
-  s.add_development_dependency 'pg', '~> 0.20.0'
+  s.add_development_dependency 'mysql2', '~> 0.4.8'
+  s.add_development_dependency 'pg', '~> 0.21.0'
   s.add_development_dependency 'mongoid', '>= 4.0.0'
   s.add_development_dependency 'rspec-rails', '~> 3.6.0'
   s.add_development_dependency 'factory_girl_rails', '~> 4.8.0'

data/app/controllers/activity_notification/notifications_with_devise_controller.rb

@@ -1,6 +1,6 @@
 module ActivityNotification
   # Controller to manage notifications with Devise authentication.
   class NotificationsWithDeviseController < NotificationsController
-    include DeviceAuthenticationController
+    include DeviseAuthenticationController
   end
 end