simple_teams 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f626da6c44a20f9b042cea11e321034ddaea542c5a96504017c309850d67bdb
+  data.tar.gz: 5c8bc35a2bbd95fc017ce9e427197cc962bb7118096de9675ca8980cfec0d79c
+SHA512:
+  metadata.gz: 7012cf09146fa7e7f5c2b86835baf11db9a72d26194cc1125021980aa65567d66fd56a37e7d668634a9989e3665fddad1ea773d1572f37e8a110d50cf8d8c872
+  data.tar.gz: 4e69cb8dab76dc70b37171e043d89c877daa75d2389c2757a62e85311d6143b8df3d85a6164a232550b368bc46b95979ca625147be109d249d7f9df0e1dd0fe2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2024 Laney Stroup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# SimpleTeams
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "simple_teams"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install simple_teams
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/simple_teams_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/simple_teams .css

data/app/assets/stylesheets/simple_teams/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/simple_teams/accept_invitations_controller.rb

@@ -0,0 +1,57 @@
+module SimpleTeams
+  class AcceptInvitationsController < ApplicationController
+    skip_before_action :authenticate_user!
+    before_action :set_invitation
+    before_action :ensure_invitation_token_is_valid
+    before_action :set_team
+    before_action :set_service_object
+
+    def new
+    end
+
+    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}."
+      else
+        if @service_object.valid?
+          @service_object.perform
+
+          SimpleTeams::Invitations::AcceptedNotification.with(
+            :team_id => @team.id,
+            :invitation_id => @invitation.id,
+            :user_id => current_user.id,
+            :team_name => @team.name,
+            :invitation_name => @invitation.email,
+            :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}."
+        else
+          render :new
+        end
+      end
+    end
+
+    private
+
+      def set_invitation
+        @invitation = SimpleTeams::Invitation.initial.unexpired.find_by(token: params[:id])
+      end
+
+      def ensure_invitation_token_is_valid
+        unless @invitation.present?
+          render "invalid_token"
+        end
+      end
+
+      def set_team
+        @team = @invitation.team
+      end
+
+      def set_service_object
+        @service_object = SimpleTeams::AcceptInvitationService.new(current_user.id, @invitation.token)
+      end
+
+  end
+end

data/app/controllers/simple_teams/admin/invitations_controller.rb

@@ -0,0 +1,60 @@
+module SimpleTeams
+  class InvitationsController < ApplicationController
+    before_action :set_invitation, only: %i[ show edit update destroy ]
+
+    # GET /invitations
+    def index
+      @invitations = Invitation.all
+    end
+
+    # GET /invitations/1
+    def show
+    end
+
+    # GET /invitations/new
+    def new
+      @invitation = Invitation.new
+    end
+
+    # GET /invitations/1/edit
+    def edit
+    end
+
+    # POST /invitations
+    def create
+      @invitation = Invitation.new(invitation_params)
+
+      if @invitation.save
+        redirect_to @invitation, notice: "Invitation was successfully created."
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    # PATCH/PUT /invitations/1
+    def update
+      if @invitation.update(invitation_params)
+        redirect_to @invitation, notice: "Invitation was successfully updated.", status: :see_other
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    # DELETE /invitations/1
+    def destroy
+      @invitation.destroy
+      redirect_to invitations_url, notice: "Invitation was successfully destroyed.", status: :see_other
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_invitation
+        @invitation = Invitation.find(params[:id])
+      end
+
+      # Only allow a list of trusted parameters through.
+      def invitation_params
+        params.require(:invitation).permit(:team_id, :inviter_id, :membership_id, :email, :role, :token, :status, :sent_at, :expires_at)
+      end
+  end
+end

data/app/controllers/simple_teams/admin/memberships_controller.rb

@@ -0,0 +1,60 @@
+module SimpleTeams
+  class MembershipsController < ApplicationController
+    before_action :set_membership, only: %i[ show edit update destroy ]
+
+    # GET /memberships
+    def index
+      @memberships = Membership.all
+    end
+
+    # GET /memberships/1
+    def show
+    end
+
+    # GET /memberships/new
+    def new
+      @membership = Membership.new
+    end
+
+    # GET /memberships/1/edit
+    def edit
+    end
+
+    # POST /memberships
+    def create
+      @membership = Membership.new(membership_params)
+
+      if @membership.save
+        redirect_to @membership, notice: "Membership was successfully created."
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    # PATCH/PUT /memberships/1
+    def update
+      if @membership.update(membership_params)
+        redirect_to @membership, notice: "Membership was successfully updated.", status: :see_other
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    # DELETE /memberships/1
+    def destroy
+      @membership.destroy
+      redirect_to memberships_url, notice: "Membership was successfully destroyed.", status: :see_other
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_membership
+        @membership = Membership.find(params[:id])
+      end
+
+      # Only allow a list of trusted parameters through.
+      def membership_params
+        params.require(:membership).permit(:team_id, :member_id, :role)
+      end
+  end
+end

data/app/controllers/simple_teams/admin/teams_controller.rb

@@ -0,0 +1,60 @@
+module SimpleTeams
+  class TeamsController < ApplicationController
+    before_action :set_team, only: %i[ show edit update destroy ]
+
+    # GET /teams
+    def index
+      @teams = Team.all
+    end
+
+    # GET /teams/1
+    def show
+    end
+
+    # GET /teams/new
+    def new
+      @team = Team.new
+    end
+
+    # GET /teams/1/edit
+    def edit
+    end
+
+    # POST /teams
+    def create
+      @team = Team.new(team_params)
+
+      if @team.save
+        redirect_to @team, notice: "Team was successfully created."
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    # PATCH/PUT /teams/1
+    def update
+      if @team.update(team_params)
+        redirect_to @team, notice: "Team was successfully updated.", status: :see_other
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    # DELETE /teams/1
+    def destroy
+      @team.destroy
+      redirect_to teams_url, notice: "Team was successfully destroyed.", status: :see_other
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_team
+        @team = Team.find(params[:id])
+      end
+
+      # Only allow a list of trusted parameters through.
+      def team_params
+        params.require(:team).permit(:teamable_id, :teamable_type)
+      end
+  end
+end

data/app/controllers/simple_teams/application_controller.rb

@@ -0,0 +1,13 @@
+module SimpleTeams
+  class ApplicationController < SimpleTeams.parent_controller
+    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/invitations_controller.rb

@@ -0,0 +1,96 @@
+module SimpleTeams
+  class InvitationsController < ApplicationController
+    before_action :set_team
+    before_action :set_invitation, except: %i[ new create index]
+
+    def new
+      authorize! :create, @team.invitations.new
+      @service_object = SimpleTeams::InvitationForms::CreateCombo.new(@team, current_user)
+    end
+
+    def create
+      authorize! :create, @team.invitations.new
+      @service_object = SimpleTeams::InvitationForms::CreateCombo.new(@team, current_user)
+
+      respond_to do |format|
+        if @service_object.perform(new_service_object_params)
+          format.html { redirect_to team_path(@team), notice: "Invitations were successfully created." }
+          format.json { render :show, status: :created, location: @invitation }
+        else
+          format.html { render :new, status: :unprocessable_entity }
+          format.json { render json: @invitation.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    def edit
+      authorize! :update, @invitation
+      @service_object = SimpleTeams::InvitationForms::Update.new(@invitation, current_user)
+    end
+
+    def update
+      authorize! :update, @invitation
+      @service_object = SimpleTeams::InvitationForms::Update.new(@invitation, current_user)
+
+      respond_to do |format|
+        if @service_object.perform(service_object_params)
+          format.html { redirect_to team_path(@team), notice: "Invitation was successfully updated." }
+          format.json { head :no_content }
+        else
+          format.html { render :edit, status: :unprocessable_entity }
+          format.json { render json: @invitation.errors, status: :unprocessable_entity }
+        end
+      end
+
+    end
+
+    def resend
+      authorize! :update, @invitation
+      @invitation.resend_invitation_notification
+
+      respond_to do |format|
+        format.html { redirect_to team_path(@team), notice: "Invitation was successfully resent." }
+        format.json { head :no_content }
+      end
+    end
+
+    def destroy
+      authorize! :destroy, @invitation
+      invitation_id = @invitation.id
+      invitation_email = @invitation.email
+      @invitation.destroy
+
+      SimpleTeams::Invitations::DestroyedNotification.with(
+        :team_id => @team.id,
+        :invitation_id => invitation_id,
+        :user_id => current_user.id,
+        :team_name => @team.name,
+        :invitation_name => invitation_email,
+        :user_name => current_user.full_name
+      ).deliver_later(@team.members)
+
+      respond_to do |format|
+        format.html { redirect_to team_path(@team), notice: "Invitation was successfully destroyed." }
+        format.json { head :no_content }
+      end
+    end
+
+    private
+
+      def new_service_object_params
+        params.require(:invitation_forms_create_combo).permit(:role, :single_vs_multiple, :email, :accessible_emails, :select2_emails => [])
+      end
+
+      def service_object_params
+        params.require(:invitation_forms_update).permit(:email, :role)
+      end
+
+      def set_team
+        @team = SimpleTeams::Team.find(params[:team_id])
+      end
+
+      def set_invitation
+        @invitation = SimpleTeams::Invitation.find(params[:id])
+      end
+  end
+end

data/app/controllers/simple_teams/leave_teams_controller.rb

@@ -0,0 +1,25 @@
+module SimpleTeams
+  class LeaveTeamsController < ApplicationController
+    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}."
+      else
+        redirect_to team_path(@team), :notice => @service_object.errors[:user_id].first
+      end
+    end
+
+    private
+
+      def set_team
+        @team = SimpleTeams::Team.find(params[:team_id])
+      end
+
+      def set_service_object
+        @service_object = SimpleTeams::LeaveTeamService.new(current_user.id, @team.id)
+      end
+
+  end
+end

data/app/controllers/simple_teams/memberships_controller.rb

@@ -0,0 +1,61 @@
+module SimpleTeams
+  class MembershipsController < ApplicationController
+    before_action :set_team
+    before_action :set_membership, :except => [:index]
+
+    def edit
+      authorize! :edit, @membership
+      @service_object = SimpleTeams::MembershipForm.new(@membership, current_user)
+    end
+
+    def update
+      authorize! :edit, @membership
+      @service_object = SimpleTeams::MembershipForm.new(@membership, current_user)
+
+      respond_to do |format|
+        if @service_object.perform(service_object_params)
+          format.html { redirect_to team_path(@team), notice: "Membership was updated successfully." }
+          format.json { render :show, status: :created, location: @service_object.membership }
+        else
+          format.html { render :edit, status: :unprocessable_entity }
+          format.json { render json: @service_object.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    def destroy
+      authorize! :destroy, @membership
+
+      member_id = @membership.member.id
+      member_name = @membership.member.full_name
+      recipients = @team.members.to_a
+
+      @membership.destroy
+
+      SimpleTeams::Memberships::DestroyedNotification.with(
+        :team_id => @team.id,
+        :member_id => member_id,
+        :user_id => current_user.id,
+        :team_name => @team.name,
+        :member_name => member_name,
+        :user_name => current_user.full_name
+      ).deliver_later(recipients)
+
+      redirect_to team_path(@team)
+    end
+
+    private
+
+      def service_object_params
+        params.require(:teams_membership_form).permit(:role)
+      end
+
+      def set_team
+        @team = SimpleTeams::Team.find(params[:team_id])
+      end
+
+      def set_membership
+        @membership = @team.memberships.find(params[:id])
+      end
+  end
+end

data/app/controllers/simple_teams/related_members_controller.rb

@@ -0,0 +1,33 @@
+module SimpleTeams
+  class RelatedUsersController < ApplicationController
+
+    def index
+      if params[:term].present?
+        @members = SimpleTeams.member_class
+          .joins(:team_memberships, :teams)
+          .where("teams_teams.id" => current_user.teams.pluck(:id))
+          .where("email ilike ?", "%#{params[:term]}%")
+          .order("#{SimpleTeams.member_class.table_name}.first_name")
+          .uniq
+        @members.reject! { |member| member.id == current_user.id }
+      else
+        @members= SimpleTeams.member_class.none
+      end
+    end
+
+    def select2
+      if params[:term].present?
+        @members = SimpleTeams.member_class
+          .joins(:team_memberships, :teams)
+          .where("teams_teams.id" => current_user.teams.pluck(:id))
+          .where("email ilike ?", "%#{params[:term]}%")
+          .order("#{SimpleTeams.member_class.table_name}.first_name")
+          .uniq
+        @members.reject! { |member| member.id == current_user.id }
+      else
+        @members = SimpleTeams.member_class.none
+      end
+    end
+
+  end
+end

data/app/controllers/simple_teams/teams_controller.rb

@@ -0,0 +1,19 @@
+module SimpleTeams
+  class TeamsController < ApplicationController
+    before_action :set_team
+
+    def show
+      authorize! :read, @team
+      @memberships = @team.memberships.joins(:member).order(:first_name)
+      @invitations = @team.invitations.initial.order(:email)
+      @memberships_and_invitations = @memberships.to_a + @invitations.to_a
+    end
+
+    private
+
+    def set_team
+      @team = SimpleTeams::Team.find(params[:id])
+    end
+
+  end
+end

data/app/forms/simple_teams/invitation_form.rb

@@ -0,0 +1,77 @@
+module SimpleTeams
+  class InvitationForm < ApplicationForm
+
+    attr_accessor :team, :current_user, :invitation, :email, :role
+
+    def initialize(team, current_user)
+      raise NotImplementedError
+    end
+
+    def perform(params)
+      self.assign_attributes(params)
+
+      if valid?
+        invitation.update!(params)
+        generate_notification
+      else
+        false
+      end
+    end
+
+    # Attributes
+    def self.invitation_attributes
+      [:email, :role]
+    end
+
+    def available_roles
+      @available_roles ||= SimpleTeams::Membership.roles
+    end
+
+    private
+
+    def valid?
+      self.errors.clear
+      validate_role_is_available
+      validate_invitation
+      validate_current_user_has_rights_to_invite_an_owner
+      !self.errors.present?
+    end
+
+    def validate_role_is_available
+      # Note: Users will never see this error message unless they hack the form
+      if role.present?
+        unless available_roles.keys.include? role
+          self.errors.add(:role, "that role is not available for this resource")
+        end
+      end
+    end
+
+    def validate_invitation
+      # Update invitation object
+      self.class.invitation_attributes.each do |a|
+        invitation.assign_attributes(a => self.send(a))
+      end
+
+      # Call valid?
+      invitation.valid?
+
+      # Reassign errors
+      self.class.invitation_attributes.each do |a|
+        if invitation.errors[a].present?
+          invitation.errors[a].each do |e|
+            self.errors.add(a, e)
+          end
+        end
+      end
+    end
+
+    def validate_current_user_has_rights_to_invite_an_owner
+      if role == "owner"
+        unless current_user.membership_for_team(team).owner?
+          self.errors.add(:role, "you must be an owner yourself to add add another owner")
+        end
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,24 @@
+module SimpleTeams
+  class InvitationForms::Create < SimpleTeams::InvitationForm
+
+    def initialize(team, current_user)
+      @team = team
+      @current_user = current_user
+      @invitation = team.invitations.new(:inviter => @current_user)
+    end
+
+    private
+
+    def generate_notification
+      SimpleTeams::Invitations::CreatedNotification.with(
+        :team_id => team.id,
+        :invitation_id => invitation.id,
+        :user_id => current_user.id,
+        :team_name => team.name,
+        :invitation_name => invitation.email,
+        :user_name => current_user.full_name
+      ).deliver_later(team.members)
+    end
+
+  end
+end