jsonapi-resources 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 797927f93aedcb2dab47c655c02b3b0fc585ae3a
-  data.tar.gz: 679a57fb31f8a64b19735130d70bd79eef9b46ad
+  metadata.gz: a1c7d37d8e26cb718f177ebe4fd12161d43196be
+  data.tar.gz: 944229a81d8e325bfd3fae18f39f97fb4716a346
 SHA512:
-  metadata.gz: 39a597f4b31a1273f4a7a71bf3b46ea0a19251b235a2fb8212c3452d959c6b01094a33420bad1fc7ac69d1c082d8193cb99d7c73e5f541c747c60d3503de1190
-  data.tar.gz: 819a12d466c075c127b9a9c6863b675fd3dc28a21f011022132c460badeb8e102745aacfb9cc4c6cab4c60d4f69d41f9b22fbbe8c1804ad4b92c2c0a43006a54
+  metadata.gz: 750930c916c0ed48ae7fc0f1dd9b19f4d3a853f1fefd27440df9736559650e21ddec7009e94ffcccc2de6133b7b8ae0e89fa2c7f0e96587562311b50c561d3fb
+  data.tar.gz: 1aa6132ee9712c7bdd6636090be1be3c243a823140376d6b21ede7026a77cc9c4b8a7eba6dff68b543f589650ae997f4fb13d1f360e27af3a23c45b1d5cc3bcb

data/README.md

@@ -272,7 +272,7 @@ end
 ```ruby
 class BookResource < JSONAPI::Resource
 
-  # Only book_admins may see unapproved comments for a book. Using 
+  # Only book_admins may see unapproved comments for a book. Using
   # a lambda to select the correct relation on the model
   has_many :book_comments, relation_name: -> (options = {}) {
     context = options[:context]
@@ -1240,6 +1240,14 @@ JSONAPI.configure do |config|
   config.top_level_meta_record_count_key = :record_count
 
   config.use_text_errors = false
+
+  # List of classes that should not be rescued by the operations processor.
+  # For example, if you use Pundit for authorization, you might
+  # raise a Pundit::NotAuthorizedError at some point during operations
+  # processing. If you want to use Rails' `rescue_from` macro to
+  # catch this error and render a 403 status code, you should add
+  # the `Pundit::NotAuthorizedError` to the `exception_class_whitelist`.
+  config.exception_class_whitelist = []
 end
 ```
 

data/lib/jsonapi/active_record_operations_processor.rb

@@ -29,8 +29,12 @@ class ActiveRecordOperationsProcessor < JSONAPI::OperationsProcessor
     raise e
 
   rescue => e
-    internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)
-    Rails.logger.error { "Internal Server Error: #{e.message} #{e.backtrace.join("\n")}" }
-    return JSONAPI::ErrorsOperationResult.new(internal_server_error.errors[0].code, internal_server_error.errors)
+    if JSONAPI.configuration.exception_class_whitelist.include?(e.class)
+      raise e
+    else
+      internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)
+      Rails.logger.error { "Internal Server Error: #{e.message} #{e.backtrace.join("\n")}" }
+      return JSONAPI::ErrorsOperationResult.new(internal_server_error.errors[0].code, internal_server_error.errors)
+    end
   end
 end

data/lib/jsonapi/acts_as_resource_controller.rb

@@ -103,11 +103,6 @@ module JSONAPI
       {}
     end
 
-    # override to set scope_id
-    def scope_id
-      nil
-    end
-
     # Control by setting in an initializer:
     #     JSONAPI.configuration.json_key_format = :camelized_key
     #     JSONAPI.configuration.route = :camelized_route
@@ -155,8 +150,7 @@ module JSONAPI
         base_meta: base_response_meta,
         base_links: base_response_links,
         resource_serializer_klass: resource_serializer_klass,
-        request: @request,
-        scope_id: scope_id
+        request: @request
       )
     end
 

data/lib/jsonapi/configuration.rb

@@ -16,7 +16,8 @@ module JSONAPI
                 :use_text_errors,
                 :top_level_links_include_pagination,
                 :top_level_meta_include_record_count,
-                :top_level_meta_record_count_key
+                :top_level_meta_record_count_key,
+                :exception_class_whitelist
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -45,6 +46,14 @@ module JSONAPI
       self.top_level_meta_record_count_key = :record_count
 
       self.use_text_errors = false
+
+      # List of classes that should not be rescued by the operations processor.
+      # For example, if you use Pundit for authorization, you might
+      # raise a Pundit::NotAuthorizedError at some point during operations
+      # processing. If you want to use Rails' `rescue_from` macro to
+      # catch this error and render a 403 status code, you should add
+      # the `Pundit::NotAuthorizedError` to the `exception_class_whitelist`.
+      self.exception_class_whitelist = []
     end
 
     def json_key_format=(format)
@@ -77,6 +86,8 @@ module JSONAPI
     attr_writer :top_level_meta_include_record_count
 
     attr_writer :top_level_meta_record_count_key
+
+    attr_writer :exception_class_whitelist
   end
 
   class << self

data/lib/jsonapi/operations_processor.rb

@@ -89,9 +89,13 @@ module JSONAPI
 
     rescue => e
       # :nocov:
-      internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)
-      Rails.logger.error { "Internal Server Error: #{e.message} #{e.backtrace.join("\n")}" }
-      return JSONAPI::ErrorsOperationResult.new(internal_server_error.errors[0].code, internal_server_error.errors)
+      if JSONAPI.configuration.exception_class_whitelist.include?(e.class)
+        raise e
+      else
+        internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)
+        Rails.logger.error { "Internal Server Error: #{e.message} #{e.backtrace.join("\n")}" }
+        return JSONAPI::ErrorsOperationResult.new(internal_server_error.errors[0].code, internal_server_error.errors)
+      end
       # :nocov:
     end
   end

data/lib/jsonapi/resource_serializer.rb

@@ -22,7 +22,6 @@ module JSONAPI
       @key_formatter = options.fetch(:key_formatter, JSONAPI.configuration.key_formatter)
       @route_formatter = options.fetch(:route_formatter, JSONAPI.configuration.route_formatter)
       @base_url = options.fetch(:base_url, '')
-      @scope_id = options[:scope_id]
     end
 
     # Converts a single resource, or an array of resources to a hash, conforming to the JSONAPI structure
@@ -207,12 +206,7 @@ module JSONAPI
     end
 
     def formatted_module_path_from_klass(klass)
-      if klass.name =~ /::[^:]+\Z/
-        path = (@route_formatter.format($`).freeze.gsub('::', '/') + '/').downcase
-        @scope_id ? "#{path}#{@scope_id}/" : path
-      else
-        ''
-      end
+      klass.name =~ /::[^:]+\Z/ ? (@route_formatter.format($`).freeze.gsub('::', '/') + '/').downcase : ''
     end
 
     def self_href(source)

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = '0.4.3'
+    VERSION = '0.4.4'
   end
 end

data/lib/jsonapi/response_document.rb

@@ -36,8 +36,7 @@ module JSONAPI
         fields: @options[:fields],
         base_url: @options.fetch(:base_url, ''),
         key_formatter: @key_formatter,
-        route_formatter: @options.fetch(:route_formatter, JSONAPI.configuration.route_formatter),
-        scope_id: @options[:scope_id]
+        route_formatter: @options.fetch(:route_formatter, JSONAPI.configuration.route_formatter)
       )
     end
 

data/lib/jsonapi/routing_ext.rb

@@ -66,7 +66,7 @@ module ActionDispatch
 
           options[:param] = :id
 
-          options[:path] = format_route(options[:path] || @resource_type)
+          options[:path] = format_route(@resource_type)
 
           if options[:except]
             options[:except] = Array(options[:except])

data/test/controllers/controller_test.rb

@@ -11,6 +11,22 @@ class PostsControllerTest < ActionController::TestCase
     assert json_response['data'].is_a?(Array)
   end
 
+  def test_exception_class_whitelist
+    original_config = JSONAPI.configuration.dup
+    JSONAPI.configuration.operations_processor = :error_raising
+    # test that the operations processor rescues the error when it
+    # has not been added to the exception_class_whitelist
+    get :index
+    assert_response 500
+    # test that the operations processor does not rescue the error when it
+    # has been added to the exception_class_whitelist
+    JSONAPI.configuration.exception_class_whitelist << PostsController::SpecialError
+    get :index
+    assert_response 403
+  ensure
+    JSONAPI.configuration = original_config
+  end
+
   def test_index_filter_with_empty_result
     get :index, {filter: {title: 'post that does not exist'}}
     assert_response :success

data/test/fixtures/active_record.rb

@@ -407,6 +407,19 @@ class CountingActiveRecordOperationsProcessor < ActiveRecordOperationsProcessor
   end
 end
 
+# This processor swaps in a mock for the operation that will raise an exception
+# when it receives the :apply method. This is used to test the
+# exception_class_whitelist configuration.
+class ErrorRaisingOperationsProcessor < ActiveRecordOperationsProcessor
+  def process_operation(operation)
+    mock_operation = Minitest::Mock.new
+    mock_operation.expect(:apply, true) do
+      raise PostsController::SpecialError
+    end
+    super(mock_operation)
+  end
+end
+
 ### CONTROLLERS
 class AuthorsController < JSONAPI::ResourceController
 end
@@ -416,6 +429,13 @@ end
 
 class PostsController < ActionController::Base
   include JSONAPI::ActsAsResourceController
+  class SpecialError < StandardError; end
+
+  # This is used to test that classes that are whitelisted are reraised by
+  # the operations processor.
+  rescue_from PostsController::SpecialError do
+    head :forbidden
+  end
 end
 
 class CommentsController < JSONAPI::ResourceController

data/test/test_helper.rb

@@ -12,6 +12,7 @@ end
 
 require 'rails/all'
 require 'rails/test_help'
+require 'minitest/mock'
 require 'jsonapi-resources'
 
 require File.expand_path('../helpers/value_matchers', __FILE__)
@@ -111,10 +112,6 @@ TestApp.routes.draw do
 
   namespace :api do
     namespace :v1 do
-      scope ":section_id" do
-        jsonapi_resources :people
-      end
-
       jsonapi_resources :people
       jsonapi_resources :comments
       jsonapi_resources :tags
@@ -264,4 +261,3 @@ class TitleValueFormatter < JSONAPI::ValueFormatter
     end
   end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-05 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler