shamu 0.0.21 → 0.0.24

data/lib/shamu/sessions/cookie_store.rb

@@ -51,8 +51,10 @@ module Shamu
 
       # @param [String] private_key the private key used to verify cookie
       #     values.
-      initialize do |private_key = Shamu::Security.private_key, **|
+      def initialize( private_key = Shamu::Security.private_key )
         @private_key = private_key
+
+        super()
       end
 
       # (see SessionStore#fetch)

data/lib/shamu/sessions/session_store.rb

@@ -5,8 +5,8 @@ module Shamu
     # requests.
     module SessionStore
 
-      def self.create( scorpion, *args, **dependencies, &block )
-        return scorpion.fetch Shamu::Sessions::CookieStore, *args, **dependencies, &block if defined? Rack
+      def self.create( scorpion, *args, &block )
+        return scorpion.fetch Shamu::Sessions::CookieStore, *args, &block if defined? Rack
 
         fail "Configure a Shamu::Sessions::SessionStore in your scorpion setup."
       end

data/lib/shamu/version.rb

@@ -2,7 +2,7 @@
 
 module Shamu
   # The primary version number
-  VERSION_NUMBER  = "0.0.21"
+  VERSION_NUMBER  = "0.0.24"
 
   # Version suffix such as 'beta' or 'alpha'
   VERSION_SUFFIX  = ""

data/shamu.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activemodel", ">= 5.0"
   spec.add_dependency "activesupport", ">= 5.0"
-  spec.add_dependency "scorpion-ioc", "~> 0.6"
+  spec.add_dependency "scorpion-ioc", "~> 1.0.1"
   spec.add_dependency "multi_json", "~> 1.11"
   spec.add_dependency "rack", ">= 1"
   spec.add_dependency "listen", "~> 3"

data/spec/lib/shamu/entities/entity_lookup_service_spec.rb

@@ -5,7 +5,7 @@ require_relative "entity_lookup_models"
 describe Shamu::Entities::EntityLookupService do
 
   let( :service ) do
-    scorpion.new( Shamu::Entities::EntityLookupService, { "Water" => EntityLookupServiceSpecs::CustomService }, {} )
+    scorpion.new( Shamu::Entities::EntityLookupService, "Water" => EntityLookupServiceSpecs::CustomService )
   end
 
   describe "#service_class_for" do

data/spec/lib/shamu/entities/list_scope/sorting_spec.rb

@@ -40,7 +40,7 @@ describe Shamu::Entities::ListScope::Paging do
   end
 
   it "includes sorting values in to_param" do
-    expect( klass.new( sort_by: :name ).params ).to eq sort_by: { name: :asc }
+    expect( klass.new( sort_by: :name ).params ).to include sort_by: { name: :asc }
   end
 
   it "is not sorted with defaults" do

data/spec/lib/shamu/entities/null_entity_spec.rb

@@ -90,5 +90,10 @@ describe Shamu::Entities::NullEntity do
     it "inherits from the entity class" do
       expect( Shamu::Entities::NullEntity.for( klass ) ).to be < klass
     end
+
+    it "uses same model name" do
+      expect( Shamu::Entities::NullEntity.for( klass ).model_name ).to be klass.model_name
+    end
+
   end
-end
+end

data/spec/lib/shamu/entities/opaque_id_spec.rb

@@ -2,10 +2,21 @@ require "spec_helper"
 
 describe Shamu::Entities::OpaqueId do
 
+  describe ".opaque_iid" do
+    it "encodes the entity path" do
+      # Patients::Patient[1]
+      expect( Shamu::Entities::OpaqueId.opaque_id( "Patients::Patient[1]" ) ).to eq "UGF0aWVudHM6OlBhdGllbnRbMV0"
+    end
+  end
+
   describe ".to_model_id" do
     it "gets the encoded id for a valid opaque id" do
       # Patients::Patient[1]
-      expect( Shamu::Entities::OpaqueId.to_model_id( "::UGF0aWVudHM6OlBhdGllbnRbMV0=" ) ).to eq 1
+      expect( Shamu::Entities::OpaqueId.to_model_id( "UGF0aWVudHM6OlBhdGllbnRbMV0" ) ).to eq 1
+    end
+
+    it "gets the encoded id for a valid opaque id with mod 4 = 0" do
+      expect( Shamu::Entities::OpaqueId.to_model_id( "RW50aXR5TG9va3VwU2VydmljZVNwZWNzOjpFeGFtcGxlWzVd" ) ).to eq 5
     end
 
     it "is int for raw ids" do
@@ -15,16 +26,12 @@ describe Shamu::Entities::OpaqueId do
 
   describe ".opaque_id?" do
     it "recognizes encoded ids" do
-      expect( Shamu::Entities::OpaqueId.opaque_id?( "::UGF0aWVudHM6OlBhdGllbnRbMV0=" ) ).to be_truthy
+      expect( Shamu::Entities::OpaqueId.opaque_id?( "UGF0aWVudHM6OlBhdGllbnRbMV0" ) ).to be_truthy
     end
 
     it "does not recognize raw numbers" do
       expect( Shamu::Entities::OpaqueId.opaque_id?( "123" ) ).to be_falsy
     end
-
-    it "does not recognize base64 encoded" do
-      expect( Shamu::Entities::OpaqueId.opaque_id?( "UGF0aWVudHM6OlBhdGllbnRbMV0=" ) ).to be_falsy
-    end
   end
 
 end

data/spec/lib/shamu/entities/static_repository_spec.rb

@@ -10,8 +10,8 @@ end
 describe Shamu::Entities::StaticRepository do
   let( :entities ) do
     [
-      scorpion.fetch( StaticRepositorySpec::Entity, { id: 10, name: "First" }, {} ),
-      scorpion.fetch( StaticRepositorySpec::Entity, { id: 20, name: "Last" }, {} ),
+      scorpion.fetch( StaticRepositorySpec::Entity, id: 10, name: "First" ),
+      scorpion.fetch( StaticRepositorySpec::Entity, id: 20, name: "Last" ),
     ]
   end
   let( :repository ) do

data/spec/lib/shamu/rails/entity_spec.rb

@@ -6,7 +6,7 @@ module LoadEntitySpec
     include Shamu::Services::RequestSupport
 
     def find( id )
-      scorpion.fetch ExampleEntity, { id: id }, {}
+      scorpion.fetch ExampleEntity, id: id
     end
 
     def list( params = nil )

data/spec/lib/shamu/rails/features_spec.rb

@@ -11,7 +11,7 @@ describe Shamu::Rails::Features, type: :controller do
   end
 
   hunt( :features_service, Shamu::Features::FeaturesService ) do
-    scorpion.new Shamu::Features::FeaturesService, File.expand_path( "../features.yml", __FILE__ ), {}
+    scorpion.new Shamu::Features::FeaturesService, File.expand_path( "../features.yml", __FILE__ )
   end
 
   hunt( :session_store, Shamu::Sessions::CookieStore )

data/spec/lib/shamu/security/principal_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Shamu::Security::Principal do
+
+  describe "#scoped?" do
+    it "is true for any scope when not limited" do
+      principal = Shamu::Security::Principal.new scopes: nil
+
+      expect( principal ).to be_scoped :all
+      expect( principal ).to be_scoped :bananas
+    end
+
+    it "is true for given scope" do
+      principal = Shamu::Security::Principal.new scopes: [ :admin ]
+
+      expect( principal ).to     be_scoped :admin
+    end
+
+    it "is false for ungiven scope" do
+      principal = Shamu::Security::Principal.new scopes: [ :admin ]
+
+      expect( principal ).not_to be_scoped :bananas
+    end
+  end
+end

data/spec/lib/shamu/services/active_record_crud_spec.rb

@@ -31,6 +31,7 @@ module ActiveRecordCrudSpec
 
   class Service < Shamu::Services::Service
     include Shamu::Services::ActiveRecordCrud
+    include Shamu::Services::ObservableSupport
 
     resource FavoriteEntity, ActiveRecordSpec::Favorite
     define_crud
@@ -170,6 +171,14 @@ describe Shamu::Services::ActiveRecordCrud do
 
       service.create
     end
+
+    it "is observable" do
+      expect do |b|
+        service.observe( &b )
+
+        service.create request
+      end.to yield_control
+    end
   end
 
   describe ".change" do
@@ -232,6 +241,14 @@ describe Shamu::Services::ActiveRecordCrud do
 
       service.update entity
     end
+
+    it "is observable" do
+      expect do |b|
+        service.observe( &b )
+
+        service.update entity
+      end.to yield_control
+    end
   end
 
   describe ".finders" do
@@ -284,8 +301,8 @@ describe Shamu::Services::ActiveRecordCrud do
     it "yields to block if block given" do
       find_klass = Class.new( klass )
       expect do |b|
-        find_klass.define_find do |_|
-          b.to_proc.call
+        find_klass.define_find do |id|
+          b.to_proc.call id
           ActiveRecordSpec::Favorite.all.first
         end
         scorpion.new( find_klass ).find( entity.id )
@@ -311,6 +328,11 @@ describe Shamu::Services::ActiveRecordCrud do
     end
 
     it "uses entity_lookup_list" do
+      # #create caches the result so bypass the cache
+      expect( service ).to receive( :cached_lookup ) do |ids, &block|
+        block.call( ids )
+      end
+
       expect( service ).to receive( :entity_lookup_list ).and_call_original
       service.lookup( entity.id )
     end
@@ -347,6 +369,11 @@ describe Shamu::Services::ActiveRecordCrud do
     end
 
     it "calls #authorize_relation" do
+      # #create caches the result so bypass the cache
+      expect( service ).to receive( :cached_lookup ) do |ids, &block|
+        block.call( ids )
+      end
+
       expect( service ).to receive( :authorize_relation ).with(
         :read,
         kind_of( ActiveRecord::Relation )
@@ -422,7 +449,7 @@ describe Shamu::Services::ActiveRecordCrud do
       expect( records ).to receive( :find ).and_return record
 
       yield_klass = Class.new( klass ) do
-        define_destroy records do
+        define_destroy :destroy, records do
           Shamu::Services::Result.new
         end
       end
@@ -440,6 +467,14 @@ describe Shamu::Services::ActiveRecordCrud do
 
       service.destroy entity.id
     end
+
+    it "is observable" do
+      expect do |b|
+        service.observe( &b )
+
+        service.destroy entity
+      end.to yield_control
+    end
   end
 
   describe ".build_entities" do
@@ -454,7 +489,7 @@ describe Shamu::Services::ActiveRecordCrud do
       Class.new( super() ) do
         define_build_entities do |records|
           records.map do |record|
-            scorpion.fetch ec, { record: record }, {}
+            scorpion.fetch ec, record: record
           end
         end
         public :build_entities

data/spec/lib/shamu/services/lazy_association_spec.rb

@@ -1,31 +1,44 @@
 require "spec_helper"
 
 describe Shamu::Services::LazyAssociation do
+  let( :lazy_class ) { Shamu::Services::LazyAssociation.class_for( Shamu::Entities::Entity ) }
+
   it "calls block to look up association" do
     assoc = double
     expect( assoc ).to receive( :label )
-    lazy = Shamu::Services::LazyAssociation.new( 1 ) { assoc }
+    lazy = lazy_class.new( 1 ) { assoc }
     lazy.label
   end
 
   it "delegates ==" do
     assoc = double
-    lazy = Shamu::Services::LazyAssociation.new( 1 ) { assoc }
+    lazy = lazy_class.new( 1 ) { assoc }
     expect( lazy ).to eq assoc
   end
 
   it "does not delegate id" do
     assoc = double
     expect( assoc ).not_to receive( :id )
-    lazy = Shamu::Services::LazyAssociation.new( 1 ) { assoc }
+    lazy = lazy_class.new( 1 ) { assoc }
     lazy.id
   end
 
   it "has the same class as original object" do
-    assoc = double
+    assoc = double Shamu::Entities::Entity
     expect( assoc ).to receive( :to_entity ).and_return assoc
-    lazy = Shamu::Services::LazyAssociation.new( 1 ) { assoc }
+    lazy = lazy_class.new( 1 ) { assoc }
 
     expect( lazy.to_entity ).to be_kind_of assoc.class
   end
-end
+
+  it "instance of" do
+    lazy = lazy_class.new( 1 ) { Shamu::Entities::Entity.new }
+
+    expect( lazy ).to be_a Shamu::Entities::Entity
+  end
+
+  it "satisfies case compare" do
+    lazy = lazy_class.new( 1 ) { Shamu::Entities::Entity.new }
+    expect( Shamu::Entities::Entity === lazy ).to be_truthy
+  end
+end

data/spec/lib/shamu/services/observable_support_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+require "shamu/active_record"
+
+class ObservableService < Shamu::Services::Service
+  include Shamu::Services::ObservableSupport
+
+  public :with_observers, :notify_observers
+end
+
+describe Shamu::Services::ObservableSupport do
+  let( :service ) { scorpion.new ObservableService }
+  let( :request ) { Shamu::Services::Request.new }
+  let( :action )  { Shamu::Services::ObservedRequest.new request: request }
+
+
+  describe "#notify_observers" do
+    it "notifies all registered observers" do
+      expect do |b|
+        service.observe( &b )
+        service.notify_observers action
+      end.to yield_control
+    end
+  end
+
+  describe "#with_observers" do
+    it "notifies observers" do
+      expect do |b|
+        service.observe( &b )
+        service.with_observers request do |req|
+          Shamu::Services::Result.new request: req
+        end
+      end.to yield_control
+    end
+
+    it "does not yield if action was canceled" do
+      expect do |b|
+        service.observe do |a|
+          a.request_cancel Shamu::Services::Result.new
+        end
+        service.with_observers( request, &b )
+      end.not_to yield_control
+    end
+
+    it "reports an error indicating the request was canceled" do
+      service.observe do |a|
+        a.request_cancel Shamu::Services::Result.new
+      end
+
+      result = service.with_observers request
+
+      expect( result ).not_to be_valid
+      expect( result.errors.full_messages ).to include /canceled/
+    end
+  end
+end

data/spec/lib/shamu/services/observed_request_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+
+describe Shamu::Services::ObservedRequest do
+  let( :request ) { double Shamu::Services::Request }
+  let( :success ) { double Shamu::Services::Result, valid?: true }
+  let( :failure ) { double Shamu::Services::Result, valid?: false }
+
+  let( :action ) do
+    Shamu::Services::ObservedRequest.new request: request
+  end
+
+  before( :each ) do
+    [ success, failure ].each do |result|
+      allow( result ).to receive( :join )
+    end
+  end
+
+  describe "#complete" do
+    context "#on_canceled" do
+      it "is invoked when canceled" do
+        expect do |b|
+          action.on_canceled( &b )
+          action.complete success, true
+        end.to yield_control
+      end
+
+      it "is not invoked if not canceled" do
+        expect do |b|
+          action.on_canceled( &b )
+          action.complete success, false
+        end.not_to yield_control
+      end
+
+      it "joins results" do
+        result = double Shamu::Services::Result
+        expect( failure ).to receive( :join ).with( result )
+        action.on_canceled do |_|
+          result
+        end
+
+        action.complete failure, true
+      end
+    end
+  end
+end

data/spec/lib/shamu/services/request_support_spec.rb

@@ -4,20 +4,24 @@ require "shamu/services"
 module RequestSupportSpec
   class Service < Shamu::Services::Service
     include Shamu::Services::RequestSupport
+    public :extract_params
 
     def process( params )
       with_request( params, Request::Change ) do |request|
         request_hook
-        next error( :base, "nope" ) if request.level < 0
+        next request.error( :base, "nope" ) if request.level < 0
 
         record = OpenStruct.new( request.to_attributes )
-        scorpion.fetch RequestSupportSpec::Entity, { record: record }, {}
+        scorpion.fetch RequestSupportSpec::Entity, record: record
       end
     end
 
     def partial_process( params )
-      with_partial_request( params, Request::Change ) do |_|
+      with_partial_request( params, Request::Change ) do |request|
         request_hook
+
+        record = OpenStruct.new( request.to_attributes )
+        scorpion.fetch RequestSupportSpec::Entity, record: record
       end
     end
 
@@ -156,6 +160,12 @@ describe Shamu::Services::RequestSupport do
 
       expect( result.request.errors ).not_to be_empty
     end
+
+    it "updates the cache after change" do
+      expect( service ).to receive( :recache_entity )
+
+      service.partial_process( request_params )
+    end
   end
 
   describe "#request_for" do
@@ -164,4 +174,45 @@ describe Shamu::Services::RequestSupport do
       expect( request ).to be_a Shamu::Services::Request
     end
   end
+
+  describe "#extract_params" do
+    it "supports string hash as only param" do
+      id, params = service.extract_params( { "id" => 5 }, nil )
+
+      expect( id ).to eq 5
+      expect( params ).to eq id: 5
+    end
+
+    it "supports string hash as second param" do
+      id, params = service.extract_params( 9, "id" => 5 )
+
+      expect( id ).to eq 9
+      expect( params ).to eq id: 5
+    end
+
+    it "supports symbol hash as only param" do
+      id, params = service.extract_params( { id: 5 }, nil )
+
+      expect( id ).to eq 5
+      expect( params ).to eq id: 5
+    end
+
+    it "supports symbol hash as second param" do
+      id, params = service.extract_params( 9, id: 5 )
+
+      expect( id ).to eq 9
+      expect( params ).to eq id: 5
+    end
+
+    it "supports entity as first param" do
+      record = OpenStruct.new( id: 5 )
+      entity = scorpion.fetch RequestSupportSpec::Entity, record: record
+
+      id, params = service.extract_params( entity, nil )
+
+      expect( id ).to eq entity
+      expect( params ).to be_nil
+    end
+  end
+
 end