simon_says 0.3.0.alpha.3 → 0.3.0.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab60ddcb71d25abd747c76c6ab0758b7cb3e2e4bc7cc3fef23cab0b42abc1d1f
-  data.tar.gz: bd0e7a95fcf5669a560028034fcf4f15386b00d73d9170bdaab0cb328ee7099f
+  metadata.gz: 2ebffb1d29f995636c2c9997b8e86a795b4a7ec08cc9dfcd6fd1bca31463203c
+  data.tar.gz: 0fb849d27ded008910437acd78b9470975b436702f917a52ae101f7ef6a0e2f9
 SHA512:
-  metadata.gz: 176d279798d67b2ca54c014397766c79ccb735d35c5ff790eb0a57ae3f27be7c4920a1492a4823d7611d7ad3855dec84012a519d0c9a56ec7be97ff943970ff1
-  data.tar.gz: '098fb9a5b568ae853a9b7840910777a932a8aa0796a030281acc890b2bdb9006ba87df04b835c394350d2cac1d5d215faf2f139441d97a18ff7506a18e4b2303'
+  metadata.gz: cdb55a962f39d5d0df49579a37cf997e4acba5fc41e375429ff38b2ffcaadd6b9377861e661ab573833f4fe8fe58eb9981ae9b8ab5c9ed5d5f7655290c9e022c
+  data.tar.gz: ea2a382c7226db07795804807280ee24e4c834bb9d7316a3122c62c718cea195a61a45504668150f208ed420f8b0f34a5613f5facc3bfe11a94397eeb244ff5e

data/lib/simon_says/authorizer.rb

@@ -12,6 +12,7 @@ module SimonSays
 
     included do
       class_attribute :default_authorization_scope
+      class_attribute :default_find_attribute
     end
 
     module ClassMethods
@@ -41,7 +42,10 @@ module SimonSays
       #   default, +:id+ is used
       # @param opts [Symbol] :param_key params key for resource query; by default,
       #   +:id+ is used
-      # @param opts [Symbol] :through through model to use when finding resource
+      # @param opts [Symbol] :through through model to use when finding and
+      #   authorizing the resource. Mutually exclusive with the :with option.
+      # @param opts [Symbol] :with what resource to authorize with. Mutually
+      #   exclusive with the :through option.
       # @param opts [Symbol] :namespace resource namespace
       #
       # @see #find_resource for finder option examples
@@ -87,22 +91,37 @@ module SimonSays
         end
       end
 
-      # Authorize against a given resource
+      # Authorize against a given resource. This resource should be an instance
+      # that includes Roleable.
       #
       # @param [Symbol, String] resource name of resource to find
       # @param [Array<Symbol, String>] roles one or more role symbols or strings
       # @param [Hash] opts before_action options
       #
       # @example Authorize resource
-      #   authorize_resource :admin, :support
-      def authorize_resource(resource, *roles)
+      #   authorize_with :admin, :support
+      def authorize_with(resource, *roles)
         opts = roles.extract_options!
 
         before_action action_options(opts) do
-          authorize roles, { resource: resource }
+          authorize roles, { with: resource }
         end
       end
 
+      # Authorize with the +default_authorization_scope+. The instance returned
+      # by the +default_authorization_scope+ should include Roleable.
+      #
+      # @param [Array<Symbol, String>] roles one or more role symbols or strings
+      # @param [Hash] opts before_action options
+      #
+      # @example Authorize "content" and "marketing" using the current Admin
+      #   self.default_authorization_scope = :current_admin
+      #
+      #   authorize :content, :marketing
+      def authorize(*roles)
+        authorize_with(default_authorization_scope, *roles)
+      end
+
       # Extract before_action options from Hash
       #
       # @private
@@ -145,10 +164,15 @@ module SimonSays
     # @param [Symbol, String] one or more required roles
     # @param [Hash] options authorizer options
     def authorize(required = nil, options)
-      if through = options[:through]
-        name = through.to_s.singularize.to_sym
+      if options.key? :through
+        name = options[:through].to_s.singularize.to_sym
+      elsif options.key? :with
+        name = options[:with].to_s.singularize.to_sym
       else
-        name = options[:resource]
+        raise ArgumentError, 'find_and_authorize must be called with either '\
+          ':through or :with option. The resource referenced by the value '\
+          'of this option should be an instance of a class that includes '\
+          'Roleable.'
       end
 
       record = instance_variable_get("@#{name}")
@@ -176,7 +200,7 @@ module SimonSays
     # @private
     def resource_scope_and_query(resource, options)
       if options[:through]
-        field = "#{resource}_id"
+        field = :"#{resource}_id"
 
         query = { field => params[field] } if params[field]
         scope = send(self.class.default_authorization_scope)
@@ -191,7 +215,10 @@ module SimonSays
         scope = klass.classify.constantize
       end
 
-      field ||= options.fetch(:find_attribute, :id)
+      field ||= options.fetch(:find_attribute) do
+        self.class.default_find_attribute&.call(resource) || :id
+      end
+
       query ||= { field => params[options.fetch(:param_key, :id)] }
 
       return scope, query

data/lib/simon_says/version.rb

@@ -1,3 +1,3 @@
 module SimonSays
-  VERSION = '0.3.0.alpha.3'
+  VERSION = '0.3.0.alpha.4'
 end

data/test/rails_app/app/controllers/admin/comm_reports_controller.rb

@@ -0,0 +1,9 @@
+class Admin::CommReportsController < ApplicationController
+  find_and_authorize :report, :comms, with: :admin, namespace: :admin
+
+  respond_to :json
+
+  def show
+    respond_with @report
+  end
+end

data/test/rails_app/app/controllers/admin/reports_controller.rb

@@ -1,7 +1,9 @@
 class Admin::ReportsController < ApplicationController
   respond_to :json
 
-  authorize_resource :admin, :support
+  self.default_authorization_scope = :current_admin
+
+  authorize :support
   find_resource :report, namespace: :admin, except: [:index, :new, :create]
 
   def index

data/test/rails_app/app/models/client.rb

@@ -0,0 +1,2 @@
+class Client < ApplicationRecord
+end

data/test/rails_app/db/migrate/20190711184853_create_clients.rb

@@ -0,0 +1,7 @@
+class CreateClients < ActiveRecord::Migration[5.1]
+  def change
+    create_table :clients, primary_key: :client_id do |t|
+      t.timestamps
+    end
+  end
+end

data/test/rails_app/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20160823220959) do
+ActiveRecord::Schema.define(version: 20190711184853) do
 
   create_table "admin_reports", force: :cascade do |t|
     t.string "title"
@@ -24,6 +24,11 @@ ActiveRecord::Schema.define(version: 20160823220959) do
     t.datetime "updated_at", null: false
   end
 
+  create_table "clients", primary_key: "client_id", force: :cascade do |t|
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
   create_table "documents", force: :cascade do |t|
     t.string "title"
     t.datetime "created_at", null: false

data/test/rails_app/test/fixtures/clients.yml

@@ -0,0 +1 @@
+alice: {}

data/test/rails_app/test/models/client_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ClientTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/simon_says/authorizer_test.rb

@@ -29,6 +29,25 @@ class AuthorizerTest < ActiveSupport::TestCase
     @controller.params = { id: documents(:alpha).id }
   end
 
+  def with_params(params)
+    default_params = @controller.params
+    @controller.params = params
+
+    yield
+
+  ensure
+    @controller.params = default_params
+  end
+
+  def with_default_find_attribute(callalbe)
+    @controller.class.default_find_attribute = callalbe
+
+    yield
+
+  ensure
+    @controller.class.default_find_attribute = nil
+  end
+
   test "find_resource" do
     @controller.find_resource :document
 
@@ -96,19 +115,19 @@ class AuthorizerTest < ActiveSupport::TestCase
   test "authorize with membership role" do
     @controller.instance_variable_set :@membership, documents(:alpha).memberships.first
 
-    assert @controller.authorize(:fork, resource: :membership)
+    assert @controller.authorize(:fork, with: :membership)
   end
 
   test "authorize with current_admin" do
     @controller.current_admin = admins(:support)
 
-    assert @controller.authorize(:support, resource: :admin)
+    assert @controller.authorize(:support, with: :admin)
   end
 
   test "authorize with multiple roles" do
     @controller.instance_variable_set :@membership, documents(:alpha).memberships.first
 
-    assert @controller.authorize([:update, :delete], resource: :membership)
+    assert @controller.authorize([:update, :delete], with: :membership)
   end
 
   test "authorize with through" do
@@ -121,14 +140,14 @@ class AuthorizerTest < ActiveSupport::TestCase
     @controller.current_admin = admins(:marketing)
 
     @controller.expects(:authenticate_admin!).once
-    @controller.authorize(:marketing, resource: :admin)
+    @controller.authorize(:marketing, with: :admin)
   end
 
   test "authorization failure single role" do
     assert_raises SimonSays::Authorizer::Denied do
       @controller.instance_variable_set :@membership, documents(:beta).memberships.first
 
-      @controller.authorize(:delete, resource: :membership)
+      @controller.authorize(:delete, with: :membership)
     end
   end
 
@@ -136,8 +155,17 @@ class AuthorizerTest < ActiveSupport::TestCase
     @controller.instance_variable_set :@membership, documents(:beta).memberships.first
 
     assert_raises SimonSays::Authorizer::Denied do
-      @controller.authorize([:update, :delete], resource: :membership)
+      @controller.authorize([:update, :delete], with: :membership)
     end
   end
-end
 
+  test 'Authorizer.default_find_attribute proc' do
+    with_default_find_attribute ->(resource) { :"#{resource}_id" } do
+      with_params id: clients(:alice).client_id do
+        @controller.find_resource :client
+      end
+    end
+
+    assert_equal clients(:alice), @controller[:client]
+  end
+end

data/test/test_helper.rb

@@ -1,4 +1,4 @@
-require 'minitest/unit'
+require "minitest/autorun"
 require 'mocha/minitest'
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simon_says
 version: !ruby/object:Gem::Version
-  version: 0.3.0.alpha.3
+  version: 0.3.0.alpha.4
 platform: ruby
 authors:
 - Michael Coyne
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,6 +136,7 @@ files:
 - test/rails_app/app/assets/images/.keep
 - test/rails_app/app/assets/javascripts/application.js
 - test/rails_app/app/assets/stylesheets/application.css
+- test/rails_app/app/controllers/admin/comm_reports_controller.rb
 - test/rails_app/app/controllers/admin/reports_controller.rb
 - test/rails_app/app/controllers/application_controller.rb
 - test/rails_app/app/controllers/concerns/.keep
@@ -147,6 +148,7 @@ files:
 - test/rails_app/app/models/admin.rb
 - test/rails_app/app/models/admin/report.rb
 - test/rails_app/app/models/application_record.rb
+- test/rails_app/app/models/client.rb
 - test/rails_app/app/models/concerns/.keep
 - test/rails_app/app/models/document.rb
 - test/rails_app/app/models/image.rb
@@ -182,6 +184,7 @@ files:
 - test/rails_app/db/migrate/20141016183642_create_documents.rb
 - test/rails_app/db/migrate/20141017140833_create_admin_reports.rb
 - test/rails_app/db/migrate/20160823220959_create_images.rb
+- test/rails_app/db/migrate/20190711184853_create_clients.rb
 - test/rails_app/db/schema.rb
 - test/rails_app/db/seeds.rb
 - test/rails_app/lib/assets/.keep
@@ -196,6 +199,7 @@ files:
 - test/rails_app/test/fixtures/.keep
 - test/rails_app/test/fixtures/admin/reports.yml
 - test/rails_app/test/fixtures/admins.yml
+- test/rails_app/test/fixtures/clients.yml
 - test/rails_app/test/fixtures/documents.yml
 - test/rails_app/test/fixtures/images.yml
 - test/rails_app/test/fixtures/memberships.yml
@@ -205,6 +209,7 @@ files:
 - test/rails_app/test/mailers/.keep
 - test/rails_app/test/models/.keep
 - test/rails_app/test/models/admin/report_test.rb
+- test/rails_app/test/models/client_test.rb
 - test/rails_app/test/models/document_test.rb
 - test/rails_app/test/models/image_test.rb
 - test/rails_app/test/models/membership_test.rb
@@ -235,8 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Light-weight, declarative authorization and access control for Rails
@@ -250,6 +254,7 @@ test_files:
 - test/rails_app/app/assets/images/.keep
 - test/rails_app/app/assets/javascripts/application.js
 - test/rails_app/app/assets/stylesheets/application.css
+- test/rails_app/app/controllers/admin/comm_reports_controller.rb
 - test/rails_app/app/controllers/admin/reports_controller.rb
 - test/rails_app/app/controllers/application_controller.rb
 - test/rails_app/app/controllers/concerns/.keep
@@ -261,6 +266,7 @@ test_files:
 - test/rails_app/app/models/admin.rb
 - test/rails_app/app/models/admin/report.rb
 - test/rails_app/app/models/application_record.rb
+- test/rails_app/app/models/client.rb
 - test/rails_app/app/models/concerns/.keep
 - test/rails_app/app/models/document.rb
 - test/rails_app/app/models/image.rb
@@ -296,6 +302,7 @@ test_files:
 - test/rails_app/db/migrate/20141016183642_create_documents.rb
 - test/rails_app/db/migrate/20141017140833_create_admin_reports.rb
 - test/rails_app/db/migrate/20160823220959_create_images.rb
+- test/rails_app/db/migrate/20190711184853_create_clients.rb
 - test/rails_app/db/schema.rb
 - test/rails_app/db/seeds.rb
 - test/rails_app/lib/assets/.keep
@@ -310,6 +317,7 @@ test_files:
 - test/rails_app/test/fixtures/.keep
 - test/rails_app/test/fixtures/admin/reports.yml
 - test/rails_app/test/fixtures/admins.yml
+- test/rails_app/test/fixtures/clients.yml
 - test/rails_app/test/fixtures/documents.yml
 - test/rails_app/test/fixtures/images.yml
 - test/rails_app/test/fixtures/memberships.yml
@@ -319,6 +327,7 @@ test_files:
 - test/rails_app/test/mailers/.keep
 - test/rails_app/test/models/.keep
 - test/rails_app/test/models/admin/report_test.rb
+- test/rails_app/test/models/client_test.rb
 - test/rails_app/test/models/document_test.rb
 - test/rails_app/test/models/image_test.rb
 - test/rails_app/test/models/membership_test.rb