jsonapi-resources 0.7.1.beta1 → 0.7.1.beta2

data/lib/jsonapi-resources.rb

@@ -1,7 +1,9 @@
+require 'jsonapi/naive_cache'
 require 'jsonapi/resource'
 require 'jsonapi/response_document'
 require 'jsonapi/acts_as_resource_controller'
 require 'jsonapi/resource_controller'
+require 'jsonapi/resource_controller_metal'
 require 'jsonapi/resources/version'
 require 'jsonapi/configuration'
 require 'jsonapi/paginator'
@@ -12,9 +14,9 @@ require 'jsonapi/resource_serializer'
 require 'jsonapi/exceptions'
 require 'jsonapi/error'
 require 'jsonapi/error_codes'
-require 'jsonapi/request'
-require 'jsonapi/operations_processor'
-require 'jsonapi/active_record_operations_processor'
+require 'jsonapi/request_parser'
+require 'jsonapi/operation_dispatcher'
+require 'jsonapi/processor'
 require 'jsonapi/relationship'
 require 'jsonapi/include_directives'
 require 'jsonapi/operation_result'

data/lib/jsonapi/acts_as_resource_controller.rb

@@ -2,11 +2,16 @@ require 'csv'
 
 module JSONAPI
   module ActsAsResourceController
+    MEDIA_TYPE_MATCHER = /(.+".+"[^,]*|[^,]+)/
+    ALL_MEDIA_TYPES = '*/*'
 
     def self.included(base)
       base.extend ClassMethods
+      base.include Callbacks
       base.before_action :ensure_correct_media_type, only: [:create, :update, :create_relationship, :update_relationship]
+      base.before_action :ensure_valid_accept_media_type
       base.cattr_reader :server_error_callbacks
+      base.define_jsonapi_resources_callbacks :process_operations
     end
 
     def index
@@ -54,27 +59,44 @@ module JSONAPI
     end
 
     def process_request
-      @request = JSONAPI::Request.new(params, context: context,
-                                      key_formatter: key_formatter,
-                                      server_error_callbacks: (self.class.server_error_callbacks || []))
+      @request = JSONAPI::RequestParser.new(params, context: context,
+                                            key_formatter: key_formatter,
+                                            server_error_callbacks: (self.class.server_error_callbacks || []))
       unless @request.errors.empty?
         render_errors(@request.errors)
       else
-        operation_results = create_operations_processor.process(@request)
-        render_results(operation_results)
+        process_operations
+        render_results(@operation_results)
       end
 
     rescue => e
       handle_exceptions(e)
-    ensure
-      if response.body.size > 0
-        response.headers['Content-Type'] = JSONAPI::MEDIA_TYPE
+    end
+
+    def process_operations
+      run_callbacks :process_operations do
+        @operation_results = operation_dispatcher.process(@request.operations)
       end
     end
 
-    # set the operations processor in the configuration or override this to use another operations processor
-    def create_operations_processor
-      JSONAPI.configuration.operations_processor.new
+    def transaction
+      lambda { |&block|
+        ActiveRecord::Base.transaction do
+          block.yield
+        end
+      }
+    end
+
+    def rollback
+      lambda {
+        fail ActiveRecord::Rollback
+      }
+    end
+
+    def operation_dispatcher
+      @operation_dispatcher ||= JSONAPI::OperationDispatcher.new(transaction: transaction,
+                                                                 rollback: rollback,
+                                                                 server_error_callbacks: @request.server_error_callbacks)
     end
 
     private
@@ -103,6 +125,36 @@ module JSONAPI
       handle_exceptions(e)
     end
 
+    def ensure_valid_accept_media_type
+      if invalid_accept_media_type?
+        fail JSONAPI::Exceptions::NotAcceptableError.new(request.accept)
+      end
+    rescue => e
+      handle_exceptions(e)
+    end
+
+    def invalid_accept_media_type?
+      media_types = media_types_for('Accept')
+
+      return false if media_types.blank? || media_types.include?(ALL_MEDIA_TYPES)
+
+      jsonapi_media_types = media_types.select do |media_type|
+        media_type.include?(JSONAPI::MEDIA_TYPE)
+      end
+
+      jsonapi_media_types.size.zero? ||
+        jsonapi_media_types.none? do |media_type|
+          media_type == JSONAPI::MEDIA_TYPE
+        end
+    end
+
+    def media_types_for(header)
+      (request.headers[header] || '')
+        .match(MEDIA_TYPE_MATCHER)
+        .to_a
+        .map(&:strip)
+    end
+
     # override to set context
     def context
       {}
@@ -117,7 +169,7 @@ module JSONAPI
     #     JSONAPI.configuration.route = :camelized_route
     #
     # Override if you want to set a per controller key format.
-    # Must return a class derived from KeyFormatter.
+    # Must return an instance of a class derived from KeyFormatter.
     def key_formatter
       JSONAPI.configuration.key_formatter
     end
@@ -152,7 +204,18 @@ module JSONAPI
 
     def render_results(operation_results)
       response_doc = create_response_document(operation_results)
-      render status: response_doc.status, json: response_doc.contents
+
+      render_options = {
+        status: response_doc.status,
+        json:   response_doc.contents,
+        content_type: JSONAPI::MEDIA_TYPE
+      }
+
+      render_options[:location] = response_doc.contents[:data]["links"][:self] if (
+        response_doc.status == :created && response_doc.contents[:data].class != Array
+      )
+
+      render(render_options)
     end
 
     def create_response_document(operation_results)
@@ -179,7 +242,7 @@ module JSONAPI
       when JSONAPI::Exceptions::Error
         render_errors(e.errors)
       else
-        if JSONAPI.configuration.exception_class_whitelist.any? { |k| e.class.ancestors.include?(k) }
+        if JSONAPI.configuration.exception_class_whitelisted?(e)
           fail e
         else
           internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)

data/lib/jsonapi/configuration.rb

@@ -1,29 +1,30 @@
 require 'jsonapi/formatter'
-require 'jsonapi/operations_processor'
-require 'jsonapi/active_record_operations_processor'
+require 'jsonapi/processor'
+require 'concurrent'
 
 module JSONAPI
   class Configuration
     attr_reader :json_key_format,
                 :resource_key_type,
-                :key_formatter,
                 :route_format,
-                :route_formatter,
                 :raise_if_parameters_not_allowed,
-                :operations_processor,
                 :allow_include,
                 :allow_sort,
                 :allow_filter,
                 :default_paginator,
                 :default_page_size,
                 :maximum_page_size,
+                :default_processor_klass,
                 :use_text_errors,
                 :top_level_links_include_pagination,
                 :top_level_meta_include_record_count,
                 :top_level_meta_record_count_key,
+                :top_level_meta_include_page_count,
+                :top_level_meta_page_count_key,
                 :exception_class_whitelist,
                 :always_include_to_one_linkage_data,
-                :always_include_to_many_linkage_data
+                :always_include_to_many_linkage_data,
+                :cache_formatters
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -32,9 +33,6 @@ module JSONAPI
       #:underscored_route, :camelized_route, :dasherized_route, or custom
       self.route_format = :dasherized_route
 
-      #:basic, :active_record, or custom
-      self.operations_processor = :active_record
-
       #:integer, :uuid, :string, or custom (provide a proc)
       self.resource_key_type = :integer
 
@@ -59,6 +57,9 @@ module JSONAPI
       self.top_level_meta_include_record_count = false
       self.top_level_meta_record_count_key = :record_count
 
+      self.top_level_meta_include_page_count = false
+      self.top_level_meta_page_count_key = :page_count
+
       self.use_text_errors = false
 
       # List of classes that should not be rescued by the operations processor.
@@ -74,25 +75,81 @@ module JSONAPI
       # NOTE: always_include_to_many_linkage_data is not currently implemented
       self.always_include_to_one_linkage_data = false
       self.always_include_to_many_linkage_data = false
+
+      # The default Operation Processor to use if one is not defined specifically
+      # for a Resource.
+      self.default_processor_klass = JSONAPI::Processor
+
+      # Formatter Caching
+      # Set to false to disable caching of string operations on keys and links.
+      self.cache_formatters = true
+    end
+
+    def cache_formatters=(bool)
+      @cache_formatters = bool
+      if bool
+        @key_formatter_tlv = Concurrent::ThreadLocalVar.new
+        @route_formatter_tlv = Concurrent::ThreadLocalVar.new
+      else
+        @key_formatter_tlv = nil
+        @route_formatter_tlv = nil
+      end
     end
 
     def json_key_format=(format)
       @json_key_format = format
-      @key_formatter = JSONAPI::Formatter.formatter_for(format)
+      if @cache_formatters
+        @key_formatter_tlv = Concurrent::ThreadLocalVar.new
+      end
+    end
+
+    def route_format=(format)
+      @route_format = format
+      if @cache_formatters
+        @route_formatter_tlv = Concurrent::ThreadLocalVar.new
+      end
+    end
+
+    def key_formatter
+      if self.cache_formatters
+        formatter = @key_formatter_tlv.value
+        return formatter if formatter
+      end
+
+      formatter = JSONAPI::Formatter.formatter_for(self.json_key_format)
+
+      if self.cache_formatters
+        formatter = @key_formatter_tlv.value = formatter.cached
+      end
+
+      return formatter
     end
 
     def resource_key_type=(key_type)
       @resource_key_type = key_type
     end
 
-    def route_format=(format)
-      @route_format = format
-      @route_formatter = JSONAPI::Formatter.formatter_for(format)
+    def route_formatter
+      if self.cache_formatters
+        formatter = @route_formatter_tlv.value
+        return formatter if formatter
+      end
+
+      formatter = JSONAPI::Formatter.formatter_for(self.route_format)
+
+      if self.cache_formatters
+        formatter = @route_formatter_tlv.value = formatter.cached
+      end
+
+      return formatter
+    end
+
+    def exception_class_whitelisted?(e)
+      @exception_class_whitelist.flatten.any? { |k| e.class.ancestors.include?(k) }
     end
 
-    def operations_processor=(operations_processor)
-      @operations_processor_name = operations_processor
-      @operations_processor = JSONAPI::OperationsProcessor.operations_processor_for(@operations_processor_name)
+    def default_processor_klass=(default_processor_klass)
+      @default_processor_klass = default_processor_klass
     end
 
     attr_writer :allow_include, :allow_sort, :allow_filter
@@ -111,6 +168,10 @@ module JSONAPI
 
     attr_writer :top_level_meta_record_count_key
 
+    attr_writer :top_level_meta_include_page_count
+
+    attr_writer :top_level_meta_page_count_key
+
     attr_writer :exception_class_whitelist
 
     attr_writer :always_include_to_one_linkage_data

data/lib/jsonapi/error.rb

@@ -18,6 +18,12 @@ module JSONAPI
       @status         = Rack::Utils::SYMBOL_TO_STATUS_CODE[options[:status]].to_s
       @meta           = options[:meta]
     end
+
+    def to_hash
+      hash = {}
+      instance_variables.each {|var| hash[var.to_s.delete('@')] = instance_variable_get(var) unless instance_variable_get(var).nil? }
+      hash
+    end
   end
 
   class Warning
@@ -31,5 +37,11 @@ module JSONAPI
                           options[:code]
                         end
     end
+
+    def to_hash
+      hash = {}
+      instance_variables.each {|var| hash[var.to_s.delete('@')] = instance_variable_get(var) unless instance_variable_get(var).nil? }
+      hash
+    end
   end
 end

data/lib/jsonapi/error_codes.rb

@@ -22,6 +22,7 @@ module JSONAPI
   SAVE_FAILED = '121'
   FORBIDDEN = '403'
   RECORD_NOT_FOUND = '404'
+  NOT_ACCEPTABLE = '406'
   UNSUPPORTED_MEDIA_TYPE = '415'
   LOCKED = '423'
   INTERNAL_SERVER_ERROR = '500'
@@ -50,6 +51,7 @@ module JSONAPI
       SAVE_FAILED => 'SAVE_FAILED',
       FORBIDDEN => 'FORBIDDEN',
       RECORD_NOT_FOUND => 'RECORD_NOT_FOUND',
+      NOT_ACCEPTABLE => 'NOT_ACCEPTABLE',
       UNSUPPORTED_MEDIA_TYPE => 'UNSUPPORTED_MEDIA_TYPE',
       LOCKED => 'LOCKED',
       INTERNAL_SERVER_ERROR => 'INTERNAL_SERVER_ERROR'

data/lib/jsonapi/exceptions.rb

@@ -18,9 +18,9 @@ module JSONAPI
 
         [JSONAPI::Error.new(code: JSONAPI::INTERNAL_SERVER_ERROR,
                             status: :internal_server_error,
-                            title: I18n.t('jsonapi-resources.exceptions.internal_server_error.title', 
+                            title: I18n.t('jsonapi-resources.exceptions.internal_server_error.title',
                                           default: 'Internal Server Error'),
-                            detail: I18n.t('jsonapi-resources.exceptions.internal_server_error.detail', 
+                            detail: I18n.t('jsonapi-resources.exceptions.internal_server_error.detail',
                                            default: 'Internal Server Error'),
                             meta: meta)]
       end
@@ -35,9 +35,9 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_RESOURCE,
                             status: :bad_request,
-                            title: I18n.t('jsonapi-resources.exceptions.invalid_resource.title', 
+                            title: I18n.t('jsonapi-resources.exceptions.invalid_resource.title',
                                           default: 'Invalid resource'),
-                            detail: I18n.t('jsonapi-resources.exceptions.invalid_resource.detail', 
+                            detail: I18n.t('jsonapi-resources.exceptions.invalid_resource.detail',
                                            default: "#{resource} is not a valid resource.", resource: resource))]
       end
     end
@@ -51,9 +51,9 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::RECORD_NOT_FOUND,
                             status: :not_found,
-                            title: I18n.translate('jsonapi-resources.exceptions.record_not_found.title', 
+                            title: I18n.translate('jsonapi-resources.exceptions.record_not_found.title',
                                                   default: 'Record not found'),
-                            detail: I18n.translate('jsonapi-resources.exceptions.record_not_found.detail', 
+                            detail: I18n.translate('jsonapi-resources.exceptions.record_not_found.detail',
                                                    default: "The record identified by #{id} could not be found.", id: id))]
       end
     end
@@ -67,7 +67,7 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::UNSUPPORTED_MEDIA_TYPE,
                             status: :unsupported_media_type,
-                            title: I18n.translate('jsonapi-resources.exceptions.unsupported_media_type.title', 
+                            title: I18n.translate('jsonapi-resources.exceptions.unsupported_media_type.title',
                                                   default: 'Unsupported media type'),
                             detail: I18n.translate('jsonapi-resources.exceptions.unsupported_media_type.detail',
                                                    default: "All requests that create or update must use the '#{JSONAPI::MEDIA_TYPE}' Content-Type. This request specified '#{media_type}'.",
@@ -76,6 +76,26 @@ module JSONAPI
       end
     end
 
+    class NotAcceptableError < Error
+      attr_accessor :media_type
+
+      def initialize(media_type)
+        @media_type = media_type
+      end
+
+      def errors
+        [JSONAPI::Error.new(code: JSONAPI::NOT_ACCEPTABLE,
+                            status: :not_acceptable,
+                            title: I18n.translate('jsonapi-resources.exceptions.not_acceptable.title',
+                                                  default: 'Not acceptable'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.not_acceptable.detail',
+                                                   default: "All requests must use the '#{JSONAPI::MEDIA_TYPE}' Accept without media type parameters. This request specified '#{media_type}'.",
+                                                   needed_media_type: JSONAPI::MEDIA_TYPE,
+                                                   media_type: media_type))]
+      end
+    end
+
+
     class HasManyRelationExists < Error
       attr_accessor :id
       def initialize(id)
@@ -85,7 +105,7 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::RELATION_EXISTS,
                             status: :bad_request,
-                            title: I18n.translate('jsonapi-resources.exceptions.has_many_relation.title', 
+                            title: I18n.translate('jsonapi-resources.exceptions.has_many_relation.title',
                                                   default: 'Relation exists'),
                             detail: I18n.translate('jsonapi-resources.exceptions.has_many_relation.detail',
                                                    default: "The relation to #{id} already exists.",
@@ -97,7 +117,7 @@ module JSONAPI
       def errors
         [JSONAPI::Error.new(code: JSONAPI::FORBIDDEN,
                             status: :forbidden,
-                            title: I18n.translate('jsonapi-resources.exceptions.to_many_set_replacement_forbidden.title', 
+                            title: I18n.translate('jsonapi-resources.exceptions.to_many_set_replacement_forbidden.title',
                                                   default: 'Complete replacement forbidden'),
                             detail: I18n.translate('jsonapi-resources.exceptions.to_many_set_replacement_forbidden.detail',
                                                    default: 'Complete replacement forbidden for this relationship'))]