letter_opener_web_wally 2.0.1

data/lib/letter_opener_web/engine.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'letter_opener'
+require 'letter_opener_web/delivery_method'
+
+module LetterOpenerWeb
+  class Engine < ::Rails::Engine
+    isolate_namespace LetterOpenerWeb
+
+    initializer 'letter_opener_web.add_delivery_method' do
+      ActiveSupport.on_load :action_mailer do
+        ActionMailer::Base.add_delivery_method(
+          :letter_opener_web,
+          LetterOpenerWeb::DeliveryMethod,
+          location: LetterOpenerWeb.config.letters_location
+        )
+      end
+    end
+  end
+end

data/lib/letter_opener_web/version.rb

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

data/lib/letter_opener_web.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'letter_opener_web/version'
+require 'letter_opener_web/engine'
+require 'rexml/document'
+require 'aws-sdk-s3'
+
+module LetterOpenerWeb
+  class Config
+    attr_accessor(
+      :letters_storage,
+      :aws_access_key_id,
+      :aws_secret_access_key,
+      :aws_region,
+      :aws_bucket
+    )
+
+    def letters_location
+      @letters_location ||=
+        case LetterOpenerWeb.config.letters_storage
+        when :local
+          Rails.root.join('tmp', 'letter_opener')
+        end
+    end
+
+    attr_writer :letters_location
+  end
+
+  def self.config
+    @config ||= Config.new.tap do |conf|
+      conf.letters_storage = :local
+    end
+  end
+
+  def self.configure
+    yield config if block_given?
+  end
+
+  def self.reset!
+    @config = nil
+    @aws_client = nil
+    @letters_location = nil
+  end
+
+  def self.aws_client
+    @aws_client ||= ::Aws::S3::Client.new(
+      access_key_id: LetterOpenerWeb.config.aws_access_key_id,
+      secret_access_key: LetterOpenerWeb.config.aws_secret_access_key,
+      region: LetterOpenerWeb.config.aws_region
+    )
+  end
+end

data/script/pre-push

@@ -0,0 +1,2 @@
+#!/bin/bash
+# bundle exec rubocop -a

data/spec/controllers/letter_opener_web/letters_controller_spec.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe LetterOpenerWeb::LettersController do
+  routes { LetterOpenerWeb::Engine.routes }
+
+  after(:each) { LetterOpenerWeb.reset! }
+
+  context 'when letters location is on AWS S3 bucket' do
+    before do
+      LetterOpenerWeb.configure do |config|
+        config.aws_access_key_id = 'aws_access_key_id'
+        config.aws_secret_access_key = 'aws_secret_access_key'
+        config.aws_region = 'aws_region'
+        config.aws_bucket = 'aws_bucket'
+        config.letters_storage = :s3
+      end
+    end
+
+    describe 'GET index' do
+      before do
+        allow(LetterOpenerWeb::AwsLetter).to receive(:search)
+        get :index
+      end
+
+      it 'searches for all letters' do
+        expect(LetterOpenerWeb::AwsLetter).to have_received(:search)
+      end
+
+      it 'returns an HTML 200 response' do
+        expect(response.status).to eq(200)
+        expect(response.content_type).to eq('text/html; charset=utf-8')
+      end
+    end
+
+    describe 'GET show' do
+      let(:id)         { 'an-id' }
+      let(:rich_text)  { 'rich text href="plain.html"' }
+      let(:plain_text) { 'plain text href="rich.html"' }
+      let(:letter)     { double(:letter, rich_text:, plain_text:, id:) }
+
+      shared_examples 'found letter examples' do |letter_style|
+        before(:each) do
+          expect(LetterOpenerWeb::AwsLetter).to receive(:find).with(id).and_return(letter)
+          expect(letter).to receive(:valid?).and_return(true)
+          get :show, params: { id:, style: letter_style }
+        end
+
+        it 'renders an HTML 200 response' do
+          expect(response.status).to eq(200)
+          expect(response.content_type).to eq('text/html; charset=utf-8')
+        end
+      end
+
+      context 'rich text version' do
+        include_examples 'found letter examples', 'rich'
+
+        it 'renders the rich text contents' do
+          expect(response.body).to match(/^rich text/)
+        end
+
+        it 'fixes plain text link' do
+          expect(response.body).not_to match(/href="plain.html"/)
+          expect(response.body).to match(/href="#{Regexp.escape letter_path(id:, style: 'plain')}"/)
+        end
+      end
+
+      context 'plain text version' do
+        include_examples 'found letter examples', 'plain'
+
+        it 'renders the plain text contents' do
+          expect(response.body).to match(/^plain text/)
+        end
+
+        it 'fixes rich text link' do
+          expect(response.body).not_to match(/href="rich.html"/)
+          expect(response.body).to match(/href="#{Regexp.escape letter_path(id:, style: 'rich')}"/)
+        end
+      end
+
+      context 'with wrong parameters' do
+        it 'should return 404 when invalid id given' do
+          letter = double(:letter, attachments: {}, valid?: false)
+          allow(LetterOpenerWeb::AwsLetter).to receive(:find).with(id).and_return(letter)
+
+          get :show, params: { id:, style: 'rich' }
+          expect(response.status).to eq(404)
+        end
+      end
+    end
+
+    describe 'GET attachment' do
+      let(:id)              { 'an-id' }
+      let(:attachment_path) { 'path/to/attachment' }
+      let(:file_name)       { 'image.jpg' }
+      let(:letter)          { double(:letter, attachments: { file_name => attachment_path }, id:) }
+
+      before do
+        allow(LetterOpenerWeb::AwsLetter).to receive(:find).with(id).and_return(letter)
+        allow(letter).to receive(:valid?).and_return(true)
+      end
+
+      it 'redirects to the s3 file' do
+        allow(controller).to receive(:redirect_to) { controller.head :found }
+        get :attachment, params: { id:, file: file_name.gsub(/\.\w+/, ''), format: File.extname(file_name)[1..] }
+
+        expect(response.status).to eq(302)
+        expect(controller).to have_received(:redirect_to)
+          .with(attachment_path, allow_other_host: true)
+      end
+
+      it "throws a 404 if attachment file can't be found" do
+        get :attachment, params: { id:, file: 'unknown', format: 'woot' }
+        expect(response.status).to eq(404)
+      end
+    end
+
+    describe 'DELETE clear' do
+      before { allow(LetterOpenerWeb::AwsLetter).to receive(:destroy_all) }
+
+      it 'removes all letters' do
+        delete :clear
+        expect(LetterOpenerWeb::AwsLetter).to have_received(:destroy_all)
+      end
+
+      it 'redirects back to index' do
+        delete :clear
+        expect(response).to redirect_to(letters_path)
+      end
+    end
+
+    describe 'DELETE destroy' do
+      let(:id) { 'an-id' }
+
+      it 'removes the selected letter' do
+        allow_any_instance_of(LetterOpenerWeb::AwsLetter).to receive(:valid?).and_return(true)
+        expect_any_instance_of(LetterOpenerWeb::AwsLetter).to receive(:delete)
+        delete :destroy, params: { id: }
+      end
+
+      it 'throws a 404 if attachment is not present on s3' do
+        bad_id = '../an-id'
+
+        allow_any_instance_of(LetterOpenerWeb::AwsLetter).to receive(:valid?).and_return(false)
+        expect_any_instance_of(LetterOpenerWeb::AwsLetter).not_to receive(:delete)
+
+        delete :destroy, params: { id: bad_id }
+
+        expect(response.status).to eq(404)
+      end
+    end
+  end
+
+  describe 'GET index' do
+    before do
+      allow(LetterOpenerWeb::Letter).to receive(:search)
+      get :index
+    end
+
+    it 'searches for all letters' do
+      expect(LetterOpenerWeb::Letter).to have_received(:search)
+    end
+
+    it 'returns an HTML 200 response' do
+      expect(response.status).to eq(200)
+      expect(response.content_type).to eq('text/html; charset=utf-8')
+    end
+  end
+
+  describe 'GET show' do
+    let(:id)         { 'an-id' }
+    let(:rich_text)  { 'rich text href="plain.html"' }
+    let(:plain_text) { 'plain text href="rich.html"' }
+    let(:letter)     { double(:letter, rich_text:, plain_text:, id:) }
+
+    shared_examples 'found letter examples' do |letter_style|
+      before(:each) do
+        expect(LetterOpenerWeb::Letter).to receive(:find).with(id).and_return(letter)
+        expect(letter).to receive(:valid?).and_return(true)
+        get :show, params: { id:, style: letter_style }
+      end
+
+      it 'renders an HTML 200 response' do
+        expect(response.status).to eq(200)
+        expect(response.content_type).to eq('text/html; charset=utf-8')
+      end
+    end
+
+    context 'rich text version' do
+      include_examples 'found letter examples', 'rich'
+
+      it 'renders the rich text contents' do
+        expect(response.body).to match(/^rich text/)
+      end
+
+      it 'fixes plain text link' do
+        expect(response.body).not_to match(/href="plain.html"/)
+        expect(response.body).to match(/href="#{Regexp.escape letter_path(id:, style: 'plain')}"/)
+      end
+    end
+
+    context 'plain text version' do
+      include_examples 'found letter examples', 'plain'
+
+      it 'renders the plain text contents' do
+        expect(response.body).to match(/^plain text/)
+      end
+
+      it 'fixes rich text link' do
+        expect(response.body).not_to match(/href="rich.html"/)
+        expect(response.body).to match(/href="#{Regexp.escape letter_path(id:, style: 'rich')}"/)
+      end
+    end
+
+    context 'with wrong parameters' do
+      it 'should return 404 when invalid id given' do
+        get :show, params: { id:, style: 'rich' }
+        expect(response.status).to eq(404)
+      end
+    end
+  end
+
+  describe 'GET attachment' do
+    let(:id)              { 'an-id' }
+    let(:attachment_path) { 'path/to/attachment' }
+    let(:file_name)       { 'image.jpg' }
+    let(:letter)          { double(:letter, attachments: { file_name => attachment_path }, id:) }
+
+    before do
+      allow(LetterOpenerWeb::Letter).to receive(:find).with(id).and_return(letter)
+      allow(letter).to receive(:valid?).and_return(true)
+    end
+
+    it 'sends the file as an inline attachment' do
+      allow(controller).to receive(:send_file) { controller.head :ok }
+      get :attachment, params: { id:, file: file_name.gsub(/\.\w+/, ''), format: File.extname(file_name)[1..] }
+
+      expect(response.status).to eq(200)
+      expect(controller).to have_received(:send_file)
+        .with(attachment_path, filename: file_name, disposition: 'inline')
+    end
+
+    it "throws a 404 if attachment file can't be found" do
+      get :attachment, params: { id:, file: 'unknown', format: 'woot' }
+      expect(response.status).to eq(404)
+    end
+  end
+
+  describe 'DELETE clear' do
+    it 'removes all letters' do
+      expect(LetterOpenerWeb::Letter).to receive(:destroy_all)
+      delete :clear
+    end
+
+    it 'redirects back to index' do
+      delete :clear
+      expect(response).to redirect_to(letters_path)
+    end
+  end
+
+  describe 'DELETE destroy' do
+    let(:id) { 'an-id' }
+
+    it 'removes the selected letter' do
+      allow_any_instance_of(LetterOpenerWeb::Letter).to receive(:valid?).and_return(true)
+      expect_any_instance_of(LetterOpenerWeb::Letter).to receive(:delete)
+      delete :destroy, params: { id: }
+    end
+
+    it 'throws a 404 if attachment is outside of the letters base path' do
+      bad_id = '../an-id'
+
+      allow_any_instance_of(LetterOpenerWeb::Letter).to receive(:valid?).and_return(false)
+      expect_any_instance_of(LetterOpenerWeb::Letter).not_to receive(:delete)
+
+      delete :destroy, params: { id: bad_id }
+
+      expect(response.status).to eq(404)
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link letter_opener_web_manifest.js

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module ApplicationHelper
+end

data/spec/dummy/app/javascript/packs/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative "../config/boot"
+require "rails/commands"

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'boot'
+
+require 'rails'
+# Pick the frameworks you want:
+# require "active_model/railtie"
+# require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+# require "action_mailbox/engine"
+# require "action_text/engine"
+require 'action_view/railtie'
+# require "action_cable/engine"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+require 'letter_opener_web'
+
+module Dummy
+  class Application < Rails::Application
+    config.load_defaults Rails::VERSION::STRING.to_f
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!