simple_discussion 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 584ec2c3ab8802d72c6f363f9b10ea08065caa9f
-  data.tar.gz: c53ec10ed28f235c1e5d30df9f76b8ef27c2ba88
+  metadata.gz: 51e4842c5231c0e38727a827f611702098fec999
+  data.tar.gz: adbe142113f0fbfb27f9fdc008a9ee43f712d4e5
 SHA512:
-  metadata.gz: '09cce64a0c017def10cc52dca5482101f62bfcf36669f72de4afc555f1e54b70256d0eb8a16cc661ab55fd58614ffd95c1c6d1a6886d0d900c39db8b71e94048'
-  data.tar.gz: acb759aa73030f40137b16475a2d51d4d2f0ae387c3592494334eaac4468b33ebb0256f77029d1af1221c9db6dc43301d252cfea7b4e0d5d249b98e6185c370a
+  metadata.gz: 384f95fab63ec0c666f1c3eabaa83e29cac9ff87f6dab4cd62d660e741ade40ef38f42ca47ff18c0b62ee56c281fb910230d41362ebbef8dffbddf74e65560c1
+  data.tar.gz: 1dbddb156f0e9df228df2787850dcfec7a8b58f32abfdd32251e6f66f9cea2a4c35ad5ce3a82a97dcbbb94a5cd0da0cc11cf32b4db1c83e2037c2763e1132bcc

data/README.md

@@ -90,6 +90,19 @@ rails g simple_discussion:helpers
 
 **NOTE:** Keep in mind that the more customization you do, the tougher gem upgrades will be in the future.
 
+### Email And Slack Notifications
+
+By default, SimpleDiscussion will attempt to send email and slack notifications for users subscribed to threads. To turn these off you can do the following in `config/initializers/simple_discussion.rb`
+
+```ruby
+SimpleDiscussion.setup do |config|
+  config.send_email_notifications = false # Default: true
+  config.send_slack_notifications = false # Default: true
+end
+```
+
+Slack notifications require you to set `simple_discussion_slack_url` in your `config/secrets.yml`. If you don't have this value set, it will not attempt Slack notifications even if they are enabled.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/app/controllers/simple_discussion/forum_posts_controller.rb

@@ -9,7 +9,7 @@ class SimpleDiscussion::ForumPostsController < SimpleDiscussion::ApplicationCont
     @forum_post.user_id = current_user.id
 
     if @forum_post.save
-      #ForumNotificationJob.perform_later(@forum_post.id)
+      SimpleDiscussion::ForumPostNotificationJob.perform_later(@forum_post)
       redirect_to simple_discussion.forum_thread_path(@forum_thread, anchor: "forum_post_#{@forum_post.id}")
     else
       render template: "simple_discussion/forum_threads/show"

data/app/controllers/simple_discussion/forum_threads_controller.rb

@@ -42,7 +42,7 @@ class SimpleDiscussion::ForumThreadsController < SimpleDiscussion::ApplicationCo
     @forum_thread.forum_posts.each{ |post| post.user_id = current_user.id }
 
     if @forum_thread.save
-      #ForumThreadNotificationJob.perform_later(@forum_thread.forum_posts.first.id)
+      SimpleDiscussion::ForumThreadNotificationJob.perform_later(@forum_thread)
       redirect_to simple_discussion.forum_thread_path(@forum_thread)
     else
       render action: :new

data/app/jobs/simple_discussion/forum_post_notification_job.rb

@@ -0,0 +1,42 @@
+class SimpleDiscussion::ForumPostNotificationJob < ApplicationJob
+  include SimpleDiscussion::Engine.routes.url_helpers
+
+  def perform(forum_post)
+    send_emails(forum_post) if SimpleDiscussion.send_email_notifications
+    send_webhook(forum_post) if SimpleDiscussion.send_slack_notifications
+  end
+
+  def send_emails(forum_post)
+    forum_thread = forum_post.forum_thread
+    users        = forum_thread.subscribed_users - [forum_post.user]
+    users.each do |user|
+      SimpleDiscussion::UserMailer.new_post(forum_post, user).deliver_later
+    end
+  end
+
+  def send_webhook(forum_post)
+    slack_webhook_url = Rails.application.secrets.simple_discussion_slack_url
+    return if slack_webhook_url.blank?
+
+    forum_thread = forum_post.forum_thread
+    payload = {
+      fallback: "#{forum_post.user.name} replied to <#{forum_thread_url(forum_thread, anchor: ActionView::RecordIdentifier.dom_id(forum_post))}|#{forum_thread.title}>",
+      pretext: "#{forum_post.user.name} replied to <#{forum_thread_url(forum_thread, anchor: ActionView::RecordIdentifier.dom_id(forum_post))}|#{forum_thread.title}>",
+      fields: [
+        {
+          title: "Thread",
+          value: forum_thread.title,
+          short: true
+        },
+        {
+          title: "Posted By",
+          value: forum_post.user.name,
+          short: true,
+        },
+      ],
+      ts: forum_post.created_at.to_i
+    }
+
+    SimpleDiscussion::Slack.new(slack_webhook_url).post(payload)
+  end
+end

data/app/jobs/simple_discussion/forum_thread_notification_job.rb

@@ -0,0 +1,40 @@
+class SimpleDiscussion::ForumThreadNotificationJob < ApplicationJob
+  include SimpleDiscussion::Engine.routes.url_helpers
+
+  def perform(forum_thread)
+    send_emails(forum_thread) if SimpleDiscussion.send_email_notifications
+    send_webhook(forum_thread) if SimpleDiscussion.send_slack_notifications
+  end
+
+  def send_emails(forum_thread)
+    forum_thread.notify_users.each do |user|
+      SimpleDiscussion::UserMailer.new_thread(forum_thread, user).deliver_later
+    end
+  end
+
+  def send_webhook(forum_thread)
+    slack_webhook_url = Rails.application.secrets.simple_discussion_slack_url
+    return if slack_webhook_url.blank?
+
+    forum_post = forum_thread.forum_posts.first
+    payload = {
+      fallback: "A new discussion was started: <#{forum_thread_url(forum_thread, anchor: ActionView::RecordIdentifier.dom_id(forum_post))}|#{forum_thread.title}>",
+      pretext: "A new discussion was started: <#{forum_thread_url(forum_thread, anchor: ActionView::RecordIdentifier.dom_id(forum_post))}|#{forum_thread.title}>",
+      fields: [
+        {
+          title: "Thread",
+          value: forum_thread.title,
+          short: true
+        },
+        {
+          title: "Posted By",
+          value: forum_post.user.name,
+          short: true,
+        },
+      ],
+      ts: forum_post.created_at.to_i
+    }
+
+    SimpleDiscussion::Slack.new(slack_webhook_url).post(payload)
+  end
+end

data/app/mailers/simple_discussion/user_mailer.rb

@@ -0,0 +1,28 @@
+class SimpleDiscussion::UserMailer < ApplicationMailer
+  # You can set the default `from` address in ApplicationMailer
+
+  helper SimpleDiscussion::ForumPostsHelper
+  helper SimpleDiscussion::Engine.routes.url_helpers
+
+  def new_thread(forum_thread, recipient)
+    @forum_thread = forum_thread
+    @forum_post   = forum_thread.forum_posts.first
+    @recipient    = recipient
+
+    mail(
+      to: "#{@recipient.name} <#{@recipient.email}>",
+      subject: @forum_thread.title
+    )
+  end
+
+  def new_post(forum_post, recipient)
+    @forum_post   = forum_post
+    @forum_thread = forum_post.forum_thread
+    @recipient    = recipient
+
+    mail(
+      to: "#{@recipient.name} <#{@recipient.email}>",
+      subject: "New post in #{@forum_thread.title}"
+    )
+  end
+end

data/app/models/forum_thread.rb

@@ -72,4 +72,12 @@ class ForumThread < ApplicationRecord
       "You're not receiving notifications from this thread."
     end
   end
+
+  # These are the users to notify on a new thread. Currently this does nothing,
+  # but you can override this to provide whatever functionality you like here.
+  #
+  # For example: You might use this to send all moderators an email of new threads.
+  def notify_users
+    []
+  end
 end

data/app/views/simple_discussion/user_mailer/new_post.html.erb

@@ -0,0 +1,12 @@
+<div style="position: relative">
+  <%= gravatar_image_tag @forum_post.user.email, style: "float: left" %>
+
+  <div style="margin-left:60px">
+    <p><strong><%= @forum_post.user.name %></strong> <small>commented:</small></p>
+    <%= formatted_content @forum_post.body %>
+  </div>
+</div>
+
+<br />
+
+<p><%= link_to "Reply to this comment", forum_thread_url(@forum_post.forum_thread, anchor: "forum_post_#{@forum_post.id}"), style: "background:#be2126; color:#fff; text-decoration:none; padding: 10px 20px" %></p>

data/app/views/simple_discussion/user_mailer/new_thread.html.erb

@@ -0,0 +1,12 @@
+<div style="position: relative">
+  <%= gravatar_image_tag @forum_post.user.email, style: "float: left" %>
+
+  <div style="margin-left:60px">
+    <p><strong><%= @forum_post.user.name %></strong> <small>commented:</small></p>
+    <%= formatted_content @forum_post.body %>
+  </div>
+</div>
+
+<br />
+
+<p><%= link_to "Reply to this comment", forum_thread_url(@forum_post.forum_thread, anchor: "forum_post_#{@forum_post.id}"), style: "background:#be2126; color:#fff; text-decoration:none; padding: 10px 20px" %></p>

data/lib/simple_discussion.rb

@@ -3,60 +3,20 @@ require 'friendly_id'
 require 'gravatar_image_tag'
 require 'will_paginate'
 
-require "simple_discussion/version"
-require "simple_discussion/engine"
-require "simple_discussion/forum_user"
-
-require 'will_paginate/view_helpers/action_view'
+require 'simple_discussion/engine'
+require 'simple_discussion/forum_user'
+require 'simple_discussion/slack'
+require 'simple_discussion/version'
+require 'simple_discussion/will_paginate'
 
 module SimpleDiscussion
-  # This code serves two purposes
-  # 1. It patches will_paginate to work with scoped and mounted Rails engines
-  #    by adding in the url_builder option
-  # 2. It adds Bootstrap 4 styling to will_paginate
-
-  class BootstrapLinkRenderer < WillPaginate::ActionView::LinkRenderer
-
-    # This method adds the `url_builder` option so we can pass in the
-    # mounted Rails engine's scope for will_paginate
-    def url(page)
-      @base_url_params ||= begin
-                             url_params = merge_get_params(default_url_params)
-                             merge_optional_params(url_params)
-                           end
-
-      url_params = @base_url_params.dup
-      add_current_page_param(url_params, page)
-
-      # Add optional url_builder support
-      (@options[:url_builder] || @template).url_for(url_params)
-    end
-
-    protected
-    def html_container(html)
-      tag :nav, tag(:ul, html, class: ul_class)
-    end
-
-    def page_number(page)
-      item_class = if(page == current_page)
-        'active page-item'
-      else
-        'page-item'
-      end
-
-      tag :li, link(page, page, :rel => rel_value(page), :class => 'page-link'), :class => item_class
-    end
-
-    def gap
-      tag :li, link('&hellip;'.html_safe, '#', :class => 'page-link'), :class => 'page-item disabled'
-    end
-
-    def previous_or_next_page(page, text, classname)
-      tag :li, link(text, page || '#', :class => 'page-link'), :class => [(classname[0..3] if  @options[:page_links]), (classname if @options[:page_links]), ('disabled' unless page), 'page-item'].join(' ')
-    end
-
-    def ul_class
-       ["pagination", container_attributes[:class]].compact.join(" ")
-    end
+  # Define who owns the subscription
+  mattr_accessor :send_email_notifications
+  mattr_accessor :send_slack_notifications
+  @@send_email_notifications = true
+  @@send_slack_notifications = true
+
+  def self.setup
+    yield self
   end
 end

data/lib/simple_discussion/engine.rb

@@ -1,5 +1,10 @@
 module SimpleDiscussion
   class Engine < ::Rails::Engine
     engine_name 'simple_discussion'
+
+    # Grab the Rails default url options and use them for sending notifications
+    config.after_initialize do
+      SimpleDiscussion::Engine.routes.default_url_options = ActionMailer::Base.default_url_options
+    end
   end
 end

data/lib/simple_discussion/slack.rb

@@ -0,0 +1,22 @@
+require 'open-uri'
+require 'net/http'
+
+module SimpleDiscussion
+  class Slack
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def post(payload)
+      uri          = URI.parse(url)
+      request      = Net::HTTP::Post.new(uri)
+      req_options  = { use_ssl: uri.scheme == "https", }
+      request.body = "payload=#{payload.to_json}"
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/simple_discussion/version.rb

@@ -1,3 +1,3 @@
 module SimpleDiscussion
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/lib/simple_discussion/will_paginate.rb

@@ -0,0 +1,53 @@
+require 'will_paginate/view_helpers/action_view'
+
+module SimpleDiscussion
+  # This code serves two purposes
+  # 1. It patches will_paginate to work with scoped and mounted Rails engines
+  #    by adding in the url_builder option
+  # 2. It adds Bootstrap 4 styling to will_paginate
+
+  class BootstrapLinkRenderer < WillPaginate::ActionView::LinkRenderer
+
+    # This method adds the `url_builder` option so we can pass in the
+    # mounted Rails engine's scope for will_paginate
+    def url(page)
+      @base_url_params ||= begin
+                             url_params = merge_get_params(default_url_params)
+                             merge_optional_params(url_params)
+                           end
+
+      url_params = @base_url_params.dup
+      add_current_page_param(url_params, page)
+
+      # Add optional url_builder support
+      (@options[:url_builder] || @template).url_for(url_params)
+    end
+
+    protected
+    def html_container(html)
+      tag :nav, tag(:ul, html, class: ul_class)
+    end
+
+    def page_number(page)
+      item_class = if(page == current_page)
+        'active page-item'
+      else
+        'page-item'
+      end
+
+      tag :li, link(page, page, :rel => rel_value(page), :class => 'page-link'), :class => item_class
+    end
+
+    def gap
+      tag :li, link('&hellip;'.html_safe, '#', :class => 'page-link'), :class => 'page-item disabled'
+    end
+
+    def previous_or_next_page(page, text, classname)
+      tag :li, link(text, page || '#', :class => 'page-link'), :class => [(classname[0..3] if  @options[:page_links]), (classname if @options[:page_links]), ('disabled' unless page), 'page-item'].join(' ')
+    end
+
+    def ul_class
+       ["pagination", container_attributes[:class]].compact.join(" ")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_discussion
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Chris Oliver
@@ -102,6 +102,9 @@ files:
 - app/controllers/simple_discussion/notifications_controller.rb
 - app/helpers/simple_discussion/forum_posts_helper.rb
 - app/helpers/simple_discussion/forum_threads_helper.rb
+- app/jobs/simple_discussion/forum_post_notification_job.rb
+- app/jobs/simple_discussion/forum_thread_notification_job.rb
+- app/mailers/simple_discussion/user_mailer.rb
 - app/models/forum_category.rb
 - app/models/forum_post.rb
 - app/models/forum_subscription.rb
@@ -117,6 +120,8 @@ files:
 - app/views/simple_discussion/forum_threads/index.html.erb
 - app/views/simple_discussion/forum_threads/new.html.erb
 - app/views/simple_discussion/forum_threads/show.html.erb
+- app/views/simple_discussion/user_mailer/new_post.html.erb
+- app/views/simple_discussion/user_mailer/new_thread.html.erb
 - bin/console
 - bin/setup
 - config/routes.rb
@@ -130,7 +135,9 @@ files:
 - lib/simple_discussion.rb
 - lib/simple_discussion/engine.rb
 - lib/simple_discussion/forum_user.rb
+- lib/simple_discussion/slack.rb
 - lib/simple_discussion/version.rb
+- lib/simple_discussion/will_paginate.rb
 - simple_discussion.gemspec
 homepage: https://github.com/excid3/simple_discussion
 licenses: