mailchannels-worker-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60be9f2512a2fe1484643715ad912c55e4dfde4f1a4d94ddf2bceb0de09835f9
+  data.tar.gz: 4aed5bf195625ec14ddc47659086f736ff5f2d288eb6090f1c09ad65a84581bf
+SHA512:
+  metadata.gz: d3517c13348fc0be01c9c149ed8b13b2c15cb99642bb164310875efb2b8386bb886914afb9fc8a176070ccd95f1053870b95ec51c24ca8c6f451583e673414b4
+  data.tar.gz: 460f573d622d1a7ed8a1c60a4d73cf510b5400791c4bb51a31918835d39e4ebb22c22ff47e352b63db5e7add48c4a4a0100778445d0a82f79f731225fd4943ee

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Bruno Prieto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Mailchannels Worker Rails
+
+This is an Action Mailer adapter that allows you to send emails using the [Mailchannels Cloudflare Worker](https://github.com/ment-labs/mailchannels-worker).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add mailchannels-worker-rails
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install mailchannels-worker-rails
+
+## Usage
+
+1. Start by deploying the [Mailchannels Worker](https://github.com/ment-labs/mailchannels-worker) on [Cloudflare Workers](https://workers.cloudflare.com/). Detailed instructions for this setup can be found in the [repository](https://github.com/ment-labs/mailchannels-worker), which includes all the necessary configurations.
+
+2. Then, add the following lines to the corresponding environment file, such as "config/environment/production.rb":
+
+    ```ruby
+    config.action_mailer.delivery_method = :mailchannels_worker
+    config.action_mailer.mailchannels_worker_settings = {
+      url: "YOUR_WORKER_URL",     # The URL where the worker is deployed
+      api_key: "YOUR_API_KEY"     # The API Key generated and stored in the worker environment variables
+    }
+    ```
+
+    Ensure to replace "YOUR_WORKER_URL" with the actual path where the worker is deployed, and "YOUR_API_KEY" with the generated API Key stored in the worker environment variables.
+
+    Remember to store the API Key in a secure location, such as [Rails Credentials](https://guides.rubyonrails.org/security.html#custom-credentials) or secret environment variables.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ment-labs/mailchannels-worker-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ment-labs/mailchannels-worker-rails/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MailchannelsWorker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ment-labs/mailchannels-worker-rails/blob/main/CODE_OF_CONDUCT.md).

data/lib/mailchannels-worker-rails.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "mailchannels_worker"

data/lib/mailchannels_worker/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MailchannelsWorker
+  class Railtie < Rails::Railtie
+    initializer "mailchannels_worker.add_delivery_method", before: "action_mailer.set_configs" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method :mailchannels_worker, MailchannelsWorker::DeliveryMethod
+      end
+    end
+  end
+end

data/lib/mailchannels_worker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MailchannelsWorker
+  VERSION = "0.1.0"
+end

data/lib/mailchannels_worker.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext/object/blank"
+require "net/http"
+require "json"
+require_relative "mailchannels_worker/railtie" if defined?(Rails)
+require_relative "mailchannels_worker/version"
+
+module MailchannelsWorker
+  class DeliveryError < StandardError; end
+
+  class DeliveryMethod
+    RESERVED_HEADERS = %w[received dkim-signature Content-Type Content-Transfer-Encoding Message-ID To From Subject Reply-To CC BCC].freeze
+
+    attr_reader :url, :api_key
+
+    def initialize(settings = {})
+      @url = settings[:url]
+      @api_key = settings[:api_key]
+    end
+
+    def deliver!(mail)
+      body = {
+        from: { email: mail.from_address.address, name: mail.from_address.name }.compact,
+        subject: mail.subject,
+        personalizations: [{
+          headers: mail.header.fields.map { |field| [field.name, field.value] unless field.name.in?(RESERVED_HEADERS) }.compact.to_h.presence,
+          to: mail.to_addresses.map { |address| { email: address.address, name: address.name }.compact },
+          cc: mail.cc_addresses.map { |address| { email: address.address, name: address.name }.compact }.presence,
+          bcc: mail.bcc_addresses.map { |address| { email: address.address, name: address.name }.compact }.presence,
+          reply_to: (mail.header["Reply-To"]&.element&.addresses || []).map { |address| { email: address.address, name: address.name }.compact }.presence
+        }.compact],
+        content: mail.parts.map { |part| { type: part.content_type, value: part.decoded } }
+      }
+      send_email(body)
+    end
+
+    private
+
+    def send_email(email)
+      uri = URI.parse(url)
+      headers = {
+        "Authorization" => "Bearer #{api_key}",
+        "Content-Type" => "application/json"
+      }
+      response = Net::HTTP.post(uri, email.to_json, headers)
+      raise MailchannelsWorker::DeliveryError, response.body unless response.is_a?(Net::HTTPSuccess)
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: mailchannels-worker-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Prieto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: 
+email:
+- brunoprietog@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/mailchannels-worker-rails.rb
+- lib/mailchannels_worker.rb
+- lib/mailchannels_worker/railtie.rb
+- lib/mailchannels_worker/version.rb
+homepage: https://github.com/ment-labs/mailchannels-worker-rails
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key: 
+specification_version: 4
+summary: An Action Mailer adapter for Mailchannels Cloudflare Worker.
+test_files: []