gemstack-mail 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b803e84a27741f520f77c1155ea6ecf4c4ce640f31629e2c02b3dd5545141bb
-  data.tar.gz: 4bcdcaef45a111d597daa07b67070ad86ea7ae278ae6a6f1936941609c6227a6
+  metadata.gz: d94ff9810f672d1d382bdf463338115eb1434f6d93e7cdfa31a31246c832a10d
+  data.tar.gz: b1f583a5d37f8db64de0b8492ec05cd9d028466493f01404dae1a668ac1a2744
 SHA512:
-  metadata.gz: 3f6c84b19b4e8c18d8aaf50033578a8dc5db2e78905db028bad1ba7f8ab59c8001bdfac7b59ca26745bc49a6557e9a39d419e9ce3445ba178a6d161d443b77fc
-  data.tar.gz: 8aa80738083852405125e756042d133c34c43990a7b3314c0f2ea2c4d5838a73e2d5abdea8bbc471788353f25761c9cc917eb64c12687c50c320b0a3944177ca
+  metadata.gz: 9b77854e54d27d67c8be3be3b598ceec4c8cb05940b206b2a3cbc3f5276b526c7efa8505638512bac406115dd16a83682b408a2c49b31fece4e5d6d5dbe798af
+  data.tar.gz: 0ebbde8d59f1617602bfddae48019609af2d22511548de3e712f2fe938661a4dbb1d08f29c7a9093e6ca34b19050522d9b632e2eb59670f36c40a1aa2e0e1c00

data/CHANGELOG.md

@@ -1,29 +1,5 @@
 # Changelog
 
-## 0.2.5
+## 0.3.0
 
-See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).
-
-## 0.2.4
-
-See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).
-
-## 0.2.3
-
-See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).
-
-## 0.2.2
-
-See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).
-
-## 0.2.1
-
-See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).
-
-## 0.2.0
-
-See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).
-
-## 0.1.0
-
-First release. See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).
+Merged into the gemstack gem; this version is a transition shim. See the [GemStack changelog](https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md).

data/README.md

@@ -1,27 +1,13 @@
 # gemstack-mail
 
-GemStack mail: mailers, templates, SMTP/log/test delivery, deliver_later via jobs.
+**Merged into [`gemstack`](https://rubygems.org/gems/gemstack) in GemStack 0.3.0.**
 
-Part of [GemStack](https://github.com/gemstack-rb/gemstack), a modular Ruby API framework for Next.js
-applications by [Adware Technologies](https://www.adwaretech.com). All GemStack gems are developed together in that repository and released with the same
-version.
+This version is a transition shim: it depends on `gemstack` and loads `gemstack/mail`, so
+Gemfiles that still list `gemstack-mail` keep working. To finish upgrading, remove `gem "gemstack-mail"`
+from your Gemfile and make sure `config/app.rb` has `require "gemstack/mail"` (apps created with 0.3.0 do).
 
-## Installation
-
-Optional module — `gemstack add auth`, or add it to the Gemfile:
-
-```ruby
-gem "gemstack-mail", "~> 0.1"
-```
-
-## Documentation
-
-- [Guide](https://github.com/gemstack-rb/gemstack/blob/main/docs/mail.md)
-- [All guides](https://github.com/gemstack-rb/gemstack/tree/main/docs) ·
-  [Architecture](https://github.com/gemstack-rb/gemstack/blob/main/ARCHITECTURE.md)
-
-Source, issues and pull requests: [gemstack-rb/gemstack](https://github.com/gemstack-rb/gemstack)
-(this gem lives in `gems/gemstack-mail`).
+GemStack is a modular Ruby API framework for Next.js applications by
+[Adware Technologies](https://www.adwaretech.com) — [gemstack-rb/gemstack](https://github.com/gemstack-rb/gemstack).
 
 ## License
 

data/lib/gemstack-mail.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# gemstack-mail is part of the gemstack gem since 0.3.0. This shim keeps Gemfiles
+# that still list gemstack-mail working; remove the line from your Gemfile.
+require "gemstack/mail"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemstack-mail
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Adware Technologies
@@ -11,47 +11,28 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: erubi
+  name: gemstack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-- !ruby/object:Gem::Dependency
-  name: gemstack-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
+        version: 0.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.5
-- !ruby/object:Gem::Dependency
-  name: mail
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: 0.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '1.0'
+description: Since GemStack 0.3.0, gemstack-mail is part of the gemstack gem. This
+  version only depends on gemstack and loads gemstack/mail, so Gemfiles that still
+  list it keep working.
 email:
 - gemstack26@gmail.com
 executables: []
@@ -61,18 +42,19 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- lib/gemstack/mail.rb
-- lib/gemstack/mail/delivery_job.rb
-- lib/gemstack/mail/testing.rb
+- lib/gemstack-mail.rb
 homepage: https://github.com/gemstack-rb/gemstack
 licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/gemstack-rb/gemstack/tree/main/gems/gemstack-mail
-  changelog_uri: https://github.com/gemstack-rb/gemstack/blob/main/gems/gemstack-mail/CHANGELOG.md
+  source_code_uri: https://github.com/gemstack-rb/gemstack
+  changelog_uri: https://github.com/gemstack-rb/gemstack/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/gemstack-rb/gemstack/issues
   documentation_uri: https://github.com/gemstack-rb/gemstack/tree/main/docs
+post_install_message: gemstack-mail is now part of the gemstack gem. Remove `gem "gemstack-mail"`
+  from your Gemfile and make sure `config/app.rb` has `require "gemstack/mail"` (apps
+  created with 0.3.0 do).
 rdoc_options: []
 require_paths:
 - lib
@@ -89,6 +71,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.20
 specification_version: 4
-summary: 'GemStack mail: mailers, templates, SMTP/log/test delivery, deliver_later
-  via jobs'
+summary: Merged into the gemstack gem — remove gemstack-mail from your Gemfile
 test_files: []

data/lib/gemstack/mail/delivery_job.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require "gemstack/jobs"
-
-module GemStack
-  module Mail
-    # Delivers a mailer action in the background (Delivery#deliver_later).
-    # Retried like any job; SMTP errors are transient more often than not.
-    class DeliveryJob < GemStack::Job
-      def self.queue(name = nil) = name ? super : (@queue || Mail.config.queue)
-
-      def perform(mailer_name, action, args)
-        mailer = Object.const_get(mailer_name)
-        raise ArgumentError, "#{mailer_name} is not a GemStack::Mailer" unless mailer.is_a?(Class) && mailer < Mailer
-
-        Mailer::Delivery.new(mailer, action, args).deliver_now
-      end
-    end
-  end
-end

data/lib/gemstack/mail/testing.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require "gemstack/mail"
-
-module GemStack
-  module Mail
-    # Test helpers (included into GemStack::TestCase by `gemstack add auth`):
-    #
-    #   assert_emails(1) { post_json "/api/auth/password/forgot", { email: user.email } }
-    #   assert_equal [user.email], last_email.to
-    module Testing
-      def before_setup
-        super
-        Mail.deliveries.clear
-      end
-
-      def deliveries = Mail.deliveries
-      def last_email = Mail.deliveries.last
-
-      def assert_emails(count, &block)
-        before = Mail.deliveries.size
-        adapter = defined?(GemStack::Jobs) && GemStack::Jobs.adapter
-        adapter = nil unless adapter.respond_to?(:perform_enqueued)
-        queued = adapter ? adapter.enqueued.map { |job| job["id"] } : []
-        block&.call
-        # deliver_later mail sent inside the block counts too.
-        adapter&.perform_enqueued(only: ["GemStack::Mail::DeliveryJob"], except_ids: queued)
-        assert_equal count, Mail.deliveries.size - before,
-                     "Expected #{count} email(s), got #{Mail.deliveries.size - before}"
-      end
-    end
-  end
-end

data/lib/gemstack/mail.rb

@@ -1,232 +0,0 @@
-# frozen_string_literal: true
-
-require "mail"
-require "erubi"
-require "uri"
-require "gemstack/core"
-
-module GemStack
-  # Email.
-  #
-  #   class AccountMailer < GemStack::Mailer
-  #     default from: "Shop <hello@shop.test>"
-  #
-  #     def welcome(user_id)
-  #       @user = User.find(user_id)
-  #       mail to: @user.email, subject: "Welcome!" # templates/account_mailer/welcome.{text,html}.erb
-  #     end
-  #   end
-  #
-  #   AccountMailer.welcome(user.id).deliver_later   # through GemStack::Jobs (pass ids)
-  #   AccountMailer.welcome(user.id).deliver_now
-  module Mail
-    class Config < Settings
-      # :smtp (production), :log (development: logged and saved to tmp/mail),
-      # :test (captured in GemStack::Mail.deliveries), or an object with #deliver(message).
-      setting :delivery, default: lambda {
-        if GemStack.env.test? then :test
-        elsif GemStack.env.development? then :log
-        else :smtp
-        end
-      }
-      # smtp://user:password@smtp.example.com:587 (STARTTLS) or smtps://…:465
-      setting :smtp_url, default: -> { ENV.fetch("SMTP_URL", nil) }
-      setting :default_from, default: -> { ENV.fetch("MAIL_FROM", "#{GemStack.config.name} <no-reply@localhost>") }
-      setting :templates_path, default: "app/mailers/templates"
-      setting :preview_dir, default: "tmp/mail"
-      # Queue used by deliver_later.
-      setting :queue, default: "mailers"
-    end
-
-    class DeliveryError < Error; end
-
-    # Loaded on first use, also by a jobs worker resolving the queued class name.
-    autoload :DeliveryJob, "gemstack/mail/delivery_job"
-
-    @deliveries = []
-    @mutex = Mutex.new
-
-    class << self
-      def config = GemStack.config.mail
-
-      # Messages delivered with the :test method.
-      attr_reader :deliveries
-
-      def deliver(message)
-        method = config.delivery
-        case method
-        when :test, "test" then @mutex.synchronize { @deliveries << message }
-        when :log, "log" then deliver_to_log(message)
-        when :smtp, "smtp" then deliver_smtp(message)
-        else
-          unless method.respond_to?(:deliver)
-            raise ConfigurationError,
-                  "a mail delivery method must respond to #deliver"
-          end
-
-          method.deliver(message)
-        end
-        GemStack.logger.info("mail.delivered", to: Array(message.to).join(","), subject: message.subject,
-                                               via: method.is_a?(Symbol) ? method : method.class.name)
-        message
-      end
-
-      def smtp_settings(url = config.smtp_url)
-        if url.to_s.empty?
-          raise ConfigurationError,
-                "set SMTP_URL (e.g. smtp://user:pass@smtp.example.com:587) to send mail"
-        end
-
-        uri = URI.parse(url)
-        {
-          address: uri.host, port: uri.port || (uri.scheme == "smtps" ? 465 : 587),
-          user_name: uri.user && URI.decode_www_form_component(uri.user),
-          password: uri.password && URI.decode_www_form_component(uri.password),
-          authentication: uri.user ? :plain : nil, tls: uri.scheme == "smtps",
-          enable_starttls_auto: uri.scheme != "smtps", open_timeout: 5, read_timeout: 10
-        }.compact
-      end
-
-      private
-
-      def deliver_smtp(message)
-        message.delivery_method(:smtp, smtp_settings)
-        message.deliver
-      rescue Net::SMTPError, SocketError, SystemCallError, Timeout::Error, OpenSSL::SSL::SSLError => e
-        raise DeliveryError, "SMTP delivery failed: #{e.class}: #{e.message}"
-      end
-
-      # Development: a log line plus a copy on disk (.eml, and .html to open in a browser).
-      def deliver_to_log(message)
-        dir = File.expand_path(config.preview_dir, GemStack.config.root)
-        FileUtils.mkdir_p(dir)
-        slug = message.subject.to_s.downcase.gsub(/[^a-z0-9]+/, "-").delete_prefix("-")[0, 40]
-        base = File.join(dir, "#{Time.now.strftime("%Y%m%d-%H%M%S-%L")}-#{slug}")
-        File.write("#{base}.eml", message.to_s)
-        html = message.html_part&.decoded
-        File.write("#{base}.html", html) if html
-        GemStack.logger.info("mail saved", to: Array(message.to).join(","), subject: message.subject,
-                                           file: "#{base}#{".html" if html}")
-      end
-    end
-  end
-
-  # Base class for mailers. Public instance methods are mail "actions";
-  # calling one on the class returns a Delivery. An action that returns
-  # without calling `mail` sends nothing (e.g. the user was deleted since).
-  class Mailer
-    # Rendered as the value of @variables set in the action.
-    class TemplateContext
-      def initialize(mailer)
-        mailer.instance_variables.each { |ivar| instance_variable_set(ivar, mailer.instance_variable_get(ivar)) }
-      end
-
-      def render(source, escape:) = instance_eval(Erubi::Engine.new(source, escape: escape).src)
-    end
-
-    # A message waiting to be delivered.
-    class Delivery
-      attr_reader :mailer_class, :action, :args
-
-      def initialize(mailer_class, action, args)
-        @mailer_class = mailer_class
-        @action = action
-        @args = args
-      end
-
-      def message
-        return @message if defined?(@message)
-
-        @message = mailer_class.new.build(action, args)
-      end
-
-      # nil when the action decided not to send (it returned without calling mail).
-      def deliver_now
-        msg = message
-        msg && Mail.deliver(msg)
-      end
-
-      # Delivers from a background job (arguments must be JSON values — pass ids).
-      def deliver_later(wait: nil)
-        require "gemstack/jobs"
-        job = wait ? Mail::DeliveryJob.set(wait: wait) : Mail::DeliveryJob
-        job.perform_later(mailer_class.name, action.to_s, args)
-      rescue LoadError
-        raise ConfigurationError, "deliver_later needs gemstack-jobs; add it to the Gemfile or use deliver_now"
-      end
-    end
-
-    class << self
-      def default(**headers) = defaults.merge!(headers.transform_keys(&:to_sym))
-      def defaults = @defaults ||= superclass.respond_to?(:defaults) ? superclass.defaults.dup : {}
-
-      def actions
-        (public_instance_methods(true) - Mailer.public_instance_methods(true)).map(&:to_s)
-      end
-
-      def respond_to_missing?(name, include_private = false) = actions.include?(name.to_s) || super
-
-      def method_missing(name, *args)
-        return super unless actions.include?(name.to_s)
-
-        Delivery.new(self, name.to_s, args)
-      end
-    end
-
-    def build(action, args)
-      @action = action
-      public_send(action, *args)
-      GemStack.logger.debug("mail skipped", mailer: self.class.name, action: action) unless @message
-      @message
-    end
-
-    # Builds the message. Bodies come from text:/html: or, when omitted, from
-    # templates: <templates_path>/<mailer>/<action>.text.erb and .html.erb
-    # (HTML templates escape <%= %> output; use <%== %> for trusted markup).
-    def mail(to:, subject:, text: nil, html: nil, from: nil, cc: nil, bcc: nil, reply_to: nil, template: @action)
-      headers = self.class.defaults
-      text ||= render_template(template, "text", escape: false)
-      html ||= render_template(template, "html", escape: true)
-      raise Error, "#{self.class.name}##{@action}: no body (give text:/html: or add a template)" unless text || html
-
-      @message = build_message(to: to, subject: subject, text: text, html: html,
-                               from: from || headers[:from] || Mail.config.default_from, cc: cc, bcc: bcc,
-                               reply_to: reply_to || headers[:reply_to])
-    end
-
-    private
-
-    def render_template(name, format, escape:)
-      path = File.join(GemStack.config.root, Mail.config.templates_path, Inflector.underscore(self.class.name),
-                       "#{name}.#{format}.erb")
-      return nil unless File.file?(path)
-
-      TemplateContext.new(self).render(File.read(path), escape: escape)
-    end
-
-    def build_message(to:, subject:, text:, html:, from:, cc:, bcc:, reply_to:)
-      message = ::Mail.new
-      message.from = from
-      message.to = to
-      message.cc = cc if cc
-      message.bcc = bcc if bcc
-      message.reply_to = reply_to if reply_to
-      message.subject = subject
-      if text
-        message.text_part = ::Mail::Part.new do
-          body text
-          content_type "text/plain; charset=UTF-8"
-        end
-      end
-      if html
-        message.html_part = ::Mail::Part.new do
-          body html
-          content_type "text/html; charset=UTF-8"
-        end
-      end
-      message
-    end
-  end
-end
-
-GemStack::Config.namespace(:mail, GemStack::Mail::Config)