global_alerts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13ab29a8c779ca9887a3a7d5b6d2ad724682632abde1e4a6502c1aacddedd6d2
+  data.tar.gz: acfb18ef1442f1ee6d4501cd5413f81fef1d414b3b0488446606d2ac5494c927
+SHA512:
+  metadata.gz: e6e79f72484f60eb1cd7204c9c88d446eb0045906f65cfbd73cca0cb70d5421bff1001b16c3e6aae4905843bbeb45d15ed6020375a1459932cafd594783ac0e6
+  data.tar.gz: ce1b3c97ed7fd4e5009e338b2b54fa23d51ad50b99436e96a978493efc0d638946d03b798e40b85578c2c11e270f5750b4b7bc8267df8c37070b78a367476a44

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2020 The Board of Trustees of the Leland Stanford Junior University.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,25 @@
+# GlobalAlerts
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'global_alerts'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install global_alerts
+```
+
+## Contributing
+Contribution directions go here.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GlobalAlerts'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  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'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/global_alerts_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/global_alerts .css

data/app/assets/stylesheets/global_alerts/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/global_alerts/application_controller.rb

@@ -0,0 +1,5 @@
+module GlobalAlerts
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/global_alerts/application_helper.rb

@@ -0,0 +1,4 @@
+module GlobalAlerts
+  module ApplicationHelper
+  end
+end

data/app/jobs/global_alerts/application_job.rb

@@ -0,0 +1,4 @@
+module GlobalAlerts
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/global_alerts/application_mailer.rb

@@ -0,0 +1,6 @@
+module GlobalAlerts
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/global_alerts/alert.rb

@@ -0,0 +1,57 @@
+module GlobalAlerts
+  class Alert
+    include ActiveModel::Model
+
+    CACHE_KEY = 'global-alerts'
+
+    def self.all
+      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')
+      end
+
+      data = YAML.safe_load(body)
+      data&.each do |yaml|
+        yield new(yaml)
+      end
+    rescue => e
+      Rails.logger.warn(e)
+      raise(e) if Rails.env.development?
+
+      []
+    end
+
+    def self.active(time = Time.zone.now)
+      active_alert = all.find do |alert|
+        alert.active?(time: time, for_application: GlobalAlerts::Engine.config.application_name)
+      end
+
+      active_alert ||= all.find do |alert|
+        alert.active?(time: time)
+      end
+
+      active_alert
+    end
+
+    def self.cache
+      GlobalAlerts::Engine.config.cache || Rails.cache
+    end
+
+    attr_accessor :html, :from, :to, :application_name
+
+    delegate :present?, to: :html
+
+    def active?(time: Time.zone.now, for_application: nil)
+      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)
+    end
+
+    def as_html
+      html.html_safe
+    end
+  end
+end

data/app/models/global_alerts/application_record.rb

@@ -0,0 +1,5 @@
+module GlobalAlerts
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/global_alerts/_alerts.html.erb

@@ -0,0 +1,7 @@
+<% alert = GlobalAlerts::Alert.active %>
+
+<% if alert.present? %>
+  <div class="global-alert">
+    <%= alert.as_html %>
+  </div>
+<% end %>

data/config/initializers/global_alerts_initializer.rb

@@ -0,0 +1 @@
+GlobalAlerts::Alert.cache.delete(GlobalAlerts::Alert::CACHE_KEY)

data/config/routes.rb

@@ -0,0 +1,2 @@
+GlobalAlerts::Engine.routes.draw do
+end

data/lib/global_alerts.rb

@@ -0,0 +1,5 @@
+require "global_alerts/engine"
+
+module GlobalAlerts
+  # Your code goes here...
+end

data/lib/global_alerts/engine.rb

@@ -0,0 +1,13 @@
+module GlobalAlerts
+  class Engine < ::Rails::Engine
+    isolate_namespace 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'
+
+    initializer('global_alerts_default') do |app|
+      config.application_name ||= app.class.module_parent_name.underscore
+    end
+  end
+end

data/lib/global_alerts/version.rb

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

data/lib/tasks/global_alerts_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :global_alerts do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: global_alerts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/global_alerts_manifest.js
+- app/assets/stylesheets/global_alerts/application.css
+- app/controllers/global_alerts/application_controller.rb
+- app/helpers/global_alerts/application_helper.rb
+- app/jobs/global_alerts/application_job.rb
+- app/mailers/global_alerts/application_mailer.rb
+- app/models/global_alerts/alert.rb
+- app/models/global_alerts/application_record.rb
+- app/views/global_alerts/_alerts.html.erb
+- config/initializers/global_alerts_initializer.rb
+- config/routes.rb
+- lib/global_alerts.rb
+- lib/global_alerts/engine.rb
+- lib/global_alerts/version.rb
+- lib/tasks/global_alerts_tasks.rake
+homepage: https://github.com/sul-dlss/global_alerts
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: SUL global alerts as a service
+test_files: []