openstax_utilities 4.2.3 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed18a23199f07f7f8edee98bed58cb496e694a48
-  data.tar.gz: 0eec1854fad5452d7dabfb2f3d4d300669489475
+SHA256:
+  metadata.gz: f4d1192783928b4f282084e72dbaf1cbeb322670d8af58bbbc0766f4bf21675f
+  data.tar.gz: fdd43154979bc0a7f997e0ce96f6f9322e8aceedce34644fa25b09950f64bf29
 SHA512:
-  metadata.gz: 63ca2f1fe8b015b0ca50ef92dcbf1efd4a846ca01b639b0e1b457134908e7ceae619438280e8dfc02bf6843a0ff15434c41612cd2efba1045e000b82d86a2b5d
-  data.tar.gz: 77e8817b5e830a77c475c8f0f0fa9afd4892e652ecff01aac6c1d128b6604e59adf64fdb6e6a2838b4a07ac6e6a2fbffbf8fb36ac190b511e1c50e820c4658cc
+  metadata.gz: 7307c95428084dd8c3545c8bd8e81a830de28e352954ca3f37a66b0b49836140c8e1fbb46fe99485adc1ebf12a0bddba995b401fd9ac138feb10546fde5d7316
+  data.tar.gz: 6568675770199473e6d80e5a272bc302b63cb64d0e571280cefc3da0bb5b38238f1d486ad8628e3afa48f6a7bca8e00e614a5ae5fb0e81e74b9d877f7e3e4452

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,81 @@
+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 = 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.rb

@@ -0,0 +1,29 @@
+require 'request_store'
+require_relative 'assets/manifest'
+
+module OpenStax::Utilities
+  module Assets
+    def self.url
+      url = Rails.application.secrets.assets_url
+      url.ends_with?('/') ? url : "#{url}/"
+    end
+
+    def self.url_for(asset)
+      "#{url}#{asset}"
+    end
+
+    def self.manifest
+      RequestStore.store[:assets_manifest] ||= OpenStax::Utilities::Assets::Manifest.new
+    end
+
+    def self.tags_for(asset)
+      manifest[asset].map do |chunk|
+        "<script type='text/javascript' src='#{chunk}' crossorigin='anonymous' async></script>"
+      end.join("\n").html_safe
+    end
+
+    def self.digest_for(asset)
+      Digest::MD5.hexdigest tags_for(asset)
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+require 'faraday'
+require 'faraday-http-cache'
+
+module OpenStax::Utilities
+  module Assets
+    # Reads and parses the assets manifest
+    class Manifest
+      attr_reader :version
+
+      def initialize
+        @assets = HashWithIndifferentAccess.new
+
+        url = OpenStax::Utilities::Assets.url_for('assets.json')
+
+        begin
+          response = self.class.client.get url
+
+          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
+              contents['entrypoints'].each do |entry_key, chunks|
+                @assets[entry_key] = chunks['js'].map do |chunk|
+                  OpenStax::Utilities::Assets.url_for(chunk)
+                end
+              end
+            end
+          else
+            Rails.logger.error { "status #{response.status} when reading remote url: #{url}" }
+          end
+        rescue Faraday::ConnectionFailed, Addressable::URI::InvalidURIError, Errno::ECONNREFUSED
+        end
+
+        Rails.logger.info do
+          "running in development mode with assets served by webpack at #{
+            OpenStax::Utilities::Assets.url
+          }"
+        end if @assets.blank?
+      end
+
+      def [](asset)
+        return [ OpenStax::Utilities::Assets.url_for("#{asset}.js") ] if @assets.blank?
+
+        @assets[asset] || []
+      end
+
+      protected
+
+      # Faraday is probably thread-safe but makes no guarantees
+      # https://github.com/lostisland/faraday/issues/370
+      # We could potentially reuse the client object
+      # However, bugs happen: https://github.com/lostisland/faraday/issues/1068
+      def self.client
+        Faraday.new do |builder|
+          builder.use :http_cache, store: Rails.cache
+
+          builder.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

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.2.3"
+    VERSION = '4.5.0'
   end
 end

data/lib/openstax_utilities.rb

@@ -19,6 +19,7 @@ require "openstax/utilities/acts_as_numberable"
 require "openstax/utilities/delegate_access_control"
 require "openstax/utilities/access_policy"
 require "openstax/utilities/osu_helper"
+require "openstax/utilities/assets"
 
 module OpenStax
   module Utilities
@@ -35,7 +36,7 @@ module OpenStax
       #
       # Configuration machinery.
       #
-      # To configure OpenStax Utilities, put the following code in your applications 
+      # To configure OpenStax Utilities, put the following code in your applications
       # initialization logic (eg. in the config/initializers in a Rails app)
       #
       #   OpenStax::Utilities.configure do |config|
@@ -43,7 +44,7 @@ module OpenStax
       #     ...
       #   end
       #
-      
+
       def configure
         yield configuration
       end
@@ -56,11 +57,13 @@ module OpenStax
         attr_accessor :standard_date_format
         attr_accessor :standard_datetime_format
         attr_accessor :standard_time_format
-        
-        def initialize      
+        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
@@ -69,4 +72,3 @@ module OpenStax
 
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_utilities
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 4.5.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: lev
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +58,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  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: faraday
+  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: faraday-http-cache
+  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: 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
@@ -81,7 +143,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_girl_rails
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +171,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: squeel
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -132,16 +208,22 @@ 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
 - lib/openstax/utilities/active_record_extensions.rb
 - lib/openstax/utilities/acts_as_numberable.rb
+- lib/openstax/utilities/assets.rb
+- lib/openstax/utilities/assets/manifest.rb
 - lib/openstax/utilities/classy_helper.rb
 - lib/openstax/utilities/delegate_access_control.rb
 - lib/openstax/utilities/engine.rb
@@ -158,54 +240,6 @@ files:
 - lib/openstax/utilities/text.rb
 - lib/openstax/utilities/version.rb
 - lib/openstax_utilities.rb
-- 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/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/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/factories/user.rb
-- spec/lib/openstax/utilities/access_policy_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
 homepage: http://github.com/openstax/openstax_utilities
 licenses:
 - MIT
@@ -225,57 +259,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Utilities for OpenStax web sites
-test_files:
-- spec/dummy/app/access_policies/dummier_access_policy.rb
-- spec/dummy/app/access_policies/dummy_access_policy.rb
-- 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/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/config.ru
-- spec/dummy/db/migrate/0_create_users.rb
-- spec/dummy/db/schema.rb
-- spec/dummy/public/404.html
-- spec/dummy/public/422.html
-- spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/Rakefile
-- spec/dummy/README.md
-- spec/factories/user.rb
-- spec/lib/openstax/utilities/access_policy_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
+test_files: []