openstax_api 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a201392708c1dc1aea7657701f4b652d572b527
-  data.tar.gz: 490312d997713a3fde94c3490a0363d99db95cfc
+  metadata.gz: a3b74dc93f1361a2e644ad8f4977ae5daa9d27c0
+  data.tar.gz: 2258ff732a6fc77dc869a7826812f2dcbdadb9f9
 SHA512:
-  metadata.gz: a62157873835a92e372a2af20ec6ab5a6a957d346c411f08ca4ad1e871d06acaeb7b21837c3b3bff4cbc5c32deacff88eb993d6260ff072ed97df0ffcfdd4478
-  data.tar.gz: 6c1fe337a3919a2f2d16a2430ad7bac65183a926f10169a16547bb83f5669721416beb3498cddf413e5dbc8b702c55871a92700e0ec598ce69ec24bc3ad17c6b
+  metadata.gz: 05e1dd62fe6cede4ce4778ca1ad107210d3337c726b6f669f38f36b48b10c23e3472e90d88920793b2844fa6cc3f32b836ca058ea1badb000ab758aead0fbc5b
+  data.tar.gz: 9815ae41155f318cfdf003d8e8daaa3d0bae2c0eaf545beaa5308fbef1dab459b88e1dcb76774e0c2430d5db5f73b7bcbc557cb5bfc96390e087896eed38c12e

data/app/representers/openstax/api/v1/abstract_search_representer.rb

@@ -31,7 +31,15 @@ module OpenStax
                    }
 
         def total_count
-          represented[:total_count] || represented[:items].limit(nil).offset(nil).count
+          return represented[:total_count] if represented[:total_count]
+          case represented[:items]
+          when ActiveRecord::Relation
+            represented[:items].limit(nil).offset(nil).count
+          when Array
+            represented[:items].count
+          else
+            1
+          end
         end
 
       end

data/lib/openstax/api/doorkeeper_application_includes.rb

@@ -13,6 +13,10 @@ module OpenStax
       def is_admin?
         false
       end
+
+      def is_anonymous?
+        false
+      end
     end
   end
 end

data/lib/openstax/api/engine.rb

@@ -1,3 +1,4 @@
+require 'doorkeeper'
 require 'roar-rails'
 require 'exception_notification'
 require 'openstax_utilities'

data/lib/openstax/api/representable_schema_printer.rb

@@ -27,7 +27,7 @@ module OpenStax
 
       # Attempts to extract the given representer's name
       def self.representer_name(representer)
-        name = representer.name
+        name = representer.try :name
         return nil if name.nil?
         name.chomp('Representer').demodulize.camelize(:lower)
       end
@@ -85,10 +85,13 @@ module OpenStax
 
             # Get the nested representers
             # Evaluate syntax is evaluate(context, instance or class, *args)
-            # We have no instance or class (since we have no fragment), so we pass nil
-            # By convention, the callables we use should return an array of all
-            # possible representers when we pass the :all_sub_representers => true option
-            decorators = [attr[:extend].evaluate(representer, nil, :all_sub_representers => true)].flatten
+            # If we have no instance or class (since we have no fragment), we pass Object
+            # By convention, our callables should return an array of all possible
+            # representers when we pass the :all_sub_representers => true option
+            instance = attr[:instance].evaluate(representer, {}) rescue nil
+            klass = attr[:class].evaluate(representer, {}) rescue Object
+            decorators = [attr[:extend].evaluate(representer, instance || klass,
+              :all_sub_representers => true)].flatten.compact rescue []
 
             # Count the representers
             include_oneof = decorators.length > 1

data/lib/openstax/api/roar.rb

@@ -2,21 +2,43 @@
 # License version 3 or later.  See the COPYRIGHT file for details.
 
 require 'openstax_utilities'
+require 'lev'
 
 module OpenStax
   module Api
 
     module Roar
 
-      def standard_search(routine, query, options, represent_with)
-        model_klass = routine.send(:initial_relation).base_class
-        OSU::AccessPolicy.require_action_allowed!(:search, current_api_user, model_klass)
-        outputs = routine.call(query, options).outputs
+      def standard_search(routine, relation, represent_with, options={})
+        user = current_api_user
+        model_klass = relation.base_class
+        OSU::AccessPolicy.require_action_allowed!(:search, user, model_klass)
+        options = options.merge({
+          search_routine: routine,
+          search_relation: relation,
+          params: params
+        })
+        result = OpenStax::Utilities::KeywordSearchHandler.call(options)
+        return render_api_errors(result.errors) if result.errors.any?
+        outputs = result.outputs
+        outputs[:items].each do |item|
+          OSU::AccessPolicy.require_action_allowed!(:read, user, item)
+        end
         respond_with outputs, represent_with: represent_with
       end
 
-      def standard_create(model, represent_with=nil, &block)
-        standard_nested_create(model, nil, nil, represent_with, &block)
+      def standard_create(model, represent_with=nil)
+        model.class.transaction do
+          consume!(model, represent_with: represent_with)
+          yield model if block_given?
+          OSU::AccessPolicy.require_action_allowed!(:create, current_api_user, model)
+
+          if model.save
+            respond_with model, represent_with: represent_with, status: :created
+          else
+            render_api_errors(model.errors)
+          end
+        end
       end
 
       def standard_read(model, represent_with=nil)
@@ -25,6 +47,7 @@ module OpenStax
       end
 
       def standard_update(model, represent_with=nil)
+        # Must be able to update the record before and after the update itself
         OSU::AccessPolicy.require_action_allowed!(:update, current_api_user, model)
 
         model.class.transaction do
@@ -35,7 +58,7 @@ module OpenStax
           if model.save
             head :no_content
           else
-            render json: model.errors, status: :unprocessable_entity
+            render_api_errors(model.errors)
           end
         end
       end
@@ -46,43 +69,53 @@ module OpenStax
         if model.destroy
           head :no_content
         else
-          render json: model.errors, status: :unprocessable_entity
+          render_api_errors(model.errors)
         end
       end
 
       def standard_index(relation, represent_with)
         model_klass = relation.base_class
         OSU::AccessPolicy.require_action_allowed!(:index, current_api_user, model_klass)
-        respond_with relation, represent_with: represent_with
+        relation.each do |item|
+          # Must be able to read each record
+          OSU::AccessPolicy.require_action_allowed!(:read, current_api_user, item)
+        end
+        respond_with(Lev::Outputs.new({items: relation}), {represent_with: represent_with})
       end
 
       def standard_sort(*args)
         raise NotYetImplemented
       end
 
-      def standard_nested_create(model, container_association=nil,
-                                 container=nil, represent_with=nil)
-        if container_association && container
-          OSU::AccessPolicy.require_action_allowed!(:update, current_api_user, container)
-          model.send("#{container_association.to_s}=", container)
-        end
+      def standard_nested_create(model, container_association,
+                                 container, represent_with=nil)
+        # Must be able to update the container
+        OSU::AccessPolicy.require_action_allowed!(:update, current_api_user, container)
+        model.send("#{container_association.to_s}=", container)
 
-        # Unlike the implications of the representable README, "consume!" can
-        # actually make changes to the database.  See http://goo.gl/WVLBqA. 
-        # We do want to consume before checking the permissions so we can know
-        # what we're dealing with, but if user doesn't have permission we don't
-        # want to have changed the DB.  Wrap in a transaction to protect ourselves.
-        model.class.transaction do
-          consume!(model, represent_with: represent_with)
-          yield model if block_given?
-          OSU::AccessPolicy.require_action_allowed!(:create, current_api_user, model)
+        standard_create(model, represent_with)
+      end
 
-          if model.save
-            respond_with model, represent_with: represent_with, status: :created
-          else
-            render json: model.errors, status: :unprocessable_entity
+      def render_api_errors(errors, status = :unprocessable_entity)
+        hash = {status: Rack::Utils.status_code(status)}
+        case errors
+        when ActiveModel::Errors, Lev::BetterActiveModelErrors
+          hash[:errors] = []
+          errors.each do |attribute, message|
+            hash[:errors] << {code: "#{attribute.to_s}_#{
+                               message.to_s.gsub(/[\s-]/, '_').gsub(/[^\w]/, '')
+                             }", message: errors.full_message(attribute, message)}
+          end
+        when Lev::Errors
+          hash[:errors] = errors.collect do |error|
+            {code: error.code, message: error.message, data: error.data}
+          end
+        else
+          hash[:errors] = [errors].flatten.collect do |error|
+            {code: error.to_s}
           end
         end
+        render json: hash, status: status
       end
       
     end

data/lib/openstax/api/routing_mapper_includes.rb

@@ -11,7 +11,8 @@ module OpenStax
                                       default: options.delete(:default))
 
         namespace api_namespace, defaults: {format: 'json'}.merge(options) do
-          scope(module: version,
+          scope(except: [:new, :edit],
+                module: version,
                 constraints: constraints) do
             get '/', to: '/apipie/apipies#index', defaults: {format: 'html',
                                                              version: version.to_s}

data/lib/openstax/api/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Api
-    VERSION = "3.0.1"
+    VERSION = "3.1.0"
   end
 end

data/spec/dummy/app/routines/search_users.rb

@@ -1,7 +1,6 @@
 # Dummy routine for testing the abstract search representer
 
 class SearchUsers < OpenStax::Utilities::AbstractKeywordSearchRoutine
-  self.initial_relation = User.unscoped
   self.search_proc = lambda { |with|
     with.keyword :username do |names|
       snames = to_string_array(names, append_wildcard: true)

data/spec/dummy/config/initializers/doorkeeper.rb

@@ -72,4 +72,4 @@ Doorkeeper.configure do
   # Some applications require dynamic query parameters on their request_uri
   # set to true if you want this to be allowed
   # wildcard_redirect_uri false
-end
+end