gravity_mailbox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72867c424724e7388ae25f6eb519d509cfaf7bc6deb90de35eaa766bd6350e40
+  data.tar.gz: 4d0a7c8ca000e49aed8a878e5bcc402896ae61a97981acf71fcbdbac29d59bad
+SHA512:
+  metadata.gz: 7b24028b7fc05777f0e727f0f4677c990226c255d705caba4a5bcf108e41ae969628faa0545e2f05c6feaab23452691bf016bab6903eff102463e2e7c5a7be53
+  data.tar.gz: 8824afef7b5bf9618186afc88371da4d3b3d275bed3d574795aa667745f3ae7fd9bd71d18deee7b86860991e370357f627f5963b5d8e969803296ab951a0801e

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.6
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## main (unreleased)
+
+## v0.1.0 (2022-11-15)
+
+ * Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gravity_mailbox.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+group :test do
+  gem 'rspec'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    gravity_mailbox (0.1.0)
+      actionmailer (>= 5.2)
+      railties (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (6.0.5.1)
+      actionpack (= 6.0.5.1)
+      actionview (= 6.0.5.1)
+      activejob (= 6.0.5.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.5.1)
+      actionview (= 6.0.5.1)
+      activesupport (= 6.0.5.1)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.5.1)
+      activesupport (= 6.0.5.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.5.1)
+      activesupport (= 6.0.5.1)
+      globalid (>= 0.3.6)
+    activesupport (6.0.5.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    nokogiri (1.13.9)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (6.0.5.1)
+      actionpack (= 6.0.5.1)
+      activesupport (= 6.0.5.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.10)
+      thread_safe (~> 0.1)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  -darwin-21
+
+DEPENDENCIES
+  gravity_mailbox!
+  rake (~> 13.0)
+  rspec
+  rubocop
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jean-Francis Bastien
+
+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,48 @@
+# GravityMailbox
+
+Development tools that aim to make it simple to visualize mail sent by your Rails app directly through your Rails app.
+It works in development and also in a staging environment by using the `Rails.cache` to store the mails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gravity_mailbox'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gravity_mailbox
+
+## Usage
+
+* Config ActionMailer to use the RailsCacheDeliveryMethod.
+
+```ruby
+config.action_mailer.delivery_method = :gravity_mailbox_rails_cache
+config.action_mailer.perform_deliveries = true
+```
+
+* Send mails
+* Go to http://localhost:3000/gravity_mailbox to see the mails.
+
+<img width="520" alt="image" src="https://user-images.githubusercontent.com/7858787/201705867-74888ae2-fa6d-4678-a911-134ae5527100.png">
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/petalmd/gravity_mailbox.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'gravity_mailbox'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gravity_mailbox.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gravity_mailbox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gravity_mailbox'
+  spec.version       = GravityMailbox::VERSION
+  spec.authors       = ['Jean-Francis Bastien']
+  spec.email         = ['jfbastien@petalmd.com']
+
+  spec.summary       = 'Write a short summary, because RubyGems requires one.'
+  spec.description   = 'Write a longer description or delete this line.'
+  spec.homepage      = 'https://github.com/petalmd/gravity_mailbox'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/petalmd/gravity_mailbox'
+  spec.metadata['changelog_uri'] = 'https://github.com/petalmd/gravity_mailbox/blob/main/CHANGELOG.md'
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'actionmailer', '>= 5.2'
+  spec.add_dependency 'railties', '>= 5.2'
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/gravity_mailbox/mailbox_controller.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GravityMailbox
+  class MailboxController < ActionController::Base
+    self.view_paths = File.expand_path('templates', __dir__)
+
+    layout 'application'
+
+    before_action :set_mails, only: %i[index]
+
+    def index
+      @part = find_preferred_part(request.format, Mime[:html], Mime[:text]) if @mail
+      return unless params[:part]
+
+      response.content_type = 'text/html'
+      render plain: email_body
+    end
+
+    def delete_all
+      RailsCacheDeliveryMethod.delete_all
+      redirect_to '/gravity_mailbox'
+    end
+
+    private
+
+    def find_preferred_part(*formats)
+      formats.each do |format|
+        part = @mail.find_first_mime_type(format)
+        return part if part
+      end
+
+      return unless formats.any? { |f| @mail.mime_type == f }
+
+      @mail
+    end
+
+    def email_body
+      @mail.part[1].body.decoded
+    end
+
+    def set_mails
+      @mails = RailsCacheDeliveryMethod.mails
+      @mail = @mails.detect { |m| m.message_id == params[:id] } if params[:id]
+    end
+  end
+end

data/lib/gravity_mailbox/rails_cache_delivery_method.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GravityMailbox
+  class RailsCacheDeliveryMethod
+    KEY_PREFIX = 'gravity_mailbox/'
+    MAILS_LIST_KEY = "#{KEY_PREFIX}list"
+
+    def initialize(options)
+      @options = options
+    end
+
+    def deliver!(mail)
+      key = "#{KEY_PREFIX}#{mail.message_id}"
+      Rails.cache.write(key, mail.encoded, expires_in: 1.week) # TODO: setting for expiration
+      actual_list = self.class.mail_keys
+      Rails.cache.write(MAILS_LIST_KEY, actual_list << key)
+    end
+
+    def self.mails
+      return [] if mail_keys.empty?
+
+      Rails.cache.read_multi(*mail_keys).values.map do |mail|
+        Mail.new(mail)
+      end.sort_by(&:date).reverse
+    end
+
+    def self.delete_all
+      Rails.cache.delete_matched("#{KEY_PREFIX}*")
+    end
+
+    def self.mail_keys
+      Rails.cache.read(MAILS_LIST_KEY) || []
+    end
+  end
+end

data/lib/gravity_mailbox/railtie.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'mailbox_controller'
+
+module GravityMailbox
+  class Railtie < ::Rails::Railtie # :nodoc:
+    initializer 'gravity_mailbox.add_delivery_method' do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method(
+          :gravity_mailbox_rails_cache,
+          RailsCacheDeliveryMethod
+        )
+      end
+    end
+
+    config.after_initialize do |app|
+      app.routes.prepend do
+        get '/gravity_mailbox' => 'gravity_mailbox/mailbox#index', internal: true
+        post '/gravity_mailbox/delete_all' => 'gravity_mailbox/mailbox#delete_all', internal: true
+      end
+    end
+  end
+end

data/lib/gravity_mailbox/templates/gravity_mailbox/mailbox/_mail.html.erb

@@ -0,0 +1,5 @@
+<div class="box <%= mail.message_id == params[:id] ? 'has-background-success-light' : '' %>">
+  <strong>Subject: </strong><%= link_to mail.subject, "?id=#{mail.message_id}" %> <br>
+  <strong>To: </strong><%= mail.to.join(', ') %><br>
+  <strong>Date: </strong><%= I18n.l(mail.date, format: :long) %><br>
+</div>

data/lib/gravity_mailbox/templates/gravity_mailbox/mailbox/index.html.erb

@@ -0,0 +1,26 @@
+<% content_for :style do %>
+  body, iframe {
+    height: 100vh;
+  }
+
+  iframe {
+    border: 0;
+    width: 100%;
+  }
+<% end %>
+
+<div class="columns mb-0 mt-0">
+  <div class="column is-one-quarter" style="max-height: 100vh; overflow: scroll">
+    <div class="section" style="padding: 1em;">
+      <%= button_to 'Delete all', '/gravity_mailbox/delete_all', class: ['button', 'is-danger'], method: :post %>
+    </div>
+    <% @mails.each do |mail| %>
+      <%= render partial: 'mail', locals: { mail: mail } %>
+    <% end %>
+  </div>
+  <div class="column pb-0 pt-0">
+    <% if @mail %>
+      <iframe seamless name="messageBody" src="?part=true&id=<%= params[:id] %>"></iframe>
+    <% end %>
+  </div>
+</div>

data/lib/gravity_mailbox/templates/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta name="viewport" content="width=device-width" />
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.4/css/bulma.min.css">
+
+  <style>
+    <%= yield :style %>
+  </style>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>

data/lib/gravity_mailbox/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GravityMailbox
+  VERSION = '0.1.0'
+end

data/lib/gravity_mailbox.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'gravity_mailbox/version'
+require_relative 'gravity_mailbox/rails_cache_delivery_method'
+require_relative 'gravity_mailbox/railtie' if defined?(Rails)
+
+module GravityMailbox
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: gravity_mailbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean-Francis Bastien
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: Write a longer description or delete this line.
+email:
+- jfbastien@petalmd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gravity_mailbox.gemspec
+- lib/gravity_mailbox.rb
+- lib/gravity_mailbox/mailbox_controller.rb
+- lib/gravity_mailbox/rails_cache_delivery_method.rb
+- lib/gravity_mailbox/railtie.rb
+- lib/gravity_mailbox/templates/gravity_mailbox/mailbox/_mail.html.erb
+- lib/gravity_mailbox/templates/gravity_mailbox/mailbox/index.html.erb
+- lib/gravity_mailbox/templates/layouts/application.html.erb
+- lib/gravity_mailbox/version.rb
+homepage: https://github.com/petalmd/gravity_mailbox
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/petalmd/gravity_mailbox
+  source_code_uri: https://github.com/petalmd/gravity_mailbox
+  changelog_uri: https://github.com/petalmd/gravity_mailbox/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []