sidemail-delivery 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7accd26109657135edc4585a488a46b3a758c7a95834720d4717bbb7bfce71f1
-  data.tar.gz: 98ce0168009e901c94512f7dde1c16379e32722c08d726f4ed271a67f0ff8816
+  metadata.gz: '08a4d71d05c883b4047bcfae8d9db5739f24cecac1b339f42943df14e959b8a6'
+  data.tar.gz: 4edb02eb7d59a33a3ad90ad240a2433d00e6d8db319e80bf41fbdddc5d6bd76c
 SHA512:
-  metadata.gz: 3879514eb421eeb9aca7c11bd3f3abb14cbc68f3f65ec75a4be670e37852e016abfbe538bde6ebdaabcdbdb7c6ef10c7686ac1a8ffa19391967d28c5da6b7e07
-  data.tar.gz: b89045584d9474301687ad800b4198b5de5959939760814c85d8a7b06785f11c5fe4e01b6624dfb8e695346694f50ca904c6f1ddd4a7e8a2f2b67f3342ff38cb
+  metadata.gz: 47b372fec3fb722db0fbc579756923f55213f9d053be3cf20cc806f4f08f36981af57f76c6fbac3980aecda7a6c25651c2f5ebe153ca6c869a10455b0f88ee65
+  data.tar.gz: c621158247f34da1babccbfb909cf62301fd9e5849e240862f81aaa079a3cd3b56209500627ee09b6a591156e799731fa59cf917c71e79602da58538b67bd2be

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+### Fixed
+### Changed
+### Removed
+
+## [0.2.0] - 2024-02-08
+### Added
+- Support for Sidemail templates and template properties.
+
+## [0.1.2] - 2024-02-07
+### Added
+- Extended the information displayed by `Sidemail::Delivery::Exception`.
+
+## [0.1.1] - 2024-02-01
+### Fixed
+- Homepage URL in gemspec.
+
+## [0.1.0] - 2024-02-01
+### Added
+- Deliver ActionMailer mails through Sidemail API. 

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright Frank Groeneveld
+Copyright Toolsfactory B.V.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -31,8 +31,18 @@ Rails.application.configure do
 end
 ```
 
-Finally you might need to contact Sidemail support to enable HTML sending through their API. 
+## Usage
+
+After the installation your existing mailers will automatically send their html/text views through Sidemail. You might
+need to contact Sidemail support to enable HTML sending through their API. 
 They disable it by default to prevent abuse.
 
+If you want to use templates you can modify your mailers to include the template name and properties in the mail call 
+and pass an empty body to avoid the need for having a mailer view. For example:
+
+```ruby
+mail(to: "somebody@example.com", template: "my-template-name", template_props: { name: "Somebody" }, body: "")
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/sidemail/delivery/exception.rb

@@ -0,0 +1,6 @@
+module Sidemail
+  module Delivery
+    class Exception < StandardError
+    end
+  end
+end

data/lib/sidemail/delivery/method.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Sidemail
+  module Delivery
+    class Method
+      URL = URI("https://api.sidemail.io/v1/email/send")
+
+      def initialize(_options)
+        # empty but unused, to avoid errors
+      end
+
+      def deliver!(mail)
+        response = post_to_api(mail[:to].addrs.map(&:address), payload(mail))
+        JSON.parse(response.body).tap do |json|
+          break unless json.key?("errorCode")
+
+          raise Sidemail::Delivery::Exception.new("#{json["errorCode"]}: #{json["developerMessage"]}")
+        end
+      rescue JSON::ParserError
+        raise Sidemail::Delivery::Exception.new("Unable to parse response")
+      end
+
+      protected
+
+      def payload(mail)
+        result = {
+          fromName: mail[:from].addrs.first.display_name,
+          fromAddress: mail[:from].addrs.first.address
+        }
+        result[:subject] = mail[:subject] if mail[:subject].present?
+        if mail[:template].present?
+          result[:templateName] = mail[:template]
+          result[:templateProps] = convert_template_props(mail[:template_props])
+        else
+          result[:html] = mail.html_part.decoded
+          result[:text] = mail.text_part.decoded
+        end
+        if mail.attachments.size.positive?
+          result[:attachments] = mail.attachments.map do |attachment|
+            {name: attachment.filename, content: Base64.strict_encode64(attachment.body.decoded)}
+          end
+        end
+        result
+      end
+
+      # converts all values that are not a string to a string for the Sidemail API
+      def convert_template_props(template_props)
+        template_props.unparsed_value.transform_values do |value|
+          case value
+          when String
+            value
+          when Float, Integer
+            value.to_s
+          else
+            value.to_json
+          end
+        end
+      end
+
+      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

data/lib/sidemail/delivery/settings.rb

@@ -0,0 +1,7 @@
+module Sidemail
+  module Delivery
+    class Settings
+      attr_accessor :api_key
+    end
+  end
+end

data/lib/sidemail/delivery/version.rb

@@ -1,5 +1,5 @@
 module Sidemail
   module Delivery
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/sidemail/delivery.rb

@@ -1,5 +1,8 @@
-require "sidemail/delivery/version"
+require "sidemail/delivery/exception"
+require "sidemail/delivery/method"
 require "sidemail/delivery/railtie"
+require "sidemail/delivery/settings"
+require "sidemail/delivery/version"
 
 module Sidemail
   module Delivery
@@ -11,57 +14,5 @@ module Sidemail
       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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidemail-delivery
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Frank Groeneveld
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,7 +37,10 @@ files:
 - README.md
 - Rakefile
 - lib/sidemail/delivery.rb
+- lib/sidemail/delivery/exception.rb
+- lib/sidemail/delivery/method.rb
 - lib/sidemail/delivery/railtie.rb
+- lib/sidemail/delivery/settings.rb
 - lib/sidemail/delivery/version.rb
 homepage: https://github.com/toolsfactory-nl/sidemail-delivery
 licenses: