activity_notification 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f445f9087536e2804c2cf9dd89ec2ac20185b0dd
-  data.tar.gz: c64170703f4b3b773b0a265d85a1d3bc730dd4b5
+  metadata.gz: 6a65b89d38b765fb3308dddba4204f205bfb67c2
+  data.tar.gz: b44aeebf83a7718a987e97b3bb62bf3011cd7b39
 SHA512:
-  metadata.gz: d7e85d1ab411ef43c75fc0cc61e851aa62906f59393ca55e6ceeb59dbfc39303a2f40ad9a584c83aefa3b174f0310e52ee9c15394729ddd6f7486eb1a21a0d3a
-  data.tar.gz: fe1c334b77ba7dcb69101e93c51198a1023c1b010f32c3a034dbf368e6def3680ed1ed0352c6830dbed9603cdc2392332fbaef4e98e394b461227f1e6973c3af
+  metadata.gz: af081cfffaf148d44c78e0fb3fddebfe213cebb970f585ac207c59fa62c96a2b5bd80b1dd720c7da148aa9e75a36556d6bb97ff4291a83bff4fd6905b96648ce
+  data.tar.gz: 815e00820bdf7d1f5f0486c00ee0e2d7eacd73b51d90b1f3ee1d6809cf875c1af3b24e9a44191c4e64f20cab04d1c179ff3814717a54b338e84c5af5dca0b27f

data/.gitignore

@@ -56,3 +56,6 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+# Security files for testing
+/spec/rails_app/config/initializers/aws.rb

data/.rubocop.yml

@@ -229,7 +229,7 @@ Metrics/CyclomaticComplexity:
                  A complexity metric that is strongly correlated to the number
                  of test cases needed to validate a method.
   Enabled: true
-  Max: 8
+  Max: 9
 
 Metrics/LineLength:
   Description: 'Limit lines to 80 characters.'

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.2.0 / 2017-01-06
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v1.1.0...v1.2.0)
+
+Enhancements:
+
+* Add optional target function
+  * Optional target development framework
+  * Subscription management for optional targets
+  * Amazon SNS client as default optional target implementation
+  * Slack client as default optional target implementation
+* Add `:restrict_with_*` and `:update_group_and_*` options to `:dependent_notifications` of `acts_as_notifiable`
+
 ## 1.1.0 / 2016-12-18
 [Full Changelog](http://github.com/simukappu/activity_notification/compare/v1.0.2...v1.1.0)
 
@@ -5,18 +17,18 @@ Enhancements:
 
 * Add subscription management framework
   * Subscription management model and API
-  * Default subscription management controllers, routing and views
-  * Add Subscriber role configuration to Target role
-* Add as_latest_group_member option to batch mailer API
-* Add group_expiry_delay option to notification API
+  * Default subscription controllers, routing and views
+  * Add `Subscriber` role configuration to `Target` role
+* Add `:as_latest_group_member` option to batch mailer API
+* Add `:group_expiry_delay` option to notification API
 
 Bug Fixes:
 
-* Fix unserializable error in Target#send_batch_unopened_notification_email since unnecessary options are passed to mailer
+* Fix unserializable error in `Target#send_batch_unopened_notification_email` since unnecessary options are passed to mailer
 
 Breaking Changes:
 
-* Remove notifiable_type from the argument of overriden method or configured lambda function for Target#batch_notification_email_allowed?
+* Remove `notifiable_type` from the argument of overriden method or configured lambda function with `:batch_email_allowed` option in `acts_as_target` role
 
 ## 1.0.2 / 2016-11-14
 [Full Changelog](http://github.com/simukappu/activity_notification/compare/v1.0.1...v1.0.2)
@@ -33,15 +45,15 @@ Enhancements:
 * Add function to send batch email notification
   * Batch mailer API
   * Default batch notification email templates
-  * Target role configuration for batch email notification
+  * `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`
+  * Add methods to get notifications for specified target type grouped by targets like `Target#notification_index_map`
 * Arrange default notification email view templates
 
 Breaking Changes:
 
-* Use instance variables @notification.target and @notification.notifiable instead of @target and @notifiable in notification email templates
+* Use instance variable `@notification.notifiable` instead of `@notifiable` in notification email templates
 
 ## 1.0.0 / 2016-10-06
 [Full Changelog](http://github.com/simukappu/activity_notification/compare/v0.0.10...v1.0.0)
@@ -63,7 +75,7 @@ Enhancements:
 
 Breaking Changes:
 
-* Rename `opened_limit` configuration parameter to `opened_index_limit`
+* Rename `config.opened_limit` configuration parameter to `config.opened_index_limit`
   * http://github.com/simukappu/activity_notification/commit/591e53cd8977220f819c11cd702503fc72dd1fd1
 
 ## 0.0.10 / 2016-09-11
@@ -72,7 +84,7 @@ Breaking Changes:
 Enhancements:
 
 * Improve controller action and notification API
-  * Add filter options to `open_all` action and `open_all_of` method
+  * Add filter options to `NotificationsController#open_all` action and `Target#open_all_of` method
 * Add source documentation with YARD
 * Support rails 5.0 and update gem dependency
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activity_notification (1.1.0)
+    activity_notification (1.2.0)
       activerecord (>= 4.2.0)
       i18n (>= 0.5.0)
       jquery-rails (>= 3.1.1)
@@ -10,39 +10,39 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.0.0.1)
-      actionpack (= 5.0.0.1)
+    actioncable (5.0.1)
+      actionpack (= 5.0.1)
       nio4r (~> 1.2)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.0.0.1)
-      actionpack (= 5.0.0.1)
-      actionview (= 5.0.0.1)
-      activejob (= 5.0.0.1)
+    actionmailer (5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.0.1)
-      actionview (= 5.0.0.1)
-      activesupport (= 5.0.0.1)
+    actionpack (5.0.1)
+      actionview (= 5.0.1)
+      activesupport (= 5.0.1)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.0.1)
-      activesupport (= 5.0.0.1)
+    actionview (5.0.1)
+      activesupport (= 5.0.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (5.0.0.1)
-      activesupport (= 5.0.0.1)
+    activejob (5.0.1)
+      activesupport (= 5.0.1)
       globalid (>= 0.3.6)
-    activemodel (5.0.0.1)
-      activesupport (= 5.0.0.1)
-    activerecord (5.0.0.1)
-      activemodel (= 5.0.0.1)
-      activesupport (= 5.0.0.1)
+    activemodel (5.0.1)
+      activesupport (= 5.0.1)
+    activerecord (5.0.1)
+      activemodel (= 5.0.1)
+      activesupport (= 5.0.1)
       arel (~> 7.0)
-    activesupport (5.0.0.1)
+    activesupport (5.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -52,12 +52,20 @@ GEM
       railties (>= 3.0)
       rspec-rails (>= 2.2)
     arel (7.1.4)
+    aws-sdk (2.6.43)
+      aws-sdk-resources (= 2.6.43)
+    aws-sdk-core (2.6.43)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.6.43)
+      aws-sdk-core (= 2.6.43)
+    aws-sigv4 (1.0.0)
     bcrypt (3.1.11)
     builder (3.2.2)
-    bullet (5.4.3)
+    bullet (5.5.0)
       activesupport (>= 3.0.0)
       uniform_notifier (~> 1.10.0)
-    concurrent-ruby (1.0.3)
+    concurrent-ruby (1.0.4)
     coveralls (0.8.17)
       json (>= 1.8, < 3)
       simplecov (~> 0.12.0)
@@ -81,7 +89,8 @@ GEM
     globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
-    jquery-rails (4.2.1)
+    jmespath (1.3.1)
+    jquery-rails (4.2.2)
       rails-dom-testing (>= 1, < 3)
       railties (>= 4.2.0)
       thor (>= 0.14, < 2.0)
@@ -97,36 +106,36 @@ GEM
     mini_portile2 (2.1.0)
     minitest (5.10.1)
     nio4r (1.2.1)
-    nokogiri (1.6.8.1)
+    nokogiri (1.7.0)
       mini_portile2 (~> 2.1.0)
     orm_adapter (0.5.0)
     rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (5.0.0.1)
-      actioncable (= 5.0.0.1)
-      actionmailer (= 5.0.0.1)
-      actionpack (= 5.0.0.1)
-      actionview (= 5.0.0.1)
-      activejob (= 5.0.0.1)
-      activemodel (= 5.0.0.1)
-      activerecord (= 5.0.0.1)
-      activesupport (= 5.0.0.1)
+    rails (5.0.1)
+      actioncable (= 5.0.1)
+      actionmailer (= 5.0.1)
+      actionpack (= 5.0.1)
+      actionview (= 5.0.1)
+      activejob (= 5.0.1)
+      activemodel (= 5.0.1)
+      activerecord (= 5.0.1)
+      activesupport (= 5.0.1)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 5.0.0.1)
+      railties (= 5.0.1)
       sprockets-rails (>= 2.0.0)
     rails-controller-testing (1.0.1)
       actionpack (~> 5.x)
       actionview (~> 5.x)
       activesupport (~> 5.x)
-    rails-dom-testing (2.0.1)
+    rails-dom-testing (2.0.2)
       activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6.0)
+      nokogiri (~> 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.0.0.1)
-      actionpack (= 5.0.0.1)
-      activesupport (= 5.0.0.1)
+    railties (5.0.1)
+      actionpack (= 5.0.1)
+      activesupport (= 5.0.1)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
@@ -155,7 +164,8 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    sprockets (3.7.0)
+    slack-notifier (1.5.1)
+    sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
     sprockets-rails (3.2.0)
@@ -187,6 +197,7 @@ PLATFORMS
 DEPENDENCIES
   activity_notification!
   ammeter
+  aws-sdk (~> 2)
   bullet
   coveralls
   devise (~> 4.2.0)
@@ -195,6 +206,7 @@ DEPENDENCIES
   rails-controller-testing
   rspec-rails (~> 3.5.1)
   simplecov (~> 0.12.0)
+  slack-notifier (~> 1.5.1)
   sqlite3 (~> 1.3.12)
   timecop
   yard (~> 0.9.5)

data/README.md

@@ -21,20 +21,24 @@
 * Notification views (presentation of notifications)
 * Grouping notifications (grouping like `"Kevin and 7 other users posted comments to this article"`)
 * Email notification
-* Batch email notification
-* Subscription management
+* Batch email notification (event driven or periodical email notification, daily or weekly etc)
+* Subscription management (opt-in or opt-out by each target and notification type)
 * Integration with [Devise](https://github.com/plataformatec/devise) authentication
+* Optional notification targets (Configurable optional notification targets like Amazon SNS, Slack, SMS and so on)
 
-### Notification index
-<kbd>![notification-index](https://raw.githubusercontent.com/simukappu/activity_notification/images/activity_notification_index.png)</kbd>
+### Notification index and plugin notifications
+<kbd>![plugin-notifications-image](https://raw.githubusercontent.com/simukappu/activity_notification/images/activity_notification_plugin_focus_with_subscription.png)</kbd>
 
-### Plugin notifications
-<kbd>![plugin-notifications](https://raw.githubusercontent.com/simukappu/activity_notification/images/activity_notification_plugin_focus_with_subscription.png)</kbd>
+`activity_notification` deeply uses [PublicActivity](https://github.com/pokonski/public_activity) as reference in presentation layer.
 
-### Subscription management
-<kbd>![subscription-management](https://raw.githubusercontent.com/simukappu/activity_notification/images/activity_notification_subscription_management.png)</kbd>
+### Subscription management of notifications
+<kbd>![subscription-management-image](https://raw.githubusercontent.com/simukappu/activity_notification/images/activity_notification_subscription_management_with_optional_targets.png)</kbd>
 
-`activity_notification` deeply uses [PublicActivity](https://github.com/pokonski/public_activity) as reference in presentation layer.
+### Amazon SNS as optional notification target
+<kbd>![optional-target-amazon-sns-email-image](https://raw.githubusercontent.com/simukappu/activity_notification/images/activity_notification_optional_target_amazon_sns_email.png)</kbd>
+
+### Slack as optional notification target
+<kbd>![optional-target-slack-image](https://raw.githubusercontent.com/simukappu/activity_notification/images/activity_notification_optional_target_slack.png)</kbd>
 
 
 ## Table of contents
@@ -70,6 +74,12 @@
     2. [Manage subscriptions](#manage-subscriptions)
     3. [Customize Subscriptions](#customize-subscriptions)
   5. [Integration with Devise](#integration-with-devise)
+  6. [Optional notification targets](#optional-notification-targets)
+    1. [Setup optional targets](#setup-optional-targets)
+    2. [Customizing message format](#Customizing-message-format)
+    3. [Amazon SNS as optional target](#amazon-sns-as-optional-target)
+    4. [Slack as optional target](#slack-as-optional-target)
+    5. [Developing custom optional targets](#developing-custom-optional-targets)
 4. [Testing](#testing)
 5. [Documentation](#documentation)
 6. **[Common examples](#common-examples)**
@@ -337,7 +347,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.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)`.
+For example, if you have a 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, you can skip it in your projects or use this prefix only to make namespace.
 
@@ -406,7 +416,7 @@ This structure is valid for notifications with keys `"notification.comment.reply
 
 #### 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`:
+Set up SMTP server configuration for `ActionMailer`. Then, 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 }
@@ -450,7 +460,7 @@ 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)`.
+`activity_notification` will look for email template in the same way as notification views. For example, if you have a 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)`.
 
@@ -473,7 +483,7 @@ notification:
 
 #### Setup batch mailer
 
-First, you need to set up the default URL options for the `activity_notification` mailer in each environment.
+Set up SMTP server configuration for `ActionMailer` and 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.
 
@@ -574,7 +584,7 @@ notification:
         mail_subject: 'New comment to your article'
 ```
 
-Then, you will see `Kevin and 7 other users replied 10 comments to your article"`.
+Then, you will see `Kevin and 7 other users posted 10 comments to your article"`.
 
 
 ### Subscription management
@@ -738,6 +748,159 @@ end
 In this example `activity_notification` will confirm the `user` who `admin` belongs to with authenticated user by devise.
 
 
+### Optional notification targets
+
+`activity_notification` supports configurable optional notification targets like Amazon SNS, Slack, SMS and so on.
+
+#### Setup optional targets
+
+`activity_notification` provides default optional target implementation for Amazon SNS and Slack.
+You can develop any optional target classes which extends `ActivityNotification::OptionalTarget::Base`, and configure them to notifiable model by `acts_as_notifiable` like this.
+
+```ruby
+class Comment < ActiveRecord::Base
+  belongs_to :article
+  belongs_to :user
+
+  require 'activity_notification/optional_targets/amazon_sns'
+  require 'activity_notification/optional_targets/slack'
+  require 'custom_optional_targets/console_output'
+  acts_as_notifiable :admins, targets: Admin.all,
+    notifiable_path: :article_notifiable_path,
+    # Set optional target implementation class and initializing parameters
+    optional_targets: {
+      ActivityNotification::OptionalTarget::AmazonSNS => { topic_arn: 'arn:aws:sns:XXXXX:XXXXXXXXXXXX:XXXXX' },
+      ActivityNotification::OptionalTarget::Slack  => {
+        webhook_url: 'https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX',
+        slack_name: :slack_name, channel: 'activity_notification', username: 'ActivityNotification', icon_emoji: ":ghost:"
+      },
+      CustomOptionalTarget::ConsoleOutput => {}
+    }
+
+  def article_notifiable_path
+    article_path(article)
+  end
+end
+```
+
+Write `require` statement for optional target implementation classes and set them with initializing parameters to `acts_as_notifiable`.
+`activity_notification` will publish all notifications of those targets and notifiables to optional targets.
+
+#### Customizing message format
+
+Optional targets prepare publishing messages from notification instance using view template like rendering notifications.
+As default, all optional targets use `app/views/activity_notification/optional_targets/default/base/_default.text.erb`.
+You can customize this template by creating `app/views/activity_notification/optional_targets/<target_class_name>/<optional_target_class_name>/<notification_key>.text.(|erb|haml|slim|something_else)`.
+For example, if you have a notification for `:users` target with `:key` set to `"notification.comment.reply"` and `ActivityNotification::OptionalTarget::AmazonSNS` optional target is configured, the gem will look for a partial in `app/views/activity_notification/optional_targets/users/amazon_sns/comment/_reply.text.erb`.
+The gem will also look for templates whose `<target_class_name>` is `default`, `<optional_target_class_name>` is `base` or `<notification_key>` is `default`, which means `app/views/activity_notification/optional_targets/users/amazon_sns/_default.text.erb`, `app/views/activity_notification/optional_targets/users/base/_default.text.erb`, `app/views/activity_notification/optional_targets/default/amazon_sns/_default.text.erb` and `app/views/activity_notification/optional_targets/default/base/_default.text.erb`.
+
+#### Amazon SNS as optional target
+
+`activity_notification` provides `ActivityNotification::OptionalTarget::AmazonSNS` as default optional target implementation for Amazon SNS.
+
+First, add `aws-sdk` gem to your Gemfile and set AWS Credentials for SDK (See [Configuring the AWS SDK for Ruby](https://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html)).
+
+```ruby
+gem 'aws-sdk', '~> 2'
+```
+
+```ruby
+require 'aws-sdk'
+Aws.config.update(
+  region: 'your_region',
+  credentials: Aws::Credentials.new('your_access_key_id', 'your_secret_access_key')
+)
+```
+
+Then, write `require 'activity_notification/optional_targets/amazon_sns'` statement in your notifiable model and set `ActivityNotification::OptionalTarget::AmazonSNS` to `acts_as_notifiable` with `:topic_arn`, `:target_arn` or `:phone_number` initializing parameters.
+Any other options for `Aws::SNS::Client.new` are available as initializing parameters. See [API Reference of Class: Aws::SNS::Client](http://docs.aws.amazon.com/sdkforruby/api/Aws/SNS/Client.html) for more details.
+
+```ruby
+class Comment < ActiveRecord::Base
+  require 'activity_notification/optional_targets/amazon_sns'
+  acts_as_notifiable :admins, targets: Admin.all,
+    optional_targets: {
+      ActivityNotification::OptionalTarget::AmazonSNS => { topic_arn: 'arn:aws:sns:XXXXX:XXXXXXXXXXXX:XXXXX' }
+    }
+end
+```
+
+#### Slack as optional target
+
+`activity_notification` provides `ActivityNotification::OptionalTarget::Slack` as default optional target implementation for Slack.
+
+First, add `slack-notifier` gem to your Gemfile and create Incoming WebHooks in Slack (See [Incoming WebHooks](https://wemakejp.slack.com/apps/A0F7XDUAZ-incoming-webhooks)).
+
+```ruby
+gem 'slack-notifier'
+```
+
+Then, write `require 'activity_notification/optional_targets/slack'` statement in your notifiable model and set `ActivityNotification::OptionalTarget::Slack` to `acts_as_notifiable` with `:webhook_url` and `:slack_name` initializing parameters. `:webhook_url` is created WebHook URL and required, `:slack_name` is target's slack user name as String value, symbol method name or lambda function and is optional.
+Any other options for `Slack::Notifier.new` are available as initializing parameters. See [Github slack-notifier](https://github.com/stevenosloan/slack-notifier) and [API Reference of Class: Slack::Notifier](http://www.rubydoc.info/gems/slack-notifier/1.5.1/Slack/Notifier) for more details.
+
+```ruby
+class Comment < ActiveRecord::Base
+  require 'activity_notification/optional_targets/slack'
+  acts_as_notifiable :admins, targets: Admin.all,
+    optional_targets: {
+      ActivityNotification::OptionalTarget::Slack  => {
+        webhook_url: 'https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX',
+        slack_name: :slack_name, channel: 'activity_notification', username: 'ActivityNotification', icon_emoji: ":ghost:"
+      }
+    }
+end
+```
+
+#### Developing custom optional targets
+
+You can develop any custom optional targets.
+Custom optional target class must extend `ActivityNotification::OptionalTarget::Base` and override `initialize_target` and `notify` method.
+You can use `render_notification_message` method to prepare message from notification instance using view template.
+
+For example, create `lib/custom_optional_targets/amazon_sns.rb` as follows:
+
+```ruby
+module CustomOptionalTarget
+  # Custom optional target implementation for mobile push notification or SMS using Amazon SNS.
+  class AmazonSNS < ActivityNotification::OptionalTarget::Base
+    require 'aws-sdk'
+
+    # Initialize method to prepare Aws::SNS::Client
+    def initialize_target(options = {})
+      @topic_arn    = options.delete(:topic_arn)
+      @target_arn   = options.delete(:target_arn)
+      @phone_number = options.delete(:phone_number)
+      @sns_client = Aws::SNS::Client.new(options)
+    end
+
+    # Publishes notification message to Amazon SNS
+    def notify(notification, options = {})
+      @sns_client.publish(
+        topic_arn:    notification.target.resolve_value(options.delete(:topic_arn) || @topic_arn),
+        target_arn:   notification.target.resolve_value(options.delete(:target_arn) || @target_arn),
+        phone_number: notification.target.resolve_value(options.delete(:phone_number) || @phone_number),
+        message: render_notification_message(notification, options)
+      )
+    end
+  end
+end
+```
+
+Then, you can configure them to notifiable model by `acts_as_notifiable` like this.
+
+```ruby
+class Comment < ActiveRecord::Base
+  require 'custom_optional_targets/amazon_sns'
+  acts_as_notifiable :admins, targets: Admin.all,
+    optional_targets: {
+      CustomOptionalTarget::AmazonSNS => { topic_arn: 'arn:aws:sns:XXXXX:XXXXXXXXXXXX:XXXXX' }
+    }
+end
+```
+
+`acts_as_notifiable` creates optional target instances and calls `initialize_target` method with initializing parameters.
+
+
 ## Testing
 
 ### Testing your application