activity_notification 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1f6ad3e3fe40d4841cde7931cdc67065c87fd948db1674a1cbc3016f1338aba
-  data.tar.gz: 0b15bf8fe764df0d3431543d29ec08b3f95548faf337a14b3c30f98379688742
+  metadata.gz: 771b080e7877b6a83105bc0f8842440fc4f2a12c0fa56b6e55f4d2b24b3e9d20
+  data.tar.gz: 2b8dcbeb13208ef8a44e3fa246ac464f1e36c8140cc1e087ebc6b39e55da1107
 SHA512:
-  metadata.gz: 56c6fe87c9ab5444d02969775ca91d1c3054d1c63ff0e12f1308984b0b5c8f06c48f3dea8cd9bfa333f79f72f3951de99d028a1f586d2f485537104300346c07
-  data.tar.gz: 309085505f26839eefdfed6a34a9d950af85013a1c161d384206e3c4a31e3156b80c1d37097d8c56dced7b10fea83715daaa10abf85e70185029e7df76fcc9d6
+  metadata.gz: e573698b449a5aef558b312c4fd0a7023d28adf2ab4210f941efc6a3025c4126cf4428ca561addf760e4e6a875696ffe6ba06d0bc0501007f663f4e59f3c0a07
+  data.tar.gz: 7c8d4771871af1dedd7440fcb670b9a50b5820fa9f09e3be5df9d2f6618002174dfaf00d7f71f6e725aecc28267b8a2263050ecbed662d3c6038a7dabd9383fe

data/.travis.yml

@@ -5,14 +5,13 @@ branches:
     - images
 
 rvm:
-#  - 2.7.0 # Need to respond to warnings for Ruby 3.0
-  - 2.6.5
-#  - 2.5.7
-#  - 2.4.9
+  - 2.7.2
+#  - 2.6.6
+#  - 2.5.8
+#  - 2.4.10 #EOL
 #  - 2.3.8 #EOL
 
 gemfile:
-  - gemfiles/Gemfile.rails-4.2
   - gemfiles/Gemfile.rails-5.0
   - gemfiles/Gemfile.rails-5.1
   - gemfiles/Gemfile.rails-5.2
@@ -27,9 +26,6 @@ env:
   - AN_ORM=dynamoid
 
 matrix:
-  exclude:
-    - gemfile: gemfiles/Gemfile.rails-4.2
-      env: AN_ORM=dynamoid
   include:
     - rvm: ruby-head
       gemfile: Gemfile
@@ -53,18 +49,12 @@ sudo: false
 
 cache: bundler
 
-before_install:
-  # Specify bundler version as '< 2.0' for Rails 4.2
-  - gem install bundler --no-document -v '1.17.3'
-
 install:
-  # Specify bundler version as '< 2.0' for Rails 4.2
-  - bundle _1.17.3_ install
+  - bundle install
   - if [ "$AN_ORM" = "dynamoid" ]; then bin/install_dynamodblocal.sh; fi
 
 before_script:
-  # Specify bundler version as '< 2.0' for Rails 4.2
-  - bundle _1.17.3_ update
+  - bundle update
   - if [ "$AN_TEST_DB" = "mysql" ]; then mysql -e 'create database activity_notification_test'; fi
   - if [ "$AN_TEST_DB" = "postgresql" ]; then psql -c 'create database activity_notification_test' -U postgres; fi
   - if [ "$AN_ORM" = "dynamoid" ]; then bin/start_dynamodblocal.sh; fi

data/CHANGELOG.md

@@ -1,3 +1,55 @@
+## 2.2.0 / 2020-12-05
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.1.4...v2.2.0)
+
+Enhancements:
+
+* Remove support for Rails 4.2 - [#151](https://github.com/simukappu/activity_notification/issues/151)
+* Turn on deprecation warnings in RSpec testing for Ruby 2.7 - [#122](https://github.com/simukappu/activity_notification/issues/122)
+* Remove Ruby 2.7 deprecation warnings - [#122](https://github.com/simukappu/activity_notification/issues/122)
+
+Breaking Changes:
+
+* Specify DynamoDB global secondary index name
+* Update additional fields to store into DynamoDB when *config.store_with_associated_records* is true
+
+## 2.1.4 / 2020-11-07
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.1.3...v2.1.4)
+
+Enhancements:
+
+* Make *Common#to_class_name* method return base_class name in order to work with STI models - [#89](https://github.com/simukappu/activity_notification/issues/89) [#139](https://github.com/simukappu/activity_notification/pull/139)
+
+Bug Fixes:
+
+* Rename *Notifiable#notification_action_cable_allowed?* to *notifiable_action_cable_allowed?* to fix duplicate method name error - [#138](https://github.com/simukappu/activity_notification/issues/138)
+* Fix hash syntax in swagger schemas - [#146](https://github.com/simukappu/activity_notification/issues/146) [#147](https://github.com/simukappu/activity_notification/pull/147)
+
+## 2.1.3 / 2020-08-11
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.1.2...v2.1.3)
+
+Enhancements:
+
+* Enable to use namespaced model - [#132](https://github.com/simukappu/activity_notification/pull/132)
+
+Bug Fixes:
+
+* Fix mongoid any_of selector error in filtered_by_group scope - [MONGOID-4887](https://jira.mongodb.org/browse/MONGOID-4887)
+
+## 2.1.2 / 2020-02-24
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.1.1...v2.1.2)
+
+Bug Fixes:
+
+* Fix scope of uniqueness validation in subscription model with mongoid - [#126](https://github.com/simukappu/activity_notification/issues/126) [#128](https://github.com/simukappu/activity_notification/pull/128)
+* Fix uninitialized constant DeviseTokenAuth when *config.eager_load = true* - [#129](https://github.com/simukappu/activity_notification/issues/129)
+
+## 2.1.1 / 2020-02-11
+[Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.1.0...v2.1.1)
+
+Bug Fixes:
+
+* Fix eager_load by autoloading VERSION - [#124](https://github.com/simukappu/activity_notification/issues/124) [#125](https://github.com/simukappu/activity_notification/pull/125)
+
 ## 2.1.0 / 2020-02-04
 [Full Changelog](http://github.com/simukappu/activity_notification/compare/v2.0.0...v2.1.0)
 

data/Gemfile

@@ -16,14 +16,13 @@ group :development do
 end
 
 group :test do
-  #TODO https://github.com/rails/rails/issues/35417
-  gem 'rspec-rails', '4.0.0.beta4'
   gem 'rails-controller-testing'
   gem 'ammeter'
   gem 'timecop'
   gem 'committee'
   gem 'committee-rails'
-  gem 'coveralls', require: false
+  # gem 'coveralls', require: false
+  gem 'coveralls_reborn', require: false
 end
 
 gem 'webpacker', groups: [:production, :development]

data/README.md

@@ -10,7 +10,7 @@
 
 *activity_notification* provides integrated user activity notifications for [Ruby on Rails](https://rubyonrails.org). 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](https://guides.rubyonrails.org/active_record_basics.html), [Mongoid](https://mongoid.org) and [Dynamoid](https://github.com/Dynamoid/dynamoid) ORM. It is tested for [MySQL](https://www.mysql.com), [PostgreSQL](https://www.postgresql.org), [SQLite3](https://www.sqlite.org) with ActiveRecord, [MongoDB](https://www.mongodb.com) with Mongoid and [Amazon DynamoDB](https://aws.amazon.com/dynamodb) with Dynamoid. The latest *activity_notification* [v2](https://rubygems.org/gems/activity_notification) is almost compatible with [v1](https://rubygems.org/gems/activity_notification/versions/1.7.1).
+*activity_notification* supports Rails 5.0+ with [ActiveRecord](https://guides.rubyonrails.org/active_record_basics.html), [Mongoid](https://mongoid.org) and [Dynamoid](https://github.com/Dynamoid/dynamoid) ORM. It is tested for [MySQL](https://www.mysql.com), [PostgreSQL](https://www.postgresql.org), [SQLite3](https://www.sqlite.org) with ActiveRecord, [MongoDB](https://www.mongodb.com) with Mongoid and [Amazon DynamoDB](https://aws.amazon.com/dynamodb) with Dynamoid. If you are using Rails 4.2, use [v2.1.4](https://rubygems.org/gems/activity_notification/versions/2.1.4) or older version of *activity_notification*.
 
 
 ## About
@@ -68,7 +68,7 @@ The deployed demo application is included in this gem's source code as a test ap
 ### Public REST API reference as OpenAPI Specification
 
 REST API reference as OpenAPI Specification is published in SwaggerHub here:
-* **https://app.swaggerhub.com/apis/simukappu/activity-notification/**
+* **https://app.swaggerhub.com/apis-docs/simukappu/activity-notification/**
 
 You can see sample single page application using [Vue.js](https://vuejs.org) as a part of example Rails application here:
 * **https://activity-notification-example.herokuapp.com/spa/**

data/activity_notification.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.required_ruby_version = '>= 2.1.0'
 
-  s.add_dependency 'railties', '>= 4.2.0', '< 6.1'
+  s.add_dependency 'railties', '>= 5.0.0', '< 6.1'
   s.add_dependency 'i18n', '>= 0.5.0'
   s.add_dependency 'jquery-rails', '>= 3.1.1'
   s.add_dependency 'swagger-blocks', '>= 3.0.0'

data/app/channels/activity_notification/notification_api_with_devise_channel.rb

@@ -24,7 +24,7 @@ if defined?(ActionCable)
       # @return [Object] Target instance (Reject subscription when request parameters are not enough)
       def set_target
         reject and return if (target_type = params[:target_type]).blank?
-        if params[:target_id].blank? && params["#{target_type.to_s.to_resource_name}_id"].blank?
+        if params[:target_id].blank? && params["#{target_type.to_s.to_resource_name[/([^\/]+)$/]}_id"].blank?
           reject and return if params[:devise_type].blank?
           current_target = find_current_target(params[:devise_type])
           params[:target_id] = target_type.to_model_class.resolve_current_devise_target(current_target)

data/app/channels/activity_notification/notification_channel.rb

@@ -22,7 +22,7 @@ if defined?(ActionCable)
         target_class = target_type.to_s.to_model_class
         @target = params[:target_id].present? ?
           target_class.find_by!(id: params[:target_id]) :
-          target_class.find_by!(id: params["#{target_type.to_s.to_resource_name}_id"])
+          target_class.find_by!(id: params["#{target_type.to_s.to_resource_name[/([^\/]+)$/]}_id"])
         rescue
         reject
       end

data/app/channels/activity_notification/notification_with_devise_channel.rb

@@ -29,7 +29,7 @@ if defined?(ActionCable)
       # @return [Object] Target instance (Reject subscription when request parameters are not enough)
       def set_target
         reject and return if (target_type = params[:target_type]).blank?
-        if params[:target_id].blank? && params["#{target_type.to_s.to_resource_name}_id"].blank?
+        if params[:target_id].blank? && params["#{target_type.to_s.to_resource_name[/([^\/]+)$/]}_id"].blank?
           reject and return if params[:devise_type].blank?
           current_target = find_current_target(params[:devise_type])
           params[:target_id] = target_type.to_model_class.resolve_current_devise_target(current_target)

data/app/controllers/activity_notification/notifications_api_with_devise_controller.rb

@@ -1,7 +1,7 @@
 module ActivityNotification
   # Controller to manage notifications API with Devise authentication.
   class NotificationsApiWithDeviseController < NotificationsApiController
-    include DeviseTokenAuth::Concerns::SetUserByToken
+    include DeviseTokenAuth::Concerns::SetUserByToken if defined?(DeviseTokenAuth)
     include DeviseAuthenticationController
   end
 end

data/app/controllers/activity_notification/notifications_controller.rb

@@ -117,26 +117,6 @@ module ActivityNotification
       super
     end
 
-    # :nocov:
-    if Rails::VERSION::MAJOR == 4
-      # Defines custom renderer class method for Rails 4.2
-      def self.renderer
-        view_context = ActionView::Base.new(ActionController::Base.view_paths, {})
-        view_context.class_eval do 
-          include Rails.application.routes.url_helpers
-          def default_url_options
-            ActionMailer::Base.default_url_options
-          end
-          def render(params = {})
-            assign(params[:assigns])
-            super(params)
-          end
-        end
-        view_context
-      end
-    end
-    # :nocov:
-
     protected
 
       # Sets @notification instance variable from request parameters.

data/app/controllers/activity_notification/subscriptions_api_controller.rb

@@ -44,7 +44,7 @@ module ActivityNotification
         params[:subscription][:optional_targets]["subscribing_to_#{optional_target_name}"] = subscribing_param unless subscribing_param.nil?
       end
       super
-      render status: 201, location: { action: :show, id: @subscription }, json: subscription_json
+      render status: 201, json: subscription_json if @subscription
     end
 
     # Finds and shows a subscription from specified key.

data/app/controllers/activity_notification/subscriptions_api_with_devise_controller.rb

@@ -1,7 +1,7 @@
 module ActivityNotification
   # Controller to manage subscriptions API with Devise authentication.
   class SubscriptionsApiWithDeviseController < SubscriptionsApiController
-    include DeviseTokenAuth::Concerns::SetUserByToken
+    include DeviseTokenAuth::Concerns::SetUserByToken if defined?(DeviseTokenAuth)
     include DeviseAuthenticationController
   end
 end

data/bin/bundle_update.sh

@@ -1,7 +1,6 @@
 #!/bin/bash
 
 bundle update
-BUNDLE_GEMFILE=gemfiles/Gemfile.rails-4.2 bundle update
 BUNDLE_GEMFILE=gemfiles/Gemfile.rails-5.0 bundle update
 BUNDLE_GEMFILE=gemfiles/Gemfile.rails-5.1 bundle update
 BUNDLE_GEMFILE=gemfiles/Gemfile.rails-5.2 bundle update

data/docs/Functions.md

@@ -65,9 +65,9 @@ config.mailer_sender = ->(key){ key == 'inquiry.post' ? 'support@example.com' :
 
 #### Email templates
 
-*activity_notification* will look for email template in a similar way as notification views, but the view file name is not start with an underscore. 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)*.
+*activity_notification* will look for email template in a similar way as notification views, but the view file name does not start with an underscore. 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)*.
+If this template is missing, the gem will use *default* as the target type which means *activity_notification/mailer/default/default.html.(|erb|haml|slim|something_else)*.
 
 #### Email subject
 
@@ -422,7 +422,7 @@ You can see [sample single page application](/spec/rails_app/app/javascript/) us
 
 OpenAPI Specification in [online demo](https://activity-notification-example.herokuapp.com/) is published here: **https://activity-notification-example.herokuapp.com/api/v2/apidocs**
 
-Public API reference is also hosted in [SwaggerHub](https://swagger.io/tools/swaggerhub/) here: **https://app.swaggerhub.com/apis/simukappu/activity-notification/**
+Public API reference is also hosted in [SwaggerHub](https://swagger.io/tools/swaggerhub/) here: **https://app.swaggerhub.com/apis-docs/simukappu/activity-notification/**
 
 You can also publish OpenAPI Specification in your own application using *[ActivityNotification::ApidocsController](/app/controllers/activity_notification/apidocs_controller.rb)* like this:
 

data/docs/Setup.md

@@ -109,76 +109,189 @@ When **store_with_associated_records** is set to *false* as default, *activity_n
 
 ```json
 {
-    "id": {
-        "S": "f05756ef-661e-4ef5-9e99-5af51243125c"
-    },
-    "target_key": {
-        "S": "User#1"
-    },
-    "notifiable_key": {
-        "S": "Comment#2"
-    },
-    "key": {
-        "S": "comment.default"
-    },
-    "group_key": {
-        "S": "Article#1"
-    },
-    "notifier_key": {
-        "S": "User#2"
-    },
-    "created_at": {
-        "N": "1560085332.689929"
-    },
-    "updated_at": {
-        "N": "1560085332.695515"
-    },
-    "parameters": {
-        "M": {}
-    }
+  "id": {
+    "S": "f05756ef-661e-4ef5-9e99-5af51243125c"
+  },
+  "target_key": {
+    "S": "User#1"
+  },
+  "notifiable_key": {
+    "S": "Comment#2"
+  },
+  "key": {
+    "S": "comment.default"
+  },
+  "group_key": {
+    "S": "Article#1"
+  },
+  "notifier_key": {
+    "S": "User#2"
+  },
+  "created_at": {
+    "S": "2020-03-08T08:22:53+00:00"
+  },
+  "updated_at": {
+    "S": "2020-03-08T08:22:53+00:00"
+  },
+  "parameters": {
+      "M": {}
+  }
 }
 ```
 
-When you set **store_with_associated_records** to *true*, *activity_notification* stores notificaion records including associated target, notifiable and notifier like this:
+When you set **store_with_associated_records** to *true*, *activity_notification* stores notificaion records including associated target, notifiable, notifier and several instance methods like this:
 
 ```json
 {
-    "id": {
-        "S": "f05756ef-661e-4ef5-9e99-5af51243125c"
-    },
-    "target_key": {
-        "S": "User#1"
-    },
-    "target_record": {
-        "S": "{\"id\":1,\"email\":\"ichiro@example.com\",\"name\":\"Ichiro\",\"created_at\":\"2019-06-09T13:10:44.853Z\",\"updated_at\":\"2019-06-09T13:10:44.853Z\"}"
-    },
-    "notifiable_key": {
-        "S": "Comment#2"
-    },
-    "notifiable_record": {
-        "S": "{\"id\":2,\"user_id\":2,\"article_id\":1,\"body\":\"This is the first Stephen's comment to Ichiro's article.\",\"created_at\":\"2019-06-09T13:10:45.677Z\",\"updated_at\":\"2019-06-09T13:10:45.677Z\"}"
-    },
-    "key": {
-        "S": "comment.default"
-    },
-    "group_key": {
-        "S": "Article#1"
-    },
-    "notifier_key": {
-        "S": "User#2"
-    },
-    "notifier_record": {
-        "S": "{\"id\":2,\"email\":\"stephen@example.com\",\"name\":\"Stephen\",\"created_at\":\"2019-06-09T13:10:45.006Z\",\"updated_at\":\"2019-06-09T13:10:45.006Z\"}"
-    },
-    "created_at": {
-        "N": "1560085332.689929"
-    },
-    "updated_at": {
-        "N": "1560085332.695515"
-    },
-    "parameters": {
-        "M": {}
+  "id": {
+    "S": "f05756ef-661e-4ef5-9e99-5af51243125c"
+  },
+  "target_key": {
+    "S": "User#1"
+  },
+  "notifiable_key": {
+    "S": "Comment#2"
+  },
+  "key": {
+    "S": "comment.default"
+  },
+  "group_key": {
+    "S": "Article#1"
+  },
+  "notifier_key": {
+    "S": "User#2"
+  },
+  "created_at": {
+    "S": "2020-03-08T08:22:53+00:00"
+  },
+  "updated_at": {
+    "S": "2020-03-08T08:22:53+00:00"
+  },
+  "parameters": {
+      "M": {}
+  },
+  "stored_target": {
+    "M": {
+      "id": {
+          "N": "1"
+      },
+      "email": {
+          "S": "ichiro@example.com"
+      },
+      "name": {
+        "S": "Ichiro"
+      },
+      "created_at": {
+        "S": "2020-03-08T08:22:23.451Z"
+      },
+      "updated_at": {
+        "S": "2020-03-08T08:22:23.451Z"
+      },
+      // { ... },
+      "printable_type": {
+          "S": "User"
+      },
+      "printable_target_name": {
+          "S": "Ichiro"
+      },
+    }
+  },
+  "stored_notifiable": {
+    "M": {
+      "id": {
+          "N": "2"
+      },
+      "user_id": {
+          "N": "2"
+      },
+      "article_id": {
+          "N": "1"
+      },
+      "body": {
+          "S": "This is the first Stephen's comment to Ichiro's article."
+      },
+      "created_at": {
+          "S": "2020-03-08T08:22:47.683Z"
+      },
+      "updated_at": {
+          "S": "2020-03-08T08:22:47.683Z"
+      },
+      "printable_type": {
+          "S": "Comment"
+      }
+    }
+  },
+  "stored_notifier": {
+    "M": {
+      "id": {
+          "N": "2"
+      },
+      "email": {
+          "S": "stephen@example.com"
+      },
+      "name": {
+          "S": "Stephen"
+      },
+      "created_at": {
+          "S": "2020-03-08T08:22:23.573Z"
+      },
+      "updated_at": {
+        "S": "2020-03-08T08:22:23.573Z"
+      },
+      // { ... },
+      "printable_type": {
+        "S": "User"
+      },
+      "printable_notifier_name": {
+          "S": "Stephen"
+      }
+    }
+  },
+  "stored_group": {
+    "M": {
+      "id": {
+        "N": "1"
+      },
+      "user_id": {
+        "N": "1"
+      },
+      "title": {
+        "S": "Ichiro's first article"
+      },
+      "body": {
+        "S": "This is the first Ichiro's article. Please read it!"
+      },
+      "created_at": {
+        "S": "2020-03-08T08:22:23.952Z"
+      },
+      "updated_at": {
+        "S": "2020-03-08T08:22:23.952Z"
+      },
+      "printable_type": {
+        "S": "Article"
+      },
+      "printable_group_name": {
+        "S": "article \"Ichiro's first article\""
+      }
     }
+  },
+  "stored_notifiable_path": {
+    "S": "/articles/1"
+  },
+  "stored_printable_notifiable_name": {
+    "S": "comment \"This is the first Stephen's comment to Ichiro's article.\""
+  },
+  "stored_group_member_notifier_count": {
+    "N": "2"
+  },
+  "stored_group_notification_count": {
+    "N": "3"
+  },
+  "stored_group_members": {
+    "L": [
+      // { ... }, { ... }, ...
+    ]
+  }
 }
 ```
 
@@ -343,6 +456,20 @@ end
 Then, you can access several pages like */users/1/notifications* and manage open/unopen of notifications using *[ActivityNotification::NotificationsController](/app/controllers/activity_notification/notifications_controller.rb)*.
 If you use Devise integration and you want to configure simple default routes for authenticated users, see [Configuring simple default routes](#configuring-simple-default-routes).
 
+#### Routes with namespaced model
+
+It is possible to configure a target model as a submodule, e.g. if your target is `Entity::User`,
+however by default the **ActivityNotification** controllers will be placed under the same namespace,
+so it is mandatory to explicitly call the controllers this way
+
+```ruby
+Rails.application.routes.draw do
+  notify_to :users, controller: '/activity_notification/notifications', target_type: 'entity/users'
+end
+```
+
+This will generate the necessary routes for the `Entity::User` target with parameters `:user_id`
+
 #### Routes with scope
 
 You can also configure *activity_notification* routes with scope like this: