mailpeek 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0235196fb58aaf81253349db5403378590dbf0b359a0f553fda33db73dac5072'
-  data.tar.gz: b3646014f52e01d097d60a46dd5ae1cb2468e306af777f3d71bf9106d1b94786
+  metadata.gz: 4514f84574556dabbc17ae49a42be6689297ba535aa4abfdd4ef57151af05ae8
+  data.tar.gz: 2d2958d8a2cf0d050335fb58d93057256f3c3a74d53d704e9424e7b6deb6c54b
 SHA512:
-  metadata.gz: 22786fdb89e523070567fee50898956592bed0ffdfddee8f4da0ffd7d7d4efe8cf6e9ace3bf3a9a5e88ca3028181fb2233241a09eb500ed1ec7d28a1a68b6dc6
-  data.tar.gz: 39fb2a5a99003630057871273c1925da8d059c5364eb5345ae9b151131da32c2399be8b176854f72e8a3e5fb9a51f259ac58ed0302e78317e4b0ef7b581cbdd1
+  metadata.gz: 66ca6a516758ad3140d74d769cd0b62df634ab9dbd76d461bad401f01a49ccb87b226926000ba4b3d86cbb325fb5d419b7bb5996836363fe61b474451b50e0fc
+  data.tar.gz: 5fe63727c42d669e4b84ae4ff87e986f685aec216402b63060f4e9432c62c254c4b433bc2403a6dc1bc95e027bee2ffef15c8f659ebcfcd31a9352a50a85d417

data/.gitignore

@@ -13,3 +13,4 @@ spec/dummy/log/*.log
 spec/dummy/tmp/*
 !spec/dummy/tmp/mailpeek/*
 spec/dummy/.sass-cache
+.ruby-version

data/.rubocop.yml

@@ -1,24 +1,22 @@
 require:
   - rubocop-performance
+  - rubocop-rspec
 
 AllCops:
   Exclude:
     - '**/bin/**/*'
+Layout/LineLength:
+  Max: 80
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
 Metrics/AbcSize:
   Max: 30
-Style/BlockDelimiters:
-  Enabled: false
 Metrics/BlockLength:
   Exclude:
     - '**/spec/**/*'
     - '**/lib/**/*.rake'
 Metrics/ClassLength:
   Max: 150
-Style/Lambda:
-  Exclude:
-    - 'app/models/**/*'
-Layout/LineLength:
-  Max: 80
 Metrics/MethodLength:
   Max: 15
 Metrics/ModuleLength:
@@ -27,10 +25,13 @@ Naming/FileName:
   Exclude:
     - '**/Guardfile'
     - '**/Capfile'
-Lint/AmbiguousBlockAssociation:
+Style/BlockDelimiters:
   Enabled: false
 Style/Documentation:
   Exclude:
     - '**/db/migrate/*'
 Style/EvalWithLocation:
   Enabled: false
+Style/Lambda:
+  Exclude:
+    - 'app/models/**/*'

data/README.md

@@ -7,7 +7,7 @@ Mailpeek provides a web interface to view emails sent out when developing in Rai
 Add to your Gemfile:
 
 ```
-gem 'mailpeek', group: :development
+gem 'mailpeek', group: %i[development test]
 ```
 
 ## Setup
@@ -18,8 +18,24 @@ In your `config/environments/development.rb` file:
 config.action_mailer.delivery_method = :mailpeek
 ```
 
-Then in your `routes.rb` file add this line:
+Then add a file called `config/initializers/mailpeek.rb` with this:
+
+```
+Mailpeek.configure do |config|
+  config.location = Rails.root.join('tmp/mailpeek')
+end
+```
+
+Finally in your `routes.rb` file add this line:
 
 ```
 mount Mailpeek::Web => '/mailpeek' if Rails.env.development?
 ```
+
+## Use
+
+Once an email is sent in a Rails project, either via `deliver_now` or `deliver_later`.  You can then view the email by visiting:
+
+```
+http://localhost:3000/mailpeek
+```

data/lib/mailpeek/configuration.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
-require 'mail/check_delivery_params'
-
 module Mailpeek
   # Public: Stores config info for Mailpeek
   class Configuration
     attr_accessor :location, :limit
 
     def initialize
-      @location = Rails.root.join('tmp', 'mailpeek')
+      @location = Dir.mktmpdir('mailpeek')
       @limit = 50
     end
   end

data/lib/mailpeek/delivery.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require 'mail/check_delivery_params'
-
 module Mailpeek
-  # Public: Delivery
+  # Public: Handles consuming emails, checking configuration, creating
+  # directories, cleaning up emails and saving attachments
   class Delivery
-    include Mail::CheckDeliveryParams if defined?(Mail::CheckDeliveryParams)
-
     class InvalidOption < StandardError; end
 
     attr_accessor :settings
@@ -17,40 +14,34 @@ module Mailpeek
       options[:limit] = options[:limit].to_i
 
       if options[:location].nil?
-        raise InvalidOption, 'A location option is required when using Mailpeek'
+        raise InvalidOption, 'The Mailpeek location option is required'
       end
 
-      # rubocop:disable Style/GuardClause
-      if options[:limit].nil?
-        raise InvalidOption, 'A limit option is required when using Mailpeek'
-      elsif options[:limit] <= 0
-        raise InvalidOption, 'A limit option is an invalid number'
+      if options[:limit] <= 0
+        raise InvalidOption, 'The Mailpeek limit option is an invalid number'
       end
 
-      # rubocop:enable Style/GuardClause
-
       self.settings = options
     end
 
     def deliver!(mail)
-      check_delivery_params(mail) if respond_to?(:check_delivery_params)
-
       clean_up
 
-      basepath = File.join(settings[:location], Time.now.to_i.to_s)
+      timestamp = Time.now.to_i.to_s
+
+      basepath = File.join(settings[:location], timestamp)
 
       save_email(mail, basepath)
 
-      return true unless mail.attachments.any?
+      add_attachments(mail, basepath) if mail.attachments.any?
 
-      add_attachments(mail, basepath)
+      timestamp
     end
 
     private
 
+    # remove oldest email if over `limit` settings
     def clean_up
-      # remove oldest email if over `limit` settings
-
       directory = File.join(settings[:location], '*')
       return if Dir[directory].length < settings[:limit]
 
@@ -60,8 +51,8 @@ module Mailpeek
     def save_email(mail, basepath)
       FileUtils.mkdir_p(basepath)
 
-      File.open(File.join(basepath, 'mail'), 'w') do |f|
-        f.write mail.to_s
+      File.open(File.join(basepath, 'mail'), 'w') do |file|
+        file.write(mail.to_s)
       end
     end
 

data/lib/mailpeek/email.rb

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
 
-require 'mail/check_delivery_params'
-
 module Mailpeek
   # Public: Wrapper class for mail object
   class Email
     attr_reader(
-      :id, :position, :mail, :html, :text, :attachments, :to, :from, :subject,
-      :message_id, :date
+      :attachments,
+      :date,
+      :from,
+      :html,
+      :id,
+      :mail,
+      :message_id,
+      :position,
+      :subject,
+      :text,
+      :to,
     )
 
     def initialize(timestamp, mail)
@@ -21,11 +28,7 @@ module Mailpeek
       @date        = mail.date
       @attachments = []
 
-      if mail.multipart?
-        parse_parts
-      else
-        parse_body
-      end
+      mail.multipart? ? parse_parts : parse_body
     end
 
     def match?(query)
@@ -33,9 +36,7 @@ module Mailpeek
     end
 
     def destroy
-      location = Mailpeek.configuration.location
-
-      FileUtils.rm_rf("#{location}/#{id}")
+      FileUtils.rm_rf("#{Mailpeek.configuration.location}/#{id}")
     end
 
     def read

data/lib/mailpeek/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mailpeek
-  VERSION = '1.0.2'
+  VERSION = '1.0.4'
 end

data/lib/mailpeek/web/action.rb

@@ -18,7 +18,7 @@ module Mailpeek
     end
 
     def redirect(location)
-      throw :halt, [302, { 'Location' => "#{request.base_url}#{location}" }, []]
+      halt([302, { 'Location' => "#{request.base_url}#{location}" }, []])
     end
 
     def params
@@ -89,9 +89,7 @@ module Mailpeek
       @env = env
       @block = block
 
-      # rubocop:disable Style/ClassVars
-      @@files ||= {}
-      # rubocop:enable Style/ClassVars
+      # @@files ||= {}
     end
 
     private

data/lib/mailpeek/web/helpers.rb

@@ -37,10 +37,6 @@ module Mailpeek
       @query_string ||= request.query_string
     end
 
-    def current_path
-      @current_path ||= request.path_info.gsub(%r{^\/}, '')
-    end
-
     def h(text)
       ::Rack::Utils.escape_html(text)
     rescue ArgumentError => e

data/lib/mailpeek/web.rb

@@ -10,7 +10,7 @@ require 'mailpeek/web/application'
 require 'rack/protection'
 
 require 'rack/builder'
-require 'rack/file'
+require 'rack/files'
 
 # Public: Mailpeek
 module Mailpeek
@@ -114,7 +114,7 @@ module Mailpeek
       ::Rack::Builder.new do
         %w[stylesheets javascripts images].each do |asset_dir|
           map "/#{asset_dir}" do
-            run ::Rack::File.new(
+            run ::Rack::Files.new(
               "#{ASSETS}/#{asset_dir}",
               'Cache-Control' => 'public, max-age=86400'
             )

data/lib/mailpeek.rb

@@ -8,8 +8,9 @@ require 'mailpeek/web'
 require 'mailpeek/version'
 
 require 'json'
+require 'tmpdir'
 
-# Public: Mailpeek
+# Public: Mailpeek Base Class
 module Mailpeek
   def self.configuration
     @configuration ||= Configuration.new

data/mailpeek.gemspec

@@ -19,14 +19,18 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files`.split("\n")
 
-  # s.test_files = Dir['spec/**/*']
+  s.test_files = Dir['spec/**/*']
 
-  s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 3.0.0'
 
-  s.add_dependency 'mail', '~> 2.7'
-  s.add_dependency 'rack', '~> 2.0'
-  s.add_dependency 'rack-protection', '~> 2.0'
+  s.add_dependency 'mail', '~> 2'
+  s.add_dependency 'rack', '~> 3'
+  s.add_dependency 'rack-protection', '~> 4'
 
-  s.add_development_dependency 'rubocop', '~> 0.79'
-  s.add_development_dependency 'rubocop-performance', '~> 1.5'
+  s.add_development_dependency 'faker'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'simplecov'
 end

data/spec/mailpeek/delivery_spec.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+describe Mailpeek::Delivery do
+  subject(:delivery) { described_class.new(options) }
+
+  let(:options) { {} }
+
+  describe '#new' do
+    let(:configuration) { Mailpeek::Configuration.new }
+
+    it 'sets settings to default configuration' do
+      settings = {
+        limit: Mailpeek.configuration.limit,
+        location: Mailpeek.configuration.location
+      }
+
+      expect(delivery.settings).to eq settings
+    end
+
+    context 'without location option' do
+      before do
+        configuration.location = nil
+
+        allow(Mailpeek).to receive(:configuration).and_return(configuration)
+      end
+
+      it 'raises InvalidOption' do
+        expect { delivery }.to raise_error(Mailpeek::Delivery::InvalidOption)
+      end
+    end
+
+    context 'without limit option' do
+      before do
+        configuration.limit = nil
+
+        allow(Mailpeek).to receive(:configuration).and_return(configuration)
+      end
+
+      it 'raises InvalidOption' do
+        expect { delivery }.to raise_error(Mailpeek::Delivery::InvalidOption)
+      end
+    end
+
+    context 'with limit set to non-number' do
+      before do
+        configuration.limit = 'invalid'
+
+        allow(Mailpeek).to receive(:configuration).and_return(configuration)
+      end
+
+      it 'raises InvalidOption' do
+        expect { delivery }.to raise_error(Mailpeek::Delivery::InvalidOption)
+      end
+    end
+  end
+
+  describe '#deliver!' do
+    let(:path) { "./spec/support/emails/#{id}/mail" }
+    let(:mail) { ::Mail.read(path) }
+    let(:timestamp) { delivery.deliver!(mail) }
+    let(:basepath) { File.join(Mailpeek.configuration.location, timestamp) }
+    let(:file) { instance_double('File') }
+
+    before do
+      mail # declare first so our File stubs don't get in the way
+
+      allow(FileUtils).to receive(:mkdir_p).and_return(true)
+
+      allow(file).to receive(:write).and_return(file)
+      allow(File).to receive(:open).and_yield(file)
+    end
+
+    context 'with email without attachments' do
+      let(:id) { 'html_and_text' }
+
+      it 'returns a timestamp' do
+        expect(timestamp).to be_truthy
+      end
+
+      it 'creates a directory' do
+        timestamp
+
+        expect(FileUtils).to have_received(:mkdir_p).with(basepath).once
+      end
+
+      it 'opens a file' do
+        timestamp
+
+        expect(File).to(
+          have_received(:open).with(File.join(basepath, 'mail'), 'w').once
+        )
+      end
+
+      it 'saves a file' do
+        timestamp
+
+        expect(file).to have_received(:write).once
+      end
+    end
+
+    context 'with attachment email' do
+      let(:id) { 'html_text_and_attachment' }
+
+      it 'returns a timestamp' do
+        expect(timestamp).to be_truthy
+      end
+
+      it 'creates 2 directories' do
+        timestamp
+
+        expect(FileUtils).to have_received(:mkdir_p).twice
+      end
+
+      it 'opens 2 files' do
+        timestamp
+
+        expect(File).to have_received(:open).twice
+      end
+
+      it 'saves 2 files' do
+        timestamp
+
+        expect(file).to have_received(:write).twice
+      end
+    end
+  end
+end

data/spec/mailpeek/email_spec.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+describe Mailpeek::Email do
+  subject(:email) { described_class.new(id, ::Mail.read(path)) }
+
+  let(:path) { "./spec/support/emails/#{id}/mail" }
+  let(:id) { 'html_and_text' }
+
+  describe '#new' do
+    context 'with html and text email' do
+      it 'sets html' do
+        expect(email.html.nil?).to eq false
+      end
+
+      it 'sets text' do
+        expect(email.text.nil?).to eq false
+      end
+
+      it 'has 0 attachments' do
+        expect(email.attachments.empty?).to eq true
+      end
+    end
+
+    context 'with text email' do
+      let(:id) { 'text' }
+
+      it 'does not set html' do
+        expect(email.html.nil?).to eq true
+      end
+
+      it 'sets text' do
+        expect(email.text.nil?).to eq false
+      end
+
+      it 'has 0 attachments' do
+        expect(email.attachments.empty?).to eq true
+      end
+    end
+
+    context 'with html email' do
+      let(:id) { 'html' }
+
+      it 'sets html' do
+        expect(email.html.nil?).to eq false
+      end
+
+      it 'does not set text' do
+        expect(email.text.nil?).to eq true
+      end
+
+      it 'has 0 attachments' do
+        expect(email.attachments.empty?).to eq true
+      end
+    end
+
+    context 'with html, text and attachment email' do
+      let(:id) { 'html_text_and_attachment' }
+
+      it 'sets html' do
+        expect(email.html.nil?).to eq false
+      end
+
+      it 'sets text' do
+        expect(email.text.nil?).to eq false
+      end
+
+      it 'has attachments' do
+        expect(email.attachments.empty?).to eq false
+      end
+    end
+  end
+
+  describe '#match?' do
+    let(:results) { email.match?(query) }
+
+    context 'with valid query' do
+      let(:query) { 'Itaque' }
+
+      it 'returns true' do
+        expect(results).to be_truthy
+      end
+    end
+
+    context 'with invalid query' do
+      let(:query) { 'Invalid' }
+
+      it 'returns true' do
+        expect(results).to be_falsey
+      end
+    end
+  end
+
+  describe '#destroy' do
+    before do
+      allow(FileUtils).to receive(:rm_rf).and_return(true)
+    end
+
+    it 'returns true' do
+      expect(email.destroy).to eq true
+    end
+
+    it 'removes directory' do
+      email.destroy
+
+      with = "#{Mailpeek.configuration.location}/#{id}"
+
+      expect(FileUtils).to have_received(:rm_rf).with(with).once
+    end
+  end
+
+  describe '#read' do
+    context 'with read email' do
+      it 'returns true' do
+        expect(email.read).to eq true
+      end
+    end
+
+    context 'with unread email' do
+      let(:id) { 'text' }
+
+      it 'returns false' do
+        expect(email.read).to eq false
+      end
+    end
+  end
+
+  describe '#read=' do
+    context 'with read email' do
+      after do
+        email.read = true
+      end
+
+      it 'unreads file' do
+        email.read = false
+        expect(email.read).to eq false
+      end
+    end
+
+    context 'with unread email' do
+      let(:id) { 'html' }
+
+      after do
+        email.read = false
+      end
+
+      it 'unreads file' do
+        email.read = true
+        expect(email.read).to eq true
+      end
+    end
+  end
+end

data/spec/mailpeek/mailpeek_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+describe Mailpeek do
+  describe '.emails' do
+    it 'returns all emails' do
+      expect(described_class.emails.size).to eq 4
+    end
+  end
+
+  describe '.unread' do
+    it 'returns count of unread emails' do
+      expect(described_class.unread).to eq 3
+    end
+  end
+
+  describe '.email' do
+    let(:id) { 'html_and_text' }
+
+    it 'returns email by id' do
+      expect(described_class.email(id).id).to eq id
+    end
+  end
+
+  describe '.prep_folder' do
+    it 'creates folder to store emails, if does not exist' do
+      allow(File).to receive(:directory?).and_return(false)
+      allow(FileUtils).to receive(:mkdir_p).and_return(true)
+
+      described_class.prep_folder
+
+      location = described_class.configuration.location
+
+      expect(FileUtils).to have_received(:mkdir_p).with(location).once
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+
+SimpleCov.start do
+  # add_group 'Group', 'lib/mailpeek'
+end
+
+require 'mailpeek'
+require 'faker'
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.before do
+    Mailpeek.configure do |c|
+      c.location = File.dirname(__FILE__) + '/support/emails'
+    end
+  end
+end

data/spec/support/emails/html/mail

@@ -0,0 +1,19 @@
+Date: Fri, 31 Jan 2020 11:06:52 -0700
+From: trudi@rutherford.com
+To: erika@schmidt.biz
+Message-ID: <5e346cbc64b6a_112ab1096aef5c4633b@f14030d40a1c.mail>
+Subject: Eligendi nihil reprehenderit exercitationem.
+Mime-Version: 1.0
+Content-Type: text/html;
+ charset=UTF-8
+Content-Transfer-Encoding: 7bit
+
+<html>
+  <body>
+    <h3>Sequi</h3>
+    
+    <p>Consequatur dolorem quia. Dolore architecto rerum. Et rerum exercitationem.<br>
+    0. In.</p>
+    
+  </body>
+</html>