shamu 0.0.4 → 0.0.5

data/lib/shamu/rails/json_api.rb

@@ -9,160 +9,131 @@ module Shamu
 
       included do
         before_action do
-          json_api error: "The 'include' parameter is not supported", status: :bad_request if params[:include]
+          render json: json_error( "The 'include' parameter is not supported" ), status: :bad_request if params[:include] # rubocop:disable Metrics/LineLength
         end
       end
 
-      private
-
-        # @!visibility public
-        #
-        # Writes a single resource as a well-formed JSON API response.
-        #
-        # @param [Object] resource to present as JSON.
-        # @param [JsonApi::Presenter] presenter to use when building the
-        #     response. If not given, attempts to find a presenter. See
-        #     {#json_context}
-        # @param (see #json_context)
-        # @yield (response) write additional top-level links and meta
-        #     information.
-        # @yieldparam [JsonApi::Response] response
-        # @return [JsonApi::Response] the presented json response.
-        def json_resource( resource, presenter = nil, **context, &block )
-          context  = json_context( **context )
-          response = Shamu::JsonApi::Response.new( context )
-          response.resource resource, presenter
-          yield response if block_given?
-          response
-        end
+      def process_action( * )
+        # If no format has been specfied, default to json_api
+        request.parameters[:format] ||= "json_api"
+        super
+      end
 
-        # @!visibility public
-        #
-        # Writes a single resource as a well-formed JSON API response.
-        #
-        # @param [Enumerabl<Object>] resources to present as a JSON array.
-        # @param [JsonApi::Presenter] presenter to use when building the
-        #     response. If not given, attempts to find a presenter. See
-        #     {#json_context}
-        # @param (see #json_context)
-        # @yield (response) write additional top-level links and meta
-        #     information.
-        # @yieldparam [JsonApi::Response] response
-        # @return [JsonApi::Response] the presented json response.
-        def json_collection( resources, presenter = nil, pagination: :auto, **context, &block )
-          context  = json_context( **context )
-          response = Shamu::JsonApi::Response.new( context )
-          response.collection resources, presenter
-          json_paginate_resources response, resources, pagination
-          yield response if block_given?
-          response
-        end
+      # Builds a well-formed JSON API response for a single resource.
+      #
+      # @param [Object] resource to present as JSON.
+      # @param [Class] presenter {Presenter} class to use when building the
+      #     response for the given resource. If not given, attempts to find a
+      #     presenter by calling {Context#find_presenter}.
+      # @param (see #json_context)
+      # @yield (response) write additional top-level links and meta
+      #     information.
+      # @yieldparam [JsonApi::Response] response
+      # @return [JsonApi::Response] the presented JSON response.
+      def json_resource( resource, presenter = nil, **context, &block )
+        response = build_json_response( context )
+        response.resource resource, presenter
+        yield response if block_given?
+        response
+      end
 
-        # @!visibility public
-        #
-        # Add page-based pagination links for the resources.
-        #
-        # @param [#current_page,#next_page,#previous_page] resources a collection that responds to `#current_page`
-        # @param [JsonApi::BaseBuilder] builder to add links to.
-        # @param [String] param the name of the page parameter to adjust for
-        def json_paginate( resources, builder, param: "page[number]" )
-          page = resources.current_page
-
-          if resources.respond_to?( :next_page ) ? resources.next_page : true
-            builder.link :next, url_for( params.reverse_merge( param => resources.current_page + 1 ) )
-          end
+      # Builds a well-formed JSON API response for a collection of resources.
+      #
+      # @param [Enumerable<Object>] resources to present as a JSON array.
+      # @param [Class] presenter {Presenter} class to use when building the
+      #     response for each of the resources. If not given, attempts to find
+      #     a presenter by calling {Context#find_presenter}
+      # @param (see #json_context)
+      # @yield (response) write additional top-level links and meta
+      #     information.
+      # @yieldparam [JsonApi::Response] response
+      # @return [JsonApi::Response] the presented JSON response.
+      def json_collection( resources, presenter = nil, pagination: :auto, **context, &block )
+        response = build_json_response( context )
+        response.collection resources, presenter
+        json_paginate_resources response, resources, pagination
+        yield response if block_given?
+        response
+      end
 
-          if resources.respond_to?( :prev_page ) ? resources.prev_page : page > 1
-            builder.link :prev, url_for( params.reverse_merge( param => resources.current_page - 1 ) )
-          end
+      # Add page-based pagination links for the resources to the builder.
+      #
+      # @param [#current_page,#next_page,#previous_page] resources a collection that responds to `#current_page`
+      # @param [JsonApi::BaseBuilder] builder to add links to.
+      # @param [String] param the name of the page parameter to adjust for
+      # @return [void]
+      def json_paginate( resources, builder, param: "page[number]" )
+        page = resources.current_page
+
+        if resources.respond_to?( :next_page ) ? resources.next_page : true
+          builder.link :next, url_for( params.reverse_merge( param => resources.current_page + 1 ) )
         end
 
-        # @!visiblity public
-        #
-        # Write an error response. See {Shamu::JsonApi::Response#error} for details.
-        #
-        # @param (see Shamu::JsonApi::Response#error)
-        # @return [Shamu::JsonApi::Response]
-        # @yield (builder)
-        # @yieldparam [Shamu::JsonApi::ErrorBuilder] builder to customize the
-        #     error response.
-        def json_error( exception = nil, http_status = :auto, **context, &block )
-          context  = json_context( **context )
-          response = Shamu::JsonApi::Response.new( context )
-
-          http_status = json_http_status_code_from_error( exception ) if http_status == :auto
-          http_status = ::Rack::Utils.status_code( http_status )      if http_status
-          response.error( exception, http_status, &block )
-          response
+        if resources.respond_to?( :prev_page ) ? resources.prev_page : page > 1
+          builder.link :prev, url_for( params.reverse_merge( param => resources.current_page - 1 ) )
         end
+      end
 
-        # @!visibility public
-        #
-        # Buid a {JsonApi::Context} for the current request and controller.
-        #
-        # @param [Hash<Symbol,Array>] fields to include in the response. If not
-        #     provided looks for a `fields` request argument and parses that.
-        #     See {JsonApi::Context#initialize}.
-        # @param [Array<String>] namespaces to look for {Presenter presenters}.
-        #     If not provided automatically adds the controller name and it's
-        #     namespace.
-        #
-        #     For example in the `Users::AccountController` it will add the
-        #     `Users::Accounts` and `Users` namespaces.
-        #
-        #     See {JsonApi::Context#find_presenter}.
-        # @param [Hash<Class,Class>] presenters a hash that maps resource classes
-        #     to the presenter class to use when building responses. See
-        #     {JsonApi::Context#find_presenter}.
-        def json_context( fields: :not_set, namespaces: :not_set, presenters: :not_set )
-          Shamu::JsonApi::Context.new fields: fields == :not_set ? json_context_fields : fields,
-                                      namespaces: namespaces == :not_set ? json_context_namespaces : namespaces,
-                                      presenters: presenters == :not_set ? json_context_presenters : presenters
+      # Write an error response. See {Shamu::JsonApi::Response#error} for details.
+      #
+      # @param (see Shamu::JsonApi::Response#error)
+      # @yield (builder)
+      # @yieldparam [Shamu::JsonApi::ErrorBuilder] builder to customize the
+      #     error response.
+      # @return [JsonApi::Response] the presented JSON response.
+      def json_error( error = nil, **context, &block )
+        response = build_json_response( context )
+
+        response.error error do |builder|
+          builder.http_status json_http_status_code_from_error( error )
+          yield builder if block_given?
         end
 
-        # rubocop:disable Metrics/PerceivedComplexity
-
-        # @!visibility public
-        #
-        # Render a JSON API response for a resource, collection or error.
-        #
-        # @overload json_api( error:, status: :auto, **context, &block )
-        #   @param [Exception] error an error to report
-        #   @param [Symbol,Integer] status the HTTP status code to return. If
-        #       :auto, attempts to determine the proper response from the
-        #       exception and request type.
-        #   @param (see #json_context)
-        # @overload json_api( resource:, status: :auto, presenter: nil, **context, &block )
-        #   @param [Object] resource  the resource to render.
-        #   @param [Symbol,Integer] status the HTTP status code. If :auto
-        #       attempts to determine the proper response from the request type.
-        #   @param (see #json_resource)
-        #   @param [Shamu::JsonApi::Presenter] presenter to use when serializing
-        #     the resource.
-        # @overload json_api( collection:, status: :ok, presenter: nil, **context, &block )
-        #   @param [Array<Object>] collection to render.
-        #   @param [Symbol,Integer] statis HTTP status code.
-        #   @param (see #json_collection)
-        #   @param [Shamu::JsonApi::Presenter] presenter to use when serializing
-        #     each of the resources.
-        def json_api( error: nil, resource: nil, collection: nil, status: :auto, presenter: nil, pagination: :auto, **context, &block ) # rubocop:disable  Metrics/LineLength
-          options = { layout: nil }
-
-          options[:json] =
-            if error
-              status = json_http_status_code_from_error( error ) if status == :auto
-              json_error( error, status, **context, &block )
-            elsif collection
-              status = :ok if status == :auto
-              json_collection( collection, presenter, pagination: pagination, **context, &block )
-            else
-              status = json_http_status_code_from_request if status == :auto
-              json_resource( resource, presenter, **context, &block )
-            end
+        response
+      end
 
-          options[:status] = status if status
-          render options.merge( context.except( :fields, :namespaces, :presenters ) )
-        end
+      # Write all the validation errors from a record to the response.
+      #
+      # @param (see Shamu::JsonApi::Response#validation_errors)
+      # @yield (builder, attr, message)
+      # @yieldparam (see Shamu::JsonApi::Response#validation_errors)
+      # @return [JsonApi::Response] the presented JSON response.
+      def json_validation_errors( errors, **context, &block )
+        response = build_json_response( context )
+        response.validation_errors errors, &block
+
+        response
+      end
+
+      JSON_CONTEXT_KEYWORDS = [ :fields, :namespaces, :presenters ].freeze
+
+      # @!visibility public
+      #
+      # Build a {JsonApi::Context} for the current request and controller.
+      #
+      # @param [Hash<Symbol,Array>] fields to include in the response. If not
+      #     provided looks for a `fields` request argument and parses that.
+      #     See {JsonApi::Context#initialize}.
+      # @param [Array<String>] namespaces to look for {Presenter presenters}.
+      #     If not provided automatically adds the controller name and it's
+      #     namespace.
+      #
+      #     For example in the `Users::AccountController` it will add the
+      #     `Users::Accounts` and `Users` namespaces.
+      #
+      #     See {JsonApi::Context#find_presenter}.
+      # @param [Hash<Class,Class>] presenters a hash that maps resource classes
+      #     to the presenter class to use when building responses. See
+      #     {JsonApi::Context#find_presenter}.
+      # @return [JsonApi::Context] the builder context honoring any filter
+      #     parameters sent by the client.
+      def json_context( fields: :not_set, namespaces: :not_set, presenters: :not_set )
+        Shamu::JsonApi::Context.new fields: fields == :not_set ? json_context_fields : fields,
+                                    namespaces: namespaces == :not_set ? json_context_namespaces : namespaces,
+                                    presenters: presenters == :not_set ? json_context_presenters : presenters
+      end
+
+      private
 
         def json_context_fields
           params[:fields]
@@ -212,6 +183,10 @@ module Shamu
           else              :ok
           end
         end
+
+        def build_json_response( context )
+          Shamu::JsonApi::Response.new( json_context( **context.slice( *JSON_CONTEXT_KEYWORDS ) ) )
+        end
     end
   end
 end

data/lib/shamu/rails/json_api_responder.rb

@@ -0,0 +1,53 @@
+module Shamu
+  module Rails
+
+    # Support JSON API responses with the standard rails `#respond_with` method.
+    module JsonApiResponder
+
+      # Render the response as JSON
+      # @return [String]
+      def to_json
+        if has_errors?
+          display_errors
+        elsif get?
+          display resource
+        elsif put? || patch?
+          display resource, :location => api_location
+        elsif post?
+          display resource, :status => :created, :location => api_location
+        else
+          head :no_content
+        end
+      end
+      alias_method :to_json_api, :to_json
+
+      protected
+
+        # @visibility private
+        def display( resource, given_options = {} )
+          given_options.merge!( options )
+
+          json =
+            if resource.is_a?( Enumerable )
+              controller.json_collection resource, **given_options
+            else
+              controller.json_resource resource, **given_options
+            end
+
+          super json, given_options
+        end
+
+        # @visibility private
+        def display_errors
+          controller.render format => controller.json_validation_errors( resource_errors ), :status => :unprocessable_entity # rubocop:disable Metrics/LineLength
+        end
+
+      private
+
+        def validation_resource?( resource )
+          resource.respond_to?( :valid? ) && resource.respond_to?( :errors )
+        end
+
+    end
+  end
+end

data/lib/shamu/rails/railtie.rb

@@ -1,4 +1,5 @@
 require "shamu/rack"
+require "shamu/json_api"
 
 module Shamu
   module Rails
@@ -16,7 +17,13 @@ module Shamu
           ::ActionController::Base.send :include, Shamu::Rails::Controller
           ::ActionController::Base.send :include, Shamu::Rails::Entity
           ::ActionController::Base.send :include, Shamu::Rails::Features
-          ::ActionController::Base.send :include, Shamu::Rails::JsonApi
+
+          Mime::Type.register Shamu::JsonApi::MIME_TYPE, :json_api
+
+          ActionController::Renderers.add :json_api do |obj, _options|
+            self.content_type ||= Mime[:json_api]
+            obj
+          end
         end
       end
 

data/lib/shamu/rails.rb

@@ -6,6 +6,7 @@ module Shamu
     require "shamu/rails/controller"
     require "shamu/rails/features"
     require "shamu/rails/json_api"
+    require "shamu/rails/json_api_responder"
     require "shamu/rails/railtie"
   end
 end

data/lib/shamu/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Shamu
   # The primary version number
-  VERSION_NUMBER  = "0.0.4".freeze
+  VERSION_NUMBER  = "0.0.5".freeze
 
   # Version suffix such as 'beta' or 'alpha'
   VERSION_SUFFIX  = "".freeze

data/spec/lib/shamu/json_api/base_builder_spec.rb

@@ -4,18 +4,6 @@ describe Shamu::JsonApi::BaseBuilder do
   let( :context ) { Shamu::JsonApi::Context.new }
   let( :builder ) { Shamu::JsonApi::BaseBuilder.new( context ) }
 
-  before( :each ) do
-    builder.identifier "example", 1
-  end
-
-  describe "#identifier" do
-    it "writes type and id" do
-      builder.identifier "spec", 5
-
-      expect( builder.compile ).to include type: "spec", id: "5"
-    end
-  end
-
   describe "#link" do
     it "adds a link" do
       builder.link :self, "http://localhost"
@@ -32,11 +20,4 @@ describe Shamu::JsonApi::BaseBuilder do
     end
   end
 
-  describe "#compile" do
-    it "fails if identifier has not been specified" do
-      expect do
-        Shamu::JsonApi::BaseBuilder.new( context ).compile
-      end.to raise_error Shamu::JsonApi::IncompleteResourceError
-    end
-  end
 end

data/spec/lib/shamu/json_api/context_spec.rb

@@ -43,18 +43,18 @@ describe Shamu::JsonApi::Context do
       klass = Class.new( Shamu::JsonApi::Presenter )
 
       context = Shamu::JsonApi::Context.new presenters: { String => klass }
-      expect( context.find_presenter( "Ms. Piggy" ) ).to be_a klass
+      expect( context.find_presenter( "Ms. Piggy" ) ).to eq klass
     end
 
     it "finds implicitly named presenter in namespaces" do
       context = Shamu::JsonApi::Context.new namespaces: [ "JsonApiContextSpec" ]
-      expect( context.find_presenter( :symbols ) ).to be_a JsonApiContextSpec::SymbolPresenter
+      expect( context.find_presenter( :symbols ) ).to eq JsonApiContextSpec::SymbolPresenter
     end
 
     it "finds implicitly named model_name presenter in namespaces" do
       resource = double model_name: ActiveModel::Name.new( Class, nil, "JsonApiContextSpec::Symbol" )
       context = Shamu::JsonApi::Context.new namespaces: [ "JsonApiContextSpec" ]
-      expect( context.find_presenter( resource ) ).to be_a JsonApiContextSpec::SymbolPresenter
+      expect( context.find_presenter( resource ) ).to eq JsonApiContextSpec::SymbolPresenter
     end
 
     it "raises if no presenter can be found" do

data/spec/lib/shamu/json_api/error_builder_spec.rb

@@ -3,14 +3,6 @@ require "spec_helper"
 describe Shamu::JsonApi::ErrorBuilder do
   let( :builder ) { Shamu::JsonApi::ErrorBuilder.new }
 
-  describe "#summary" do
-    it "infers title" do
-      builder.summary 422, :not_allowed
-
-      expect( builder.compile ).to include title: "Not Allowed"
-    end
-  end
-
   describe "#exception" do
     before( :each ) do
       builder.exception NotImplementedError.new( "Nope, we haven't done that yet" )

data/spec/lib/shamu/json_api/relationship_builder_spec.rb

@@ -1,5 +1,27 @@
 require "spec_helper"
 
 describe Shamu::JsonApi::RelationshipBuilder do
+  let( :context ) { Shamu::JsonApi::Context.new }
+  let( :builder ) { Shamu::JsonApi::RelationshipBuilder.new( context ) }
+
+  before( :each ) do
+    builder.identifier "example", 1
+  end
+
+  describe "#compile" do
+    it "fails if identifier has not been specified" do
+      expect do
+        Shamu::JsonApi::RelationshipBuilder.new( context ).compile
+      end.to raise_error Shamu::JsonApi::IncompleteResourceError
+    end
+  end
+
+  describe "#identifier" do
+    it "writes type and id" do
+      builder.identifier "spec", 5
+
+      expect( builder.compile ).to include data: hash_including( type: "spec", id: "5" )
+    end
+  end
 
 end

data/spec/lib/shamu/json_api/resource_builder_spec.rb

@@ -4,10 +4,19 @@ describe Shamu::JsonApi::RelationshipBuilder do
   let( :context ) { Shamu::JsonApi::Context.new }
   let( :builder ) { Shamu::JsonApi::ResourceBuilder.new( context ) }
 
+
   before( :each ) do
     builder.identifier "example", 1
   end
 
+  describe "#identifier" do
+    it "writes type and id" do
+      builder.identifier "spec", 5
+
+      expect( builder.compile ).to include type: "spec", id: "5"
+    end
+  end
+
   describe "#attribute" do
     it "adds to the attributes node" do
       builder.attribute name: "Jim"
@@ -49,4 +58,12 @@ describe Shamu::JsonApi::RelationshipBuilder do
     end
   end
 
+  describe "#compile" do
+    it "fails if identifier has not been specified" do
+      expect do
+        Shamu::JsonApi::ResourceBuilder.new( context ).compile
+      end.to raise_error Shamu::JsonApi::IncompleteResourceError
+    end
+  end
+
 end

data/spec/lib/shamu/json_api/response_spec.rb

@@ -1,14 +1,21 @@
 require "spec_helper"
+require "active_model"
 
 describe Shamu::JsonApi::Response do
   let( :context )  { Shamu::JsonApi::Context.new }
   let( :response ) { Shamu::JsonApi::Response.new context }
 
   it "uses presenter if given" do
-    presenter = double Shamu::JsonApi::Presenter
-    expect( presenter ).to receive( :present ) do |_, builder|
-      builder.identifier :response, 9
-    end.with( anything, kind_of( Shamu::JsonApi::ResourceBuilder ) )
+    presenter = double
+    expect( presenter ).to receive( :new ) do |resource, builder|
+      instance = Shamu::JsonApi::Presenter.new resource, builder
+
+      expect( instance ).to receive( :present ) do
+        builder.identifier :response, 9
+      end
+
+      instance
+    end
 
     response.resource double, presenter
   end
@@ -39,4 +46,27 @@ describe Shamu::JsonApi::Response do
 
     expect( response.compile ).to include errors: [ hash_including( code: "not_implemented" ) ]
   end
+
+  it "writes validation errors" do
+    klass = Class.new do
+      include ActiveModel::Validations
+
+      attr_reader :title
+      validates :title, presence: true
+
+      validate :general_problem
+
+      def general_problem
+        errors.add :base, "nope"
+      end
+    end
+
+    allow( klass ).to receive( :name ).and_return "Example"
+    record = klass.new
+    record.valid?
+
+    response.validation_errors record.errors
+    expect( response.compile ).to include errors: include( hash_including( source: { pointer: "/data/attributes/title" } ) ) # rubocop:disable Metrics/LineLength
+    expect( response.compile ).to include errors: include( hash_including( source: { pointer: "/data" } ) )
+  end
 end