json-crud-api 0.0.11 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0423b4c02c64dcc84ecb43145267e8ad6b157716
-  data.tar.gz: 18b29475bb8fe29e75c6d9ac97e78a46643087b2
+  metadata.gz: e3e1e5bf85ec51418cbf586a6ccab176542b12d9
+  data.tar.gz: 0e0bd52b46f1ab21e289238d51dbcdee38235cfa
 SHA512:
-  metadata.gz: 73526f31ac42f5986f80754daad727b0d9fc5c1c8bcc43f36f22445282613388cef0e45f69953486919d55b4b6208f9d629251dc20f276681dd2c19c222f8c27
-  data.tar.gz: 2dc288144b95ccc849b14a51818ed8eccdf1dc298e51b37c70eea2f28da9375f4c581da9478fc01f54b3d0640303810e4f779c528cadd0c057139a40ada91349
+  metadata.gz: 899bd551c4ffc00d715d89fba3a41c809eea75280cb0d3f99c1501b9362b056f6c7691ce87dfa8b15eb56270309c7e4f0d648abde8d7a9059a4b095c3d4a2d94
+  data.tar.gz: 45c7ec02f1ad9fe76590023f58a2734272cf468f292782bf3642d337f2ace0c9e8a88f8a3f2ba9c15d9f6356ad438ac31bf81a721882dc1c6da5eb467d119d22

data/lib/json-crud-api/crud.rb

@@ -5,7 +5,7 @@ module JsonCrudApi
     def crud_get_all(key)
       service = settings.services[key]
       presenter = settings.presenters[key]
-      return fail_forbidden unless service.user_authorized_for? :get_all
+      return fail_forbidden unless service.user_authorized_for? @user, :get_all
       entities = service.get_all
       return fail_not_found if entities.nil?
 
@@ -15,7 +15,7 @@ module JsonCrudApi
     def crud_get(key)
       service = settings.services[key]
       presenter = settings.presenters[key]
-      return fail_forbidden unless service.user_authorized_for? :get
+      return fail_forbidden unless service.user_authorized_for? @user, :get
       entity = service.get(params["id"])
       return fail_not_found if entity.nil?
 
@@ -25,7 +25,7 @@ module JsonCrudApi
     def crud_post(key)
       service = settings.services[key]
       presenter = settings.presenters[key]
-      return fail_forbidden unless service.user_authorized_for? :create
+      return fail_forbidden unless service.user_authorized_for? @user, :create
       post_data = presenter.parse @payload, :post
       return fail_with_errors unless service.valid_for? post_data, :create, self
       entity = service.create post_data 
@@ -35,7 +35,7 @@ module JsonCrudApi
     def crud_put(key)
       service = settings.services[key]
       presenter = settings.presenters[key]
-      return fail_forbidden unless service.user_authorized_for? :update
+      return fail_forbidden unless service.user_authorized_for? @user, :update
       put_data = presenter.parse @payload, :put
       return fail_with_errors unless service.valid_for? put_data, :update, self
       return fail_not_found unless service.update params["id"], put_data
@@ -46,7 +46,7 @@ module JsonCrudApi
     def crud_delete(key)
       service = settings.services[key]
       presenter = settings.presenters[key]
-      return fail_forbidden unless service.user_authorized_for? :delete
+      return fail_forbidden unless service.user_authorized_for? @user, :delete
       return fail_not_found unless service.delete params["id"]
       204
     end

data/lib/json-crud-api/service.rb

@@ -3,14 +3,12 @@ require 'rubygems'
 module JsonCrudApi
   class Service
 
-    attr_accessor :log_service, :model, :user, :scope_map, :user_scopes
+    attr_accessor :log_service, :model, :scope_map
 
     def initialize(options)
       @log_service = options[:log_service]
       @model = options[:model]
       @scope_map = options[:scope_map]
-      @user = nil
-      @user_scopes = nil
     end
 
     # Create a record with the given attributes
@@ -51,40 +49,31 @@ module JsonCrudApi
       record.destroy
     end
 
-    # Set the current user
-    def set_user(user)
-      @user = user
-      set_user_scopes(user[:scopes]) unless @user.nil?
-    end
-
-    # Set the current user scopes
-    def set_user_scopes(user_scopes)
-      @user_scopes = user_scopes
-    end
-
     # Find if the params are valid for an operation (defaults to true)
     def valid_for?(params, operation, api_instance)
       true
     end
 
     # Determine if the current user is authorized for the given operation
-    def user_authorized_for?(operation)
+    def user_authorized_for?(user, operation)
       # Auth is disabled if scope map is nil
       return true if @scope_map.nil?
       # Auth succeeds if there is no map for this operation
       return true if @scope_map[operation].nil?
       # Auth fails if user is not logged in
-      return false if @user.nil?
+      return false if user.nil?
       # Auth fails if user has no scopes
-      return false if @user_scopes.nil? or @user_scopes.empty?
+      return false unless user.has_key?(:scopes) 
+      return false unless user[:scopes].is_a?(Array)
+      return false if user[:scopes].empty?
 
       if @scope_map[operation].is_a?(Array)
         # Auth succeeds if the intersection of allowed scopes and mapped scopes is non-empty.
-        return !((@scope_map[operation] & @user_scopes).empty?)
+        return !((@scope_map[operation] & user[:scopes]).empty?)
       end
 
       # Auth succeeds if the mapped scope is singular and the user posesses it
-      @user_scopes.include?(@scope_map[operation])
+      user[:scopes].include?(@scope_map[operation])
     end
   end
 end

data/spec/unit/crud_spec.rb

@@ -2,8 +2,10 @@ require "spec_helper"
 
 describe JsonCrudApi::AuthClient do
   before(:each) do
+    @test_user = { :name=>"Test User", :scopes => ['ADMIN'] }
+
     class CrudTest
-      attr_accessor :test_settings, :test_params, :payload
+      attr_accessor :test_settings, :test_params, :payload, :user
       include JsonCrudApi::Crud
 
       def settings
@@ -16,6 +18,8 @@ describe JsonCrudApi::AuthClient do
     end
 
     @test = CrudTest.new
+    @test.user = @test_user
+    
   end
 
   describe '#crud_get_all' do
@@ -28,13 +32,14 @@ describe JsonCrudApi::AuthClient do
         :services=>OpenStruct.new,
         :presenters=>OpenStruct.new
       })
+
     end
 
     it 'should call get_all on service, render on the presenter, and return JSON' do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:get_all).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :get_all).and_return(true)
       expect(@service).to receive(:get_all).and_return([])
 
       expect(@presenter).to receive(:render).with([], :get_all).and_return({ :test_output => 1})
@@ -46,7 +51,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:get_all).and_return(false)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :get_all).and_return(false)
 
       expect(@test).to receive(:fail_forbidden)
 
@@ -60,7 +65,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:get_all).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :get_all).and_return(true)
       expect(@service).to receive(:get_all).and_return(nil)
 
       expect(@test).to receive(:fail_not_found)
@@ -88,7 +93,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:get).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :get).and_return(true)
       expect(@service).to receive(:get).with(234).and_return([])
 
       expect(@presenter).to receive(:render).with([], :get).and_return({ :test_output => 56})
@@ -100,7 +105,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:get).and_return(false)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :get).and_return(false)
 
       expect(@test).to receive(:fail_forbidden)
 
@@ -114,7 +119,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:get).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :get).and_return(true)
       expect(@service).to receive(:get).with(234).and_return(nil)
 
       expect(@test).to receive(:fail_not_found)
@@ -142,7 +147,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:create).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :create).and_return(true)
       expect(@service).to receive(:valid_for?).with({ :test_output => 12398}, :create, @test).and_return(true)
       expect(@service).to receive(:create).with({ :test_output => 12398}).and_return({ :test_output => 77234})
 
@@ -156,7 +161,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:create).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :create).and_return(true)
       expect(@service).to receive(:valid_for?).with({ :test_output => 12398}, :create, @test).and_return(false)
       
       expect(@presenter).to receive(:parse).with(@test.payload, :post).and_return({ :test_output => 12398})
@@ -173,7 +178,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:create).and_return(false)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :create).and_return(false)
 
       expect(@test).to receive(:fail_forbidden)
 
@@ -201,7 +206,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:update).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :update).and_return(true)
       expect(@presenter).to receive(:parse).with(@test.payload, :put).and_return({ :test_output => 12398})
       expect(@service).to receive(:valid_for?).with({ :test_output => 12398},:update,@test).and_return(true)
       expect(@service).to receive(:update).with(7345, { :test_output => 12398}).and_return(true)
@@ -216,7 +221,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:update).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :update).and_return(true)
       expect(@presenter).to receive(:parse).with(@test.payload, :put).and_return({ :test_output => 12398})
       expect(@service).to receive(:valid_for?).with({ :test_output => 12398},:update,@test).and_return(false)
       expect(@presenter).not_to receive(:render)
@@ -230,7 +235,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:update).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :update).and_return(true)
       expect(@service).to receive(:valid_for?).with({ :test_output => 12398},:update,@test).and_return(true)
       expect(@service).to receive(:update).with(7345, { :test_output => 12398}).and_return(false)
 
@@ -246,7 +251,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:update).and_return(false)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :update).and_return(false)
 
       expect(@test).to receive(:fail_forbidden)
 
@@ -274,7 +279,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:delete).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :delete).and_return(true)
       expect(@service).to receive(:delete).with(234).and_return(true)
 
       expect(@test.send(:crud_delete,'thekey')).to eq 204
@@ -284,7 +289,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:delete).and_return(false)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :delete).and_return(false)
 
       expect(@test).to receive(:fail_forbidden)
 
@@ -297,7 +302,7 @@ describe JsonCrudApi::AuthClient do
       expect(@test.test_settings.services).to receive(:[]).with('thekey').and_return(@service)
       expect(@test.test_settings.presenters).to receive(:[]).with('thekey').and_return(@presenter)
 
-      expect(@service).to receive(:user_authorized_for?).with(:delete).and_return(true)
+      expect(@service).to receive(:user_authorized_for?).with(@test_user, :delete).and_return(true)
       expect(@service).to receive(:delete).with(234).and_return(false)
 
       expect(@test).to receive(:fail_not_found)

data/spec/unit/service_spec.rb

@@ -19,11 +19,6 @@ describe JsonCrudApi::Service do
       expect(@service.model).to be @mock_model
       expect(@service.scope_map).to be @mock_map
     end
-
-    it 'should initialize user and scopes to nil' do
-      expect(@service.user).to be nil
-      expect(@service.user_scopes).to be nil
-    end
   end
 
   describe '#create' do
@@ -130,36 +125,6 @@ describe JsonCrudApi::Service do
     end
   end
 
-  describe '#set_user' do
-    it 'should set user in service to param' do
-      @service.set_user(nil)
-      expect(@service.user).to eq nil
-    end
-
-    it 'should not call set_user_scopes if user is nil' do
-      expect(@service).not_to receive(:set_user_scopes)
-      @service.set_user(nil)
-      expect(@service.user).to eq nil
-    end
-
-    it 'should call set_user_scopes if user is not' do
-      user = { :scopes => [1,2] }
-      expect(@service).to receive(:set_user_scopes).with([1,2])
-      @service.set_user(user)
-      expect(@service.user).to eq user
-    end
-  end
-
-  describe '#set_user_scopes' do
-    it 'should set user_scopes in service to param' do
-      @service.set_user_scopes(nil)
-      expect(@service.user_scopes).to eq nil
-
-      @service.set_user_scopes(234234)
-      expect(@service.user_scopes).to eq 234234
-    end
-  end
-
   describe '#valid_for?' do
     it 'should return true' do
       expect(@service.valid_for?(nil,nil,nil)).to be true
@@ -169,67 +134,59 @@ describe JsonCrudApi::Service do
   describe '#user_authorized_for?' do
     it 'should return true if scope_map is nil' do
       @service.scope_map = nil
-      expect(@service.user_authorized_for?(:one)).to be true
+      expect(@service.user_authorized_for?(nil,:one)).to be true
     end
 
     it 'should return true if scope_map is not nil but no map for operation' do
       @service.scope_map = { :two => 'TWO' }
-      expect(@service.user_authorized_for?(:one)).to be true
+      expect(@service.user_authorized_for?(nil,:one)).to be true
     end
 
-    it 'should return false if user is nil' do
+    it 'should return false if user is nil with non nil scope map' do
       @service.scope_map = { :two => 'TWO' }
-      @service.user = nil
-      expect(@service.user_authorized_for?(:two)).to be false
+      expect(@service.user_authorized_for?(nil, :two)).to be false
     end
 
     it 'should return false if user has nil scopes' do
       @service.scope_map = { :two => 'TWO' }
-      @service.user = { :name => "Tom" }
-      @service.user_scopes = nil
-      expect(@service.user_authorized_for?(:two)).to be false
+      @user = { :name => "Tom", :scopes => nil }
+      expect(@service.user_authorized_for?(@user, :two)).to be false
     end
 
     it 'should return false if user has empty scopes' do
       @service.scope_map = { :two => 'TWO' }
-      @service.user = { :name => "Tom" }
-      @service.user_scopes = []
-      expect(@service.user_authorized_for?(:two)).to be false
+      @user = { :name => "Tom", :scopes => [] }
+      expect(@service.user_authorized_for?(@user, :two)).to be false
     end
 
     it 'should return true if scope map exists in user scopes' do
       @service.scope_map = { :two => 'FIVE'}
-      @service.user = { :name => "Tom" }
-      @service.user_scopes = [ 'ONE', 'TWO', 'FIVE']
-      expect(@service.user_authorized_for?(:two)).to be true
+      @user = { :name => "Tom", :scopes => [ 'ONE', 'TWO', 'FIVE'] }
+      expect(@service.user_authorized_for?(@user, :two)).to be true
     end
 
     it 'should return false if scope map does not exist in user scopes' do
       @service.scope_map = { :two => 'SEVEN'}
-      @service.user = { :name => "Tom" }
-      @service.user_scopes = [ 'ONE', 'TWO', 'FIVE']
-      expect(@service.user_authorized_for?(:two)).to be false
+      @user = { :name => "Tom", :scopes => [ 'ONE', 'TWO', 'FIVE'] }
+      expect(@service.user_authorized_for?(@user, :two)).to be false
     end
 
     it 'should return true if scope map is array and shares one scope with user' do
       @service.scope_map = { :two => ['TWO'] }
-      @service.user = { :name => "Tom" }
-      @service.user_scopes = [ 'ONE', 'TWO', 'THREE']
-      expect(@service.user_authorized_for?(:two)).to be true
+      @user = { :name => "Tom", :scopes => [ 'ONE', 'TWO', 'THREE'] }
+      expect(@service.user_authorized_for?(@user, :two)).to be true
     end
 
     it 'should return true if scope map is array and shares more than one scope with user' do
       @service.scope_map = { :two => ['TWO','THREE'] }
-      @service.user = { :name => "Tom" }
-      @service.user_scopes = [ 'ONE', 'TWO', 'THREE']
-      expect(@service.user_authorized_for?(:two)).to be true
+      @user = { :name => "Tom", :scopes => [ 'ONE', 'TWO', 'THREE'] }
+      expect(@service.user_authorized_for?(@user, :two)).to be true
     end
 
     it 'should return false if scope map is array and does not share scopes with user' do
       @service.scope_map = { :two => ['FOUR'] }
-      @service.user = { :name => "Tom" }
-      @service.user_scopes = [ 'ONE', 'TWO', 'THREE']
-      expect(@service.user_authorized_for?(:two)).to be false
+      @user = { :name => "Tom", :scopes => [ 'ONE', 'TWO', 'THREE'] }
+      expect(@service.user_authorized_for?(@user, :two)).to be false
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-crud-api
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.0
 platform: ruby
 authors:
 - Tom Cully
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake