plunk_mail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14aa48ca43599b9ebd0b078b2a7ba3ae10ce2e13f5ccb350b25a760142719f00
+  data.tar.gz: ae4fc89ef05e07b45ae16e7e969b1ce22697eb186c98a8f6707e56192ab0c368
+SHA512:
+  metadata.gz: b124b878c5e45d6124c4674c4e49c1a0333b4bd5c16e104197e672102e64f047ac4ba24626d8ab87fe307f609f0e8e7204232be6330b39f96d26fb6d7e23284b
+  data.tar.gz: fce30f08f21a0b59e6d1589abb670b446ec766fba0830180437dcfd9c7b8af1f486cc42dc504fdb8c2bc1b9198ace2a82615946fc9ace15c6b82b3de61b437cc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Andres
+
+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,70 @@
+# PlunkMail
+
+ActionMailer delivery method for sending emails through Plunk.
+
+PlunkMail allows Rails applications to use Plunk as an ActionMailer delivery method:
+
+```ruby
+config.action_mailer.delivery_method = :plunk
+```
+
+## Usage
+
+Configure Plunk in your `config/environments/production.rb`:
+
+```ruby
+config.action_mailer.delivery_method = :plunk
+
+config.action_mailer.plunk_settings = {
+  api_key: ENV["PLUNK_API_KEY"]
+}
+```
+
+Use ActionMailer normally:
+
+```ruby
+class UserMailer < ApplicationMailer
+  def welcome(user)
+    mail(
+      to: user.email,
+      subject: "Welcome"
+    )
+  end
+end
+```
+
+Send the email:
+
+```ruby
+UserMailer.welcome(user).deliver_now
+```
+
+HTML emails are supported automatically. If an HTML part exists, it will be sent through Plunk.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "plunk_mail"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install plunk_mail
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/plunk_mail/delivery_method.rb

@@ -0,0 +1,38 @@
+require "faraday"
+
+module PlunkMail
+  class DeliveryMethod
+    def initialize(settings = {})
+      @api_key = settings[:api_key]
+    end
+
+    def deliver!(mail)
+      response = Faraday.post(
+        "https://next-api.useplunk.com/v1/send",
+        {
+          to: mail.to.first,
+          subject: mail.subject,
+          body: email_body(mail),
+          from: {
+            name: mail[:from]&.display_names&.first,
+            email: mail.from.first
+          }.compact
+        }.to_json,
+        {
+          "Authorization" => "Bearer #{@api_key}",
+          "Content-Type" => "application/json"
+        }
+      )
+
+      raise "Plunk error: #{response.status} #{response.body}" unless response.success?
+
+      response
+    end
+
+    private
+
+    def email_body(mail)
+      mail.html_part&.body&.decoded || mail.body.decoded
+    end
+  end
+end

data/lib/plunk_mail/version.rb

@@ -0,0 +1,3 @@
+module PlunkMail
+  VERSION = "0.1.0"
+end

data/lib/plunk_mail.rb

@@ -0,0 +1,11 @@
+require "plunk_mail/version"
+require "plunk_mail/delivery_method"
+require "action_mailer"
+
+ActionMailer::Base.add_delivery_method(
+  :plunk,
+  PlunkMail::DeliveryMethod
+)
+
+module PlunkMail
+end

data/lib/tasks/plunk_mail_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :plunk_mail do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: plunk_mail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andres Gracia Danies
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.1.3
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: PlunkMail allows Rails applications to use Plunk as an ActionMailer delivery
+  method.
+email:
+- 18741308+a-gracia@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/plunk_mail.rb
+- lib/plunk_mail/delivery_method.rb
+- lib/plunk_mail/version.rb
+- lib/tasks/plunk_mail_tasks.rake
+homepage: https://github.com/a-gracia/plunk_mail
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/a-gracia/plunk_mail
+  source_code_uri: https://github.com/a-gracia/plunk_mail
+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.7.2
+specification_version: 4
+summary: ActionMailer delivery method for sending emails through Plunk.
+test_files: []