activeadmin-chat 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8d98f77adf289e587a3fe87574aea5b04c0dbec
+  data.tar.gz: a39d14ff43fb865d774a38027ac81c437a2d78d3
+SHA512:
+  metadata.gz: ce8c7420247974431bef63d479c20df168745b7ec0ae71b2dac44ad7357fc798d3cca68cab3ce44bfcaaefc12d39c5fd71bfe7b30f1ec8554e9c55b97c4ff383
+  data.tar.gz: 37dcb743df2be501579b0259f03af19a077e2ee871cbc8bbe9f7d16740e0990dc20852c87f6632c5493baeb5aeade99ee9dd5da611bdf6c10edb260b8ade6a07

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Rootstrap
+
+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,149 @@
+# ActiveAdmin::Chat
+
+[![Build Status](https://travis-ci.org/rootstrap/activeadmin-chat.svg?branch=master)](https://travis-ci.org/rootstrap/activeadmin-chat)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7a8d43aef79218e8f772/maintainability)](https://codeclimate.com/github/rootstrap/activeadmin-chat/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7a8d43aef79218e8f772/test_coverage)](https://codeclimate.com/github/rootstrap/activeadmin-chat/test_coverage)
+
+Get a chat for your ActiveAdmin app out of the box.
+
+![](images/activeadmin-chat.gif)
+
+## Prerequisites
+- It assumes you have models for your admins and users in place.
+- It assumes that your users have an `email` attribute.
+- For production you need to configure ActionCable by providing it with a Redis or Postgres connection in `config/cable.yml`.
+
+## Installation
+Add to Gemfile:
+```ruby
+gem 'activeadmin-chat'
+```
+
+And then run:
+```bash
+$ bundle install
+```
+
+This gem requires Webpacker for the Javascript. Add the npm package:
+```bash
+$ yarn add activeadmin-chat
+```
+
+And install it:
+```bash
+$ yarn install
+```
+
+Install `ActiveAdmin::Chat`:
+```bash
+$ rails generate active_admin:chat:install
+```
+It will generate:
+  - `Conversation` and `Message` models and migrations.
+  - Initializer that configures the model names for conversation, message, admin user and user.
+  - Default chat page.
+
+You can customize the namings of the models when installing `ActiveAdmin::Chat` with the usage of the `--conversation_model_name`, `--message_model_name`, `--admin_user_model_name` and `--user_model_name` flags.
+
+For example:
+```bash
+$ rails generate active_admin:chat:install --conversation_model_name=chat
+```
+
+Once you've successfully installed `ActiveAdmin::Chat`, run:
+```bash
+$ rails db:migrate
+```
+
+Add including of CSS to `app/assets/stylesheets/active_admin.css.scss`:
+```css
+@import 'active_admin/chat';
+```
+
+Create a file named `app/javascript/packs/activeadmin-chat.js`, with the following content:
+```js
+import 'activeadmin-chat';
+```
+
+### Example diagram
+![](images/activeadmin-chat_diagram.png?raw=true "Chat diagram")
+
+## Usage
+All you need to get the chat up and running is to authenticate your users in the websocket connection in `app/channels/application_cable/connection.rb`. It's important that you identify them as the `current_user` here, this will be used by the gem internally.
+
+For example with the `devise` gem:
+```ruby
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+    identified_by :current_user
+
+    def connect
+      self.current_user = find_verified_user
+    end
+
+    private
+
+    def find_verified_user
+      verified_user = env['warden'].user
+
+      reject_unauthorized_connection unless verified_user
+
+      verified_user
+    end
+  end
+end
+```
+
+## Customization
+You can change the chat page name and namespace the same way you do with other ActiveAdmin pages.
+
+If you'd like to change the chat styling you can override the following classes:
+ - `.active-admin-chat__title`: Title above the conversations list
+ - `.active-admin-chat__conversations-list-container`, `.active-admin-chat__conversations-list` and `.active-admin-chat__conversation-item`: List of conversations
+ - `.active-admin-chat__conversation-history-container` and `.active-admin-chat__conversation-history`: Conversation panel
+ - `.active-admin-chat__message-container`: Message in the conversation panel
+ - `.active-admin-chat__send-message-container`: Send message button
+
+If you'd like to change the whole HTML you can do it in the chat page by specifying its content:
+```ruby
+ActiveAdmin.register_chat 'Chat' do
+  content do
+    # your code
+  end
+end
+```
+
+If you'd like to change the controller actions you can do it in the chat page by specifying its controller:
+```ruby
+ActiveAdmin.register_chat 'Chat' do
+  controller do
+    def show
+      # your code
+    end
+  end
+end
+```
+
+
+If you'd like to add a button in the user's index in the admin dashboard to start a chat with a user:
+```ruby
+ActiveAdmin.register_chat User do
+  index do
+    # your code
+    actions do |user|
+      send_message_link user
+    end
+  end
+end
+```
+
+## Contributing
+Bug reports (please use Issues) and pull requests are welcome on GitHub at https://github.com/rootstrap/activeadmin-chat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+**Active Admin Chat** is maintained by [Rootstrap](http://www.rootstrap.com) with the help of our [contributors](https://github.com/rootstrap/activeadmin-chat/contributors).
+
+[<img src="https://s3-us-west-1.amazonaws.com/rootstrap.com/img/rs.png" width="100"/>](http://www.rootstrap.com)

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveAdmin::Chat'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new
+
+task default: %i[rubocop spec]

data/app/assets/stylesheets/active_admin/chat.scss

@@ -0,0 +1,130 @@
+@import 'chat/colors';
+
+.active-admin-chat__chat {
+  height: calc(100vh - 270px);
+
+  .active-admin-chat__conversations-list-container {
+    display: inline-block;
+    height: 100%;
+    width: 30%;
+  }
+
+  .active-admin-chat__title {
+    background-color: $active-admin-chat__lighter-grey;
+    background-image: linear-gradient(180deg, $active-admin-chat__lighter-grey, $active-admin-chat__light-grey);
+    border: solid 1px $active-admin-chat__grey;
+    border-color: $active-admin-chat__light-grey $active-admin-chat__light-grey $active-admin-chat__grey;
+    box-shadow: 0 1px 3px rgba($active-admin-chat__black, 0.12), 0 0 1px $active-admin-chat__white inset;
+    font-size: 14px;
+    font-weight: bold;
+    margin: 0;
+    padding: 10px 12px 8px;
+    text-shadow: $active-admin-chat__white 0 1px 0;
+  }
+
+  .active-admin-chat__conversations-list {
+    height: calc(100% - 34px);
+    margin: 0;
+    overflow-y: auto;
+    padding: 0;
+
+    a {
+      color: inherit;
+      text-decoration: inherit;
+    }
+  }
+
+  .active-admin-chat__conversation-item {
+    border-bottom: 1px solid $active-admin-chat__lighter-grey;
+    cursor: pointer;
+    list-style: none;
+    padding: 10px 12px 8px;
+    vertical-align: top;
+
+    &:nth-child(even) {
+      background-color: $active-admin-chat__lightest-grey;
+    }
+
+    &:hover {
+      background-color: $active-admin-chat__lighter-grey;
+    }
+
+    &.selected {
+      background-color: $active-admin-chat__grey;
+
+      &:hover {
+        background-color: $active-admin-chat__grey;
+      }
+    }
+  }
+
+  .active-admin-chat__conversation-history-container {
+    display: inline-block;
+    float: right;
+    height: 100%;
+    width: 70%;
+  }
+
+  .active-admin-chat__conversation-history {
+    background-color: $active-admin-chat__lighter-grey;
+    display: flex;
+    flex-direction: column;
+    height: calc(100% - 61px);
+    overflow: auto;
+    padding: 0 15px;
+
+    &.no-messages {
+      font-size: 24px;
+      margin: auto;
+      padding: 50px;
+    }
+  }
+
+  .active-admin-chat__message-container {
+    &:first-child {
+      margin-top: auto;
+    }
+
+    div {
+      background-color: $active-admin-chat__white;
+      border-radius: 10px 10px 10px 0;
+      display: inline-block;
+      margin: 3px;
+      max-width: 70%;
+      padding: 5px;
+      word-break: break-word;
+
+      p {
+        font-size: 12px;
+        margin: 0 0 0 2px;
+      }
+
+      span {
+        font-size: 10px;
+      }
+    }
+
+    &.admin {
+      text-align: right;
+
+      div {
+        background-color: $active-admin-chat__green;
+        border-radius: 10px 10px 0;
+      }
+    }
+  }
+
+  .active-admin-chat__send-message-container {
+    background-color: $active-admin-chat__lighter-grey;
+    height: 61px;
+
+    input {
+      border: 0;
+      border-radius: 25px;
+      margin: 10px 30px;
+      outline: none;
+      padding: 15px;
+      width: calc(100% - 90px);
+    }
+  }
+}

data/app/assets/stylesheets/active_admin/chat/colors.scss

@@ -0,0 +1,7 @@
+$active-admin-chat__lightest-grey: #fafafa;
+$active-admin-chat__lighter-grey: #efefef;
+$active-admin-chat__light-grey: #d4d4d4;
+$active-admin-chat__grey: #cdcdcd;
+$active-admin-chat__black: #000;
+$active-admin-chat__white: #fff;
+$active-admin-chat__green: #cbe6b8;

data/app/channels/active_admin/chat/admin_channel.rb

@@ -0,0 +1,21 @@
+module ActiveAdmin
+  module Chat
+    class AdminChannel < ActiveAdmin::Chat::BaseChannel
+      private
+
+      def conversation
+        return unless admin? && conversation_id.present?
+
+        @conversation ||= ActiveAdmin::Chat.conversation_klass.find_by(id: conversation_id)
+      end
+
+      def admin?
+        current_user.instance_of?(ActiveAdmin::Chat.admin_user_klass)
+      end
+
+      def conversation_id
+        params[:conversation_id]
+      end
+    end
+  end
+end

data/app/channels/active_admin/chat/base_channel.rb

@@ -0,0 +1,28 @@
+module ActiveAdmin
+  module Chat
+    class BaseChannel < ApplicationCable::Channel
+      def subscribed
+        conversation ? stream_for(conversation) : reject
+      end
+
+      def speak(data)
+        message = conversation.public_send(
+          ActiveAdmin::Chat.message_relation_name.pluralize
+        ).create!(
+          sender: current_user,
+          content: data['message']
+        )
+
+        message = ActiveAdmin::Chat::MessagePresenter.new(message)
+        ActiveAdmin::Chat::AdminChannel.broadcast_to(conversation, message)
+        ActiveAdmin::Chat::UserChannel.broadcast_to(conversation, message)
+      end
+
+      private
+
+      def conversation
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/app/channels/active_admin/chat/user_channel.rb

@@ -0,0 +1,19 @@
+module ActiveAdmin
+  module Chat
+    class UserChannel < ActiveAdmin::Chat::BaseChannel
+      private
+
+      def conversation
+        return unless user?
+
+        @conversation ||= ActiveAdmin::Chat.conversation_klass.find_by(
+          "#{ActiveAdmin::Chat.user_relation_name}_id": current_user.id
+        )
+      end
+
+      def user?
+        current_user.instance_of?(ActiveAdmin::Chat.user_klass)
+      end
+    end
+  end
+end

data/app/helpers/active_admin/chat/chat_helper.rb

@@ -0,0 +1,13 @@
+module ActiveAdmin
+  module Chat
+    module ChatHelper
+      def admin_class(message)
+        'admin' if message.sender.class == ActiveAdmin::Chat.admin_user_klass
+      end
+
+      def selected_class(conversation, active_conversation)
+        'selected' if active_conversation && active_conversation == conversation
+      end
+    end
+  end
+end

data/app/views/active_admin/chat/_chat.html.erb

@@ -0,0 +1,7 @@
+<div class='active-admin-chat__chat'>
+  <%= render partial: 'active_admin/chat/list' %>
+
+  <div class='active-admin-chat__conversation-history-container'>
+    <div class='active-admin-chat__conversation-history'></div>
+  </div>
+</div>

data/app/views/active_admin/chat/_list.html.erb

@@ -0,0 +1,12 @@
+<div class='active-admin-chat__conversations-list-container'>
+  <h3 class='active-admin-chat__title'><%= ActiveAdmin::Chat.conversation_relation_name.pluralize.capitalize %></h3>
+  <ul class='active-admin-chat__conversations-list'>
+    <% conversations.each do |conversation| %>
+      <a href='<%= "/#{ActiveAdmin::Chat.namespace}/#{ActiveAdmin::Chat.page_name}/#{conversation.id}" %>' >
+        <li id='conversation-<%= conversation.id %>' class='active-admin-chat__conversation-item <%= selected_class(conversation, active_conversation) %>'>
+          <%= conversation.public_send(:"#{ActiveAdmin::Chat.user_relation_name}").email %>
+        </li>
+      </a>
+    <% end %>
+  </ul>
+</div>

data/app/views/active_admin/chat/_message.html.erb

@@ -0,0 +1,5 @@
+<div id="message-<%= message.id %>" data-time="<%= message.created_at.iso8601(3) %>" class="active-admin-chat__message-container <%= admin_class(message) %>">
+  <div>
+    <p><%= message.content %></p>
+  </div>
+</div>

data/app/views/active_admin/chat/_messages.html.erb

@@ -0,0 +1,3 @@
+<% messages.each do |message| %>
+   <%= render partial: 'active_admin/chat/message', locals: { message: message } %>
+<% end %>

data/app/views/active_admin/chat/show.html.erb

@@ -0,0 +1,17 @@
+<div class='active-admin-chat__chat'>
+  <%= render partial: 'active_admin/chat/list' %>
+
+  <div class='active-admin-chat__conversation-history-container'>
+    <div class='active-admin-chat__conversation-history'>
+      <% if active_conversation && messages.empty? %>
+          <div class='active-admin-chat__conversation-history no-messages'>No messages</div>
+      <% else %>
+        <%= render partial: 'active_admin/chat/messages' %>
+      <% end %>
+    </div>
+    <div class='active-admin-chat__send-message-container'>
+      <input type='text' id='send-message' placeholder="Send message" />
+    </div>
+  </div>
+</div>
+<%= javascript_pack_tag 'activeadmin-chat' %>

data/config/routes.rb

@@ -0,0 +1,9 @@
+Rails.application.routes.draw do
+  if ActiveAdmin::Chat.method_defined?(:page_name) && ActiveAdmin::Chat.page_name
+    namespace ActiveAdmin::Chat.namespace do
+      get  "#{ActiveAdmin::Chat.page_name}/:id", to: "#{ActiveAdmin::Chat.page_name}#show"
+      post "#{ActiveAdmin::Chat.user_model_name}/:#{ActiveAdmin::Chat.user_relation_name}_id/#{ActiveAdmin::Chat.page_name}",
+           to: "#{ActiveAdmin::Chat.page_name}#create"
+    end
+  end
+end

data/lib/active_admin/chat.rb

@@ -0,0 +1,42 @@
+require 'active_admin'
+require 'active_admin/chat/engine'
+require 'active_admin/chat/extensions'
+require 'active_admin/chat/extensions/application'
+require 'active_admin/chat/application'
+require 'active_admin/chat/extensions/index_table_for'
+require 'active_admin/chat/message_presenter'
+require 'webpacker'
+
+module ActiveAdmin
+  module Chat
+    extend self
+
+    def application
+      @application ||= ::ActiveAdmin::Chat::Application.new
+    end
+
+    def setup
+      yield(application)
+    end
+
+    delegate :conversation_klass, to: :application
+    delegate :message_klass, to: :application
+    delegate :admin_user_klass, to: :application
+    delegate :user_klass, to: :application
+    delegate :conversation_relation_name, to: :application
+    delegate :message_relation_name, to: :application
+    delegate :admin_user_relation_name, to: :application
+    delegate :user_relation_name, to: :application
+    delegate :page_name, to: :application
+    delegate :namespace, to: :application
+    delegate :user_model_name, to: :application
+    delegate :messages_per_page, to: :application
+  end
+end
+
+::ActiveAdmin.send :include, ActiveAdmin::Chat::Extensions
+::ActiveAdmin::Application.send :include, ActiveAdmin::Chat::Extensions::Application
+::ActiveAdmin::Views::IndexAsTable::IndexTableFor.send(
+  :prepend,
+  ActiveAdmin::Chat::Extensions::Views::IndexAsTable::IndexTableFor
+)

data/lib/active_admin/chat/application.rb

@@ -0,0 +1,29 @@
+module ActiveAdmin
+  module Chat
+    class Application
+      attr_accessor :conversation_model_name, :message_model_name, :admin_user_model_name,
+                    :user_model_name, :page_name, :namespace, :messages_per_page
+
+      def initialize
+        @conversation_model_name = 'conversation'
+        @message_model_name = 'message'
+        @admin_user_model_name = 'admin_user'
+        @user_model_name = 'user'
+        @namespace = 'admin'
+        @messages_per_page = 25
+      end
+
+      %i[conversation message admin_user user].each do |attribute|
+        define_method :"#{attribute}_klass" do
+          public_send("#{attribute}_model_name").pluralize.classify.constantize
+        end
+      end
+
+      %i[conversation message admin_user user].each do |attribute|
+        define_method :"#{attribute}_relation_name" do
+          public_send("#{attribute}_model_name").split('/').last
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/chat/engine.rb

@@ -0,0 +1,6 @@
+module ActiveAdmin
+  module Chat
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/active_admin/chat/extensions.rb

@@ -0,0 +1,13 @@
+module ActiveAdmin
+  module Chat
+    module Extensions
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        delegate :register_chat, to: :application
+      end
+    end
+  end
+end

data/lib/active_admin/chat/extensions/application.rb

@@ -0,0 +1,83 @@
+module ActiveAdmin
+  module Chat
+    module Extensions
+      module Application
+        def register_chat(name, options = {}, &block)
+          setup_page_configs(name, options[:namespace])
+
+          register_page name, options do
+            content do
+              render 'active_admin/chat/chat'
+            end
+
+            controller do
+              layout 'active_admin', only: :show
+              helper_method :messages, :active_conversation, :conversations
+
+              def show
+                respond_to do |format|
+                  format.html { render 'active_admin/chat/show' }
+                  format.json do
+                    render json: ActiveAdmin::Chat::MessagePresenter.all(messages)
+                  end
+                end
+              end
+
+              def create
+                conversation =
+                  ActiveAdmin::Chat.conversation_klass
+                                   .find_or_create_by!(
+                                     "#{user_relation_name_id}": params[:"#{user_relation_name_id}"]
+                                   )
+                redirect_to action: 'show', id: conversation
+              end
+
+              def active_conversation
+                @active_conversation ||= ActiveAdmin::Chat.conversation_klass.find_by(
+                  id: params[:id]
+                )
+              end
+
+              def conversations
+                @conversations ||= ActiveAdmin::Chat.conversation_klass
+                                                    .includes(ActiveAdmin::Chat.user_relation_name)
+              end
+
+              def messages
+                return [] unless active_conversation
+
+                page_messages = active_conversation.public_send(
+                  ActiveAdmin::Chat.message_relation_name.pluralize
+                ).includes(:sender).order(created_at: :desc)
+
+                if params[:created_at].present?
+                  page_messages = page_messages.where('created_at < ?',
+                                                      DateTime.parse(params[:created_at]))
+                end
+                page_messages.limit(ActiveAdmin::Chat.messages_per_page).reverse
+              end
+
+              private
+
+              def user_relation_name_id
+                "#{ActiveAdmin::Chat.user_relation_name}_id"
+              end
+            end
+
+            # customize default chat
+            instance_eval(&block)
+          end
+        end
+
+        private
+
+        def setup_page_configs(page_name, namespace)
+          ActiveAdmin::Chat.setup do |config|
+            config.page_name = page_name.downcase
+            config.namespace = namespace.downcase if namespace
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/chat/extensions/index_table_for.rb

@@ -0,0 +1,23 @@
+module ActiveAdmin
+  module Chat
+    module Extensions
+      module Views
+        module IndexAsTable
+          module IndexTableFor
+            def send_message_link(resource)
+              text_node link_to 'Send Message',
+                                send_message_path(resource.id),
+                                method: :post
+            end
+
+            private
+
+            def send_message_path(id)
+              "#{ActiveAdmin::Chat.user_model_name}/#{id}/#{ActiveAdmin::Chat.page_name}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/chat/message_presenter.rb

@@ -0,0 +1,24 @@
+module ActiveAdmin
+  module Chat
+    class MessagePresenter
+      attr_reader :message
+
+      def initialize(message)
+        @message = message
+      end
+
+      def self.all(messages)
+        { messages: messages.map { |m| new(m) } }
+      end
+
+      def as_json(*)
+        {
+          id: message.id,
+          message: message.content,
+          date: message.created_at.iso8601(3),
+          is_admin: message.sender.class == ActiveAdmin::Chat.admin_user_klass
+        }
+      end
+    end
+  end
+end

data/lib/active_admin/chat/version.rb

@@ -0,0 +1,5 @@
+module ActiveAdmin
+  module Chat
+    VERSION = '1.0.1'.freeze
+  end
+end

data/lib/activeadmin-chat.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'active_admin/chat'

data/lib/generators/active_admin/chat/install/install_generator.rb

@@ -0,0 +1,123 @@
+module ActiveAdmin
+  module Chat
+    module Generators
+      class InstallGenerator < Rails::Generators::NamedBase
+        argument :name, default: ''
+        class_option :conversation_model_name, type: :string, default: 'conversation'
+        class_option :message_model_name, type: :string, default: 'message'
+        class_option :admin_user_model_name, type: :string, default: 'admin_user'
+        class_option :user_model_name, type: :string, default: 'user'
+
+        source_root File.expand_path('templates', __dir__)
+
+        def normalize_config
+          @conversation_model_name = options['conversation_model_name'].underscore.singularize
+          @message_model_name = options['message_model_name'].underscore.singularize
+          @admin_user_model_name = options['admin_user_model_name'].underscore.singularize
+          @user_model_name = options['user_model_name'].underscore.singularize
+          @messages_per_page = 25
+        end
+
+        def copy_initializer
+          template 'initializers/active_admin/chat.rb.erb',
+                   'config/initializers/active_admin/chat.rb'
+        end
+
+        def create_models
+          unless model_exists?(@conversation_model_name)
+            Rails::Generators.invoke(
+              'active_record:model', [
+                @conversation_model_name,
+                "#{@user_model_name.split('/').last}_id:integer:index",
+                '--migration',
+                '--timestamps'
+              ]
+            )
+          end
+
+          unless model_exists?(@message_model_name)
+            Rails::Generators.invoke(
+              'active_record:model', [
+                @message_model_name,
+                'content:string',
+                'sender:references{polymorphic}',
+                "#{@conversation_model_name.split('/').last}_id:integer:index",
+                'created_at:datetime:index',
+                'updated_at:datetime',
+                '--migration',
+                '--no-timestamps'
+              ]
+            )
+          end
+        end
+
+        def inject_models_contents
+          if model_exists?(@conversation_model_name)
+            inject_into_class(
+              model_path(@conversation_model_name),
+              @conversation_model_name.classify,
+              conversation_contents
+            )
+          end
+
+          if model_exists?(@message_model_name)
+            inject_into_class(
+              model_path(@message_model_name),
+              @message_model_name.classify,
+              message_contents
+            )
+          end
+        end
+
+        def insert_chat_page
+          template 'pages/chat.rb', 'app/admin/chat.rb'
+        end
+
+        private
+
+        def conversation_contents
+          buffer = <<-CONTENT
+  #{add_belongs_to(@user_model_name)}
+  #{add_has_many(@message_model_name)}
+          CONTENT
+
+          buffer
+        end
+
+        def message_contents
+          buffer = <<-CONTENT
+  #{add_belongs_to(@conversation_model_name)}
+          CONTENT
+
+          buffer
+        end
+
+        def add_belongs_to(model_name)
+          if model_name.include?('/')
+            "belongs_to :#{model_name.split('/').last}, class_name: '#{model_name.classify}'"
+          else
+            "belongs_to :#{model_name}"
+          end
+        end
+
+        def add_has_many(model_name)
+          relation_name = model_name.split('/').last.pluralize
+
+          if model_name.include?('/')
+            "has_many :#{relation_name}, class_name: #{model_name.classify}, dependent: :destroy"
+          else
+            "has_many :#{relation_name}, dependent: :destroy"
+          end
+        end
+
+        def model_exists?(model_name)
+          File.exist?(File.join(destination_root, model_path(model_name)))
+        end
+
+        def model_path(model_name)
+          File.join('app', 'models', "#{model_name}.rb")
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_admin/chat/install/templates/initializers/active_admin/chat.rb.erb

@@ -0,0 +1,8 @@
+ActiveAdmin::Chat.setup do |config|
+  # Specify the names of the models required for the chat
+  config.conversation_model_name = '<%= @conversation_model_name %>'
+  config.message_model_name = '<%= @message_model_name %>'
+  config.admin_user_model_name = '<%= @admin_user_model_name %>'
+  config.user_model_name = '<%= @user_model_name %>'
+  config.messages_per_page = <%= @messages_per_page %>
+end

data/lib/generators/active_admin/chat/install/templates/pages/chat.rb

@@ -0,0 +1,2 @@
+ActiveAdmin.register_chat 'Chat' do
+end

metadata

@@ -0,0 +1,270 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin-chat
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Santiago Bartesaghi
+- Federico Aldunate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: action-cable-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.32.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.32.2
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.1
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: ActiveAdmin chat plugin
+email:
+- santiago.bartesaghi@rootstrap.com
+- federico@rootstrap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/active_admin/chat/manifest.js
+- app/assets/stylesheets/active_admin/chat.scss
+- app/assets/stylesheets/active_admin/chat/colors.scss
+- app/channels/active_admin/chat/admin_channel.rb
+- app/channels/active_admin/chat/base_channel.rb
+- app/channels/active_admin/chat/user_channel.rb
+- app/helpers/active_admin/chat/chat_helper.rb
+- app/views/active_admin/chat/_chat.html.erb
+- app/views/active_admin/chat/_list.html.erb
+- app/views/active_admin/chat/_message.html.erb
+- app/views/active_admin/chat/_messages.html.erb
+- app/views/active_admin/chat/show.html.erb
+- config/routes.rb
+- lib/active_admin/chat.rb
+- lib/active_admin/chat/application.rb
+- lib/active_admin/chat/engine.rb
+- lib/active_admin/chat/extensions.rb
+- lib/active_admin/chat/extensions/application.rb
+- lib/active_admin/chat/extensions/index_table_for.rb
+- lib/active_admin/chat/message_presenter.rb
+- lib/active_admin/chat/version.rb
+- lib/activeadmin-chat.rb
+- lib/generators/active_admin/chat/install/install_generator.rb
+- lib/generators/active_admin/chat/install/templates/initializers/active_admin/chat.rb.erb
+- lib/generators/active_admin/chat/install/templates/pages/chat.rb
+homepage: https://github.com/rootstrap/activeadmin-chat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: ActiveAdmin chat plugin
+test_files: []