smswire 0.0.1.pre → 0.1.0

data/lib/smswire/test_helper.rb

@@ -0,0 +1,81 @@
+require "active_job/test_helper"
+
+module Smswire
+  # Minitest assertions for messengers.
+  #
+  #   class OrderTest < ActiveSupport::TestCase
+  #     include Smswire::TestHelper
+  #
+  #     test "ships" do
+  #       assert_sms_delivered(to: "+15551234567", messenger: OrderMessenger, action: :shipped) do
+  #         Order.ship!(order)
+  #       end
+  #     end
+  #   end
+  #
+  # Deliveries are cleared before each test. With a block, enqueued
+  # Smswire::DeliveryJob jobs are performed so deliver_later is covered.
+  module TestHelper
+    include ActiveJob::TestHelper
+
+    def before_setup
+      Smswire::Testing.clear!
+      super
+    end
+
+    def sms_deliveries
+      Smswire::Testing.deliveries
+    end
+
+    def assert_sms_delivered(count = nil, **filters, &block)
+      delivered =
+        if block
+          before = Smswire::Testing.deliveries.size
+          perform_enqueued_jobs(only: Smswire::DeliveryJob, &block)
+          Smswire::Testing.deliveries.drop(before)
+        else
+          Smswire::Testing.deliveries
+        end
+      matching = Smswire::Testing.match_deliveries(delivered, **filters)
+      described = Smswire::Testing.describe_filters(filters)
+
+      if count
+        assert_equal count, matching.size,
+          "Expected #{count} SMS#{described}, got #{matching.size} (#{delivered.size} delivered in total)"
+      else
+        assert matching.any?, "Expected an SMS#{described}, but none was delivered (#{delivered.size} in total)"
+      end
+      matching
+    end
+
+    def assert_no_sms_delivered(**filters, &block)
+      assert_sms_delivered(0, **filters, &block)
+    end
+
+    def assert_enqueued_sms(messenger = nil, action = nil, count: nil, params: nil, args: nil, kwargs: nil, &block)
+      jobs =
+        if block
+          before = enqueued_jobs.size
+          block.call
+          enqueued_jobs.drop(before)
+        else
+          enqueued_jobs
+        end
+      entries = Smswire::Testing.enqueued(jobs)
+      matching = Smswire::Testing.match_enqueued(entries, messenger:, action:, params:, args:, kwargs:)
+      label = [messenger, action].compact.join("#")
+      label = label.empty? ? "an SMS" : label
+
+      if count
+        assert_equal count, matching.size, "Expected #{count} enqueued #{label}, got #{matching.size}"
+      else
+        assert matching.any?, "Expected #{label} to be enqueued, but it was not (#{entries.size} SMS enqueued)"
+      end
+      matching
+    end
+
+    def assert_no_enqueued_sms(messenger = nil, action = nil, **filters, &block)
+      assert_enqueued_sms(messenger, action, count: 0, **filters, &block)
+    end
+  end
+end

data/lib/smswire/testing.rb

@@ -0,0 +1,72 @@
+module Smswire
+  # Shared matching logic for Smswire::TestHelper and the RSpec matchers.
+  module Testing
+    DELIVERY_FILTERS = %i[to from body messenger action category provider].freeze
+
+    module_function
+
+    def deliveries
+      Providers::Test.deliveries
+    end
+
+    def clear!
+      Providers::Test.clear!
+    end
+
+    def match_deliveries(messages, **filters)
+      unknown = filters.keys - DELIVERY_FILTERS
+      raise ArgumentError, "Unknown filter(s): #{unknown.join(", ")}" if unknown.any?
+
+      messages.select do |message|
+        filters.all? do |key, expected|
+          actual = message.public_send(key)
+          case key
+          when :to then expected_phone?(actual, expected)
+          when :messenger then matches?(actual, expected.is_a?(Class) ? expected.name : expected)
+          else matches?(actual, expected)
+          end
+        end
+      end
+    end
+
+    # Enqueued Smswire::DeliveryJob entries from an ActiveJob test adapter,
+    # deserialized into hashes with :messenger, :action, :params, :args, :kwargs.
+    def enqueued(jobs)
+      jobs.filter_map do |job|
+        job_class = job[:job] || job["job_class"]
+        next unless job_class.to_s == DeliveryJob.name
+
+        messenger, action, params, args, kwargs = ActiveJob::Arguments.deserialize(job[:args] || job["arguments"])
+        {messenger:, action:, params:, args:, kwargs:, queue: job[:queue], at: job[:at]}
+      end
+    end
+
+    def match_enqueued(entries, messenger: nil, action: nil, params: nil, args: nil, kwargs: nil)
+      entries.select do |entry|
+        (messenger.nil? || entry[:messenger] == (messenger.is_a?(Class) ? messenger.name : messenger.to_s)) &&
+          (action.nil? || entry[:action] == action.to_s) &&
+          (params.nil? || entry[:params] == params) &&
+          (args.nil? || entry[:args] == args) &&
+          (kwargs.nil? || entry[:kwargs] == kwargs)
+      end
+    end
+
+    def describe_filters(filters)
+      filters.empty? ? "" : " matching #{filters.map { |k, v| "#{k}: #{v.inspect}" }.join(", ")}"
+    end
+
+    def matches?(actual, expected)
+      case expected
+      when Regexp then expected.match?(actual.to_s)
+      when Symbol then actual.to_s == expected.to_s
+      else actual == expected
+      end
+    end
+
+    def expected_phone?(actual, expected)
+      return expected.match?(actual.to_s) if expected.is_a?(Regexp)
+
+      actual == expected || actual == PhoneNumber.normalize(expected)
+    end
+  end
+end

data/lib/smswire/version.rb

@@ -1,3 +1,3 @@
 module Smswire
-  VERSION = "0.0.1.pre"
+  VERSION = "0.1.0"
 end

data/lib/smswire.rb

@@ -1,11 +1,75 @@
-require_relative "smswire/version"
+require "zeitwerk"
+require "active_support"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/string/filters"
+require "active_support/core_ext/hash/keys"
+require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/numeric/time"
+require "active_job"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect("http" => "HTTP", "rspec" => "RSpec")
+loader.ignore(
+  "#{__dir__}/generators",
+  "#{__dir__}/smswire/errors.rb",
+  "#{__dir__}/smswire/engine.rb",
+  "#{__dir__}/smswire/noticed_delivery_method.rb",
+  "#{__dir__}/smswire/rspec.rb"
+)
+loader.setup
+
+require_relative "smswire/errors"
 
 # Smswire is the production SMS layer for Rails: messenger classes and
-# templates, a provider-agnostic message object, persisted deliveries with
-# status callbacks, consent and keyword handling, retries, development
-# sandboxing, previews, and test helpers.
+# templates, a provider-agnostic message object, a delivery pipeline with
+# typed outcomes, provider adapters, retries, and test helpers.
 #
-# This pre-release reserves the gem name. See docs/SPEC.md for the design.
+# See docs/SPEC.md for the full design.
 module Smswire
-  class Error < StandardError; end
+  class << self
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    def reset_config!
+      @config = Configuration.new
+    end
+
+    def logger
+      config.logger || ActiveSupport::Logger.new($stdout)
+    end
+
+    # Check the credentials of +provider+ (default: the default provider)
+    # with one read-only API call, for boot checks and health endpoints.
+    def verify_credentials!(provider = nil)
+      Providers.resolve(provider).verify_credentials!
+    end
+
+    # Interceptors respond to +delivering_sms(message)+. They run after the
+    # recipient is normalized and before the provider is called, and may
+    # mutate the message or cancel it with +message.cancel!+.
+    def register_interceptor(interceptor)
+      config.interceptors << interceptor unless config.interceptors.include?(interceptor)
+    end
+
+    def unregister_interceptor(interceptor)
+      config.interceptors.delete(interceptor)
+    end
+
+    # Observers respond to +delivered_sms(result)+. They are called with
+    # every pipeline outcome except transient errors, which raise.
+    def register_observer(observer)
+      config.observers << observer unless config.observers.include?(observer)
+    end
+
+    def unregister_observer(observer)
+      config.observers.delete(observer)
+    end
+  end
 end
+
+require_relative "smswire/engine" if defined?(Rails::Railtie)

data/smswire.gemspec

@@ -22,17 +22,21 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://github.com/timimsms/smswire"
   spec.metadata["changelog_uri"] = "https://github.com/timimsms/smswire/blob/main/CHANGELOG.md"
   spec.metadata["bug_tracker_uri"] = "https://github.com/timimsms/smswire/issues"
-  spec.metadata["documentation_uri"] = "https://github.com/timimsms/smswire/blob/main/docs/SPEC.md"
+  spec.metadata["documentation_uri"] = "https://github.com/timimsms/smswire/tree/main/docs/guides"
   spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
-      f.start_with?("test/", "bin/", ".github/", ".gitignore")
+      f.start_with?("test/", "bin/", ".github/", ".gitignore", "Gemfile", "Rakefile")
     end
   end
   spec.require_paths = ["lib"]
 
-  # Runtime dependencies arrive with the first functional release (Phase 1
-  # of docs/SPEC.md): activesupport, activejob, activerecord, actionview,
-  # railties, all >= 7.1. This pre-release only reserves the name.
+  rails_requirement = [">= 7.1", "< 9"]
+  spec.add_dependency "actionpack", *rails_requirement
+  spec.add_dependency "activejob", *rails_requirement
+  spec.add_dependency "activerecord", *rails_requirement
+  spec.add_dependency "activesupport", *rails_requirement
+  spec.add_dependency "railties", *rails_requirement
+  spec.add_dependency "zeitwerk", "~> 2.6"
 end

metadata

@@ -1,15 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: smswire
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Tim Walsh
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-08 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: |-
   Smswire gives Rails applications Action Mailer-style messenger classes and
   templates for SMS, a provider-agnostic message object, persisted deliveries
@@ -23,12 +136,86 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
+- RELEASING.md
+- app/controllers/smswire/development_controller.rb
+- app/controllers/smswire/inbound_messages_controller.rb
+- app/controllers/smswire/inbox_controller.rb
+- app/controllers/smswire/previews_controller.rb
+- app/controllers/smswire/status_callbacks_controller.rb
+- app/controllers/smswire/webhooks_controller.rb
+- app/models/smswire/application_record.rb
+- app/models/smswire/consent.rb
+- app/models/smswire/delivery.rb
+- app/models/smswire/inbound_message.rb
+- app/views/layouts/smswire/application.html.erb
+- app/views/smswire/inbox/index.html.erb
+- app/views/smswire/previews/index.html.erb
+- app/views/smswire/previews/show.html.erb
+- config/routes.rb
+- db/migrate/20261008000000_create_smswire_deliveries.rb
+- db/migrate/20261008000001_create_smswire_consents_and_inbound_messages.rb
 - docs/SPEC.md
+- docs/guides/compliance.md
+- docs/guides/getting-started.md
+- docs/guides/migrating-from-noticed-twilio.md
+- docs/guides/migrating-from-twilio-ruby.md
+- docs/guides/writing-a-provider.md
+- lib/generators/smswire/install/install_generator.rb
+- lib/generators/smswire/install/templates/application_messenger.rb.tt
+- lib/generators/smswire/install/templates/initializer.rb.tt
+- lib/generators/smswire/messenger/messenger_generator.rb
+- lib/generators/smswire/messenger/templates/messenger.rb.tt
+- lib/generators/smswire/messenger/templates/preview.rb.tt
+- lib/generators/smswire/messenger/templates/test.rb.tt
+- lib/generators/smswire/messenger/templates/view.text.erb.tt
+- lib/generators/smswire/provider/provider_generator.rb
+- lib/generators/smswire/provider/templates/provider.rb.tt
+- lib/generators/smswire/provider/templates/test.rb.tt
 - lib/smswire.rb
+- lib/smswire/base.rb
+- lib/smswire/body_formatter.rb
+- lib/smswire/callbacks.rb
+- lib/smswire/configuration.rb
+- lib/smswire/delivery_job.rb
+- lib/smswire/engine.rb
+- lib/smswire/errors.rb
+- lib/smswire/http.rb
+- lib/smswire/inbound.rb
+- lib/smswire/inbound_handler.rb
+- lib/smswire/interceptors/allowlist.rb
+- lib/smswire/keyword_messenger.rb
+- lib/smswire/keywords.rb
+- lib/smswire/log_subscriber.rb
+- lib/smswire/message.rb
+- lib/smswire/message_delivery.rb
+- lib/smswire/noticed_delivery_method.rb
+- lib/smswire/parameterized_messenger.rb
+- lib/smswire/phone_number.rb
+- lib/smswire/pipeline.rb
+- lib/smswire/preview.rb
+- lib/smswire/provider_contract.rb
+- lib/smswire/providers.rb
+- lib/smswire/providers/base.rb
+- lib/smswire/providers/log.rb
+- lib/smswire/providers/null.rb
+- lib/smswire/providers/telnyx.rb
+- lib/smswire/providers/test.rb
+- lib/smswire/providers/twilio.rb
+- lib/smswire/providers/vonage.rb
+- lib/smswire/quiet_hours.rb
+- lib/smswire/rate_limit.rb
+- lib/smswire/receipt.rb
+- lib/smswire/recipient.rb
+- lib/smswire/result.rb
+- lib/smswire/rspec.rb
+- lib/smswire/segments.rb
+- lib/smswire/sender.rb
+- lib/smswire/status_handler.rb
+- lib/smswire/status_update.rb
+- lib/smswire/test_helper.rb
+- lib/smswire/testing.rb
 - lib/smswire/version.rb
 - smswire.gemspec
 homepage: https://smswire.dev
@@ -39,9 +226,8 @@ metadata:
   source_code_uri: https://github.com/timimsms/smswire
   changelog_uri: https://github.com/timimsms/smswire/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/timimsms/smswire/issues
-  documentation_uri: https://github.com/timimsms/smswire/blob/main/docs/SPEC.md
+  documentation_uri: https://github.com/timimsms/smswire/tree/main/docs/guides
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,8 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: The production SMS layer for Rails.
 test_files: []

data/Gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem "rake", "~> 13.0"
-gem "minitest", "~> 5.25"
-gem "standard", "~> 1.0"

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
-
-require "standard/rake"
-
-task default: %i[test standard]