openemail 0.0.1

data/lib/openemail/wire.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module OpenEmail
+  module Wire
+    RECIPIENT_FIELDS = %w[to cc bcc].freeze
+    BASE64_TEXT = %r{\A(?:[A-Za-z0-9+/_-]{4})*(?:[A-Za-z0-9+/_-]{2}==|[A-Za-z0-9+/_-]{3}=)?\z}
+    BASE64_WHITESPACE = " \t\n\f\r"
+    ISO_INSTANT = "%Y-%m-%dT%H:%M:%S.%LZ"
+
+    module_function
+
+    def body(value, fields)
+      base = value.nil? ? {} : hash_of(value)
+      base.merge(fields).transform_keys(&:to_s)
+    end
+
+    def hash_of(value)
+      return value if value.is_a?(Hash)
+      return value.to_hash if value.respond_to?(:to_hash)
+
+      raise ArgumentError, Defaults::MESSAGES[:BODY_SHAPE]
+    end
+
+    def email(body)
+      recipients(body).tap do |wire|
+        next unless wire.key?("attachments")
+
+        attachments = wire.delete("attachments")
+        wire["attachments"] = list(attachments).map { |attachment| attachment(attachment) } unless attachments.nil?
+      end
+    end
+
+    def recipients(body)
+      body.dup.tap do |wire|
+        RECIPIENT_FIELDS.each { |field| wire[field] = many(wire[field]) unless wire[field].nil? }
+        wire["scheduledAt"] = instant(wire["scheduledAt"]) if wire.key?("scheduledAt")
+      end
+    end
+
+    def many(value)
+      collection?(value) ? list(value) : [value]
+    end
+
+    def attachment(value)
+      entry = hash_of(value).transform_keys(&:to_s)
+      return {"fileId" => entry["fileId"]} if entry.key?("fileId")
+
+      wire = {"filename" => entry["filename"], "content" => content(entry["content"])}
+      wire["contentType"] = entry["contentType"] if entry.key?("contentType")
+      wire
+    end
+
+    def content(value)
+      return [RawBody.read(value)].pack("m0") unless value.is_a?(String) && value.encoding != Encoding::BINARY
+      return value if BASE64_TEXT.match?(value.delete(BASE64_WHITESPACE))
+
+      raise ArgumentError, Defaults::MESSAGES[:ATTACHMENT_CONTENT_SHAPE]
+    end
+
+    def instant(value)
+      return value.getutc.strftime(ISO_INSTANT) if value.respond_to?(:getutc)
+      return value.new_offset(0).strftime(ISO_INSTANT) if value.is_a?(DateTime)
+      return value.iso8601 if value.is_a?(Date)
+
+      value
+    end
+
+    def number(value)
+      return value if value.is_a?(Integer)
+      return value unless value.is_a?(Numeric) && value.finite?
+
+      (value == value.truncate) ? value.truncate : value.to_f
+    end
+
+    def scalar(value)
+      number(instant(value))
+    end
+
+    def collection?(value)
+      value.is_a?(Array) || value.is_a?(Set)
+    end
+
+    def list(value)
+      collection?(value) ? value.to_a : value
+    end
+
+    def json_ready(value)
+      case value
+      when Hash then value.to_h { |key, item| [key, json_ready(item)] }
+      when Array, Set then value.map { |item| json_ready(item) }
+      else scalar(value)
+      end
+    end
+  end
+end

data/lib/openemail.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "ipaddr"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "securerandom"
+require "time"
+require "uri"
+
+require_relative "openemail/version"
+require_relative "openemail/constants"
+require_relative "openemail/protocol"
+require_relative "openemail/api_paths"
+require_relative "openemail/defaults"
+require_relative "openemail/errors"
+require_relative "openemail/credentials"
+require_relative "openemail/endpoint"
+require_relative "openemail/decode"
+require_relative "openemail/request_path"
+require_relative "openemail/raw_body"
+require_relative "openemail/wire"
+require_relative "openemail/http"
+require_relative "openemail/update_notice"
+require_relative "openemail/transport"
+require_relative "openemail/results"
+require_relative "openemail/pagination"
+require_relative "openemail/webhook"
+require_relative "openemail/languages"
+require_relative "openemail/resource"
+
+Dir[File.join(__dir__, "openemail", "resources", "*.rb")].sort.each { |path| require path }
+
+require_relative "openemail/client"
+
+module OpenEmail
+  @default_client = nil
+  @default_lock = Mutex.new
+
+  class << self
+    def new(...)
+      Client.new(...)
+    end
+
+    def create_client(key = nil, api_key: nil, access_token: nil, base_url: nil, **options)
+      raise ArgumentError, Defaults::MESSAGES[:KEY_TWICE] unless key.nil? || api_key.nil?
+
+      api_key = key if api_key.nil?
+      explicit = !api_key.nil? || !access_token.nil?
+      api_key = from_environment(Protocol::ENV_VARS[:API_KEY]) unless explicit
+      access_token = from_environment(Protocol::ENV_VARS[:ACCESS_TOKEN]) unless explicit || !api_key.nil?
+      base_url = Endpoint.normalise(base_url || from_environment(Protocol::ENV_VARS[:BASE_URL]))
+
+      Client.new(api_key:, access_token:, base_url:, **options)
+    end
+
+    def init(...)
+      created = create_client(...)
+      @default_lock.synchronize { @default_client = created }
+    end
+
+    def client
+      @default_lock.synchronize { @default_client ||= create_client }
+    end
+
+    def reset_client
+      @default_lock.synchronize { @default_client = nil }
+    end
+
+    def create_temp_mail(base_url: nil, inbox_token: nil, adapter: nil, max_retries: nil, timeout: nil, user_agent: nil,
+      headers: nil, disable_update_notice: false)
+      base_url = Endpoint.normalise(base_url || from_environment(Protocol::ENV_VARS[:BASE_URL]))
+      transport = Transport.new(base_url:, inbox_token:, adapter:, max_retries:, timeout:, user_agent:, headers:,
+        disable_update_notice:)
+      Resources::TempMail.new(transport)
+    end
+
+    def verify_webhook_signature(payload:, headers:, secret:, tolerance_seconds: nil)
+      Webhook.verify(payload:, headers:, secret:, tolerance_seconds:)
+    end
+
+    def to_base64(bytes)
+      [RawBody.read(bytes)].pack("m0")
+    end
+
+    def api_key?(value)
+      Credentials.api_key?(value)
+    end
+
+    def access_token?(value)
+      Credentials.access_token?(value)
+    end
+
+    def sealed?(message)
+      encryption = message[:encryption] || message["encryption"]
+      return false unless encryption.is_a?(Hash)
+
+      Protocol::SEALED_ENCRYPTION_FORMATS.include?(encryption[:format] || encryption["format"])
+    end
+
+    def resolve_language(input)
+      Languages.resolve(input)
+    end
+
+    def language_by_code(code)
+      Languages.by_code(code)
+    end
+
+    def rtl_language?(code)
+      Languages.rtl?(code)
+    end
+
+    Client::NAMESPACES.each_key do |name|
+      define_method(name) { client.public_send(name) }
+    end
+
+    private
+
+    def from_environment(name)
+      value = ENV.fetch(name, nil)
+      (value.nil? || value.empty?) ? nil : value
+    end
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: openemail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- OpenEmail
+bindir: bin
+cert_chain: []
+date: 2026-10-04 00:00:00.000000000 Z
+dependencies: []
+description: Send email and broadcasts, work with threads, drafts, labels, templates,
+  rules, webhooks, tracking, contacts, audiences, sign-up forms, domains, suppressions,
+  files, API keys, roles, members, mailbox imports and disposable inboxes from Ruby.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/openemail.rb
+- lib/openemail/api_paths.rb
+- lib/openemail/client.rb
+- lib/openemail/constants.rb
+- lib/openemail/credentials.rb
+- lib/openemail/decode.rb
+- lib/openemail/defaults.rb
+- lib/openemail/endpoint.rb
+- lib/openemail/errors.rb
+- lib/openemail/http.rb
+- lib/openemail/languages.rb
+- lib/openemail/pagination.rb
+- lib/openemail/protocol.rb
+- lib/openemail/raw_body.rb
+- lib/openemail/request_path.rb
+- lib/openemail/resource.rb
+- lib/openemail/resources/account.rb
+- lib/openemail/resources/addresses.rb
+- lib/openemail/resources/analytics.rb
+- lib/openemail/resources/app_host.rb
+- lib/openemail/resources/audiences.rb
+- lib/openemail/resources/billing.rb
+- lib/openemail/resources/branding.rb
+- lib/openemail/resources/broadcasts.rb
+- lib/openemail/resources/calendar.rb
+- lib/openemail/resources/chats.rb
+- lib/openemail/resources/contacts.rb
+- lib/openemail/resources/dns_connections.rb
+- lib/openemail/resources/domains.rb
+- lib/openemail/resources/drafts.rb
+- lib/openemail/resources/emails.rb
+- lib/openemail/resources/encryption.rb
+- lib/openemail/resources/exports.rb
+- lib/openemail/resources/files.rb
+- lib/openemail/resources/forms.rb
+- lib/openemail/resources/imports.rb
+- lib/openemail/resources/keys.rb
+- lib/openemail/resources/labels.rb
+- lib/openemail/resources/languages.rb
+- lib/openemail/resources/me.rb
+- lib/openemail/resources/members.rb
+- lib/openemail/resources/provider_imports.rb
+- lib/openemail/resources/roles.rb
+- lib/openemail/resources/rules.rb
+- lib/openemail/resources/security.rb
+- lib/openemail/resources/senders.rb
+- lib/openemail/resources/settings.rb
+- lib/openemail/resources/subscriptions.rb
+- lib/openemail/resources/support.rb
+- lib/openemail/resources/suppressions.rb
+- lib/openemail/resources/temp_mail.rb
+- lib/openemail/resources/templates.rb
+- lib/openemail/resources/threads.rb
+- lib/openemail/resources/tools.rb
+- lib/openemail/resources/tracking.rb
+- lib/openemail/resources/webhooks.rb
+- lib/openemail/resources/workspaces.rb
+- lib/openemail/results.rb
+- lib/openemail/transport.rb
+- lib/openemail/update_notice.rb
+- lib/openemail/version.rb
+- lib/openemail/webhook.rb
+- lib/openemail/wire.rb
+homepage: https://openemail.uk
+licenses:
+- Nonstandard
+metadata:
+  homepage_uri: https://openemail.uk
+  documentation_uri: https://openemail.uk/docs/ruby
+  changelog_uri: https://openemail.uk/docs/ruby/changelog
+  bug_tracker_uri: https://openemail.uk/contact
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: The official Ruby SDK for the OpenEmail API.
+test_files: []