RubyGems - letter_opener_web_wally - Versions diffs - 2.0.1 - Mend

letter_opener_web_wally 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (93) hide show

checksums.yaml +7 -0
data/.github/workflows/brakeman-analysis.yml +36 -0
data/.github/workflows/main.yml +29 -0
data/.github/workflows/release-gem.yml +32 -0
data/.gitignore +20 -0
data/.rspec +4 -0
data/.rubocop.yml +29 -0
data/.rubocop_todo.yml +19 -0
data/CHANGELOG.md +95 -0
data/Gemfile +8 -0
data/LICENSE.txt +0 -0
data/README.md +176 -0
data/Rakefile +10 -0
data/app/controllers/letter_opener_web/application_controller.rb +7 -0
data/app/controllers/letter_opener_web/letters_controller.rb +77 -0
data/app/models/letter_opener_web/aws_letter.rb +98 -0
data/app/models/letter_opener_web/base_letter.rb +93 -0
data/app/models/letter_opener_web/letter.rb +54 -0
data/app/models/letter_opener_web/s3_message.rb +25 -0
data/app/views/layouts/letter_opener_web/_javascripts.html.erb +31 -0
data/app/views/layouts/letter_opener_web/_styles.html.erb +3 -0
data/app/views/layouts/letter_opener_web/js/_favcount.html.erb +104 -0
data/app/views/layouts/letter_opener_web/js/_jquery.html.erb +7 -0
data/app/views/layouts/letter_opener_web/letters.html.erb +15 -0
data/app/views/layouts/letter_opener_web/styles/_bootstrap.html.erb +9 -0
data/app/views/layouts/letter_opener_web/styles/_icon.html.erb +2 -0
data/app/views/layouts/letter_opener_web/styles/_letters.html.erb +70 -0
data/app/views/letter_opener_web/letters/_item.html.erb +10 -0
data/app/views/letter_opener_web/letters/index.html.erb +24 -0
data/bin/setup +6 -0
data/config/routes.rb +9 -0
data/letter_opener_web.gemspec +35 -0
data/lib/letter_opener_web/delivery_method.rb +29 -0
data/lib/letter_opener_web/engine.rb +20 -0
data/lib/letter_opener_web/version.rb +5 -0
data/lib/letter_opener_web.rb +52 -0
data/script/pre-push +2 -0
data/spec/controllers/letter_opener_web/letters_controller_spec.rb +282 -0
data/spec/dummy/Rakefile +8 -0
data/spec/dummy/app/assets/config/manifest.js +3 -0
data/spec/dummy/app/assets/images/.keep +0 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/channels/application_cable/channel.rb +6 -0
data/spec/dummy/app/channels/application_cable/connection.rb +6 -0
data/spec/dummy/app/controllers/application_controller.rb +4 -0
data/spec/dummy/app/controllers/concerns/.keep +0 -0
data/spec/dummy/app/helpers/application_helper.rb +4 -0
data/spec/dummy/app/javascript/packs/application.js +15 -0
data/spec/dummy/app/jobs/application_job.rb +9 -0
data/spec/dummy/app/mailers/application_mailer.rb +6 -0
data/spec/dummy/app/models/application_record.rb +5 -0
data/spec/dummy/app/models/concerns/.keep +0 -0
data/spec/dummy/app/views/layouts/application.html.erb +15 -0
data/spec/dummy/app/views/layouts/mailer.html.erb +13 -0
data/spec/dummy/app/views/layouts/mailer.text.erb +1 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/bin/setup +33 -0
data/spec/dummy/config/application.rb +37 -0
data/spec/dummy/config/boot.rb +7 -0
data/spec/dummy/config/environment.rb +7 -0
data/spec/dummy/config/environments/development.rb +78 -0
data/spec/dummy/config/environments/production.rb +122 -0
data/spec/dummy/config/environments/test.rb +61 -0
data/spec/dummy/config/initializers/application_controller_renderer.rb +10 -0
data/spec/dummy/config/initializers/assets.rb +14 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +10 -0
data/spec/dummy/config/initializers/content_security_policy.rb +30 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +7 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +8 -0
data/spec/dummy/config/initializers/inflections.rb +18 -0
data/spec/dummy/config/initializers/mime_types.rb +6 -0
data/spec/dummy/config/initializers/permissions_policy.rb +13 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +16 -0
data/spec/dummy/config/locales/en.yml +33 -0
data/spec/dummy/config/puma.rb +45 -0
data/spec/dummy/config/routes.rb +5 -0
data/spec/dummy/config.ru +8 -0
data/spec/dummy/lib/assets/.keep +0 -0
data/spec/dummy/log/.keep +0 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/apple-touch-icon-precomposed.png +0 -0
data/spec/dummy/public/apple-touch-icon.png +0 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/storage/.keep +0 -0
data/spec/letter_opener_web_spec.rb +47 -0
data/spec/models/letter_opener_web/aws_letter_spec.rb +196 -0
data/spec/models/letter_opener_web/letter_spec.rb +184 -0
data/spec/rails_helper.rb +8 -0
data/spec/spec_helper.rb +8 -0
metadata +291 -0

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/apple-touch-icon-precomposed.png ADDED Viewed

File without changes

data/spec/dummy/public/apple-touch-icon.png ADDED Viewed

File without changes

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/dummy/storage/.keep ADDED Viewed

File without changes

data/spec/letter_opener_web_spec.rb ADDED Viewed

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'rails_helper'
+RSpec.describe LetterOpenerWeb do
+  subject { described_class }
+  after(:each) { described_class.reset! }
+  describe '.config' do
+    it 'sets default letters_storage' do
+      expect(subject.config.letters_storage).to eq(:local)
+    end
+    it 'sets default letters_location' do
+      expect(subject.config.letters_location).to eq(Rails.root.join('tmp', 'letter_opener'))
+    end
+  end
+  describe '.configure' do
+    it 'yields config to the block' do
+      subject.configure do |config|
+        expect(config).to eq(subject.config)
+      end
+    end
+    it 'retains settings set within the block' do
+      subject.configure do |config|
+        config.letters_location = 'tmp/test_path'
+      end
+      expect(subject.config.letters_location).to eq('tmp/test_path')
+    end
+  end
+  describe '.reset!' do
+    it 'resets configuration' do
+      subject.configure do |config|
+        config.letters_location = 'tmp/test_path'
+      end
+      subject.reset!
+      expected = Rails.root.join('tmp', 'letter_opener')
+      expect(subject.config.letters_location).to eq(expected)
+    end
+  end
+end

data/spec/models/letter_opener_web/aws_letter_spec.rb ADDED Viewed

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+RSpec.describe LetterOpenerWeb::AwsLetter do
+  subject { described_class.new(id: letter_id) }
+  let(:aws_access_key_id)     { 'aws_access_key_id' }
+  let(:aws_secret_access_key) { 'aws_secret_access_key' }
+  let(:aws_region)            { 'aws_region' }
+  let(:aws_bucket)            { 'aws_bucket' }
+  let(:letter_id)             { 'letter_id' }
+  let(:letters_location)      { nil }
+  let(:s3_client) do
+    instance_double(Aws::S3::Client)
+  end
+  before :each do
+    LetterOpenerWeb.configure do |config|
+      config.letters_storage = :s3
+      config.letters_location = letters_location
+      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
+    end
+    allow(Aws::S3::Client)
+      .to receive(:new)
+      .with(
+        access_key_id: aws_access_key_id,
+        secret_access_key: aws_secret_access_key,
+        region: aws_region
+      )
+      .and_return(s3_client)
+  end
+  after :each do
+    LetterOpenerWeb.reset!
+  end
+  describe '#letters_location' do
+    subject { described_class.letters_location }
+    context 'with a nil given value in LetterOpenerWeb.configure' do
+      let(:letters_location) { nil }
+      it { is_expected.to eq(nil) }
+    end
+    context 'with any value in LetterOpenerWeb.configure' do
+      let(:letters_location) { 'letters_location' }
+      it { is_expected.to eq(letters_location) }
+    end
+  end
+  describe '#search' do
+    it 'returns all letters', aggregates_failure: true do
+      expect(s3_client)
+        .to receive(:list_objects_v2)
+        .with(bucket: aws_bucket, prefix: '', delimiter: '.html')
+        .and_return(
+          instance_double(Aws::S3::Types::ListObjectsV2Output, common_prefixes: [
+                            instance_double(Aws::S3::Types::CommonPrefix,
+                                            prefix: 'location/to/letters/1111_1111/toto.html'),
+                            instance_double(Aws::S3::Types::CommonPrefix, prefix: '2222_2222/toto.html')
+                          ])
+        )
+      letters = described_class.search
+      expect(letters.size).to eq(2)
+      expect(letters.first.id).to eq('2222_2222')
+      expect(letters.last.id).to eq('1111_1111')
+    end
+  end
+  describe '#destroy_all' do
+    let(:s3_content) { instance_double(Aws::S3::Types::Object, key: '123') }
+    it 'removes all letters', aggregates_failure: true do
+      expect(s3_client)
+        .to receive(:list_objects_v2)
+        .with(bucket: aws_bucket, prefix: '')
+        .and_return(
+          instance_double(Aws::S3::Types::ListObjectsV2Output, contents: [s3_content])
+        )
+      expect(s3_client)
+        .to receive(:delete_objects)
+        .with(
+          bucket: aws_bucket,
+          delete: {
+            objects: [key: s3_content.key],
+            quiet: false
+          }
+        )
+      described_class.destroy_all
+    end
+  end
+  describe '.delete' do
+    let(:s3_content) { instance_double(Aws::S3::Types::Object, key: '123') }
+    it 'does not remove letter if it does not exist', aggregates_failure: true do
+      expect(s3_client)
+        .to receive(:list_objects_v2)
+        .with(bucket: aws_bucket, prefix: letter_id)
+        .and_return(
+          instance_double(Aws::S3::Types::ListObjectsV2Output, contents: [])
+        )
+      expect(s3_client)
+        .not_to receive(:delete_objects)
+      subject.delete
+    end
+    it 'removes letter if it exists' do
+      expect(s3_client)
+        .to receive(:list_objects_v2)
+        .with(bucket: aws_bucket, prefix: letter_id)
+        .and_return(
+          instance_double(Aws::S3::Types::ListObjectsV2Output, contents: [s3_content])
+        )
+        .twice
+      expect(s3_client)
+        .to receive(:delete_objects)
+        .with(
+          bucket: aws_bucket,
+          delete: {
+            objects: [key: s3_content.key],
+            quiet: false
+          }
+        )
+      subject.delete
+    end
+  end
+  describe '.valid?' do
+    it 'returns true if the letter exists' do
+      expect(s3_client)
+        .to receive(:list_objects_v2)
+        .with(bucket: aws_bucket, prefix: letter_id)
+        .and_return(
+          instance_double(Aws::S3::Types::ListObjectsV2Output, contents: [
+                            instance_double(Aws::S3::Types::Object)
+                          ])
+        )
+      expect(subject).to be_valid
+    end
+    it 'returns false if the letter does not exist' do
+      expect(s3_client)
+        .to receive(:list_objects_v2)
+        .with(bucket: aws_bucket, prefix: letter_id)
+        .and_return(
+          instance_double(Aws::S3::Types::ListObjectsV2Output, contents: [])
+        )
+      expect(subject).not_to be_valid
+    end
+  end
+  describe '.attachments' do
+    let(:s3_content)    { instance_double(Aws::S3::Types::Object, key: '123') }
+    let(:presigned_url) { 'https://presigned-url' }
+    let(:s3_bucket)     { instance_double(Aws::S3::Bucket, object: double) }
+    let(:s3_object)     { instance_double(Aws::S3::Object, presigned_url: double) }
+    it 'returns attachments with presigned urls' do
+      expect(s3_client)
+        .to receive(:list_objects_v2)
+        .with(bucket: aws_bucket, prefix: "#{letter_id}/attachments/")
+        .and_return(
+          instance_double(Aws::S3::Types::ListObjectsV2Output, contents: [s3_content])
+        )
+      expect(Aws::S3::Bucket)
+        .to receive(:new)
+        .with(name: aws_bucket, client: s3_client)
+        .and_return(s3_bucket)
+      expect(s3_bucket)
+        .to receive(:object)
+        .with(s3_content.key)
+        .and_return(s3_object)
+      expect(s3_object)
+        .to receive(:presigned_url)
+        .with(:get, expires_in: 1.week.to_i)
+        .and_return(presigned_url)
+      expect(subject.attachments).to eq(s3_content.key => presigned_url)
+    end
+  end
+end

data/spec/models/letter_opener_web/letter_spec.rb ADDED Viewed

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+RSpec.describe LetterOpenerWeb::Letter do
+  let(:location) { Pathname.new(__dir__).join('..', '..', 'tmp').cleanpath }
+  def rich_text(mail_id)
+    <<~MAIL
+      Rich text for #{mail_id}
+      <!DOCTYPE html>
+      <body>
+        <div id="container">
+          <div id="message_headers">
+            <dl>
+              <dt>From:</dt>
+              <dd>noreply@example.com</dd>
+            </dl>
+          </div>
+          <a href='a-link.html'>
+            <img src='an-image.jpg'>
+            Link text
+          </a>
+          <a href='fooo.html'>Bar</a>
+          <a href="example.html" class="blank"></a>
+          <address><a href="inside-address.html">inside address</a></address>
+        </div>
+      </body>
+    MAIL
+  end
+  before :each do
+    LetterOpenerWeb.configure { |config| config.letters_location = location }
+    %w[1111_1111 2222_2222].each do |folder|
+      FileUtils.mkdir_p("#{location}/#{folder}")
+      File.write("#{location}/#{folder}/plain.html", "Plain text for #{folder}")
+      File.write("#{location}/#{folder}/rich.html", rich_text(folder))
+      FileUtils.mkdir_p("#{Rails.root.join('tmp', 'letter_opener')}/#{folder}")
+      File.write("#{Rails.root.join('tmp', 'letter_opener')}/#{folder}/rich.html", "Rich text for #{folder}")
+    end
+  end
+  after :each do
+    LetterOpenerWeb.reset!
+    FileUtils.rm_rf(location)
+  end
+  describe 'rich text headers' do
+    let(:id) { '1111_1111' }
+    subject { described_class.new(id:).headers }
+    before do
+      FileUtils.rm_rf("#{location}/#{id}/plain.html")
+    end
+    it { is_expected.to match(%r{<dl>\s*<dt>From:</dt>\s*<dd>noreply@example\.com</dd>}m) }
+  end
+  describe 'plain text headers' do
+    let(:id) { '1111_1111' }
+    subject { described_class.new(id:).headers }
+    before do
+      FileUtils.rm_rf("#{location}/#{id}/rich.html")
+    end
+    it { is_expected.to eq('UNABLE TO PARSE HEADERS') }
+  end
+  describe 'rich text version' do
+    let(:id) { '1111_1111' }
+    subject { described_class.new(id:).rich_text }
+    it { is_expected.to match(/Rich text for 1111_1111/) }
+    it 'changes links to show up on a new window' do
+      link_html = [
+        "<a href='a-link.html' target='_blank'>",
+        "  <img src='an-image.jpg'/>",
+        '  Link text',
+        '</a>'
+      ].join("\n    ")
+      expect(subject).to include(link_html)
+    end
+    it 'always rewrites links with a closing tag rather than making them selfclosing' do
+      expect(subject).to include("<a class='blank' href='example.html' target='_blank'></a>")
+    end
+  end
+  describe 'plain text version' do
+    let(:id) { '2222_2222' }
+    subject { described_class.new(id:).plain_text }
+    it { is_expected.to match(/Plain text for 2222_2222/) }
+  end
+  describe 'default style' do
+    let(:id) { '2222_2222' }
+    subject { described_class.new(id:) }
+    it 'returns rich if rich text version is present' do
+      expect(subject.default_style).to eq('rich')
+    end
+    it 'returns plain if rich text version is not present' do
+      allow(File).to receive_messages(exist?: false)
+      expect(subject.default_style).to eq('plain')
+    end
+  end
+  describe 'attachments' do
+    let(:file)            { 'an-image.csv' }
+    let(:attachments_dir) { "#{location}/#{id}/attachments" }
+    let(:id)              { '1111_1111' }
+    subject { described_class.new(id:) }
+    before do
+      FileUtils.mkdir_p(attachments_dir)
+      File.open("#{attachments_dir}/#{file}", 'w') { |f| f.puts 'csv,contents' }
+    end
+    it 'builds a hash with file name as key and full path as value' do
+      expect(subject.attachments).to eq(file => "#{attachments_dir}/#{file}")
+    end
+  end
+  describe '.search' do
+    let(:search_results) { described_class.search }
+    let(:first_letter)   { search_results.first }
+    let(:last_letter)    { search_results.last }
+    before do
+      allow(File).to receive(:mtime).with("#{location}/1111_1111").and_return(Date.today - 1.day)
+      allow(File).to receive(:mtime).with("#{location}/2222_2222").and_return(Date.today)
+    end
+    it 'returns a list of ordered letters' do
+      expect(first_letter.sent_at).to be > last_letter.sent_at
+    end
+  end
+  describe '.find' do
+    let(:id)     { 'an-id' }
+    let(:letter) { described_class.find(id) }
+    it 'returns a letter with id set' do
+      expect(letter.id).to eq(id)
+    end
+  end
+  describe '.destroy_all' do
+    it 'removes all letters' do
+      described_class.destroy_all
+      expect(Dir["#{location}/**/*"]).to be_empty
+    end
+  end
+  describe '#delete' do
+    let(:id) { '1111_1111' }
+    subject { described_class.new(id:).delete }
+    it 'removes the letter with given id' do
+      subject
+      directories = Dir["#{location}/*"]
+      expect(directories.count).to eql(1)
+      expect(directories.first).not_to match(id)
+    end
+    context 'when the id is outside of the letters base path' do
+      let(:id) { '../3333_3333' }
+      it 'does not remove the letter' do
+        expect(FileUtils).not_to receive(:rm_rf).with(location.join(id).cleanpath.to_s)
+        expect(subject).to be_nil
+      end
+    end
+  end
+end

data/spec/rails_helper.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('dummy/config/environment', __dir__)
+require 'spec_helper'
+require 'rspec/rails'
+RSpec.configure(&:infer_spec_type_from_file_location!)

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'shoulda-matchers'
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end