enveloop 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a3906e5d57e00185b12ee7f3280bbbcf527520f99e0781d01d5d892b0b7237e
-  data.tar.gz: cd0b0620c7223c1039b2048c02956caf66804c36274b5da3fd034b981d5bcabd
+  metadata.gz: 97d604a2c0de5c5291ddd80b3da8af6498a27ec51a5f3309c757935642dcc9c5
+  data.tar.gz: a2a7da964a3b81d8b333d05bb83a282433a65b99b32c0537ae1591517ba90c07
 SHA512:
-  metadata.gz: 02a7e12cb859a178afb988f01fe82f3f1b5301d9810c7bc42220b62e7ef32614a80e7cf60ffea5302cd3c42c52f36c7309a95c563ffcbe43ab2e7f34d2cd09c3
-  data.tar.gz: b6bfab95266eebaaf830839903411d4082ff19f18fdd28b83dcc66359d309311c11e589f8ecd63ff88a965a419ca7b09cc833211bc13eb943cd54c031cedc1f7
+  metadata.gz: 9b1ee3493f3f48bfe4f633c8f0620776653d9d8fc08dd16df4a59068fd941bd678d240142a4ea1a773f14e7eb1a9f30a6b8a35bd9dfacbd4b159045bdc44bce4
+  data.tar.gz: cf7c9b076d2e80c9972ae155e4ef395910ca1cf2142356b379e31f9a84ceb279c32666913d3f813571f2bca40cab2a660f80a31e7d8c82d98aa0f382f37c5e60

data/CHANGELOG.md

@@ -30,3 +30,8 @@
 > ## Version 0.1.6
 
 * Raise ruby errors when an error is encountered in the API
+
+> ## Version 0.2.0
+
+* Add support for Rails via ActiveMailer
+* Add `send_raw` method to send HTML email without a template

data/Gemfile.lock

@@ -1,18 +1,180 @@
 PATH
   remote: .
   specs:
-    enveloop (0.1.5)
+    enveloop (0.2.0)
       faraday
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.1)
+      actionpack (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activesupport (= 7.1.1)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.1)
+      actionview (= 7.1.1)
+      activesupport (= 7.1.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.1)
+      actionpack (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.1)
+      activesupport (= 7.1.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.1)
+      activesupport (= 7.1.1)
+      globalid (>= 0.3.6)
+    activemodel (7.1.1)
+      activesupport (= 7.1.1)
+    activerecord (7.1.1)
+      activemodel (= 7.1.1)
+      activesupport (= 7.1.1)
+      timeout (>= 0.4.0)
+    activestorage (7.1.1)
+      actionpack (= 7.1.1)
+      activejob (= 7.1.1)
+      activerecord (= 7.1.1)
+      activesupport (= 7.1.1)
+      marcel (~> 1.0)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
     diff-lcs (1.4.4)
-    faraday (1.1.0)
-      multipart-post (>= 1.2, < 3)
+    drb (2.2.0)
       ruby2_keywords
-    multipart-post (2.1.1)
+    erubi (1.12.0)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.8.3)
+      rdoc
+      reline (>= 0.3.8)
+    loofah (2.21.4)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
+    net-imap (0.4.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.4)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    psych (5.1.1.1)
+      stringio
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.1)
+      actioncable (= 7.1.1)
+      actionmailbox (= 7.1.1)
+      actionmailer (= 7.1.1)
+      actionpack (= 7.1.1)
+      actiontext (= 7.1.1)
+      actionview (= 7.1.1)
+      activejob (= 7.1.1)
+      activemodel (= 7.1.1)
+      activerecord (= 7.1.1)
+      activestorage (= 7.1.1)
+      activesupport (= 7.1.1)
+      bundler (>= 1.15.0)
+      railties (= 7.1.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.1)
+      actionpack (= 7.1.1)
+      activesupport (= 7.1.1)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rake (12.3.3)
+    rdoc (6.6.0)
+      psych (>= 4.0.0)
+    reline (0.4.0)
+      io-console (~> 0.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -26,13 +188,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
+    stringio (3.0.9)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   enveloop!
+  rails
   rake (~> 12.0)
   rspec (~> 3.0)
 

data/README.md

@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Ruby (direct usage)
+
 Setup the client connection:
 
 ```ruby
@@ -28,7 +30,7 @@ require 'enveloop'
 enveloop = Enveloop::Client.new(api_key: ENV['ENVELOOP_API_TOKEN'])
 ```
 
-Send a message: 
+Send a message using a template:
 
 ```ruby
 enveloop.send_message(
@@ -42,11 +44,32 @@ enveloop.send_message(
 )
 ```
 
+Send a message passing HTML body:
+
+```ruby
+enveloop.send_message(
+  html: '<h1>Hello John, Welcome to MyApp</h1>',
+  to: 'user@email.com',
+  from: 'welcome@myapp.com',
+  subject: 'Welcome to MyApp',
+)
+```
+
 Get information about a template (variables and body html):
 
 ```ruby
 enveloop.template_info(template: 'welcome-email')
 ```
+### Rails
+
+Add the following to your initializer and send Active::Mailer messaegs with Enveloop as well
+
+```ruby
+config.action_mailer.delivery_method = :enveloop
+config.action_mailer.enveloop_settings = { 
+  api_key: ENV['ENVELOOP_API_TOKEN']
+}
+```
 
 ## Development
 

data/enveloop.gemspec

@@ -8,15 +8,16 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Envelope API wrapper"
   spec.description   = "This gem provides a wrapper for the Envelope API."
-  spec.homepage      = "https://github.com/enveloophq/ruby_enveloop"
+  spec.homepage      = "https://github.com/enveloophq/enveloop-ruby"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/enveloophq/ruby_enveloop"
-  spec.metadata["changelog_uri"] = "https://github.com/enveloophq/ruby_enveloop/blob/master/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/enveloophq/enveloop-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/enveloophq/enveloop-ruby/blob/master/CHANGELOG.md"
 
   spec.add_dependency "faraday"
+  spec.add_development_dependency "rails"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/enveloop/client.rb

@@ -5,12 +5,13 @@ module Enveloop
       @api_key = api_key
     end
 
-    def send_message(template:, to:, from: nil, subject: nil, template_variables: {})
+    def send_message(to:, template: nil, html: nil, from: nil, subject: nil, template_variables: {})
       data = {
         to: to,
         from: from,
         subject: subject,
         template: template,
+        html: html,
         templateVariables: template_variables
       }
 
@@ -34,6 +35,31 @@ module Enveloop
       return MessageResponse.new(status: response.status, body: response.body)
     end
 
+    def send_raw(email:)
+      data = {
+        email: email
+      }
+
+      conn = Faraday.new(
+        url: @endpoint,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "token #{@api_key}",
+          "Sdk-Version" => "ruby-#{Enveloop::VERSION}"
+        }
+      )
+
+      response = conn.post('/messages/rawEmail') do |req|
+        req.body = data.to_json
+      end
+
+      if response.status == 500
+        raise Enveloop::Error.new(JSON.parse(response.body)['error'])
+      end
+
+      return MessageResponse.new(status: response.status, body: response.body)
+    end
+
     def template_info(template:)
       conn = Faraday.new(
         url: @endpoint,

data/lib/enveloop/version.rb

@@ -1,3 +1,3 @@
 module Enveloop
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/enveloop.rb

@@ -6,6 +6,8 @@ require 'enveloop/client'
 require 'enveloop/message_response'
 require 'enveloop/template_response'
 
+require 'enveloop_rails' if defined?(Rails) && defined?(ActionMailer)
+
 module Enveloop
   class Error < StandardError; end
 end

data/lib/enveloop_rails/errors.rb

@@ -0,0 +1,26 @@
+module EnveloopRails
+  class Error < StandardError
+
+    attr_reader :object
+
+    def initialize(message = nil, object = nil)
+      super(message)
+
+      @object = object
+    end
+  end
+
+  class ConfigurationError < Error
+  end
+
+  class InternalError < Error
+
+    attr_reader :source_exception
+
+    def initialize(source_exc, message = nil, object = nil)
+      super(message, object)
+
+      @source_exception = source_exc
+    end
+  end
+end

data/lib/enveloop_rails/mailer.rb

@@ -0,0 +1,33 @@
+require 'action_mailer'
+require 'json'
+require 'enveloop'
+require 'rails'
+require 'enveloop_rails/errors'
+
+module EnveloopRails
+
+  # EnveloopRails::Mailer is an ActionMailer provider for sending mail through Enveloop.
+  class Mailer
+    # [Hash] config ->
+    #   Requires *at least* `api_key`
+    attr_accessor :config, :settings
+
+    # Initialize the EnveloopRails mailer.
+    #
+    # @param [Hash] config Hash of config values, typically from `app_config.action_mailer.enveloop_settings`
+    def initialize(config)
+      @config = config
+
+      raise EnveloopRails::ConfigurationError.new("Config requires `api_key` key", @config) unless @config.has_key?(:api_key)
+
+      @enveloop_client = Enveloop::Client.new(**config)
+
+      # To avoid exception in mail gem v2.6
+      @settings = { return_response: true }
+    end
+
+    def deliver!(mail)
+      @enveloop_client.send_raw(email: mail.to_s)
+    end
+  end
+end

data/lib/enveloop_rails/railtie.rb

@@ -0,0 +1,10 @@
+require 'enveloop_rails/mailer'
+
+module EnveloopRails
+  class Railtie < ::Rails::Railtie
+    ActiveSupport.on_load(:action_mailer) do
+      add_delivery_method :enveloop, EnveloopRails::Mailer
+      ActiveSupport.run_load_hooks(:enveloop_mailer, EnveloopRails::Mailer)
+    end
+  end
+end

data/lib/enveloop_rails.rb

@@ -0,0 +1,6 @@
+require 'enveloop_rails/railtie'
+require 'enveloop_rails/errors'
+require 'enveloop_rails/mailer'
+
+module EnveloopRails
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enveloop
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Wyrosdick
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem provides a wrapper for the Envelope API.
 email:
 - support@enveloop.com
@@ -48,14 +62,18 @@ files:
 - lib/enveloop/message_response.rb
 - lib/enveloop/template_response.rb
 - lib/enveloop/version.rb
-homepage: https://github.com/enveloophq/ruby_enveloop
+- lib/enveloop_rails.rb
+- lib/enveloop_rails/errors.rb
+- lib/enveloop_rails/mailer.rb
+- lib/enveloop_rails/railtie.rb
+homepage: https://github.com/enveloophq/enveloop-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/enveloophq/ruby_enveloop
-  source_code_uri: https://github.com/enveloophq/ruby_enveloop
-  changelog_uri: https://github.com/enveloophq/ruby_enveloop/blob/master/CHANGELOG.md
-post_install_message: 
+  homepage_uri: https://github.com/enveloophq/enveloop-ruby
+  source_code_uri: https://github.com/enveloophq/enveloop-ruby
+  changelog_uri: https://github.com/enveloophq/enveloop-ruby/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -70,8 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Envelope API wrapper
 test_files: []