global_alerts 0.0.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80c6008fc3858caacc9c80d6868f6312d9428e5a1a017f1b031786d6a0b6c2dc
-  data.tar.gz: 01030bb0d1f820819ce83a591da2897731b73c3c35868b8405b43e416fdbc093
+  metadata.gz: b2d276ba651ab199596da21e5cb21f6df96f799c095a06a7df9a54f155adc6c8
+  data.tar.gz: 3edc15a256ecac67413234f6b244b44a045206e6645aa1f7cd762a656072e4a4
 SHA512:
-  metadata.gz: 8952e26ab3864ad79cd94ce744477ff64aa725edcd4096ee03c7304b52c763f134c8ae1521112131ecfda1286f577a2d3043b235e6724c9353661ca62957fdb5
-  data.tar.gz: 919a4c120b77c8379fb390478bd083cf3456f22199a050feee0fcd510127ab9eddba106503ec32796a34ba6c08c4c4478fb7170d52b8da77bc1127abc9cfd4fb
+  metadata.gz: bee7b578178af6d0151486664d193d768879dd3153967e4d96feaf69a1bca77d127557f4087fba2fcf44747f332c10be3d6c21ba7e534ed8e42c3f71bb000352
+  data.tar.gz: d8a26ecee06b70f5679e07e7fca6395979649391ddb6a44b839a7436eef3cafb98d0d7e04804165d1852ddd9f1211d7be8b59cde2f9fea894dfe525446d0dbbb

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/lib/global_alerts/engine.rb

@@ -4,10 +4,11 @@ module GlobalAlerts
 
     config.cache = nil #defaults to Rails.cache
     config.application_name = nil
-    config.url = 'https://github.com/sul-dlss/global-alerts/raw/main/sul.json'
+    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.2'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: global_alerts
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails