permits 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d330b1a5acfacc191ccffec7849305d517a1c70e50bc5e9937a07b15239f950c
-  data.tar.gz: 4f3c2df1fec8854571ab7d57abc7129662679fbc7d53b70704ca92b8915a82a6
+  metadata.gz: c4baf7748a113d4c68af920c55257fb5840bb6c136a60f002cbc13558a20e4d9
+  data.tar.gz: d7ab07da8c225023bc734f45d075f460951ca59597d6a0a2d0206e73d5f30a3a
 SHA512:
-  metadata.gz: '0842937fcd45b32c6cb384e7c26fc2fb8556abbae9ef9cfdb5a429fad034a6b1c82d2e85d3d50747b6375359b67e55adffb6f6000f06162640d8c622ff5defa6'
-  data.tar.gz: b6f0a89a8b057fb960517622affcbab9911c222af51449eccfe4691488d2bac4c939eafba235d624a5f7f5f98ee29c8564514a02b61ae0e7b4bfe8992a5a5976
+  metadata.gz: a472133852912635c254bbc0b1be0ed2518c8363b64166509f527adee531bf8c8223cec3c44d7bcbd5de011b290878270a4d412c7fc12d660311861ff095d6fe
+  data.tar.gz: 037bd6a26de070e6b1499484db5003aea39896f8ed1aecbc5cd927bffd145547191a5f5cf88ee8a134c6465dd96fc7684d9b242eb8fb4cb1d21b9fc1b3c8cf32

data/README.md

@@ -9,7 +9,7 @@ Set up the valid `permits` values (roles/actions/levels):
 
 # user levels example
 ::Permits.configure do |config|
-  config.permits = %i[admin user super_user]
+  config.permit = %i[admin user super_user]
 end
 
 # user actions example
@@ -76,6 +76,23 @@ CustomPolicy.authorize!(owner, resource, :some_action)
 CustomPolicy.authorized?(owner, resource, :some_action)
 ```
 
+### Invites
+`Permits` provides a simple pre-permissioned Invite system, with a `Permits::Invite` model, a `Permits::Form::NewInviteForm` form object for creating new invites, and a `Permits::Form::InviteForm` form object for accepting, declining and revoking invites. Invites can be pre-assigned permissions, so that when the invite is accepted, the invitee is automatically granted the permissions.
+
+```irb
+group = Group.create(name: "Group 1")
+group_user = User.create(name: "User 1")
+user_permission = Permits::Permission.create(owner: group_user, resource: group, action: :super_user)
+
+NewInviteForm.new(
+  invited_by: group_user,
+  email: "invitee@email-address.com",
+  permission_attributes: {
+    group => [:read, :edit]
+  }
+).save!
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/generators/permits/install/install_generator.rb

@@ -4,8 +4,13 @@ module Permits
       source_root File.expand_path("templates", __dir__)
 
       def copy_application_policy
-        template "create_permits_permissions.rb", "db/migrate/#{Time.current.strftime("%Y%m%d%H%M%S")}_create_permits_permissions.rb"
-        template "create_permits_invites.rb", "db/migrate/#{Time.current.strftime("%Y%m%d%H%M%S")}_create_permits_invites.rb"
+        [
+          "create_permits_permissions.rb",
+          "create_permits_invites.rb"
+        ].each_with_index do |migration_file, index|
+          timestamp = (Time.current + index + 1).strftime("%Y%m%d%H%M%S")
+          template migration_file, "db/migrate/#{timestamp}_#{migration_file}.rb"
+        end
       end
     end
   end

data/lib/permits/forms/invite_form.rb

@@ -0,0 +1,65 @@
+module Permits
+  module Forms
+    class InviteForm
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+      include ActiveModel::Validations
+
+      attribute :invite_id
+      attribute :invited
+      attribute :token
+
+      validates :invite_id, presence: true
+      validates :invited, presence: true
+      validates :token, presence: true
+
+      def accept
+        return false unless valid_invite?
+
+        ActiveRecord::Base.transaction do
+          invite.accept!
+        end
+        true
+      end
+
+      def decline
+        return false unless valid_invite?
+
+        ActiveRecord::Base.transaction do
+          invite.decline!
+        end
+        true
+      end
+
+      def destroy
+        ActiveRecord::Base.transaction do
+          invite.permissions.destroy_all
+          invite.destroy
+        end
+        true
+      end
+
+      private
+
+      def valid_invite?
+        return false unless valid?
+
+        valid_email? && valid_token?
+      end
+
+      def valid_email?
+        raise I18n.t("errors.invited_does_not_respond_to_email") unless invited.respond_to?(:email)
+
+        invite.email == invited.email
+      end
+
+      def valid_token?
+        invite.slug == token
+      end
+
+      def invite
+        @invite ||= ::Permits::Invite.find(invite_id)
+      end
+    end
+  end
+end

data/lib/permits/forms/{new_invite.rb → new_invite_form.rb}

@@ -1,6 +1,6 @@
 module Permits
   module Forms
-    class NewInvite
+    class NewInviteForm
       include ActiveModel::Model
       include ActiveModel::Attributes
       include ActiveModel::Validations

data/lib/permits/permission.rb

@@ -17,7 +17,7 @@ module Permits
     def permits_is_permissable
       return if Permits.config.permits&.include?(permits&.to_sym)
 
-      errors.add(:permits, "is not a valid permits for #{resource.class}")
+      errors.add(:permits, I18n.t("errors.invalid_permits_param", class: resource.class.name))
     end
 
     scope :permits_any, -> { all }

data/lib/permits/version.rb

@@ -1,3 +1,3 @@
 module Permits
-  VERSION = "0.3.0"
+  VERSION = "1.1.0"
 end

data/lib/permits.rb

@@ -1,7 +1,8 @@
 require "active_support/configurable"
 require "aasm"
 require "permits/concerns/has_permissions"
-require "permits/forms/new_invite"
+require "permits/forms/new_invite_form"
+require "permits/forms/invite_form"
 require "permits/invite"
 require "permits/permission"
 require "permits/policy/unauthorized_error"
@@ -17,12 +18,16 @@ module Permits
     def configure
       yield config
 
-      if config.permits
-        config.permits = config.permits.map!(&:to_sym)
-        config.permits.each do |role|
+      if config.permit
+        config.permits ||= []
+        config.permit.each do |role|
+          next if config.permits.include?(role.to_sym)
+          config.permits << role.to_sym
           ::Permits::Permission.scope "permits_#{role}", -> { where(permits: role) }
         end
       end
+
+      config.permit = config.permits
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: permits
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Craig Gilchrist
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aasm
@@ -152,7 +152,8 @@ files:
 - lib/generators/permits/install/templates/create_permits_permissions.rb
 - lib/permits.rb
 - lib/permits/concerns/has_permissions.rb
-- lib/permits/forms/new_invite.rb
+- lib/permits/forms/invite_form.rb
+- lib/permits/forms/new_invite_form.rb
 - lib/permits/invite.rb
 - lib/permits/permission.rb
 - lib/permits/policy/base.rb