openstax_utilities 4.1.0 → 4.3.0

data/spec/vcr_helper.rb

@@ -0,0 +1,18 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.allow_http_connections_when_no_cassette = Rails.env.development?
+  c.ignore_localhost = true
+  c.ignore_request { |request| Addressable::URI.parse(request.uri).path == '/oauth/token' } \
+    if Rails.env.development?
+  c.preserve_exact_body_bytes { |http_message| !http_message.body.valid_encoding? }
+end
+
+VCR_OPTS = {
+  # This should default to :none
+  record: ENV.fetch('VCR_OPTS_RECORD', :none).to_sym,
+  allow_unused_http_interactions: Rails.env.development?
+}

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openstax_utilities
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.3.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2020-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: lev
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,48 @@ 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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +123,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 +151,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,14 +188,18 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/handlers/openstax/utilities/keyword_search_handler.rb
-- app/routines/openstax/utilities/abstract_keyword_search_routine.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/osu/shared/_action_list.html.erb
 - 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
@@ -156,15 +216,17 @@ 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/routines/search_users.rb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
@@ -184,6 +246,7 @@ files:
 - 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
@@ -191,16 +254,23 @@ files:
 - 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/handlers/openstax/utilities/keyword_search_handler_spec.rb
 - spec/lib/openstax/utilities/access_policy_spec.rb
+- spec/lib/openstax/utilities/assets_spec.rb
 - spec/rails_helper.rb
-- spec/routines/openstax/utilities/abstract_keyword_search_routine_spec.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
@@ -220,54 +290,63 @@ 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/dummy_access_policy.rb
+- 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/app/models/user.rb
-- spec/dummy/app/routines/search_users.rb
-- spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/bin/bundle
+- 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/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/filter_parameter_logging.rb
+- spec/dummy/config/initializers/search_users.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/session_store.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/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/handlers/openstax/utilities/keyword_search_handler_spec.rb
 - spec/lib/openstax/utilities/access_policy_spec.rb
-- spec/rails_helper.rb
-- spec/routines/openstax/utilities/abstract_keyword_search_routine_spec.rb
-- spec/spec_helper.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

data/app/handlers/openstax/utilities/keyword_search_handler.rb

@@ -1,95 +0,0 @@
-# Database-agnostic keyword searching handler
-#
-# Keywords have the format keyword:value
-# Keywords can also be negated with -, as in -keyword:value
-# Values are comma-separated, while keywords are space-separated
-# See https://github.com/bruce/keyword_search for more information
-#
-# Callers must pass the search_routine and search_relation options:
-#
-# Required:
-#
-#   search_routine  - the Lev::Routine that will handle the search
-#   search_relation - the ActiveRecord::Relation that will be searched
-#
-# Optional (recommended to prevent scraping):
-#
-#   min_characters - the minimum number of characters allowed in the query
-#                    only an error will be returned if the query has less
-#                    than the minimum number of characters allowed
-#                    default: nil (disabled)
-#
-#   max_items      - the maximum number of matching items allowed to be returned
-#                    no results will be returned if this number is exceeded,
-#                    but the total result count will still be returned
-#                    applies even if pagination is enabled
-#                    default: nil (disabled)
-#
-# This handler also expects the following parameters from the user or the UI:
-#
-# Required:
-#
-#   q - the query itself, a String that follows the keyword format above
-#
-# Optional:
-#
-#   order_by - a String used to order the search results - default: 'created_at ASC'
-#   per_page - the number of results returned per page - default: nil (disabled)
-#   page     - the current page number - default: 1
-#
-# This handler's output contains:
-#
-#   outputs[:total_count] - the total number of items that matched the query
-#                           set even when no results are returned due to
-#                           a query that is too short or too generic
-#   outputs[:items]       - the array of objects returned by the search routine
-#
-# See spec/dummy/app/handlers/users_search.rb for an example search handler
-
-require 'lev'
-
-module OpenStax
-  module Utilities
-    class KeywordSearchHandler
-
-      lev_handler
-
-      protected
-
-      def authorized?
-        routine = options[:search_routine]
-        relation = options[:search_relation]
-        raise ArgumentError if routine.nil? || relation.nil?
-        OSU::AccessPolicy.action_allowed?(:search, caller, relation.base_class)
-      end
-
-      def handle
-        query = params[:q]
-        fatal_error(code: :query_blank,
-                    message: 'You must provide a query parameter (q or query).') if query.nil?
-
-        min_characters = options[:min_characters]
-        fatal_error(code: :query_too_short,
-                    message: "The provided query is too short (minimum #{
-                      min_characters} characters).") \
-          if !min_characters.nil? && query.length < min_characters
-
-        routine = options[:search_routine]
-        relation = options[:search_relation]
-        items = run(routine, relation, query, params).outputs[:items]
-
-        outputs[:total_count] = items.limit(nil).offset(nil).count
-
-        max_items = options[:max_items]
-        fatal_error(code: :too_many_items,
-                    message: "The number of matches exceeded the allowed limit of #{
-                      max_items} matches. Please refine your query and try again.") \
-          if !max_items.nil? && outputs[:total_count] > max_items
-
-        outputs[:items] = items.to_a
-      end
-
-    end
-
-  end
-end

data/app/routines/openstax/utilities/abstract_keyword_search_routine.rb

@@ -1,158 +0,0 @@
-# Database-agnostic keyword searching routine
-#
-# Keywords have the format keyword:value
-# Keywords can also be negated with -, as in -keyword:value
-# Values are comma-separated, while keywords are space-separated
-# See https://github.com/bruce/keyword_search for more information
-#
-# Subclasses must set the search_proc and sortable_fields class variables
-#
-#   search_proc - a proc passed to keyword_search's `search` method
-#                 it receives keyword_search's `with` object as argument
-#                 this proc must define the `keyword` blocks for keyword_search
-#                 the relation to be scoped is contained in the @items instance variable
-#                 the `to_string_array` helper can help with
-#                 parsing strings from the query
-#
-#   sortable_fields_map - a Hash that maps the lowercase names of fields
-#                         which can be used to sort the results to symbols
-#                         for their respective database columns
-#                         keys are lowercase strings that should be allowed
-#                         in options[:order_by]
-#                         values are the corresponding database column names
-#                         that will be passed to the order() method
-#                         columns from other tables can be specified either
-#                         through Arel attributes (Class.arel_table[:column])
-#                         or through literal strings
-#
-# Callers of subclass routines provide a relation argument,
-# a query argument and an options hash
-#
-# Required arguments:
-#
-#   relation - the initial relation to start searching on
-#   query - a string that follows the keyword format above
-#
-# Options hash:
-#
-#     Ordering:
-#
-#       :order_by - list of fields to sort by, with optional sort directions
-#                   can be a String, Array of Strings or Array of Hashes
-#                   default: {:created_at => :asc}
-#
-#     Pagination:
-#
-#       :per_page - the maximum number of results per page - default: nil (disabled)
-#       :page     - the page to return - default: 1
-#
-# This routine's output contains:
-#
-#   outputs[:items] - an ActiveRecord::Relation that matches the query terms and options
-#
-# You can use the following expression to obtain the
-# total count of records that matched the query terms:
-#
-#   outputs[:items].limit(nil).offset(nil).count
-#
-# See spec/dummy/app/routines/search_users.rb for an example search routine
-
-require 'lev'
-require 'keyword_search'
-
-module OpenStax
-  module Utilities
-    class AbstractKeywordSearchRoutine
-
-      lev_routine transaction: :no_transaction
-
-      protected
-
-      class_attribute :search_proc, :sortable_fields_map
-
-      def exec(relation, query, options = {})
-        raise NotImplementedError if search_proc.nil? || sortable_fields_map.nil?
-
-        raise ArgumentError \
-          unless relation.is_a?(ActiveRecord::Relation) && query.is_a?(String)
-
-        @items = relation
-
-        # Scoping
-
-        ::KeywordSearch.search(query) do |with|
-          instance_exec(with, &search_proc)
-        end
-
-        # Ordering
-
-        order_bys = sanitize_order_bys(options[:order_by])
-        @items = @items.order(order_bys)
-        
-        # Pagination
-
-        per_page = Integer(options[:per_page]) rescue nil
-        unless per_page.nil?
-          page = Integer(options[:page]) rescue 1
-          @items = @items.limit(per_page).offset(per_page*(page-1))
-        end
-
-        outputs[:items] = @items
-      end
-
-      def sanitize_order_by(field, dir = nil)
-        sanitized_field = sortable_fields_map[field.to_s.downcase] || :created_at
-        sanitized_dir = dir.to_s.downcase == 'desc' ? :desc : :asc
-        case sanitized_field
-        when Symbol
-          {sanitized_field => sanitized_dir}
-        when Arel::Attributes::Attribute
-          sanitized_field.send sanitized_dir
-        else
-          "#{sanitized_field.to_s} #{sanitized_dir.to_s.upcase}"
-        end
-      end
-
-      def sanitize_order_bys(order_bys)
-        case order_bys
-        when Array
-          order_bys.collect do |ob|
-            case ob
-            when Hash
-              sanitize_order_by(ob.keys.first, ob.values.first)
-            when Array
-              sanitize_order_by(ob.first, ob.second)
-            else
-              sanitize_order_by(ob)
-            end
-          end
-        when Hash
-          order_bys.collect { |k, v| sanitize_order_by(k, v) }
-        else
-          order_bys.to_s.split(',').collect do |ob|
-            fd = ob.split(' ')
-            sanitize_order_by(fd.first, fd.second)
-          end
-        end
-      end
-
-      # Parses a keyword string into an array of strings
-      # User-supplied wildcards are removed and strings are split on commas
-      # Then wildcards are appended or prepended if the append_wildcard or
-      # prepend_wildcard options are specified
-      def to_string_array(str, options = {})
-        sa = case str
-        when Array
-          str.collect{|name| name.gsub('%', '').split(',')}.flatten
-        else
-          str.to_s.gsub('%', '').split(',')
-        end
-        sa = sa.collect{|str| "#{str}%"} if options[:append_wildcard]
-        sa = sa.collect{|str| "%#{str}"} if options[:prepend_wildcard]
-        sa
-      end
-
-    end
-
-  end
-end