shamu 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6619b53b0ccf99f395e9ef5687a3eb9cd2fd661
-  data.tar.gz: 425daaaa1d330ffeb4ec885a59e9b0c63e5e1548
+  metadata.gz: 202b665e0d910a1c418ca7a5ea4bb35d441c16c7
+  data.tar.gz: 8089bef31c11ba75389f8c6b417b2b8f1c34e9dd
 SHA512:
-  metadata.gz: 6f1cad8cd5b39cbfe4b186d4dfbb5b4c4f1c5e549dabb829cc801d708516fb15be7e16b8da1f9e1829203ae1d4b695ac6acb8f943767910f716591deb93fc659
-  data.tar.gz: 9cccb625e79e236cc7829cf86db880f0a0ac814847b305137c7e33d222e63ca507c0e373c243c9472d40159e503f65fb5169fb4c1d9e5bd684a6def1aac54662
+  metadata.gz: ab5be942fca9ff72725316a71a84761a28a954c3cb4445073eb94126556569ada8747795c5788811349740e828d83dfabf516fd1b9851c0ac296b993e95c5075
+  data.tar.gz: cce3f9ff5242932c85e3dfc92977ff0a4469439a865213aeb264ee67cde98f3731aeea157651dbbc60fd18c12acff8d938e1eed42b9b2e35750cb00ba7e00496

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.0

data/Gemfile

@@ -3,9 +3,11 @@ source "https://rubygems.org"
 # Specify your gem"s dependencies in shamu.gemspec
 gemspec
 
+gem 'rake'
+
 group :test do
-  gem "activerecord", "~> 4.2.5"
-  gem "actionpack", "~> 4.2.5"
+  gem "activerecord", "~> 5.0"
+  gem "actionpack", "~> 5.0"
   gem "responders", "~> 2.1.2"
   gem "kaminari", "~> 0.16.3", require: false
 
@@ -30,4 +32,4 @@ group :test do
 
   gem "codeclimate-test-reporter", group: :test, require: nil
   gem "rspec_junit_formatter", "~> 0.2.2", platforms: :mri
-end
+end

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] = File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/shamu/attributes.rb

@@ -121,6 +121,8 @@ module Shamu
         # Allow protected attributes to be used without explicitly being set.
         # All 'Attributes' classes are them selves the explicit set of permitted
         # attributes.
+        elsif attributes.respond_to?( :to_unsafe_h )
+          attributes.to_unsafe_h
         elsif attributes.respond_to?( :to_hash )
           attributes.to_hash.symbolize_keys
         elsif attributes.respond_to?( :to_h )
@@ -270,4 +272,4 @@ module Shamu
     end
 
   end
-end
+end

data/lib/shamu/events/active_record/migration.rb

@@ -3,14 +3,14 @@ module Shamu
     module ActiveRecord
 
       # Prepare the database for storing event messages.
-      class Migration < ::ActiveRecord::Migration
+      class Migration < ::ActiveRecord::Migration[5.0]
 
         self.verbose = false
 
         # rubocop:disable Metrics/MethodLength
 
         def up
-          return if table_exists? Message.table_name
+          return if data_source_exists? Message.table_name
 
           # TODO: Need to provide a means for using 64-bit primary keys in
           # databases that support it. Otherwise limited to 4B events.
@@ -38,12 +38,12 @@ module Shamu
         end
 
         def down
-          drop_table Message.table_name if table_exists? Message.table_name
-          drop_table Channel.table_name if table_exists? Channel.table_name
-          drop_table Runner.table_name  if table_exists? Runner.table_name
+          drop_table Message.table_name if data_source_exists? Message.table_name
+          drop_table Channel.table_name if data_source_exists? Channel.table_name
+          drop_table Runner.table_name  if data_source_exists? Runner.table_name
         end
 
       end
     end
   end
-end
+end

data/lib/shamu/json_api/builder_methods/identifier.rb

@@ -7,9 +7,15 @@ module Shamu
         # @param [String] type of the resource.
         # @param [Object] id of the resource.
         # @return [self]
-        def identifier( type, id = nil )
-          output[:type] = @type = type.to_s
-          output[:id]   = id.to_s
+        def identifier( type, id = :not_set )
+          output[:type] = @type = json_type( type )
+
+          output[:id] =
+            if id == :not_set
+              type.id if type.respond_to?( :id )
+            else
+              id.to_s
+            end
 
           self
         end
@@ -24,6 +30,14 @@ module Shamu
 
           attr_reader :type
 
+          def json_type( type )
+            type = type.json_type                  if type.respond_to?( :json_type )
+            type = type.model_name.element         if type.respond_to?( :model_name )
+            type = type.name.demodulize.underscore if type.is_a?( Module )
+
+            type
+          end
+
           def require_identifier!
             fail IncompleteResourceError unless type
           end
@@ -31,4 +45,4 @@ module Shamu
       end
     end
   end
-end
+end

data/lib/shamu/json_api/context.rb

@@ -114,6 +114,8 @@ module Shamu
         def parse_fields( raw )
           return {} unless raw
 
+          raw = raw.to_unsafe_hash if raw.respond_to?( :to_unsafe_hash )
+
           raw.each_with_object( {} ) do |(type, fields), parsed|
             fields = fields.split( "," ) if fields.is_a?( String )
 
@@ -146,4 +148,4 @@ module Shamu
 
     end
   end
-end
+end

data/lib/shamu/json_api/error.rb

@@ -24,5 +24,11 @@ module Shamu
         super translate( :no_presenter, class: resource.class, namespaces: namespaces )
       end
     end
+
+    class NoJsonBodyError < Error
+      def initialize( message = :no_json_body )
+        super
+      end
+    end
   end
-end
+end

data/lib/shamu/json_api/presenter.rb

@@ -45,6 +45,28 @@ module Shamu
         attr_reader :resource
         attr_reader :builder
 
+
+        # Present all the named attributes of the {#resource}.
+        # @param [Array<Symbol>] names of the resource to present.
+        def resource_attributes( *names )
+          names.map do |name|
+            attribute name, attribute_value( resource.send( name ) )
+          end
+        end
+
+        # Get a JSON API safe version of the value.
+        # @param [Object] value the value to be coerced.
+        # @return [Object]
+        def attribute_value( value )
+          case value
+          when Date, DateTime then
+            value.to_date.to_time.iso8601
+          when Time, ActiveSupport::TimeWithZone then
+            value.iso8601
+          else value
+          end
+        end
+
     end
   end
-end
+end

data/lib/shamu/json_api/rails/controller.rb

@@ -8,68 +8,122 @@ module Shamu
       module Controller
         extend ActiveSupport::Concern
 
+        # Pattern to identify request params that hold 'ids'
+        ID_PATTERN = /\A(id|.+_id)\z/
+
         included do
           before_action do
             render json: json_error( "The 'include' parameter is not supported" ), status: :bad_request if params[:include] # rubocop:disable Metrics/LineLength
             request.formats = [ :json_api, :json ]
           end
-        end
 
-        # def process_action( * )
-        #   # If no format has been specfied, default to json_api
-        #   request.parameters[:format] ||= "json_api"
-        #   super
-        # 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.to_json
+          rescue_from Exception, with: :render_unhandled_exception unless ::Rails.env.test?
         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.to_json
-        end
+        private
 
-        # 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.to_json
-        end
+          # @!visibility public
+          #
+          # 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.as_json
+          end
+
+          # @!visibility public
+          #
+          # Present the `resource` as json and render it adding appropriate
+          # HTTP response codes and headers for standard JSON API actions.
+          #
+          # @param [Symbol,Number] status the HTTP status code.
+          # @param (see #json_resource)
+          def render_resource( resource, presenter: nil, status: nil, location: nil, **context, &block )
+            json = json_resource( resource, presenter, **context, &block )
+
+            # Include canonical url to resource if present
+            if data = json[ "data" ]
+              if links = data[ "links" ]
+                location ||= links[ "self" ] if links[ "self" ]
+              end
+            end
+
+            render json: json, status: status, location: location
+          end
+
+          # @!visibility public
+          #
+          # Renders a {Shamu::Services::Result} presenting either the
+          # validation errors or the entity.
+          #
+          # @param [Shamu::Services::Result] result of a service call
+          # @param (see #json_resource)
+          def render_result( result, presenter: nil, status: nil, **context, &block )
+            if result.valid?
+              if result.entity
+                status ||= case request.method
+                           when 'POST'   then :created
+                           when 'DELETE' then :no_content
+                           else               :ok
+                           end
+
+                render_resource result.entity, presenter: presenter, status: status, **context, &block
+              else
+                head status || :no_content
+              end
+            else
+              render json: json_validation_errors( result.errors, **context ), status: :unprocessable_entity
+            end
+          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.as_json
+          end
+
+          # Present the resources as json and render it adding appropriate HTTP
+          # response codes and headers.
+          def render_collection( resources, presenter: nil, pagination: :auto, **context, &block )
+            render json: json_collection( resources, presenter, pagination: pagination, **context, &block )
+          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.as_json
+          end
 
         private
 
@@ -93,12 +147,15 @@ module Shamu
             end
           end
 
-            def json_page_parameter( page_param_name, param, value )
-              page_params = params.reverse_merge page_param_name => {}
-              page_params[page_param_name][param] = value
+          def json_page_parameter( page_param_name, param, value )
+            params = self.params
+            params = params.to_unsafe_hash if params.respond_to?( :to_unsafe_hash )
 
-              page_params
-            end
+            page_params = params.reverse_merge page_param_name => {}
+            page_params[page_param_name][param] = value
+
+            page_params
+          end
 
           # @!visibility public
           #
@@ -127,12 +184,29 @@ module Shamu
 
             response.error error do |builder|
               builder.http_status json_http_status_code_from_error( error )
+              annotate_json_error( error, builder )
               yield builder if block_given?
             end
 
             response.to_json
           end
 
+          def render_unhandled_exception( exception )
+            render json: json_error( exception ), status: :internal_server_error
+          end
+
+          # @!visibility public
+          #
+          # Annotate an exception that is being rendered to the browser - for
+          # example to add current user or security information if available.
+          def annotate_json_error( error, builder )
+            if ::Rails.env.development?
+              builder.meta :type, error.class.to_s
+              builder.meta :backtrace, error.backtrace
+            end
+          end
+
+
           JSON_CONTEXT_KEYWORDS = [ :fields, :namespaces, :presenters ].freeze
 
           # @!visibility public
@@ -157,8 +231,67 @@ module Shamu
           #     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
+              namespaces: namespaces == :not_set ? json_context_namespaces : namespaces,
+              presenters: presenters == :not_set ? json_context_presenters : presenters
+          end
+
+
+          # See (Shamu::Rails::Entity#request_params)
+          def request_params( param_key )
+            if relationships = json_request_payload[ :relationships ]
+              return map_json_resource_payload( relationships[ param_key ][ :data ] ) if relationships.key?( param_key )
+            end
+
+            payload = map_json_resource_payload( json_request_payload )
+
+            request.params.each do |key, value|
+              if ID_PATTERN =~ key
+                payload[ key.to_sym ] ||= value
+              end
+            end
+
+            payload
+          end
+
+          def map_json_resource_payload( resource )
+            payload = resource[ :attributes ] ? resource[ :attributes ].dup : {}
+            payload[ :id ] = resource[ :id ] if resource.key?( :id )
+
+            if relationships = resource[ :relationships ]
+              relationships.each do |key, value|
+                attr_key = "#{ key.to_s.singularize }_id"
+
+                if value[ :data ].is_a?( Array )
+                  attr_key += 's' if value[ :data ].is_a?( Array )
+
+                  payload[ attr_key.to_sym ] = value[ :data ].map { |d| d[ :id ] }
+                  payload[ key ] = value[ :data ].map { |d| map_json_resource_payload( d ) }
+                else
+                  payload[ attr_key.to_sym ] = value[ :data ][ :id ]
+                  payload[ key ] = map_json_resource_payload( value[ :data ] )
+                end
+              end
+            end
+
+            payload
+          end
+
+          # @!visibility public
+          #
+          # Map a JSON body to a hash.
+          # @return [Hash] the parsed JSON payload.
+          def json_request_payload
+            @json_request_payload ||=
+              begin
+                body = request.body.read || "{}"
+                json = JSON.parse( body, symbolize_names: true )
+
+                unless json.blank?
+                  fail NoJsonBodyError unless json[ :data ]
+                end
+
+                json ? json[ :data ] : {}
+              end
           end
 
 
@@ -167,7 +300,7 @@ module Shamu
           end
 
           def json_context_namespaces
-            name = self.class.name.sub /Controller$/, ""
+            name = self.class.name.sub( /Controller$/, "" )
             namespaces = [ name.pluralize ]
             loop do
               name = name.deconstantize
@@ -217,4 +350,4 @@ module Shamu
       end
     end
   end
-end
+end

data/lib/shamu/locale/en.yml

@@ -8,8 +8,9 @@ en:
 
     services:
       errors:
-        active_record_crud_missing_resource: The resource has not been defined. Add `resource entity_class, model_class` to {%service}.
+        active_record_crud_missing_resource: "The resource has not been defined. Add `resource entity_class, model_class` to %{service}."
         incomplete_setup: The service has not been setup. See included modules documentation for details.
+        service_request_failed: 'The service call failed with: %{errors}.'
 
 
     security:
@@ -30,3 +31,4 @@ en:
       errors:
         incomplete_resource: "`identifier` was not called to define the type and id of the resource."
         no_presenter: No presenter available for %{class} objects. Looked in %{namespaces}.
+        no_json_body: "Missing `data` node for JSON API body. Override `json_request_payload` if no body is expected."

data/lib/shamu/rails/controller.rb

@@ -16,8 +16,11 @@ module Shamu
       included do
         include Scorpion::Rails::Controller
 
-        helper_method :permit?
-        helper_method :current_user
+        # ActionController::API does not have #helper_method
+        if respond_to?( :helper_method )
+          helper_method :permit?
+          helper_method :current_user
+        end
       end
 
       private

data/lib/shamu/rails/entity.rb

@@ -9,7 +9,7 @@ module Shamu
       private
 
         def fetch_entity( service, param )
-          service.find( params[ param ] )
+          service.find( params[ param ] ) if params.key?( param )
         end
 
         def fetch_entities( service, param )
@@ -22,16 +22,24 @@ module Shamu
           return unless request = service.request_for( action, entity )
 
           param_key ||= entity.model_name.param_key
+          request.assign_attributes( request_params( param_key ) )
 
+          service.authorize!( action, entity, request ) if service.respond_to?( :authorize! )
+          request
+        end
+
+        # @!visibility public
+        #
+        # Get the raw request hash params for the given parameter key.
+        # @param [Symbol] param_key key of the entity params to fetch.
+        # @return [Hash] the params
+        def request_params( param_key )
           strong_param = :"#{ param_key }_params"
           if respond_to?( strong_param, true )
-            request.assign_attributes( send( strong_param ) )
+            send( strong_param )
           else
-            request.assign_attributes( params[ param_key ] )
+            params[ param_key ]
           end
-
-          service.authorize!( action, entity, request ) if service.respond_to?( :authorize! )
-          request
         end
 
         def load_entity( method:, list_method:, action: nil, only: nil, except: nil )
@@ -44,11 +52,16 @@ module Shamu
         def matching_entity_action?( action, only:, except: )
           return if only.present? && !only.include?( action )
           return if except.present? && except.include?( action )
-          true
+
+          !create_action?( action )
+        end
+
+        def list_action?( action = params[ :action ] )
+          action.to_sym == :index
         end
 
-        def list_action?( action )
-          action == :index
+        def create_action?( action = params[ :action ] )
+          [ :new, :create ].include?( action.to_sym )
         end
 
       class_methods do
@@ -101,7 +114,7 @@ module Shamu
         #     not being modified in an :update request.
         def entity( entity_class, through: nil, as: nil, list: nil, only: nil, except: nil, param: :id, list_param: nil, action: nil, param_key: nil ) # rubocop:disable Metrics/LineLength
           as      ||= entity_as_name( entity_class )
-          through ||= :"#{ as }_service"
+          through ||= :"#{ as.to_s.pluralize }_service"
           list    ||= as.to_s.pluralize.to_sym
 
           define_entity_method( as, through, param )
@@ -132,7 +145,7 @@ module Shamu
                 @#{ as } = fetch_entity( #{ through }, :#{ param } )                         #   @entity = fetch_entity( entity_service, :id )
               end                                                                            # end
 
-              helper_method :#{ as }
+              helper_method :#{ as } if respond_to?( :helper_method )
             RUBY
           end
 
@@ -145,7 +158,7 @@ module Shamu
                 @#{ as } = fetch_entities( #{ through }, #{ param ? ":#{ param }" : 'nil' } ) #   @entities = fetch_entities( entity_service, nil )
               end                                                                             # end
 
-              helper_method :#{ as }
+              helper_method :#{ as } if respond_to?( :helper_method )
             RUBY
           end
 
@@ -155,14 +168,15 @@ module Shamu
 
               def #{ as }_request                                                              # def entity_request
                 return @#{ as }_request if defined? @#{ as }_request                           #   return @entity_request if defined? @entity_request
-                @#{ as }_request = fetch_entity_request( #{ through }, #{ as }, :#{ as } )     #   @entity_request = fetch_entity_request( entity_service, entity, :entity )
+                _entity = #{ as } unless create_action?                                        #   _entity = entity unless create_action?
+                @#{ as }_request = fetch_entity_request( #{ through }, _entity, :#{ as } )     #   @entity_request = fetch_entity_request( entity_service, _entity, :entity )
               end                                                                              # end
 
-              helper_method :#{ as }_request
+              helper_method :#{ as }_request if respond_to?( :helper_method )
             RUBY
           end
 
       end
     end
   end
-end
+end