paubox 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da4b3dae43dc155032452be9913d48e4da7ba65878067923af62bb5497783ebc
-  data.tar.gz: f7e0db657ed86db45207f3c0fcd280febd834262ebcac0313a5c48c0b7e2f186
+  metadata.gz: 5ba4ee3af31174ce6a77fb403a770afe36a35bbdb36b04358d613d8e7762bbf0
+  data.tar.gz: c89efb57681fa92d3957f27df88a95b54f121b1c13cd6f6b25fb69751482d9bf
 SHA512:
-  metadata.gz: b450e2ca12166a1689fc460ec810c11dc6ad53cc2d1e71d29a06f701db91f901d2ead1ca4eb7c61f91ebb444c5caadcbc49c8a5f81157a256514bf90f4b33ac0
-  data.tar.gz: db478b8679f6acb5a5851b80826f81a1dd0b8360250acd68254812e4cf75c5f4bef83f21c8ec939bd43ec339e0489a554c4bfe271cc246719afcbb93816668c3
+  metadata.gz: 64f70fb89c5a13f75fcdc376742389a8fb27dec34f1a25f8f480c357fb8680b70d35429d3622de55daa626aa62b61a19e17ed945adc7e3eced25c36e73d63234
+  data.tar.gz: 6aa4d4a5ef992be5cc041a7f09a9ceb7ecaa412f085028ce1d26ebfe8411c099e688d79906efff72ebae74d4cfd412b006b276673ec550fcd2d6b966dbef6917

data/.github/scripts/route-check.sh

@@ -0,0 +1,43 @@
+#!/bin/sh
+# Probes each base URL with a junk token: api.paubox.com answers unrouted paths
+# with its own HTML 404 page, so a wrong base fails here without credentials.
+#
+# Usage: route-check.sh <url> [url ...]
+#        <command printing one URL per line> | route-check.sh
+set -eu
+
+MARKER='The resource could not be found'
+TOKEN='route-check-not-a-real-key'
+
+urls=$(mktemp)
+fails=$(mktemp)
+trap 'rm -f "$urls" "$fails"' EXIT
+
+if [ "$#" -gt 0 ]; then
+  for u in "$@"; do echo "$u"; done > "$urls"
+else
+  cat > "$urls"
+fi
+
+sed 's#/*$##' "$urls" | grep '^https://' | sort -u > "$urls.clean" || true
+mv "$urls.clean" "$urls"
+
+if [ ! -s "$urls" ]; then
+  echo "route-check: no URLs given" >&2
+  exit 1
+fi
+
+while IFS= read -r url; do
+  if curl -sS -m 20 -H "Authorization: Token token=$TOKEN" "$url" \
+       | grep -qF "$MARKER"; then
+    echo "FAIL $url  <- not routed"
+    echo "$url" >> "$fails"
+  else
+    echo "ok   $url"
+  fi
+done < "$urls"
+
+if [ -s "$fails" ]; then
+  echo "See https://docs.paubox.com for the documented base URLs." >&2
+  exit 1
+fi

data/.github/workflows/ci.yml

@@ -38,3 +38,24 @@ jobs:
 
       - name: Assert the suite actually executed
         run: ruby .github/scripts/assert_specs_ran.rb rspec-results.json
+
+  route-check:
+    name: Base URLs are routed
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+
+      # Ask the client, so a base URL change cannot pass unprobed.
+      - name: Probe the base URLs the clients build
+        run: |
+          bundle exec ruby -Ilib -rjson -rpaubox -e '
+            Paubox.configure { |c| c.api_key = "route-check" }
+            puts Paubox::Client.new.send(:api_base_endpoint)
+            f = Paubox::FormsClient
+            puts "#{f::FORMS_PROTOCOL}#{f::FORMS_HOST}#{f::FORMS_BASE}"
+          ' | .github/scripts/route-check.sh

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.0.0"
+  ".": "1.2.0"
 }

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.2.0](https://github.com/Paubox/paubox-ruby/compare/v1.1.0...v1.2.0) (2026-09-16)
+
+
+### Features
+
+* add receiving (inbound email) endpoints ([#29](https://github.com/Paubox/paubox-ruby/issues/29)) ([aeda949](https://github.com/Paubox/paubox-ruby/commit/aeda9497215ce6d701af7eb37ec9ac895910e1b2))
+
+## [1.1.0](https://github.com/Paubox/paubox-ruby/compare/v1.0.0...v1.1.0) (2026-09-09)
+
+
+### Features
+
+* add scheduled send support ([#26](https://github.com/Paubox/paubox-ruby/issues/26)) ([9ddb07a](https://github.com/Paubox/paubox-ruby/commit/9ddb07a20f41874a10be6e0479cb943e833b336d))
+
+
+### Bug Fixes
+
+* target the documented /v1/email and /v1/forms base URLs ([#24](https://github.com/Paubox/paubox-ruby/issues/24)) ([3a32459](https://github.com/Paubox/paubox-ruby/commit/3a324596ef8e9237d5da15246b36a21baf3df688))
+
 ## [1.0.0](https://github.com/Paubox/paubox-ruby/compare/v0.3.2...v1.0.0) (2026-08-21)
 
 First stable release. RubyGems had been on `0.3.2` since October 2022.

data/CLAUDE.md

@@ -15,7 +15,7 @@ lib/
   paubox/
     version.rb               # Gem version constant
     client.rb                # Email API client (authenticated, api.paubox.com)
-    forms_client.rb          # Forms API client (api.paubox.com/forms; Bearer auth on management endpoints)
+    forms_client.rb          # Forms API client (api.paubox.com/v1/forms; Bearer auth on management endpoints)
     message.rb               # Builds send-message API payload from a hash
     templated_message.rb     # Extends Message for template-based sends
     mail_to_message.rb       # Adapts Ruby Mail::Message to API payload
@@ -38,8 +38,8 @@ spec/
 
 | Class | Responsibility |
 |---|---|
-| `Paubox::Client` | Authenticated HTTP client for the Email API. Token auth via `Authorization: Token token=<key>`. Base URL: `https://api.paubox.com/v1`. |
-| `Paubox::FormsClient` | HTTP client for the Forms API. Base URL: `https://api.paubox.com/forms`. Public endpoints (`get_form`, `submit_form`) send no auth headers; management endpoints (list/create/find/update/archive/copy forms, stats, submissions, CSV/PDF export) require a "forms"-scoped API key sent as `Authorization: Bearer <api_key>`. |
+| `Paubox::Client` | Authenticated HTTP client for the Email API. Token auth via `Authorization: Token token=<key>`. Base URL: `https://api.paubox.com/v1/email`. |
+| `Paubox::FormsClient` | HTTP client for the Forms API. Base URL: `https://api.paubox.com/v1/forms`. Public endpoints (`get_form`, `submit_form`) send no auth headers; management endpoints (list/create/find/update/archive/copy forms, stats, submissions, CSV/PDF export) require a "forms"-scoped API key sent as `Authorization: Bearer <api_key>`. |
 | `Paubox::Message` | Builds the JSON payload for `/messages`. Accepts `from`, `to`, `cc`, `bcc`, `subject`, `text_content`, `html_content`, `attachments`. |
 | `Paubox::TemplatedMessage` | Extends `Message`; overrides `send_message_payload` to include `template_name` / `template_values`. |
 | `Paubox::MailToMessage` | Converts a `Mail::Message` object into a Paubox API payload. |

data/api.md

@@ -28,7 +28,7 @@ Authorization: Token token=<api_key>
 ### Base URL
 
 ```
-https://api.paubox.com/v1
+https://api.paubox.com/v1/email
 ```
 
 All Email API paths below are relative to this base.
@@ -178,7 +178,7 @@ Returns service health. No authentication required in practice.
 ### Base URL
 
 ```
-https://api.paubox.com/forms
+https://api.paubox.com/v1/forms
 ```
 
 ---

data/lib/paubox/client.rb

@@ -3,6 +3,7 @@
 module Paubox
   # Client sends API requests to Paubox API
   class Client
+    require 'cgi'
     require 'rest-client'
     require 'ostruct'
     attr_reader :api_key, :api_host, :api_protocol, :api_version
@@ -54,6 +55,113 @@ module Paubox
     end
     alias message_receipt email_disposition
 
+    def schedule_mail(mail, scheduled_at)
+      case mail
+      when Mail::Message
+        allow_non_tls = mail.allow_non_tls.nil? ? false : mail.allow_non_tls
+        msg_payload = MailToMessage.new(mail, allow_non_tls: allow_non_tls).send_message_payload
+        msg_data = JSON.parse(msg_payload)['data']['message']
+      when Hash
+        msg_data = Message.new(mail).send_message_payload
+        msg_data = JSON.parse(msg_data)['data']['message']
+      when Paubox::Message
+        msg_data = JSON.parse(mail.send_message_payload)['data']['message']
+      end
+      payload = { data: { message: msg_data, scheduled_at: scheduled_at } }.to_json
+      url = request_endpoint('schedule')
+      response = RestClient.post(url, payload, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def get_scheduled(source_tracking_id)
+      url = request_endpoint("schedule/#{source_tracking_id}")
+      response = RestClient.get(url, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def reschedule(source_tracking_id, scheduled_at)
+      url = request_endpoint("schedule/#{source_tracking_id}")
+      payload = { scheduled_at: scheduled_at }.to_json
+      response = RestClient.patch(url, payload, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def cancel_scheduled(source_tracking_id)
+      url = request_endpoint("schedule/#{source_tracking_id}/cancel")
+      response = RestClient.post(url, nil, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def list_receiving_domains
+      url = request_endpoint('receiving/domains')
+      response = RestClient.get(url, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def create_receiving_domain(slug: nil)
+      url = request_endpoint('receiving/domains')
+      payload = { slug: slug }.compact.to_json
+      response = RestClient.post(url, payload, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def get_receiving_domain(id)
+      url = request_endpoint("receiving/domains/#{id}")
+      response = RestClient.get(url, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def delete_receiving_domain(id)
+      url = request_endpoint("receiving/domains/#{id}")
+      response = RestClient.delete(url, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def list_receiving_mailboxes(domain_id)
+      url = request_endpoint("receiving/domains/#{domain_id}/mailboxes")
+      response = RestClient.get(url, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def create_receiving_mailbox(domain_id, name:, password:, quota_bytes: nil)
+      url = request_endpoint("receiving/domains/#{domain_id}/mailboxes")
+      payload = { name: name, password: password, quota_bytes: quota_bytes }.compact.to_json
+      response = RestClient.post(url, payload, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def get_receiving_mailbox(domain_id, mailbox_id)
+      url = request_endpoint("receiving/domains/#{domain_id}/mailboxes/#{mailbox_id}")
+      response = RestClient.get(url, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def delete_receiving_mailbox(domain_id, mailbox_id)
+      url = request_endpoint("receiving/domains/#{domain_id}/mailboxes/#{mailbox_id}")
+      response = RestClient.delete(url, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def list_received_emails(limit: nil, after: nil, before: nil)
+      params = { limit: limit, after: after, before: before }.compact
+      query = params.map { |k, v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
+      url = request_endpoint('receiving')
+      url = "#{url}?#{query}" unless query.empty?
+      response = RestClient.get(url, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def get_received_email(email_id)
+      url = request_endpoint("receiving/#{email_id}")
+      response = RestClient.get(url, auth_header)
+      JSON.parse(response.body)
+    end
+
+    def get_received_email_attachment(email_id, blob_id)
+      url = request_endpoint("receiving/#{email_id}/attachments/#{blob_id}")
+      RestClient.get(url, auth_header)
+    end
+
     def send_request(method: :get, payload: {}, path: '')
       url = request_endpoint(path)
 
@@ -69,7 +177,7 @@ module Paubox
     end
 
     def api_base_endpoint
-      "#{api_protocol}#{api_host}/#{api_version}"
+      "#{api_protocol}#{api_host}/#{api_version}/email"
     end
 
     def request_endpoint(endpoint)

data/lib/paubox/forms_client.rb

@@ -7,7 +7,7 @@ module Paubox
   class FormsClient
     FORMS_HOST     = 'api.paubox.com'
     FORMS_PROTOCOL = 'https://'
-    FORMS_BASE     = '/forms'
+    FORMS_BASE     = '/v1/forms'
 
     TIMEOUT_SECONDS = 30
 

data/lib/paubox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Paubox
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paubox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Paubox
@@ -149,6 +149,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/scripts/assert_specs_ran.rb"
+- ".github/scripts/route-check.sh"
 - ".github/workflows/ci.yml"
 - ".github/workflows/pr-title.yml"
 - ".github/workflows/release-please.yml"