ohmysmtp-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 056dbcc06cf514f4ea4ab5b24eb3606a7b170ffd485c32aead49088b4e2666ef
+  data.tar.gz: 54faecc5475e5fb710bc63242c80e287cfc0be004ba0cdf4eecdcf14eaf428b2
+SHA512:
+  metadata.gz: 2fb219e0e85ce7e3df8431b96f2abad253439a5ef51c2d4b8e367c1e6eec6f6b0c1cfb76bcbf8c2cf4090171dfdedf256689c206b0edad17355b3c11fb71db36
+  data.tar.gz: 29d62a2f03de60de38187c8e6dfcf4509d34b04dcbbecb05c1bbae757156f2ce72ee7184f9faf271841038537a04c980900f6b941ebdec76e1a9841f11753d96

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 OhMySMTP
+
+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,92 @@
+# OhMySMTP::Rails
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+
+
+[OhMySMTP](https://ohmysmtp.com) lets you send transactional emails from your app over an easy to use API.
+
+The OhMySMTP Rails Gem is a plug in for ActionMailer to send emails via [OhMySMTP](https://ohmysmtp.com) to make sending emails from Rails apps super simple.
+
+## Usage
+
+Once installed and configured, continue to send emails using [ActionMailer](https://guides.rubyonrails.org/action_mailer_basics.html) like normal.
+
+## Requirements
+
+You will need an OhMySMTP account with a verified domain and organization with an active plan.
+
+## Installation
+
+### Account Setup 
+
+Set up an account at [OhMySMTP](https://app.ohmysmtp.com/users/sign_up) and complete the Onboarding steps
+
+### Gem Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ohmysmtp-rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ohmysmtp-rails
+```
+
+### Configure the Gem
+
+First you will need to retrieve your API token for your sending domain from [OhMySMTP](https://app.ohmysmtp.com). You can find it under Organization -> Domain -> API Tokens
+
+#### Rails 6
+
+Use the encrypted secret management to save your API Token to `config/credentials.yml.enc` by running the following:
+
+```bash
+rails secret
+rails credentials:edit
+```
+
+Then add your token:
+
+```yaml
+ohmysmtp_api_token: "TOKEN_GOES_HERE"
+```
+
+Set OhMySMTP as your mail delivery method in `config/application.rb`:
+
+```ruby
+config.action_mailer.delivery_method = :ohmysmtp
+config.action_mailer.ohmysmtp_settings = { api_token: Rails.application.credentials.ohmysmtp_api_token }
+```
+
+#### Rails 3-5
+
+Save your API Token to `config/secrets.yml` using a text editor:
+
+```yaml
+ohmysmtp_api_token: "TOKEN_GOES_HERE"
+```
+
+Set OhMySMTP as your mail delivery method in `config/application.rb`:
+
+```ruby
+config.action_mailer.delivery_method = :ohmysmtp
+config.action_mailer.ohmysmtp_settings = { :api_token => Rails.application.secrets.ohmysmtp_api_token }
+```
+
+## Support
+
+For support please check the [OhMySMTP Documentation](https://docs.ohmysmtp.com)  or contact us at support@ohmysmtp.com
+
+## Contributing
+
+Pull requests always welcome
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OhMySMTP::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/ohmysmtp-rails.rb

@@ -0,0 +1,62 @@
+require 'action_mailer'
+require 'httparty'
+require 'uri'
+require 'json'
+require 'ohmysmtp-rails/version'
+require 'ohmysmtp-rails/railtie' if defined? Rails
+
+module OhMySMTP
+  # OhMySMTP ActionMailer delivery method
+  class DeliveryMethod
+    attr_accessor :settings
+
+    def initialize(values)
+      check_api_token(values)
+      self.settings = {}.merge!(values)
+    end
+
+    def deliver!(mail)
+      check_delivery_params(mail)
+      result = HTTParty.post(
+        'https://app.ohmysmtp.com/api/v1/send',
+        body: {
+          from: mail.from.join(','),
+          to: mail.to.join(','),
+          subject: mail.subject,
+          htmlbody: mail.body,
+          cc: mail.cc&.join(','),
+          bcc: mail.bcc&.join(','),
+          replyto: mail.reply_to
+        }.to_json,
+        headers: {
+          'User-Agent' => "OhMySMTP Rails Gem v#{OhMySMTP::Rails::VERSION}",
+          'Accept' => 'application/json',
+          'Content-Type' => 'application/json',
+          'Ohmysmtp-Server-Token' => settings[:api_token]
+        }
+      )
+
+      handle_response(result)
+    end
+
+    private
+
+    def check_api_token(values)
+      return if values[:api_token].present?
+
+      raise ArgumentError, 'OhMySMTP API token is not set'
+    end
+
+    def check_delivery_params(mail)
+      return unless mail.from.nil? || mail.to.nil?
+
+      raise ArgumentError, 'Missing to or from address in email'
+    end
+
+    def handle_response(result)
+      return unless result.code != 200
+
+      raise result['error']
+    end
+  end
+end

data/lib/ohmysmtp-rails/railtie.rb

@@ -0,0 +1,7 @@
+module OhMySMTP
+  class Railtie < ::Rails::Railtie
+    initializer 'ohmysmtp.add_delivery_method', before: 'action_mailer.set_configs' do
+      ActionMailer::Base.add_delivery_method(:ohmysmtp, OhMySMTP::DeliveryMethod)
+    end
+  end
+end

data/lib/ohmysmtp-rails/version.rb

@@ -0,0 +1,5 @@
+module OhMySMTP
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: ohmysmtp-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OhMySMTP
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.2
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: pry
+  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: sqlite3
+  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: The OhMySMTP Rails Gem is a plug in for ActionMailer to send emails via
+  OhMySMTP to make sending emails from Rails apps super simple.
+email:
+- support@ohmysmtp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ohmysmtp-rails.rb
+- lib/ohmysmtp-rails/railtie.rb
+- lib/ohmysmtp-rails/version.rb
+homepage: https://ohmysmtp.com
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Lets you send transactional emails from your app over an easy to use API
+test_files: []