mail-relayer 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7000ec5bbfcc9779972081b7508bee5768abd044ccf812d39529f4745a26adb
+  data.tar.gz: deeca4cc2f1bb7248f0a936b93547e1f6f2bc1ea4c09138d485a03cec0dfde2c
+SHA512:
+  metadata.gz: 1537b9b92e2a48cce91677b8b17355c96f8ed2ea83d858db462c32140fa3f7fff818b1077980192ea8e6c1c3e18467e2494af0a502efa56224d22ff17a9c5cba
+  data.tar.gz: 67f2dc3fb60869a1cbd3623b253ffddcba5f62b5ef4c4e8a3125b857d4db10229fd451aa397791b91112e22a7f2a2dab6c10542f3996636f336beb57c939a77f

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# CHANGELOG
+
+## v0.2.1 - Dec 20, 2019
+
+Re-release v0.2.0 as v0.2.1.
+
+## v0.2.0 - Dec 19, 2019
+
+Adds option parsing to `mail-relayer` executable.
+
+## v0.1.0 - Dec 19, 2019
+
+Adds executable `mail-relayer` for CLI usage.
+
+## v0.0.1 - Dec 17, 2019
+
+Initial release.
+
+Contains `Mail::Relayer` class adapted from `ActionMailbox::Relayer` - https://github.com/rails/rails/blob/master/actionmailbox/lib/action_mailbox/relayer.rb

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Axel Gustav
+
+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,34 @@
+# Mail Relayer
+
+This project is an attempt to simplify relaying incoming emails, e.g. to ActionMailbox.
+
+## Usage
+
+1. `gem install mail-relayer`
+
+2. Then pipe the email content from `STDIN` to `mail-relayer` executable. You need to specify the target URL and password (HTTP Basic Auth) either via command line arguments or via environment variables.
+
+3. Profit
+
+### Configuration
+
+- target URL: `--url` or `MAIL_RELAYER_URL`
+- ingress username: `--ingress-username` or `MAIL_RELAYER_INGRESS_USERNAME` (optional, default: `mail_relayer`)
+- ingress password: `--ingress-password` or `MAIL_RELAYER_INGRESS_PASSWORD`
+
+## Development
+
+1. Install ruby - see `.ruby-version`
+2. Install bundler - `gem install bundler`
+3. Install dependencies - `bundle install`
+
+## Tests
+
+- `rake test` runs all MiniTest tests in `/test`
+- `rubocop` run static code checks
+
+## Build / Release
+
+1. Update version number in `VERSION` if required.
+2. `gem build mail-relayer.gemspec`
+3. `gem install ./mail-relayer-<VERSION>.gem` to install locally

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/mail-relayer

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "optparse"
+
+require "mail_relayer"
+
+options = {
+  url: ENV["MAIL_RELAYER_URL"],
+  username: ENV["MAIL_RELAYER_INGRESS_USERNAME"],
+  password: ENV["MAIL_RELAYER_INGRESS_PASSWORD"]
+}
+
+OptionParser.new do |opts|
+  opts.on("--url URL") do |url|
+    options[:url] = url
+  end
+  opts.on("--ingress-username INGRESS_USERNAME") do |user|
+    options[:username] = user
+  end
+  opts.on("--ingress-password INGRESS_PASSWORD") do |password|
+    options[:password] = password
+  end
+  opts.on("-v", "--version") do
+    puts "mail-relayer v#{Mail::Relayer::VERSION}"
+    exit 0
+  end
+end.parse!
+
+unless options[:url] && options[:password]
+  puts "4.3.5 URL and INGRESS_PASSWORD are required"
+  exit 1
+end
+
+relayer = Mail::Relayer.new(**options.compact)
+result = relayer.relay(STDIN.read)
+
+puts "#{result.status_code} #{result.message}"
+exit result.success?

data/lib/mail/relayer.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "base64"
+require "net/http"
+require "uri"
+
+module Mail
+  class Relayer
+    class Result < Struct.new(:status_code, :message) # rubocop:disable Style/StructInheritance
+      def success?
+        !failure?
+      end
+
+      def failure?
+        transient_failure? || permanent_failure?
+      end
+
+      def transient_failure?
+        status_code.start_with?("4.")
+      end
+
+      def permanent_failure?
+        status_code.start_with?("5.")
+      end
+    end
+
+    VERSION = File.read(File.expand_path("../../VERSION", __dir__)).strip
+
+    CONTENT_TYPE = "message/rfc822"
+    USER_AGENT   = "Mail relayer v#{VERSION}"
+
+    attr_reader :uri, :username, :password
+
+    def initialize(url:, username: "mail_relayer", password:)
+      @uri = URI(url)
+      @username = username
+      @password = password
+    end
+
+    def relay(source)
+      case response = post(source)
+      when Net::HTTPSuccess
+        Result.new "2.0.0", "Successfully relayed message to ingress"
+      when Net::HTTPUnauthorized
+        Result.new "4.7.0", "Invalid credentials for ingress"
+      else
+        Result.new "4.0.0", "HTTP #{response.code}"
+      end
+    rescue IOError, SocketError, SystemCallError => error
+      Result.new "4.4.2", "Network error relaying to ingress: #{error.message}"
+    rescue Timeout::Error
+      Result.new "4.4.2", "Timed out relaying to ingress"
+    rescue => error # rubocop:disable Style/RescueStandardError
+      Result.new "4.0.0", "Error relaying to ingress: #{error.message}"
+    end
+
+    private
+
+    def post(source)
+      client.post uri, source,
+        "Content-Type" => CONTENT_TYPE,
+        "User-Agent" => USER_AGENT,
+        "Authorization" => "Basic #{Base64.strict_encode64(username + ':' + password)}"
+    end
+
+    def client
+      @client ||= Net::HTTP.new(uri.host, uri.port).tap do |connection|
+        if uri.scheme == "https"
+          require "openssl"
+
+          connection.use_ssl     = true
+          connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        end
+
+        connection.open_timeout = 1
+        connection.read_timeout = 10
+      end
+    end
+  end
+end

data/lib/mail_relayer.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "mail/relayer"

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: mail-relayer
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Axel Gustav
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.77.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.77.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.13'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: A small wrapper around ActionMailbox::Relayer without any dependencies.
+email: dev@axelgustav.de
+executables:
+- mail-relayer
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- VERSION
+- bin/mail-relayer
+- lib/mail/relayer.rb
+- lib/mail_relayer.rb
+homepage: https://gitlab.com/axelthegerman/mail-relayer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Extracts ActionMailbox::Relayer for stand-alone use
+test_files: []