activity_notification 1.0.2 → 1.1.0

data/spec/rails_app/app/controllers/users/subscriptions_with_devise_controller.rb

@@ -0,0 +1,87 @@
+class Users::SubscriptionsWithDeviseController < ActivityNotification::SubscriptionsWithDeviseController
+  # GET /:target_type/:target_id/subscriptions
+  # def index
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions
+  # def create
+  #   super
+  # end
+
+  # GET /:target_type/:target_id/subscriptions/:id
+  # def show
+  #   super
+  # end
+
+  # DELETE /:target_type/:target_id/subscriptions/:id
+  # def destroy
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/subscribe
+  # def subscribe
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe
+  # def unsubscribe
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/subscribe_to_email
+  # def subscribe_to_email
+  #   super
+  # end
+
+  # POST /:target_type/:target_id/subscriptions/:id/unsubscribe_to_email
+  # def unsubscribe_to_email
+  #   super
+  # end
+
+  # protected
+
+  # def set_target
+  #   super
+  # end
+
+  # def set_subscription
+  #   super
+  # end
+
+  # def subscription_params
+  #   super
+  # end
+
+  # def set_index_options
+  #   super
+  # end
+
+  # def load_subscription_index(options = {})
+  #   super(options)
+  # end
+
+  # def controller_path
+  #   super
+  # end
+
+  # def target_view_path
+  #   super
+  # end
+
+  # def set_view_prefixes
+  #   super
+  # end
+
+  # def return_back_or_ajax
+  #   super
+  # end
+
+  # def authenticate_devise_resource!
+  #   super
+  # end
+
+  # def authenticate_target!
+  #   super
+  # end
+end

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

@@ -4,6 +4,7 @@ class Admin < ActiveRecord::Base
 
   acts_as_notification_target email: :email,
     email_allowed: ->(admin, key) { admin.user.confirmed_at.present? },
+    subscription_allowed: true,
     devise_resource: :user,
     printable_name: ->(admin) { "admin (#{admin.user.name})" }
 end

data/spec/rails_app/app/models/dummy/dummy_subscriber.rb

@@ -0,0 +1,4 @@
+class Dummy::DummySubscriber < ActiveRecord::Base
+  self.table_name = :users
+  acts_as_target email: 'dummy@example.com', email_allowed: true, batch_email_allowed: true, subscription_allowed: true
+end

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

@@ -4,7 +4,8 @@ class User < ActiveRecord::Base
   has_many :articles, dependent: :destroy
   has_one :admin, dependent: :destroy
 
-  acts_as_target email: :email, email_allowed: :confirmed_at, batch_email_allowed: :confirmed_at, printable_name: :name
+  acts_as_target email: :email, email_allowed: :confirmed_at, batch_email_allowed: :confirmed_at,
+                 subscription_allowed: true, printable_name: :name
   acts_as_notifier printable_name: :name
 
   def admin?

data/spec/rails_app/app/views/activity_notification/mailer/dummy_subscribers/test_key.text.erb

@@ -0,0 +1 @@
+Dummy subscriber's notification email template.

data/spec/rails_app/app/views/articles/index.html.erb

@@ -7,6 +7,9 @@
         <p class="list_description">
           <span><%= user.name %></span> · <%= user.email %><br>
           <%= link_to 'Notifications', user_notifications_path(user) %>
+          <% if User.subscription_enabled? %>
+            <%= link_to 'Subscriptions', user_subscriptions_path(user) %>
+          <% end %>
         </p>
       </div>
     </div>
@@ -22,6 +25,9 @@
         <p class="list_description">
           <span><%= admin.user.name %></span> · <%= admin.user.email %><br>
           <%= link_to 'Notifications', admin_notifications_path(admin) %>
+          <% if Admin.subscription_enabled? %>
+            <%= link_to 'Subscriptions', admin_subscriptions_path(admin) %>
+          <% end %>
         </p>
       </div>
     </div>

data/spec/rails_app/config/initializers/activity_notification.rb

@@ -5,13 +5,27 @@ ActivityNotification.configure do |config|
   config.enabled = true
 
   # Configure table name to store notification data
-  config.table_name = "notifications"
+  config.notification_table_name = "notifications"
 
-  # Configure if email notification is enabled as default
+  # Configure table name to store subscription data
+  config.subscription_table_name = "subscriptions"
+
+  # Configure if email notification is enabled as default.
   # Note that you can configure them for each model by acts_as roles.
-  # Set true when you want to turn on email notifications as default
+  # Set true when you want to turn on email notifications as default.
   config.email_enabled = false
 
+  # Configure if subscription is managed.
+  # Note that this parameter must be true when you want use subscription management.
+  # However, you can also configure them for each model by acts_as roles.
+  # Set true when you want to turn on subscription management as default.
+  config.subscription_enabled = false
+
+  # Configure default subscription value to use when the subscription record does not configured.
+  # Note that you can configure them for each method calling as default argument.
+  # Set false when you want to unsubscribe to any notifications as default.
+  config.subscribe_as_default = true
+
   # Configure the e-mail address which will be shown in ActivityNotification::Mailer,
   # note that it will be overwritten if you use your own mailer class with default "from" parameter.
   config.mailer_sender = 'please-change-me-at-config-initializers-activity_notification@example.com'

data/spec/rails_app/config/routes.rb

@@ -4,6 +4,6 @@ Rails.application.routes.draw do
   resources :articles
   resources :comments, only: [:create, :destroy]
 
-  notify_to :users
-  notify_to :admins, with_devise: :users
+  notify_to :users, with_subscription: true
+  notify_to :admins, with_devise: :users, with_subscription: true
 end

data/spec/rails_app/db/migrate/20160715050420_create_activity_notification_tables.rb

@@ -0,0 +1,33 @@
+# Migration responsible for creating a table with notifications
+class CreateActivityNotificationTables < ActiveRecord::Migration
+  # Create tables
+  def change
+    create_table :notifications do |t|
+      t.belongs_to :target,     polymorphic: true, index: true, null: false
+      t.belongs_to :notifiable, polymorphic: true, index: true, null: false
+      t.string     :key,                                        null: false
+      t.belongs_to :group,      polymorphic: true, index: true
+      t.integer    :group_owner_id,                index: true
+      t.belongs_to :notifier,   polymorphic: true, index: true
+      t.text       :parameters
+      t.datetime   :opened_at
+
+      t.timestamps
+    end
+
+    create_table :subscriptions do |t|
+      t.belongs_to :target,     polymorphic: true, index: true, null: false
+      t.string     :key,                           index: true, null: false
+      t.boolean    :subscribing,                                null: false, default: true
+      t.boolean    :subscribing_to_email,                       null: false, default: true
+      t.datetime   :subscribed_at
+      t.datetime   :unsubscribed_at
+      t.datetime   :subscribed_to_email_at
+      t.datetime   :unsubscribed_to_email_at
+      t.text       :parameters
+
+      t.timestamps
+    end
+    add_index :subscriptions, [:target_type, :target_id, :key], unique: true
+  end
+end

data/spec/rails_app/db/schema.rb

@@ -60,6 +60,24 @@ ActiveRecord::Schema.define(version: 20160715050433) do
     t.index ["target_type", "target_id"], name: "index_notifications_on_target_type_and_target_id"
   end
 
+  create_table "subscriptions", force: :cascade do |t|
+    t.string   "target_type",                             null: false
+    t.integer  "target_id",                               null: false
+    t.string   "key",                                     null: false
+    t.boolean  "subscribing",              default: true, null: false
+    t.boolean  "subscribing_to_email",     default: true, null: false
+    t.datetime "subscribed_at"
+    t.datetime "unsubscribed_at"
+    t.datetime "subscribed_to_email_at"
+    t.datetime "unsubscribed_to_email_at"
+    t.text     "parameters"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.index ["key"], name: "index_subscriptions_on_key"
+    t.index ["target_type", "target_id", "key"], name: "index_subscriptions_on_target_type_and_target_id_and_key", unique: true
+    t.index ["target_type", "target_id"], name: "index_subscriptions_on_target_type_and_target_id"
+  end
+
   create_table "users", force: :cascade do |t|
     t.string   "email",                default: "", null: false
     t.string   "encrypted_password",   default: "", null: false

data/spec/roles/acts_as_notifiable_spec.rb

@@ -25,7 +25,7 @@ describe ActivityNotification::ActsAsNotifiable do
     describe ".available_notifiable_options" do
       it "returns list of available options in acts_as_notifiable" do
         expect(dummy_model_class.available_notifiable_options)
-          .to eq([:targets, :group, :notifier, :parameters, :email_allowed, :notifiable_path, :printable_notifiable_name, :printable_name, :dependent_notifications])
+          .to eq([:targets, :group, :group_expiry_delay, :notifier, :parameters, :email_allowed, :notifiable_path, :printable_notifiable_name, :printable_name, :dependent_notifications])
       end
     end
   end

data/spec/roles/acts_as_target_spec.rb

@@ -33,7 +33,7 @@ describe ActivityNotification::ActsAsTarget do
     describe ".available_target_options" do
       it "returns list of available options in acts_as_target" do
         expect(dummy_model_class.available_target_options)
-          .to eq([:email, :email_allowed, :batch_email_allowed, :devise_resource, :printable_notification_target_name, :printable_name])
+          .to eq([:email, :email_allowed, :batch_email_allowed, :subscription_allowed, :devise_resource, :printable_notification_target_name, :printable_name])
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activity_notification
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Shota Yamazaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-14 00:00:00.000000000 Z
+date: 2016-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 4.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.7.0
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -179,9 +179,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -193,6 +195,8 @@ files:
 - activity_notification.gemspec
 - app/controllers/activity_notification/notifications_controller.rb
 - app/controllers/activity_notification/notifications_with_devise_controller.rb
+- app/controllers/activity_notification/subscriptions_controller.rb
+- app/controllers/activity_notification/subscriptions_with_devise_controller.rb
 - app/mailers/activity_notification/mailer.rb
 - app/views/activity_notification/mailer/default/batch_default.html.erb
 - app/views/activity_notification/mailer/default/batch_default.text.erb
@@ -206,14 +210,29 @@ files:
 - app/views/activity_notification/notifications/default/open.js.erb
 - app/views/activity_notification/notifications/default/open_all.js.erb
 - app/views/activity_notification/notifications/default/show.html.erb
+- app/views/activity_notification/subscriptions/default/_form.html.erb
+- app/views/activity_notification/subscriptions/default/_notification_keys.html.erb
+- app/views/activity_notification/subscriptions/default/_subscription.html.erb
+- app/views/activity_notification/subscriptions/default/_subscriptions.html.erb
+- app/views/activity_notification/subscriptions/default/create.js.erb
+- app/views/activity_notification/subscriptions/default/destroy.js.erb
+- app/views/activity_notification/subscriptions/default/index.html.erb
+- app/views/activity_notification/subscriptions/default/show.html.erb
+- app/views/activity_notification/subscriptions/default/subscribe.js.erb
+- app/views/activity_notification/subscriptions/default/subscribe_to_email.js.erb
+- app/views/activity_notification/subscriptions/default/unsubscribe.js.erb
+- app/views/activity_notification/subscriptions/default/unsubscribe_to_email.js.erb
 - gemfiles/Gemfile.rails-4.2
 - gemfiles/Gemfile.rails-4.2.lock
 - gemfiles/Gemfile.rails-5.0
 - gemfiles/Gemfile.rails-5.0.lock
 - lib/activity_notification.rb
 - lib/activity_notification/apis/notification_api.rb
+- lib/activity_notification/apis/subscription_api.rb
 - lib/activity_notification/common.rb
 - lib/activity_notification/config.rb
+- lib/activity_notification/controllers/common_controller.rb
+- lib/activity_notification/controllers/devise_authentication_controller.rb
 - lib/activity_notification/controllers/store_controller.rb
 - lib/activity_notification/helpers/polymorphic_helpers.rb
 - lib/activity_notification/helpers/view_helpers.rb
@@ -222,8 +241,10 @@ files:
 - lib/activity_notification/models/concerns/group.rb
 - lib/activity_notification/models/concerns/notifiable.rb
 - lib/activity_notification/models/concerns/notifier.rb
+- lib/activity_notification/models/concerns/subscriber.rb
 - lib/activity_notification/models/concerns/target.rb
 - lib/activity_notification/models/notification.rb
+- lib/activity_notification/models/subscription.rb
 - lib/activity_notification/rails.rb
 - lib/activity_notification/rails/routes.rb
 - lib/activity_notification/renderable.rb
@@ -236,40 +257,53 @@ files:
 - lib/generators/activity_notification/controllers_generator.rb
 - lib/generators/activity_notification/install_generator.rb
 - lib/generators/activity_notification/migration/migration_generator.rb
-- lib/generators/activity_notification/notification/notification_generator.rb
+- lib/generators/activity_notification/models_generator.rb
 - lib/generators/activity_notification/views_generator.rb
 - lib/generators/templates/README
-- lib/generators/templates/active_record/migration.rb
 - lib/generators/templates/activity_notification.rb
 - lib/generators/templates/controllers/README
 - lib/generators/templates/controllers/notifications_controller.rb
 - lib/generators/templates/controllers/notifications_with_devise_controller.rb
+- lib/generators/templates/controllers/subscriptions_controller.rb
+- lib/generators/templates/controllers/subscriptions_with_devise_controller.rb
 - lib/generators/templates/locales/en.yml
-- lib/generators/templates/notification/notification.rb
+- lib/generators/templates/migrations/migration.rb
+- lib/generators/templates/models/README
+- lib/generators/templates/models/notification.rb
+- lib/generators/templates/models/subscription.rb
 - lib/tasks/activity_notification_tasks.rake
 - spec/concerns/apis/notification_api_spec.rb
+- spec/concerns/apis/subscription_api_spec.rb
 - spec/concerns/common_spec.rb
 - spec/concerns/models/group_spec.rb
 - spec/concerns/models/notifiable_spec.rb
 - spec/concerns/models/notifier_spec.rb
+- spec/concerns/models/subscriber_spec.rb
 - spec/concerns/models/target_spec.rb
 - spec/concerns/renderable_spec.rb
+- spec/controllers/common_controller_spec.rb
+- spec/controllers/dummy_common_controller.rb
 - spec/controllers/notifications_controller_shared_examples.rb
 - spec/controllers/notifications_controller_spec.rb
 - spec/controllers/notifications_with_devise_controller_spec.rb
+- spec/controllers/subscriptions_controller_shared_examples.rb
+- spec/controllers/subscriptions_controller_spec.rb
+- spec/controllers/subscriptions_with_devise_controller_spec.rb
 - spec/factories/admins.rb
 - spec/factories/articles.rb
 - spec/factories/comments.rb
 - spec/factories/dummy/dummy_group.rb
 - spec/factories/dummy/dummy_notifiable.rb
 - spec/factories/dummy/dummy_notifier.rb
+- spec/factories/dummy/dummy_subscriber.rb
 - spec/factories/dummy/dummy_target.rb
 - spec/factories/notifications.rb
+- spec/factories/subscriptions.rb
 - spec/factories/users.rb
 - spec/generators/controllers_generator_spec.rb
 - spec/generators/install_generator_spec.rb
 - spec/generators/migration/migration_generator_spec.rb
-- spec/generators/notification/notification_generator_spec.rb
+- spec/generators/models_generator_spec.rb
 - spec/generators/views_generator_spec.rb
 - spec/helpers/polymorphic_helpers_spec.rb
 - spec/helpers/view_helpers_spec.rb
@@ -277,8 +311,10 @@ files:
 - spec/models/dummy/dummy_group_spec.rb
 - spec/models/dummy/dummy_notifiable_spec.rb
 - spec/models/dummy/dummy_notifier_spec.rb
+- spec/models/dummy/dummy_subscriber_spec.rb
 - spec/models/dummy/dummy_target_spec.rb
 - spec/models/notification_spec.rb
+- spec/models/subscription_spec.rb
 - spec/rails_app/Rakefile
 - spec/rails_app/app/assets/javascripts/application.js
 - spec/rails_app/app/assets/stylesheets/application.css
@@ -288,6 +324,10 @@ files:
 - spec/rails_app/app/controllers/articles_controller.rb
 - spec/rails_app/app/controllers/comments_controller.rb
 - spec/rails_app/app/controllers/concerns/.keep
+- spec/rails_app/app/controllers/users/notifications_controller.rb
+- spec/rails_app/app/controllers/users/notifications_with_devise_controller.rb
+- spec/rails_app/app/controllers/users/subscriptions_controller.rb
+- spec/rails_app/app/controllers/users/subscriptions_with_devise_controller.rb
 - spec/rails_app/app/helpers/application_helper.rb
 - spec/rails_app/app/mailers/.keep
 - spec/rails_app/app/models/.keep
@@ -298,9 +338,11 @@ files:
 - spec/rails_app/app/models/dummy/dummy_group.rb
 - 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_subscriber.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/mailer/dummy_subscribers/test_key.text.erb
 - 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
 - spec/rails_app/app/views/activity_notification/notifications/users/_custom_index.html.erb
@@ -338,7 +380,7 @@ files:
 - spec/rails_app/config/locales/devise.en.yml
 - spec/rails_app/config/routes.rb
 - spec/rails_app/config/secrets.yml
-- spec/rails_app/db/migrate/20160715050420_create_notifications.rb
+- spec/rails_app/db/migrate/20160715050420_create_activity_notification_tables.rb
 - spec/rails_app/db/migrate/20160715050433_create_test_tables.rb
 - spec/rails_app/db/schema.rb
 - spec/rails_app/db/seeds.rb
@@ -378,28 +420,37 @@ specification_version: 4
 summary: Integrated user activity notifications for Ruby on Rails
 test_files:
 - spec/concerns/apis/notification_api_spec.rb
+- spec/concerns/apis/subscription_api_spec.rb
 - spec/concerns/common_spec.rb
 - spec/concerns/models/group_spec.rb
 - spec/concerns/models/notifiable_spec.rb
 - spec/concerns/models/notifier_spec.rb
+- spec/concerns/models/subscriber_spec.rb
 - spec/concerns/models/target_spec.rb
 - spec/concerns/renderable_spec.rb
+- spec/controllers/common_controller_spec.rb
+- spec/controllers/dummy_common_controller.rb
 - spec/controllers/notifications_controller_shared_examples.rb
 - spec/controllers/notifications_controller_spec.rb
 - spec/controllers/notifications_with_devise_controller_spec.rb
+- spec/controllers/subscriptions_controller_shared_examples.rb
+- spec/controllers/subscriptions_controller_spec.rb
+- spec/controllers/subscriptions_with_devise_controller_spec.rb
 - spec/factories/admins.rb
 - spec/factories/articles.rb
 - spec/factories/comments.rb
 - spec/factories/dummy/dummy_group.rb
 - spec/factories/dummy/dummy_notifiable.rb
 - spec/factories/dummy/dummy_notifier.rb
+- spec/factories/dummy/dummy_subscriber.rb
 - spec/factories/dummy/dummy_target.rb
 - spec/factories/notifications.rb
+- spec/factories/subscriptions.rb
 - spec/factories/users.rb
 - spec/generators/controllers_generator_spec.rb
 - spec/generators/install_generator_spec.rb
 - spec/generators/migration/migration_generator_spec.rb
-- spec/generators/notification/notification_generator_spec.rb
+- spec/generators/models_generator_spec.rb
 - spec/generators/views_generator_spec.rb
 - spec/helpers/polymorphic_helpers_spec.rb
 - spec/helpers/view_helpers_spec.rb
@@ -407,8 +458,10 @@ test_files:
 - spec/models/dummy/dummy_group_spec.rb
 - spec/models/dummy/dummy_notifiable_spec.rb
 - spec/models/dummy/dummy_notifier_spec.rb
+- spec/models/dummy/dummy_subscriber_spec.rb
 - spec/models/dummy/dummy_target_spec.rb
 - spec/models/notification_spec.rb
+- spec/models/subscription_spec.rb
 - spec/rails_app/Rakefile
 - spec/rails_app/app/assets/javascripts/application.js
 - spec/rails_app/app/assets/stylesheets/application.css
@@ -418,6 +471,10 @@ test_files:
 - spec/rails_app/app/controllers/articles_controller.rb
 - spec/rails_app/app/controllers/comments_controller.rb
 - spec/rails_app/app/controllers/concerns/.keep
+- spec/rails_app/app/controllers/users/notifications_controller.rb
+- spec/rails_app/app/controllers/users/notifications_with_devise_controller.rb
+- spec/rails_app/app/controllers/users/subscriptions_controller.rb
+- spec/rails_app/app/controllers/users/subscriptions_with_devise_controller.rb
 - spec/rails_app/app/helpers/application_helper.rb
 - spec/rails_app/app/mailers/.keep
 - spec/rails_app/app/models/.keep
@@ -428,9 +485,11 @@ test_files:
 - spec/rails_app/app/models/dummy/dummy_group.rb
 - 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_subscriber.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/mailer/dummy_subscribers/test_key.text.erb
 - 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
 - spec/rails_app/app/views/activity_notification/notifications/users/_custom_index.html.erb
@@ -468,7 +527,7 @@ test_files:
 - spec/rails_app/config/locales/devise.en.yml
 - spec/rails_app/config/routes.rb
 - spec/rails_app/config/secrets.yml
-- spec/rails_app/db/migrate/20160715050420_create_notifications.rb
+- spec/rails_app/db/migrate/20160715050420_create_activity_notification_tables.rb
 - spec/rails_app/db/migrate/20160715050433_create_test_tables.rb
 - spec/rails_app/db/schema.rb
 - spec/rails_app/db/seeds.rb