global_alerts 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13ab29a8c779ca9887a3a7d5b6d2ad724682632abde1e4a6502c1aacddedd6d2
-  data.tar.gz: acfb18ef1442f1ee6d4501cd5413f81fef1d414b3b0488446606d2ac5494c927
+  metadata.gz: fd3f4670516b8090e20518f954892fba639683e2cb1c1dc77112c67417a82a7a
+  data.tar.gz: 221cf06217609ff081d19501a03b58b88e7abfb189aa33f22db9bfc6efe236fb
 SHA512:
-  metadata.gz: e6e79f72484f60eb1cd7204c9c88d446eb0045906f65cfbd73cca0cb70d5421bff1001b16c3e6aae4905843bbeb45d15ed6020375a1459932cafd594783ac0e6
-  data.tar.gz: ce1b3c97ed7fd4e5009e338b2b54fa23d51ad50b99436e96a978493efc0d638946d03b798e40b85578c2c11e270f5750b4b7bc8267df8c37070b78a367476a44
+  metadata.gz: d5913609eb9b54f302d751c9bf04017e1f39d72e89a367e9a8fef361d2f0cff49a50fed916af0ef630a2110f7f0a219b11d767faa7425b3d9c065a25f118ac9c
+  data.tar.gz: 91a55525d7d1281bcfba1c73f9d669a68029c92ecc01adaa5ff000de48b538adb63e41b1149938f279a84e70bd8d7d49267e6fef7a355df22ed6341bd5079ec6

data/README.md

@@ -2,7 +2,27 @@
 Short description and motivation.
 
 ## Usage
-How to use my plugin.
+
+### Consuming
+
+- Add the gem
+- Set any engine configuration:
+   - 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.
 
 ## Installation
 Add this line to your application's Gemfile:

data/app/models/global_alerts/alert.rb

@@ -1,3 +1,5 @@
+require 'http'
+
 module GlobalAlerts
   class Alert
     include ActiveModel::Model
@@ -8,12 +10,12 @@ module GlobalAlerts
       return to_enum(:all) unless block_given?
 
       body = cache.fetch(CACHE_KEY) do
-        # HTTP.follow.get(GlobalAlerts::Engine.config.url).body.to_s
-        File.read(GlobalAlerts::Engine.root + 'sul.yaml')
+        HTTP.follow.get(GlobalAlerts::Engine.config.url).body.to_s
       end
 
       data = YAML.safe_load(body)
-      data&.each do |yaml|
+
+      data.dig('alerts')&.each do |yaml|
         yield new(yaml)
       end
     rescue => e
@@ -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,10 @@ 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.module_parent_name.underscore
+      config.application_name ||= app.class.parent_name.underscore
     end
   end
 end

data/lib/global_alerts/version.rb

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

metadata

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