wakio 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 701b8f414dc39686af35c768fd62f176365f50e8e10cf5fc8d47fe8473fad702
-  data.tar.gz: ab412723cc02b1ce9e04c9fdcb51b0282f467d1f43dacbd415a4df4532111406
+  metadata.gz: 41b4696d5b5dcea8872174fce7d104adeb163eb775555de498214e2ba1c49711
+  data.tar.gz: 1b7eaa7f2b2e4540b4f60a4beb979718262b54a35e64c34a52fc931aa1a748d0
 SHA512:
-  metadata.gz: 1e5191bf7700df69a86c119fd2dadbc4e8ef26e5530b68dd60727057f6f9c08e6e6e1928040001986585dd9ebf4ea9f9032da6561687330dff4f887c654aea85
-  data.tar.gz: 20c01bf3d406b7431632aac6367ecb227fc735fef780cba4f4c760db1df898fbc34b5def97e0c46f96ed1742b9e5c575666b180845300892e8fe423566cb16ea
+  metadata.gz: ec7af6244e5c01a97da9b8455b23475dbf4d26a86df036e0cc97ec341020b19dc7b9b851307185f5d4d2a8052a3e53cb4db37a28f350c39acd23ea6762baae07
+  data.tar.gz: 99b951382c14c5ee5732411f3ce2f4fc75c3128c9283d495d48763881fae5d1593630886970c55a82f89148a519a881f2e7ddc41b8968d2e252726381ffaf97b

data/README.md

@@ -14,7 +14,9 @@ config.action_mailer.wakio_settings = {
 }
 ```
 
-`open_timeout` and `read_timeout` are optional, in seconds, and default to 5 and 10. A timeout raises `Net::OpenTimeout` or `Net::ReadTimeout`, not `Wakio::DeliveryError`. A read timeout can come after Wakio accepted the send, so a retry without an idempotency key (below) may send twice.
+`open_timeout` and `read_timeout` are optional, in seconds, and default to 5 and 10. A timeout raises `Net::OpenTimeout` or `Net::ReadTimeout`, and any other network failure raises Ruby's own error, not `Wakio::DeliveryError`. A read timeout can come after Wakio accepted the send, so a retry without an idempotency key (below) may send twice.
+
+`host` must be `https`. An `http` host other than `localhost` raises `Wakio::Misconfigured` before anything is sent, so the API key never travels in cleartext.
 
 Every existing mailer keeps working unchanged. Its rendered subject, its HTML and text parts, and its `from` go to Wakio as they are, with no server-side template involved. A text-only mailer sends a text-only email.
 
@@ -24,11 +26,24 @@ The `from` domain must be one of your account's sendable sending domains, matche
 
 **A suppressed address raises.** Wakio suppresses addresses that have hard-bounced or complained, and accepts a send to one rather than refusing it. The response names each recipient's status, and `deliver!` raises `Wakio::Suppressed` (a `Wakio::DeliveryError`) when every recipient was suppressed, so a one-recipient mailer to a suppressed address fails loudly instead of reporting success. Retrying cannot help, so handle it rather than letting a job backend retry it: `rescue_from Wakio::Suppressed` in your mailer also catches it under `deliver_later`. A send where only some recipients were suppressed returns normally; check the returned response's `deliveries` for which ones.
 
-**Refusals split by whether a retry can ever send the message.** Every error is a `Wakio::DeliveryError` carrying `status`, `code` (the response's `error`, such as `"invalid_request"`) and the parsed `body`.
+**Refusals split by whether a retry can ever send the message.** A refusal from Wakio is a `Wakio::DeliveryError` carrying `status`, `code` (the response's `error`, such as `"invalid_request"`) and the parsed `body`.
+
+- `Wakio::Rejected`: retrying this message cannot help. `400`, `413`, `422 invalid_request` (usually a mailer bug; `detail` names the field) and `422 idempotency_key_reused` (an earlier request with that key already went out). Report it and drop it.
+- `Wakio::Misconfigured`: the account or its configuration is wrong, and the same message sends once that is fixed. `401 invalid_api_key`, `402 not_entitled`, `403 account_suspended`, `404`, `422 no_verified_sending_domain`, `422 unknown_template`, a redirect, an `http` host, and any 4xx this gem does not know. Retry it.
+- A plain `Wakio::DeliveryError`: `409 request_in_flight`, every 5xx, and a success response the gem cannot read. Retry it; after an unreadable success only a keyed send is safe to repeat.
+
+Action Mailer's delivery job retries nothing itself, and Solid Queue and GoodJob do not retry a failed job by default, so give it a policy:
+
+```ruby
+class WakioDeliveryJob < ActionMailer::MailDeliveryJob
+  retry_on Wakio::DeliveryError, Net::OpenTimeout, Net::ReadTimeout, wait: :polynomially_longer, attempts: 25
+end
+
+# config/application.rb
+config.action_mailer.delivery_job = "WakioDeliveryJob"
+```
 
-- `Wakio::Rejected`: this message can never be sent. `400`, `413`, `422 invalid_request` and `422 idempotency_key_reused`. Report it and drop it.
-- `Wakio::Misconfigured`: the account or its configuration is wrong, and the same message sends once that is fixed. `401 invalid_api_key`, `402 not_entitled`, `403 account_suspended`, `404`, `422 no_verified_sending_domain`, `422 unknown_template`, and any 4xx this gem does not know. Let it raise so the job retries and your error tracker shows it.
-- A plain `Wakio::DeliveryError`: `409 request_in_flight` and every 5xx. Let it retry.
+The mailer's `rescue_from` below catches `Suppressed` and `Rejected` before the job sees them.
 
 ```ruby
 class ApplicationMailer < ActionMailer::Base

data/lib/wakio/delivery_method.rb

@@ -37,6 +37,8 @@ module Wakio
     # towards retrying rather than towards dropping mail.
     REJECTED_STATUSES = [ 400, 413 ].freeze
     REJECTED_CODES = %w[invalid_request idempotency_key_reused].freeze
+    LOCAL_HOSTS = %w[localhost 127.0.0.1 ::1].freeze
+    MESSAGE_BODY_LIMIT = 300
 
     def deliver!(mail)
       # Caller-supplied, never derived — and no key at all when the caller gives none.
@@ -135,11 +137,12 @@ module Wakio
       body = parsed(raw)
       code = body["error"] if body.is_a?(Hash)
       kind =
-        if !status.between?(400, 499) || status == 409 then DeliveryError
+        if status.between?(300, 399) then Misconfigured
+        elsif !status.between?(400, 499) || status == 409 then DeliveryError
         elsif REJECTED_STATUSES.include?(status) || REJECTED_CODES.include?(code) then Rejected
         else Misconfigured
         end
-      kind.new("Wakio returned #{status}: #{raw}", status: status, body: body)
+      kind.new("Wakio returned #{status}: #{raw.to_s[0, MESSAGE_BODY_LIMIT]}", status: status, body: body)
     end
 
     def parsed(body)
@@ -154,6 +157,9 @@ module Wakio
 
     def post(payload, idempotency_key:)
       uri = URI.join(settings.fetch(:host), "/v1/emails")
+      unless uri.scheme == "https" || LOCAL_HOSTS.include?(uri.hostname)
+        raise Misconfigured, "Wakio host must be https, or the API key travels in cleartext: #{settings.fetch(:host)}"
+      end
       request = Net::HTTP::Post.new(uri)
       request["Authorization"] = "Bearer #{settings.fetch(:api_key)}"
       request["Content-Type"] = "application/json"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wakio
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - WorkersLab LLC