mailpeek 0.0.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b243a8e91699e454889e3ccbd018a180afdc70e9
-  data.tar.gz: ac5340075d3ce7ac48c78f490d1d356b4d4bc69d
+SHA256:
+  metadata.gz: 861ea94d5c5fb58fbf5ee3f2a8435a86e1d1bda405b2e669376056b99648ca44
+  data.tar.gz: 5e2236e055fdd976c2a8f8fbf88f962bfbf5a7511fa7b159067538e88ff81bdf
 SHA512:
-  metadata.gz: 723eaa85e2d7bacb041b479519cbd5d09a9e24d1711b810c188f997707d23b755b66df66bd9e76d4f713413876f00fe02fd30d5f3e843a40d420489a3db73c6e
-  data.tar.gz: c8683bd2e3d1686863070dcc1922e699c3e3d6a0f5c94fd733f4ca4d9e6fbc72c0d9ede8aa9f3b235f0a8738c0b4090c3c6448117952e40e82e20a144d9e7f4c
+  metadata.gz: 2b8fe75a85a85f18b97988184394cd019df54ae9d3f528a8ee1e6beffcf25d71892ceacd81b099ba66420b4b8fbf73d4cce6ad6e08efc92f8c01233c9252b3f1
+  data.tar.gz: 777b60620eb1032bf3cc994444a9ca974498b1e9c1dace1de91739e44bbf5d36d6546317c27754011980d60e84563e61ceaa8cc40ce7cbf8c97e1f7189ba6198

data/.gitignore

@@ -0,0 +1,15 @@
+.bundle/
+log/*.log
+pkg/
+*.gem
+coverage/
+node_modules/
+stats.json
+Gemfile.lock
+
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/*
+!spec/dummy/tmp/mailpeek/*
+spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,36 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  Exclude:
+    - '**/bin/**/*'
+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:
+  Max: 150
+Naming/FileName:
+  Exclude:
+    - '**/Guardfile'
+    - '**/Capfile'
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+Style/Documentation:
+  Exclude:
+    - '**/db/migrate/*'
+Style/EvalWithLocation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in mailpeek.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rogue Pod
+
+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,25 @@
+# Mailpeek
+
+Mailpeek provides a web interface to view emails sent out when developing in Rails.
+
+## Installation
+
+Add to your Gemfile:
+
+```
+gem 'mailpeek', group: :development
+```
+
+## Setup
+
+In your `config/environments/development.rb` file:
+
+```
+config.action_mailer.delivery_method = :mailpeek
+```
+
+Then in your `routes.rb` file add this line:
+
+```
+mount Mailpeek::Web => '/mailpeek' if Rails.env.development?
+```

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,7 +16,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 
 load 'rails/tasks/engine.rake'
 load 'rails/tasks/statistics.rake'

data/lib/mailpeek.rb

@@ -1,6 +1,66 @@
-require 'mailpeek/engine'
+# frozen_string_literal: true
+
+require 'mail'
+require 'mailpeek/email'
 require 'mailpeek/delivery'
+require 'mailpeek/configuration'
+require 'mailpeek/web'
+require 'mailpeek/version'
+
+require 'json'
 
 # Public: Mailpeek
 module Mailpeek
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.emails
+    emails   = []
+    location = Mailpeek.configuration.location
+
+    prep_folder
+
+    Dir.foreach(location) do |filename|
+      next if ['.', '..'].include?(filename)
+
+      path  = File.join(location, filename, 'mail')
+      email = Email.new(filename, ::Mail.read(path))
+
+      emails.push(email)
+    end
+
+    emails.sort_by(&:position).reverse
+  end
+
+  def self.email(timestamp)
+    emails.detect { |x| x.id == timestamp }
+  end
+
+  def self.unread
+    unread   = 0
+    location = Mailpeek.configuration.location
+
+    prep_folder
+
+    Dir.foreach(location) do |filename|
+      next if ['.', '..'].include?(filename)
+
+      unread += 1 unless File.exist?(File.join(location, filename, '.read'))
+    end
+
+    unread
+  end
+
+  def self.prep_folder
+    location = Mailpeek.configuration.location
+
+    FileUtils.mkdir_p(location) unless File.directory?(location)
+  end
 end
+
+require 'mailpeek/railtie' if defined?(Rails::Railtie)

data/lib/mailpeek/configuration.rb

@@ -0,0 +1,15 @@
+# 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')
+      @limit = 50
+    end
+  end
+end

data/lib/mailpeek/delivery.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mail/check_delivery_params'
 
 module Mailpeek
@@ -10,24 +12,71 @@ module Mailpeek
     attr_accessor :settings
 
     def initialize(options = {})
+      options[:location] ||= Mailpeek.configuration.location
+      options[:limit] ||= Mailpeek.configuration.limit
+      options[:limit] = options[:limit].to_i
+
       if options[:location].nil?
-        raise(
-          InvalidOption,
-          'A location option is required when using Mailpeek')
+        raise InvalidOption, 'A location option is required when using Mailpeek'
+      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'
       end
+
+      # rubocop:enable Style/GuardClause
+
       self.settings = options
     end
 
     def deliver!(mail)
       check_delivery_params(mail) if respond_to?(:check_delivery_params)
 
-      FileUtils.mkdir_p(settings[:location])
+      clean_up
+
+      basepath = File.join(settings[:location], Time.now.to_i.to_s)
+
+      save_email(mail, basepath)
+
+      return true unless mail.attachments.any?
+
+      add_attachments(mail, basepath)
+    end
 
-      filepath = File.join(settings[:location], Time.now.to_i.to_s)
+    private
 
-      File.open(filepath, 'w') do |f|
+    def clean_up
+      # remove oldest email if over `limit` settings
+
+      directory = File.join(settings[:location], '*')
+      return if Dir[directory].length < settings[:limit]
+
+      FileUtils.rm_rf(Dir[File.join(settings[:location], '*')].min)
+    end
+
+    def save_email(mail, basepath)
+      FileUtils.mkdir_p(basepath)
+
+      File.open(File.join(basepath, 'mail'), 'w') do |f|
         f.write mail.to_s
       end
     end
+
+    def add_attachments(mail, basepath)
+      attachments_dir = File.join(basepath, 'attachments')
+      FileUtils.mkdir_p(attachments_dir) unless File.directory?(attachments_dir)
+
+      mail.attachments.each do |attachment|
+        filename = attachment.filename.gsub(/[^\w\-_.]/, '_')
+        path     = File.join(attachments_dir, filename)
+
+        unless File.exist?(path)
+          File.open(path, 'wb') { |f| f.write(attachment.body.raw_source) }
+        end
+      end
+    end
   end
 end

data/lib/mailpeek/email.rb

@@ -0,0 +1,85 @@
+# 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
+    )
+
+    def initialize(timestamp, mail)
+      @id          = timestamp
+      @position    = timestamp
+      @mail        = mail
+      @to          = mail[:to].addrs.map(&:format)
+      @from        = mail[:from].addrs.map(&:format)
+      @subject     = mail.subject
+      @message_id  = mail.message_id
+      @date        = mail.date
+      @attachments = []
+
+      if mail.multipart?
+        parse_parts
+      else
+        parse_body
+      end
+    end
+
+    def match?(query)
+      subject&.match(query) || text&.match(query) || html&.match(query)
+    end
+
+    def destroy
+      location = Mailpeek.configuration.location
+
+      FileUtils.rm_rf("#{location}/#{id}")
+    end
+
+    def read
+      File.exist?(read_file_path)
+    end
+
+    def read=(value)
+      if value && !read
+        FileUtils.touch(read_file_path)
+      elsif !value && read
+        File.delete(read_file_path)
+      end
+    end
+
+    private
+
+    def read_file_path
+      File.join(Mailpeek.configuration.location, id, '.read')
+    end
+
+    def parse_parts
+      if mail.html_part
+        @html = mail.html_part.body.decoded.force_encoding('utf-8')
+      end
+
+      if mail.text_part
+        @text = mail.text_part.body.decoded.force_encoding('utf-8')
+      end
+
+      return unless mail.attachments.any?
+
+      mail.attachments.each do |attachment|
+        @attachments.push(attachment.filename.gsub(/[^\w\-_.]/, '_'))
+      end
+    end
+
+    def parse_body
+      body = mail.body.decoded.force_encoding('utf-8')
+
+      if mail.content_type =~ /html/
+        @html = body
+      else
+        @text = body
+      end
+    end
+  end
+end

data/lib/mailpeek/{engine.rb → railtie.rb}

@@ -1,17 +1,15 @@
-module Mailpeek
-  # Public: Engine
-  class Engine < ::Rails::Engine
-    isolate_namespace Mailpeek
+# frozen_string_literal: true
 
+module Mailpeek
+  # Public: Railtie
+  class Railtie < Rails::Railtie
     initializer 'mailpeek.add_delivery_method' do
       ActiveSupport.on_load :action_mailer do
         ActionMailer::Base.add_delivery_method(
           :mailpeek,
-          Mailpeek::Delivery,
-          location: Rails.root.join('tmp', 'mailpeek'))
+          Mailpeek::Delivery
+        )
       end
     end
-
-    require 'jbuilder'
   end
 end

data/lib/mailpeek/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mailpeek
-  VERSION = '0.0.2'.freeze
+  VERSION = '1.0.1'
 end

data/lib/mailpeek/web.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+require 'mailpeek/web/router'
+require 'mailpeek/web/action'
+require 'mailpeek/web/helpers'
+require 'mailpeek/web/application'
+
+require 'rack/protection'
+
+require 'rack/builder'
+require 'rack/file'
+
+# Public: Mailpeek
+module Mailpeek
+  # Public: Base Web Class
+  class Web
+    ROOT = File.expand_path("#{File.dirname(__FILE__)}/../../web")
+    VIEWS = "#{ROOT}/views"
+    LAYOUT = "#{VIEWS}/layout.erb"
+    ASSETS = "#{ROOT}/assets"
+
+    class << self
+      def settings
+        self
+      end
+
+      def middlewares
+        @middlewares ||= []
+      end
+
+      def use(*middleware_args, &block)
+        middlewares << [middleware_args, block]
+      end
+
+      def views
+        @views ||= VIEWS
+      end
+
+      def enable(*opts)
+        opts.each { |key| set(key, true) }
+      end
+
+      def disable(*opts)
+        opts.each { |key| set(key, false) }
+      end
+
+      def set(attribute, value)
+        send(:"#{attribute}=", value)
+      end
+
+      attr_accessor :app_url
+      attr_writer :views
+    end
+
+    def self.inherited(child)
+      child.app_url = app_url
+    end
+
+    def settings
+      self.class.settings
+    end
+
+    def use(*middleware_args, &block)
+      middlewares << [middleware_args, block]
+    end
+
+    def middlewares
+      @middlewares ||= Web.middlewares.dup
+    end
+
+    def call(env)
+      app.call(env)
+    end
+
+    def self.call(env)
+      @app ||= new
+      @app.call(env)
+    end
+
+    def app
+      @app ||= build
+    end
+
+    def enable(*opts)
+      opts.each { |key| set(key, true) }
+    end
+
+    def disable(*opts)
+      opts.each { |key| set(key, false) }
+    end
+
+    def set(attribute, value)
+      send(:"#{attribute}=", value)
+    end
+
+    def self.register(extension)
+      extension.registered(WebApplication)
+    end
+
+    private
+
+    def using?(middleware)
+      middlewares.any? do |(m, _)|
+        m.is_a?(Array) && (m[0] == middleware || m[0].is_a?(middleware))
+      end
+    end
+
+    def build
+      middlewares = self.middlewares
+      klass = self.class
+
+      ::Rack::Builder.new do
+        %w[stylesheets javascripts images].each do |asset_dir|
+          map "/#{asset_dir}" do
+            run ::Rack::File.new(
+              "#{ASSETS}/#{asset_dir}",
+              'Cache-Control' => 'public, max-age=86400'
+            )
+          end
+        end
+
+        middlewares.each { |middleware, block| use(*middleware, &block) }
+
+        run WebApplication.new(klass)
+      end
+    end
+  end
+
+  Mailpeek::WebApplication.helpers WebHelpers
+
+  Mailpeek::WebAction.class_eval(
+    "def _render\n#{ERB.new(File.read(Web::LAYOUT)).src}\nend"
+  )
+end