mailsmtp 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd030bbe1224ef8bce71ca5bc863df0e73285c884c35527202fe2b376cdfb26f
-  data.tar.gz: 9daf7326e361f0d214921171d4dcf4b27c2c18e209e59f8317216e09e0089185
+  metadata.gz: 5e3b608d7e843c5cc556588340f9cb6446398479fac9fb8b327256388ad5b254
+  data.tar.gz: e84314276f9336f5d0a8dcf91f4c260aa4ee0d4943a87f098a920078511c138d
 SHA512:
-  metadata.gz: 8d74cfca2a76a9994cba453cf444e3ba2095baca76c651918b42f4d2464ae02b61cc0dbedc2e729a07fa201387a86f186d3376e98ed924001273d8955fd5a348
-  data.tar.gz: 367b891a056bad4c67fdd3636dddbfe0ab027156d206d3c6e88d163137df1bb46fbb5b1e59afd0ad172ffec5d4f7afa0735122c382b1a66cb32ec52d853e692d
+  metadata.gz: 240d4561b11ef3d475d8514d8bb220147d3f29fbba4f72a01b0c692907f72b02686e5218561bf1cd41052f7181f3ec9d0791c7f4bbcc5a3d39006873f85b0ab6
+  data.tar.gz: 5e4565c687ee1f6d4835d6fbddcfd213d701656d97e69e66f48ed9b07007fc12bab82d92a127cf8e7367ed60be18d4d5ced1867e7b771265c03b6c78817e1434

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.1
+
+Documentation
+
 ## 0.2.0
 
 - Fail `MailSmtp::Error` subclasses that omit `status` at definition time, not on `#response`

data/README.md

@@ -1,6 +1,8 @@
 # mailsmtp
 
-📬 A boring SMTP server for Ruby
+📬 Boring SMTP server for Ruby.
+
+Answers one question: how do I receive emails in Ruby?
 
 **mailsmtp implements the SMTP protocol so you can plug in your own logic.** Receive email in your own app — no Postfix, no ESP required. As the conversation progresses, you decide what AUTH, MAIL FROM, RCPT TO, and DATA mean.
 
@@ -20,8 +22,6 @@ Plus:
 - multi-listen across any number of host×port pairs
 - injectable logger and live connection/processing counters
 
-
-
 ## Contents
 
 - [Installation](#installation)
@@ -33,12 +33,11 @@ Plus:
 - [Reference](#reference)
   - [Hooks](#hooks)
   - [Options](#options)
+- [Testing](#testing)
 - [History](#history)
 - [Contributing](#contributing)
 - [License](#license)
 
-
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -47,7 +46,7 @@ Add this line to your application's Gemfile:
 gem "mailsmtp"
 ```
 
-Requires Ruby >= 3.3.4. Runtime dependencies: `base64`, `logger`.
+Requires Ruby >= 3.3.4
 
 ## Getting Started
 
@@ -112,8 +111,6 @@ Multi-listen: `hosts:` / `ports:` expand to every host×port pair.
 
 ## Design
 
-
-
 ### Role — server only
 
 mailsmtp is an SMTP **server**. Outbound submission (`Net::SMTP`, your MTA, Action Mailer) stays outside the gem.
@@ -139,13 +136,10 @@ SIZE / line-length failures raise a `MailSmtp::Error` from `read` / `readpartial
 
 ## Reference
 
-
-
 ### Hooks
 
 Raising a `MailSmtp::Error` subclass sends that SMTP reply to the client. Other exceptions during `receive` become a 451 (`LocalError`). Unexpected errors outside DATA still need cleanup (prefer raising a defined error).
 
-
 | Hook                | Signature                                            | Return / raise                                                                 |
 | ------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------ |
 | `connected`         | `(session)`                                          | —                                                                              |
@@ -165,12 +159,8 @@ Raising a `MailSmtp::Error` subclass sends that SMTP reply to the client. Other
 | `unknown_command`   | `(session, line)`                                    | default raises `CommandNotRecognized`                                          |
 | `log`               | `(session, severity, msg, err:)`                     | —                                                                              |
 
-
-
-
 ### Options
 
-
 | Option                 | Default             | Notes                                                                                       |
 | ---------------------- | ------------------- | ------------------------------------------------------------------------------------------- |
 | `auth`                 | required arg        | `:disabled` or `:required`                                                                  |
@@ -192,12 +182,18 @@ Raising a `MailSmtp::Error` subclass sends that SMTP reply to the client. Other
 | `max_session_duration` | `1800`              | Absolute session ceiling (seconds); `nil` to disable                                        |
 | `logger`               | stdout logger       | Injectable `Logger`                                                                         |
 
-
 `starttls: :required` requires a non-nil `tls` object. Per-IP connection caps are deferred for peers in `proxy_hosts` until PROXY rewrites the client address. Forced `#stop` aborts lingering sockets with RST (`SO_LINGER 0`). Inspect live load with `connections_count` / `processings_count` (and `connections?`).
 
+## Testing
+
+```sh
+bundle install
+rake
+```
+
 ## History
 
-View the [changelog](CHANGELOG).
+View the [changelog](CHANGELOG.md).
 
 ## Contributing
 
@@ -208,8 +204,6 @@ Everyone is encouraged to help improve this project:
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
-
-
 ## License
 
-MIT. See [LICENSE](LICENSE).
+MIT. See [LICENSE](LICENSE).

data/lib/mailsmtp/version.rb

@@ -1,3 +1,3 @@
 module MailSmtp
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/mailsmtp.gemspec

@@ -6,10 +6,9 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.required_ruby_version = ">= 3.3.4"
   spec.authors = [ "Simon Lev" ]
-  spec.email = [ "support@postrider.dev" ]
 
-  spec.summary = "A Boring SMTP server for Ruby"
-  spec.description = "Receive email in your own app — no Postfix, no ESP required. Implements the SMTP protocol so you can plug in your own logic for auth, accepting mail, and storage."
+  spec.summary = "Boring SMTP server for Ruby."
+  spec.description = "Answers one question: how do I receive emails in Ruby? Implements the SMTP protocol so you can plug in your own logic for auth, accepting mail, and storage."
 
   spec.homepage = "https://github.com/mailpiece/mailsmtp"
   spec.license = "MIT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailsmtp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Simon Lev
@@ -37,11 +37,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Receive email in your own app — no Postfix, no ESP required. Implements
-  the SMTP protocol so you can plug in your own logic for auth, accepting mail, and
-  storage.
-email:
-- support@postrider.dev
+description: 'Answers one question: how do I receive emails in Ruby? Implements the
+  SMTP protocol so you can plug in your own logic for auth, accepting mail, and storage.'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -81,5 +78,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.3
 specification_version: 4
-summary: A Boring SMTP server for Ruby
+summary: Boring SMTP server for Ruby.
 test_files: []