activity_notification 2.0.0 → 2.1.4

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

@@ -0,0 +1,9 @@
+# Creates DATETIME(3) column types by default which support microseconds.
+# Without it, only regular (second precise) DATETIME columns are created.
+if defined?(ActiveRecord)
+  module ActiveRecord::ConnectionAdapters
+    if defined?(AbstractMysqlAdapter)
+      AbstractMysqlAdapter::NATIVE_DATABASE_TYPES[:datetime][:limit] = 3
+    end
+  end
+end

data/spec/rails_app/config/locales/activity_notification.en.yml

@@ -7,9 +7,9 @@ en:
         create:
           text: 'Article has been created'
         update:
-          text: 'Article %{article_title} has been updated'
+          text: 'Article "%{article_title}" has been updated'
         destroy:
-          text: 'Some user removed an article!'
+          text: 'The author removed an article "%{article_title}"'
       comment:
         create:
           text: '%{notifier_name} posted a comment on the article "%{article_title}"'

data/spec/rails_app/config/routes.rb

@@ -1,14 +1,50 @@
 Rails.application.routes.draw do
+  # Routes for example Rails application
   root to: 'articles#index'
   devise_for :users
-  resources :articles
+  resources :articles, except: [:destroy]
   resources :comments, only: [:create, :destroy]
 
+  # activity_notification routes for users
   notify_to :users, with_subscription: true
   notify_to :users, with_devise: :users, devise_default_routes: true, with_subscription: true
 
+  # activity_notification routes for admins
   notify_to :admins, with_devise: :users, with_subscription: true
   scope :admins, as: :admins do
     notify_to :admins, with_devise: :users, devise_default_routes: true, with_subscription: true, routing_scope: :admins
   end
+
+  # Routes for single page application working with activity_notification REST API backend
+  resources :spa, only: [:index]
+  namespace :api do
+    scope :"v#{ActivityNotification::GEM_VERSION::MAJOR}" do
+      mount_devise_token_auth_for 'User', at: 'auth'
+    end
+  end
+
+  # Routes of activity_notification REST API backend for users
+  scope :api do
+    scope :"v#{ActivityNotification::GEM_VERSION::MAJOR}" do
+      notify_to :users, api_mode: true, with_subscription: true
+      notify_to :users, api_mode: true, with_devise: :users, devise_default_routes: true, with_subscription: true
+      resources :apidocs, only: [:index], controller: 'activity_notification/apidocs'
+      resources :users, only: [:index, :show] do
+        collection do
+          get :find
+        end
+      end
+    end
+  end
+
+  # Routes of activity_notification REST API backend for admins
+  scope :api do
+    scope :"v#{ActivityNotification::GEM_VERSION::MAJOR}" do
+      notify_to :admins, api_mode: true, with_devise: :users, with_subscription: true
+      scope :admins, as: :admins do
+        notify_to :admins, api_mode: true, with_devise: :users, devise_default_routes: true, with_subscription: true
+      end
+      resources :admins, only: [:index, :show]
+    end
+  end
 end

data/spec/rails_app/config/webpack/development.js

@@ -0,0 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
+const environment = require('./environment')
+
+module.exports = environment.toWebpackConfig()

data/spec/rails_app/config/webpack/environment.js

@@ -0,0 +1,7 @@
+const { environment } = require('@rails/webpacker')
+const { VueLoaderPlugin } = require('vue-loader')
+const vue = require('./loaders/vue')
+
+environment.plugins.prepend('VueLoaderPlugin', new VueLoaderPlugin())
+environment.loaders.prepend('vue', vue)
+module.exports = environment

data/spec/rails_app/config/webpack/loaders/vue.js

@@ -0,0 +1,6 @@
+module.exports = {
+  test: /\.vue(\.erb)?$/,
+  use: [{
+    loader: 'vue-loader'
+  }]
+}

data/spec/rails_app/config/webpack/production.js

@@ -0,0 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'production'
+
+const environment = require('./environment')
+
+module.exports = environment.toWebpackConfig()

data/spec/rails_app/config/webpack/test.js

@@ -0,0 +1,5 @@
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
+const environment = require('./environment')
+
+module.exports = environment.toWebpackConfig()

data/spec/rails_app/config/webpacker.yml

@@ -0,0 +1,97 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: packs
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/cache/webpacker
+  check_yarn_integrity: false
+  webpack_compile_output: true
+
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  resolved_paths: []
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  # Extract and emit a css file
+  extract_css: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+    - .eot
+    - .otf
+    - .ttf
+    - .woff
+    - .woff2
+
+  extensions:
+    - .vue
+    - .mjs
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .svg
+    - .gif
+    - .jpeg
+    - .jpg
+
+development:
+  <<: *default
+  compile: true
+
+  # Verifies that correct packages and versions are installed by inspecting package.json, yarn.lock, and node_modules
+  check_yarn_integrity: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    # Inline should be set to true if using HMR
+    inline: true
+    overlay: true
+    compress: true
+    disable_host_check: true
+    use_local_ip: false
+    quiet: false
+    pretty: false
+    headers:
+      'Access-Control-Allow-Origin': '*'
+    watch_options:
+      ignored: '**/node_modules/**'
+
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Extract and emit a css file
+  extract_css: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true

data/spec/rails_app/db/migrate/20191201000000_add_tokens_to_users.rb

@@ -0,0 +1,10 @@
+class AddTokensToUsers < ActiveRecord::Migration[5.2]
+  def change
+    ## Required
+    add_column :users, :provider, :string, null: false, default: "email"
+    add_column :users, :uid, :string, null: false, default: ""
+
+    ## Tokens
+    add_column :users, :tokens, :text
+  end
+end

data/spec/rails_app/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2018_12_09_000000) do
+ActiveRecord::Schema.define(version: 2019_12_01_000000) do
 
   create_table "admins", force: :cascade do |t|
     t.integer "user_id"
@@ -89,6 +89,9 @@ ActiveRecord::Schema.define(version: 2018_12_09_000000) do
     t.string "name"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.string "provider", default: "email", null: false
+    t.string "uid", default: "", null: false
+    t.text "tokens"
     t.index ["email"], name: "index_users_on_email"
   end
 

data/spec/rails_app/db/seeds.rb

@@ -2,8 +2,15 @@
 # This file is seed file for test data on development environment.
 
 def clean_database
-  [ActivityNotification::Notification, ActivityNotification::Subscription, Comment, Article, Admin, User].each do |model_class|
-    model_class.delete_all
+  models = [Comment, Article, Admin, User]
+  if ENV['AN_USE_EXISTING_DYNAMODB_TABLE']
+    ActivityNotification::Notification.where('id.not_null': true).delete_all
+    ActivityNotification::Subscription.where('id.not_null': true).delete_all
+  else
+    models.concat([ActivityNotification::Notification, ActivityNotification::Subscription])
+  end
+  models.each do |model|
+    model.delete_all
   end
 end
 
@@ -68,6 +75,7 @@ puts "* Created #{Article.count} article records"
 notifications = ActivityNotification::Notification.filtered_by_type("Article")
 puts "** Generated #{ActivityNotification::Notification.filtered_by_type("Article").count} notification records for new articles"
 puts "*** #{ActivityNotification::Notification.filtered_by_type("Article").filtered_by_target_type("User").count} notifications as #{ActivityNotification::Notification.filtered_by_type("Article").filtered_by_target_type("User").group_owners_only.count} groups to users"
+puts "*** #{ActivityNotification::Notification.filtered_by_type("Article").filtered_by_target_type("Admin").count} notifications as #{ActivityNotification::Notification.filtered_by_type("Article").filtered_by_target_type("Admin").group_owners_only.count} groups to admins"
 
 Article.all.each do |article|
   User.all.each do |user|

data/spec/rails_app/lib/custom_optional_targets/raise_error.rb

@@ -0,0 +1,14 @@
+module CustomOptionalTarget
+  # Optional target implementation to raise error.
+  class RaiseError < ActivityNotification::OptionalTarget::Base
+    def initialize_target(options = {})
+      @raise_error = options[:raise_error] == false ? false : true
+    end
+
+    def notify(notification, options = {})
+      if @raise_error
+        raise 'Intentional RuntimeError in CustomOptionalTarget::RaiseError'
+      end
+    end
+  end
+end

data/spec/rails_app/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "activity_notification",
+  "description": "Sample single page application for activity_notification using Vue.js",
+  "dependencies": {
+    "@rails/webpacker": "^4.2.0",
+    "axios": "^0.19.0",
+    "vue": "^2.6.10",
+    "vuex": "^3.1.2",
+    "vuex-persistedstate": "^2.7.0",
+    "vue-loader": "^15.7.2",
+    "vue-router": "^3.1.3",
+    "vue-template-compiler": "^2.6.10",
+    "vue-moment": "^4.1.0",
+    "vue-moment-tz": "^2.1.1",
+    "vue-pluralize": "^0.0.2",
+    "actioncable-vue": "^1.5.1",
+    "push.js": "^1.0.12"
+  },
+  "devDependencies": {
+    "webpack-dev-server": "^3.9.0"
+  },
+  "license": "MIT"
+}

data/spec/rails_app/postcss.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  plugins: [
+    require('postcss-import'),
+    require('postcss-flexbugs-fixes'),
+    require('postcss-preset-env')({
+      autoprefixer: {
+        flexbox: 'no-2009'
+      },
+      stage: 3
+    })
+  ]
+}

data/spec/roles/acts_as_group_spec.rb

@@ -18,8 +18,6 @@ describe ActivityNotification::ActsAsGroup do
           expect(dummy_model_class.acts_as_group).to eq({})
         end
       end
-
-      #TODO test other options
     end
 
     describe ".available_group_options" do

data/spec/roles/acts_as_notifiable_spec.rb

@@ -54,7 +54,7 @@ describe ActivityNotification::ActsAsNotifiable do
 
         context "true as :tracked" do
           before do
-            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: true
+            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: true, notifiable_path: -> { "dummy_path" }
             @created_notifiable = dummy_notifiable_class.create
           end
 
@@ -103,7 +103,7 @@ describe ActivityNotification::ActsAsNotifiable do
 
         context "with :only option (creation only)" do
           before do
-            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: { only: [:create] }
+            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: { only: [:create] }, notifiable_path: -> { "dummy_path" }
             @created_notifiable = dummy_notifiable_class.create
           end
 
@@ -133,7 +133,7 @@ describe ActivityNotification::ActsAsNotifiable do
 
         context "with :except option (except update)" do
           before do
-            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: { except: [:update] }
+            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: { except: [:update] }, notifiable_path: -> { "dummy_path" }
             @created_notifiable = dummy_notifiable_class.create
           end
 
@@ -163,7 +163,7 @@ describe ActivityNotification::ActsAsNotifiable do
 
         context "with :key option" do
           before do
-            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: { key: "test.key" }
+            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: { key: "test.key" }, notifiable_path: -> { "dummy_path" }
             @created_notifiable = dummy_notifiable_class.create
           end
 
@@ -199,7 +199,7 @@ describe ActivityNotification::ActsAsNotifiable do
         context "with :notify_later option" do
           before do
             ActiveJob::Base.queue_adapter = :test
-            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: { notify_later: true }
+            dummy_notifiable_class.acts_as_notifiable :users, targets: [user_target], tracked: { notify_later: true }, notifiable_path: -> { "dummy_path" }
             @created_notifiable = dummy_notifiable_class.create
           end
 
@@ -420,14 +420,12 @@ describe ActivityNotification::ActsAsNotifiable do
           end
         end
       end
-
-      #TODO test other options
     end
 
     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, :group_expiry_delay, :notifier, :parameters, :email_allowed, :action_cable_allowed, :notifiable_path, :printable_notifiable_name, :printable_name, :dependent_notifications, :optional_targets])
+          .to eq([:targets, :group, :group_expiry_delay, :notifier, :parameters, :email_allowed, :action_cable_allowed, :action_cable_api_allowed, :notifiable_path, :printable_notifiable_name, :printable_name, :dependent_notifications, :optional_targets])
       end
     end
   end

data/spec/roles/acts_as_notifier_spec.rb

@@ -18,8 +18,6 @@ describe ActivityNotification::ActsAsNotifier do
           expect(dummy_model_class.acts_as_notifier).to eq({})
         end
       end
-
-      #TODO test other options
     end
 
     describe ".available_notifier_options" do

data/spec/roles/acts_as_target_spec.rb

@@ -18,14 +18,10 @@ describe ActivityNotification::ActsAsTarget do
           expect(dummy_model_class.acts_as_target).to eq({})
         end
       end
-
-      #TODO test other options
     end
 
     describe ".acts_as_notification_target" do
       it "is an alias of acts_as_target" do
-        #TODO make better way to test alias
-        #expect(dummy_model_class.acts_as_notification_target).to receive(:acts_as_target)
         expect(dummy_model_class.respond_to?(:acts_as_notification_target)).to be_truthy
       end
     end

data/spec/spec_helper.rb

@@ -14,30 +14,22 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [
 SimpleCov.start('rails') do
   add_filter '/spec/'
   add_filter '/lib/generators/templates/'
-  add_filter '/lib/activity_notification/version.rb'
-  if Rails::VERSION::MAJOR >= 5
-    skip_token_tag = 'except-rails5-plus'
-  else
-    skip_token_tag = 'only-rails5-plus'
-    add_filter '/app/channels/activity_notification/'
-  end
-  if Gem::Version.new("5.1.6") <= Rails.gem_version && Rails.gem_version < Gem::Version.new("5.2.2")
-    skip_token_tag += '#only-rails-without-callback-issue'
-  else
-    skip_token_tag += '#only-rails-with-callback-issue'
-  end
+  add_filter '/lib/activity_notification/version'
   if ENV['AN_ORM'] == 'mongoid'
     add_filter '/lib/activity_notification/orm/active_record'
     add_filter '/lib/activity_notification/orm/dynamoid'
   elsif ENV['AN_ORM'] == 'dynamoid'
     add_filter '/lib/activity_notification/orm/active_record'
     add_filter '/lib/activity_notification/orm/mongoid'
-    skip_token_tag += '#except-dynamoid'
   else
     add_filter '/lib/activity_notification/orm/mongoid'
     add_filter '/lib/activity_notification/orm/dynamoid'
   end
-  skip_token skip_token_tag
+  if Rails::VERSION::MAJOR < 5
+    add_filter '/app/channels/'
+    add_filter '/lib/activity_notification/optional_targets/action_cable_channel'
+    add_filter '/lib/activity_notification/optional_targets/action_cable_api_channel'
+  end
 end
 
 # Dummy application
@@ -59,7 +51,7 @@ end
 
 RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
-  config.before(:all) do
+  config.before(:each) do
     FactoryBot.reload
     clean_database
   end