shamu 0.0.21 → 0.0.24

data/lib/shamu/entities/opaque_id.rb

@@ -9,8 +9,8 @@ module Shamu
     module OpaqueId
       module_function
 
-      PREFIX  = "::".freeze
-      PATTERN = %r{\A#{ PREFIX }[a-zA-Z0-9+/]+={0,3}\z}
+      PATTERN = %r{\A[a-zA-Z0-9+/]+={0,3}\z}
+      NUMERICAL = %r{\A[0-9]+\z}
 
       # @return [String] an opaque value that uniquely identifies the
       # entity.
@@ -21,7 +21,7 @@ module Shamu
                  Entity.compose_entity_path( [ entity ] )
                end
 
-        "#{ PREFIX }#{ Base64.strict_encode64( path ) }"
+        "#{ Base64.strict_encode64( path ).chomp( '=' ) }"
       end
 
       # @return [String,Integer] the encoded raw record id.
@@ -36,18 +36,19 @@ module Shamu
 
       # @return [Array<[String, String]>] decodes the id to it's {EntityPath}.
       def to_entity_path( opaque_id )
-        return nil unless opaque_id && opaque_id.start_with?( PREFIX )
+        return nil unless opaque_id && NUMERICAL !~ opaque_id
 
-        id = opaque_id[ PREFIX.length..-1 ]
-        id = Base64.strict_decode64( id )
-        id
+        id = opaque_id
+        id += "=" * ( 4 - id.length % 4 ) if id.length % 4 > 0
+
+        Base64.strict_decode64( id )
       end
 
       # @param [String] value candidate value
       # @return [Boolean] true if the given value is an opaque id.
       def opaque_id?( value )
         return unless value
-        PATTERN =~ value
+        PATTERN =~ value && NUMERICAL !~ value
       end
     end
   end

data/lib/shamu/error.rb

@@ -17,8 +17,29 @@ module Shamu
 
   # The resource was not found.
   class NotFoundError < Error
-    def initialize( message = :not_found )
-      super translate( message )
+    attr_reader :id
+    attr_reader :resource
+
+    def initialize( message = :not_found, id: :not_set, resource: :not_set )
+      @id = id
+      @resource = resource
+
+      if message == :not_found
+        message =
+          if id != :not_set
+            if resource != :not_set
+              :resource_not_found_with_id
+            else
+              :not_found_with_id
+            end
+          elsif resource != :not_set
+            :resource_not_found
+          else
+            :not_found
+          end
+      end
+
+      super translate( message, id: id, resource: resource )
     end
   end
 
@@ -28,4 +49,4 @@ module Shamu
       super translate( message )
     end
   end
-end
+end

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

@@ -7,8 +7,6 @@ module Shamu
 
         self.verbose = false
 
-        # rubocop:disable Metrics/MethodLength
-
         def up
           return if data_source_exists? Message.table_name
 

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

@@ -27,10 +27,12 @@ module Shamu
           Migration.new.migrate( :up )
         end
 
-        initialize do
+        def initialize
           self.class.ensure_records!
           @channels ||= {}
           @mutex    ||= Mutex.new
+
+          super
         end
 
         # (see EventsService#publish)

data/lib/shamu/events/events_service.rb

@@ -116,7 +116,7 @@ module Shamu
         def deserialize( raw )
           hash = MultiJson.load( raw )
           message_class = hash["class"].constantize
-          scorpion.fetch message_class, hash["attributes"], {}
+          scorpion.fetch message_class, hash["attributes"]
         end
 
         def fetch_channel( name )
@@ -133,4 +133,4 @@ module Shamu
 
     end
   end
-end
+end

data/lib/shamu/events/in_memory/async_service.rb

@@ -9,7 +9,7 @@ module Shamu
       # to handle events coming in on a separate thread.
       class AsyncService < InMemory::Service
 
-        initialize do
+        def initialize
           ObjectSpace.define_finalizer self do
             threads = mutex.synchronize do
               channels.map do |_, state|
@@ -20,6 +20,8 @@ module Shamu
 
             ThreadsWait.all_waits( *threads )
           end
+
+          super
         end
 
         # (see Service#dispatch)
@@ -45,4 +47,4 @@ module Shamu
       end
     end
   end
-end
+end

data/lib/shamu/events/in_memory/service.rb

@@ -12,9 +12,11 @@ module Shamu
       class Service < EventsService
         include ChannelStats
 
-        initialize do
+        def initialize
           @mutex    = Thread::Mutex.new
           @channels = {}
+
+          super
         end
 
         # (see EventsService#publish)

data/lib/shamu/features/features_service.rb

@@ -43,8 +43,10 @@ module Shamu
       # @!method initialize( config_path )
       # @param
       # @return [FeaturesService]
-      initialize do |config_path = nil, **|
+      def initialize( config_path = nil )
         @config_path = config_path || self.class.default_config_path
+
+        super()
       end
 
       # Indicates if the feature is enabled for the current request/session.

data/lib/shamu/features/support.rb

@@ -48,4 +48,4 @@ module Shamu
         end
     end
   end
-end
+end

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

@@ -249,7 +249,7 @@ module Shamu
             payload
           end
 
-          def map_json_resource_payload( resource ) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          def map_json_resource_payload( resource ) # rubocop:disable Metrics/AbcSize
             payload = resource[ :attributes ] ? resource[ :attributes ].dup : {}
             payload[ :id ] = resource[ :id ] if resource.key?( :id )
 

data/lib/shamu/locale/en.yml

@@ -1,8 +1,11 @@
 en:
   shamu:
     errors:
-        not_found: The resource was not found.
-        not_implemented: The method has not been implemented.
+      not_found: The resource was not found.
+      resource_not_found_with_id: The %{resource} with id %{id} was not found.
+      not_found_with_id: The resource with id %{id} was not found.
+      resource_not_found: The %{resource} was not found.
+      not_implemented: The method has not been implemented.
 
     warnings:
 
@@ -19,6 +22,7 @@ en:
         incomplete_setup: Security has been enabled but is not yet configured.
         no_actiev_record_policy_checks: Don't check for policy on ActiveRecord resources. Check their projected Entity instead.
         no_policy_impersonation: Impersonation is not supported by this principal.
+
     events:
       errors:
         unknown_runner: Unknown runner. Each process should offer a consitent but unique runner_id.
@@ -32,3 +36,11 @@ en:
         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."
+
+  activemodel:
+    errors:
+      models:
+        shamu/services/service:
+          attributes:
+            base:
+              canceled: Request was canceled

data/lib/shamu/security/active_record_policy.rb

@@ -25,7 +25,7 @@ module Shamu
     #
     #     def list
     #       entity_list policy.refine_relation( :list, Model::User.all ) do |record|
-    #         scorpion.fetch UserEntity, { record: record }, {}
+    #         scorpion.fetch UserEntity, record: record
     #       end
     #     end
     #
@@ -92,6 +92,7 @@ module Shamu
         #     if no refinement should be applied.
         # @return [void]
         def refine( *actions, model_class, &block )
+          fail "No actions defined" if actions.blank?
           refinements << PolicyRefinement.new( expand_aliases( actions ), model_class, block )
         end
 

data/lib/shamu/security/error.rb

@@ -68,4 +68,4 @@ module Shamu
       end
     end
   end
-end
+end

data/lib/shamu/security/policy.rb

@@ -138,7 +138,9 @@ module Shamu
           @principal_roles ||= begin
             expanded = self.class.expand_roles( *roles )
             expanded << :authenticated if principal.user_id && self.class.role_defined?( :authenticated )
-            expanded
+            expanded.select do |role|
+              principal.scoped?( role )
+            end
           end
         end
 
@@ -151,6 +153,16 @@ module Shamu
           principal.try( :user_id ) == id || related_user_ids.include?( id )
         end
 
+        # @return [Boolean] true if {#principal} has authenticated.
+        def authenticated?
+          principal.try( :user_id )
+        end
+
+        # @return [Boolean] true if the {#principal} has not authenticated.
+        def anonymous?
+          !authenticated?
+        end
+
         # ============================================================================
         # @!group DSL
         #
@@ -179,7 +191,7 @@ module Shamu
         # @return [void]
         def permissions
           if respond_to?( :anonymous_permissions, true ) && respond_to?( :authenticated_permissions, true )
-            if principal.user_id
+            if in_role?( :authenticated )
               authenticated_permissions
             else
               anonymous_permissions
@@ -205,8 +217,6 @@ module Shamu
         # called if the resource offered to {#permit?} is a Class or Module.
         #
         # @example
-          # end
-          # end
         #   permit :read, UserEntity
         #   permit :show, :dashboard
         #   permit :update, UserEntity do |user|

data/lib/shamu/security/principal.rb

@@ -28,14 +28,20 @@ module Shamu
         attr_reader :elevated
         alias_method :elevated?, :elevated
 
+      # @!attribute
+      # @return [Array<Symbol>] security scopes the principal may be used to
+      # authenticate against. When empty, no limits are imposed.
+        attr_reader :scopes
+
       #
       # @!endgroup Attributes
 
-      def initialize( user_id: nil, parent_principal: nil, remote_ip: nil, elevated: false )
+      def initialize( user_id: nil, parent_principal: nil, remote_ip: nil, elevated: false, scopes: nil )
         @user_id          = user_id
         @parent_principal = parent_principal
         @remote_ip        = remote_ip
         @elevated         = elevated
+        @scopes           = scopes
       end
 
       # @return [Array<Object>] all of the user ids in the security principal
@@ -73,6 +79,20 @@ module Shamu
       def service_delegate?
       end
 
+      # @param [Symbol] scope
+      # @return [Boolean] true if the principal is scoped to authenticate the
+      # user for the given scope.
+      def scoped?( scope )
+        scopes.nil? || scopes.include?( scope )
+      end
+
+      # @!attribute
+      # @return [Boolean] true if there is no user associated with the
+      # principal.
+      def anonymous?
+        !user_id
+      end
+
     end
   end
-end
+end

data/lib/shamu/security/roles.rb

@@ -18,9 +18,10 @@ module Shamu
         # @param [Symbol] name of the role.
         # @param [Array<Symbol>] inherits additional roles that are
         #     automatically inherited when the named role is granted.
+        # @param [Array<Symbol>] scopes that the role may be granted in.
         # @return [void]
-        def role( name, inherits: nil )
-          roles[ name.to_sym ] = { inherits: Array( inherits ) }
+        def role( name, inherits: nil, scopes: nil )
+          roles[ name.to_sym ] = { inherits: Array( inherits ), scopes: Array( scopes ) }
         end
 
         # Expand the given roles to include the roles that they have inherited.
@@ -38,7 +39,7 @@ module Shamu
 
         private
 
-          def expand_roles_into( roles, expanded ) # rubocop:disable Metrics/MethodLength
+          def expand_roles_into( roles, expanded )
             raise "No roles defined for #{ name }" unless self.roles.present?
 
             roles.each do |name|

data/lib/shamu/services.rb

@@ -8,5 +8,7 @@ module Shamu
     require "shamu/services/result"
     require "shamu/services/lazy_transform"
     require "shamu/services/lazy_association"
+    require "shamu/services/observable_support"
+    require "shamu/services/observed_request"
   end
-end
+end

data/lib/shamu/services/active_record.rb

@@ -41,7 +41,8 @@ module Shamu
 
           ::ActiveRecord::Base.transaction options do
             result = yield
-            raise ::ActiveRecord::Rollback if result && !result.valid?
+            success = result && ( result.respond_to?( :valid? ) ? result.valid? : true )
+            raise ::ActiveRecord::Rollback unless success
           end
 
           result

data/lib/shamu/services/active_record_crud.rb

@@ -7,7 +7,7 @@ module Shamu
     # @example
     #
     #   class UsersService < Shamu::Services::Service
-    #     include Shamu::Services::Crud
+    #     include Shamu::Services::ActievRecordCrud
     #
     #     # Define the resource that the service will manage
     #     resource UserEntity, Models::User
@@ -35,7 +35,7 @@ module Shamu
     #                    records.pluck( :parent_id )
     #                  end
     #
-    #         scorpion.fetch UserEntity, { parent: parent }, {}
+    #         scorpion.fetch UserEntity, { parent: parent }
     #       end
     #     end
     #   end
@@ -92,6 +92,10 @@ module Shamu
           relation
         end
 
+        def not_found!( id = :not_set )
+          raise Shamu::NotFoundError, id: id, resource: entity_class
+        end
+
       class_methods do
 
         # Declare the entity and resource classes used by the service.
@@ -155,17 +159,18 @@ module Shamu
         # @yieldparam [Array] args any additional arguments injected by an
         # overridden {#with_request} method.
         # @return [void]
-        def define_create( &block )
-          define_method :create do |params = nil|
-            with_request params, request_class( :create ) do |request, *args|
+        def define_create( method = :create, &block )
+          define_method method do |params = nil|
+            with_request params, request_class( method ) do |request, *args|
               record = request.apply_to( model_class.new )
 
               if block_given?
                 result = instance_exec record, request, *args, &block
                 next result if result.is_a?( Services::Result )
+                next unless request.valid?
               end
 
-              authorize! :create, build_entity( record ), request
+              authorize! method, build_entity( record ), request
 
               next record unless record.save
               build_entity record
@@ -183,12 +188,11 @@ module Shamu
         # overridden {#with_request} method.
         # @return [Result] the result of the request.
         # @return [void]
-        def define_change( method, default_scope = model_class, &block ) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/LineLength
+        def define_change( method, default_scope = model_class, &block )
           define_method method do |id, params = nil|
             klass = request_class( method )
 
-            params, id = id, id[ :id ] if !params && !id.respond_to?( :to_model_id )
-            params[ :id ] ||= id       if params
+            id, params = extract_params( id, params )
 
             with_partial_request params, klass do |request, *args|
               record = default_scope.find( id.to_model_id || request.id )
@@ -204,6 +208,7 @@ module Shamu
               if block_given?
                 result = instance_exec record, request, *args, &block
                 next result if result.is_a?( Services::Result )
+                next unless request.valid?
               end
 
               next record unless record.save
@@ -228,17 +233,21 @@ module Shamu
         # @param [ActiveRecord::Relation] default_scope to use when finding
         #     records.
         # @return [void]
-        def define_destroy( default_scope = model_class, &block )
-          define_method :destroy do |params|
-            klass = request_class( :destroy )
+        def define_destroy( method = :destroy, default_scope = model_class, &block )
+          define_method method do |params|
+            klass = request_class( method )
 
             params = { id: params } if params.respond_to?( :to_model_id )
 
             with_request params, klass do |request, *args|
               record = default_scope.find( request.id )
-              authorize! :destroy, build_entity( record ), request
+              authorize! method, build_entity( record ), request
+
+              if block_given?
+                instance_exec record, request, *args, &block
+                next unless request.valid?
+              end
 
-              instance_exec record, request, *args, &block if block_given?
               next record unless record.destroy
             end
           end
@@ -269,9 +278,10 @@ module Shamu
         # @return [void]
         def define_find( default_scope = model_class.all, &block )
           if block_given?
+            define_method :_find_block, &block
             define_method :find do |id|
               wrap_not_found do
-                record = yield( id )
+                record = _find_block( id )
                 authorize! :read, build_entity( record )
               end
             end
@@ -295,9 +305,17 @@ module Shamu
         #     underlying resource.
         # @return [void]
         def define_lookup( default_scope = model_class.all, &block )
+          if block_given?
+            define_method :_lookup_block, &block
+          else
+            define_method :_lookup_block do |ids|
+              default_scope.where( id: ids )
+            end
+          end
+
           define_method :lookup do |*ids|
             cached_lookup( ids ) do |uncached_ids|
-              records = block_given? ? yield( uncached_ids ) : default_scope.where( id: uncached_ids )
+              records = _lookup_block( uncached_ids )
               records = authorize_relation :read, records
               entity_lookup_list records, uncached_ids, entity_class.null_entity
             end
@@ -319,8 +337,14 @@ module Shamu
             list_scope = Entities::ListScope.for( entity_class ).coerce( params )
             authorize! :list, entity_class, list_scope
 
-            records    = block_given? ? yield( scope ) : scope_relation( default_scope, list_scope )
-            records    = authorize_relation( :read, records, list_scope )
+            records =
+              if block_given?
+                instance_exec( list_scope, &block )
+              else
+                scope_relation( default_scope, list_scope )
+              end
+
+            records = authorize_relation( :read, records, list_scope )
 
             entity_list records
           end
@@ -346,7 +370,7 @@ module Shamu
           else
             define_method :build_entities do |records|
               records.map do |record|
-                entity = scorpion.fetch( entity_class, { record: record }, {} )
+                entity = scorpion.fetch( entity_class, record: record )
                 authorize! :read, entity
               end
             end