emailfuse 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10f6474788d0e55fd6b5acf21634b0400093ae064a2edea2bad4e24bf5492f23
+  data.tar.gz: '0359d5d174aa60a50a152fa99d1846b314a61614ff54d016ed734536417f93d4'
+SHA512:
+  metadata.gz: 4143f719a80cb4639c4be3f0936cd7d4c518c3f25811c775fcb5f590ccf4beb97a109ae63f8432cea562c70b25fa78ce19ceaca2f429402123a9d194930f2850
+  data.tar.gz: 836eb683894f0575addb17ade8fca333f91bd747df92f3a6dc89fb871554b06677d8aabf7726d81dfa287392fef6405d6d4a0837fc48fb151e2e1572125e2c9d

data/README.md

@@ -0,0 +1,26 @@
+# Voupe Emails
+
+*email_fuse* is an Action Mailer adapter for using [Emails](https://github.com/voupe/emails) in Rails apps.
+
+It is a heavily modified version of the [mailgun_rails](https://github.com/jorgemanrubia/mailgun_rails) gem
+
+## Installing
+
+In your `Gemfile`
+
+```ruby
+gem "email_fuse"
+```
+
+## Usage
+
+To configure your VoupeEmails credentials place the following code in the corresponding environment file (`development.rb`, `production.rb`...)
+
+```ruby
+config.action_mailer.delivery_method = :email_fuse
+config.action_mailer.email_fuse_settings = {
+  api_token: "abc",
+  host:   "your.host.com",
+  ssl:    true
+}
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/emailfuse/client.rb

@@ -0,0 +1,69 @@
+module Emailfuse
+  class Client
+    class << self
+      def url
+        Emailfuse.config.host || "https://api.emailfuse.net"
+      end
+
+      def connection
+        @connection ||= Faraday.new("#{url}/v1") do |conn|
+          conn.request :authorization, :Bearer, Emailfuse.config.token
+
+          conn.headers = {
+            "User-Agent" => "emailfuse/v#{VERSION} (github.com/voupe/emailfuse-gem)"
+          }
+
+          conn.request :multipart
+          conn.request :json
+
+          conn.response :json
+        end
+      end
+
+      def get_request(url, params: {}, headers: {})
+        handle_response connection.get(url, params, headers)
+      end
+
+      def post_request(url, body: {}, headers: {})
+        handle_response connection.post(url, body, headers)
+      end
+
+      def patch_request(url, body:, headers: {})
+        handle_response connection.patch(url, body, headers)
+      end
+
+      def delete_request(url, headers: {})
+        handle_response connection.delete(url, headers)
+      end
+
+      def handle_response(response)
+        case response.status
+        when 400
+          raise Error, "Error 400: Your request was malformed."
+        when 401
+          raise Error, "Error 401: You did not supply valid authentication credentials."
+        when 403
+          raise Error, "Error 403: You are not allowed to perform that action."
+        when 404
+          raise Error, "Error 404: No results were found for your request."
+        when 409
+          raise Error, "Error 409: Your request was a conflict."
+        when 429
+          raise Error, "Error 429: Your request exceeded the API rate limit."
+        when 422
+          raise Error, "Error 422: Unprocessable Entity."
+        when 500
+          raise Error, "Error 500: We were unable to perform the request due to server-side problems."
+        when 503
+          raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second."
+        when 501
+          raise Error, "Error 501: This resource has not been implemented."
+        when 204
+          return true
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/emailfuse/collection.rb

@@ -0,0 +1,27 @@
+module Emailfuse
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, type:, key: nil)
+      body = response.body
+
+      if key.is_a?(String)
+        data  = body["data"][key].map { |attrs| type.new(attrs) }
+        total = body["data"]["total"]
+      else
+        data  = body["data"].map { |attrs| type.new(attrs) }
+        total = body["data"].count
+      end
+
+      new(
+        data: data,
+        total: total
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/emailfuse/configuration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Emailfuse
+  class Configuration
+    attr_accessor :host, :token
+
+    def initialize
+    end
+  end
+end

data/lib/emailfuse/deliverer.rb

@@ -0,0 +1,68 @@
+module Emailfuse
+  class Deliverer
+    class Attachment < StringIO
+      attr_reader :original_filename, :content_type, :path
+
+      def initialize (attachment, *rest)
+        @path = ""
+        @original_filename = attachment.filename
+        @content_type = attachment.content_type.split(";")[0]
+        super attachment.body.decoded
+      end
+    end
+
+    attr_accessor :settings
+
+    def initialize(settings)
+      self.settings = settings
+    end
+
+    def api_token
+      self.settings[:token] || Emailfuse.config.token
+    end
+
+    def deliver!(rails_message)
+      attributes = {
+        from: rails_message[:from],
+        to: rails_message[:to],
+        subject: rails_message.subject,
+        html: extract_html(rails_message),
+        text: extract_text(rails_message)
+      }
+
+      unless rails_message.attachments.empty?
+        attributes[:attachments] = []
+        rails_message.attachments.each do |attachment|
+          attributes[:attachments] << Attachment.new(attachment, encoding: "ascii-8bit")
+        end
+      end
+
+      Email.create(**attributes)
+    end
+
+    private
+
+    # @see http://stackoverflow.com/questions/4868205/rails-mail-getting-the-body-as-plain-text
+    def extract_html(rails_message)
+      if rails_message.html_part
+        rails_message.html_part.body.decoded
+      else
+        rails_message.content_type =~ /text\/html/ ? rails_message.body.decoded : nil
+      end
+    end
+
+    def extract_text(rails_message)
+      if rails_message.multipart?
+        rails_message.text_part ? rails_message.text_part.body.decoded : nil
+      else
+        rails_message.content_type =~ /text\/plain/ ? rails_message.body.decoded : nil
+      end
+    end
+
+    def email_fuse_client
+      @email_fuse_client ||= Client.new(api_token, host)
+    end
+  end
+end
+
+ActionMailer::Base.add_delivery_method :email_fuse, Emailfuse::Deliverer

data/lib/emailfuse/error.rb

@@ -0,0 +1,4 @@
+module Emailfuse
+  class Error < StandardError
+  end
+end

data/lib/emailfuse/models/email.rb

@@ -0,0 +1,21 @@
+module Emailfuse
+  class Email < Object
+    class << self
+      def create(to:, from:, subject:, html: nil, text: nil, **attributes)
+        raise ArgumentError, "You must provide either html or text" if html.nil? && text.nil?
+
+        attributes.merge!(
+          to: to,
+          from: from,
+          subject: subject,
+          html: html,
+          text: text
+        )
+
+        response = Client.post_request("emails", body: attributes)
+
+        Email.new(response.body) if response.success?
+      end
+    end
+  end
+end

data/lib/emailfuse/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Emailfuse
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [ key, to_ostruct(val) ] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/emailfuse/railtie.rb

@@ -0,0 +1,12 @@
+module Emailfuse
+  class Railtie < Rails::Railtie
+    initializer "emailfuse.add_delivery_method" do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method(
+          :emailfuse,
+          Deliverer
+        )
+      end
+    end
+  end
+end

data/lib/emailfuse/version.rb

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

data/lib/emailfuse.rb

@@ -0,0 +1,30 @@
+require "action_mailer"
+
+require "faraday"
+require "faraday/multipart"
+
+module Emailfuse
+  autoload :Configuration, "emailfuse/configuration"
+  autoload :Client, "emailfuse/client"
+  autoload :Collection, "emailfuse/collection"
+  autoload :Error, "emailfuse/error"
+  autoload :Object, "emailfuse/object"
+
+  autoload :Deliverer, "emailfuse/deliverer"
+
+  class << self
+    attr_writer :config
+  end
+
+  def self.configure
+    yield(config) if block_given?
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  autoload :Email, "emailfuse/models/email"
+end
+
+require "emailfuse/railtie" if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: emailfuse
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dean Perry
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- dean@voupe.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/emailfuse.rb
+- lib/emailfuse/client.rb
+- lib/emailfuse/collection.rb
+- lib/emailfuse/configuration.rb
+- lib/emailfuse/deliverer.rb
+- lib/emailfuse/error.rb
+- lib/emailfuse/models/email.rb
+- lib/emailfuse/object.rb
+- lib/emailfuse/railtie.rb
+- lib/emailfuse/version.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+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.5.9
+signing_key:
+specification_version: 4
+summary: Ruby library for the Emailfuse API including an Rails Action Mailer adapter
+test_files: []