teamable 0.0.1.alpha → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92e14701652541974d41ad1b2f37bb99ae1ba17e2932da58ff40a60164e40be7
-  data.tar.gz: cac90b085b07a4b5b616168a6d4a33a60cf904f357a563c96fe8fbd699dfda1f
+  metadata.gz: 1860e39d3cd85c51f07d0a6eafdb2b8fb54fd6857b31b828803ebf96ed83779c
+  data.tar.gz: 4aa1de393a617deaaea7508d7236b60eb6617091766fc654973b4be6b8365462
 SHA512:
-  metadata.gz: a640b4d0df029a0cba8044a7ff47fea7bc56ab9538ae19ffd93a853b56a6b7bdd2001ccca4ca0c0028bd21199c71484ad3b7623b8105f1a3dcd92b2d85cee84e
-  data.tar.gz: 6ab50670c95b7451d6c35394302c812307f52f0678638eeced97527c6f8ae175c4e407a53fae297dee8135b7f0091c78cf5c3d55004811504b3f01399c8a3bf5
+  metadata.gz: 1ee01575799e26c74d465da1c28fe90c0e5598c91b24732f17419e2332c27b8f5f12834affedbbe8c505b65e8b97d7ba8690d8454462638e52702bbe4558b629
+  data.tar.gz: fb3521f7e93c51498120d6c17d3a58295dee54d66dd488d2d804023d6822043c7a6083c4ff4f98e6b44eee119e597d54b27fdf0a77da7334fe12d10c88925322

data/README.md

@@ -7,7 +7,7 @@ Teamable
 
 Teamable enables role based multi-user accounts (teams/organizations). Teams are represented by the `Account` model. An account can have multiple users associated with it and a user can have multiple accounts. You can think of accounts as a common name for **teams** or **organizations**.
 
-Every user can have one personal account they're admin of, which allows our code to work the same way whether we're adding resources privately for a user or for a team/organization. When a user signs in for the first time, they will be redirected to `new_account_path` and prompted to create their first personal or team account.
+Every user can have one personal account they're admin of, which allows our code to work the same way whether we're adding resources privately for a user or for a team/organization. When a user signs in for the first time, they will be redirected to `setup_personal_account_path` and prompted to create their personal account.
 
 ### Team resources
 
@@ -44,7 +44,7 @@ Installation
 Add the following line to Gemfile:
 
 ```ruby
-gem "teamable", "~> 1.0"
+gem "teamable", github: "kiqr/teamable" # Use Github repo to use alpha release.
 ```
 
 and run `bundle install` from your terminal to install it.
@@ -71,7 +71,39 @@ foo@bar:~$ rails g teamable:install
       create  app/models/member.rb
       create  db/migrate/20211010111722_teamable_create_accounts.rb
       create  db/migrate/20211010111723_teamable_create_members.rb
-       route  teamable "organizations"
+       route  teamable "account"
+```
+
+#### Team authentication
+
+To set up a controller with team authentication, just add `before_action :authenticate_account!` to your controllers. If you're using Devise as your authentication gem, you should add `unless: :devise_controller?` to prevent redirects from Devise routes (for example password settings or sign out).
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :authenticate_user!
+  before_action :authenticate_account!, unless: :devise_controller? # Add this row after authenticate_user!
+end
+```
+
+
+Routes
+------
+
+#### Scoped/prefixed routes
+Teamable finds the current account by parsing the `account_id` param. If none is set it will use the personal account. Define the routes for your application inside the `teamable` block and they will automatically be prefixed with `/team/<team_id>` if the user is signed in to a team account.
+
+```ruby
+teamable "account" do
+  root "dashboard#show"
+end
+```
+
+#### Custom path scope
+Teamable ships with some default routes. If you want to change the path name for teamable routes, you can do it by changing the first argument passed to `teamable` in your `config/routes.rb`, like this:
+
+```ruby
+# config/routes.rb
+teamable "organizations" # Scope teamable urls by "/organizations" instead of "/account".
 ```
 
 Contributing

data/app/controllers/teamable/accounts_controller.rb

@@ -15,24 +15,22 @@ module Teamable
       @account.members.build(user: current_user)
 
       if @account.save
-        update_teamable_session_id!(@account.id)
-        redirect_to root_path, notice: "success"
+        redirect_to root_path(account_id: @account)
       else
         render :new, status: :unprocessable_entity
       end
     end
 
     def switch
-      account = current_user.accounts.find(params[:id])
-      update_teamable_session_id!(account.id)
-      redirect_to after_account_switched_path
+      account = current_user.accounts.find_puid!(params[:account_id])
+      redirect_to after_account_switched_path(account)
     end
 
     private
 
     # Only allow a list of trusted parameters through.
     def account_params
-      params.require(:account).permit(:name, :billing_email)
+      params.require(:account).permit(:name)
     end
   end
 end

data/app/controllers/teamable/setup_controller.rb

@@ -4,17 +4,20 @@ module Teamable
   class SetupController < TeamableController
     # GET /account/setup
     def new
-      @account = current_user.accounts.new
+      @account = current_user.build_personal_account(
+        personal_account: true
+      )
     end
 
     # POST /account/setup
     def create
-      @account = current_user.accounts.build(account_params)
+      @account = current_user.build_personal_account(account_params)
+      @account.personal_account = true
       @account.members.build(user: current_user)
 
       if @account.save
-        update_teamable_session_id!(@account.id)
-        redirect_to root_path, notice: "success"
+        current_user.update(personal_account: @account)
+        redirect_to root_path, notice: "Your account was setup successfully!"
       else
         render :new, status: :unprocessable_entity
       end
@@ -24,7 +27,7 @@ module Teamable
 
     # Only allow a list of trusted parameters through.
     def account_params
-      params.require(:account).permit(:name, :billing_email)
+      params.require(:account).permit(:name)
     end
   end
 end

data/app/views/teamable/accounts/new.html.erb

@@ -3,4 +3,4 @@
 
 <%= render "teamable/shared/flash_messages" %>
 
-<%= render "form" %>
+<%= render "teamable/shared/form" %>

data/app/views/teamable/setup/new.html.erb

@@ -3,4 +3,4 @@
 
 <%= render "teamable/shared/flash_messages" %>
 
-<%= render "form" %>
+<%= render "teamable/shared/form" %>

data/app/views/teamable/shared/_form.html.erb

@@ -0,0 +1,5 @@
+<%= form_for @account, url: @account.personal_account ? setup_personal_account_path : account_path, method: :post do |f| %>
+  <%= render 'teamable/shared/errors', resource: @account %>
+  <%= f.text_field :name, placeholder: @account.personal_account ? "Your name" : "Account name" %><br>
+  <%= f.submit "Create account" %>
+<% end %>

data/lib/generators/teamable/install_generator.rb

@@ -33,6 +33,7 @@ module Teamable
     def generate_migrations
       migration_template "migrations/account.tt", "#{db_migrate_path}/teamable_create_accounts.rb"
       migration_template "migrations/member.tt", "#{db_migrate_path}/teamable_create_members.rb"
+      migration_template "migrations/user.tt", "#{db_migrate_path}/teamable_add_personal_account_to_users.rb"
     end
 
     def add_route

data/lib/generators/teamable/templates/migrations/account.tt

@@ -4,8 +4,11 @@ class TeamableCreateAccounts < ActiveRecord::Migration[5.2]
   def change
     create_table :accounts do |t|
       t.string :name, null: false
-      t.string :billing_email, null: false
+      t.string :public_uid, null: false
+      t.boolean :personal_account, default: false
       t.timestamps
     end
+
+    add_index :accounts, :public_uid, unique: true
   end
 end

data/lib/generators/teamable/templates/migrations/member.tt

@@ -5,7 +5,6 @@ class TeamableCreateMembers < ActiveRecord::Migration[5.2]
     create_table :members do |t|
       t.references :user, foreign_key: { to_table: :users }
       t.references :account, foreign_key: { to_table: :accounts }
-      t.string :invitee_email
       t.string :role, nullable: false
       t.timestamps
     end

data/lib/generators/teamable/templates/migrations/user.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class TeamableAddPersonalAccountToUsers < ActiveRecord::Migration[5.2]
+  def change
+    add_reference :users, :personal_account, foreign_key: { to_table: :accounts }, null: true
+  end
+end

data/lib/generators/teamable/templates/models/member.tt

@@ -3,6 +3,6 @@
 class Member < ApplicationRecord
   include Teamable::Models::Member
 
-  AVAILABLE_ROLES = %w[member admin].freeze
-  FIRST_USER_ROLE = "admin" # Default role for the user who created the account.
+  AVAILABLE_ROLES = %w[owner admin member].freeze
+  FIRST_USER_ROLE = "owner" # Default role for the user who created the account.
 end

data/lib/generators/teamable/views_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+require "active_support/core_ext/string/inflections"
+
+module Teamable
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      desc "Copy view files to app/views"
+      source_root Teamable::Engine.root
+
+      def copy_views
+        directory "app/views/teamable", "app/views/teamable"
+      end
+    end
+  end
+end

data/lib/teamable/controllers/current_account_helper.rb

@@ -16,7 +16,7 @@ module Teamable
         end
 
         rescue_from Teamable::MissingAccountError do
-          redirect_to setup_account_path
+          redirect_to setup_personal_account_path
         end
       end
 
@@ -38,13 +38,6 @@ module Teamable
         !!current_account
       end
 
-      # Store an account id in a session variable.
-      # Warning: this does not validate that the current_user
-      # actually is a member of the specified account.
-      def update_teamable_session_id!(account_id)
-        session[:teamable_account_id] = account_id
-      end
-
       private
 
       # Load current account from Account model and store it
@@ -52,20 +45,20 @@ module Teamable
       def load_current_account
         return unless user_signed_in?
 
-        Teamable::Current.account ||= account_from_session || fallback_account || nil
+        Teamable::Current.account ||= account_from_params || current_user.personal_account || nil
       end
 
       # Try to load current account using session[:teamable_account_id]
-      def account_from_session
-        return if session[:teamable_account_id].blank?
+      def account_from_params
+        return if params[:account_id].blank?
 
-        current_user.accounts.find_by(id: session[:teamable_account_id])
+        current_user.accounts.find_puid(params[:account_id])
       end
 
       # Finds last joined account if the user have any associated accounts.
       def fallback_account
         memberships = current_user.members
-        return nil if memberships.length.zero?
+        return nil if memberships.empty?
 
         memberships.last.account # Return last joined account.
       end

data/lib/teamable/controllers/url_helpers.rb

@@ -10,8 +10,10 @@ module Teamable
       # Method references in Teamable::AccountsController#switch to redirect a user
       # after they've switched to another account. You can override it in your
       # ApplicationController to provide a custom url.
-      def after_account_switched_path
-        root_path
+      def after_account_switched_path(account = nil)
+        return root_path(account_id: nil) if defined?(current_user) && current_user&.personal_account == account
+
+        root_path(account_id: account)
       end
     end
   end

data/lib/teamable/engine.rb

@@ -3,10 +3,13 @@
 module Teamable
   # Makes Teamable available to Rails as an Engine.
   class Engine < ::Rails::Engine
+    config.autoload_paths << Teamable::Engine.root.join("app")
+    config.autoload_paths << Teamable::Engine.root.join("lib")
+
     initializer "teamable.setup" do
       # Make teamable helpers available in controllers.
-      ActionController::Base.include Teamable::Controllers::CurrentAccountHelper
-      ActionController::Base.include Teamable::Controllers::UrlHelpers
+      ActiveSupport.on_load(:action_controller) { include Teamable::Controllers::CurrentAccountHelper }
+      ActiveSupport.on_load(:action_controller) { include Teamable::Controllers::UrlHelpers }
     end
   end
 end

data/lib/teamable/models/account.rb

@@ -4,14 +4,13 @@ module Teamable
   module Models
     module Account
       extend ActiveSupport::Concern
+      include PublicUid::ModelConcern
 
       included do
         has_many :members
         has_many :users, through: :members
 
-        validates :name, presence: true
-        validates :billing_email, presence: true, uniqueness: true
-        validates_format_of :billing_email, with: Teamable.config.email_regexp
+        validates :name, presence: true, length: { minimum: 4, maximum: 255 }
       end
     end
   end

data/lib/teamable/models/user.rb

@@ -8,6 +8,13 @@ module Teamable
       included do
         has_many :members
         has_many :accounts, through: :members
+
+        has_many   :teams, -> { where(personal_account: false) }, through: :account_users, source: :account
+        belongs_to :personal_account, class_name: "Account", optional: true
+      end
+
+      def personal_account?
+        !!personal_account
       end
     end
   end

data/lib/teamable/routes.rb

@@ -3,27 +3,34 @@
 module ActionDispatch
   module Routing
     class Mapper
-      def teamable(team_label, options = {}, &block)
-        options[:path] ||= team_label.to_s
+      def teamable(teamable_path = nil, options = {}, &block)
+        options = default_options(teamable_path, options)
 
-        teamable_scope options do
-          teamable_accounts(options)
+        resource :personal_account, only: %i[], path: "onboarding" do
+          get :setup, controller: options[:setup_controller], action: "new"
+          post :setup, controller: options[:setup_controller], action: "create"
+        end
+
+        teamable_settings(options)
+
+        scope "(/#{options[:path]}/:account_id)", account_id: %r{[^/]+} do
           yield block if block_given?
         end
       end
 
-      protected
+      private
 
-      def teamable_scope(options, &block)
-        scope options[:path], module: "teamable", &block
+      def teamable_settings(options)
+        resource :account, only: %i[new create], controller: options[:accounts_controller], path: options[:path].to_s do
+          patch ":account_id/switch", action: "switch", as: :switch
+        end
       end
 
-      def teamable_accounts(_options)
-        resource :account, only: %i[new create], path: "" do
-          get :setup, to: "setup#new"
-          post :setup, to: "setup#create"
-          patch ":id/switch", to: "accounts#switch", as: :switch
-        end
+      def default_options(teamable_path, options)
+        options[:path] = teamable_path || "team"
+        options[:setup_controller] ||= "teamable/setup"
+        options[:accounts_controller] ||= "teamable/accounts"
+        options
       end
     end
   end

data/lib/teamable/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Teamable
-  VERSION = "0.0.1.alpha"
+  VERSION = "0.1.0"
 end

data/lib/teamable.rb

@@ -7,6 +7,7 @@ require "teamable/version"
 require "teamable/engine"
 
 require "dry-configurable"
+require "public_uid"
 
 # Enable role based multi-user accounts (teams/organizations) in Rails.
 module Teamable
@@ -27,10 +28,10 @@ module Teamable
 
   # The controller class that all Teamable controllers will inherit from.
   # Defaults to `ApplicationController`.
-  setting :parent_controller, "ApplicationController"
+  setting :parent_controller, default: "ApplicationController"
 
   # Email regex used to validate email formats. It simply asserts that
   # one (and only one) @ exists in the given string. This is mainly
   # to give user feedback and not to assert the e-mail validity.
-  setting :email_regexp, /\A[^@\s]+@[^@\s]+\z/
+  setting :email_regexp, default: /\A[^@\s]+@[^@\s]+\z/
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamable
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.1.0
 platform: ruby
 authors:
 - Rasmus Kjellberg
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-17 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -17,14 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: public_uid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 description:
 email: hello@kiqr.dev
 executables: []
@@ -36,17 +50,18 @@ files:
 - app/controllers/teamable/accounts_controller.rb
 - app/controllers/teamable/setup_controller.rb
 - app/controllers/teamable_controller.rb
-- app/views/teamable/accounts/_form.html.erb
 - app/views/teamable/accounts/new.html.erb
-- app/views/teamable/setup/_form.html.erb
 - app/views/teamable/setup/new.html.erb
 - app/views/teamable/shared/_errors.html.erb
 - app/views/teamable/shared/_flash_messages.html.erb
+- app/views/teamable/shared/_form.html.erb
 - lib/generators/teamable/install_generator.rb
 - lib/generators/teamable/templates/migrations/account.tt
 - lib/generators/teamable/templates/migrations/member.tt
+- lib/generators/teamable/templates/migrations/user.tt
 - lib/generators/teamable/templates/models/account.tt
 - lib/generators/teamable/templates/models/member.tt
+- lib/generators/teamable/views_generator.rb
 - lib/teamable.rb
 - lib/teamable/controllers/current_account_helper.rb
 - lib/teamable/controllers/url_helpers.rb
@@ -65,6 +80,7 @@ metadata:
   bug_tracker_uri: https://github.com/kiqr/teamable/issues
   documentation_uri: https://github.com/kiqr/teamable/issues
   source_code_uri: https://github.com/kiqr/teamable
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -73,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Extension to enable teams for Authenticatable

data/app/views/teamable/accounts/_form.html.erb

@@ -1,7 +0,0 @@
-<%= form_for @account, url: account_path, method: :post do |f| %>
-  <%= render 'teamable/shared/errors', resource: @account %>
-
-  <%= f.text_field :name, placeholder: "Account name" %><br>
-  <%= f.text_field :billing_email, placeholder: "Billing email" %><br>
-  <%= f.submit "Create account" %>
-<% end %>

data/app/views/teamable/setup/_form.html.erb

@@ -1,7 +0,0 @@
-<%= form_for @account, url: setup_account_path, method: :post do |f| %>
-  <%= render 'teamable/shared/errors', resource: @account %>
-
-  <%= f.text_field :name, placeholder: "Account name" %><br>
-  <%= f.text_field :billing_email, placeholder: "Billing email" %><br>
-  <%= f.submit "Create account" %>
-<% end %>