openstax_utilities 4.3.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc7366a73ada7f334bd42ca06e41c0043f92e0d2aff08969f5ec1759275b1885
-  data.tar.gz: 86fa1a1dbe2f4c8521afb1b6ce635b63c8c2140e6656de3028887fd22d7872d1
+  metadata.gz: 23e87d67c828892be99027a2ab746eb1399cbf8a806705fa985e462d9d42d7fd
+  data.tar.gz: 25567a40d96ad15ebb84d0d9a2f8902bc3d702a2248ea1ce0e72274f56489355
 SHA512:
-  metadata.gz: 26555b0e6c39c6cc7c3615d6e948849cce15aa9ff67ebafb5fad260ddb408a8003598b2e588f10ea1c2ed55256ade08a223ad92517b8fcc45adfeb8976583322
-  data.tar.gz: c36765470b6f808e37e2145538b49b56312568ea9ddc73f8329c94e7eb593ecaa8fa5bd09f999db6e7deda74a6792a8c85fdfa4bd2e850a63239de85fbaebd4d
+  metadata.gz: 8cb88e2b59504aa7eadea2a6fad09fc6b1e33250c790781ca99a953218c0a4e2192207279c4a0d9a3153d0d1532eac31ce4c4e7fe96363c3ea2be797dcb9b6c5
+  data.tar.gz: d7da39d27d6f853a6d92c19d79011b742b4e5e3429b7ebbbcb5fa6e321484265df3339c12299f8c92f0a327470b7cbc76b62903286d581a4d65543386548b3b1

data/README.md

@@ -1,7 +1,7 @@
 OpenStax Utilities
 ==================
 
-[![Build Status](https://travis-ci.org/openstax/openstax_utilities.svg?branch=master)](https://travis-ci.org/openstax/openstax_utilities)
+[![Tests](https://github.com/openstax/openstax_utilities/workflows/Tests/badge.svg)](https://github.com/openstax/openstax_utilities/actions?query=workflow:Tests)
 [![Code Climate](https://codeclimate.com/github/openstax/openstax_utilities.png)](https://codeclimate.com/github/openstax/openstax_utilities)
 
 A set of common utilities for the various OpenStax projects.

data/app/controllers/openstax/utilities/status_controller.rb

@@ -0,0 +1,82 @@
+require 'aws-sdk-autoscaling'
+
+class OpenStax::Utilities::StatusController < ActionController::Base
+  before_action :authenticate
+
+  layout 'openstax/utilities/status'
+
+  def index
+    @application_name = Rails.application.class.parent_name
+    @environment_name = Rails.application.secrets.environment_name
+
+    @statuses = if @environment_name == 'development'
+      [ [ 'local', 1, 1, :ok ] ]
+    else
+      queues = Module.const_defined?(:Delayed) && Delayed.const_defined?(:Worker) ?
+        Delayed::Worker.queue_attributes.keys.map(&:to_s) - [ 'migration' ] : []
+      asgs = [ 'migration', 'web', 'cron', 'background' ] + queues.map do |queue|
+        "background-#{queue}"
+      end
+
+      Aws::AutoScaling::Client.new.describe_auto_scaling_groups(
+        auto_scaling_group_names: asgs.map do |asg|
+          "#{@environment_name}-#{@application_name.downcase}-#{asg}-asg"
+        end
+      ).auto_scaling_groups.map do |asg|
+        name = asg.auto_scaling_group_name.sub(
+          "#{@environment_name}-#{@application_name.downcase}-", ''
+        ).chomp('-asg')
+
+        status = if asg.desired_capacity == 0
+          if [ 'web', 'background', 'cron' ].include?(name)
+            :configuration_error
+          elsif asg.instances.size > 0
+            :shutting_down
+          else
+            :sleeping
+          end
+        elsif asg.instances.all? do |instance|
+                instance.health_status != 'Healthy' || instance.lifecycle_state != 'InService'
+              end
+          case name
+          when 'web'
+            :down
+          when 'background', 'cron'
+            :impacted
+          else
+            :offline
+          end
+        elsif name == 'migration'
+          :migrating
+        elsif asg.max_size > 1 && asg.desired_capacity == asg.max_size
+          :at_capacity
+        elsif asg.instances.size < asg.desired_capacity
+          :scaling_up
+        elsif asg.instances.size > asg.desired_capacity
+          :scaling_down
+        else
+          :ok
+        end
+
+        [ name, asg.instances.size, asg.max_size, status ]
+      end.sort_by do |name, _, _, _|
+        case name
+        when 'migration'
+          '0'
+        when 'web'
+          '1'
+        when 'cron'
+          '2'
+        else
+          "3#{name}"
+        end
+      end
+    end
+  end
+
+  protected
+
+  def authenticate
+    instance_exec &OpenStax::Utilities.configuration.status_authenticate
+  end
+end

data/app/views/layouts/openstax/utilities/status.html.erb

@@ -0,0 +1,24 @@
+<% title = "OpenStax #{@application_name} (#{@environment_name}) Status" %>
+
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= title %></title>
+    <meta name="robots" content="noindex">
+    <meta http-equiv="content-type" content="text/html; charset=UTF8" />
+
+    <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+    <%= csrf_meta_tags %>
+  </head>
+
+  <body id="status" class="status">
+    <div class="body">
+      <div class="body-container" style="margin-left: 16px;">
+        <header><h2><%= title %></h2></header>
+
+        <%= yield %>
+      </div>
+    </div>
+  </body>
+</html>

data/app/views/openstax/utilities/status/index.html.erb

@@ -0,0 +1,52 @@
+<%
+  status_icons = {
+    configuration_error: '💀',
+    down: '💥',
+    impacted: '⚠️',
+    at_capacity: '🥵',
+    migrating: '💾',
+    scaling_down: '📉',
+    scaling_up: '📈',
+    ok: '✅',
+    shutting_down: '😪',
+    offline: '🔌',
+    sleeping: '💤'
+  }
+
+  backend = @application_name == 'Tutor' ? 'tutor-server' : @application_name.downcase
+%>
+
+<h3>Versions</h3>
+
+<ul>
+  <li>
+    Backend (<%= backend %>): <%= Rails.application.secrets.release_version || 'not deployed' %>
+  </li>
+  <li>
+    Frontend (tutor-js): <%= OpenStax::Utilities::Assets.manifest.version || 'not deployed' %>
+  </li>
+  <li>
+    Deployment (tutor-deployment): <%=
+      Rails.application.secrets.deployment_version || 'not deployed'
+    %>
+  </li>
+</ul>
+
+<% status = status_icons.find { |key, _| @statuses.any? { |_, _, _, status| status == key } } %>
+<h3>Status: <% unless status.nil? %><span title="<%=
+  status.first.to_s.humanize
+%>"><%= status.second %></span><% end %></h3>
+
+<ul>
+  <% @statuses.map do |name, num_instances, max_size, status| %>
+    <% title = status.to_s.humanize %>
+    <li>
+      <%= name.to_s.underscore.humanize %>: <%= num_instances %>/<%= max_size %>
+      <% if status_icons.has_key? status %>
+        <span title="<%= title %>"><%= status_icons[status] %></span>
+      <% else %>
+        (<%= title %>)
+      <% end %>
+    </li>
+  <% end %>
+</ul>

data/config/routes.rb

@@ -0,0 +1,3 @@
+OpenStax::Utilities::Engine.routes.draw do
+  root to: 'status#index'
+end

data/lib/openstax/utilities/assets/manifest.rb

@@ -5,6 +5,8 @@ module OpenStax::Utilities
   module Assets
     # Reads and parses the assets manifest
     class Manifest
+      attr_reader :version
+
       def initialize
         @assets = HashWithIndifferentAccess.new
 
@@ -16,6 +18,8 @@ module OpenStax::Utilities
           if response.success?
             contents = JSON.parse response.body
 
+            @version = contents['version']
+
             if contents['entrypoints'].blank?
               Rails.logger.error { "failed to parse manifest from #{url}" }
             else

data/lib/openstax/utilities/engine.rb

@@ -2,6 +2,7 @@ require "openstax/utilities/action_list"
 
 ActiveSupport::Inflector.inflections do |inflect|
   inflect.acronym 'OpenStax'
+  inflect.acronym 'OSU'
 end
 
 module OpenStax
@@ -10,14 +11,18 @@ module OpenStax
       isolate_namespace OpenStax::Utilities
 
       config.after_initialize do
-        OSU::SITE_NAME = ::Rails.application.class.parent_name.underscore
+        if Rails::VERSION::MAJOR == 6
+          OSU::SITE_NAME = ::Rails.application.class.module_parent_name.underscore
+        else
+          OSU::SITE_NAME = ::Rails.application.class.parent_name.underscore
+        end
       end
 
       config.generators do |g|
-        g.test_framework :rspec, :fixture => false
+        g.test_framework :rspec, fixture: false
         g.assets false
         g.helper false
       end
     end
   end
-end
+end

data/lib/openstax/utilities/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Utilities
-    VERSION = '4.3.0'
+    VERSION = '4.5.1'
   end
 end

data/lib/openstax_utilities.rb

@@ -57,11 +57,13 @@ module OpenStax
         attr_accessor :standard_date_format
         attr_accessor :standard_datetime_format
         attr_accessor :standard_time_format
+        attr_accessor :status_authenticate
 
         def initialize
           @standard_date_format = "%b %d, %Y"
           @standard_datetime_format = "%b %d, %Y %l:%M %p %Z"
           @standard_time_format = "%l:%M %p %Z"
+          @status_authenticate = -> { head :forbidden }
           super
         end
       end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: openstax_utilities
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.1
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2021-01-20 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: '5.2'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: lev
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-autoscaling
+  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
@@ -188,11 +208,15 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/openstax/utilities/status_controller.rb
 - app/routines/openstax/utilities/limit_and_paginate_relation.rb
 - app/routines/openstax/utilities/order_relation.rb
 - app/routines/openstax/utilities/search_and_organize_relation.rb
 - app/routines/openstax/utilities/search_relation.rb
+- app/views/layouts/openstax/utilities/status.html.erb
+- app/views/openstax/utilities/status/index.html.erb
 - app/views/osu/shared/_action_list.html.erb
+- config/routes.rb
 - lib/openstax/utilities/access.rb
 - lib/openstax/utilities/access_policy.rb
 - lib/openstax/utilities/action_list.rb
@@ -216,61 +240,6 @@ files:
 - lib/openstax/utilities/text.rb
 - lib/openstax/utilities/version.rb
 - lib/openstax_utilities.rb
-- spec/cassettes/OpenStax_Utilities_Assets/loading_remote_manifest/uses_remote_json.yml
-- spec/dummy/README.md
-- spec/dummy/Rakefile
-- spec/dummy/app/access_policies/dummier_access_policy.rb
-- spec/dummy/app/access_policies/dummy_access_policy.rb
-- spec/dummy/app/assets/config/manifest.js
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/bin/bundle
-- spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/dummy/config.ru
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/access_policies.rb
-- spec/dummy/config/initializers/assets.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/cookies_serializer.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/search_users.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config/secrets.yml
-- spec/dummy/db/migrate/0_create_users.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/log/test.log
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/tmp/cache/C09/760/6da7b2a29da9cb0f80ef102c7effb91fab3374db
-- spec/factories/user.rb
-- spec/lib/openstax/utilities/access_policy_spec.rb
-- spec/lib/openstax/utilities/assets_spec.rb
-- spec/rails_helper.rb
-- spec/routines/openstax/utilities/limit_and_paginate_relation_spec.rb
-- spec/routines/openstax/utilities/order_relation_spec.rb
-- spec/routines/openstax/utilities/search_and_organize_relation_spec.rb
-- spec/routines/openstax/utilities/search_relation_spec.rb
-- spec/spec_helper.rb
-- spec/vcr_helper.rb
 homepage: http://github.com/openstax/openstax_utilities
 licenses:
 - MIT
@@ -294,59 +263,4 @@ rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Utilities for OpenStax web sites
-test_files:
-- spec/rails_helper.rb
-- spec/spec_helper.rb
-- spec/vcr_helper.rb
-- spec/factories/user.rb
-- spec/dummy/app/models/user.rb
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
-- spec/dummy/app/assets/config/manifest.js
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/access_policies/dummier_access_policy.rb
-- spec/dummy/app/access_policies/dummy_access_policy.rb
-- spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
-- spec/dummy/tmp/cache/C09/760/6da7b2a29da9cb0f80ef102c7effb91fab3374db
-- spec/dummy/db/migrate/0_create_users.rb
-- spec/dummy/db/test.sqlite3
-- spec/dummy/db/schema.rb
-- spec/dummy/log/test.log
-- spec/dummy/README.md
-- spec/dummy/public/favicon.ico
-- spec/dummy/public/422.html
-- spec/dummy/public/404.html
-- spec/dummy/public/500.html
-- spec/dummy/config.ru
-- spec/dummy/bin/rails
-- spec/dummy/bin/rake
-- spec/dummy/bin/bundle
-- spec/dummy/config/application.rb
-- spec/dummy/config/initializers/filter_parameter_logging.rb
-- spec/dummy/config/initializers/search_users.rb
-- spec/dummy/config/initializers/assets.rb
-- spec/dummy/config/initializers/cookies_serializer.rb
-- spec/dummy/config/initializers/inflections.rb
-- spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/initializers/access_policies.rb
-- spec/dummy/config/initializers/session_store.rb
-- spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/environments/production.rb
-- spec/dummy/config/environments/test.rb
-- spec/dummy/config/environments/development.rb
-- spec/dummy/config/secrets.yml
-- spec/dummy/Rakefile
-- spec/lib/openstax/utilities/access_policy_spec.rb
-- spec/lib/openstax/utilities/assets_spec.rb
-- spec/routines/openstax/utilities/limit_and_paginate_relation_spec.rb
-- spec/routines/openstax/utilities/search_relation_spec.rb
-- spec/routines/openstax/utilities/order_relation_spec.rb
-- spec/routines/openstax/utilities/search_and_organize_relation_spec.rb
-- spec/cassettes/OpenStax_Utilities_Assets/loading_remote_manifest/uses_remote_json.yml
+test_files: []