activity_notification 2.0.0 → 2.1.0

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

@@ -9,7 +9,7 @@
       </p>
       <div class="list_button_wrapper">
         <%= link_to 'Edit Article', edit_article_path(@article), class: "gray_button" %>
-        <%= link_to 'Destroy Article', @article, method: :delete, data: { confirm: 'Are you sure?' }, class: "gray_button" %>
+        <%#= link_to 'Destroy Article', @article, method: :delete, data: { confirm: 'Are you sure?' }, class: "gray_button" %>
       </div>
     </div>
   </div>

data/spec/rails_app/app/views/layouts/_header.html.erb

@@ -30,18 +30,16 @@
         <%#= render_notifications_of current_user, fallback: :default_without_grouping, index_content: :with_attributes, with_group_members: true %>
       <% end %>
     </div>
-    <% if user_signed_in? and current_user.admin? and respond_to?('admins_notifications_path') %>
-      <div class="header_menu_wrapper">
-        <p>
-          <%= link_to "Admin notifications", admins_notifications_path %> /
-          <%= link_to "subscriptions", admins_subscriptions_path %>
-        </p>
-      </div>
-    <% end %>
     <div class="header_menu_wrapper">
       <p>
-        <%= link_to 'Preview email', "/rails/mailers" %>
-        <%= " · " unless user_signed_in? %>
+        <%= link_to 'Preview Email', "/rails/mailers" %>
+        <%= " · " if !user_signed_in? or (current_user.admin? and respond_to?('admins_notifications_path')) %>
+      </p>
+    </div>
+    <div class="header_menu_wrapper">
+      <p>
+        <%= link_to 'SPA', "/spa/" %>
+        <%= " · " %>
       </p>
     </div>
   </div>

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

@@ -0,0 +1,2 @@
+<div id='spa'/>
+<%= javascript_pack_tag 'spa' %>

data/spec/rails_app/babel.config.js

@@ -0,0 +1,72 @@
+module.exports = function(api) {
+  var validEnv = ['development', 'test', 'production']
+  var currentEnv = api.env()
+  var isDevelopmentEnv = api.env('development')
+  var isProductionEnv = api.env('production')
+  var isTestEnv = api.env('test')
+
+  if (!validEnv.includes(currentEnv)) {
+    throw new Error(
+      'Please specify a valid `NODE_ENV` or ' +
+        '`BABEL_ENV` environment variables. Valid values are "development", ' +
+        '"test", and "production". Instead, received: ' +
+        JSON.stringify(currentEnv) +
+        '.'
+    )
+  }
+
+  return {
+    presets: [
+      isTestEnv && [
+        '@babel/preset-env',
+        {
+          targets: {
+            node: 'current'
+          }
+        }
+      ],
+      (isProductionEnv || isDevelopmentEnv) && [
+        '@babel/preset-env',
+        {
+          forceAllTransforms: true,
+          useBuiltIns: 'entry',
+          corejs: 3,
+          modules: false,
+          exclude: ['transform-typeof-symbol']
+        }
+      ]
+    ].filter(Boolean),
+    plugins: [
+      'babel-plugin-macros',
+      '@babel/plugin-syntax-dynamic-import',
+      isTestEnv && 'babel-plugin-dynamic-import-node',
+      '@babel/plugin-transform-destructuring',
+      [
+        '@babel/plugin-proposal-class-properties',
+        {
+          loose: true
+        }
+      ],
+      [
+        '@babel/plugin-proposal-object-rest-spread',
+        {
+          useBuiltIns: true
+        }
+      ],
+      [
+        '@babel/plugin-transform-runtime',
+        {
+          helpers: false,
+          regenerator: true,
+          corejs: false
+        }
+      ],
+      [
+        '@babel/plugin-transform-regenerator',
+        {
+          async: false
+        }
+      ]
+    ].filter(Boolean)
+  }
+}

data/spec/rails_app/bin/webpack

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"]  ||= "development"
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/webpack_runner"
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  Webpacker::WebpackRunner.run(ARGV)
+end

data/spec/rails_app/bin/webpack-dev-server

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"]  ||= "development"
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/dev_server_runner"
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  Webpacker::DevServerRunner.run(ARGV)
+end

data/spec/rails_app/config/application.rb

@@ -4,9 +4,10 @@ require File.expand_path('../boot', __FILE__)
 if ENV['AN_ORM'] == 'mongoid'
   require 'mongoid'
   require 'rails'
-  if Rails.env != 'test'
+  unless Rails.env.test?
     Mongoid.load!(File.expand_path("config/mongoid.yml"), :development)
   end
+# Load dynamoid configuration if necessary:
 elsif ENV['AN_ORM'] == 'dynamoid'
   require 'dynamoid'
   require 'rails'
@@ -14,7 +15,9 @@ elsif ENV['AN_ORM'] == 'dynamoid'
 end
 
 # Pick the frameworks you want:
-unless ENV['AN_ORM'] == 'mongoid' && ENV['AN_TEST_DB'] == 'mongodb'
+if ENV['AN_ORM'] == 'mongoid' && ENV['AN_TEST_DB'] == 'mongodb'
+  require "mongoid/railtie"
+else
   require "active_record/railtie"
 end
 require "action_controller/railtie"
@@ -35,6 +38,16 @@ module Dummy
     if Rails::VERSION::MAJOR >= 5 && Rails::VERSION::MINOR >= 2 && ENV['AN_TEST_DB'] != 'mongodb'
       config.active_record.sqlite3.represent_boolean_as_integer = true
     end
+
+    # Configure CORS for API mode
+    if defined?(Rack::Cors)
+      config.middleware.insert_before 0, Rack::Cors do
+        allow do
+          origins '*'
+          resource '*', :headers => :any, :methods => [:get, :post, :put, :delete]
+        end
+      end
+    end
   end
 end
 

data/spec/rails_app/config/environment.rb

@@ -1,8 +1,9 @@
 # Load the Rails application.
 require File.expand_path('../application', __FILE__)
 
-# Demo application uses Devise
+# Demo application uses Devise and Devise Token Auth
 require 'devise'
+require 'devise_token_auth'
 
 # Initialize the Rails application.
 Rails.application.initialize!

data/spec/rails_app/config/environments/development.rb

@@ -47,6 +47,11 @@ Rails.application.configure do
   # For notification email preview
   config.action_mailer.preview_path = "#{Rails.root}/lib/mailer_previews"
 
+  # Specifies delivery job for mail
+  if Rails::VERSION::MAJOR >= 6
+    config.action_mailer.delivery_job = "ActionMailer::MailDeliveryJob"
+  end
+
   # Configration for bullet
   config.after_initialize do
     Bullet.enable = true

data/spec/rails_app/config/environments/production.rb

@@ -64,6 +64,9 @@ Rails.application.configure do
   # Set this to true and configure the email server for immediate delivery to raise delivery errors.
   # config.action_mailer.raise_delivery_errors = false
 
+  # Specifies delivery job for mail
+  config.action_mailer.delivery_job = "ActionMailer::MailDeliveryJob"
+  
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
   # the I18n.default_locale when a translation cannot be found).
   config.i18n.fallbacks = true

data/spec/rails_app/config/environments/test.rb

@@ -54,4 +54,9 @@ Rails.application.configure do
 
   # Set default_url_options for devise and notification email.
   config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+
+  # Specifies delivery job for mail
+  if Rails::VERSION::MAJOR >= 6
+    config.action_mailer.delivery_job = "ActionMailer::MailDeliveryJob"
+  end
 end

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

@@ -71,6 +71,11 @@ ActivityNotification.configure do |config|
   # Set true when you want to turn on WebSocket subscription using ActionCable as default.
   config.action_cable_enabled = false
 
+  # Configure if WebSocket API subscription using ActionCable is enabled.
+  # Note that you can configure them for each model by acts_as roles.
+  # Set true when you want to turn on WebSocket API subscription using ActionCable as default.
+  config.action_cable_api_enabled = false
+
   # Configure if ctivity_notification publishes WebSocket notifications using ActionCable only to authenticated target with Devise.
   # Note that you can configure them for each model by acts_as roles.
   # Set true when you want to use Device integration with WebSocket subscription using ActionCable as default.
@@ -79,4 +84,7 @@ ActivityNotification.configure do |config|
   # Configure notification channel prefix for ActionCable.
   config.notification_channel_prefix = 'activity_notification_channel'
 
+  # Configure notification API channel prefix for ActionCable.
+  config.notification_api_channel_prefix = 'activity_notification_api_channel'
+
 end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+DeviseTokenAuth.setup do |config|
+  # By default the authorization headers will change after each request. The
+  # client is responsible for keeping track of the changing tokens. Change
+  # this to false to prevent the Authorization header from changing after
+  # each request.
+  config.change_headers_on_each_request = false
+
+  # By default, users will need to re-authenticate after 2 weeks. This setting
+  # determines how long tokens will remain valid after they are issued.
+  config.token_lifespan = 1.hour
+
+  # Limiting the token_cost to just 4 in testing will increase the performance of
+  # your test suite dramatically. The possible cost value is within range from 4
+  # to 31. It is recommended to not use a value more than 10 in other environments.
+  config.token_cost = Rails.env.test? ? 4 : 10
+
+  # Sets the max number of concurrent devices per user, which is 10 by default.
+  # After this limit is reached, the oldest tokens will be removed.
+  # config.max_number_of_devices = 10
+
+  # Sometimes it's necessary to make several requests to the API at the same
+  # time. In this case, each request in the batch will need to share the same
+  # auth token. This setting determines how far apart the requests can be while
+  # still using the same auth token.
+  # config.batch_request_buffer_throttle = 5.seconds
+
+  # This route will be the prefix for all oauth2 redirect callbacks. For
+  # example, using the default '/omniauth', the github oauth2 provider will
+  # redirect successful authentications to '/omniauth/github/callback'
+  # config.omniauth_prefix = "/omniauth"
+
+  # By default sending current password is not needed for the password update.
+  # Uncomment to enforce current_password param to be checked before all
+  # attribute updates. Set it to :password if you want it to be checked only if
+  # password is updated.
+  # config.check_current_password_before_update = :attributes
+
+  # By default we will use callbacks for single omniauth.
+  # It depends on fields like email, provider and uid.
+  # config.default_callbacks = true
+
+  # Makes it possible to change the headers names
+  # config.headers_names = {:'access-token' => 'access-token',
+  #                        :'client' => 'client',
+  #                        :'expiry' => 'expiry',
+  #                        :'uid' => 'uid',
+  #                        :'token-type' => 'token-type' }
+
+  # By default, only Bearer Token authentication is implemented out of the box.
+  # If, however, you wish to integrate with legacy Devise authentication, you can
+  # do so by enabling this flag. NOTE: This feature is highly experimental!
+  # config.enable_standard_devise_support = false
+end

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,46 @@
 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]
+    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