global_alerts 0.0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eda069f5366b4292b3dbd6e3f50c665c811d8ef47209234e8b0b65229e31e96
-  data.tar.gz: 860d1119003a9f9e1e85ec62c01b4df409f4ffed6b6a9368636b12523486d420
+  metadata.gz: 2b13e756e2ad666be24edad46f98b48a98b0c82f697b75d0fe8db10d0af23797
+  data.tar.gz: ccdb8b3f5421e602d91789418b657d89bd39b36317c863e7cf25853a49d4bdc3
 SHA512:
-  metadata.gz: 890d04169c6c938cd7d36e62a62cf46843f6aa15cc15e0f4cd559f6a6ed6d829b4ca1e4e4ae566e89ab6eff813132580029d00581a2b413af401b0e68416bfd6
-  data.tar.gz: 658cdbb2effb5d683a72adad53b4dc32de46f99035d3514f46f607e90ebac2f2d1eb386f229a3bf92050df7e0ee5eebb1ac7ffb8a9fc0efa9da811fd3a07750a
+  metadata.gz: 64d67a541cbd5fee1530f559ca153cda4dc39e00cbd48aeb82516b1cb312b775c26a9e313004bb76a475ead53da3be49774dfbaf7a90419a62a433e6fa4afc6d
+  data.tar.gz: bff01e26847463982b0e2b07b18a94073ba04f5e4fb4ff8cf0750f02209d86d82abed7bcbf5562b4d0a6c6df0b7de073acf2df890b72fb51e64040b122c4c751

data/README.md

@@ -1,8 +1,68 @@
 # 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
-How to use my plugin.
+
+### Consuming
+
+- Add the gem
+- 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)
+- Render the global_alerts/alerts partial
+
+### Publishing alerts
+
+In a YAML file (e.g. https://github.com/sul-dlss/global_alerts/blob/main/sul.yaml by default), configure alerts using:
+
+- `html`: the HTML-safe alert text
+- `application_name`: used for application-specific alert text; matches against the consumer's `GlobalAlerts::Engine.config.application_name`
+- `from`/`to`: schedule alerts for particular times (also supports open-ended ranges with only `from` or only `to`)
+
+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:
@@ -20,6 +80,3 @@ Or install it yourself as:
 ```bash
 $ gem install global_alerts
 ```
-
-## Contributing
-Contribution directions go here.

data/app/models/global_alerts/alert.rb

@@ -1,3 +1,5 @@
+require 'http'
+
 module GlobalAlerts
   class Alert
     include ActiveModel::Model
@@ -44,10 +46,19 @@ module GlobalAlerts
     delegate :present?, to: :html
 
     def active?(time: Time.zone.now, for_application: nil)
-      return false if for_application == application_name
+      return false if for_application != application_name
 
       return true if from.nil? && to.nil?
-      ((from.presence && Time.zone.parse(from))...(to.presence && Time.zone.parse(to))).cover?(time)
+
+      range.cover?(time)
+    end
+
+    def range
+      start_of_range = from.presence && Time.zone.parse(from)
+      start_of_range ||= Time.at(0) unless RUBY_VERSION > '2.7'
+
+      end_of_range = to.presence && Time.zone.parse(to)
+      start_of_range...end_of_range
     end
 
     def as_html

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.0.3'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: global_alerts
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Chris Beer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2021-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,7 +58,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - cabeer@stanford.edu
 executables: []
@@ -87,7 +87,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 +102,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.3
+signing_key:
 specification_version: 4
 summary: SUL global alerts as a service
 test_files: []