global_alerts 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd3f4670516b8090e20518f954892fba639683e2cb1c1dc77112c67417a82a7a
-  data.tar.gz: 221cf06217609ff081d19501a03b58b88e7abfb189aa33f22db9bfc6efe236fb
+  metadata.gz: 6007837f7de40972e221132425424184910e894b42964fa812ac0e0780aff32f
+  data.tar.gz: a3f606c12ae564f17cc4df240126abf848441e13656b518312e8f6947438b817
 SHA512:
-  metadata.gz: d5913609eb9b54f302d751c9bf04017e1f39d72e89a367e9a8fef361d2f0cff49a50fed916af0ef630a2110f7f0a219b11d767faa7425b3d9c065a25f118ac9c
-  data.tar.gz: 91a55525d7d1281bcfba1c73f9d669a68029c92ecc01adaa5ff000de48b538adb63e41b1149938f279a84e70bd8d7d49267e6fef7a355df22ed6341bd5079ec6
+  metadata.gz: 2545b85c009f505403b7772daceac3fdbda17e968a61950b5869cf9021132515ab8287ce5de24e9b51d286ec408c8abb38a5293f858a8ebd41423024c106b2ab
+  data.tar.gz: 9e04a6d7f03bc4885af220c5ea6b421f2ed15e192ab9c2109b48607496137d2d044fd40ddf1f88b5d04a069de9b99ef78c866ea7f9f0fd5a45b8019b92b04905

data/README.md

@@ -1,12 +1,14 @@
 # GlobalAlerts
-Short description and motivation.
+A gem for managing user-facing alerts across the portfolio. 
+⚠️[See current alerts](https://github.com/sul-dlss/global_alerts/blob/main/sul.yaml)
 
 ## Usage
 
 ### Consuming
 
 - Add the gem
-- Set any engine configuration:
+- Set GLOBAL_ALERTS to `<%= true %>` in the application settings.
+- Set any engine configuration in the consuming application's initializers:
    - GlobalAlerts::Engine.config.cache (Cache for the alerts feed; defaults to the Rails cache)
    - GlobalAlerts::Engine.config.application_name (Used for app-specific alerts, default is derived from the application name)
    - GlobalAlerts::Engine.config.url (URL to pull alerts from)
@@ -24,6 +26,44 @@ Consuming applications will pick only the first relevant alert.
 
 Restart any consuming applications.
 
+### Example Alerts
+
+#### Basic alert
+```
+alerts:
+   - html: A single <em>sample alert</em> across all apps. This will appear until manually removed from the YML file.
+```
+
+#### `to`
+```
+alerts:
+   - to: '2020-12-07T12:00:00-07:00'
+     html: This message will appear immediately and will expire on December 7th at noon.
+```
+
+#### `from`
+```
+alerts:
+   - from: '2020-12-07T12:00:00-07:00'
+     html: This message will begin on December 7th at noon and must be manually removed.
+```
+#### `from` and `to`
+```
+alerts:
+   - from: '2020-12-24T12:00:00-07:00'
+     to: '2020-12-25T12:00:00-07:00'
+     html: This message will appear from December 24th at noon and expire on December 25th at noon. This YML should be removed later.
+```
+
+#### `application_name`
+```
+alerts:
+   - application_name: 'MyLibrary
+     html: This message will appear on MyLibrary until manually removed.
+   - html: This alert will appear on all other applications with GLOBAL_ALERTS enabled
+```
+
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -40,6 +80,3 @@ Or install it yourself as:
 ```bash
 $ gem install global_alerts
 ```
-
-## Contributing
-Contribution directions go here.

data/Rakefile

@@ -14,9 +14,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
-
 load 'rails/tasks/statistics.rake'
 
 require 'bundler/gem_tasks'

data/config/initializers/global_alerts_initializer.rb

@@ -1 +1,3 @@
-GlobalAlerts::Alert.cache.delete(GlobalAlerts::Alert::CACHE_KEY)
+Rails.application.reloader.to_prepare do
+  GlobalAlerts::Alert.cache.delete(GlobalAlerts::Alert::CACHE_KEY)
+end

data/lib/global_alerts/engine.rb

@@ -7,7 +7,8 @@ module GlobalAlerts
     config.url = 'https://github.com/sul-dlss/global-alerts/raw/main/sul.yaml'
 
     initializer('global_alerts_default') do |app|
-      config.application_name ||= app.class.parent_name.underscore
+      # parent_name is deprecated in Rails 6.1
+      config.application_name ||= app.class.respond_to?(:parent_name) ? app.class.parent_name.underscore : app.class.module_parent_name.underscore
     end
   end
 end

data/lib/global_alerts/version.rb

@@ -1,3 +1,3 @@
 module GlobalAlerts
-  VERSION = '0.2.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: global_alerts
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Beer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -58,7 +58,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
 - cabeer@stanford.edu
 executables: []
@@ -87,7 +101,7 @@ homepage: https://github.com/sul-dlss/global_alerts
 licenses:
 - Apache 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,8 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: SUL global alerts as a service
 test_files: []