missive 0.0.1.pre → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8f0fafdf0f75d8ed064f71eb41232a210e94a7cb628f7f1baf5ef143c21b9bf
-  data.tar.gz: 1393cfff9b146e8b58e60e0be44241af4f5fddbf34a8058015187c487207ca73
+  metadata.gz: 63e8195762299f95bdc217efcf1a81dbd8be46ec029ea90b8b4db430af37eabd
+  data.tar.gz: 94532fa3c3cd42c9086b35385773c0d2f8483dad96690b0d78523512736aa86e
 SHA512:
-  metadata.gz: bead54c48d4b4a1114a420a4ec18c02b0a7238521a27528564c27424fcb91469afbde5544a118040d1e70e06b02a96250c756c76ae509456ba79c69595b11c6c
-  data.tar.gz: 530f6996cd21ac2dd8a3d792bd436b6ff748f6e32064f9849091bf2740403610aaa4f853ffbe1505ee8c72ec2aaa7b44ed1d22d2d993e94d7ee706007ee938ac
+  metadata.gz: d365c0b22c19489e7d61d46746bec34d58834c167066f02eb71cec287e855a7e820e1eb535e066c2f871cc948338bbbd5151efac7838ca037e2455b36c4dbe07
+  data.tar.gz: d7c9d72e65bbac0b683b6f5b69b888547f7ebc5245c35b6b9f582042ad8ef524b775acaed2aa47d17dd4a2be689315c02e41570913edebf7c213b5d0dc728f6f

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+- Add install generator
+- Add Postmark Bulk API implementation
+
+## [0.0.1] - 2025-10-14
+
+- First release: base models, database structure
+
 ## [0.0.1.pre] - 2025-09-30
 
 - First commit

data/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Spone/missive. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Spone/missive/blob/main/CODE_OF_CONDUCT.md).
+
+## Testing
+
+Run the test suite with:
+
+```bash
+bin/rails test
+```
+
+## Get started
+
+- Fork the repository
+- Run `bin/setup` to install dependencies
+- Create your feature branch (`git checkout -b my-new-feature`)
+- Make your changes
+- Run the tests `bin/rails test`
+- Commit your change, push the branch and create a pull request
+
+## Release
+
+- Update the version number in `version.rb`
+- Run `bundle exec rake release`, which will create a git tag for the version
+- Push git commits and the created tag
+- Push the `.gem` file to [rubygems.org](https://rubygems.org)

data/README.md

@@ -1,38 +1,252 @@
 # Missive
 
-TODO: Delete this and the text below, and describe your gem
+A lightweight Rails toolkit for building newsletter features. Missive provides the primitives for managing newsletters and subscribers, with [Postmark](https://postmarkapp.com/) handling delivery.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/missive`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Overview
 
-## Installation
+### Features
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+- **Newsletter Management**: Create and organize newsletters within your Rails application
+- **Postmark Integration**: Leverage Postmark's reliable email delivery service
+- **Rails Native**: Designed to work seamlessly with Rails conventions and ActionMailer
+- **Subscriber Management**: Handle your newsletter subscriber lists
 
-Install the gem and add to the application's Gemfile by executing:
+### Scope
+
+#### Goals
+
+- Rely on Postmark as much as possible, integrate with webhooks, send through Postmark API (not SMTP).
+- Provide a way to compose messages that include content from the host app models.
+
+#### Non-goals
+
+- Integrate with other sending services.
+- Send transactional emails or email sequences: Missive focuses on newsletters.
+- Provide ready-made subscription forms: subscription management is the responsibility of the host app.
+- Multi-tenancy: Missive is designed for a single Rails app and domain.
+
+## Concepts
+
+### Models
+
+- `Sender` is an identity used to send messages, optionally associated with a `User` from the host app. It has a corresponding [Sender Signature](https://postmarkapp.com/developer/api/signatures-api) in Postmark.
+- `Subscriber` is a person who have opted in to receiving emails or have been added manually, optionally associated with a `User` from the host app.
+- `Subscription` is the relation between a subscriber and a list.
+- `List` is a list of subscribers. It uses a specific [Message Stream](https://postmarkapp.com/developer/api/message-streams-api) to send messages through Postmark.
+- `Message` is an email sent to subscribers of a given list.
+- `Dispatch` is the relation between a subscriber and a message (ie. when a `Message` is sent, it's dispatched to all subscribers). It's called [Email](https://postmarkapp.com/developer/api/email-api) in Postmark.
+
+## Requirements
+
+- Rails 8.0 or higher
+- A Postmark account with API credentials
+
+### Dependencies
+
+- Official [postmark](https://github.com/activecampaign/postmark-gem) gem
+- [time_for_a_boolean](https://github.com/calebhearth/time_for_a_boolean) to back boolean concepts (`sent`, `delivered`, `open`, ...) with timestamps
+- [rails-pattern_matching](https://github.com/kddnewton/rails-pattern_matching) to use pattern matching when processing incoming webhooks
+
+## Usage
+
+### Setup
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add missive
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Install the migrations:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+rails generate missive:install
 ```
 
-## Usage
+### Configuration
+
+Missive uses the same configuration as `postmark-rails`. Please follow the [`postmark-rails` configuration instructions](https://github.com/ActiveCampaign/postmark-rails?tab=readme-ov-file#installation) to set up your Postmark API credentials.
+
+### Quick start
+
+#### Connect the host app `User` model (optional)
+
+The host app `User` can be associated to a `Missive::Subscriber` and/or a `Missive::Sender`, using the `Missive::User` concern.
+
+```rb
+class User < ApplicationRecord
+  include Missive::User
+end
+```
+
+The concerns can also be included separately, which is useful if `User` needs to be implemented as a `Sender` or `Subscriber` only.
+
+```rb
+class User < ApplicationRecord
+  include Missive::UserAsSender
+  include Missive::UserAsSubscriber
+end
+```
+
+This is equivalent to:
+
+```rb
+class User < ApplicationRecord
+  # Missive::UserAsSender
+  has_one :sender # ...
+  has_many :sent_dispatches # ...
+  has_many :sent_lists # ...
+  has_many :sent_messages # ...
+
+  def init_sender(attributes = {});
+    # ...
+  end
+
+  # Missive::UserAsSubscriber
+  has_one :subscriber # ...
+  has_many :dispatches # ...
+  has_many :subscriptions # ...
+  has_many :subscribed_lists # ...
+  has_many :unsubscribed_lists # ...
+
+  def init_subscriber(attributes = {})
+    # ...
+  end
+end
+```
+
+#### Manage subscriptions
+
+```rb
+user = User.first
+list = Missive::List.first
 
-TODO: Write usage instructions here
+# Make sure the User has an associated Missive::Subscriber:
+# - if one exists with the same email, associate it
+# - else create a new subscriber with the same email
+user.init_subscriber
 
-## Development
+# List the subscriptions
+user.subscriptions # returns a `Missive::Subscription` collection
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# List the (un)subscribed lists
+user.subscribed_lists # returns a `Missive::List` collection
+user.unsubscribed_lists # returns a `Missive::List` collection
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+# Subscribe to an existing Missive::List
+user.subscriber.subscriptions.create!(list:)
 
-## Contributing
+# Unsubscribe from the list
+user.subscriptions.find_by(list:).suppress!(reason: :manual_suppression)
+```
+
+#### Manage senders
+
+```rb
+user = User.where(admin: true).first
+list = Missive::List.first
+
+# Make sure the User has an associated Missive::Sender:
+# - if one exists with the same email, associate it
+# - else create a new sender with the same email
+# then assign them the provided name
+user.init_sender(name: user.full_name)
+
+# Make them the default sender for a list
+user.sent_lists << list
+```
+
+#### Manage lists
+
+```rb
+# Create a new list
+list = Missive::List.create!(name: "My newsletter")
+
+# Choose a specific Message Stream to send messages for this list
+list.update!(postmark_message_stream_id: "bulk")
+
+# Get available lists
+Missive::List.all
+
+# Get list stats
+list.subscriptions_count # how many people subscribe or unsubscribe to this list?
+list.messages_count # how many messages have been created in this list?
+```
+
+> [!WARNING]
+> **Everything below is currently being developed and is not yet ready for use.**
+
+#### Manage messages
+
+```rb
+# Create a new message in a list
+list.create_message!(subject: "Hello world!")
+
+# TODO: add message content
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/missive. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/missive/blob/main/CODE_OF_CONDUCT.md).
+# Send the message to the list
+message.send!
+```
+
+### Sending with Postmark Bulk API
+
+Missive leverages the [Bulk Email API](https://postmarkapp.com/developer/api/bulk-email) endpoints.
+
+> [!WARNING]
+> This endpoint is available to early access customers only. You need to request access. [Learn more](https://postmarkapp.com/support/article/1311-the-early-access-program-for-the-new-bulk-api)
+
+The official [postmark gem](https://github.com/ActiveCampaign/postmark-gem) does not support these endpoints yet, so Missive ships with `Stamp`, a thin layer over Postmark's official library.
+
+#### Sending a message in bulk
+
+You can pass a Hash that matches the body expected by the API.
+
+```rb
+Missive::Stamp::ApiClient.deliver_in_bulk(
+  from: "sender@example.com",
+  subject: "Hello {{name}}",
+  html_body: "<p>Hello {{name}}</p>",
+  text_body: "Hello {{name}}",
+  messages: [
+    {
+      to: "jane.doe@example.com",
+      template_model: {name: "Jane"}
+    },
+    {
+      to: "john.doe@example.com",
+      template_model: {name: "John"}
+    }
+  ]
+)
+```
+
+You can also pass a `Mail` instance and an Array of recipients.
+
+```rb
+mail = Mail.new do
+  from "sender@example.com"
+  subject "Hello {{name}}"
+  body: "Hello {{name}}"
+end
+
+Missive::Stamp::ApiClient.deliver_message_in_bulk(
+  mail,
+  [
+    {
+      to: "jane.doe@example.com",
+      template_model: {name: "Jane"}
+    },
+    {
+      to: "john.doe@example.com",
+      template_model: {name: "John"}
+    }
+  ]
+)
+```
+
+#### Getting the status of a bulk API request
+
+```rb
+Missive::Stamp::ApiClient.get_bulk_status("f24af63c-533d-4b7a-ad65-4a7b3202d3a7")
+```
 
 ## License
 
@@ -40,4 +254,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Missive project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/missive/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Missive project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Spone/missive/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,10 +1,11 @@
-# frozen_string_literal: true
+require "bundler/setup"
 
-require "bundler/gem_tasks"
-require "minitest/test_task"
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-Minitest::TestTask.create
+load "rails/tasks/statistics.rake"
 
 require "standard/rake"
+require "bundler/gem_tasks"
 
 task default: %i[test standard]

data/app/controllers/missive/application_controller.rb

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

data/app/controllers/missive/postmark/webhooks_controller.rb

@@ -0,0 +1,92 @@
+module Missive
+  class Postmark::WebhooksController < ApplicationController
+    skip_forgery_protection
+
+    class RecipientNotMatching < StandardError; end
+
+    before_action :verify_webhook
+    before_action :set_payload, only: :receive
+
+    rescue_from RecipientNotMatching, with: :handle_bad_request
+    rescue_from ActiveRecord::RecordNotFound, with: :handle_not_found
+    rescue_from NoMatchingPatternError, with: :handle_no_matching_pattern
+
+    def receive
+      case @payload
+      in {RecordType: "Open", ReceivedAt: opened_at}
+        set_subscriber! && set_dispatch! && check_dispatch_recipient!
+        @dispatch.update!(opened_at:)
+      in {RecordType: "Delivery", DeliveredAt: delivered_at}
+        set_subscriber! && set_dispatch! && check_dispatch_recipient!
+        @dispatch.update!(delivered_at:)
+      in {RecordType: "SubscriptionChange", ChangedAt: suppressed_at, SuppressSending: true, SuppressionReason: suppression_reason}
+        set_subscriber! && set_dispatch && set_subscription
+        reason = suppression_reason.underscore
+        @subscriber.suppress!(reason:)
+        @dispatch&.suppress!(reason:)
+        @subscription&.suppress!(reason:)
+      in {RecordType: "SubscriptionChange", SuppressSending: false}
+        set_subscriber! && set_dispatch && set_subscription
+        @subscriber.unsuppress!
+        @dispatch&.unsuppress!
+        @subscription&.unsuppress!
+      end
+
+      head :ok
+    end
+
+    private
+
+    def verify_webhook
+      secret_header = request.headers["HTTP_X_POSTMARK_SECRET"]
+
+      render plain: "Cannot verify webhook", status: :unauthorized if secret_header != webhooks_secret
+    end
+
+    def set_payload
+      @payload = JSON.parse(request.body.read).with_indifferent_access
+    end
+
+    def set_dispatch
+      @dispatch = Dispatch.includes(:subscriber, :list).find_by(postmark_message_id: @payload["MessageID"])
+    end
+
+    def set_dispatch!
+      @dispatch = Dispatch.includes(:subscriber, :list).find_by!(postmark_message_id: @payload["MessageID"])
+    end
+
+    def set_subscriber!
+      @subscriber = Subscriber.find_by!(email: @payload["Recipient"])
+    end
+
+    def set_subscription
+      return if @dispatch.nil?
+
+      list = @dispatch.list
+      @subscription = Subscription.find_by(list:, subscriber: @subscriber)
+    end
+
+    def check_dispatch_recipient!
+      return unless @dispatch.subscriber != @subscriber
+
+      raise RecipientNotMatching,
+        "Dispatch subscriber #{@dispatch.subscriber.email} does not match payload recipient #{@payload["Recipient"]}"
+    end
+
+    def webhooks_secret
+      Rails.application.credentials.postmark.webhooks_secret
+    end
+
+    def handle_bad_request(e)
+      render plain: e.message, status: :bad_request
+    end
+
+    def handle_not_found(e)
+      render plain: "#{e.model} not found", status: :not_found
+    end
+
+    def handle_no_matching_pattern
+      render plain: "Webhook payload not supported", status: :unprocessable_entity
+    end
+  end
+end

data/app/helpers/missive/application_helper.rb

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

data/app/jobs/missive/application_job.rb

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

data/app/mailers/missive/application_mailer.rb

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

data/app/models/concerns/missive/suppressible.rb

@@ -0,0 +1,26 @@
+module Missive
+  module Suppressible
+    extend ActiveSupport::Concern
+
+    included do
+      time_for_a_boolean :suppressed
+
+      enum :suppression_reason, %i[hard_bounce spam_complaint manual_suppression]
+
+      scope :suppressed, -> { where.not(suppressed_at: nil) }
+      scope :not_suppressed, -> { where(suppressed_at: nil) }
+
+      validates :suppression_reason, presence: true, if: :suppressed?
+
+      def suppress!(reason:)
+        self.suppression_reason = reason
+        suppressed!
+        save!
+      end
+
+      def unsuppress!
+        update!(suppressed_at: nil, suppression_reason: nil)
+      end
+    end
+  end
+end

data/app/models/concerns/missive/user.rb

@@ -0,0 +1,10 @@
+module Missive
+  module User
+    extend ActiveSupport::Concern
+
+    included do
+      include Missive::UserAsSender
+      include Missive::UserAsSubscriber
+    end
+  end
+end

data/app/models/concerns/missive/user_as_sender.rb

@@ -0,0 +1,19 @@
+module Missive
+  module UserAsSender
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :sender, class_name: "Missive::Sender", dependent: :nullify
+      has_many :sent_dispatches, class_name: "Missive::Dispatch", through: :sender, source: :dispatches
+      has_many :sent_lists, class_name: "Missive::List", through: :sender, source: :lists
+      has_many :sent_messages, class_name: "Missive::Message", through: :sender, source: :messages
+
+      def init_sender(attributes = {})
+        self.sender = Missive::Sender.find_or_initialize_by(email:)
+        sender.assign_attributes(attributes)
+        sender.save!
+        sender
+      end
+    end
+  end
+end

data/app/models/concerns/missive/user_as_subscriber.rb

@@ -0,0 +1,23 @@
+module Missive
+  module UserAsSubscriber
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :subscriber, class_name: "Missive::Subscriber", dependent: :destroy
+      has_many :dispatches, class_name: "Missive::Dispatch", through: :subscriber
+      has_many :subscriptions, class_name: "Missive::Subscription", through: :subscriber
+      has_many :subscribed_lists, class_name: "Missive::List", through: :subscriber, source: :lists
+      has_many :unsubscribed_lists, -> { where.not(missive_subscriptions: {suppressed_at: nil}) },
+        class_name: "Missive::List",
+        through: :subscriber,
+        source: :lists
+
+      def init_subscriber(attributes = {})
+        self.subscriber = Missive::Subscriber.find_or_initialize_by(email:)
+        subscriber.assign_attributes(attributes)
+        subscriber.save!
+        subscriber
+      end
+    end
+  end
+end

data/app/models/missive/application_record.rb

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

data/app/models/missive/dispatch.rb

@@ -0,0 +1,19 @@
+module Missive
+  class Dispatch < ApplicationRecord
+    include Suppressible
+
+    belongs_to :sender
+    belongs_to :subscriber
+    belongs_to :message, counter_cache: :dispatches_count
+    has_one :list, through: :message
+    has_one :subscription, ->(dispatch) { where(list: dispatch.list) }, through: :subscriber, source: :subscriptions
+
+    time_for_a_boolean :sent
+    time_for_a_boolean :delivered
+    time_for_a_boolean :opened
+    time_for_a_boolean :clicked
+
+    validates :message, uniqueness: {scope: :subscriber,
+                                     message: "should be dispatched once per subscriber"}
+  end
+end

data/app/models/missive/list.rb

@@ -0,0 +1,10 @@
+module Missive
+  class List < ApplicationRecord
+    belongs_to :sender
+    has_many :messages, dependent: :destroy
+    has_many :subscriptions, dependent: :destroy
+    has_many :subscribers, through: :subscriptions
+
+    validates :name, presence: true
+  end
+end

data/app/models/missive/message.rb

@@ -0,0 +1,11 @@
+module Missive
+  class Message < ApplicationRecord
+    belongs_to :sender
+    belongs_to :list, counter_cache: :messages_count
+    has_many :dispatches, dependent: :destroy
+
+    time_for_a_boolean :sent
+
+    validates :subject, presence: true
+  end
+end

data/app/models/missive/sender.rb

@@ -0,0 +1,10 @@
+module Missive
+  class Sender < ApplicationRecord
+    belongs_to :user, class_name: "::User", optional: true
+    has_many :dispatches, dependent: :restrict_with_exception
+    has_many :lists, dependent: :restrict_with_exception
+    has_many :messages, dependent: :restrict_with_exception
+
+    validates :email, presence: true
+  end
+end

data/app/models/missive/subscriber.rb

@@ -0,0 +1,12 @@
+module Missive
+  class Subscriber < ApplicationRecord
+    include Suppressible
+
+    belongs_to :user, class_name: "::User", optional: true
+    has_many :dispatches, dependent: :destroy
+    has_many :subscriptions, dependent: :destroy
+    has_many :lists, through: :subscriptions
+
+    validates :email, presence: true
+  end
+end

data/app/models/missive/subscription.rb

@@ -0,0 +1,11 @@
+module Missive
+  class Subscription < ApplicationRecord
+    include Suppressible
+
+    belongs_to :subscriber
+    belongs_to :list, counter_cache: :subscriptions_count
+
+    validates :list, uniqueness: {scope: :subscriber,
+                                  message: "should be subscribed once per subscriber"}
+  end
+end

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

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Missive</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "missive/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Missive::Engine.routes.draw do
+  namespace :postmark do
+    post "webhooks", to: "webhooks#receive"
+  end
+end

data/lefthook.yml

@@ -0,0 +1,13 @@
+# EXAMPLE USAGE:
+#
+#   Refer for explanation to following link:
+#   https://github.com/evilmartians/lefthook/blob/master/docs/configuration.md
+
+pre-commit:
+  parallel: true
+  commands:
+    standard:
+      tags: ruby style
+      glob: "**/*.rb"
+      run: bundle exec rake standard:fix {staged_files}
+      stage_fixed: true

data/lib/generators/missive/install_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+require "rails/generators/active_record"
+
+module Missive
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def copy_missive_migrations
+        migration_template "migrations/install_missive.rb.erb", "db/migrate/install_missive.rb"
+      end
+
+      private
+
+      def migration_class_name
+        if Rails::VERSION::MAJOR >= 5
+          "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+        else
+          "ActiveRecord::Migration"
+        end
+      end
+    end
+  end
+end

data/lib/generators/missive/templates/migrations/install_missive.rb.erb

@@ -0,0 +1,74 @@
+class InstallMissive < <%= migration_class_name %>
+  def change
+    create_table :missive_subscribers do |t|
+      t.string :email, null: false
+      t.timestamp :suppressed_at
+      t.integer :suppression_reason
+      t.references :user, foreign_key: true
+
+      t.timestamps
+    end
+
+    create_table :missive_lists do |t|
+      t.string :name, null: false
+      t.integer :subscriptions_count, default: 0
+      t.integer :messages_count, default: 0
+      t.timestamp :last_message_sent_at
+      t.string :postmark_message_stream_id
+
+      t.timestamps
+    end
+
+    create_table :missive_messages do |t|
+      t.string :subject, null: false
+      t.integer :dispatches_count, default: 0
+      t.references :list, null: false, foreign_key: {to_table: "missive_lists"}
+      t.string :postmark_message_stream_id
+      t.timestamp :sent_at
+
+      t.timestamps
+    end
+
+    create_table :missive_dispatches do |t|
+      t.references :subscriber, null: false, foreign_key: {to_table: "missive_subscribers"}
+      t.references :message, null: false, foreign_key: {to_table: "missive_messages"}
+      t.string :postmark_message_stream_id
+      t.string :postmark_message_id
+      t.timestamp :sent_at
+      t.timestamp :delivered_at
+      t.timestamp :opened_at
+      t.timestamp :clicked_at
+      t.timestamp :suppressed_at
+      t.integer :suppression_reason
+
+      t.index [:subscriber_id, :message_id], unique: true
+
+      t.timestamps
+    end
+
+    create_table :missive_subscriptions do |t|
+      t.references :subscriber, null: false, foreign_key: {to_table: "missive_subscribers"}
+      t.references :list, null: false, foreign_key: {to_table: "missive_lists"}
+      t.timestamp :suppressed_at
+      t.integer :suppression_reason
+
+      t.index [:subscriber_id, :list_id], unique: true
+
+      t.timestamps
+    end
+
+    create_table :missive_senders do |t|
+      t.string :email, null: false
+      t.string :name
+      t.string :reply_to_email
+      t.integer :postmark_sender_signature_id
+      t.references :user, foreign_key: false
+
+      t.timestamps
+    end
+
+    add_reference :missive_dispatches, :sender, null: false, foreign_key: {to_table: "missive_senders"}
+    add_reference :missive_lists, :sender, null: false, foreign_key: {to_table: "missive_senders"}
+    add_reference :missive_messages, :sender, null: false, foreign_key: {to_table: "missive_senders"}
+  end
+end

data/lib/missive/engine.rb

@@ -0,0 +1,7 @@
+require "time_for_a_boolean"
+
+module Missive
+  class Engine < ::Rails::Engine
+    isolate_namespace Missive
+  end
+end

data/lib/missive/railtie.rb

@@ -0,0 +1,4 @@
+module Missive
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/missive/stamp/api_client.rb

@@ -0,0 +1,40 @@
+module Missive
+  # Stamp is a thin layer over Postmark's official library,
+  # that improves it for Missive's needs.
+  #
+  # Main features:
+  # - implementation of the [Bulk API](https://postmarkapp.com/developer/api/bulk-email)
+  module Stamp
+    class ApiClient < ::Postmark::ApiClient
+      # Send bulk emails, passing a hash
+      # https://postmarkapp.com/developer/api/bulk-email#send-bulk-emails
+      def deliver_in_bulk(message_hash)
+        data = serialize(::Postmark::MessageHelper.to_postmark(message_hash))
+
+        with_retries do
+          format_response http_client.post("email/bulk", data)
+        end
+      end
+
+      # Send bulk emails, passing a message and its recipients
+      # https://postmarkapp.com/developer/api/bulk-email#send-bulk-emails
+      def deliver_message_in_bulk(message, recipients = [])
+        data = serialize(message.to_postmark_hash.merge(messages: recipients))
+
+        with_retries do
+          response, error = take_response_of { http_client.post("email/bulk", data) }
+          update_message(message, response)
+          raise error if error
+
+          format_response(response, compatible: true)
+        end
+      end
+
+      # Get the status/details of a bulk API request
+      # https://postmarkapp.com/developer/api/bulk-email#get-a-bulk-send-status
+      def get_bulk_status(id)
+        format_response http_client.get("email/bulk/#{id}")
+      end
+    end
+  end
+end

data/lib/missive/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Missive
-  VERSION = "0.0.1.pre"
+  VERSION = "0.0.2".freeze
 end

data/lib/missive.rb

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-require_relative "missive/version"
+require "missive/version"
+require "missive/engine"
+require "postmark"
+require "missive/stamp/api_client"
 
 module Missive
-  class Error < StandardError; end
   # Your code goes here...
 end

data/lib/tasks/missive_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :missive do
+#   # Task goes here
+# end

metadata

@@ -1,14 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: missive
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.0.2
 platform: ruby
 authors:
 - Hans Lemuet
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: postmark-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.1
+- !ruby/object:Gem::Dependency
+  name: time_for_a_boolean
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: rails-pattern_matching
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 description: 'Missive provides primitives to build your own custom newsletter: lists,
   subscribers, content editor, tracking.'
 email:
@@ -20,11 +76,39 @@ files:
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/concerns/.keep
+- app/controllers/missive/application_controller.rb
+- app/controllers/missive/postmark/webhooks_controller.rb
+- app/helpers/missive/application_helper.rb
+- app/jobs/missive/application_job.rb
+- app/mailers/missive/application_mailer.rb
+- app/models/concerns/.keep
+- app/models/concerns/missive/suppressible.rb
+- app/models/concerns/missive/user.rb
+- app/models/concerns/missive/user_as_sender.rb
+- app/models/concerns/missive/user_as_subscriber.rb
+- app/models/missive/application_record.rb
+- app/models/missive/dispatch.rb
+- app/models/missive/list.rb
+- app/models/missive/message.rb
+- app/models/missive/sender.rb
+- app/models/missive/subscriber.rb
+- app/models/missive/subscription.rb
+- app/views/layouts/missive/application.html.erb
+- config/routes.rb
+- lefthook.yml
+- lib/generators/missive/install_generator.rb
+- lib/generators/missive/templates/migrations/install_missive.rb.erb
 - lib/missive.rb
+- lib/missive/engine.rb
+- lib/missive/railtie.rb
+- lib/missive/stamp/api_client.rb
 - lib/missive/version.rb
+- lib/tasks/missive_tasks.rake
 homepage: https://github.com/Spone/missive
 licenses:
 - MIT
@@ -46,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Toolbox for managing newsletters in Rails, sending them with Postmark.
 test_files: []