openstax_api 8.3.2 → 9.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7296239fd11318616e99546c687c2f99a387e17425f0f6efca8f6b4f77059fc6
-  data.tar.gz: 0dcbc6e75158fda3afe0ded916182726a285d6bf565ac1bb131b4115290bcebc
+  metadata.gz: aec2631a5eebf6c105ae15fa8462c06577027583db6b2cbaa952aea4acf52280
+  data.tar.gz: 3d0ee92a6bdaa1e01f9040dd62fb8b65be37c30262f678aeda4e9ec6a8324f88
 SHA512:
-  metadata.gz: 3296d8f4e8354e4fb26ebd43d75ce509160a2c2d4b1a74c245b111514431ce50f9bc330f1eb8ba49975f7db00d592f81a7374bd0fe98303b7fb6341144b9d6b3
-  data.tar.gz: 6483a27055e0b8f01850dd77cf22ecfe39ffb3d74d9a41ef2bbd52ece5fda56754d0ea50fd2a8c0c259b57a8f4129d4fb7739cedc453dfe955f8e0bbf95aab84
+  metadata.gz: 9d01d88bad42186d009a46dc9030399c9c36542a170a3d8f711ea03dedc4f09548da45ecf6f75c39bb22f3553efb4f4f7a050335e5290cf475dcaa37f7b9a326
+  data.tar.gz: c796fbdfde096f09fea43bb50091e6df8137d5d82064d3357c661506a73cc312c15c044aceec6b66ebc6616f7d57f4d11c189c4fd20282af9c84c03ddcbd5bce

data/Rakefile

@@ -17,4 +17,4 @@ require 'rspec/core/rake_task'
 desc 'Run all specs in spec directory (excluding plugin specs)'
 RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
 
-task :default => :spec
+task default: :spec

data/app/controllers/openstax/api/v1/api_controller.rb

@@ -12,27 +12,27 @@ module OpenStax
 
         respond_to :json
 
-        # after_filters are in place to make sure certain things are set how we
-        # want even if something else goes on during the request.  These filters
-        # are also paired with before_filters in case an exception prevents
+        # after_actions are in place to make sure certain things are set how we
+        # want even if something else goes on during the request.  These actions
+        # are also paired with before_actions in case an exception prevents
         # normal action completion.
 
         # Always force JSON requests and send the Date header in the response
-        before_filter :force_json_content_type
-        before_filter :set_date_header
-        after_filter :set_date_header
+        before_action :force_json_content_type
+        before_action :set_date_header
+        after_action :set_date_header
 
         # Doorkeeper is used only if a token is present
         # Access policies should be used to limit access to anonymous users
-        before_filter :doorkeeper_authorize!, if: :token_user?
+        before_action :doorkeeper_authorize!, if: :token_user?
 
         # Except for users logged in via a cookie, we can disable CSRF protection and enable CORS
-        skip_before_filter :verify_authenticity_token, unless: :local_session_user?
-        skip_before_filter :authenticate_user!, only: :options
-        skip_before_filter :verify_authenticity_token, only: :options
+        skip_before_action :verify_authenticity_token, unless: :local_session_user?
+        skip_before_action :verify_authenticity_token, only: :options
+        skip_before_action :authenticate_user!, only: :options, raise: false
 
-        before_filter :maybe_set_cors_headers
-        after_filter  :maybe_set_cors_headers
+        before_action :maybe_set_cors_headers
+        after_action  :maybe_set_cors_headers
 
         # Keep old current_user method so we can use it
         alias_method :current_session_user, OpenStax::Api.configuration.current_user_method
@@ -40,6 +40,11 @@ module OpenStax
         # Ensure we will never again confuse human users and api users
         undef_method OpenStax::Api.configuration.current_user_method
 
+        # intended to be overridden by parent
+        def authenticate_user!
+          throw(:abort)
+        end
+
         # Always return an ApiUser
         def current_api_user
           @current_api_user ||= ApiUser.new(doorkeeper_token, lambda { current_session_user })

data/lib/openstax/api/engine.rb

@@ -13,6 +13,8 @@ module OpenStax
     class Engine < ::Rails::Engine
       isolate_namespace OpenStax::Api
 
+      config.autoload_paths += Dir[config.root.join('app', 'representers', '{**}')]
+
       config.generators do |g|
         g.test_framework      :rspec,        fixture: false
         g.fixture_replacement :factory_bot, dir: 'spec/factories'

data/lib/openstax/api/roar.rb

@@ -13,7 +13,7 @@ module OpenStax
         model_klass = relation.base_class
         OSU::AccessPolicy.require_action_allowed!(:index, current_api_user, model_klass)
 
-        represent_with_options = { user_options: options }.merge(represent_with: represent_with)
+        represent_with_options = { user_options: options, represent_with: represent_with }
 
         relation.each do |item|
           # Must be able to read each record
@@ -24,11 +24,10 @@ module OpenStax
       end
 
       def standard_search(klass, routine, represent_with, options={})
-        search_options = { location: nil }
         user = current_api_user
         OSU::AccessPolicy.require_action_allowed!(:search, user, klass)
 
-        represent_with_options = { user_options: options }.merge(represent_with: represent_with)
+        represent_with_options = { user_options: options, represent_with: represent_with }
 
         result = routine.call(params, options)
         return render_api_errors(result.errors) if result.errors.any?
@@ -38,12 +37,11 @@ module OpenStax
           OSU::AccessPolicy.require_action_allowed!(:read, user, item)
         end
 
-        respond_with outputs, search_options.merge(represent_with_options)
+        respond_with outputs, { status: :ok, location: nil }.merge(represent_with_options)
       end
 
       def standard_create(model, represent_with=nil, options={})
-        create_options = { status: :created, location: nil }
-        represent_with_options = { user_options: options }.merge(represent_with: represent_with)
+        represent_with_options = { user_options: options, represent_with: represent_with }
 
         model.class.transaction do
           consume!(model, represent_with_options.dup)
@@ -51,7 +49,7 @@ module OpenStax
           OSU::AccessPolicy.require_action_allowed!(:create, current_api_user, model)
 
           if model.save
-            respond_with model, create_options.merge(represent_with_options)
+            respond_with model, { status: :created, location: nil }.merge(represent_with_options)
           else
             render_api_errors(model.errors)
           end
@@ -71,9 +69,7 @@ module OpenStax
       def standard_read(model, represent_with=nil, use_timestamp_for_cache=false, options={})
         OSU::AccessPolicy.require_action_allowed!(:read, current_api_user, model)
 
-        represent_with_options = { user_options: options }.merge(represent_with: represent_with)
-
-        respond_with model, represent_with_options \
+        respond_with(model, { user_options: options, represent_with: represent_with }) \
           if !use_timestamp_for_cache || stale?(model, template: false)
       end
 
@@ -82,7 +78,7 @@ module OpenStax
         OSU::AccessPolicy.require_action_allowed!(:update, current_api_user, model)
 
         responder_options = { responder: ResponderWithPutPatchDeleteContent }
-        represent_with_options = { user_options: options }.merge(represent_with: represent_with)
+        represent_with_options = { user_options: options, represent_with: represent_with }
 
         model.with_lock do
           consume!(model, represent_with_options.dup)
@@ -106,11 +102,12 @@ module OpenStax
           if model.respond_to?(:deleted?) && model.deleted?
 
         responder_options = { responder: ResponderWithPutPatchDeleteContent }
-        represent_with_options = { user_options: options }.merge(represent_with: represent_with)
+        represent_with_options = { user_options: options, represent_with: represent_with }
 
         model.with_lock do
           if model.destroy
-            model.clear_association_cache
+            model.send :clear_association_cache
+            yield model if block_given?
             respond_with model, responder_options.merge(represent_with_options)
           else
             render_api_errors(model.errors)
@@ -128,12 +125,14 @@ module OpenStax
         recursive = options.has_key?(:recursive) ? options[:recursive] : true
 
         responder_options = { responder: ResponderWithPutPatchDeleteContent }
-        represent_with_options = { user_options: options.except(:recursive) }
-                                     .merge(represent_with: represent_with)
+        represent_with_options = {
+          user_options: options.except(:recursive), represent_with: represent_with
+        }
 
         model.with_lock do
           if model.restore(recursive: recursive)
-            model.clear_association_cache
+            model.send :clear_association_cache
+            yield model if block_given?
             respond_with model, responder_options.merge(represent_with_options)
           else
             render_api_errors(model.errors)

data/lib/openstax/api/rspec_helpers.rb

@@ -1,11 +1,15 @@
 # Provides API-specific HTTP request methods
 #
-# The args at the end of each request is interpreted a hash that can contain
-# keys for:
-#   :raw_post_data -- a JSON string (if a Hash provided, to_json will be called on it)
-#   :parameters -- a hash of parameters
-#   :session -- whatever built-in request methods expect
-#   :flash -- whatever built-in request methods expect
+# action is a symbol (controller specs) OR a relative url (request specs)
+#
+# doorkeeper_token is a Doorkeeper::AccessToken or nil
+#
+# args are a hash that can contain the following keys:
+#   :params          -- a hash of parameters (controller specs) OR a json string (request specs)
+#   :body            -- a JSON string (controller specs only)
+#   :format          -- always set to :json for API calls
+#   :session, :flash -- hashes (controller specs)
+#   :headers, :env   -- hashes (request specs)
 #
 # Helpful documentation:
 #  https://github.com/rails/rails/blob/3-2-stable/actionpack/lib/action_controller/test_case.rb
@@ -13,71 +17,67 @@
 module OpenStax
   module Api
     module RSpecHelpers
-
-      def api_get(action, doorkeeper_token, args={})
+      def api_get(action, doorkeeper_token = nil, args={})
         api_request(:get, action, doorkeeper_token, args)
       end
 
-      def api_put(action, doorkeeper_token, args={})
+      def api_put(action, doorkeeper_token = nil, args={})
         api_request(:put, action, doorkeeper_token, args)
       end
 
-      def api_post(action, doorkeeper_token, args={})
+      def api_post(action, doorkeeper_token = nil, args={})
         api_request(:post, action, doorkeeper_token, args)
       end
 
-      def api_delete(action, doorkeeper_token, args={})
+      def api_delete(action, doorkeeper_token = nil, args={})
         api_request(:delete, action, doorkeeper_token, args)
       end
 
-      def api_patch(action, doorkeeper_token, args={}) 
+      def api_patch(action, doorkeeper_token = nil, args={})
         api_request(:patch, action, doorkeeper_token, args)
       end
 
-      def api_head(action, doorkeeper_token, args={})
+      def api_head(action, doorkeeper_token = nil, args={})
         api_request(:head, action, doorkeeper_token, args)
       end
 
-      def api_request(type, action, doorkeeper_token, args={})
-        raise IllegalArgument if ![:get, :post, :put, :delete, :patch, :head].include?(type)
-
-        header = is_a_controller_spec? ? request.env : {}
+      def api_request(type, action, doorkeeper_token = nil, args={})
+        raise IllegalArgument unless [:head, :get, :post, :patch, :put, :delete].include?(type)
 
-        # Add the doorkeeper token info
-        header['HTTP_AUTHORIZATION'] = "Bearer #{doorkeeper_token.token}" \
-          if doorkeeper_token
+        headers = is_a_controller_spec? ? request.headers : {}
 
         # Select the version of the API based on the spec metadata and populate the accept header
         version_string = self.class.metadata[:version].try(:to_s)
-        raise ArgumentError, "Top-level 'describe' metadata must include a value for ':version'" if version_string.nil?
-        header['HTTP_ACCEPT'] = "application/vnd.openstax.#{version_string}"
-
-        # Set the raw post data in the request, converting to JSON if needed
-        if args[:raw_post_data]
-          header['RAW_POST_DATA'] = args[:raw_post_data].is_a?(Hash) ? 
-                                      args[:raw_post_data].to_json : 
-                                      args[:raw_post_data]
-        end
+        raise ArgumentError, "Top-level 'describe' metadata must include a value for ':version'" \
+          if version_string.nil?
+        headers['HTTP_ACCEPT'] = "application/vnd.openstax.#{version_string}"
+
+        # Add the doorkeeper token header
+        headers['HTTP_AUTHORIZATION'] = "Bearer #{doorkeeper_token.token}" \
+          if doorkeeper_token
 
-        # Set the data format
-        args[:parameters] ||= {}
-        args[:parameters][:format] = 'json'
-        header['CONTENT_TYPE'] = 'application/json'
+        headers['CONTENT_TYPE'] = 'application/json'
+
+        if is_a_controller_spec?
+          request.headers.merge! headers
+          args[:format] = :json
+          # Convert the request body to JSON if needed
+          args[:body] = args[:body].to_json unless args[:body].nil? || args[:body].is_a?(String)
+        else
+          args[:headers] = headers
+        end
 
         # If these helpers are used from a request spec, action can
         # be a URL fragment string -- in such a case, prepend "/api"
         # to the front of the URL as a convenience to callers
 
-        if action.is_a? String
-          action = "/#{action}" if !action.starts_with?("/")
-          action = "/api#{action}" if !action.starts_with?("/api/")
+        action = action.to_s unless is_a_controller_spec?
+        if action.is_a?(String) && !action.include?('://')
+          action = "/#{action}" if !action.starts_with?('/')
+          action = "/api#{action}" if !action.starts_with?('/api/')
         end
 
-        if is_a_controller_spec?
-          send(type, action, args[:parameters], args[:session], args[:flash])
-        else
-          send(type, action, args[:parameters].to_json, header)
-        end
+        send type, action, args
       end
 
       private
@@ -85,7 +85,6 @@ module OpenStax
       def is_a_controller_spec?
         self.class.metadata[:type] == :controller
       end
-
     end
   end
 end

data/lib/openstax/api/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Api
-    VERSION = "8.3.2"
+    VERSION = '9.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstax_api
 version: !ruby/object:Gem::Version
-  version: 8.3.2
+  version: 9.3.0
 platform: ruby
 authors:
 - Dante Soares
@@ -9,146 +9,134 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2020-09-10 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'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: representable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: roar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: roar-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: uber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: doorkeeper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: exception_notification
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: openstax_utilities
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: lev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: responders
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -178,7 +166,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,7 +180,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot_rails
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -206,7 +194,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -220,7 +208,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: squeel
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -294,8 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: API utilities for OpenStax products and tools.