shamu 0.0.9 → 0.0.11

data/lib/shamu/rails/railtie.rb

@@ -18,9 +18,14 @@ module Shamu
         config.shamu.json_api.default_url_options = {}
 
         if defined? ::ActionController
-          ::ActionController::Base.send :include, Shamu::Rails::Controller
-          ::ActionController::Base.send :include, Shamu::Rails::Entity
-          ::ActionController::Base.send :include, Shamu::Rails::Features
+          controller_classes = [ ::ActionController::Base ]
+          controller_classes << ::ActionController::API if defined? ::ActionController::API
+
+          controller_classes.each do |klass|
+            klass.send :include, Shamu::Rails::Controller
+            klass.send :include, Shamu::Rails::Entity
+            klass.send :include, Shamu::Rails::Features
+          end
 
           Mime::Type.register Shamu::JsonApi::MIME_TYPE, :json_api
 
@@ -32,11 +37,11 @@ module Shamu
       end
 
       initializer "shamu.insert_middleware" do |app|
-        app.config.middleware.use "Scorpion::Rack::Middleware"
-        app.config.middleware.use "Shamu::Rack::CookiesMiddleware"
-        app.config.middleware.use "Shamu::Rack::QueryParamsMiddleware"
+        app.config.middleware.use Scorpion::Rack::Middleware
+        app.config.middleware.use Shamu::Rack::CookiesMiddleware
+        app.config.middleware.use Shamu::Rack::QueryParamsMiddleware
       end
 
     end
   end
-end
+end

data/lib/shamu/services/active_record.rb

@@ -49,10 +49,10 @@ module Shamu
           if relation.respond_to?( :by_list_scope )
             relation.by_list_scope( list_scope )
           else
-            fail "Can't scope a #{ relation.klass }. Add `scope :by_list_scope, ->(list_scope) { ... }` or include Shamu::Entities::ActiveRecord." # rubocop:disable Metrics/LineLength
+            fail "Can't scope a #{ relation.klass }. Add `scope :by_list_scope, ->(list_scope) { ... }` or extend Shamu::Entities::ActiveRecord." # rubocop:disable Metrics/LineLength
           end
         end
 
     end
   end
-end
+end

data/lib/shamu/services/active_record_crud.rb

@@ -29,12 +29,14 @@ module Shamu
     #     destroy
     #
     #     # Build the entity class from the given record.
-    #     build_entity do |record, records = nil|
-    #       parent = lookup_association( record.parent_id, self ) do
-    #                  records.pluck( :parent_id ) if records
-    #                end
+    #     build_entities do |records|
+    #       records.map do |record|
+    #         parent = lookup_association( record.parent_id, self ) do
+    #                    records.pluck( :parent_id )
+    #                  end
     #
-    #       scorpion.fetch UserEntity, { parent: parent }, {}
+    #         scorpion.fetch UserEntity, { parent: parent }, {}
+    #       end
     #     end
     #   end
     module ActiveRecordCrud
@@ -97,17 +99,16 @@ module Shamu
         # Creates instance and class level methods `entity_class` and
         # `model_class`.
         #
-        # See {.build_entity} for build_entity block details.
+        # See {.build_entities} for build_entities block details.
         #
         # @param [Class] entity_class the {Entities::Entity} class that will be
         #   returned by finders and mutator methods.
         # @param [Class] model_class the {ActiveRecord::Base} model
         # @param [Array<Symbol>] methods the {DSL_METHODS DSL methods} to
         #     include (eg :create, :update, :find, etc.)
-        # @yield (record, records = nil )
-        # @yieldparam [ActiveRecord::Base] record to build an {Entities::Entity}
-        #     for.
-        # @yieldparam [ActiveRecord::Relation] records that are all being built
+        # @yield ( records )
+        # @yieldparam [ActiveRecord::Relation] records to be mapped to an
+        #   entity.
         # @yieldreturn [Entities::Entity] the entity projection for the given
         #     record.
         # @return [void]
@@ -122,7 +123,7 @@ module Shamu
             send method
           end
 
-          build_entity( &block )
+          build_entities( &block )
         end
 
         # @return [Class] the {Entities::Entity} class that the service will
@@ -172,7 +173,11 @@ module Shamu
         # @return [void]
         def change( method = :update, &block )
           define_method method do |id, params = nil|
-            with_request params, request_class( method ) do |request|
+            klass = request_class( method )
+
+            id, params = id.id, id if id.is_a?( klass ) && !params
+
+            with_request params, klass do |request|
               record = model_class.find( id.to_model_id )
               authorize! method, build_entity( record ), request
 
@@ -247,7 +252,7 @@ module Shamu
             define_method :find do |id|
               wrap_not_found do
                 record = yield( id )
-                authorize! :read, build_entity( record )
+                authorize! :read, build_entities( record )
               end
             end
           else
@@ -258,8 +263,8 @@ module Shamu
         end
 
         # Define a `lookup( *ids )` method that takes a list of entity ids to
-        # find. Calls {#build_entity} for each found record, or constructs a
-        # {Entities::NullEntity} for ids that were not found.
+        # find. Calls {#build_entities} to map all found records to entities,
+        # or constructs a {Entities::NullEntity} for ids that were not found.
         #
         # @param [ActiveRecord::Relation] default_scope to use when finding
         #     records.
@@ -317,11 +322,8 @@ module Shamu
           end
         end
 
-        # Define a private `build_entity( record, records = nil )` method that
-        # constructs an {Entities::Entity} from the given `record`. The optional
-        # `records` argument is used when constructing a list of entities so
-        # that associations can all be fetched once and cached while building
-        # the list of entities.
+        # Define a private `build_entities( records )` method that
+        # constructs an {Entities::Entity} for each of the given `records`.
         #
         # If no block is given, creates a simple builder that simply constructs
         # an instance of the {.entity_class} passing `record: record` to the
@@ -329,28 +331,24 @@ module Shamu
         #
         # See {Service#lookup_association} for details on association caching.
         #
-        # @yield (record, records = nil )
-        # @yieldparam [ActiveRecord::Base] record to build an {Entities::Entity}
-        #     for.
-        # @yieldparam [ActiveRecord::Relation] records that are all being built.
-        # @yieldreturn [Entities::Entity] the entity projection for the given
-        #     record.
+        # @yield ( records )
+        # @yieldparam [ActiveRecord::Relation] records to be mapped to
+        #   entities.
+        # @yieldreturn [Array<Entities::Entity>] the projected entities.
         # @return [void]
-        def build_entity( &block )
+        def build_entities( &block )
           if block_given?
-            define_method :build_entity_instance, &block
+            define_method :build_entities, &block
           else
-            define_method :build_entity_instance do |record, _ = nil|
-              scorpion.fetch( entity_class, { record: record }, {} )
+            define_method :build_entities do |records|
+              records.map do |record|
+                entity = scorpion.fetch( entity_class, { record: record }, {} )
+                authorize! :read, entity
+              end
             end
           end
 
-          define_method :build_entity do |record, records = nil|
-            authorize! :read, build_entity_instance( record, records )
-          end
-
-          private :build_entity
-          private :build_entity_instance
+          private :build_entities
         end
 
         private
@@ -361,7 +359,7 @@ module Shamu
 
           def inferred_resource_name
             inferred = name || "Resource"
-            inferred.split( "::" ).last.sub /Service/, ""
+            inferred.split( "::" ).last.sub( /Service/, "" )
           end
 
           def inferred_namespace
@@ -375,4 +373,4 @@ module Shamu
 
     end
   end
-end
+end

data/lib/shamu/services/error.rb

@@ -20,5 +20,15 @@ module Shamu
         super
       end
     end
+
+    class ServiceRequestFailedError < Error
+      attr_reader :result
+
+      def initialize( result )
+        @result = result
+
+        super translate( :service_request_failed, errors: result.errors.full_messages.join( ', ' ) )
+      end
+    end
   end
-end
+end

data/lib/shamu/services/lazy_transform.rb

@@ -7,8 +7,8 @@ module Shamu
       include Enumerable
 
       # @param [Enumerable] source enumerable to transform.
-      # @yieldparam [Object] object the original value.
-      # @yieldreturn the transformed value.
+      # @yieldparam [Array<Object>] objects the original values.
+      # @yieldreturn the transformed values.
       # @yield (object)
       def initialize( source, &transformer )
         @transformer = transformer
@@ -48,7 +48,7 @@ module Shamu
           return @first if defined? @first
           @first = begin
             value = source.first
-            transformer.call( value ) unless value.nil?
+            raise_if_not_transformed( transformer.call( [ value ] ) ).first unless value.nil?
           end
         end
       end
@@ -86,12 +86,17 @@ module Shamu
         attr_reader :transformer
 
         def transformed
-          @transformed ||= source.map( &transformer )
+          @transformed ||= raise_if_not_transformed( transformer.call( source ) )
         end
 
         def transformed?
           !!@transformed
         end
+
+        def raise_if_not_transformed( transformed )
+          raise "Block to LazyTransform did not return an enumerable value" unless transformed.is_a? Enumerable
+          transformed
+        end
     end
   end
 end

data/lib/shamu/services/request_support.rb

@@ -117,7 +117,10 @@ module Shamu
         private
 
           def request_class_namespace
-            @request_class_namespace ||= ( name || "" ).sub( /(Service)?$/, "Request" ).constantize
+            @request_class_namespace ||= ( name || "" ).sub( /(Service)?$/, "" )
+                                                       .singularize
+                                                       .concat( 'Request' )
+                                                       .constantize
           rescue NameError
             self
           end
@@ -145,4 +148,4 @@ module Shamu
       end
     end
   end
-end
+end

data/lib/shamu/services/result.rb

@@ -7,6 +7,7 @@ module Shamu
     class Result
       extend ActiveModel::Translation
 
+
       # ============================================================================
       # @!group Attributes
       #
@@ -17,17 +18,41 @@ module Shamu
       # @return [Entities::Entity] the entity created or changed by the request.
       attr_reader :entity
 
+      # @return [Entities::Entity] the entity created or changed by the request.
+      # @raise [ServiceRequestFailedError] if the result was not valid.
+      def entity!
+        valid!
+        entity
+      end
+
+      # @return [Array<Object>] the values returned by the service call.
+      attr_reader :values
+
+      # @return [Object] the primary return value of the service call.
+      attr_reader :value
+
+      # @return [Object] the primary return value of the service call.
+      # @raise [ServiceRequestFailedError] if the result was not valid.
+      def value!
+        valid!
+        value
+      end
+
       #
       # @!endgroup Attributes
 
-      # @param [Array<#errors>] validation_sources an array of objects that respond to `#errors`
-      #   returning a {ActiveModel::Errors} object.
+      # @param [Array<Object,#errors>] values an array of objects that
+      #   represent the result of the service call. If they respond to `#errors`
+      #   those errors will be included in {#errors} on the result object itself.
       # @param [Request] request submitted to the service. If :not_set, uses
-      #   the first {Request} object found in the `validation_sources`.
+      #   the first {Request} object found in the `values`.
       # @param [Entities::Entity] entity submitted to the service. If :not_set,
-      #   uses the first {Request} object found in the `validation_sources`.
-      def initialize( *validation_sources, request: :not_set, entity: :not_set )
-        validation_sources.each do |source|
+      #   uses the first {Entity} object found in the `values`.
+      def initialize( *values, request: :not_set, entity: :not_set )
+        @values = values
+        @value  = values.first
+
+        values.each do |source|
           request = source if request == :not_set && source.is_a?( Services::Request )
           entity  = source if entity == :not_set && source.is_a?( Entities::Entity )
 
@@ -61,8 +86,16 @@ module Shamu
         ( request && request.model_name ) || ( entity && entity.model_name ) || ActiveModel::Name.new( self, nil, "Request" ) # rubocop:disable Metrics/LineLength
       end
 
+      # @return [self]
+      # @raise [ServiceRequestFailedError] if the result was not valid.
+      def valid!
+        raise ServiceRequestFailedError.new( self ) unless valid?
+        self
+      end
+
       private
 
+
         def append_error_source( source )
           return unless source.respond_to?( :errors )
 
@@ -72,4 +105,4 @@ module Shamu
         end
     end
   end
-end
+end

data/lib/shamu/services/service.rb

@@ -78,6 +78,16 @@ module Shamu
 
       private
 
+        # Maps a single record to an entity. Requires a `build_entities` method
+        # that maps an enumerable set of records to entities.
+        #
+        # @param [Object] record to map.
+        # @return [Entity] the mapped entity.
+        def build_entity( record )
+          mapped = build_entities( [ record ] )
+          mapped && mapped.first
+        end
+
         # @!visibility public
         # Takes a raw enumerable list of records and transforms them to a proper
         # {Entities::List}.
@@ -85,10 +95,9 @@ module Shamu
         # As simple as the method is, it also serves as a hook for mixins to add
         # additional behavior when processing lists.
         #
-        # If a block is not provided, looks for a method `build_entity(record,
-        # records=nil)` where `record` is the individual record to be
-        # transformed and `records` is the original collection or database query
-        # being transformed.
+        # If a block is not provided, looks for a method `build_entities(
+        # records )` that maps a set of records to their corresponding
+        # entities.
         #
         # @param [Enumerable] records the raw list of records.
         # @yield (record)
@@ -99,8 +108,8 @@ module Shamu
         def entity_list( records, &transformer )
           return Entities::List.new [] unless records
           unless transformer
-            fail "Either provide a block or add a private method `def build_entity( record, records = nil )` to #{ self.class.name }." unless respond_to?( :build_entity, true ) # rubocop:disable Metrics/LineLength
-            transformer ||= ->( record ) { build_entity( record, records ) }
+            fail "Either provide a block or add a private method `def build_entities( records )` to #{ self.class.name }." unless respond_to?( :build_entities, true ) # rubocop:disable Metrics/LineLength
+            transformer ||= method( :build_entities )
           end
 
           Entities::List.new LazyTransform.new( records, &transformer )
@@ -325,7 +334,7 @@ module Shamu
 
         # @!visibility public
         #
-        # @overload result( *validation_sources, request: nil, entity: nil )
+        # @overload result( *values, request: nil, entity: nil )
         # @param (see Result#initialize)
         # @return [Result]
         def result( *args )
@@ -354,4 +363,4 @@ module Shamu
         end
     end
   end
-end
+end

data/lib/shamu/services/service_call_failed_error.rb

@@ -0,0 +1,4 @@
+module Shamu
+  module Services
+
+    class 

data/lib/shamu/version.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 module Shamu
   # The primary version number
-  VERSION_NUMBER  = "0.0.9".freeze
+  VERSION_NUMBER  = "0.0.11".freeze
 
   # Version suffix such as 'beta' or 'alpha'
   VERSION_SUFFIX  = "".freeze
 
   # Published version number
   VERSION         = "#{ VERSION_NUMBER }#{ VERSION_SUFFIX }".freeze
-end
+end

data/shamu.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.2.0"
 
 
-  spec.add_dependency "activemodel", "~> 4.2"
-  spec.add_dependency "activesupport", "~> 4.2"
-  spec.add_dependency "scorpion-ioc", "~> 0.5.16"
+  spec.add_dependency "activemodel", ">= 5.0"
+  spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "scorpion-ioc", "~> 0.6"
   spec.add_dependency "multi_json", "~> 1.11.2"
-  spec.add_dependency "rack", "~> 1"
+  spec.add_dependency "rack", ">= 1"
   spec.add_dependency "listen", "~> 3"
   spec.add_dependency "crc32", "~> 1"
   spec.add_dependency "loofah", "~> 2"

data/spec/lib/shamu/json_api/builder_methods/identifier_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+module BuilderMethodsIdentifierSpec
+  class Builder
+    include Shamu::JsonApi::BuilderMethods::Identifier
+
+    attr_reader :output
+
+    def initialize
+      @output = {}
+    end
+  end
+end
+
+describe Shamu::JsonApi::BuilderMethods::Identifier do
+  let( :builder ) { BuilderMethodsIdentifierSpec::Builder.new }
+
+  it "it uses #json_type if available" do
+    type = double( json_type: "magic" )
+
+    builder.identifier( type )
+    expect( builder.output[ :type ] ).to eq "magic"
+  end
+
+  it "it uses #model_name if available" do
+    type = double( model_name: double( element: "record" ) )
+
+    builder.identifier( type )
+    expect( builder.output[ :type ] ).to eq "record"
+  end
+
+  it "it uses class name as last resort" do
+    builder.identifier( BuilderMethodsIdentifierSpec::Builder )
+
+    expect( builder.output[ :type ] ).to eq "builder"
+  end
+
+  it "gets ID from type ifid not provided" do
+    resource = double( id: 56, json_type: "double" )
+
+    builder.identifier resource
+    expect( builder.output[ :id ] ).to eq 56
+    expect( builder.output[ :type ] ).to eq "double"
+  end
+end