po_box 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a96717f6fc9f8aee68cbf574b60c2da573d7693a1173279a84b16e1a1666d38
+  data.tar.gz: b5b7dcb9dcea500041f806517edc8ece9cdc18af18241900ce28adc43dd525de
+SHA512:
+  metadata.gz: 5522631b60e572e57049274c7c730d257c44eb94d0ef900b528c628329dfd0ac68e0ea166be00c8773ae3c9d3c46693c6336971881205553228760259a637b9e
+  data.tar.gz: d6209dc03e50daa7ff937fee1ae5b39075a4a54b7215a7e80ec9290b9502864f5e1fc341e0a3585eacdfa7d9baa7de34ee8c644032a4627c337ff649ed96fede

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Leo Policastro
+
+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,103 @@
+# PoBox
+
+PoBox is a Ruby on Rails engine that provides inboxes and email addresses for your users.
+
+## Requirements
+
+1. [ActiveStorage](https://edgeguides.rubyonrails.org/active_storage_overview.html) needs to be installed and configured.
+2. [ActionMailbox](https://edgeguides.rubyonrails.org/action_mailbox_basics.html) needs to be installed and configured.
+3. A model that the inbox and emails will be associated with needs to exist in the host application. e.g. `User` or `Account`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "po_box"
+```
+
+And then run:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install po_box
+```
+
+## Configuration
+
+**IMPORTANT:** Make sure you have ActiveStorage and ActionMailbox installed and configured.
+
+1. `bin/rails po_box:install:migrations`
+2. `bin/rails g po_box emailable_model` (where `emailable_model` is the name of the model you want to make emailable, e.g. `user`)
+3. `bin/rails db:migrate`
+4. `bin/rails po_box:backfill_emailables`
+
+## Limitations
+
+1. Can only be applied to one model per application, for now.
+
+## Usage
+
+Visit http://localhost:3000/rails/conductor/action_mailbox/inbound_emails to send an email to your app.
+
+Send the email to the address that is associated with the emailable model. e.g.
+
+```ruby
+  User.inboxes.first.address
+
+  # => "some#64b0@yourapp"
+```
+
+<!-- If your emailable_class is a User -->
+
+```ruby
+
+irb(main):003:0> u = User.last
+  User Load (0.4ms)  SELECT "users".* FROM "users" ORDER BY "users"."id" DESC LIMIT $1  [["LIMIT", 1]]
+=>
+#<User:0x000000011131a328
+...
+irb(main):004:0> u.inboxes.first
+  PoBox::Inbox Load (0.4ms)  SELECT "po_box_inboxes".* FROM "po_box_inboxes" WHERE "po_box_inboxes"."emailable_id" = $1 AND "po_box_inboxes"."emailable_type" = $2 ORDER BY "po_box_inboxes"."id" ASC LIMIT $3  [["emailable_id", 1], ["emailable_type", "User"], ["LIMIT", 1]]
+=>
+#<PoBox::Inbox:0x00000001113119a8
+ id: 1,
+ emailable_type: "User",
+ emailable_id: 1,
+ address: "some#64b0",
+ created_at: Thu, 04 May 2023 00:28:13.107181000 UTC +00:00,
+ updated_at: Thu, 04 May 2023 00:28:13.107181000 UTC +00:00>
+irb(main):005:0>
+
+irb(main):005:0> u.inboxes.first.emails.last
+  PoBox::Inbox Load (0.5ms)  SELECT "po_box_inboxes".* FROM "po_box_inboxes" WHERE "po_box_inboxes"."emailable_id" = $1 AND "po_box_inboxes"."emailable_type" = $2 ORDER BY "po_box_inboxes"."id" ASC LIMIT $3  [["emailable_id", 1], ["emailable_type", "User"], ["LIMIT", 1]]
+  PoBox::Email Load (0.5ms)  SELECT "po_box_emails".* FROM "po_box_emails" WHERE "po_box_emails"."inbox_id" = $1 ORDER BY "po_box_emails"."id" DESC LIMIT $2  [["inbox_id", 1], ["LIMIT", 1]]
+=>
+#<PoBox::Email:0x00000001079c27e8
+ id: 1,
+ inbox_id: 1,
+ cc: nil,
+ from: "anyone@aol.com",
+ multipart: true,
+ read: false,
+ subject: "Something subjecty",
+ to: "some#64b0@yourapp.com",
+ message_id: "6452fc3aa9815_568e39a83101b@My-MacBook-Pro-2.local.mail",
+ body: "Hello World",
+ created_at: Thu, 04 May 2023 00:28:44.171561000 UTC +00:00,
+ updated_at: Thu, 04 May 2023 00:28:44.483199000 UTC +00:00>
+irb(main):006:0>
+```
+
+## Contributing
+
+Bug reports and pull requests are always welcome!
+
+## 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("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/po_box_manifest.js

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

data/app/assets/stylesheets/po_box/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/po_box/application_controller.rb

@@ -0,0 +1,4 @@
+module PoBox
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/po_box/emails_controller.rb

@@ -0,0 +1,68 @@
+module PoBox
+  class EmailsController < ApplicationController
+    before_action :set_inbox
+    before_action :set_email, only: %i[show edit update destroy]
+
+    # GET /emails
+    def index
+      @emails = Email.all
+    end
+
+    # GET /emails/1
+    def show
+    end
+
+    # GET /emails/new
+    def new
+      @email = Email.new
+    end
+
+    # GET /emails/1/edit
+    def edit
+    end
+
+    # POST /emails
+    def create
+      @email = Email.new(email_params)
+
+      if @email.save
+        redirect_to inbox_email_path(@inbox, @email), notice: "Email was successfully created."
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    # PATCH/PUT /emails/1
+    def update
+      if @email.update(email_params)
+        redirect_to inbox_email_path(@inbox, @email), notice: "Email was successfully updated."
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    # DELETE /emails/1
+    def destroy
+      @email.destroy
+      redirect_to inbox_emails_url(@inbox), notice: "Email was successfully destroyed."
+    end
+
+    private
+
+    def set_inbox
+      @inbox = Inbox.find(params[:inbox_id])
+    rescue ActiveRecord::RecordNotFound
+      redirect_to po_box_inboxes_path, notice: "Inbox not found"
+    end
+
+    # Use callbacks to share common setup or constraints between actions.
+    def set_email
+      @email = Email.find(params[:id])
+    end
+
+    # Only allow a list of trusted parameters through.
+    def email_params
+      params.require(:email).permit(:inbox_id, :cc, :from, :multipart, :read, :subject, :to, :message_id)
+    end
+  end
+end

data/app/controllers/po_box/inboxes_controller.rb

@@ -0,0 +1,54 @@
+module PoBox
+  class InboxesController < ApplicationController
+    before_action :set_inbox, only: %i[show edit update destroy]
+
+    def index
+      @inboxes = Inbox.all
+    end
+
+    def show
+    end
+
+    def new
+      @inbox = Inbox.new
+    end
+
+    def edit
+    end
+
+    def create
+      @inbox = Inbox.new(inbox_params)
+
+      if @inbox.save
+        redirect_to @inbox, notice: "Inbox was successfully created."
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      if @inbox.update(inbox_params)
+        redirect_to @inbox, notice: "Inbox was successfully updated."
+      else
+        render :edit, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      @inbox.destroy
+      redirect_to inboxes_url, notice: "Inbox was successfully destroyed."
+    end
+
+    private
+
+    def inbox_params
+      params.require(:inbox).permit(:name, :address)
+    end
+
+    def set_inbox
+      @inbox = Inbox.find(params[:id])
+    rescue ActiveRecord::RecordNotFound
+      redirect_to po_box_inboxes_path, notice: "Inbox not found"
+    end
+  end
+end

data/app/helpers/po_box/application_helper.rb

@@ -0,0 +1,4 @@
+module PoBox
+  module ApplicationHelper
+  end
+end

data/app/helpers/po_box/emails_helper.rb

@@ -0,0 +1,4 @@
+module PoBox
+  module EmailsHelper
+  end
+end

data/app/jobs/po_box/application_job.rb

@@ -0,0 +1,4 @@
+module PoBox
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailboxes/application_mailbox.rb

@@ -0,0 +1,2 @@
+class ApplicationMailbox < ActionMailbox::Base
+end

data/app/mailboxes/po_box/inbox_mailbox.rb

@@ -0,0 +1,54 @@
+module PoBox
+  class InboxMailbox < ApplicationMailbox
+    before_processing :ensure_inbox
+
+    def process
+      email = create_email
+      handle_attachments(email) if mail.attachments.any?
+    end
+
+    private
+
+    def ensure_inbox
+      return if inbox.present?
+
+      bounce_with EmailableMailer.missing_emailable(mail)
+    end
+
+    def inbox
+      @inbox ||= PoBox::Inbox.find_by(address: address)
+    end
+
+    def address
+      mail.to.first.split("@").first
+    end
+
+    def create_email
+      inbox.emails.create!(
+        cc: mail.cc,
+        from: mail.from.first,
+        multipart: mail.multipart?,
+        read: false,
+        subject: mail.subject,
+        to: mail.to.first,
+        message_id: mail.message_id,
+        body: if mail.html_part
+                mail.html_part.decoded
+              elsif mail.text_part
+                mail.text_part.decoded
+              else
+                mail.decoded
+              end
+      )
+    end
+
+    def handle_attachments(email)
+      mail.attachments.each do |attachment|
+        email.files.attach(
+          io: StringIO.new(attachment.body.decoded),
+          filename: attachment.filename
+        )
+      end
+    end
+  end
+end

data/app/mailers/po_box/application_mailer.rb

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

data/app/mailers/po_box/emailable_mailer.rb

@@ -0,0 +1,12 @@
+module PoBox
+  class EmailableMailer < ApplicationMailer
+    def missing_emailable(mail)
+      mail(
+        to: mail.sender,
+        subject: "Inbox not found",
+        body: "We were unable to find an inbox for this email. Please contact support.",
+        content_type: "text/html"
+      )
+    end
+  end
+end

data/app/models/concerns/po_box/emailable.rb

@@ -0,0 +1,33 @@
+module PoBox
+  module Emailable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :inboxes, as: :emailable, class_name: "PoBox::Inbox", dependent: :destroy
+
+      after_create_commit :set_inbox
+
+      accepts_nested_attributes_for :inboxes, allow_destroy: true
+
+      private
+
+      def set_inbox
+        return if inboxes.any?
+
+        inbox_address = if email.present?
+          "#{email.split("@").first}##{SecureRandom.hex(2)}"
+        else
+          SecureRandom.hex(8)
+        end
+
+        inbox = inboxes.new
+        loop do
+          inbox.address = inbox_address
+          break unless PoBox.emailable_class.joins(:inboxes).where(po_box_inboxes: {address: inbox.address}).exists?
+        end
+
+        save
+      end
+    end
+  end
+end

data/app/models/po_box/application_record.rb

@@ -0,0 +1,5 @@
+module PoBox
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/po_box/email.rb

@@ -0,0 +1,11 @@
+module PoBox
+  class Email < ApplicationRecord
+    belongs_to :inbox, class_name: "PoBox::Inbox"
+
+    has_many_attached :files
+
+    validates :from, presence: true
+
+    delegate :raw_source, to: :body
+  end
+end

data/app/models/po_box/inbox.rb

@@ -0,0 +1,11 @@
+module PoBox
+  class Inbox < ApplicationRecord
+    belongs_to :emailable, polymorphic: true, class_name: PoBox.emailable_class.to_s
+
+    has_many :emails, class_name: "PoBox::Email", dependent: :destroy
+
+    define_method PoBox.emailable_class.to_s.underscore do
+      emailable
+    end
+  end
+end

data/app/views/layouts/po_box/application.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Active email</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= stylesheet_link_tag    "po_box/application", media: "all" %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/po_box/mailer.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/po_box/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/app/views/po_box/emails/_email.html.erb

@@ -0,0 +1,49 @@
+<div id="<%= dom_id email %>">
+  <% if email.cc %>
+    <p>
+      <strong>Cc:</strong>
+      <%= email.cc %>
+    </p>
+  <% end %>
+  <p>
+    <strong>Subject:</strong>
+    <%= email.subject %>
+  </p>
+  <p>
+    <strong>From:</strong>
+    <%= email.from %>
+  </p>
+  <p>
+    <strong>To:</strong>
+    <%= email.to %>
+  </p>
+  <p>
+    <strong>Body:</strong>
+    <%= email.body %>
+  </p>
+  <% email.files.each do |file| %>
+    <div>
+      <% if file.representable? %>
+        <%=  image_tag main_app.url_for(file.representation(resize_to_limit: [100, 100])) %>
+      <% else %>
+        <%= link_to file.filename, main_app.url_for(file) %>
+      <% end %>
+    </div>
+  <% end %>
+  <p>
+    <strong>Multipart:</strong>
+    <%= email.multipart %>
+  </p>
+  <p>
+    <strong>Emailable ID:</strong>
+    <%= email.inbox_id %>
+  </p>
+  <p>
+    <strong>Read:</strong>
+    <%= email.read %>
+  </p>
+  <p>
+    <strong>Message ID:</strong>
+    <%= email.message_id %>
+  </p>
+</div>

data/app/views/po_box/emails/_form.html.erb

@@ -0,0 +1,51 @@
+<%= form_with(model: email, url: url) do |form| %>
+  <% if email.errors.any? %>
+    <div style="color: red">
+      <h2><%= pluralize(email.errors.count, "error") %> prohibited this email from being saved:</h2>
+      <ul>
+        <% email.errors.each do |error| %>
+          <li><%= error.full_message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+  <div>
+    <%= form.label :inbox_id, style: "display: block" %>
+    <%= form.text_field :inbox_id %>
+  </div>
+  <div>
+    <%= form.label :cc, style: "display: block" %>
+    <%= form.text_field :cc %>
+  </div>
+  <div>
+    <%= form.label :from, style: "display: block" %>
+    <%= form.text_field :from %>
+  </div>
+  <div>
+    <%= form.label :multipart, style: "display: block" %>
+    <%= form.check_box :multipart %>
+  </div>
+  <div>
+    <%= form.label :read, style: "display: block" %>
+    <%= form.check_box :read %>
+  </div>
+  <div>
+    <%= form.label :subject, style: "display: block" %>
+    <%= form.text_field :subject %>
+  </div>
+  <div>
+    <%= form.label :to, style: "display: block" %>
+    <%= form.text_field :to %>
+  </div>
+  <div>
+    <%= form.label :message_id, style: "display: block" %>
+    <%= form.text_field :message_id %>
+  </div>
+  <div>
+    <%= form.label :body, style: "display: block" %>
+    <%= form.text_area :body %>
+  </div>
+  <div>
+    <%= form.submit %>
+  </div>
+<% end %>

data/app/views/po_box/emails/edit.html.erb

@@ -0,0 +1,7 @@
+<h1>Editing email</h1>
+<%= render "form", email: @email, url: inbox_email_path(@inbox, @email) %>
+<br>
+<div>
+  <%= link_to "Show this email", inbox_email_path(@inbox, @email) %> |
+  <%= link_to "Back to emails", inbox_emails_path(@inbox) %>
+</div>

data/app/views/po_box/emails/index.html.erb

@@ -0,0 +1,11 @@
+<p style="color: green"><%= notice %></p>
+<h1>Emails</h1>
+<div id="emails">
+  <% @emails.each do |email| %>
+    <%= render email %>
+    <p>
+      <%= link_to "Show this email", inbox_email_path(@inbox, email) %>
+    </p>
+  <% end %>
+</div>
+<%= link_to "New email", new_inbox_email_path(@inbox) %>

data/app/views/po_box/emails/new.html.erb

@@ -0,0 +1,6 @@
+<h1>New email</h1>
+<%= render "form", email: @email, url: inbox_emails_path(@inbox) %>
+<br>
+<div>
+  <%= link_to "Back to emails", inbox_emails_path(@inbox) %>
+</div>

data/app/views/po_box/emails/show.html.erb

@@ -0,0 +1,7 @@
+<p style="color: green"><%= notice %></p>
+<%= render @email %>
+<div>
+  <%= link_to "Edit this email", edit_inbox_email_path(@inbox, @email) %> |
+  <%= link_to "Back to emails", inbox_emails_path(@inbox) %>
+  <%= button_to "Destroy this email", inbox_email_path(@inbox, @email, method: :delete) %>
+</div>

data/app/views/po_box/home/index.html.erb

@@ -0,0 +1,2 @@
+<h1>Home#index</h1>
+<p>Find me in app/views/po_box/home/index.html.erb</p>

data/app/views/po_box/inboxes/_form.html.erb

@@ -0,0 +1,19 @@
+<%= form_with(model: inbox) do |form| %>
+  <% if inbox.errors.any? %>
+    <div style="color: red">
+      <h2><%= pluralize(inbox.errors.count, "error") %> prohibited this inbox from being saved:</h2>
+      <ul>
+        <% inbox.errors.each do |error| %>
+          <li><%= error.full_message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+  <div>
+    <%= form.label :address, style: "display: block" %>
+    <%= form.text_field :address %>
+  </div>
+  <div>
+    <%= form.submit %>
+  </div>
+<% end %>

data/app/views/po_box/inboxes/_inbox.html.erb

@@ -0,0 +1,6 @@
+<div id="<%= dom_id inbox %>">
+  <p>
+    <strong>Email Address:</strong>
+    <%= inbox.address %>
+  </p>
+</div>

data/app/views/po_box/inboxes/edit.html.erb

@@ -0,0 +1,7 @@
+<h1>Editing inbox</h1>
+<%= render "form", inbox: @inbox %>
+<br>
+<div>
+  <%= link_to "Show this inbox", @inbox %> |
+  <%= link_to "Back to inboxes", inboxes_path %>
+</div>

data/app/views/po_box/inboxes/index.html.erb

@@ -0,0 +1,15 @@
+<p style="color: green"><%= notice %></p>
+<h1>Email addresses</h1>
+<div class="">
+  <%= link_to "New inbox", new_inbox_path %>
+</div>
+<div id="inboxes">
+  <% @inboxes.each do |inbox| %>
+    <%= render inbox %>
+    <div>
+      <%= link_to "Show this inbox", inbox %>
+      <%= link_to "Edit inbox", edit_inbox_path(inbox) %>
+      <%= button_to "Destroy", edit_inbox_path(inbox) %>
+    </div>
+  <% end %>
+</div>

data/app/views/po_box/inboxes/new.html.erb

@@ -0,0 +1,6 @@
+<h1>New inbox</h1>
+<%= render "form", inbox: @inbox %>
+<br>
+<div>
+  <%= link_to "Back to inboxes", inboxes_path %>
+</div>

data/app/views/po_box/inboxes/show.html.erb

@@ -0,0 +1,8 @@
+<p style="color: green"><%= notice %></p>
+<%= render @inbox %>
+<%= link_to "Emails", inbox_emails_path(@inbox) %> |
+<div>
+  <%= link_to "Edit this inbox", edit_inbox_path() %> |
+  <%= link_to "Back to inboxes", inboxes_path %>
+  <%= button_to "Destroy this inbox", @inbox, method: :delete %>
+</div>

data/config/initializers/po_box.rb

@@ -0,0 +1 @@
+PoBox.emailable_class = "Owner"

data/config/routes.rb

@@ -0,0 +1,7 @@
+PoBox::Engine.routes.draw do
+  resources :inboxes do
+    resources :emails
+  end
+
+  root "inboxes#index"
+end

data/db/migrate/20230425172819_create_po_box_inboxes.rb

@@ -0,0 +1,10 @@
+class CreatePoBoxInboxes < ActiveRecord::Migration[7.0]
+  def change
+    create_table :po_box_inboxes do |t|
+      t.references :emailable, polymorphic: true, null: false
+      t.string :address, null: false, index: {unique: true}
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230426005820_create_po_box_emails.rb

@@ -0,0 +1,17 @@
+class CreatePoBoxEmails < ActiveRecord::Migration[7.0]
+  def change
+    create_table :po_box_emails do |t|
+      t.references :inbox, foreign_key: {to_table: :po_box_inboxes}
+      t.string :cc
+      t.string :from
+      t.boolean :multipart
+      t.boolean :read, default: false, null: false
+      t.string :subject
+      t.string :to
+      t.string :message_id
+      t.text :body
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/po_box/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate po_box User
+
+    This will create:
+        An initializer in config/initializers/po_box.rb
+        A migration to add the inbox address to the emailable table
+        Mount the engine in config/routes.rb
+        Add the emailable concern to the User model
+        Add the route all emails to the po_box/inbox mailbox

data/lib/generators/po_box/po_box_generator.rb

@@ -0,0 +1,33 @@
+class PoBoxGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  def setup_initializer
+    create_file "config/initializers/po_box.rb", "PoBox.emailable_class = \"#{name.camelize}\""
+  end
+
+  def mount_engine
+    route "mount PoBox::Engine, at: \"/po_box\""
+  end
+
+  def include_concerns
+    inject_into_file "app/models/#{name.tableize.singularize}.rb", after: "class #{name.camelize} < ApplicationRecord\n" do
+      <<-RUBY
+        include PoBox::Emailable
+      RUBY
+    end
+  end
+
+  def setup_inbox
+    inject_into_file "app/mailboxes/application_mailbox.rb", after: "class ApplicationMailbox < ActionMailbox::Base\n" do
+      <<-RUBY
+        routing all: "po_box/inbox"
+      RUBY
+    end
+  end
+
+  def append_to_manifest
+    append_to_file "app/assets/config/manifest.js" do
+      "//= link po_box/application.css\n"
+    end
+  end
+end

data/lib/generators/po_box/templates/po_box.rb

@@ -0,0 +1 @@
+PoBox.emailable_class = ARGV[0]

data/lib/po_box/engine.rb

@@ -0,0 +1,13 @@
+module PoBox
+  mattr_accessor :application_controller
+
+  class Engine < ::Rails::Engine
+    isolate_namespace PoBox
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: "spec/factories"
+    end
+  end
+end

data/lib/po_box/version.rb

@@ -0,0 +1,3 @@
+module PoBox
+  VERSION = "0.1.0"
+end

data/lib/po_box.rb

@@ -0,0 +1,10 @@
+require "po_box/version"
+require "po_box/engine"
+
+module PoBox
+  mattr_accessor :emailable_class
+
+  def self.emailable_class
+    @@emailable_class.constantize
+  end
+end

data/lib/tasks/po_box.rake

@@ -0,0 +1,8 @@
+namespace :po_box do
+  desc "Backfill inboxes for emailables"
+  task backfill_emailables: :environment do
+    PoBox.emailable_class.all.each do |emailable|
+      emailable.send(:set_inbox)
+    end
+  end
+end

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: po_box
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leo Policastro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.3
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create inboxes for your users to send and receive emails.
+email:
+- lbpdev@proton.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/po_box_manifest.js
+- app/assets/stylesheets/po_box/application.css
+- app/controllers/po_box/application_controller.rb
+- app/controllers/po_box/emails_controller.rb
+- app/controllers/po_box/inboxes_controller.rb
+- app/helpers/po_box/application_helper.rb
+- app/helpers/po_box/emails_helper.rb
+- app/jobs/po_box/application_job.rb
+- app/mailboxes/application_mailbox.rb
+- app/mailboxes/po_box/inbox_mailbox.rb
+- app/mailers/po_box/application_mailer.rb
+- app/mailers/po_box/emailable_mailer.rb
+- app/models/concerns/po_box/emailable.rb
+- app/models/po_box/application_record.rb
+- app/models/po_box/email.rb
+- app/models/po_box/inbox.rb
+- app/views/layouts/po_box/application.html.erb
+- app/views/layouts/po_box/mailer.html.erb
+- app/views/layouts/po_box/mailer.text.erb
+- app/views/po_box/emails/_email.html.erb
+- app/views/po_box/emails/_form.html.erb
+- app/views/po_box/emails/edit.html.erb
+- app/views/po_box/emails/index.html.erb
+- app/views/po_box/emails/new.html.erb
+- app/views/po_box/emails/show.html.erb
+- app/views/po_box/home/index.html.erb
+- app/views/po_box/inboxes/_form.html.erb
+- app/views/po_box/inboxes/_inbox.html.erb
+- app/views/po_box/inboxes/edit.html.erb
+- app/views/po_box/inboxes/index.html.erb
+- app/views/po_box/inboxes/new.html.erb
+- app/views/po_box/inboxes/show.html.erb
+- config/initializers/po_box.rb
+- config/routes.rb
+- db/migrate/20230425172819_create_po_box_inboxes.rb
+- db/migrate/20230426005820_create_po_box_emails.rb
+- lib/generators/po_box/USAGE
+- lib/generators/po_box/po_box_generator.rb
+- lib/generators/po_box/templates/po_box.rb
+- lib/po_box.rb
+- lib/po_box/engine.rb
+- lib/po_box/version.rb
+- lib/tasks/po_box.rake
+homepage: https://github.com/leopolicastro/po_box
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/leopolicastro/po_box
+  source_code_uri: https://github.com/leopolicastro/po_box
+  changelog_uri: https://github.com/leopolicastro/po_box/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Create inboxes for your users to send and receive emails.
+test_files: []