flowmailer_rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b1b138e49c32a25c5acd356442942b9a42c38e55b4741b9b69206af53cab09b
-  data.tar.gz: 517ef17f387643e360448dcd27f968257f6f61606e6fed8ab24963cd44ac84a7
+  metadata.gz: 26ad29df91bf8ce2e60eea7d6bc7e35ead984aaacb88a09fce445ec98def8542
+  data.tar.gz: 606d48b72365d4c9c36bf3b605ff29a4ed9ff159b34889209280ccf1b90872ce
 SHA512:
-  metadata.gz: d3caf9173ee0bc60f66eb2b064a28d56ac68e2cf48af17644448680178ae76433c895c20adaa4bb63c7b992996f4f4560b7560bc9b4e6df9a6c7201661ad8da7
-  data.tar.gz: 9ea6b6bf40e79072b9ba7218fb8aaa32e52a5f03e93a9e31a5d01e6bc558173ba8835972d2dc43f9cf1f8eb6f9e782220b72b8098eb1a2f38d03eae6da800487
+  metadata.gz: 6571137fd7a30106c0fa50adc8e0631c6ae7f74efeea7f5a4dbecccad74dc94a3419ee4143d46a2e9ac681d072d6c9fc9b6ea53914f810383cee6e0cc90381dc
+  data.tar.gz: fdf61fa3331fea173cdfaa6e36826b30f7c5e1e48286ee6c91cad28d71264aadcd9b26f040c225617db810aa4dc5c365cd4f3202266e4d9f21a47546f69fa578

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flowmailer_rails (0.1.0)
+    flowmailer_rails (0.2.0)
       actionmailer (>= 3.0.0)
       faraday (>= 0.7.4, < 1.0)
       faraday_middleware
@@ -9,68 +9,69 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (6.0.3.4)
-      actionpack (= 6.0.3.4)
-      actionview (= 6.0.3.4)
-      activejob (= 6.0.3.4)
+    actionmailer (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      actionview (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.4)
-      actionview (= 6.0.3.4)
-      activesupport (= 6.0.3.4)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.3.2)
+      actionview (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    actionview (6.1.3.2)
+      activesupport (= 6.1.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    activejob (6.1.3.2)
+      activesupport (= 6.1.3.2)
       globalid (>= 0.3.6)
-    activesupport (6.0.3.4)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
     builder (3.2.4)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     crack (0.4.4)
     crass (1.0.6)
     diff-lcs (1.3)
     docile (1.3.2)
     erubi (1.10.0)
-    faraday (0.17.3)
+    faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     hashdiff (1.0.1)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.7.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
+    mini_mime (1.1.0)
+    minitest (5.14.4)
     multipart-post (2.1.1)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.6-arm64-darwin)
+      racc (~> 1.4)
     parallel (1.20.0)
     parser (2.7.2.0)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -82,7 +83,7 @@ GEM
     rainbow (3.0.0)
     rake (13.0.1)
     regexp_parser (1.8.2)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -119,15 +120,14 @@ GEM
     standard (0.6.2)
       rubocop (= 0.91.1)
       rubocop-performance (= 1.8.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.8)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
     webmock (3.10.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -143,4 +143,4 @@ DEPENDENCIES
   webmock (~> 3.10.0)
 
 BUNDLED WITH
-   2.0.2
+   2.1.4

data/README.md

@@ -1,4 +1,6 @@
 # FlowmailerRails
+[![Gem Version](https://badge.fury.io/rb/flowmailer_rails.svg)](https://rubygems.org/gems/flowmailer_rails)
+![Tests](https://github.com/teamtailor/flowmailer_rails/workflows/Ruby/badge.svg)
 
 Send ActionMailer emails with Flowmailer
 
@@ -14,14 +16,36 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install FlowmailerRails
+### Configuration
 
-## Usage
+Add basic configuration by providing it with your account id and client Id and Secret for an API source with submitt access.
+```ruby
+# config/production.rb
+config.action_mailer.flowmailer_settings = {
+  account_id: ENV["FLOWMAILER_ACCOUNT_ID"],
+  client_id: ENV["FLOWMAILER_CLIENT_ID"],
+  client_secret: ENV["FLOWMAILER_CLIENT_SECRET"],
+}
+```
 
-TODO: Write usage instructions here
+You can also provide procs that handles the `access_token` retrieval if you already have that logic in your Rails app:
+```ruby
+# config/production.rb
+config.action_mailer.flowmailer_settings = {
+  account_id: ENV["FLOWMAILER_ACCOUNT_ID"],
+  access_token: -> { FooBar.access_token },
+  fetch_new_access_token: -> { FooBar.fetch_new_access_token },
+}
+```
+
+Tell Rails to use Flowmailer as the delivery method
 
+```ruby
+# config/production.rb
+config.action_mailer.delivery_method = :flowmailer
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/flowmailer_rails/mailer.rb

@@ -5,6 +5,7 @@ module FlowmailerRails
   class Mailer
     class NoAccessTokenError < StandardError; end
     class DeliveryError < StandardError; end
+    class TooBigMessageError < DeliveryError; end
     class ExpiredAccessTokenError < StandardError; end
 
     OAUTH_ENDPOINT = "https://login.flowmailer.net".freeze
@@ -38,8 +39,7 @@ module FlowmailerRails
       begin
         response = api_client.post(path, json, authorization_header)
 
-        raise ExpiredAccessTokenError if response.status == 401
-        raise DeliveryError, response.body unless response.success?
+        handle_failure(response)
       rescue ExpiredAccessTokenError
         if (retries += 1) <= 3
           fetch_new_access_token
@@ -52,6 +52,18 @@ module FlowmailerRails
       response
     end
 
+    def handle_failure(response)
+      return if response.success?
+
+      raise ExpiredAccessTokenError if response.status == 401
+
+      too_big_error = response.body&.[]("allErrors")&.find { |error| error["code"] == "message.toobig" }
+
+      raise TooBigMessageError, too_big_error["defaultMessage"] if too_big_error.present?
+
+      raise DeliveryError, response.body
+    end
+
     def api_client
       @api_client ||= Faraday.new(url: API_ENDPOINT) { |conn|
         conn.request :json

data/lib/flowmailer_rails/version.rb

@@ -1,3 +1,3 @@
 module FlowmailerRails
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flowmailer_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonas Brusman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -199,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: ActionMailer adapter for Flowmailer