chook 1.0.1.b2 → 1.1.0

data/lib/chook/server/public/css/chook.css

@@ -0,0 +1,125 @@
+@charset "UTF-8";
+
+/* ******* General Styling ******* */
+
+.monospaced {
+  font-family: "Lucida Console", Monaco, monospace;
+}
+
+
+/* ******* Title Header Area ******* */
+
+.chook_title {
+  font-weight: bold;
+  font-size: 2.5em;
+  }
+
+#header_version {
+  font-size: 0.5em;
+}
+
+#definition {
+  line-height: 1.6;
+}
+
+.def_pronunciation {
+  font-style: italic;
+  font-size: 1.2em;
+}
+
+.def_part_of_speech {
+  font-weight: bold;
+}
+
+.def_dialect {
+  font-style: italic;
+}
+
+.def_definition {
+  font-size: 1.2em;
+}
+
+/* ******* Section Label Areas ******* */
+
+.section_label {
+  padding-bottom: 5px;
+}
+
+/* ******* Live Log Section ******* */
+
+#hide_log_btn {
+  display: none;
+}
+
+#logbox_div {
+  display: none;
+}
+
+#logbox_btns {
+  padding-bottom: 5px;
+}
+
+#logbox {
+  width: 100%;
+}
+
+/* ******* Handlers Section ******* */
+
+#hide_handlers_btn {
+  display: none;
+}
+
+#handlers_div {
+  display: none;
+}
+
+#handlers_table {
+  width: 100%;
+  border: 1px solid black;
+  border-collapse: collapse;
+  margin-top: 5px;
+  padding-bottom: 5px;
+}
+
+#handlers_table_header_row {
+  text-align: left;
+  border: 1px solid black;
+  border-collapse: collapse;
+  background-color: LightGrey;
+  padding-top: 4px;
+  padding-left: 3px;
+}
+
+.handlers_table_cell {
+  text-align: left;
+  border: 1px solid black;
+  border-collapse: collapse;
+  padding-top: 4px;
+  padding-left: 3px;
+}
+
+#handler_viewer_div {
+  display: none;
+  padding-top: 15px;
+}
+
+#handler_viewer {
+  width: 95%;
+  border: 3px solid black;
+  padding-top: 5px;
+}
+
+/* ******* Handlers Section ******* */
+
+#hide_config_btn {
+  display: none;
+}
+
+#config_div {
+  display: none;
+}
+
+#config_viewer_div {
+  margin-top: 5px;
+  padding-bottom: 5px;
+}

data/lib/chook/server/public/js/chook.js

@@ -0,0 +1,127 @@
+
+// show the logbox
+function view_log() {
+  document.getElementById("pause_log").checked = false
+  document.getElementById("logbox_div").style.display = 'block';
+  document.getElementById("view_log_btn").style.display = 'none';
+  document.getElementById("hide_log_btn").style.display = 'inline';
+  start_log_stream();
+  update_logbox();
+}
+
+// hide the logbox
+function hide_log() {
+  document.getElementById("logbox_div").style.display = 'none';
+  document.getElementById("view_log_btn").style.display = 'inline';
+  document.getElementById("hide_log_btn").style.display = 'none';
+  document.getElementById("pause_log").checked = true;
+}
+
+// clear the log stream
+function clear_log(){
+  document.getElementById("logbox").value = '';
+  log_source = '';
+}
+
+// change the log level
+function change_log_level() {
+  var new_level = document.getElementById("log_level_select").value
+  var url = "/set_log_level/" + new_level
+  var xhttp = new XMLHttpRequest();
+  xhttp.open("PUT", url, true);
+  xhttp.send();
+}
+
+// reload the handlers
+function reload_handlers() {
+  var url = '/reload_handlers';
+  var xhttp = new XMLHttpRequest();
+  xhttp.onreadystatechange = function() {
+    if (this.readyState == 4 && this.status == 200) {
+      now = new Date().toLocaleString();
+      document.getElementById("reloaded_notification").innerHTML = 'Reloaded at ' + now;
+    } else {
+      document.getElementById("reloaded_notification").innerHTML = 'Reload Failed.';
+    }
+  };
+  xhttp.open("GET", url, true);
+  xhttp.send();
+}
+
+// show the handler area
+function view_handlers() {
+  document.getElementById("handlers_div").style.display = 'block';
+  document.getElementById("view_handlers_btn").style.display = 'none';
+  document.getElementById("hide_handlers_btn").style.display = 'inline';
+}
+
+// hide the handler area
+function hide_handlers() {
+  document.getElementById("handlers_div").style.display = 'none';
+  document.getElementById("view_handlers_btn").style.display = 'inline';
+  document.getElementById("hide_handlers_btn").style.display = 'none';
+}
+
+// hide the handler editor
+function hide_handler_viewer() {
+  document.getElementById("handler_viewer_div").style.display = 'none';
+}
+
+// show the handler editor with the selected handler code
+// handler = the path to the hander fle.
+function edit_handler(handler, type) {
+  var code = '';
+  var editing_filename = handler;
+
+  // new handler
+  if (handler == 'new_handler') {
+    editing_filename = new_handler_filename();
+    if (editing_filename == 'Name Already Taken') {
+      code = editing_filename;
+    }
+    document.getElementById("handler_viewer").value = code;
+
+    if (document.getElementById("add_handler_external_radio").checked) {
+      type = 'external';
+    } else {
+      type = 'internal';
+    }
+
+  // existing handler
+  } else {
+    fetch_handler_code(handler) ;
+  }
+  var now_editing = editing_filename + ' (' + type + ')'
+  document.getElementById("currently_viewing_filename").innerHTML = now_editing;
+  document.getElementById("handler_viewer_div").style.display = 'block';
+}
+
+// get the code for an existing handler into the editor
+function fetch_handler_code(handler) {
+  var editor = document.getElementById("handler_viewer");
+  var url = '/handler_code/' + handler
+  var xhttp = new XMLHttpRequest();
+  xhttp.onreadystatechange = function() {
+    if (this.readyState == 4 && this.status == 200) {
+      editor.value = xhttp.responseText;
+    } else {
+      editor.value = 'ERROR: File Not Found';
+    }
+  };
+  xhttp.open("GET", url, true);
+  xhttp.send();
+}
+
+// show the config area
+function view_config() {
+  document.getElementById("config_div").style.display = 'block';
+  document.getElementById("view_config_btn").style.display = 'none';
+  document.getElementById("hide_config_btn").style.display = 'inline';
+}
+
+// hide the config area
+function hide_config() {
+  document.getElementById("config_div").style.display = 'none';
+  document.getElementById("view_config_btn").style.display = 'inline';
+  document.getElementById("hide_config_btn").style.display = 'none';
+}

data/lib/chook/server/public/js/logstream.js

@@ -0,0 +1,101 @@
+
+// Vars
+//////////////////////////////////
+
+// the url that will provide the stream
+var log_stream_url = '/subscribe_to_log_stream';
+
+// the EventSource that will get events from the url
+var log_source
+
+// the log box on the info page
+var logbox
+
+// the checkbox to pause updating the log box
+var pause_ckbx
+
+// data from the log gets added to this string
+// but its only written to the log box if we
+// aren't paused.
+var log_data
+
+var new_log_level_regex = /Log level changed, now: (.*)$/;
+
+// update the text in the log box unless the
+// pause checkbox is checked
+function update_logbox() {
+  if (pause_ckbx.checked) { return; }
+  logbox.value = log_data;
+  logbox.scrollTop = logbox.scrollHeight;
+}
+
+// start the stream
+function start_log_stream() {
+  // always update the log level
+  get_current_log_level();
+  // return if already started
+  if (typeof(log_source) != "undefined")  { return; }
+
+  logbox = document.getElementById("logbox");
+  pause_ckbx = document.getElementById("pause_log");
+
+  log_data = logbox.value;
+  log_source = new EventSource(log_stream_url);
+
+  // add incoming lines of data from the server
+  // to the in-memory cache
+  log_source.onmessage = function (event) {
+    var msg = event.data;
+    log_data = log_data + msg + "\n";
+    update_logbox();
+    var match = new_log_level_regex.exec(msg);
+    if (match) { update_log_level_selector(match[1]); }
+  };
+
+  // close the streams when client pages are closed.
+  // The server will see that the streams are closed
+  // and will remove the registrations as needed.
+  window.onbeforeunload = function() {
+     log_source.close();
+     return null;
+  }
+}
+
+// update the selector with the current log level from the server
+function get_current_log_level() {
+  var url = '/current_log_level';
+  var xhttp = new XMLHttpRequest();
+
+  xhttp.onreadystatechange = function() {
+    if (this.readyState == 4 && this.status == 200) {
+      update_log_level_selector(xhttp.responseText);
+    }
+  };
+
+  xhttp.open("GET", url, true);
+  xhttp.send();
+}
+
+function update_log_level_selector(new_level) {
+  var new_idx;
+  switch(new_level) {
+    case 'fatal':
+      new_idx = 0;
+      break;
+    case 'error':
+      new_idx = 1;
+      break;
+    case 'warn':
+      new_idx = 2;
+      break;
+    case 'info':
+      new_idx = 3;
+      break;
+    case 'debug':
+      new_idx = 4;
+      break;
+    default:
+      new_idx = null;
+   }
+  document.getElementById("log_level_select").selectedIndex = new_idx;
+}

data/lib/chook/server/routes.rb

@@ -23,5 +23,50 @@
 ###
 ###
 
+module Chook
+
+  # the server
+  class Server < Sinatra::Base
+
+    # These two helpers let us decude which routes need
+    # http basic auth and which don't
+    #
+    # To protect a route, put `protected!` as the
+    # first line of code in the route.
+    #
+    # See http://sinatrarb.com/faq.html#auth
+    #
+    helpers do
+      def protected!
+        # don't protect if user isn't defined
+        return unless Chook.config.webhooks_user
+
+        return if authorized?
+        headers['WWW-Authenticate'] = 'Basic realm="Restricted Area"'
+        halt 401, "Not authorized\n"
+      end
+
+      def authorized?
+        @auth ||= Rack::Auth::Basic::Request.new(request.env)
+        @auth.provided? && \
+          @auth.basic? && \
+          @auth.credentials && \
+          @auth.credentials == [Chook.config.webhooks_user, Chook::Server.webhooks_user_pw]
+      end
+    end
+
+    # log errors in production (in dev, they go to stdout and the browser)
+    error do
+      logger.error "ERROR: #{env['sinatra.error'].message}"
+      env['sinatra.error'].backtrace.each { |l| logger.error "..#{l}" }
+      500
+    end
+
+  end # server
+
+end # Chook
+
 require 'chook/server/routes/home'
 require 'chook/server/routes/handle_webhook_event'
+require 'chook/server/routes/handlers'
+require 'chook/server/routes/log'

data/lib/chook/server/routes/handle_webhook_event.rb

@@ -29,9 +29,28 @@ module Chook
   class Server < Sinatra::Base
 
     post '/handle_webhook_event' do
-      request.body.rewind # in case someone already read it
-      event = Chook::HandledEvent.parse_event request.body.read
-      event.handle
+      # enforce http basic auth if needed
+      protected!
+
+      # rewind to ensure read-pointer is at the start
+      request.body.rewind #
+      raw_json = request.body.read
+
+      event = Chook::HandledEvent.parse_event raw_json
+      if event.nil?
+        logger.error "Empty JSON from #{request.ip}"
+        result = 400
+      else
+
+        event.logger.info "START From #{request.ip}, WebHook '#{event.webhook_name}' (id: #{event.webhook_id})"
+
+        event.logger.debug "JSON: #{raw_json}"
+
+        result = event.handle
+
+        event.logger.info "END #{result}"
+      end
+      result
     end # post
 
   end # class

data/lib/chook/server/routes/handlers.rb

@@ -0,0 +1,52 @@
+### Copyright 2017 Pixar
+
+###
+###    Licensed under the Apache License, Version 2.0 (the "Apache License")
+###    with the following modification; you may not use this file except in
+###    compliance with the Apache License and the following modification to it:
+###    Section 6. Trademarks. is deleted and replaced with:
+###
+###    6. Trademarks. This License does not grant permission to use the trade
+###       names, trademarks, service marks, or product names of the Licensor
+###       and its affiliates, except as required to comply with Section 4(c) of
+###       the License and to reproduce the content of the NOTICE file.
+###
+###    You may obtain a copy of the Apache License at
+###
+###        http://www.apache.org/licenses/LICENSE-2.0
+###
+###    Unless required by applicable law or agreed to in writing, software
+###    distributed under the Apache License with the above modification is
+###    distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+###    KIND, either express or implied. See the Apache License for the specific
+###    language governing permissions and limitations under the Apache License.
+###
+###
+
+module Chook
+
+  # see server.rb
+  class Server < Sinatra::Base
+
+    # reload the handlers
+    get '/reload_handlers' do
+      protected!
+      logger.info 'Reloading handlers'
+      Chook::HandledEvent::Handlers.load_handlers reload: true
+      'Handlers reloaded'
+    end # get /
+
+    # used by javascript to fetch the content of a handler
+    get '/handler_code/:file' do
+      protected!
+      file = Chook.config.handler_dir + params[:file]
+      if file.file?
+        body file.read
+      else
+        404
+      end
+    end
+
+  end # class
+
+end # module