diff --git a/app/assets/stylesheets/common/admin/admin_base.scss b/app/assets/stylesheets/common/admin/admin_base.scss
index 8688fdfb5..d8a734cf7 100644
--- a/app/assets/stylesheets/common/admin/admin_base.scss
+++ b/app/assets/stylesheets/common/admin/admin_base.scss
@@ -297,7 +297,7 @@ td.flaggers td {
height: 150px;
}
-.groups, .badges {
+.groups, .badges, .web-hook-container {
.form-horizontal {
label {
font-weight: bold;
@@ -311,12 +311,24 @@ td.flaggers td {
width: 350px;
}
- input[type="checkbox"] {
+ input[type="checkbox"], input[type="radio"] {
width: 20px;
}
}
}
+.text-successful {
+ color: $success;
+}
+
+.text-danger {
+ color: $danger;
+}
+
+.text-muted {
+ color: lighten($primary, 40);
+}
+
.admin-nav {
width: 18.018%;
position: relative;
@@ -394,7 +406,7 @@ td.flaggers td {
float: left;
width: 53%;
padding-right: 20px;
- .category-group {
+ .category-selector {
width: 95%;
}
@media (max-width: $mobile-breakpoint) {
@@ -1248,6 +1260,21 @@ table.api-keys {
}
+.hook-event {
+ display: inline-block;
+ width: 40%;
+
+ margin-left: 20px;
+
+ label {
+ display: inline-block;
+ }
+
+ p {
+ margin: 0 0 5px 25px;
+ }
+}
+
.email-template {
input {
width: 100%;
@@ -1805,6 +1832,80 @@ table#user-badges {
}
}
+// Webhook
+
+.web-hook-container {
+ > p {
+ padding-bottom: 10px;
+ border-bottom: darken($secondary, 10%) 1px solid;
+ }
+ .filters {
+ margin: 5px 0;
+ padding-bottom: 5px;
+ border-bottom: darken($secondary, 5%) 1px solid;
+ }
+ .instructions {
+ margin-top: 5px;
+ }
+ .subscription-choice {
+ margin-bottom: 10px;
+ }
+}
+
+.web-hook-direction {
+ button {
+ margin-right: 10px;
+ }
+}
+
+.web-hook-events {
+ margin-top: 15px;
+
+ li {
+ padding: 2px 0;
+ }
+
+ .col {
+ display: inline-block;
+ padding-top: 6px;
+ vertical-align: top;
+ overflow-y: auto;
+ overflow-x: hidden;
+ }
+
+ .col.first {
+ width: 30px;
+ }
+
+ .col.event-id {
+ width: 300px;
+ }
+
+ .col.timestamp {
+ width: 150px;
+ }
+
+ .col.completion {
+ width: 220px;
+ }
+
+ .col.actions {
+ width: 305px;
+ padding-top: 0;
+ a {
+ text-decoration: underline;
+ }
+ }
+
+ .details {
+ display: block;
+ margin-top: 10px;
+ }
+ label {
+ font-size: 1.05em;
+ }
+}
+
// Mobile specific styles
// Mobile view text-inputs need some padding
.mobile-view .admin-contents {
diff --git a/app/assets/stylesheets/desktop/user.scss b/app/assets/stylesheets/desktop/user.scss
index 6a1d03446..4c57444da 100644
--- a/app/assets/stylesheets/desktop/user.scss
+++ b/app/assets/stylesheets/desktop/user.scss
@@ -20,7 +20,7 @@
}
.user-preferences {
- input.category-group, input.user-selector {
+ input.category-selector, input.user-selector {
width: 530px;
}
diff --git a/app/assets/stylesheets/mobile/user.scss b/app/assets/stylesheets/mobile/user.scss
index 6a559260b..a82419bd9 100644
--- a/app/assets/stylesheets/mobile/user.scss
+++ b/app/assets/stylesheets/mobile/user.scss
@@ -86,7 +86,7 @@
}
.user-preferences {
- input.category-group {
+ input.category-selector {
}
textarea {
diff --git a/app/controllers/admin/web_hooks_controller.rb b/app/controllers/admin/web_hooks_controller.rb
new file mode 100644
index 000000000..d70048c74
--- /dev/null
+++ b/app/controllers/admin/web_hooks_controller.rb
@@ -0,0 +1,114 @@
+class Admin::WebHooksController < Admin::AdminController
+ before_filter :fetch_web_hook, only: %i(show update destroy list_events ping)
+
+ def index
+ limit = 50
+ offset = params[:offset].to_i
+
+ web_hooks = WebHook.limit(limit)
+ .offset(offset)
+ .includes(:web_hook_event_types)
+ .includes(:categories)
+ .includes(:groups)
+
+ json = {
+ web_hooks: serialize_data(web_hooks, AdminWebHookSerializer),
+ extras: {
+ event_types: WebHookEventType.all,
+ default_event_types: WebHook.default_event_types,
+ content_types: WebHook.content_types.map { |name, id| { id: id, name: name } },
+ delivery_statuses: WebHook.last_delivery_statuses.map { |name, id| { id: id, name: name.to_s } },
+ },
+ total_rows_web_hooks: WebHook.count,
+ load_more_web_hooks: admin_web_hooks_path(limit: limit, offset: offset + limit, format: :json)
+ }
+
+ render json: MultiJson.dump(json), status: 200
+ end
+
+ def show
+ render_serialized(@web_hook, AdminWebHookSerializer, root: 'web_hook')
+ end
+
+ def create
+ web_hook = WebHook.new(web_hook_params)
+
+ if web_hook.save
+ render_serialized(web_hook, AdminWebHookSerializer, root: 'web_hook')
+ else
+ render_json_error web_hook.errors.full_messages
+ end
+ end
+
+ def update
+ if @web_hook.update_attributes(web_hook_params)
+ render_serialized(@web_hook, AdminWebHookSerializer, root: 'web_hook')
+ else
+ render_json_error @web_hook.errors.full_messages
+ end
+ end
+
+ def destroy
+ @web_hook.destroy!
+ render json: success_json
+ end
+
+ def new
+ end
+
+ def list_events
+ limit = 50
+ offset = params[:offset].to_i
+
+ json = {
+ web_hook_events: serialize_data(@web_hook.web_hook_events.limit(limit).offset(offset), AdminWebHookEventSerializer),
+ total_rows_web_hook_events: @web_hook.web_hook_events.count,
+ load_more_web_hook_events: admin_web_hook_events_path(limit: limit, offset: offset + limit, format: :json),
+ extras: {
+ web_hook_id: @web_hook.id
+ }
+ }
+
+ render json: MultiJson.dump(json), status: 200
+ end
+
+ def redeliver_event
+ web_hook_event = WebHookEvent.find(params[:event_id])
+
+ if web_hook_event
+ web_hook = web_hook_event.web_hook
+ conn = Excon.new(URI(web_hook.payload_url).to_s,
+ ssl_verify_peer: web_hook.verify_certificate,
+ retry_limit: 0)
+
+ now = Time.zone.now
+ response = conn.post(headers: MultiJson.load(web_hook_event.headers), body: web_hook_event.payload)
+ web_hook_event.update_attributes!(status: response.status,
+ response_headers: MultiJson.dump(response.headers),
+ response_body: response.body,
+ duration: ((Time.zone.now - now) * 1000).to_i)
+ render_serialized(web_hook_event, AdminWebHookEventSerializer, root: 'web_hook_event')
+ else
+ render json: failed_json
+ end
+ end
+
+ def ping
+ Jobs.enqueue(:emit_web_hook_event, web_hook_id: @web_hook.id, event_type: 'ping')
+ render json: success_json
+ end
+
+ private
+
+ def web_hook_params
+ params.require(:web_hook).permit(:payload_url, :content_type, :secret,
+ :wildcard_web_hook, :active, :verify_certificate,
+ web_hook_event_type_ids: [],
+ group_ids: [],
+ category_ids: [])
+ end
+
+ def fetch_web_hook
+ @web_hook = WebHook.find(params[:id])
+ end
+end
diff --git a/app/jobs/regular/emit_web_hook_event.rb b/app/jobs/regular/emit_web_hook_event.rb
new file mode 100644
index 000000000..56a31b6c7
--- /dev/null
+++ b/app/jobs/regular/emit_web_hook_event.rb
@@ -0,0 +1,101 @@
+require 'excon'
+
+module Jobs
+ class EmitWebHookEvent < Jobs::Base
+ def execute(args)
+ raise Discourse::InvalidParameters.new(:web_hook_id) unless args[:web_hook_id].present?
+ raise Discourse::InvalidParameters.new(:event_type) unless args[:event_type].present?
+
+ @web_hook = WebHook.find(args[:web_hook_id])
+
+ unless args[:event_type] == 'ping'
+ return unless @web_hook.active?
+ return if @web_hook.group_ids.present? && (args[:group_id].present? ||
+ !@web_hook.group_ids.include?(args[:group_id]))
+ return if @web_hook.category_ids.present? && (!args[:category_id].present? ||
+ !@web_hook.category_ids.include?(args[:category_id]))
+ end
+
+ @opts = args
+
+ web_hook_request
+ end
+
+ private
+
+ def web_hook_request
+ uri = URI(@web_hook.payload_url)
+ conn = Excon.new(uri.to_s,
+ ssl_verify_peer: @web_hook.verify_certificate,
+ retry_limit: 0)
+
+ body = build_web_hook_body
+ web_hook_event = WebHookEvent.create!(web_hook_id: @web_hook.id)
+
+ begin
+ content_type = case @web_hook.content_type
+ when WebHook.content_types['application/x-www-form-urlencoded']
+ 'application/x-www-form-urlencoded'
+ else
+ 'application/json'
+ end
+ headers = {
+ 'Accept' => '*/*',
+ 'Connection' => 'close',
+ 'Content-Length' => body.size,
+ 'Content-Type' => content_type,
+ 'Host' => uri.host,
+ 'User-Agent' => "Discourse/" + Discourse::VERSION::STRING,
+ 'X-Discourse-Event-Id' => web_hook_event.id,
+ 'X-Discourse-Event-Type' => @opts[:event_type]
+ }
+ headers['X-Discourse-Event'] = @opts[:event_name] if @opts[:event_name].present?
+
+ if @web_hook.secret.present?
+ headers['X-Discourse-Event-Signature'] = "sha256=" + OpenSSL::HMAC.hexdigest("sha256", @web_hook.secret, body)
+ end
+
+ now = Time.zone.now
+ response = conn.post(headers: headers, body: body)
+ rescue
+ web_hook_event.destroy!
+ end
+
+ web_hook_event.update_attributes!(headers: MultiJson.dump(headers),
+ payload: body,
+ status: response.status,
+ response_headers: MultiJson.dump(response.headers),
+ response_body: response.body,
+ duration: ((Time.zone.now - now) * 1000).to_i)
+ end
+
+ def build_web_hook_body
+ body = {}
+ web_hook_user = Discourse.system_user
+ guardian = Guardian.new(web_hook_user)
+
+ if @opts[:topic_id]
+ topic_view = TopicView.new(@opts[:topic_id], web_hook_user)
+ body[:topic] = TopicViewSerializer.new(topic_view, scope: guardian, root: false).as_json
+ end
+
+ if @opts[:post_id]
+ post = Post.find(@opts[:post_id])
+ body[:post] = PostSerializer.new(post, scope: guardian, root: false).as_json
+ end
+
+ if @opts[:user_id]
+ user = User.find(@opts[:user_id])
+ body[:user] = UserSerializer.new(user, scope: guardian, root: false).as_json
+ end
+
+ body[:ping] = 'OK' if @opts[:event_type] == 'ping'
+
+ raise Discourse::InvalidParameters.new if body.empty?
+
+ MultiJson.dump(body)
+ end
+
+ end
+
+end
diff --git a/app/models/category.rb b/app/models/category.rb
index bc841d62b..f6925a428 100644
--- a/app/models/category.rb
+++ b/app/models/category.rb
@@ -27,6 +27,8 @@ class Category < ActiveRecord::Base
has_many :category_groups, dependent: :destroy
has_many :groups, through: :category_groups
+ has_and_belongs_to_many :web_hooks
+
validates :user_id, presence: true
validates :name, if: Proc.new { |c| c.new_record? || c.name_changed? },
presence: true,
diff --git a/app/models/group.rb b/app/models/group.rb
index 133dfdf08..772f689f0 100644
--- a/app/models/group.rb
+++ b/app/models/group.rb
@@ -10,6 +10,8 @@ class Group < ActiveRecord::Base
has_many :categories, through: :category_groups
has_many :users, through: :group_users
+ has_and_belongs_to_many :web_hooks
+
before_save :downcase_incoming_email
after_save :destroy_deletions
diff --git a/app/models/web_hook.rb b/app/models/web_hook.rb
new file mode 100644
index 000000000..de1fc9d12
--- /dev/null
+++ b/app/models/web_hook.rb
@@ -0,0 +1,86 @@
+class WebHook < ActiveRecord::Base
+ has_and_belongs_to_many :web_hook_event_types
+ has_and_belongs_to_many :groups
+ has_and_belongs_to_many :categories
+
+ has_many :web_hook_events, dependent: :destroy
+
+ default_scope { order('id ASC') }
+
+ validates :payload_url, presence: true, format: URI::regexp(%w(http https))
+ validates :secret, length: { minimum: 12 }, allow_blank: true
+ validates_presence_of :content_type
+ validates_presence_of :last_delivery_status
+ validates_presence_of :web_hook_event_types, unless: :wildcard_web_hook?
+
+ def self.content_types
+ @content_types ||= Enum.new('application/json' => 1,
+ 'application/x-www-form-urlencoded' => 2)
+ end
+
+ def self.last_delivery_statuses
+ @last_delivery_statuses ||= Enum.new(inactive: 1,
+ failed: 2,
+ successful: 3)
+ end
+
+ def self.default_event_types
+ [WebHookEventType.find(WebHookEventType::POST)]
+ end
+
+ def self.find_by_type(type)
+ WebHook.where(active: true)
+ .joins(:web_hook_event_types)
+ .where("web_hooks.wildcard_web_hook = ? OR web_hook_event_types.name = ?", true, type.to_s)
+ end
+
+ def self.enqueue_hooks(type, opts = {})
+ find_by_type(type).each do |w|
+ Jobs.enqueue(:emit_web_hook_event, opts.merge(web_hook_id: w.id, event_type: type.to_s))
+ end
+ end
+
+ def self.enqueue_topic_hooks(topic, user)
+ WebHook.enqueue_hooks(:topic, topic_id: topic.id, user_id: user&.id, category_id: topic&.category&.id)
+ end
+
+ %i(topic_destroyed topic_recovered).each do |event|
+ DiscourseEvent.on(event) do |topic, user|
+ WebHook.enqueue_topic_hooks(topic, user)
+ end
+ end
+
+ DiscourseEvent.on(:topic_created) do |topic, _, user|
+ WebHook.enqueue_topic_hooks(topic, user)
+ end
+
+ %i(post_created
+ post_destroyed
+ post_recovered).each do |event|
+
+ DiscourseEvent.on(event) do |post, _, user|
+ WebHook.enqueue_hooks(:post,
+ post_id: post.id,
+ topic_id: post&.topic&.id,
+ user_id: user&.id,
+ category_id: post.topic&.category&.id
+ )
+ end
+ end
+end
+
+# == Schema Information
+#
+# Table name: web_hooks
+#
+# id :integer not null, primary key
+# payload_url :string not null
+# content_type :integer default(1), not null
+# last_delivery_status :integer default(1), not null
+# secret :string default("")
+# wildcard_web_hook :boolean default(FALSE), not null
+# verify_certificate :boolean default(TRUE), not null
+# active :boolean default(FALSE), not null
+# created_at :datetime
+# updated_at :datetime
+#
diff --git a/app/models/web_hook_event.rb b/app/models/web_hook_event.rb
new file mode 100644
index 000000000..f2720a912
--- /dev/null
+++ b/app/models/web_hook_event.rb
@@ -0,0 +1,37 @@
+class WebHookEvent < ActiveRecord::Base
+ belongs_to :web_hook
+
+ after_save :update_web_hook_delivery_status
+
+ default_scope { order('created_at DESC') }
+
+ def update_web_hook_delivery_status
+ web_hook.last_delivery_status = case status
+ when 200..299
+ WebHook.last_delivery_statuses[:successful]
+ else
+ WebHook.last_delivery_statuses[:failed]
+ end
+ web_hook.save!
+ end
+end
+
+# == Schema Information
+#
+# Table name: web_hook_events
+#
+# id :integer not null, primary key
+# web_hook_id :integer not null
+# headers :string
+# payload :text
+# status :integer
+# response_headers :string
+# response_body :text
+# duration :integer default(0)
+# created_at :datetime
+# updated_at :datetime
+#
+# Indexes
+#
+# index_web_hook_events_on_web_hook_id (web_hook_id)
+#
diff --git a/app/models/web_hook_event_type.rb b/app/models/web_hook_event_type.rb
new file mode 100644
index 000000000..139dd912f
--- /dev/null
+++ b/app/models/web_hook_event_type.rb
@@ -0,0 +1,18 @@
+class WebHookEventType < ActiveRecord::Base
+ TOPIC = 1
+ POST = 2
+
+ has_and_belongs_to_many :web_hooks
+
+ default_scope { order('id ASC') }
+
+ validates :name, presence: true, uniqueness: true
+end
+
+# == Schema Information
+#
+# Table name: web_hook_event_types
+#
+# id :integer not null, primary key
+# name :string not null
+#
diff --git a/app/serializers/admin_web_hook_event_serializer.rb b/app/serializers/admin_web_hook_event_serializer.rb
new file mode 100644
index 000000000..0343d1739
--- /dev/null
+++ b/app/serializers/admin_web_hook_event_serializer.rb
@@ -0,0 +1,17 @@
+class AdminWebHookEventSerializer < ApplicationSerializer
+ attributes :id,
+ :web_hook_id,
+ :request_url,
+ :headers,
+ :payload,
+ :status,
+ :response_headers,
+ :response_body,
+ :duration,
+ :created_at
+
+
+ def request_url
+ object.web_hook.payload_url
+ end
+end
diff --git a/app/serializers/admin_web_hook_serializer.rb b/app/serializers/admin_web_hook_serializer.rb
new file mode 100644
index 000000000..ff74ae3f9
--- /dev/null
+++ b/app/serializers/admin_web_hook_serializer.rb
@@ -0,0 +1,18 @@
+class AdminWebHookSerializer < ApplicationSerializer
+ attributes :id,
+ :payload_url,
+ :content_type,
+ :last_delivery_status,
+ :secret,
+ :wildcard_web_hook,
+ :verify_certificate,
+ :active,
+ :web_hook_event_types
+
+ has_many :categories, serializer: BasicCategorySerializer, embed: :ids, include: false
+ has_many :groups, serializer: BasicGroupSerializer, embed: :ids, include: false
+
+ def web_hook_event_types
+ ActiveModel::ArraySerializer.new(object.web_hook_event_types).as_json
+ end
+end
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index 2897d0cfb..fbe90abc7 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -2428,6 +2428,69 @@ en:
all_users: "All Users"
note_html: "Keep this key
secret, all users that have it may create arbitrary posts as any user."
+ web_hooks:
+ title: "Webhooks"
+ none: "There are no webhooks right now."
+ instruction: "Webhooks allows Discourse to notify external services when certain event happens in your site. When the webhook is triggered, a POST request will send to URLs provided."
+ detailed_instruction: "A POST request will be sent to provided URL when chosen event happens."
+ new: "New Webhook"
+ create: "Create"
+ save: "Save"
+ destroy: "Delete"
+ description: "Description"
+ controls: "Controls"
+ go_back: "Back to list"
+ payload_url: "Payload URL"
+ payload_url_placeholder: "https://example.com/postreceive"
+ warn_local_payload_url: "It seems you are trying to set up the webhook to a local url. Event delivered to a local address may cause side-effect or unexpected behaviours. Continue?"
+ secret_invalid: "Secret must not have any blank characters."
+ secret_too_short: "Secret should be at least 12 characters."
+ secret_placeholder: "A optional string, used for generating signature"
+ event_type_missing: "You need to set up at least one event type."
+ content_type: "Content Type"
+ secret: "Secret"
+ event_chooser: "Which events would you like to trigger this webhook?"
+ wildcard_event: "Send me everything."
+ individual_event: "Select individual events."
+ verify_certificate: "Check TLS certificate of payload url"
+ active: "Active"
+ active_notice: "We will deliver event details when it happens."
+ categories_filter_instructions: "Relevant webhooks will only be triggered if the event is related with specified categories. Leave blank to trigger webhooks for all categories."
+ categories_filter: "Triggered Categories"
+ groups_filter_instructions: "Relevant webhooks will only be triggered if the event is related with specified groups. Leave blank to trigger webhooks for all groups."
+ groups_filter: "Triggered Groups"
+ delete_confirm: "Delete this webhook?"
+ topic_event:
+ name: "Topic Event"
+ details: "When there is a new topic, revised, changed or deleted."
+ post_event:
+ name: "Post Event"
+ details: "When there is a new reply, edit, deleted or recovered."
+ invitation_event:
+ name: "Invitation Event"
+ details: "When a invitation is sent or accepted."
+ user_event:
+ name: "User Event"
+ details: "When there is a user is created or changed."
+ delivery_status:
+ title: "Delivery Status"
+ inactive: "Inactive"
+ failed: "Failed"
+ successful: "Successful"
+ events:
+ none: "There are no related events."
+ redeliver: "Redeliver"
+ completion: "Completed in %{seconds} seconds."
+ request: "Request"
+ response: "Response"
+ redeliver_confirm: "Are you sure you want to redeliver the same payload?"
+ headers: "Headers"
+ payload: "Payload"
+ body: "Body"
+ go_list: "Go to list"
+ go_details: "Edit webhook"
+ go_events: "Go to events"
+ ping: "Ping"
plugins:
title: "Plugins"
installed: "Installed Plugins"
diff --git a/config/locales/server.en.yml b/config/locales/server.en.yml
index 524c9c52f..c9ba20b69 100644
--- a/config/locales/server.en.yml
+++ b/config/locales/server.en.yml
@@ -350,7 +350,10 @@ en:
post_reply:
base:
different_topic: "Post and reply must belong to the same topic."
-
+ web_hook:
+ attributes:
+ payload_url:
+ invalid: "URL is invalid. URL should includes http:// or https://. And no blank is allowed."
user_profile:
no_info_me: "
"
diff --git a/config/routes.rb b/config/routes.rb
index 19740cb18..ca9e1d2df 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -206,6 +206,12 @@ Discourse::Application.routes.draw do
end
end
+ resources :web_hooks, constraints: AdminConstraint.new
+ get 'web_hook_events/:id' => 'web_hooks#list_events', constraints: AdminConstraint.new, as: :web_hook_events
+ get 'web_hooks/:id/events' => 'web_hooks#list_events', constraints: AdminConstraint.new
+ post 'web_hooks/:web_hook_id/events/:event_id/redeliver' => 'web_hooks#redeliver_event', constraints: AdminConstraint.new
+ post 'web_hooks/:id/ping' => 'web_hooks#ping', constraints: AdminConstraint.new
+
resources :backups, only: [:index, :create], constraints: AdminConstraint.new do
member do
get "" => "backups#show", constraints: { id: BACKUP_ROUTE_FORMAT }
diff --git a/db/fixtures/007_web_hook_event_types.rb b/db/fixtures/007_web_hook_event_types.rb
new file mode 100644
index 000000000..afa74b88d
--- /dev/null
+++ b/db/fixtures/007_web_hook_event_types.rb
@@ -0,0 +1,9 @@
+WebHookEventType.seed do |b|
+ b.id = WebHookEventType::TOPIC
+ b.name = "topic"
+end
+
+WebHookEventType.seed do |b|
+ b.id = WebHookEventType::POST
+ b.name = "post"
+end
diff --git a/db/migrate/20160905082217_create_web_hook_event_types.rb b/db/migrate/20160905082217_create_web_hook_event_types.rb
new file mode 100644
index 000000000..44466d451
--- /dev/null
+++ b/db/migrate/20160905082217_create_web_hook_event_types.rb
@@ -0,0 +1,7 @@
+class CreateWebHookEventTypes < ActiveRecord::Migration
+ def change
+ create_table :web_hook_event_types do |t|
+ t.string :name, null: false
+ end
+ end
+end
diff --git a/db/migrate/20160905082248_create_web_hooks.rb b/db/migrate/20160905082248_create_web_hooks.rb
new file mode 100644
index 000000000..f0f592507
--- /dev/null
+++ b/db/migrate/20160905082248_create_web_hooks.rb
@@ -0,0 +1,16 @@
+class CreateWebHooks < ActiveRecord::Migration
+ def change
+ create_table :web_hooks do |t|
+ t.string :payload_url, null: false
+ t.integer :content_type, default: 1, null: false
+ t.integer :last_delivery_status, default: 1, null: false
+ t.integer :status, default: 1, null: false
+ t.string :secret, default: ''
+ t.boolean :wildcard_web_hook, default: false, null: false
+ t.boolean :verify_certificate, default: true, null: false
+ t.boolean :active, default: false, null: false
+
+ t.timestamps
+ end
+ end
+end
diff --git a/db/migrate/20160905084502_create_web_hook_events.rb b/db/migrate/20160905084502_create_web_hook_events.rb
new file mode 100644
index 000000000..9f1552015
--- /dev/null
+++ b/db/migrate/20160905084502_create_web_hook_events.rb
@@ -0,0 +1,15 @@
+class CreateWebHookEvents < ActiveRecord::Migration
+ def change
+ create_table :web_hook_events do |t|
+ t.belongs_to :web_hook, null: false, index: true
+ t.string :headers
+ t.text :payload
+ t.integer :status, default: 0
+ t.string :response_headers
+ t.text :response_body
+ t.integer :duration, default: 0
+
+ t.timestamps
+ end
+ end
+end
diff --git a/db/migrate/20160905085445_create_join_table_web_hooks_web_hook_event_types.rb b/db/migrate/20160905085445_create_join_table_web_hooks_web_hook_event_types.rb
new file mode 100644
index 000000000..28c54d3ab
--- /dev/null
+++ b/db/migrate/20160905085445_create_join_table_web_hooks_web_hook_event_types.rb
@@ -0,0 +1,9 @@
+class CreateJoinTableWebHooksWebHookEventTypes < ActiveRecord::Migration
+ def change
+ create_join_table :web_hooks, :web_hook_event_types
+
+ add_index :web_hook_event_types_hooks, [:web_hook_event_type_id, :web_hook_id],
+ name: 'idx_web_hook_event_types_hooks_on_ids',
+ unique: true
+ end
+end
diff --git a/db/migrate/20160905091958_create_join_table_web_hooks_groups.rb b/db/migrate/20160905091958_create_join_table_web_hooks_groups.rb
new file mode 100644
index 000000000..a23760771
--- /dev/null
+++ b/db/migrate/20160905091958_create_join_table_web_hooks_groups.rb
@@ -0,0 +1,6 @@
+class CreateJoinTableWebHooksGroups < ActiveRecord::Migration
+ def change
+ create_join_table :web_hooks, :groups
+ add_index :groups_web_hooks, [:web_hook_id, :group_id], unique: true
+ end
+end
diff --git a/db/migrate/20160905092148_create_join_table_web_hooks_categories.rb b/db/migrate/20160905092148_create_join_table_web_hooks_categories.rb
new file mode 100644
index 000000000..8759ff64a
--- /dev/null
+++ b/db/migrate/20160905092148_create_join_table_web_hooks_categories.rb
@@ -0,0 +1,6 @@
+class CreateJoinTableWebHooksCategories < ActiveRecord::Migration
+ def change
+ create_join_table :web_hooks, :categories
+ add_index :categories_web_hooks, [:web_hook_id, :category_id], unique: true
+ end
+end
diff --git a/spec/fabricators/web_hook_fabricator.rb b/spec/fabricators/web_hook_fabricator.rb
new file mode 100644
index 000000000..3d10b267a
--- /dev/null
+++ b/spec/fabricators/web_hook_fabricator.rb
@@ -0,0 +1,30 @@
+Fabricator(:web_hook) do
+ payload_url 'https://meta.discourse.org/webhook_listener'
+ content_type WebHook.content_types['application/json']
+ wildcard_web_hook false
+ secret 'my_lovely_secret_for_web_hook'
+ verify_certificate true
+ active true
+
+ transient post_hook: WebHookEventType.find_by(name: 'post')
+
+ after_build do |web_hook, transients|
+ web_hook.web_hook_event_types << transients[:post_hook]
+ end
+end
+
+Fabricator(:inactive_web_hook, from: :web_hook) do
+ active false
+end
+
+Fabricator(:wildcard_web_hook, from: :web_hook) do
+ wildcard_web_hook true
+end
+
+Fabricator(:topic_web_hook, from: :web_hook) do
+ transient topic_hook: WebHookEventType.find_by(name: 'topic')
+
+ after_build do |web_hook, transients|
+ web_hook.web_hook_event_types = [transients[:topic_hook]]
+ end
+end
diff --git a/spec/jobs/emit_web_hook_event_spec.rb b/spec/jobs/emit_web_hook_event_spec.rb
new file mode 100644
index 000000000..e7ba30fb0
--- /dev/null
+++ b/spec/jobs/emit_web_hook_event_spec.rb
@@ -0,0 +1,91 @@
+require 'rails_helper'
+
+describe Jobs::EmitWebHookEvent do
+ let(:post_hook) { Fabricate(:web_hook) }
+ let(:inactive_hook) { Fabricate(:inactive_web_hook) }
+ let(:post) { Fabricate(:post) }
+ let(:user) { Fabricate(:user) }
+
+ it 'raises an error when there is no web hook record' do
+ expect { subject.execute(event_type: 'post') }.to raise_error(Discourse::InvalidParameters)
+ end
+
+ it 'raises an error when there is no event name' do
+ expect { subject.execute(web_hook_id: 1) }.to raise_error(Discourse::InvalidParameters)
+ end
+
+ it 'raises an error when event name is invalid' do
+ expect { subject.execute(web_hook_id: post_hook.id, event_type: 'post_random') }.to raise_error(Discourse::InvalidParameters)
+ end
+
+ it "doesn't emit when the hook is inactive" do
+ Jobs::EmitWebHookEvent.any_instance.expects(:web_hook_request).never
+ subject.execute(web_hook_id: inactive_hook.id, event_type: 'post', post_id: post.id)
+ end
+
+ it 'emits normally with sufficient arguments' do
+ Jobs::EmitWebHookEvent.any_instance.expects(:web_hook_request).once
+ subject.execute(web_hook_id: post_hook.id, event_type: 'post', post_id: post.id)
+ end
+
+ context 'with category filters' do
+ let(:category) { Fabricate(:category) }
+ let(:topic) { Fabricate(:topic) }
+ let(:topic_with_category) { Fabricate(:topic, category_id: category.id) }
+ let(:topic_hook) { Fabricate(:topic_web_hook, categories: [category]) }
+
+ it "doesn't emit when event is not related with defined categories" do
+ Jobs::EmitWebHookEvent.any_instance.expects(:web_hook_request).never
+
+ subject.execute(web_hook_id: topic_hook.id,
+ event_type: 'topic',
+ topic_id: topic.id,
+ user_id: user.id,
+ category_id: topic.category.id)
+ end
+
+ it 'emit when event is related with defined categories' do
+ Jobs::EmitWebHookEvent.any_instance.expects(:web_hook_request).once
+
+ subject.execute(web_hook_id: topic_hook.id,
+ event_type: 'topic',
+ topic_id: topic_with_category.id,
+ user_id: user.id,
+ category_id: topic_with_category.category.id)
+ end
+ end
+
+ describe '.web_hook_request' do
+ before(:all) { Excon.defaults[:mock] = true }
+ after(:all) { Excon.defaults[:mock] = false }
+ after(:each) { Excon.stubs.clear }
+
+ it 'creates delivery event record' do
+ Excon.stub({ url: "https://meta.discourse.org/webhook_listener" },
+ { body: 'OK', status: 200 })
+
+ expect do
+ subject.execute(web_hook_id: post_hook.id, event_type: 'post', post_id: post.id)
+ end.to change(WebHookEvent, :count).by(1)
+ end
+
+ it 'sets up proper request headers' do
+ Excon.stub({ url: "https://meta.discourse.org/webhook_listener" },
+ { headers: { test: 'string' }, body: 'OK', status: 200 })
+
+ subject.execute(web_hook_id: post_hook.id, event_type: 'ping', event_name: 'ping')
+ event = WebHookEvent.last
+ headers = MultiJson.load(event.headers)
+ expect(headers['Content-Length']).to eq(13)
+ expect(headers['Host']).to eq("meta.discourse.org")
+ expect(headers['X-Discourse-Event-Id']).to eq(event.id)
+ expect(headers['X-Discourse-Event-Type']).to eq('ping')
+ expect(headers['X-Discourse-Event']).to eq('ping')
+ expect(headers['X-Discourse-Event-Signature']).to eq('sha256=162f107f6b5022353274eb1a7197885cfd35744d8d08e5bcea025d309386b7d6')
+ expect(event.payload).to eq(MultiJson.dump({ping: 'OK'}))
+ expect(event.status).to eq(200)
+ expect(MultiJson.load(event.response_headers)['test']).to eq('string')
+ expect(event.response_body).to eq('OK')
+ end
+ end
+end
diff --git a/spec/models/web_hook_event_spec.rb b/spec/models/web_hook_event_spec.rb
new file mode 100644
index 000000000..5f6a9046b
--- /dev/null
+++ b/spec/models/web_hook_event_spec.rb
@@ -0,0 +1,16 @@
+require 'rails_helper'
+
+describe WebHookEvent do
+ let(:event) { WebHookEvent.new(status: 200, web_hook: Fabricate(:web_hook)) }
+ let(:failed_event) { WebHookEvent.new(status: 400, web_hook: Fabricate(:web_hook)) }
+
+ it 'update last delivery status for associated WebHook record' do
+ event.update_web_hook_delivery_status
+ expect(event.web_hook.last_delivery_status).to eq(WebHook.last_delivery_statuses[:successful])
+ end
+
+ it 'sets last delivery status to failed' do
+ failed_event.update_web_hook_delivery_status
+ expect(failed_event.web_hook.last_delivery_status).to eq(WebHook.last_delivery_statuses[:failed])
+ end
+end
diff --git a/spec/models/web_hook_event_type_spec.rb b/spec/models/web_hook_event_type_spec.rb
new file mode 100644
index 000000000..bd6b8ef41
--- /dev/null
+++ b/spec/models/web_hook_event_type_spec.rb
@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+describe WebHookEventType do
+ it { is_expected.to validate_presence_of :name }
+end
diff --git a/spec/models/web_hook_spec.rb b/spec/models/web_hook_spec.rb
new file mode 100644
index 000000000..4d5586c90
--- /dev/null
+++ b/spec/models/web_hook_spec.rb
@@ -0,0 +1,132 @@
+require 'rails_helper'
+
+describe WebHook do
+ it { is_expected.to validate_presence_of :payload_url }
+ it { is_expected.to validate_presence_of :content_type }
+ it { is_expected.to validate_presence_of :last_delivery_status }
+ it { is_expected.to validate_presence_of :web_hook_event_types }
+
+ describe '#content_types' do
+ subject { WebHook.content_types }
+
+ it "'json' (application/json) should be at 1st position" do
+ expect(subject['application/json']).to eq(1)
+ end
+
+ it "'url_encoded' (application/x-www-form-urlencoded) should be at 2st position" do
+ expect(subject['application/x-www-form-urlencoded']).to eq(2)
+ end
+ end
+
+ describe '#last_delivery_statuses' do
+ subject { WebHook.last_delivery_statuses }
+
+ it "inactive should be at 1st position" do
+ expect(subject[:inactive]).to eq(1)
+ end
+
+ it "failed should be at 2st position" do
+ expect(subject[:failed]).to eq(2)
+ end
+
+ it "successful should be at 3st position" do
+ expect(subject[:successful]).to eq(3)
+ end
+ end
+
+ context 'web hooks' do
+ let!(:post_hook) { Fabricate(:web_hook) }
+ let!(:topic_hook) { Fabricate(:topic_web_hook) }
+
+ describe '#find_by_type' do
+ it 'find relevant hooks' do
+ expect(WebHook.find_by_type(:post)).to eq([post_hook])
+ expect(WebHook.find_by_type(:topic)).to eq([topic_hook])
+ end
+
+ it 'excludes inactive hooks' do
+ post_hook.update_attributes!(active: false)
+
+ expect(WebHook.find_by_type(:post)).to eq([])
+ expect(WebHook.find_by_type(:topic)).to eq([topic_hook])
+ end
+ end
+
+ describe '#enqueue_hooks' do
+ it 'enqueues hooks with id and name' do
+ Jobs.expects(:enqueue).with(:emit_web_hook_event, web_hook_id: post_hook.id, event_type: 'post')
+
+ WebHook.enqueue_hooks(:post)
+ end
+
+ it 'accepts additional parameters' do
+ Jobs.expects(:enqueue).with(:emit_web_hook_event, web_hook_id: post_hook.id, post_id: 1, event_type: 'post')
+
+ WebHook.enqueue_hooks(:post, post_id: 1)
+ end
+ end
+
+ context 'includes wildcard hooks' do
+ let!(:wildcard_hook) { Fabricate(:wildcard_web_hook) }
+
+ describe '#find_by_type' do
+ it 'can find wildcard hooks' do
+ expect(WebHook.find_by_type(:wildcard)).to eq([wildcard_hook])
+ end
+
+ it 'can include wildcard hooks' do
+ expect(WebHook.find_by_type(:post).sort_by(&:id)).to eq([post_hook, wildcard_hook])
+ expect(WebHook.find_by_type(:topic).sort_by(&:id)).to eq([topic_hook, wildcard_hook])
+
+ end
+ end
+
+ describe '#enqueue_hooks' do
+ it 'enqueues hooks with ids' do
+ Jobs.expects(:enqueue).with(:emit_web_hook_event, web_hook_id: post_hook.id, event_type: 'post')
+ Jobs.expects(:enqueue).with(:emit_web_hook_event, web_hook_id: wildcard_hook.id, event_type: 'post')
+
+ WebHook.enqueue_hooks(:post)
+ end
+
+ it 'accepts additional parameters' do
+ Jobs.expects(:enqueue).with(:emit_web_hook_event, web_hook_id: post_hook.id, post_id: 1, event_type: 'post')
+ Jobs.expects(:enqueue).with(:emit_web_hook_event, web_hook_id: wildcard_hook.id, post_id: 1, event_type: 'post')
+
+ WebHook.enqueue_hooks(:post, post_id: 1)
+ end
+ end
+ end
+ end
+
+ describe 'enqueues hooks' do
+ let!(:post_hook) { Fabricate(:web_hook) }
+ let!(:topic_hook) { Fabricate(:topic_web_hook) }
+ let(:user) { Fabricate(:user) }
+ let(:topic) { Fabricate(:topic, user: user) }
+ let(:post) { Fabricate(:post, topic: topic) }
+ let(:post2) { Fabricate(:post, topic: topic) }
+
+ it 'should enqueue the right hooks for topic events' do
+ WebHook.expects(:enqueue_topic_hooks).once
+ PostCreator.create(user, { raw: 'post', title: 'topic', skip_validations: true })
+
+ WebHook.expects(:enqueue_topic_hooks).once
+ PostDestroyer.new(user, post).destroy
+
+ WebHook.expects(:enqueue_topic_hooks).once
+ PostDestroyer.new(user, post).recover
+ end
+
+ it 'should enqueue the right hooks for post events' do
+ WebHook.expects(:enqueue_hooks).once
+ PostCreator.create(user, { raw: 'post', topic_id: topic.id, reply_to_post_number: 1, skip_validations: true })
+
+ WebHook.expects(:enqueue_hooks).once
+ PostDestroyer.new(user, post2).destroy
+
+ WebHook.expects(:enqueue_hooks).once
+ PostDestroyer.new(user, post2).recover
+ end
+ end
+end
diff --git a/test/javascripts/lib/utilities-test.js.es6 b/test/javascripts/lib/utilities-test.js.es6
index 75b8cc194..59281334f 100644
--- a/test/javascripts/lib/utilities-test.js.es6
+++ b/test/javascripts/lib/utilities-test.js.es6
@@ -2,6 +2,7 @@
import { blank } from 'helpers/qunit-helpers';
import {
emailValid,
+ extractDomainFromUrl,
isAnImage,
avatarUrl,
allowsAttachments,
@@ -21,6 +22,13 @@ test("emailValid", function() {
ok(emailValid('bob@EXAMPLE.com'), "allows upper case in the email domain");
});
+test("extractDomainFromUrl", function() {
+ equal(extractDomainFromUrl('http://meta.discourse.org:443/random'), 'meta.discourse.org', "extract domain name from url");
+ equal(extractDomainFromUrl('meta.discourse.org:443/random'), 'meta.discourse.org', "extract domain regardless of scheme presence");
+ equal(extractDomainFromUrl('http://192.168.0.1:443/random'), '192.168.0.1', "works for IP address");
+ equal(extractDomainFromUrl('http://localhost:443/random'), 'localhost', "works for localhost");
+});
+
var validUpload = validateUploadedFiles;
test("validateUploadedFiles", function() {