gravity_mailbox 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 570d181cfe915276f4974ccfcf0d3e155201ab1b801ace546f8f3f492072640d
-  data.tar.gz: 4bfa2c3ae452251cd56fd5cbcfb8da0dda6b3ec967df6310cb192881dc23c14f
+  metadata.gz: 5835a90d8c0976603d428e309d93cf986c01acdae1828a552a66c863cd313e80
+  data.tar.gz: 6827f99d05b9fab10df3622879f1afaabd1b1dbc25a7ed225413b16eb1b70b52
 SHA512:
-  metadata.gz: 38e58ed90b91cd01fd22b4ce0d6643a1a747fc195681c83d43a8831ba73f956ff1fca06c60f197fa38443f6c4cbf0c40c6c2b2dd0de150c8eb9b60e3f9e22a85
-  data.tar.gz: 3cb194679c08136d8ab6f4957a5651e346dff20c710b54f28649e9db3d82f4a0080ccd64eddfcc052d71783e49cd2e98b44ea8ec033d5839d28a1d659524279d
+  metadata.gz: ff917785d1ce22c4026d320d251b0c4430878105903fa18469901dbc6bfdfb6151a792b92b7b66a49d9cf177df5e069c098cdfe0aa6c733ec29edeb9da84ffed
+  data.tar.gz: 013eb6ca9e93c6d61e07fec711a07dda29de59af08402e6f48e94410f576b0af09986effc8051c44c003b6fc05f2d034436b16b341359ba2a86e1c05537975f6

data/README.md

@@ -29,13 +29,28 @@ Or install it yourself as:
 * Config ActionMailer to use the RailsCacheDeliveryMethod.
 
 ```ruby
+# config/environments/(development|staging).rb
 config.action_mailer.delivery_method = :gravity_mailbox_rails_cache
 config.action_mailer.perform_deliveries = true
 ```
 
+* Mount the Engine
+
+```ruby
+# config/routes.rb
+mount GravityMailbox::Engine => "/gravity_mailbox"
+```
+
 * Send mails
 * Go to http://localhost:3000/gravity_mailbox to see the mails.
 
+**Note**
+
+You can use routing constraints to restrict access to GravityMailbox. More details and example in the [Rails Guides](https://guides.rubyonrails.org/routing.html#advanced-constraints). 
+
+
+## Screenshots
+
 <p align="center">
     <img width="520" alt="image" src="https://user-images.githubusercontent.com/7858787/213796119-a22ac9da-3943-4cd0-95e6-2fb724de999a.png">
 </p>
@@ -46,6 +61,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+### Standalone app
+
+Use `bundle exec rackup` to test locally the gem. Go to [http://localhost:9292](http://localhost:9292)
+Use the button to send a test mail and to see those mail into GravityMailbox.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/petalmd/gravity_mailbox.

data/{lib → app/controllers}/gravity_mailbox/mailbox_controller.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
+require 'action_controller'
+
 module GravityMailbox
   class MailboxController < ActionController::Base
-    self.view_paths = File.expand_path('templates', __dir__)
-
-    layout 'application'
+    layout 'gravity_mailbox'
 
     before_action :set_mails, only: %i[index]
 
     def index
-      @part = find_preferred_part(request.format, Mime[:html], Mime[:text]) if @mail
+      @part = find_preferred_part(*[request.format, Mime[:html], Mime[:text]].uniq) if @mail
       return unless params[:part]
 
       response.content_type = 'text/html'
-      render plain: email_body
+      render plain: @part&.decoded
     end
 
     def download_eml
@@ -34,18 +34,14 @@ module GravityMailbox
     private
 
     def find_preferred_part(*formats)
-      formats.each do |format|
-        part = @mail.find_first_mime_type(format)
-        return part if part
+      if @mail.multipart?
+        formats.each do |format|
+          part = @mail.find_first_mime_type(format)
+          return part if part
+        end
+      elsif formats.include?(@mail.mime_type)
+        @mail.body
       end
-
-      return unless formats.any? { |f| @mail.mime_type == f }
-
-      @mail
-    end
-
-    def email_body
-      @mail.part[1].body.decoded
     end
 
     def set_mails

data/app/views/layouts/gravity_mailbox.html.erb

@@ -0,0 +1,18 @@
+<!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">
+    <link rel="preconnect" href="https://fonts.googleapis.com">
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+    <link href="https://fonts.googleapis.com/css2?family=Righteous&display=swap" rel="stylesheet">
+    <style>
+      <%= yield :style %>
+    </style>
+  </head>
+  <body>
+    <%= yield %>
+    <script type="module" src="https://unpkg.com/ionicons@5.5.2/dist/ionicons/ionicons.esm.js"></script>
+    <script nomodule src="https://unpkg.com/ionicons@5.5.2/dist/ionicons/ionicons.js"></script>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+GravityMailbox::Engine.routes.draw do
+  get '/' => 'mailbox#index', as: :index
+  get 'download_eml' => 'mailbox#download_eml'
+  post 'delete' => 'mailbox#delete'
+  post 'delete_all' => 'mailbox#delete_all'
+end

data/lib/gravity_mailbox/engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails'
+require_relative 'rails_cache_delivery_method'
+
+module GravityMailbox
+  class Engine < ::Rails::Engine # :nodoc:
+    isolate_namespace(GravityMailbox)
+
+    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
+  end
+end

data/lib/gravity_mailbox/rails_cache_delivery_method.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
+require 'mail'
+
 module GravityMailbox
   class RailsCacheDeliveryMethod
     KEY_PREFIX = 'gravity_mailbox/'
     MAILS_LIST_KEY = "#{KEY_PREFIX}list"
 
-    def initialize(options)
-      @options = options
+    attr_accessor :settings
+
+    def initialize(settings)
+      @settings = settings
     end
 
     def deliver!(mail)

data/lib/gravity_mailbox/version.rb

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

data/lib/gravity_mailbox.rb

@@ -1,8 +1,7 @@
 # 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)
+require_relative 'gravity_mailbox/engine'
 
 module GravityMailbox
 end

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gravity_mailbox
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionmailer
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   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'
+        version: '6.0'
 description: Development tools that aim to make it simple to visualize mail sent by
   your Rails app directly through your Rails app.
 email:
@@ -50,13 +36,14 @@ extra_rdoc_files:
 files:
 - LICENSE.txt
 - README.md
+- app/controllers/gravity_mailbox/mailbox_controller.rb
+- app/views/gravity_mailbox/mailbox/_mail.html.erb
+- app/views/gravity_mailbox/mailbox/index.html.erb
+- app/views/layouts/gravity_mailbox.html.erb
+- config/routes.rb
 - lib/gravity_mailbox.rb
-- lib/gravity_mailbox/mailbox_controller.rb
+- lib/gravity_mailbox/engine.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:
@@ -82,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Visualize mail sent by your Rails app directly through your Rails app.

data/lib/gravity_mailbox/railtie.rb

@@ -1,25 +0,0 @@
-# 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
-        get '/gravity_mailbox/download_eml' => 'gravity_mailbox/mailbox#download_eml', internal: true
-        post '/gravity_mailbox/delete' => 'gravity_mailbox/mailbox#delete', internal: true
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-<!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">
-  <link rel="preconnect" href="https://fonts.googleapis.com">
-  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-  <link href="https://fonts.googleapis.com/css2?family=Righteous&display=swap" rel="stylesheet">
-  <style>
-    <%= yield :style %>
-  </style>
-</head>
-<body>
-<%= yield %>
-<script type="module" src="https://unpkg.com/ionicons@5.5.2/dist/ionicons/ionicons.esm.js"></script>
-<script nomodule src="https://unpkg.com/ionicons@5.5.2/dist/ionicons/ionicons.js"></script>
-</body>
-</html>