mailgun_list_manager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9895a573fe2fa059380c8c907c80ac7dc58db9a4
+  data.tar.gz: 91bff3d4ae86f0a23bd802527cb321d12e66bcec
+SHA512:
+  metadata.gz: 23b947599d1800506a59acdcd314f926e2af1e94aa7a693b3a80c3a2940b219c7fa567e87d87fbaddcb71c56d09ca7e651347f57ece715b9c31a0816d543b978
+  data.tar.gz: beead165ba4dbcf0b3915297d6cba88cd9cf228760b7456f03fd065e40dd2fa5530a03abe922ab515c04b67d935e7b17cbb454b10cf7208682cf337cf6882a55

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Noémien Kocher
+
+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,18 @@
+# Mailgun list manager
+
+A web interface to interact with mailgun's mailling lists.
+
+## Installation
+
+*coming soon*
+
+## Features
+
+* List mailling lists
+* Edit lists' informations
+* List members of a list
+* Add a member to a list
+* Remove a member from a list
+* Create a list
+* Remove a list
+* Print a list

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'MailgunListManager'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_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/assets/images/mailgun_list_manager/loader.svg

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><svg width='128px' height='128px' xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" preserveAspectRatio="xMidYMid" class="uil-ripple"><rect x="0" y="0" width="100" height="100" fill="none" class="bk"></rect><g> <animate attributeName="opacity" dur="2s" repeatCount="indefinite" begin="0s" keyTimes="0;0.33;1" values="1;1;0"></animate><circle cx="50" cy="50" r="40" stroke="#edc901" fill="none" stroke-width="6" stroke-linecap="round"><animate attributeName="r" dur="2s" repeatCount="indefinite" begin="0s" keyTimes="0;0.33;1" values="0;22;44"></animate></circle></g><g><animate attributeName="opacity" dur="2s" repeatCount="indefinite" begin="1s" keyTimes="0;0.33;1" values="1;1;0"></animate><circle cx="50" cy="50" r="40" stroke="#e4a50c" fill="none" stroke-width="6" stroke-linecap="round"><animate attributeName="r" dur="2s" repeatCount="indefinite" begin="1s" keyTimes="0;0.33;1" values="0;22;44"></animate></circle></g></svg>

data/app/assets/javascripts/mailgun_list_manager/ajax_loader.js

@@ -0,0 +1,18 @@
+/* global $ */
+"use strict";
+
+/* Ajax loader */
+
+$(document).on("ready page:load", function() {
+	var timer;
+	$(document).ajaxStart(function(){
+		timer && clearTimeout(timer);
+		timer = setTimeout(function() {
+			$("#overlay").fadeIn(500);
+		}, 400);
+	});
+	$(document).ajaxStop(function(){
+		clearTimeout(timer);
+	  $("#overlay").fadeOut(400);
+	});
+});

data/app/assets/javascripts/mailgun_list_manager/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.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/mailgun_list_manager/pages.js

@@ -0,0 +1,16 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+$(document).on("ready page:load", function() {
+  init();
+});
+
+
+function init() {
+  $("#lists-wrapper").on("click", ".list .title", function() {
+    $(this).next().toggle();
+  });
+
+  $("#lists-wrapper").on("click", ".list .update-modal .close", function() {
+    $(".update-modal").hide();
+  });
+}

data/app/assets/javascripts/mailgun_list_manager/print.js

@@ -0,0 +1,5 @@
+function printElement(el) {
+  $(el).addClass("print-alone");
+  window.print();
+  $(el).removeClass("print-alone");
+}

data/app/assets/stylesheets/mailgun_list_manager/ajax-loader.scss

@@ -0,0 +1,18 @@
+.mailgun-list-manager.manager {
+  #overlay {
+  	position: fixed;
+  	top: 0; bottom: 0; right: 0; left: 0;
+  	background: rgba(255,255,255,.8);
+  	z-index: 9999;
+  	display: none;
+  	p {
+  		position: fixed;
+  		top: 300px;
+  		text-align: center;
+  		width: 100%;
+  		font-weight: 900;
+  		font-size: 25px;
+  		font-family: "Raleway";
+  	}
+  }
+}

data/app/assets/stylesheets/mailgun_list_manager/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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/mailgun_list_manager/pages.scss

@@ -0,0 +1,88 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+.mailgun-list-manager.manager {
+  font-family: sans-serif;
+  font-size: 12px;
+  max-width: 900px;
+  margin: auto;
+
+  .add-list {
+    padding: 5px 10px;
+  }
+
+  .lists {
+    .list {
+      margin: 10px 0;
+      .title {
+        background: #efefef;
+        padding: 5px 10px;
+        cursor: pointer;
+        &:hover {
+          background: aliceblue;
+        }
+        .address {
+          font-weight: bold;
+        }
+      }
+      .container {
+        display: none;
+        border: 2px solid aliceblue;
+        border-radius: 0 0 10px 10px;
+        .form {
+          padding: 15px 10px;
+          background: aliceblue;
+          form.delete {
+            display: inline-block;
+          }
+          form.add {
+            padding: 5px 0 0 0;
+          }
+        }
+        table {
+          padding: 5px 10px;
+          width: 100%;
+          tbody {
+            tr {
+              &:hover {
+                background: aliceblue;
+              }
+            }
+          }
+        }
+      }
+      .update-modal {
+        position: fixed;
+        top: 0; right: 0; bottom: 0; left: 0;
+        z-index: 10;
+        background: rgba(0,0,0,.3);
+        display: none;
+        .content {
+          position: fixed;
+          top: 50%; left: 50%;
+          transform: translate(-50%, -50%);
+          padding: 10px;
+          background: #fff;
+          .close {
+            cursor: pointer;
+            text-align: right;
+            padding: 10px;
+            &:hover {
+              font-weight: bold;
+            }
+          }
+        }
+      }
+    }
+  }
+
+  .print-alone {
+    position: absolute;
+    top: 0; right: 0; left: 0;
+    background: #fff;
+    z-index: 999;
+    min-height: 100%;
+  }
+
+}

data/app/assets/stylesheets/mailgun_list_manager/print.scss

@@ -0,0 +1,5 @@
+@media print {
+  .mailgun-list-manager.manager .no-print {
+    display: none;
+  }
+}

data/app/controllers/mailgun_list_manager/application_controller.rb

@@ -0,0 +1,5 @@
+module MailgunListManager
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/mailgun_list_manager/lists_controller.rb

@@ -0,0 +1,33 @@
+require_dependency "mailgun_list_manager/application_controller"
+
+module MailgunListManager
+  class ListsController < ApplicationController
+
+    def index
+      @lists = List.all
+    end
+
+    def create
+      List.add(list_params[:address], list_params)
+      @lists = List.all
+    end
+
+    def update
+      list = List.find(params[:id])
+      @list = list.update(list_params)
+      @old_id = params[:id]
+    end
+
+    def destroy
+      List.destroy(params[:id])
+      @lists = List.all
+    end
+
+    private
+
+    def list_params
+      params[:list].permit(:description, :address, :name, :access_level)
+    end
+
+  end
+end

data/app/controllers/mailgun_list_manager/members_controller.rb

@@ -0,0 +1,17 @@
+require_dependency "mailgun_list_manager/application_controller"
+
+module MailgunListManager
+  class MembersController < ApplicationController
+
+    def create
+      Member.add(params[:list_id], params[:member_address])
+      @list = List.find(params[:list_id])
+    end
+
+    def destroy
+      Member.delete(params[:list_id], params[:id])
+      @list = List.find(params[:list_id])
+    end
+
+  end
+end

data/app/controllers/mailgun_list_manager/pages_controller.rb

@@ -0,0 +1,7 @@
+require_dependency "mailgun_list_manager/application_controller"
+
+module MailgunListManager
+  class PagesController < ApplicationController
+
+  end
+end

data/app/helpers/mailgun_list_manager/application_helper.rb

@@ -0,0 +1,4 @@
+module MailgunListManager
+  module ApplicationHelper
+  end
+end

data/app/helpers/mailgun_list_manager/list_helper.rb

@@ -0,0 +1,4 @@
+module MailgunListManager
+  module ListHelper
+  end
+end

data/app/helpers/mailgun_list_manager/pages_helper.rb

@@ -0,0 +1,5 @@
+module MailgunListManager
+  module PagesHelper
+
+  end
+end

data/app/models/mailgun_list_manager/List.rb

@@ -0,0 +1,71 @@
+module MailgunListManager
+  class List
+    include ActiveModel::Model
+    require "base64"
+
+    ACCESS_LEVELS = ["readonly", "members", "everyone"]
+
+    attr_accessor :address,
+                  :name,
+                  :description,
+                  :access_level,
+                  :created_at,
+                  :members_count
+
+    validates :address, presence: true
+    validates_format_of :address, :with => /@/
+    validates :access_level,  inclusion: { in: ACCESS_LEVELS, messages: "unknown access level type" }
+    validates :members_count, :numericality => { :greater_than_or_equal_to => 0 }, allow_blank: true
+
+    def id
+      Base64.urlsafe_encode64(address)
+    end
+
+    def members
+      json = Mailgun().list_members(address).list
+      Member.parse(json, self)
+    end
+
+    # CRUD operations
+
+    def self.all
+      json = Mailgun().lists.list
+      @lists = parse(json)
+    end
+
+    def self.add(address, params)
+      p '######'
+      p params
+      List.new(params)
+      Mailgun().lists.create(address, params)
+    end
+
+    def self.find(id)
+      address = Base64.urlsafe_decode64(id)
+      hash = Mailgun().lists.find(address)["list"]
+      List.new(hash)
+    end
+
+    def self.destroy(id)
+      address = Base64.urlsafe_decode64(id)
+      Mailgun().lists.delete(address)
+    end
+
+    def update(list_params)
+      hash = Mailgun().lists.update(address, list_params["address"], list_params)["list"]
+      List.new(hash)
+    end
+
+    def initialize(params = {})
+      super(params)
+      raise self.errors.messages.to_s if self.invalid?
+    end
+
+    private
+
+    def self.parse(hash)
+      hash.map { |list| List.new(list) }
+    end
+
+  end
+end

data/app/models/mailgun_list_manager/Member.rb

@@ -0,0 +1,46 @@
+module MailgunListManager
+  class Member
+    include ActiveModel::Model
+    require "base64"
+
+    attr_accessor :address,
+                  :name,
+                  :subscribed,
+                  :vars,
+                  :list
+
+    validates :address, presence: true
+    validates_format_of :address, :with => /@/
+    validates :subscribed, inclusion: { in: [true, false], messages: "must be true or false" }, allow_blank: true
+
+    def initialize(attributes = {}, list)
+      super(attributes)
+      raise errors.messages.to_s if self.invalid?
+      @list = list
+    end
+
+    def id
+      Base64.urlsafe_encode64(address)
+    end
+
+    # CRUD operations
+
+    def self.add(list_id, address)
+      list_address = Base64.urlsafe_decode64(list_id)
+      Mailgun().list_members(list_address).add(address)
+    end
+
+    def self.delete(list_id, id)
+      list_address = Base64.urlsafe_decode64(list_id)
+      address = Base64.urlsafe_decode64(id)
+      Mailgun().list_members(list_address).remove(address)
+    end
+
+    private
+
+    def self.parse(hash, list)
+      hash.map { |member| Member.new(member, list)  }
+    end
+
+  end
+end

data/app/views/layouts/mailgun_list_manager/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>MailgunListManager</title>
+  <%= stylesheet_link_tag    "mailgun_list_manager/application", media: "all" %>
+  <%= javascript_include_tag "mailgun_list_manager/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/mailgun_list_manager/lists/_list.html.erb

@@ -0,0 +1,48 @@
+<div class="list">
+  <div class="title">
+    <span class="name">    <%= @list.name %> </span>
+    <span class="address"> <%= @list.address %> (<%= @list.members_count %>)</span>
+  </div>
+
+  <div class="container">
+    <div class="form no-print">
+
+      <%= link_to "Supprimer la liste", list_path(@list.id),
+            method: :delete, remote: true, data: {confirm: "Vraiment?"} %>
+
+      <button onclick="$(this).next('.update-modal').show()">Mettre à jour les infos</button>
+      <div class="update-modal">
+        <div class="content">
+          <div class="close">X (fermer)</div>
+          <div class="title">Changer les infos</div>
+          <%= form_for @list, url: list_path(@list.id), remote: true, method: :put do |f| %>
+            <%= f.label :address %>
+            <%= f.email_field :address, required: true %>
+            <%= f.label :name %>
+            <%= f.text_field :name %>
+            <%= f.label :description %>
+            <%= f.text_field :description %>
+            <%= f.label :access_level %>
+            <%= f.select(:access_level, MailgunListManager::List::ACCESS_LEVELS) %>
+            <%= f.submit "Mettre à jour" %>
+          <% end %>
+        </div>
+      </div>
+
+      <button onclick="printElement('[id=\'list-<%= @list.id %>\']')">Imprimer la liste</button>
+
+      <%= form_tag(list_members_path(@list.id), remote: true, class: "add") do %>
+        <label>Ajouter un membre: </label>
+        <input type="email" required name="member_address" placeholder="email">
+        <input type="hidden" name="list_address" value="<%= @list.address %>">
+        <input type="hidden" name="dom_id" value="<%= "members-#{@i}" %>">
+        <input type="submit" value="Ajouter">
+      <% end %>
+    </div>
+
+    <div id="members-<%= @list.id %>">
+      <%= render 'mailgun_list_manager/members/members' %>
+    </div>
+
+  </div>
+</div>

data/app/views/mailgun_list_manager/lists/_lists.html.erb

@@ -0,0 +1,6 @@
+<div class="lists">
+  <% @lists.each do |list| %>
+    <% @list = list %>
+    <%= content_tag :div, (render 'list'), id: "list-#{@list.id}" %>
+  <% end %>
+</div>

data/app/views/mailgun_list_manager/lists/create.js

@@ -0,0 +1 @@
+$("#lists-wrapper").html("<%= j (render 'lists') %>");

data/app/views/mailgun_list_manager/lists/destroy.js

@@ -0,0 +1 @@
+$("#lists-wrapper").html("<%= j (render 'lists') %>");

data/app/views/mailgun_list_manager/lists/index.html.erb

@@ -0,0 +1,27 @@
+<div class="mailgun-list-manager manager">
+
+  <h1>Listes de diffusion mail</h1>
+
+  <div class="add-list no-print">
+    <%= form_for :list, url: lists_path, remote: true do |f| %>
+      <%= f.label :address %>
+      <%= f.email_field :address, required: true %>
+      <%= f.label :name %>
+      <%= f.text_field :name %>
+      <%= f.label :description %>
+      <%= f.text_field :description %>
+      <%= f.label :access_level %>
+      <%= f.select(:access_level, MailgunListManager::List::ACCESS_LEVELS) %>
+      <%= f.submit %>
+    <% end %>
+  </div>
+
+  <div id="lists-wrapper">
+    <%= render "lists" %>
+  </div>
+
+  <div id="overlay" data-loading>
+  	<p>Loading<br><br><%= image_tag "mailgun_list_manager/loader.svg" %></p>
+  </div>
+
+</div>

data/app/views/mailgun_list_manager/lists/update.js.erb

@@ -0,0 +1,7 @@
+var domlist = $("[id='list-<%= @old_id %>']");
+
+domlist.attr('id', 'list-<%= @list.id %>');
+
+domlist.html("<%= j (render 'list') %>");
+
+domlist.find(".container").show();

data/app/views/mailgun_list_manager/members/_members.html.erb

@@ -0,0 +1,19 @@
+<table>
+  <thead>
+    <th>Adresse</th> <th>Name</th> <th>Subscribed</th> <th>vars</th> <th class="no-print">Actions</th>
+  </thead>
+  <tbody>
+    <% @list.members.each do |member| %>
+      <tr>
+        <td> <%= member.address %>    </td>
+        <td> <%= member.name %>       </td>
+        <td> <%= member.subscribed %> </td>
+        <td> <%= member.vars %>       </td>
+        <td class="no-print">
+          <%= link_to "delete", list_member_path(member.list.id, member.id),
+                method: :delete, remote: true, data: {confirm: "Vraiment?"} %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/mailgun_list_manager/members/create.js.erb

@@ -0,0 +1 @@
+$("[id='members-<%= @list.id %>']").html("<%= j (render 'members') %>");

data/app/views/mailgun_list_manager/members/destroy.js.erb

@@ -0,0 +1 @@
+$("[id='members-<%= @list.id %>']").html("<%= j (render 'members') %>");

data/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile += %w( mailgun_list_manager/loader.svg )

data/config/initializers/mailgun.rb

@@ -0,0 +1,4 @@
+Mailgun.configure do |config|
+  config.api_key = MailgunListManager.apikey
+  config.domain  = MailgunListManager.domain
+end

data/config/routes.rb

@@ -0,0 +1,9 @@
+MailgunListManager::Engine.routes.draw do
+
+  root to: "lists#index"
+
+  resources :lists do
+    resources :members
+  end
+
+end

data/lib/mailgun_list_manager/engine.rb

@@ -0,0 +1,8 @@
+module MailgunListManager
+  class Engine < ::Rails::Engine
+    require 'mailgun'
+    require 'jquery-rails'
+
+    isolate_namespace MailgunListManager
+  end
+end

data/lib/mailgun_list_manager/version.rb

@@ -0,0 +1,3 @@
+module MailgunListManager
+  VERSION = "0.0.1"
+end