How dokeos/mailjet-gem works
Project Type and Purpose
• This is an open-source Ruby gem—a wrapper around Mailjet’s REST API—that provides:
• A generic HTTP client interface to Mailjet’s API endpoints, via resource classes under lib/mailjet/resources
• Rails & Rack integration for ActionMailer delivery and inbound event callbacks
• A code generator to bootstrap a Rails initializer
File Structure Analysis
Top-level files:
• mailjet.gemspec, Gemfile, Rakefile, README.md → Ruby gem boilerplate
• lib/mailjet.rb → gem entry point, loads submodules
• lib/mailjet/{configuration,connection,resource,exception,…}.rb → core modules
• lib/mailjet/resources/*.rb → one Ruby class per Mailjet API resource
• lib/mailjet/rack/endpoint.rb → Rack middleware for inbound callbacks
• lib/mailjet/mailer.rb & message_delivery.rb → ActionMailer adapters
• lib/generators/mailjet/… → Rails generator to create an initializer
• spec/… with VCR cassettes → automated HTTP-based tests
README Insights
• Describes authentication, configuration, versioning, supported API versions (v3, v3.1)
• Shows how users call Mailjet::Resource.create/.all/.find/.delete etc.
• Shows how to configure Rails ActionMailer delivery_method = :mailjet or :mailjet_api
• Demonstrates setting up Rack middleware to receive callback events
a. Main Components
• User Application Code (client scripts or Rails app)
• Mailjet Gem (modules below)
– Configuration module (holds API keys, default_from, endpoint)
– Connection module (builds HTTP requests, handles authentication, versioning)
– Resource layer (classes under mailjet/resources implement create, all, find, delete, custom actions)
– ActionMailer integration (mailer adapter + message_delivery bridge)
– Rack Endpoint middleware (Mailjet::Rack::Endpoint)
– Generator (Rails::Generators for initializer)
• External Dependencies
– Mailjet REST API (https://api.mailjet.com/v3/…)
– Rails ActionMailer (for mail delivery)
– Rack-compatible server/framework (Sinatra, Rails middleware stack)
– HTTP client library (e.g. net/http or Faraday)
• Test Harness
– VCR/cassettes and RSpec suite
b. Relationships & Data Flows
1. At runtime, client code calls Mailjet::<Resource> methods →
2. Configuration provides API keys and base URL →
3. Connection builds and sends HTTP(S) request to Mailjet API →
4. API responds with JSON/XML →
5. Connection parses response and hands back a Resource object or collection →
6. In Rails context, ActionMailer invokes Mailjet::Mailer or Mailjet::MessageDelivery to send email via the API instead of SMTP →
7. For inbound events, HTTP requests from Mailjet’s webhooks hit the Rack::Endpoint middleware →
8. Middleware yields params to user’s block in Rails application
c. Architectural Patterns & Principles
• Facade pattern: Mailjet module hides low-level HTTP details
• ActiveResource-like resource classes: one class per endpoint, uniform .create/.all/.find/.delete API
• Dependency injection via Configuration object
• Rack middleware pattern for callbacks
• Generator pattern for Rails integration
d. Key Technologies & Libraries
• Ruby 2.2+
• RSpec & VCR for testing
• Rails generators, ActionMailer for delivery integration
• Rack interface for inbound events
• HTTP client (standard library or Faraday/net-http)