malina 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ddf49f09e26acd295056933f597683e0a17423db3ff0e3070bbe458856bf8acb
+  data.tar.gz: 3a734030fbd633bdfe9375a835c0e39cd8de285eae7582939e9b58e16602a66a
+SHA512:
+  metadata.gz: faa17c418c39e864987f76f3a5f93a2def156b8c79c2892143177259f33d7a25029b88653436830438ce27e99d0dfe112e7440b8fe38c1ff28aecb642e7e74b5
+  data.tar.gz: 7e63bd7f572173ffa80f3cf27010ba696a634b65ca0265fdbaf7c6471d4aff540c207446c2d919b8586d24406b71b712b4cc7637aeeb09cf32beb8ffc7444a71

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 mpakus
+
+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,83 @@
+# Malina
+[![CircleCI](https://circleci.com/gh/mpakus/malina.svg?style=svg)](https://circleci.com/gh/mpakus/malina)
+
+Interface for browsing sent emails.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'malina', group: :development
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install malina
+```
+
+### 1. Generate initialize file
+
+```bash
+rails g malina:install
+```
+
+it generates `malina_emails.rb` in your application's folder `config/initializers/` 
+```ruby
+ActionMailer::Base.register_interceptor(Malina::EmailInterceptor) if Rails.env.development?
+
+Malina::Config.layout = 'malina'
+```
+
+### 2. Generate migration file
+
+```bash
+rails g malina:migration
+```
+
+run migration
+```bash
+rails db:migrate
+```
+
+### 3. Mount route
+add this line to your `config/routes.rb`
+
+```ruby
+mount Malina::Engine => '/backroom/emails', as: :malina
+```
+you can change this url of course
+
+## Usage
+
+and now interface is available at your's app url, for example `localhost:3000/backroom/emails`
+
+![Alt text](https://monosnap.com/image/L4OXErEzGxTbtT262b8P8XPqmGoz9L)
+
+![Alt text](https://monosnap.com/image/dDrVpfW9PP6ixMZlJqeUVBQGa1MUgW)
+
+## Views
+
+Since Malina is an engine, all its views are packaged inside the gem. 
+These views will help you get started, but after some time you may want to change them. 
+If this is the case, you just need to invoke the following generator, and it will copy all views to your application:
+
+```bash
+rails g malina:layout
+```
+makes Layout available for changes
+
+```bash
+rails g malina:views
+```
+the other views, too
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/mpakus/malina
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Malina'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/internal/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/malina/emails_controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Malina::EmailsController < ApplicationController
+  layout Malina::Config.layout
+
+  def destroy
+    Malina::Email.destroy_all
+    redirect_to malina.malina_emails_path
+  end
+
+  private
+
+  # @return [Array<Malina::Email>]
+  def emails
+    @emails ||= Malina::Email.ordered
+  end
+
+  # @return [Malina::Email]
+  def email
+    @email ||= Malina::Email.find(params[:id])
+  end
+
+  # @param [String] emails
+  # @return [String]
+  def prepare(emails = nil)
+    return '' unless emails
+
+    JSON.parse(emails)&.join(', ')
+  end
+
+  helper_method :emails
+  helper_method :email
+  helper_method :prepare
+end

data/app/models/malina/email.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Malina::Email < ActiveRecord::Base
+  self.table_name = 'malina_emails'
+
+  scope :ordered, -> { order(created_at: :desc) }
+end
+# == Schema Information
+#
+# Table name: malina_emails
+#
+#  id         :integer          not null, primary key
+#  bcc        :string
+#  body       :text
+#  cc         :string
+#  from       :string
+#  subject    :string
+#  to         :string
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#
+# Indexes
+#
+#  index_malina_emails_on_from  (from)
+#  index_malina_emails_on_to    (to)
+#
+

data/app/services/malina/config.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Malina::Config
+  @layout = 'malina'
+
+  class << self
+    attr_accessor :layout
+  end
+end

data/app/services/malina/email_interceptor.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class Malina::EmailInterceptor
+  def self.delivering_email(message)
+    Malina::Email.create(
+      subject: message.subject,
+      to:      message.to,
+      from:    message.from,
+      cc:      message.cc,
+      bcc:     message.bcc,
+      body:    message.body
+    )
+  end
+end

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

@@ -0,0 +1,46 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+  <title>
+    E-mails
+  </title>
+  <style>
+    body {
+      background: #fff;
+      font-size: 12px;
+      font-family: "Helvetica Neue", Arial, sans-serif;
+      padding: 1em;
+      margin: 0;
+      height: 100%;
+      overflow: auto;
+    }
+    
+    table.malina-table {
+      width: 100%;
+    }
+    
+    table.malina-table > thead {
+      border-top: 1px solid #000;
+      border-bottom: 1px solid #000;
+    }
+    
+    table.malina-table td {
+      padding: 0.3em;
+    }
+    
+    iframe.malina-email-body {
+      border: 0;
+      width: 100%;
+      height: 100%;
+      
+      white-space: pre-wrap;
+      border: 1px solid #eee;
+    }
+  </style>
+</head>
+<body>
+<div class="malina-container">
+  <%= yield %>
+</div>
+</body>
+</html>

data/app/views/malina/emails/index.html.erb

@@ -0,0 +1,32 @@
+<h1>E-mails</h1>
+
+<p class="malina-clear-button">
+  <%= button_to 'Clear all', malina.malina_email_path(1), method: :delete %>
+</p>
+
+<table class="malina-table">
+  <thead>
+    <tr>
+      <th>ID</th>
+      <th>When</th>
+      <th>From</th>
+      <th>To</th>
+      <th>Subject</th>
+      <th>CC</th>
+      <th>BCC</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% emails.each do |email| %>
+      <tr>
+        <td><%= link_to email.id, malina.malina_email_path(email) %></td>
+        <td><%= l email.created_at %></td>
+        <td><%= link_to email.subject, malina.malina_email_path(email) %></td>
+        <td><%= prepare email.from %></td>
+        <td><%= prepare email.to %></td>
+        <td><%= prepare email.cc %></td>
+        <td><%= prepare email.bcc %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/malina/emails/show.html.erb

@@ -0,0 +1,13 @@
+<h1>E-mail</h1>
+
+<p class="malina-back-button">
+  <%= link_to '<< Back', malina.malina_emails_path %>
+</p>
+
+<div class="malina-email">
+  <h3>Subject: <%= email.subject %></h3>
+  <h4>From: <%= prepare email.from %></h4>
+  <h4>To: <%= prepare email.to %></h4>
+  <hr>
+  <iframe class="malina-email-body" seamless="seamless" srcdoc="<%= email.body %>" onload="this.style.height=this.contentDocument.body.scrollHeight +'px';"></iframe>
+</div>

data/config/routes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Rails.application.routes.draw do
+#   root to: 'malina/emails#index'
+#
+#   namespace :malina do
+#     resources :emails, only: %i[index show destroy]
+#   end
+# end
+
+Malina::Engine.routes do
+  root to: 'malina/emails#index'
+
+  namespace :malina do
+    resources :emails, only: %i[index show destroy]
+  end
+end

data/lib/generators/malina/install_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Malina
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __dir__)
+
+    desc 'Configure necessary files to use Malina E-mails'
+    def copy_initializer_file
+      copy_file 'malina_emails.rb', Rails.root.join('config/initializers/malina_emails.rb')
+    end
+  end
+end

data/lib/generators/malina/layout_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Malina
+  class LayoutGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../app/views/layouts', __dir__)
+
+    desc 'Copy layout file'
+    def copy_views_file
+      copy_file 'malina.html.erb', Rails.root.join('app/views/layouts/malina.html.erb')
+    end
+  end
+end

data/lib/generators/malina/migration_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Malina
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __dir__)
+
+    def self.next_migration_number(dirname)
+      return Time.new.utc.strftime('%Y%m%d%H%M%S') if ActiveRecord::Base.timestamped_migrations
+
+      format('%.3d', (current_migration_number(dirname) + 1))
+    end
+
+    def create_migration_file
+      migration_template 'create_malina_emails.rb', 'db/migrate/create_malina_emails.rb'
+    end
+  end
+end

data/lib/generators/malina/views_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Malina
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __dir__)
+
+    desc 'Copy views files'
+    def copy_views_file
+      copy_file 'index.html.erb', Rails.root.join('app/views/malina/emails/index.html.erb')
+      copy_file 'show.html.erb', Rails.root.join('app/views/malina/emails/show.html.erb')
+    end
+  end
+end

data/lib/generators/templates/create_malina_emails.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateMalinaEmails < ActiveRecord::Migration[5.0]
+  def change
+    create_table :malina_emails do |t|
+      t.string :subject
+      t.string :to, index: true
+      t.string :from, index: true
+      t.string :cc
+      t.string :bcc
+      t.text :body
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/templates/malina_emails.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ActionMailer::Base.register_interceptor(Malina::EmailInterceptor) if Rails.env.development?
+
+Malina::Config.layout = 'malina'

data/lib/malina.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'malina/engine'
+
+module Malina
+  # Your code goes here...
+end

data/lib/malina/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Malina
+  class Engine < ::Rails::Engine
+    # isolate_namespace Malina
+  end
+end

data/lib/malina/version.rb

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

data/lib/tasks/malina_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :malina do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: malina
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Renat "MpaK" Ibragimov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+description: Interface for browsing sent emails.
+email:
+- mrak69@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/malina_manifest.js
+- app/controllers/malina/emails_controller.rb
+- app/models/malina/email.rb
+- app/services/malina/config.rb
+- app/services/malina/email_interceptor.rb
+- app/views/layouts/malina.html.erb
+- app/views/malina/emails/index.html.erb
+- app/views/malina/emails/show.html.erb
+- config/routes.rb
+- lib/generators/malina/install_generator.rb
+- lib/generators/malina/layout_generator.rb
+- lib/generators/malina/migration_generator.rb
+- lib/generators/malina/views_generator.rb
+- lib/generators/templates/create_malina_emails.rb
+- lib/generators/templates/malina_emails.rb
+- lib/malina.rb
+- lib/malina/engine.rb
+- lib/malina/version.rb
+- lib/tasks/malina_tasks.rake
+homepage: https://github.com/mpakus/malina
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/mpakus/malina/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/mpakus/malina
+  homepage_uri: https://github.com/mpakus/malina
+  source_code_uri: https://github.com/mpakus/malina
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Malina E-mails UI as Rails Engine
+test_files: []