simple_teams 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acdf88bfe936ac559c9454125c3219d9eba2e9a8d029cda43ac7d749231ac273
-  data.tar.gz: 5eb9a31ff2ab4a078e086c80396ad822f0baf718823de36ca3927290ea1b3a2b
+  metadata.gz: 567aba40fd5afd3451c19e11fe6eeea9bfe7759a880e44f08de06cf408163d69
+  data.tar.gz: 8998c1d483358d8eae9177d2e2f7511fc0548838140943424732fa2188450b84
 SHA512:
-  metadata.gz: d5dc54ba9215f56f8161b8b22e7e1b110f5e3a73a74be7ed3e57460dc119e38d1bc323c99e21b7ffa92413a942e05144d13892fc9693da96142b0dcbea969326
-  data.tar.gz: c345c9fc4fcbedbf30055ff8af61b48751badceebccfd1b36921a08b038c65757f90088fb41032226ea09e9510896e43fa2c968ef30e192decee50cb31dd9ccd
+  metadata.gz: 26b0d136ea943750ca8e1db97bba98cdaa182d9eaba09f7c2d3b5d7688b5cac0395bb757b8984e17a3f3a422cf6f71558fa4ac3688d3824c80d8a12eec801a53
+  data.tar.gz: 4377afe7493f8a876c52657587f489d16a22aeac639ed46bdd0136a286bf3e836a51b550e77fa2f16da32d2e174a37ef30806497cdf8470fca057a21f3754fb0

data/README.md

@@ -1,17 +1,72 @@
-# WARNING:
-This gem is a work in progress. If you like what we are doing, feel free to watch it for updates, but please do not attempt to use it in production.
-
 # SimpleTeams
 SimpleTeams is an all-in-one solution for implementing teams quickly in a Ruby on Rails (RoR) application. It follows best practices, using the Rails Engine design pattern for easy configurability, CanCan for authorization, and polymorphic association (like ActiveStorage) to avoid dictating model names.
 
-## Usage
-Pending...
+## STATUS
+SimpleTeams is actually in use within several client-facing applications. However, the gem is still under development, and notably lacks standalone testing.
+
+That said, feel free to try it out, and let us know if you have any comments/questions. Just make sure to test things thoroughly, and be patient with the (sparse) documentation.
 
 ## Installation
-Pending...
+1. Add simple\_teams to your Gemfile and run bundle install
+
+2. Add the necessary initializers to your config directory (NEED TO ADD DETAILS)
+a. devise.rb (see devise gem for further details)
+b. simple\_form.rb (see simple\_form gem for further details)
+c. simple\_teams.rb (NEED TO MAKE THIS AN INSTALL SCRIPT)
+
+3. Install the necessary migrations for simple\_teams and it's dependencies
+`
+devise generate User
+rails noticed:install:migrations
+rails simple\_teams:install:migrations
+`
+
+4. Add the SimpleTeams concerns to the desired models. E.g.
+`
+#app/models/user.rb
+class User
+  include SimpleTeams::MemberObject
+...
+
+#app/models/Organization.rb
+class Organization
+  include SimpleTeams::TeamObject
+...
+`
+
+5. Make sure to initialize the TeamObject properly via the InitializeTeamService to specify the owner of the team. E.g.
+
+`
+#within the create action of app/controllers/organizations_controller.rb
+
+def create
+  if @organization.update(organization_params)
+    SimpleTeams::InitializeTeamService.new(current_user, @organization.team).perform
+    redirect_to @organization, ...
+...
+`
+
+## Usage
+1. SimpleTeams comes pre-packaged with all of the necessary controllers and views for adding/updating/removing team members. For the default functionality, you can simply link from the teamable object (e.g. the "Organization") to the team for users to view/manage these permissions. E.g.
+
+`
+#app/views/organizations/show.html.erb
+...
+link_to "Organization Roles", simple_teams.team_path(@organization.team)
+...
+`
+
+2. The breadcrumbs in these views will reference the default routes for the teamable resource automatically. E.g.
+Organizations / Test Organization / Team Members
+
+However, you can customize these views, as well, by installing them in your application via the standard Engine functionality (i.e. "rails simple\_teams:install:views")
+
+3. NOTE: NEED TO ADD INSTRUCTIONS REGARDING locale configuration.
 
 ## Contributing
-Contribution directions go here.
+This gem is still in its initial stages, so it is important to ensure that it grows in the proper directions.
+
+That said, contributions are welcome, but please give me a heads up on your ideas (via Github issues) so that we can discuss them beforehand.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/controllers/simple_teams/accept_invitations_controller.rb

@@ -1,6 +1,5 @@
 module SimpleTeams
-  class AcceptInvitationsController < ApplicationController
-    skip_before_action :authenticate_user!
+  class AcceptInvitationsController < BaseController
     before_action :set_invitation
     before_action :ensure_invitation_token_is_valid
     before_action :set_team
@@ -12,12 +11,12 @@ module SimpleTeams
     def create
       if params[:commit] == "Decline"
         @invitation.declined!
-        redirect_to root_path, :notice => "You have declined the invitation to the '#{@team.name}' #{@team.teamable.class.model_name.human}."
+        redirect_to main_app.root_path, :notice => "You have declined the invitation to the '#{@team.name}' #{@team.teamable.class.model_name.human}."
       else
         if @service_object.valid?
           @service_object.perform
 
-          SimpleTeams::Invitations::AcceptedNotification.with(
+          SimpleTeams::Invitations::AcceptedNotifier.with(
             :team_id => @team.id,
             :invitation_id => @invitation.id,
             :user_id => current_user.id,
@@ -26,7 +25,7 @@ module SimpleTeams
             :user_name => current_user.full_name
           ).deliver_later(@team.members)
 
-          redirect_to url_for(@team.teamable), :notice => "You have accepted the invitation to the '#{@team.name}' #{@team.teamable.class.model_name.human}."
+          redirect_to main_app.url_for(@team.teamable), :notice => "You have accepted the invitation to the '#{@team.name}' #{@team.teamable.class.model_name.human}."
         else
           render :new
         end

data/app/controllers/simple_teams/application_controller.rb

@@ -1,13 +1,6 @@
 module SimpleTeams
-  class ApplicationController < SimpleTeams.parent_controller
+  class ApplicationController < ActionController::Base
     before_action :authenticate_user!
 
-    layout SimpleTeams.layout
-
-    def current_ability
-      SimpleTeams::Ability.new(current_user)
-    end
-    helper_method :current_ability
-
   end
 end

data/app/controllers/simple_teams/base_controller.rb

@@ -0,0 +1,12 @@
+module SimpleTeams
+  class BaseController < SimpleTeams.parent_controller
+
+    layout SimpleTeams.layout
+
+    def current_ability
+      SimpleTeams::Ability.new(current_user)
+    end
+    helper_method :current_ability
+
+  end
+end

data/app/controllers/simple_teams/invitations_controller.rb

@@ -1,5 +1,5 @@
 module SimpleTeams
-  class InvitationsController < ApplicationController
+  class InvitationsController < BaseController
     before_action :set_team
     before_action :set_invitation, except: %i[ new create index]
 
@@ -60,7 +60,7 @@ module SimpleTeams
       invitation_email = @invitation.email
       @invitation.destroy
 
-      SimpleTeams::Invitations::DestroyedNotification.with(
+      SimpleTeams::Invitations::DestroyedNotifier.with(
         :team_id => @team.id,
         :invitation_id => invitation_id,
         :user_id => current_user.id,

data/app/controllers/simple_teams/leave_teams_controller.rb

@@ -1,11 +1,11 @@
 module SimpleTeams
-  class LeaveTeamsController < ApplicationController
+  class LeaveTeamsController < BaseController
     before_action :set_team
     before_action :set_service_object
 
     def destroy
       if @service_object.valid? and @service_object.perform
-        redirect_to root_path, :notice => "You have successfully left the #{@team.name} #{@team.teamable.class.model_name.human}."
+        redirect_to main_app.url_for(@team.teamable.class), :notice => "You have successfully left the #{@team.name} #{@team.teamable.class.model_name.human}."
       else
         redirect_to team_path(@team), :notice => @service_object.errors[:user_id].first
       end

data/app/controllers/simple_teams/memberships_controller.rb

@@ -1,5 +1,5 @@
 module SimpleTeams
-  class MembershipsController < ApplicationController
+  class MembershipsController < BaseController
     before_action :set_team
     before_action :set_membership, :except => [:index]
 
@@ -32,7 +32,7 @@ module SimpleTeams
 
       @membership.destroy
 
-      SimpleTeams::Memberships::DestroyedNotification.with(
+      SimpleTeams::Memberships::DestroyedNotifier.with(
         :team_id => @team.id,
         :member_id => member_id,
         :user_id => current_user.id,

data/app/controllers/simple_teams/related_members_controller.rb

@@ -1,5 +1,5 @@
 module SimpleTeams
-  class RelatedMembersController < ApplicationController
+  class RelatedMembersController < BaseController
 
     def index
       if params[:term].present?

data/app/controllers/simple_teams/teams_controller.rb

@@ -1,5 +1,5 @@
 module SimpleTeams
-  class TeamsController < ApplicationController
+  class TeamsController < BaseController
     before_action :set_team
 
     def show

data/app/forms/application_form.rb

@@ -0,0 +1,3 @@
+class ApplicationForm
+  include ActiveModel::Model
+end

data/app/forms/simple_teams/invitation_forms/create.rb

@@ -10,7 +10,7 @@ module SimpleTeams
     private
 
     def generate_notification
-      SimpleTeams::Invitations::CreatedNotification.with(
+      SimpleTeams::Invitations::CreatedNotifier.with(
         :team_id => team.id,
         :invitation_id => invitation.id,
         :user_id => current_user.id,

data/app/forms/simple_teams/invitation_forms/create_bulk.rb

@@ -112,7 +112,7 @@ module SimpleTeams
     end
 
     def generate_notification
-      SimpleTeams::BulkInvitationsNotification.with(
+      SimpleTeams::BulkInvitationsNotifier.with(
         :team_id => team.id,
         :user_id => current_user.id,
         :team_name => team.name,

data/app/forms/simple_teams/invitation_forms/update.rb

@@ -15,7 +15,7 @@ module SimpleTeams
     private
 
     def generate_notification
-      SimpleTeams::Invitations::UpdatedNotification.with(
+      SimpleTeams::Invitations::UpdatedNotifier.with(
         :team_id => team.id,
         :invitation_id => invitation.id,
         :user_id => current_user.id,

data/app/forms/simple_teams/membership_form.rb

@@ -77,7 +77,7 @@ module SimpleTeams
     end
 
     def generate_notification
-      SimpleTeams::Memberships::UpdatedNotification.with(
+      SimpleTeams::Memberships::UpdatedNotifier.with(
         :team_id => team.id,
         :member_id => membership.member.id,
         :user_id => current_user.id,

data/app/helpers/simple_teams/base_helper.rb

@@ -0,0 +1,11 @@
+module SimpleTeams
+  module BaseHelper
+    def team_based_role_name(team, role)
+      t "simple_teams.#{team.teamable.class.model_name.plural}.roles.names.#{role}", :default => [t("simple_teams.roles.names.#{role}")]
+    end
+
+    def team_based_role_description(team, role)
+      t "simple_teams.#{team.teamable.class.model_name.plural}.roles.descriptions.#{role}", :default => [t("simple_teams.roles.descriptions.#{role}")]
+    end
+  end
+end

data/app/helpers/simple_teams/teams_helper.rb

@@ -1,4 +1,11 @@
 module SimpleTeams
   module TeamsHelper
+    def team_based_role_name(team, role)
+      t "simple_teams.#{team.teamable.class.to_s.underscore}.role_names.#{role}", :default => [t("simple_teams.role_names.#{role}")]
+    end
+
+    def team_based_role_description(team, role)
+      t "simple_teams.#{team.teamable.class.to_s.underscore}.role_descriptions.#{role}", :default => [t("simple_teams.role_descriptions.#{role}")]
+    end
   end
 end

data/app/mailers/simple_teams/application_mailer.rb

@@ -1,6 +1,6 @@
 module SimpleTeams
   class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
+    default from: SimpleTeams.from_address
     layout "mailer"
   end
 end

data/app/models/concerns/simple_teams/member_object.rb

@@ -5,6 +5,7 @@ module SimpleTeams::MemberObject
     has_many :team_memberships, :class_name => "SimpleTeams::Membership", :foreign_key => :member_id, :dependent => :destroy
     has_many :teams, :through => :team_memberships, :class_name => "SimpleTeams::Team"
     has_many :team_members, :through => :teams, :source => :members, :class_name => SimpleTeams.member_class.to_s
+    has_many :notifications, as: :recipient, :class_name => "Noticed::Notification", dependent: :destroy
   end
 
   def member_of_team?(team)

data/app/models/simple_teams/ability.rb

@@ -14,11 +14,11 @@ module SimpleTeams
       end
 
       can [:update], Team do |team|
-          %w"owner administrator".include? user.role_for_team(team)
+        %w"owner administrator".include? user.role_for_team(team)
       end
 
       can [:destroy], Team do |team|
-          %w"owner".include? user.role_for_team(team)
+        %w"owner".include? user.role_for_team(team)
       end
 
       # Team Memberships/Invitations

data/app/notifiers/concerns/simple_teams/invitation_notifier.rb

@@ -0,0 +1,59 @@
+module SimpleTeams
+  module InvitationNotifier
+    extend ActiveSupport::Concern
+
+    included do
+      required_params :team_id, :invitation_id, :user_id, :team_name, :invitation_name, :user_name
+
+      notification_methods do
+        def message
+          raise NotImplemented
+        end
+
+        def subject
+          raise NotImplemented
+        end
+
+        def url
+          if team.present? and team.members.include? recipient
+            SimpleTeams::Engine.routes.url_helpers.team_path(team)
+          end
+        end
+
+        def link_text
+          "View Invitations"
+        end
+
+        # Objects
+        def team
+          Team.find_by(id: params[:team_id])
+        end
+
+        def user
+          User.find_by(id: params[:user_id])
+        end
+
+        def invitation
+          team.invitations.find_by(id: params[:invitation_id]) if team.present?
+        end
+
+        # Names (fallback)
+        def team_name
+          team.present? ? team.name : params[:team_name]
+        end
+
+        def invitation_name
+          invitation.present? ? invitation.email : params[:invitation_name]
+        end
+
+        def user_name
+          if recipient.id == params[:user_id]
+            "You"
+          else
+            user.present? ? user.full_name : params[:user_name]
+          end
+        end
+      end
+    end
+  end
+end

data/app/notifiers/concerns/simple_teams/membership_notifier.rb

@@ -0,0 +1,63 @@
+module SimpleTeams
+  module MembershipNotifier
+    extend ActiveSupport::Concern
+
+    included do
+      required_params :team_id, :member_id, :user_id, :team_name, :member_name, :user_name
+
+      notification_methods do
+        def message
+          raise NotImplemented
+        end
+
+        def subject
+          raise NotImplemented
+        end
+
+        def url
+          if team.present? and team.members.include? recipient
+            SimpleTeams::Engine.routes.url_helpers.team_path(team)
+          end
+        end
+
+        def link_text
+          "View Permissions"
+        end
+
+        # Objects
+        def team
+          Team.find_by(id: params[:team_id])
+        end
+
+        def user
+          User.find_by(id: params[:user_id])
+        end
+
+        def member
+          team.members.find_by(id: params[:member_id]) if team.present?
+        end
+
+        # Names (fallback)
+        def team_name
+          team.present? ? team.name : params[:team_name]
+        end
+
+        def member_name
+          if recipient.id == params[:member_id]
+            "you"
+          else
+            member.present? ? member.full_name : params[:member_name]
+          end
+        end
+
+        def user_name
+          if recipient.id == params[:user_id]
+            "You"
+          else
+            user.present? ? user.full_name : params[:user_name]
+          end
+        end
+      end
+    end
+  end
+end

data/app/notifiers/simple_teams/application_notifier.rb

@@ -0,0 +1,6 @@
+module SimpleTeams
+  class ApplicationNotifier < Noticed::Event
+    #deliver_by :email, mailer: "NotificationMailer", :method => "notification"
+
+  end
+end

data/app/notifiers/simple_teams/bulk_invitations_notifier.rb

@@ -0,0 +1,52 @@
+module SimpleTeams
+  class BulkInvitationsNotifier < SimpleTeams::ApplicationNotifier
+    required_params :team_id, :user_id, :team_name, :user_name, :invitation_names
+
+    notification_methods do
+      def message
+        "#{user_name} invited #{invitation_names.to_sentence} to #{team_name}."
+      end
+
+      def subject
+        "Users Invited"
+      end
+
+      def url
+        if team.present?
+          SimpleTeams::Engine.routes.url_helpers.team_path(team)
+        end
+      end
+
+      def link_text
+        "View Invitations"
+      end
+
+      # Objects
+      def team
+        Team.find_by(id: params[:team_id])
+      end
+
+      def user
+        User.find_by(id: params[:user_id])
+      end
+
+      # Names (fallback)
+      def team_name
+        team.present? ? team.name : params[:team_name]
+      end
+
+      def invitation_names
+        params[:invitation_names]
+      end
+
+      def user_name
+        if recipient.id == params[:user_id]
+          "You"
+        else
+          user.present? ? user.full_name : params[:user_name]
+        end
+      end
+    end
+
+  end
+end

data/app/notifiers/simple_teams/invitations/accepted_notifier.rb

@@ -0,0 +1,16 @@
+module SimpleTeams
+  class Invitations::AcceptedNotifier < ApplicationNotifier
+    include SimpleTeams::InvitationNotifier
+
+    notification_methods do
+      def message
+        "#{user_name} accepted the invitation to #{team_name}."
+      end
+
+      def subject
+        "Invitation Accepted"
+      end
+    end
+
+  end
+end

data/app/notifiers/simple_teams/invitations/created_notifier.rb

@@ -0,0 +1,16 @@
+module SimpleTeams
+  class Invitations::CreatedNotifier < ApplicationNotifier
+    include SimpleTeams::InvitationNotifier
+
+    notification_methods do
+      def message
+        "#{user_name} invited #{invitation_name} to #{team_name}."
+      end
+
+      def subject
+        "User Invited"
+      end
+    end
+
+  end
+end

data/app/notifiers/simple_teams/invitations/destroyed_notifier.rb

@@ -0,0 +1,16 @@
+module SimpleTeams
+  class Invitations::DestroyedNotifier < ApplicationNotifier
+    include SimpleTeams::InvitationNotifier
+
+    notification_methods do
+      def message
+        "#{user_name} deleted the invitation for #{invitation_name} to #{team_name}."
+      end
+
+      def subject
+        "Invitation Deleted"
+      end
+    end
+
+  end
+end

data/app/notifiers/simple_teams/invitations/updated_notifier.rb

@@ -0,0 +1,16 @@
+module SimpleTeams
+  class Invitations::UpdatedNotifier < ApplicationNotifier
+    include SimpleTeams::InvitationNotifier
+
+    notification_methods do
+      def message
+        "#{user_name} updated the invitation for #{invitation_name} to #{team_name}."
+      end
+
+      def subject
+        "Invitation Updated"
+      end
+    end
+
+  end
+end

data/app/notifiers/simple_teams/memberships/destroyed_notifier.rb

@@ -0,0 +1,16 @@
+module SimpleTeams
+  class Memberships::DestroyedNotifier < ApplicationNotifier
+    include SimpleTeams::MembershipNotifier
+
+    notification_methods do
+      def message
+        "#{user_name} removed #{member_name} from #{team_name}."
+      end
+
+      def subject
+        "Member Removed"
+      end
+    end
+
+  end
+end

data/app/notifiers/simple_teams/memberships/left_notifier.rb

@@ -0,0 +1,20 @@
+module SimpleTeams
+  class Memberships::LeftNotifier < ApplicationNotifier
+    include SimpleTeams::MembershipNotifier
+
+    notification_methods do
+      def message
+        if recipient.id == params[:member_id]
+          "You left #{team_name}."
+        else
+          "#{member_name} left #{team_name}."
+        end
+      end
+
+      def subject
+        "Member Left"
+      end
+    end
+
+  end
+end

data/app/notifiers/simple_teams/memberships/updated_notifier.rb

@@ -0,0 +1,20 @@
+module SimpleTeams
+  class Memberships::UpdatedNotifier < ApplicationNotifier
+    include SimpleTeams::MembershipNotifier
+
+    notification_methods do
+      def message
+        if recipient.id == params[:member_id]
+          "#{user_name} updated your role for #{team_name}."
+        else
+          "#{user_name} updated the role of #{member_name} for #{team_name}."
+        end
+      end
+
+      def subject
+        "Member Updated"
+      end
+    end
+
+  end
+end

data/app/service_objects/simple_teams/accept_invitation_service.rb

@@ -32,7 +32,7 @@ module SimpleTeams
     end
 
     def invitation
-      @invitation ||= Teams::Invitation.find_by(token: @invitation_token)
+      @invitation ||= Invitation.find_by(token: @invitation_token)
     end
 
     private

data/app/service_objects/simple_teams/leave_team_service.rb

@@ -42,7 +42,7 @@ module SimpleTeams
 
     def generate_notification
       recipients = team.members.to_a << user
-      SimpleTeams::Memberships::LeftNotification.with(
+      SimpleTeams::Memberships::LeftNotifier.with(
         :team_id => team.id,
         :member_id => user.id,
         :user_id => user.id,

data/app/views/simple_teams/_nested_action_breadcrumb.html.erb

@@ -0,0 +1,8 @@
+<nav aria-label="breadcrumb">
+  <ol class="breadcrumb">
+    <li class="breadcrumb-item"><%= link_to @team.teamable.class.model_name.human(count: 2), main_app.url_for(@team.teamable.class) %></li>
+    <li class="breadcrumb-item"><%= link_to @team.teamable.name, main_app.url_for(@team.teamable) %></li>
+    <li class="breadcrumb-item"><%= link_to "Team Members", @team %></li>
+    <li class="breadcrumb-item active" aria-current="page"><%= current_page_name %></li>
+  </ol>
+</nav>