activity_notification 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eafbddc7c4427310930baf3d6f23464f4d0c2baa
-  data.tar.gz: 38dce4c34e4e22e06be7132d588906500127c017
+  metadata.gz: 7bdfeb236b9f987b0c7c7cc6aa515349245c1102
+  data.tar.gz: cf9f3952dcd6d7ff380d8c5ac7ab043dbde361e4
 SHA512:
-  metadata.gz: 4da1eff72e8906c9398bb43f9273ca1c788ce91debeccfc4ec9d371fa6032b11c12fb60594c5191e37717f88df4b1d020b82506357c469c9f1894ba0930ac992
-  data.tar.gz: 08ce06b4beaf320607e276d7dabd9486c58b7f979aa29ee522da90a7c9972eda2bc8148cadad1b90c66dd46bbead0fa819a0bff43a5fd17b9c8b9a1db5e4c113
+  metadata.gz: bfe83748a25c77b316798ac7bf0f939f8fc6e11543ecb48c155fbd2cba4d4044bbe01edc0337f6f186c7f50c707e72d60e3b890744872d81d030cff49b553c51
+  data.tar.gz: 42503e4939f33dc2dc2d45cbefd2895c284f695a640100451e588222f8679ea85318793fc16e909ff62727774ae14dbd7fdad0da35bc646c29f18d4541734a6d

data/CHANGELOG.md

@@ -0,0 +1,75 @@
+## 1.0.2 / 2016-11-14
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v1.0.1...v1.0.2)
+
+Bug Fixes:
+
+* Fix migration and notification generator's path
+
+## 1.0.1 / 2016-11-05
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v1.0.0...v1.0.1)
+
+Enhancements:
+
+* Add function to send batch email notification
+  * Batch mailer API
+  * Default batch notification email templates
+  * Target role configuration for batch email notification
+* Improve target API
+  * Add `:reverse`, `:with_group_members`, `:as_latest_group_member` and `:custom_filter` options to API loading notification index
+  * Add methods to get notifications for specified target type grouped by targets like `notification_index_map`
+* Arrange default notification email view templates
+
+## 1.0.0 / 2016-10-06
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v0.0.10...v1.0.0)
+
+Enhancements:
+
+* Improve notification API
+  * Add methods to count distinct group members or notifiers like `group_member_notifier_count`
+  * Update `send_later` argument of `send_notification_email` method to options hash argument
+* Improve target API
+  * Update `notification_index` API to automatically load opened notifications with unopend notifications
+* Improve acts_as roles
+  * Add `acts_as_group` role
+  * Add `printable_name` configuration for all roles
+  * Add `:dependent_notifications` option to `acts_as_notifiable` to make handle notifications with deleted notifiables
+* Arrange default notification view templates
+* Arrange bundled test application
+* Make default rails version 5.0 and update gem dependency
+
+Breaking Changes:
+* Rename `opened_limit` configuration parameter to `opened_index_limit`
+  * http://github.com/simukappu/activity_notification/commit/591e53cd8977220f819c11cd702503fc72dd1fd1
+
+## 0.0.10 / 2016-09-11
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v0.0.9...v0.0.10)
+
+Enhancements:
+
+* Improve controller action and notification API
+  * Add filter options to `open_all` action and `open_all_of` method
+* Add source documentation with YARD
+* Support rails 5.0 and update gem dependency
+
+Bug Fixes:
+
+* Fix `Notification#notifiable_path` method to be called with key
+* Add including `PolymorphicHelpers` statement to `seed.rb` in test application to resolve String extention
+
+## 0.0.9 / 2016-08-19
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v0.0.8...v0.0.9)
+
+Enhancements:
+
+* Improve acts_as roles
+  * Enable models to be configured by acts_as role without including statement
+  * Disable email notification as default and add email configurations to acts_as roles
+  * Remove `:skip_email` option from `acts_as_target`
+* Update `Renderable#text` method to use `#{key}.text` field in i18n properties
+  
+Bug Fixes:
+
+* Fix wrong method name of `Notification#notifiable_path`
+
+## 0.0.8 / 2016-07-31
+* First release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activity_notification (1.0.1)
+    activity_notification (1.0.2)
       activerecord (>= 4.2.0)
       i18n (>= 0.5.0)
       jquery-rails (>= 3.1.1)

data/README.md

@@ -57,8 +57,9 @@
     2. [Email templates](#email-templates)
     3. [i18n for email](#i18n-for-email)
   2. [Batch email notification](#batch-email-notification)
-    1. [Batch email templates](#batch-email-templates)
-    2. [i18n for batch email](#i18n-for-batch-email)
+    1. [Setup mailer](#setup-mailer)
+    2. [Batch email templates](#batch-email-templates)
+    3. [i18n for batch email](#i18n-for-batch-email)
   3. [Grouping notifications](#grouping-notifications)
   4. [Integration with Devise](#integration-with-devise)
 4. [Testing](#testing)
@@ -462,9 +463,30 @@ notification:
 
 ### Batch email notification
 
-`activity_notification` provides batch email notification to the notification targets. You can send notification daily or hourly with scheduler like `whenever`.
+`activity_notification` provides batch email notification to the notification targets. You can send notification email daily, hourly or weekly and so on with a scheduler like `whenever`.
+
+#### Setup mailer
+
+First, you need to set up the default URL options for the `activity_notification` mailer in each environment.
+
+Batch email notification is disabled as default. You can configure to enable email notification in initializer `activity_notification.rb` like single email notification.
+
+```ruby
+config.email_enabled = true
+config.mailer_sender = 'your_notification_sender@example.com'
+```
+
+You can also configure them for each target model by `acts_as_notification_target` role like this.
+
+```ruby
+class User < ActiveRecord::Base
+  # Example using confirmed_at of devise field
+  # to decide whether activity_notification sends batch notification email to this user
+  acts_as_notification_target email: :email, batch_email_allowed: :confirmed_at
+end
+```
 
-You can automatically send batch notification email for unopened notifications only to the all specified targets with `batch_key`.
+Then, you can automatically send batch notification email for unopened notifications only to the all specified targets with `batch_key`.
 
 ```ruby
 # Send batch notification email to the users with unopened notifications

data/app/mailers/activity_notification/mailer.rb

@@ -8,7 +8,7 @@ if defined?(ActionMailer)
     # @param [Notification] notification Notification instance to send email
     # @param [Hash]         options      Options for notification email
     # @option options [String, Symbol] :fallback (:default) Fallback template to use when MissingTemplate is raised
-    # @return [Mail::Message|ActionMailer::DeliveryJob] Email message or its delivery job, return NilClass for wrong target
+    # @return [Mail::Message|ActionMailer::DeliveryJob] Email message or its delivery job
     def send_notification_email(notification, options = {})
       options[:fallback] ||= :default
       if options[:fallback] == :none
@@ -22,9 +22,9 @@ if defined?(ActionMailer)
     # @param [Object]              target        Target of batch notification email
     # @param [Array<Notification>] notifications Target notifications to send batch notification email
     # @param [Hash]                options       Options for notification email
-    # @option options [String, Symbol] :fallback    (:batch_default) Fallback template to use when MissingTemplate is raised
-    # @option options [String]         :batch_key   (nil)            Key of the batch notification email, a key of the first notification will be used if not specified
-    # @return [Mail::Message|ActionMailer::DeliveryJob] Email message or its delivery job, return NilClass for wrong target
+    # @option options [String, Symbol] :fallback  (:batch_default) Fallback template to use when MissingTemplate is raised
+    # @option options [String]         :batch_key (nil)            Key of the batch notification email, a key of the first notification will be used if not specified
+    # @return [Mail::Message|ActionMailer::DeliveryJob] Email message or its delivery job
     def send_batch_notification_email(target, notifications, options = {})
       options[:fallback] ||= :batch_default
       if options[:fallback] == :none

data/gemfiles/Gemfile.rails-4.2.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    activity_notification (1.0.0)
+    activity_notification (1.0.2)
       activerecord (>= 4.2.0)
       i18n (>= 0.5.0)
       jquery-rails (>= 3.1.1)
@@ -154,7 +154,7 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.11)
+    sqlite3 (1.3.12)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)
@@ -181,7 +181,7 @@ DEPENDENCIES
   rails (~> 4.2.0)
   rspec-rails (~> 3.5.1)
   simplecov (~> 0.12.0)
-  sqlite3 (~> 1.3.11)
+  sqlite3 (~> 1.3.12)
   timecop
   yard (~> 0.9.5)
   yard-activesupport-concern (~> 0.0.1)

data/gemfiles/Gemfile.rails-5.0.lock

@@ -1,9 +1,10 @@
 PATH
   remote: ../
   specs:
-    activity_notification (0.0.9)
+    activity_notification (1.0.2)
       activerecord (>= 4.2.0)
       i18n (>= 0.5.0)
+      jquery-rails (>= 3.1.1)
       railties (>= 4.2.0, < 5.1)
 
 GEM
@@ -160,7 +161,7 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.11)
+    sqlite3 (1.3.12)
     term-ansicolor (1.3.2)
       tins (~> 1.0)
     thor (0.19.1)
@@ -187,12 +188,11 @@ DEPENDENCIES
   coveralls
   devise (~> 4.2.0)
   factory_girl_rails (~> 4.7.0)
-  jquery-rails
   rails (~> 5.0.0)
   rails-controller-testing
   rspec-rails (~> 3.5.1)
   simplecov (~> 0.12.0)
-  sqlite3
+  sqlite3 (~> 1.3.12)
   timecop
   yard (~> 0.9.5)
   yard-activesupport-concern (~> 0.0.1)

data/lib/activity_notification/version.rb

@@ -1,3 +1,3 @@
 module ActivityNotification
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/generators/{active_record → migration}/migration_generator_spec.rb

@@ -1,4 +1,4 @@
-require 'generators/activity_notification/active_record/migration_generator'
+require 'generators/activity_notification/migration/migration_generator'
 
 describe ActivityNotification::Generators::MigrationGenerator, type: :generator do
 

data/spec/generators/{models → notification}/notification_generator_spec.rb

@@ -1,4 +1,4 @@
-require 'generators/activity_notification/models/notification_generator'
+require 'generators/activity_notification/notification/notification_generator'
 
 describe ActivityNotification::Generators::NotificationGenerator, type: :generator do
 

data/spec/rails_app/app/models/notification.rb

@@ -0,0 +1,6 @@
+# Notification model for customisation & custom methods
+class Notification < ActivityNotification::Notification
+
+  # Write custom methods or override methods here
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activity_notification
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Shota Yamazaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-05 00:00:00.000000000 Z
+date: 2016-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -184,6 +184,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -232,10 +233,10 @@ files:
 - lib/activity_notification/roles/acts_as_notifier.rb
 - lib/activity_notification/roles/acts_as_target.rb
 - lib/activity_notification/version.rb
-- lib/generators/activity_notification/active_record/migration_generator.rb
 - lib/generators/activity_notification/controllers_generator.rb
 - lib/generators/activity_notification/install_generator.rb
-- lib/generators/activity_notification/models/notification_generator.rb
+- lib/generators/activity_notification/migration/migration_generator.rb
+- lib/generators/activity_notification/notification/notification_generator.rb
 - lib/generators/activity_notification/views_generator.rb
 - lib/generators/templates/README
 - lib/generators/templates/active_record/migration.rb
@@ -265,10 +266,10 @@ files:
 - spec/factories/dummy/dummy_target.rb
 - spec/factories/notifications.rb
 - spec/factories/users.rb
-- spec/generators/active_record/migration_generator_spec.rb
 - spec/generators/controllers_generator_spec.rb
 - spec/generators/install_generator_spec.rb
-- spec/generators/models/notification_generator_spec.rb
+- spec/generators/migration/migration_generator_spec.rb
+- spec/generators/notification/notification_generator_spec.rb
 - spec/generators/views_generator_spec.rb
 - spec/helpers/polymorphic_helpers_spec.rb
 - spec/helpers/view_helpers_spec.rb
@@ -298,6 +299,7 @@ files:
 - spec/rails_app/app/models/dummy/dummy_notifiable.rb
 - spec/rails_app/app/models/dummy/dummy_notifier.rb
 - spec/rails_app/app/models/dummy/dummy_target.rb
+- spec/rails_app/app/models/notification.rb
 - spec/rails_app/app/models/user.rb
 - spec/rails_app/app/views/activity_notification/notifications/default/custom/_path_test.html.erb
 - spec/rails_app/app/views/activity_notification/notifications/default/custom/_test.html.erb
@@ -394,10 +396,10 @@ test_files:
 - spec/factories/dummy/dummy_target.rb
 - spec/factories/notifications.rb
 - spec/factories/users.rb
-- spec/generators/active_record/migration_generator_spec.rb
 - spec/generators/controllers_generator_spec.rb
 - spec/generators/install_generator_spec.rb
-- spec/generators/models/notification_generator_spec.rb
+- spec/generators/migration/migration_generator_spec.rb
+- spec/generators/notification/notification_generator_spec.rb
 - spec/generators/views_generator_spec.rb
 - spec/helpers/polymorphic_helpers_spec.rb
 - spec/helpers/view_helpers_spec.rb
@@ -427,6 +429,7 @@ test_files:
 - spec/rails_app/app/models/dummy/dummy_notifiable.rb
 - spec/rails_app/app/models/dummy/dummy_notifier.rb
 - spec/rails_app/app/models/dummy/dummy_target.rb
+- spec/rails_app/app/models/notification.rb
 - spec/rails_app/app/models/user.rb
 - spec/rails_app/app/views/activity_notification/notifications/default/custom/_path_test.html.erb
 - spec/rails_app/app/views/activity_notification/notifications/default/custom/_test.html.erb