sidemail-delivery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a15089d3b51c6eb6062e698b08b1edb7e5e8afa39a951ee33cdbc11807be57ff
+  data.tar.gz: 01bd934d193bdcfd75f0bc89f69d02092b5891db1cb58cf54b389a3807609604
+SHA512:
+  metadata.gz: e693160bc90839f2e74a420abc04cc819e3c4bd8ebdc910ac510e0688ab4e8a1137f0def9bcbc43b5bf18fce6c84781035c2794965081863ac3438f098242d4b
+  data.tar.gz: be243f15c94637c8ae78e65fd97324785bcb99f8d936d9d36a38f1f2d5940eff5044d3ba7fdac443b98885675b2e9491762880b7c7aeadfbf8d0866f04bb4ddb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Frank Groeneveld
+
+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,38 @@
+# Sidemail::Delivery
+A Rails delivery method that uses the [Sidemail](https://sidemail.io) transactional API for sending outgoing mail.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sidemail-delivery"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Create an initializer in `config/initializers/sidemail_delivery.rb` to configure your Sidemail API key:
+
+```ruby
+Sidemail::Delivery.configure do |config|
+  config.api_key = "YOUR_API_KEY"
+end
+```
+
+Now set your delivery method for your preferred environment, for example in `config/environments/production.rb`:
+
+```ruby
+Rails.application.configure do
+  # ...
+  config.action_mailer.delivery_method = :sidemail
+  # ...
+end
+```
+
+Finally you might need to contact Sidemail support to enable HTML sending through their API. 
+They disable it by default to prevent abuse.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/sidemail/delivery/railtie.rb

@@ -0,0 +1,9 @@
+module Sidemail
+  module Delivery
+    class Railtie < ::Rails::Railtie
+      initializer "sidemail_delivery.configure_rails_initialization" do
+        ActionMailer::Base.add_delivery_method :sidemail, Sidemail::Delivery::Method
+      end
+    end
+  end
+end

data/lib/sidemail/delivery/version.rb

@@ -0,0 +1,5 @@
+module Sidemail
+  module Delivery
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidemail/delivery.rb

@@ -0,0 +1,67 @@
+require "sidemail/delivery/version"
+require "sidemail/delivery/railtie"
+
+module Sidemail
+  module Delivery
+    class << self
+      attr_accessor :settings
+    end
+
+    def self.configure
+      self.settings ||= Settings.new
+      yield(settings)
+    end
+
+    class Settings
+      attr_accessor :api_key
+    end
+
+    class Exception < StandardError
+    end
+
+    class Method
+      URL = URI("https://api.sidemail.io/v1/email/send")
+
+      def initialize(_options)
+        # empty but unused, to avoid errors
+      end
+
+      def deliver!(mail)
+        payload = {
+          fromName: mail[:from].addrs.first.display_name,
+          fromAddress: mail[:from].addrs.first.address,
+          html: mail.html_part.decoded,
+          text: mail.text_part.decoded,
+          subject: mail[:subject]
+        }
+        if mail.attachments.size.positive?
+          payload[:attachments] = mail.attachments.map do |attachment|
+            {name: attachment.filename, content: Base64.strict_encode64(attachment.body.decoded)}
+          end
+        end
+
+        response = post_to_api(mail[:to].addrs.map(&:address), payload)
+
+        JSON.parse(response.body).tap do |json|
+          raise Sidemail::Delivery::Exception.new(json["errorCode"]) if json.key?("errorCode")
+        end
+      rescue JSON::ParserError
+        raise Sidemail::Delivery::Exception.new("Unable to parse response")
+      end
+
+      protected
+
+      def post_to_api(addresses, payload)
+        https = Net::HTTP.new(URL.host, URL.port)
+        https.use_ssl = true
+
+        request = Net::HTTP::Post.new(URL)
+        request["Content-Type"] = "application/json"
+        request["Authorization"] = "Bearer #{Sidemail::Delivery.settings.api_key}"
+        request.body = JSON.generate(addresses.map { |to| {toAddress: to}.merge(payload) })
+
+        https.request(request)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: sidemail-delivery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frank Groeneveld
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: A Rails delivery method that uses the Sidemail transactional API for
+  sending outgoing mail.
+email:
+- frank@toolsfactory.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sidemail/delivery.rb
+- lib/sidemail/delivery/railtie.rb
+- lib/sidemail/delivery/version.rb
+homepage: https://github.com/toolsfactory-nl/sidemail_delivery
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/toolsfactory-nl/sidemail_delivery
+  source_code_uri: https://github.com/toolsfactory-nl/sidemail_delivery
+  changelog_uri: https://github.com/toolsfactory-nl/sidemail_delivery/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Rails delivery method for Sidemail.
+test_files: []