ms-graph-mailer 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b3570e71f901eb9a4113918ff258b9027f1cf1c06fe8cd01f479761aec65ab4
-  data.tar.gz: 26faf075b68963e20d478fd5813eb384a848a6beeb1467ed2eae16da1c166199
+  metadata.gz: 469b5d7a57ff7c226a55b9e73cd2995ee229f9f22824e9155585d905c66b5887
+  data.tar.gz: 4a358f5c1ea87954bfa99169a41faa6f226d2fc80a054dede48ced754b32a6ac
 SHA512:
-  metadata.gz: ba486608590ae404c6bc89056b1792664e23023de730776241f0c4ee53d858cbc72aaba869bf76722c66c78eadd7ebc2d68fda4712d0a44c9ee00377dbf72265
-  data.tar.gz: '097c8be2986508a0c0cf8182358135d9ca0490c6a81380ac3a9c66d668c4dee4f9e498c1e230f429fc389dac022cb9dcb955c12e5d8d2e0e500d2e4f84e59aee'
+  metadata.gz: fa851676f45ced636be7c356cf7f33dc36ecc2685d9fb6662692756b0fdcae2fbb908f30b5b9908c08a88192c2f1858e78b1bf23d982e6034b9e25b3373245c7
+  data.tar.gz: 2c9a35d08b4579a65bd9c1596d0074cf21368f596c0a5a18362d4136e40981a1e521ad89a88b6bf25f5a6e8059ae9e67149c9b72cccdffdabcd1be6e78afa9ed

data/CHANGELOG.md

@@ -5,13 +5,47 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2026-11-06
+
+### Added
+
+- `MsGraphMailer::DeliveryError` exposes `status`, `code`, `retry_after`, `request_id` and
+  `client_request_id`, plus `throttled?` (429/503 — rejected, safe to retry) and
+  `outcome_unknown?` (other 5xx and network errors — the mail may have been sent).
+- Every sendMail request carries a generated `client-request-id`; request ids and
+  `Retry-After` are logged on success and failure.
+- `open_timeout` / `timeout` configuration options for the sendMail request.
+
+### Changed
+
+- Error classes moved to `lib/ms/graph/mailer/errors.rb`. Error messages are unchanged.
+
+## [1.0.0] - 2025-12-15
+
+### Added
+
+- Automated CI/CD workflow with GitHub Actions
+- Continuous Integration testing across Ruby 2.7, 3.0, 3.1, 3.2
+- Automated releases using Trusted Publishing (no API keys needed)
+- Version bump script (`scripts/bump_version.rb`)
+- Comprehensive deployment documentation
+- Rake tasks for version bumping (`rake version:major/minor/patch`)
+
+### Changed
+
+- **BREAKING**: Renamed gem from `microsoft-graph-mailer` to `ms-graph-mailer`
+- **BREAKING**: Changed module namespace from `MicrosoftGraphMailer` to `MsGraphMailer`
+- **BREAKING**: Changed require path from `microsoft/graph/mailer` to `ms/graph/mailer`
+- Improved RuboCop configuration
+- Enhanced CHANGELOG format with proper version links
+
 ## [0.1.0] - 2025-12-15
 
 ### Added
 
 - Initial release of ms-graph-mailer gem
 - ActionMailer delivery method for Microsoft Graph API
-- OAuth 2.0 client credentials flow authentication
+- OAuth 2.0 client credentials flow authentication with token caching
 - Support for HTML and plain text emails
 - Support for attachments (file attachments)
 - Support for CC, BCC, and Reply-To recipients
@@ -19,12 +53,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Configurable SSL verification
 - Logging support
 - Complete documentation and examples
-
-### Features
-
 - `MsGraphMailer::DeliveryMethod` - Main delivery method class
-- `MsGraphMailer::TokenService` - OAuth token management
+- `MsGraphMailer::TokenService` - OAuth token management with Rails.cache
 - Configuration system for tenant, client credentials
 - Integration with Rails logger
 
+[1.1.0]: https://github.com/zauberware/ms-graph-mailer/releases/tag/v1.1.0
+[1.0.0]: https://github.com/zauberware/ms-graph-mailer/releases/tag/v1.0.0
 [0.1.0]: https://github.com/zauberware/ms-graph-mailer/releases/tag/v0.1.0

data/README.md

@@ -48,6 +48,9 @@ MsGraphMailer.configure do |config|
   config.client_id = ENV['AZURE_MAIL_APP_CLIENT_ID']
   config.client_secret = ENV['AZURE_MAIL_APP_CLIENT_SECRET']
   config.logger = Rails.logger
+  # Optional: request timeouts in seconds (default: HTTP adapter defaults)
+  config.open_timeout = 10
+  config.timeout = 120
 end
 ```
 
@@ -106,6 +109,21 @@ The gem raises specific exceptions for different error scenarios:
 - `MsGraphMailer::AuthenticationError` - OAuth authentication failures
 - `MsGraphMailer::DeliveryError` - Email delivery failures
 
+`DeliveryError` carries the Graph response details so callers can decide whether to retry:
+
+```ruby
+rescue MsGraphMailer::DeliveryError => e
+  e.status            # => 503
+  e.code              # => "CommandConcurrencyLimitReached"
+  e.retry_after       # => 7 (seconds, from the Retry-After header; nil if absent)
+  e.request_id        # => Graph request-id, for Microsoft support
+  e.client_request_id # => id the gem sent with the request (also set on timeouts)
+
+  e.throttled?        # 429/503: Graph rejected the request, nothing was sent - safe to retry
+  e.outcome_unknown?  # other 5xx or network error/timeout - the mail may have been sent
+end
+```
+
 ## Development
 
 After checking out the repo, run:

data/lib/ms/graph/mailer/delivery_method.rb

@@ -28,31 +28,56 @@ module MsGraphMailer
         saveToSentItems: true
       }
 
+      # Sent with the request and echoed back by Graph, so a failure can be
+      # traced with Microsoft even when no response arrives (timeouts).
+      client_request_id = SecureRandom.uuid
+
       response = connection(token_result.value!).post("users/#{CGI.escape(sender_email)}/sendMail") do |req|
         req.headers['Content-Type'] = 'application/json'
+        req.headers['client-request-id'] = client_request_id
+        req.headers['return-client-request-id'] = 'true'
         req.body = message_payload.to_json
       end
 
-      unless response.status == 202
-        error_body = begin
-          JSON.parse(response.body)
-        rescue StandardError
-          {}
-        end
-        error_msg = error_body.dig('error', 'message') || 'Unknown error'
-        logger.error("[MsGraphMailer] sendMail failed: [status: #{response.status}] - [body: #{response.body}]")
-        raise DeliveryError, "Microsoft Graph sendEmail failed with status #{response.status}: #{error_msg}"
-      end
+      raise build_delivery_error(response, client_request_id) unless response.status == 202
 
-      logger.info('[MsGraphMailer] Email sent successfully via Microsoft Graph')
+      logger.info('[MsGraphMailer] Email sent successfully via Microsoft Graph ' \
+                  "[request-id: #{response.headers['request-id']}] [client-request-id: #{client_request_id}]")
       response
     rescue Faraday::Error => e
-      logger.error("[MsGraphMailer] Network error: #{e.message}")
-      raise DeliveryError, "Network error sending email: #{e.message}"
+      logger.error("[MsGraphMailer] Network error: #{e.message} [client-request-id: #{client_request_id}]")
+      raise DeliveryError.new("Network error sending email: #{e.message}",
+                              client_request_id: client_request_id, network_error: true)
     end
 
     private
 
+    def build_delivery_error(response, client_request_id)
+      error = parse_error_body(response.body)
+      request_id = response.headers['request-id']
+      retry_after = DeliveryError.parse_retry_after(response.headers['Retry-After'])
+
+      logger.error("[MsGraphMailer] sendMail failed: [status: #{response.status}] [code: #{error['code']}] " \
+                   "[request-id: #{request_id}] [client-request-id: #{client_request_id}] " \
+                   "[retry-after: #{retry_after.inspect}] - [body: #{response.body}]")
+
+      DeliveryError.new(
+        "Microsoft Graph sendEmail failed with status #{response.status}: #{error['message'] || 'Unknown error'}",
+        status: response.status,
+        code: error['code'],
+        retry_after: retry_after,
+        request_id: request_id,
+        client_request_id: client_request_id
+      )
+    end
+
+    def parse_error_body(body)
+      parsed = JSON.parse(body.to_s)
+      parsed.is_a?(Hash) && parsed['error'].is_a?(Hash) ? parsed['error'] : {}
+    rescue JSON::ParserError
+      {}
+    end
+
     def validate_configuration!
       config = MsGraphMailer.configuration
       return if config&.valid?
@@ -133,6 +158,8 @@ module MsGraphMailer
     def connection(access_token)
       @connection ||= Faraday.new(url: 'https://graph.microsoft.com/v1.0/') do |f|
         f.headers['Authorization'] = "Bearer #{access_token}"
+        f.options.open_timeout = MsGraphMailer.configuration&.open_timeout
+        f.options.timeout = MsGraphMailer.configuration&.timeout
         f.adapter Faraday.default_adapter
         # SSL verification configuration
         f.ssl.verify = ssl_verify?

data/lib/ms/graph/mailer/errors.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module MsGraphMailer
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class ConfigurationError < Error; end
+
+  # Raised when Microsoft Graph does not accept a sendMail request.
+  #
+  # Besides the message (kept stable for callers that persist or match it),
+  # the error exposes the response details a caller needs to decide whether a
+  # retry is safe:
+  #
+  # - throttled?        Graph rejected the request (429, or 503 such as
+  #                     "CommandConcurrencyLimitReached"). Nothing was sent;
+  #                     retry after #retry_after seconds.
+  # - outcome_unknown?  Gateway errors and network failures/timeouts. The
+  #                     mail may or may not have been sent — retrying blindly
+  #                     risks a duplicate.
+  class DeliveryError < Error
+    THROTTLED_STATUSES = [429, 503].freeze
+
+    attr_reader :status, :code, :retry_after, :request_id, :client_request_id
+
+    def initialize(message = nil, status: nil, code: nil, retry_after: nil, request_id: nil, # rubocop:disable Metrics/ParameterLists
+                   client_request_id: nil, network_error: false)
+      super(message)
+      @status = status
+      @code = code
+      @retry_after = retry_after
+      @request_id = request_id
+      @client_request_id = client_request_id
+      @network_error = network_error
+    end
+
+    def throttled?
+      THROTTLED_STATUSES.include?(status)
+    end
+
+    def outcome_unknown?
+      return true if @network_error
+      return false if status.nil? || throttled?
+
+      status >= 500
+    end
+
+    # Retry-After is either delta-seconds or an HTTP date (RFC 9110 §10.2.3).
+    # Returns whole seconds, or nil when the header is absent or unparsable.
+    def self.parse_retry_after(value, now: Time.now)
+      return nil if value.nil? || value.to_s.strip.empty?
+
+      raw = value.to_s.strip
+      return raw.to_i if raw.match?(/\A\d+\z/)
+
+      [(Time.httpdate(raw) - now).ceil, 0].max
+    rescue ArgumentError
+      nil
+    end
+  end
+end

data/lib/ms/graph/mailer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MsGraphMailer
-  VERSION = '0.1.0'
+  VERSION = '1.1.0'
 end

data/lib/ms/graph/mailer.rb

@@ -6,17 +6,14 @@ require 'dry/monads'
 require 'json'
 require 'base64'
 require 'cgi'
+require 'securerandom'
 
 require_relative 'mailer/version'
+require_relative 'mailer/errors'
 require_relative 'mailer/token_service'
 require_relative 'mailer/delivery_method'
 
 module MsGraphMailer
-  class Error < StandardError; end
-  class AuthenticationError < Error; end
-  class DeliveryError < Error; end
-  class ConfigurationError < Error; end
-
   class << self
     attr_accessor :configuration
 
@@ -27,13 +24,17 @@ module MsGraphMailer
   end
 
   class Configuration
-    attr_accessor :tenant_id, :client_id, :client_secret, :logger
+    # open_timeout / timeout (seconds) apply to the sendMail request. nil keeps
+    # the HTTP adapter's defaults.
+    attr_accessor :tenant_id, :client_id, :client_secret, :logger, :open_timeout, :timeout
 
     def initialize
       @tenant_id = nil
       @client_id = nil
       @client_secret = nil
       @logger = nil
+      @open_timeout = nil
+      @timeout = nil
     end
 
     def valid?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ms-graph-mailer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Zauberware Technologies GmbH
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-15 00:00:00.000000000 Z
+date: 2026-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: securerandom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +191,7 @@ files:
 - README.md
 - lib/ms/graph/mailer.rb
 - lib/ms/graph/mailer/delivery_method.rb
+- lib/ms/graph/mailer/errors.rb
 - lib/ms/graph/mailer/token_service.rb
 - lib/ms/graph/mailer/version.rb
 homepage: https://github.com/zauberware/ms-graph-mailer
@@ -194,14 +209,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: ActionMailer delivery method for Microsoft Graph API