maily_herald-webui 0.8.0 → 0.9.0

data/README.md

@@ -1,6 +1,6 @@
 # MailyHerald Web UI
 
-Web interface for Ruby on Rails email marketing solution - [MailyHerald](https://github.com/Sology/maily_herald).
+Web interface for [MailyHerald](https://github.com/Sology/maily_herald) - Ruby on Rails email marketing solution.
 
 ## Requirements
 
@@ -8,7 +8,7 @@ Both Ruby on Rails 3.2 and 4 are supported.
 
 ## Installation
 
-Simply just
+Simply just run
 
     gem install maily_herald-webui
 
@@ -18,7 +18,7 @@ or put in your Gemfile
 
 ## Usage
 
-Mount WebUI in your application:
+Mount the WebUI in your application:
 
 ```ruby
 # config/routes.rb
@@ -29,14 +29,14 @@ mount MailyHerald::Webui::Engine => "/maily_webui"
 
 ### Restricting access
 
-The simplest way to restrict access to Maily WebUI is to use Rails routing constraints:
+The simplest way to restrict access to the Maily WebUI is to use Rails routing constraints:
 
 ```ruby
 # config/routes.rb
 mount MailyHerald::Webui::Engine => "/maily_webui", :constraints => MailyAccessConstraint.new
 ```
 
-Sample `MailyAccessConstraint` implementation might look like this:
+A sample `MailyAccessConstraint` implementation might look like this:
 
 ```ruby
 class MailyAccessConstraint
@@ -48,11 +48,37 @@ class MailyAccessConstraint
 end
 ```
 
+HTTP Basic auth can be used too:
+
+```ruby
+# config/routes.rb
+MailyHerald::Webui::Engine.middleware.use Rack::Auth::Basic do |username, password|
+  username == ENV["MAILY_USERNAME"] && password == ENV["MAILY_PASSWORD"]
+end if Rails.env.production?
+
+mount MailyHerald::Webui::Engine => "/maily_webui"
+```
+
+### Entity names
+
+By default the WebUI displays entities (i.e. your users) using the `to_s` method. You can easily overwrite this method in your model to see your user names in the WebUI. Example below:
+
+```ruby
+class User < ActiveRecord::Base
+
+  # ...
+
+  def to_s
+    "#{self.firstname} #{self.lastname}"
+  end
+end
+```
+
 ## More Information
 
-* [Home Page](http://www.mailyherald.org)
+* [Home Page](http://mailyherald.org)
 * [API Docs](http://www.rubydoc.info/gems/maily_herald)
-* Showcase (_coming soon_)
+* [Showcase](http://showcase.sology.eu/maily_herald)
 * [Sample application](https://github.com/Sology/maily_testapp)
 
 For bug reports or feature requests see the [issues on Github](https://github.com/Sology/maily_herald-webui/issues).  

data/Rakefile

@@ -25,6 +25,6 @@ end
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
-load "sprockets/assets.rake"
+#load "sprockets/assets.rake"
 
 Bundler::GemHelper.install_tasks

data/app/assets/javascripts/maily_herald/webui/dispatches.coffee

@@ -23,6 +23,7 @@ $.fn.handleDispatchForm = () ->
 
       if from_value == "default"
         from_field.hide()
+        from_field.val("")
       else if from_value == "specify"
         from_field.show()
 

data/app/assets/javascripts/maily_herald/webui/webui.coffee

@@ -13,14 +13,18 @@ $.rails.confirmed = (link) ->
 $.rails.showConfirmDialog = (link) ->
   message = link.attr 'data-confirm'
   link.popover('destroy')
+  editable = link.closest(".editable")
+  editable.addClass("force-visible")
   
   content = $("#popover-confirmation").clone().removeClass("fade")
   content.find(".popover-msg").html(message)
   content.find('.confirm').unbind "click"
   content.find('.confirm').click ->
     $.rails.confirmed(link)
+    editable.removeClass("force-visible")
   content.find('.cancel').click ->
     link.popover('hide')
+    editable.removeClass("force-visible")
 
   link.popover(content: content, html: true, trigger: 'manual', title: $("#popover-confirmation").data("title"))
   link.popover('show')
@@ -61,6 +65,10 @@ $('.btn-default a').click  (e) ->
        keyChange()
      , 400)
 
+$.fn.setup_form_inputs = (v) ->
+  $(this).find('input[type="radio"]:checked').parent().addClass 'radio-checked'
+  $(this).find('input[type="checkbox"]:checked').parent().addClass 'checkbox-checked'
+
 $.fn.editable = (v) ->
   if v == "cancel"
     if $(this).data("edit-bkp")
@@ -73,6 +81,7 @@ $.fn.editable = (v) ->
     children.detach()
     $(this).data("edit-bkp", children)
     $(this).html(v)
+    $(this).setup_form_inputs()
 
 $.fn.historyGraph = () ->
   createSeries = (obj) ->
@@ -101,6 +110,11 @@ $.fn.historyGraph = () ->
         renderer: "line"
         interpolation: "linear"
         series: [
+          {
+            color: "#c3a323"
+            data: skipped
+            name: "Skipped"
+          }
           {
             color: "#a94442"
             data: failed
@@ -111,11 +125,6 @@ $.fn.historyGraph = () ->
             data: delivered
             name: "Delivered"
           }
-          {
-            color: "#006f68"
-            data: skipped
-            name: "Skipped"
-          }
         ]
       )
       x_axis = new Rickshaw.Graph.Axis.Time(graph: graph)
@@ -134,9 +143,9 @@ $.fn.historyGraph = () ->
       container.data("graph", graph)
     else
       graph = container.data("graph")
-      graph.series[0]["data"] = failed
-      graph.series[1]["data"] = delivered
-      graph.series[2]["data"] = skipped
+      graph.series[0]["data"] = skipped
+      graph.series[1]["data"] = failed
+      graph.series[2]["data"] = delivered
       graph.update()
 
 $ ->
@@ -147,28 +156,27 @@ $ ->
     false
 
   $(document).tooltip
-    selector: 'a[data-toggle=tooltip]'
+    selector: '*[data-toggle=tooltip]'
 
   $(document).on 'hidden.bs.modal', (e) ->
     $(e.target).removeData('bs.modal')
 
 
   # form ui
-  $('input[type=radio]').on 'change', ->
+  $(document).on 'change', 'input[type=radio]', ->
     $("input[type=radio][name=#{$(this).attr("name")}]").each ->
       if $(this).is(":checked")
         $(this).parent().addClass("radio-checked")
       else
         $(this).parent().removeClass("radio-checked")
 
-  $('input[type=checkbox]').on 'change', ->
+  $(document).on 'change', 'input[type=checkbox]', ->
     if $(this).is(":checked")
       $(this).parent().addClass("checkbox-checked")
     else
       $(this).parent().removeClass("checkbox-checked")
 
-  $('input[type="radio"]:checked').parent().addClass 'radio-checked'
-  $('input[type="checkbox"]:checked').parent().addClass 'checkbox-checked'
+  $(document).setup_form_inputs()
 
   $(".select-wrap").click ->
     $(this).toggleClass "select-btn"
@@ -181,7 +189,7 @@ $ ->
     target = $(e.target)
     target.addClass("disabled")
     target.bind "click", dummy
-    if target.find("i.fa").length == 0
+    if target.find("i.fa, span.fa").length == 0
       target.prepend("<i class='fa fa-spinner fa-spin'></i> ")
 
     target.on "ajax:success", (e) ->

data/app/assets/stylesheets/maily_herald/webui/webui.sass

@@ -147,6 +147,9 @@ a.error
   color: #f00 !important
   i.fa:before
     content: "" !important
+  i.fa
+    -webkit-animation: none !important
+    animation: none !important
 
 em 
   font-style: italic
@@ -168,9 +171,23 @@ pre
   max-height: 400px
   white-space: pre-wrap
 
+abbr[title], abbr[data-original-title]
+  text-decoration: none
+
 .no-margin 
   margin-bottom: 0
 
+.dropdown.dropdown-settings
+  background: none
+  width: 40px
+  text-align: center
+  .dropdown-menu
+    min-width: 200px
+    border: 1px solid #ddd
+    &:before
+      right: 10px
+
+
 // Breadcrumbs
 .breadcrumb
   background: none
@@ -388,7 +405,7 @@ button i
     content: ''
     position: absolute
     top: -10px
-    left: 50%
+    right: 10%
     margin-left: -5px
     width: 0
     height: 0
@@ -755,7 +772,7 @@ h1, .h1, h2, .h2, h3, .h3, h4, .h4, h5, .h5, h6, .h6
         margin-left: -22px
       .text-muted
         color: #aaa
-    &:hover
+    &:hover, &.force-visible
       td.actions
         &:after
           display: none
@@ -782,11 +799,15 @@ h1, .h1, h2, .h2, h3, .h3, h4, .h4, h5, .h5, h6, .h6
           visibility: hidden
         &:first-child:before
           display: none
+.smart-listing-controls
+  label
+    margin-top: 8px
 
 // Search
 .filter-search 
   position: relative
   display: inline-block
+  vertical-align: top
   input[type='text']
     padding-right: 36px
     max-width: 200px

data/app/controllers/maily_herald/webui/ad_hoc_mailings_controller.rb

@@ -0,0 +1,33 @@
+module MailyHerald
+	class Webui::AdHocMailingsController < Webui::MailingsController
+    add_breadcrumb :label_ad_hoc_mailing_plural, Proc.new{ ad_hoc_mailings_path }
+    set_menu_item :ad_hoc_mailings
+
+    def archived 
+      add_breadcrumb view_context.tw("#{controller_name}.archived.label")
+      
+      super
+    end
+
+    def show
+      super
+    end
+
+    def deliver
+      find_item
+
+      if params[:entity_id]
+        @e = @item.list.context.scope.find(params[:entity_id])
+        @item.schedule_delivery_to @e
+
+        render_containers ["schedules"]
+        render_update
+      else
+        @item.schedule_delivery_to_all
+
+        render_containers ["schedules"]
+        render_update
+      end
+    end
+  end
+end

data/app/controllers/maily_herald/webui/application_controller.rb

@@ -5,14 +5,18 @@ module MailyHerald
       include MailyHerald::Webui::MenuManager::ControllerExtensions
 
       helper SmartListing::Helper
-      helper_method :expert_mode?, :work_mode
+      helper_method :settings
 
-      def work_mode
-        session[:work_mode].try(:to_sym) || :regular
+      def settings
+        Settings.new(cookies)
       end
 
-      def expert_mode?
-        work_mode == :expert
+      def log_scope
+        if settings.show_skipped?
+          MailyHerald::Log.all
+        else
+          MailyHerald::Log.not_skipped
+        end
       end
     end
   end

data/app/controllers/maily_herald/webui/dashboard_controller.rb

@@ -22,7 +22,7 @@ module MailyHerald
       smart_listing_create(:logs, logs(:processed), :partial => "maily_herald/webui/logs/items", default_sort: {processing_at: "desc"})
       smart_listing_create(:scheduled_logs, MailyHerald::Log.scheduled, :partial => "maily_herald/webui/logs/items", default_sort: {processing_at: "asc"})
 
-      @total_count = MailyHerald::Log.count
+      @total_count = log_scope.count
       @processed_count = logs(:processed).count
       @delivered_count = logs(:delivered).count
       @skipped_count = logs(:skipped).count
@@ -59,7 +59,7 @@ module MailyHerald
     def logs state, period = nil
       period ||= @period
 
-      MailyHerald::Log.send(state).where("processing_at > (?)", @time - period)
+      log_scope.send(state).where("processing_at > (?)", @time - period)
     end
 	end
 end

data/app/controllers/maily_herald/webui/dispatches_controller.rb

@@ -22,7 +22,7 @@ module MailyHerald
     def destroy
       @item.archive!
 
-      render_containers ["details", "entities"]
+      render_containers ["details", "subscribers"]
       render_update
     end
 
@@ -35,7 +35,7 @@ module MailyHerald
         @item.disable!
       end
 
-      render_containers ["details", "entities"]
+      render_containers ["details", "subscribers"]
       render_update
     end
   end

data/app/controllers/maily_herald/webui/lists_controller.rb

@@ -17,7 +17,7 @@ module MailyHerald
       @item.unsubscribe! @entity
     end
 
-    def context_variables
+    def context_attributes
       @context = MailyHerald.context(params[:context])
 
       render layout: "maily_herald/webui/modal"
@@ -33,7 +33,7 @@ module MailyHerald
           scope.where("name like ? or title like ?", "%#{query}%", "%#{query}%")
         end
         spec.items_partial = "items"
-        spec.params = [:name, :title]
+        spec.params = [:name, :title, :context_name]
         spec.update_containers = {
           "subscribers" => true,
           "opt_outs" => true,

data/app/controllers/maily_herald/webui/mailings_controller.rb

@@ -38,10 +38,11 @@ module MailyHerald
         spec.params = [:title, :mailer_name, :list, :from, :conditions, :override_subscription, :subject, :template]
         spec.update_containers = {
           "template" => {editable: true},
-          "entities" => true,
-          "logs" => true
+          "subscribers" => true,
+          "logs" => true,
+          "schedules" => true
         }
-        spec.containers_order = ["details", "template", "entities", "logs"]
+        spec.containers_order = ["details", "template", "subscribers", "logs", "schedules"]
       end
     end
 
@@ -54,11 +55,22 @@ module MailyHerald
       containers.each do |container|
         case container
         when "logs"
-          @logs = smart_listing_create(:logs, @item.logs.processed, :partial => "maily_herald/webui/logs/items", default_sort: {processing_at: "desc"})
-        when "entities"
-          @entities = @item.list.subscribers
-          @entities = @entities.merge(@item.list.context.scope_like(params[:entities_filter])) if params[:entities_filter]
-          @entities = smart_listing_create(:entities, @entities, :partial => "maily_herald/webui/subscribers/list")
+          @logs = @item.logs.merge(log_scope).processed
+          @logs = @logs.merge(MailyHerald::Log.like_email(params[:logs_filter])) if params[:logs_filter]
+          @logs = smart_listing_create(:logs, @logs, :partial => "maily_herald/webui/logs/items", default_sort: {processing_at: "desc"})
+
+        when "schedules"
+          @schedules = @item.logs.scheduled
+          @schedules = @schedules.merge(MailyHerald::Log.like_email(params[:schedules_filter])) if params[:schedules_filter]
+          @schedules = smart_listing_create(:schedules, @schedules, :partial => "maily_herald/webui/logs/items", default_sort: {processing_at: "asc"})
+
+        when "subscribers"
+          @with_unmet_conditions = params[:with_unmet_conditions] == "1"
+
+          @subscribers = @item.list.subscribers
+          @subscribers = @subscribers.merge(@item.list.context.scope_like(params[:subscribers_filter])) if params[:subscribers_filter]
+          @subscribers = @subscribers.select{|e| @mailing.conditions_met?(e)} if @mailing.has_conditions? && params[:with_unmet_conditions] != "1"
+          @subscribers = smart_listing_create(:subscribers, @subscribers, :partial => "maily_herald/webui/subscribers/list", array: @mailing.has_conditions?)
         else
           yield(container) if block_given?
         end

data/app/controllers/maily_herald/webui/one_time_mailings_controller.rb

@@ -13,20 +13,23 @@ module MailyHerald
       super
     end
 
-    def deliver
-      find_item
+    protected
 
-      if params[:entity_id]
-        @e = @item.list.context.scope.find(params[:entity_id])
-        @item.deliver_to @e
+    def set_resource_spec
+      spec = super
+      spec.params.push(:start_at)
+      spec.update_containers["schedules"] = true
+      spec.containers_order = ["details", "template", "subscribers", "schedules", "logs"]
+      spec
+    end
 
-        render_containers ["logs"]
-        render_update
-      else
-        @item.run
-        head :ok
+    def action_dependencies *containers
+      super do |container|
+        case container
+        when "schedules"
+          @schedules = smart_listing_create(:schedules, @item.logs.scheduled, :partial => "maily_herald/webui/logs/items", default_sort: {processing_at: "asc"})
+        end
       end
     end
-
   end
 end