permits 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d330b1a5acfacc191ccffec7849305d517a1c70e50bc5e9937a07b15239f950c
-  data.tar.gz: 4f3c2df1fec8854571ab7d57abc7129662679fbc7d53b70704ca92b8915a82a6
+  metadata.gz: 17d6289fc58da4116cf85b5cf7853ebfe67d6366a4e9c96b64b0d0d42533d1a4
+  data.tar.gz: '08f713827ae201b471163040ce273e2b7f5beb5e59f31c9af0d808e3d1248f7e'
 SHA512:
-  metadata.gz: '0842937fcd45b32c6cb384e7c26fc2fb8556abbae9ef9cfdb5a429fad034a6b1c82d2e85d3d50747b6375359b67e55adffb6f6000f06162640d8c622ff5defa6'
-  data.tar.gz: b6f0a89a8b057fb960517622affcbab9911c222af51449eccfe4691488d2bac4c939eafba235d624a5f7f5f98ee29c8564514a02b61ae0e7b4bfe8992a5a5976
+  metadata.gz: 45c24dc5c7c076e30644f57a9779d50d252551921fa3e7eb7de6d21fe588f5e5217c5f90638cf98bc570ec9daf75526f910f0f015bf4e72ec923e860f0ecb420
+  data.tar.gz: 4bec82908bb725ea9a36fac20d0d1ee091923509b2f3a52b2ce59649fb011a586e67e70c7d93e3ad1ce480f496432af84354787ea285753a75bc8eda67d3b8a3

data/README.md

@@ -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/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.0.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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: permits
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Craig Gilchrist
@@ -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