role_call 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ad375b91373f25bf7d1424ae82e46af3f9a689249e5d3cebd7c5703e172219f
-  data.tar.gz: e9b5c8fcde350b7511fc21d7b49d3ca9471b8ed5c8681f6054afce87a88c514e
+  metadata.gz: 383223b658164ace5b6bae492ff85f5ad5cd07dad7ce04244be3c0dfd73f84b5
+  data.tar.gz: 6044c87799f8d888b4411addbf92e99f5e4ed5044619c5b1eec1b9339ddd09ce
 SHA512:
-  metadata.gz: c9d2ef9d20f908256b2613763c659b0164066de3c30d823de59be0de6f2ad7ab1c1516ef100edbb85e657862616b74dcb7e2fc407ff443c4c6160bb1e244cf74
-  data.tar.gz: d56eff26436385219c548f28112eb67327678357a7e79372d2b830f08d00d8c812af6ff303d76862b770d3a56b157e7bf724c2cc1f17d909265e8d72bbf8c1b5
+  metadata.gz: e6d50ed87e4601a23df929c75957d0b09580ceb1fcdf6455a06a2a5f7660e9a5af0ea72758cd573b89186db752b7366eeee5444a2b9a79f371a99c4b92d0ce60
+  data.tar.gz: 75d16aec5180cf8fc57ecbcc30cbcbcfca1f887314fa202b8719b5c6af7465ddfb75a416a27f94d0cbcb57bcd635bc762aaa387263c61fcb19d1b9ff943b9701

data/lib/role_call.rb

@@ -3,9 +3,13 @@
 require "active_support"
 require "active_support/core_ext/enumerable"
 
-require "spicerack"
+require "spicery"
 
 require "role_call/version"
 
+require "role_call/permission_base"
+require "role_call/role_base"
+require "role_call/actor"
+
 module RoleCall
 end

data/lib/role_call/actor.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RoleCall
+  module Actor
+    extend ActiveSupport::Concern
+
+    included do
+      include ShortCircuIt
+
+      memoize :permissions
+      memoize :permission_classes
+      memoize :permissions_map
+    end
+
+    def permitted_to?(object)
+      permissions_map.key?(object.try(:key)) || permissions_map.key?(object) || permissions.include?(object)
+    end
+
+    def permissions
+      permission_classes.map(&:key).uniq
+    end
+
+    def roles
+      [ try(:role) ].compact
+    end
+
+    private
+
+    def permission_classes
+      Array.wrap(roles).map(&:permissions).flatten
+    end
+
+    def permissions_map
+      permission_classes.index_by(&:key)
+    end
+  end
+end

data/lib/role_call/permission_base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "permissions/roles"
+
+# A **Permission** are the "keys" that are accumulated across the **Roles** of an **Actor**.
+module RoleCall
+  class PermissionBase < Spicerack::RootObject
+    include RoleCall::Permissions::Roles
+
+    def self.key
+      name.chomp("Permission").underscore.to_sym
+    end
+  end
+end

data/lib/role_call/permissions/roles.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# A **Permission** is granted to various **Roles** to authorize **Actors** to perform actions.
+module RoleCall
+  module Permissions
+    module Roles
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :roles, instance_writer: false, default: []
+      end
+
+      class_methods do
+        def inherited(base)
+          base.roles = []
+          super
+        end
+
+        def granted_to(role)
+          roles << role
+        end
+      end
+    end
+  end
+end

data/lib/role_call/role_base.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "roles/permissions"
+
+# A **Role** is authorized to take actions by virtue of having the appropriate **Permissions**.
+module RoleCall
+  class RoleBase < Spicerack::RootObject
+    include RoleCall::Roles::Permissions
+  end
+end

data/lib/role_call/roles/permissions.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# A **Role** is a collection of granted **Permissions**.
+module RoleCall
+  module Roles
+    module Permissions
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :permissions, instance_writer: false, default: []
+        delegate :unpermitted?, to: :class
+      end
+
+      class_methods do
+        def unpermitted?
+          permissions.blank?
+        end
+
+        def inherited(base)
+          base.permissions = permissions.dup
+          super
+        end
+
+        private
+
+        def grant(*permission_grants)
+          permission_grants = permission_grants.flatten.compact
+
+          ensure_valid_permissions(permission_grants)
+
+          permission_grants.each do |permission|
+            permissions << permission
+            track_permission(permission)
+          end
+        end
+
+        def track_permission(permission)
+          permission.granted_to(self)
+        end
+
+        def ensure_valid_permissions(permission_grants)
+          raise ArgumentError, "a permission is required" if permission_grants.empty?
+
+          invalid_permissions = permission_grants.reject { |permission| permission.respond_to?(:granted_to) }
+          raise ArgumentError, "invalid permissions: #{invalid_permissions.join(", ")}" if invalid_permissions.present?
+        end
+      end
+    end
+  end
+end

data/lib/role_call/rspec/custom_matchers.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "custom_matchers/be_granted_to"
+require_relative "custom_matchers/grant_permissions"
+require_relative "custom_matchers/have_default_key"
+require_relative "custom_matchers/have_key"

data/lib/role_call/rspec/custom_matchers/be_granted_to.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests references of roles to permissions.
+#
+#     class ExamplePermission < ApplicationPermission
+#     end
+#
+#     class ExampleRole < ApplicationRole
+#       grants ExamplePermission
+#     end
+#
+#     RSpec.describe ExamplePermission, type: :permission do
+#       it { is_expected.to be_granted_to ExampleRole }
+#     end
+
+RSpec::Matchers.define :be_granted_to do |*roles|
+  match { expect(test_subject.roles).to include *Array.wrap(roles).flatten }
+  description { "include roles #{Array.wrap(roles).flatten}" }
+  failure_message do
+    "expected #{test_subject} to include roles #{Array.wrap(roles).flatten}; #{test_subject.roles}"
+  end
+  failure_message_when_negated do
+    "expected #{test_subject} not to include roles #{Array.wrap(roles).flatten}; #{test_subject.roles}"
+  end
+
+  def test_subject
+    subject.is_a?(Class) ? subject : subject.class
+  end
+end

data/lib/role_call/rspec/custom_matchers/grant_permissions.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests grants of permissions to roles.
+#
+#     class ExamplePermission < ApplicationPermission
+#     end
+#
+#     class ExampleRole < ApplicationRole
+#       grants ExamplePermission
+#     end
+#
+#     RSpec.describe ExampleRole, type: :role do
+#       it { is_expected.to grant_permissions ExamplePermission }
+#     end
+
+RSpec::Matchers.define :grant_permissions do |*permissions|
+  match { expect(test_subject.permissions).to include *Array.wrap(permissions).flatten }
+  description { "have permissions #{Array.wrap(permissions).flatten}" }
+  failure_message do
+    "expected #{test_subject} to have permissions #{Array.wrap(permissions).flatten}; #{test_subject.permissions}"
+  end
+  failure_message_when_negated do
+    "expected #{test_subject} not to have permissions #{Array.wrap(permissions).flatten}; #{test_subject.permissions}"
+  end
+
+  def test_subject
+    subject.is_a?(Class) ? subject : subject.class
+  end
+end

data/lib/role_call/rspec/custom_matchers/have_default_key.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests the key of a permissions.
+#
+#     class ExamplePermission < ApplicationPermission
+#     end
+#
+#     RSpec.describe ExamplePermission, type: :permission do
+#       it { is_expected.to have_default_key }
+#     end
+#
+
+RSpec::Matchers.define :have_default_key do
+  match { expect(test_subject.key).to eq test_subject.name.chomp("Permission").underscore.to_sym }
+  description { "have default key" }
+  failure_message { "expected #{test_subject} to have default key but had `#{test_subject.key}' instead." }
+  failure_message_when_negated { "expected #{test_subject} not to have default key but did." }
+
+  def test_subject
+    subject.is_a?(Class) ? subject : subject.class
+  end
+end

data/lib/role_call/rspec/custom_matchers/have_key.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests the key of a permissions.
+#
+#     class ExamplePermission < ApplicationPermission
+#       def self.key
+#         :something_nonstandard
+#       end
+#     end
+#
+#     RSpec.describe ExamplePermission, type: :permission do
+#       it { is_expected.to have_key :something_nonstandard }
+#     end
+#
+
+RSpec::Matchers.define :have_key do |expected_key|
+  match { expect(test_subject.key).to eq expected_key }
+  description { "have key #{expected_key}" }
+  failure_message do
+    "expected #{test_subject} to have key `#{expected_key}' but had `#{test_subject.key}' instead."
+  end
+  failure_message_when_negated { "expected #{test_subject} not to have key `#{expected_key}' but did." }
+
+  def test_subject
+    subject.is_a?(Class) ? subject : subject.class
+  end
+end

data/lib/role_call/spec_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "rspec/custom_matchers"

data/lib/role_call/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RoleCall
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,36 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: role_call
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Eric Garside
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.1
 - !ruby/object:Gem::Dependency
-  name: spicerack
+  name: spicery
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.3
+        version: 0.22.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.3
+        version: 0.22.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -58,20 +58,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
-- !ruby/object:Gem::Dependency
-  name: faker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -101,54 +87,54 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 4.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: rspice
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.3
+        version: 0.22.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -158,7 +144,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.3
+        version: 0.22.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -168,7 +154,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.3
+        version: 0.22.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -178,24 +164,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.3
+        version: 0.22.3.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: shoulda-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.0.1
 description: Describe the roles and permissions of your system with clear, testable,
   self-documenting code
 email:
@@ -207,8 +179,19 @@ files:
 - LICENSE.txt
 - README.md
 - lib/role_call.rb
+- lib/role_call/actor.rb
+- lib/role_call/permission_base.rb
+- lib/role_call/permissions/roles.rb
+- lib/role_call/role_base.rb
+- lib/role_call/roles/permissions.rb
+- lib/role_call/rspec/custom_matchers.rb
+- lib/role_call/rspec/custom_matchers/be_granted_to.rb
+- lib/role_call/rspec/custom_matchers/grant_permissions.rb
+- lib/role_call/rspec/custom_matchers/have_default_key.rb
+- lib/role_call/rspec/custom_matchers/have_key.rb
+- lib/role_call/spec_helper.rb
 - lib/role_call/version.rb
-homepage: https://www.freshly.com/
+homepage: https://github.com/Freshly/role_call
 licenses:
 - MIT
 metadata: {}
@@ -227,8 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple and extensible approach to role-based access control management