chook 1.0.1.b2 → 1.1.0

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

@@ -29,7 +29,40 @@ module Chook
   class Server < Sinatra::Base
 
     get '/' do
-      body "Hello, this is Chook, a Jamf Pro WebHook handling service from Pixar Animation Studios!\n"
+      protected!
+
+      # a list of current handlers for the admin page
+      @handlers_for_admin_page = []
+
+      Chook::HandledEvent::Handlers.handlers.keys.sort.each do |eventname|
+        Chook::HandledEvent::Handlers.handlers[eventname].each do |handler|
+          if handler.is_a? Pathname
+            file = handler
+            type = :external
+          else
+            file = Pathname.new(Chook.config.handler_dir) + handler.handler_file
+            type = :internal
+          end # if else
+          @handlers_for_admin_page << { event: eventname, file: file, type: type }
+        end # handlers each
+      end # Handlers.handlers.each
+
+      # the current config, for the admin page
+      @config_text =
+        if Chook::Configuration::DEFAULT_CONF_FILE.file?
+          @config_src = Chook::Configuration::DEFAULT_CONF_FILE.to_s
+          Chook::Configuration::DEFAULT_CONF_FILE.read
+
+        elsif Chook::Configuration::SAMPLE_CONF_FILE.file?
+          @config_src = "Using default values, showing sample config file at #{Chook::Configuration::SAMPLE_CONF_FILE}"
+          Chook::Configuration::SAMPLE_CONF_FILE.read
+
+        else
+          @config_src = "No #{Chook::Configuration::DEFAULT_CONF_FILE} or sample config file found."
+          @config_src
+        end
+
+      haml :admin
     end # get /
 
   end # class

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

@@ -0,0 +1,106 @@
+### 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
+
+    # External Handlers can use this route to make log entries.
+    #
+    # The request body must be a JSON object (Hash) wth 2 keys 'level' and 'message'
+    # where both values are strings
+    #
+    # Here's an example with curl, split to multi-line for clarity:
+    #
+    # curl -H "Content-Type: application/json" \
+    #   -X POST \
+    #   --data '{"level":"debug", "message":"It Worked"}' \
+    #   https://user:passwd@chookserver.myorg.org:443/log
+    #
+    post '/log' do
+      protected!
+      request.body.rewind # in case someone already read it
+      raw = request.body.read
+
+      begin
+        logentry = JSON.parse raw, symbolize_names: true
+        raise if logentry[:level].to_s.empty? || logentry[:message].to_s.empty?
+      rescue
+        Chook::Server::Log.logger.error "Malformed log entry JSON from #{request.ip}: #{raw}"
+        halt 409, "Malformed log entry JSON: #{raw}"
+      end
+
+      level = logentry[:level].to_sym
+      level = :unknown unless Chook::Server::Log::LOG_LEVELS.key? level
+      Chook::Server::Log.logger.send level, "ExternalEntry: #{logentry[:message]}"
+
+      { result: 'logged', level: level }.to_json
+    end # post /
+
+    # AJAXy access to a log stream
+    # When an admin displays the log on the chook admin/home page,
+    # the page's javascript starts the stream as an EventSource
+    # from this url.
+    #
+    # The innards are taken almost verbatim from the Sinatra README
+    # docs.
+    #
+    # See also logstream.js and views/admin.haml
+    #
+    #
+    get '/subscribe_to_log_stream', provides: 'text/event-stream' do
+      protected!
+      content_type 'text/event-stream'
+      cache_control 'no-cache'
+
+      # register a client's interest in server events
+      stream(:keep_open) do |outbound_stream|
+        # add this connection to the array of streams
+        Chook::Server::Log.log_streams[outbound_stream] = request.ip
+        logger.debug "Added log stream for #{request.ip}"
+        # purge dead connections
+        Chook::Server::Log.clean_log_streams
+      end # stream
+    end
+
+    # set the log level via the admin page.
+    put '/set_log_level/:level' do
+      level = params[:level].to_sym
+      level = :unknown unless Chook::Server::Log::LOG_LEVELS.key? level
+      Chook.logger.level = level
+      Chook.logger.unknown "Log level changed, now: #{level}"
+      { result: 'level changed', level: level }.to_json
+    end
+
+    # get the log level via the admin page.
+    get '/current_log_level' do
+      protected!
+      Chook::Server::Log::LOG_LEVELS.invert[Chook.logger.level].to_s
+    end
+
+  end # class
+
+end # module

data/lib/chook/server/views/admin.haml

@@ -0,0 +1,11 @@
+%hr/
+%hr/
+= haml :logstream
+
+%hr/
+%hr/
+= haml :handlers
+
+%hr/
+%hr/
+= haml :config

data/lib/chook/server/views/bak.haml

@@ -0,0 +1,48 @@
+%hr/
+.section_label#log_label
+  The Live Chook Log
+      
+  %button#view_log_btn{ type: 'button', onClick: 'view_log();', title: 'view the live Chook log' }
+    View
+  %button#hide_log_btn{ type: 'button', onClick: 'hide_log();', title: 'hide the live Chook log' }
+    Hide
+       Log Level:
+  %select#log_level_select{ onchange: 'change_log_level();' }
+    %option{ value: 'fatal', selected: Chook.logger.level == Logger::FATAL } fatal
+    %option{ value: 'error', selected: Chook.logger.level == Logger::ERROR } error
+    %option{ value: 'warn', selected: Chook.logger.level == Logger::WARN } warn
+    %option{ value: 'info', selected: Chook.logger.level == Logger::INFO } info
+    %option{ value: 'debug', selected: Chook.logger.level == Logger::DEBUG } debug
+
+#logbox_div
+  #logbox_btns
+    %input#pause_log{ type: 'checkbox', checked: false, onclick: 'update_logbox();' }
+      Pause
+        
+    %button#clear_log_btn{ type: 'button', onClick: 'clear_log();', title: 'clear the live Chook log' }
+      Clear
+
+  // Log Level: [popup list] (set)
+  %textarea.monospaced#logbox{ readonly: true, rows: 20, cols: 150 }
+
+%hr/
+.section_label#handlers_label
+  Current Webhook Handlers (#{@handlers_for_admin_page.size})
+      
+
+  %button#view_handlers_btn{ type: 'button', onClick: 'view_handlers();', title: 'view the handler list' }
+    View
+  %button#hide_handlers_btn{ type: 'button', onClick: 'hide_handlers();', title: 'hide the handler list' }
+    Hide
+      
+
+  Handler Directory:
+  %span.monospaced
+    = Chook.config.handler_dir.to_s
+
+#handlers_div
+  %table#handlers_table
+    %tr
+      %th Event
+      %th Handler Type
+      %th File Name

data/lib/chook/server/views/config.haml

@@ -0,0 +1,15 @@
+.section_label#config_label
+  %button#view_config_btn{ type: 'button', onClick: 'view_config();', title: 'view the config file' }
+    View
+  %button#hide_config_btn{ type: 'button', onClick: 'hide_config();', title: 'hide the config file' }
+    Hide
+      
+
+  Configuration
+
+#config_div
+  Config file:
+  %span.monospaced= @config_src
+
+  #config_viewer_div
+    %textarea.monospaced#config_box{ readonly: true, rows: 20, cols: 150 }= @config_text

data/lib/chook/server/views/handlers.haml

@@ -0,0 +1,48 @@
+.section_label#handlers_label
+  %button#view_handlers_btn{ type: 'button', onClick: 'view_handlers();', title: 'view the handler list' }
+    View
+  %button#hide_handlers_btn{ type: 'button', onClick: 'hide_handlers();', title: 'hide the handler list' }
+    Hide
+      
+
+  Current Webhook Handlers (#{@handlers_for_admin_page.size})
+
+#handlers_div
+
+  Handler Directory:
+  %span.monospaced= Chook.config.handler_dir.to_s
+      
+
+  %button#reload_all_handlers_btn{ type: 'button', onClick: 'reload_handlers();', title: 'reload all handlers' }
+    Reload
+    
+  %span#reloaded_notification
+
+  %table#handlers_table
+    %tr#handlers_table_header_row
+      %th.handlers_table_cell Event
+      %th.handlers_table_cell{ width: '10%' } Handler Type
+      %th.handlers_table_cell File Name
+      %th.handlers_table_cell Actions
+
+    - @handlers_for_admin_page.each do |hndlr_info|
+      %tr
+        %td.handlers_table_cell= hndlr_info[:event]
+        %td.handlers_table_cell= hndlr_info[:type].to_s
+        %td.handlers_table_cell= hndlr_info[:file].basename.to_s
+        %td.handlers_table_cell
+          %button.edit_handler_btn{ type: 'button', onClick: "edit_handler('#{hndlr_info[:file].basename}', '#{hndlr_info[:type]}');", title: 'View this handler' }
+            View
+
+  #handler_viewer_div
+    %input#currently_viewing_handler_file{ name: 'currently_viewing_handler_file', type: :hidden }
+    %input#currently_editing_handler_type{ name: 'currently_editing_handler_type', type: :hidden }
+    #currently_viewing_handler_label
+      %button#hide_handler_viewer_btn{ type: 'button', onClick: 'hide_handler_viewer();', title: 'hide the handler editor' }
+        Hide
+          
+      Viewing handler:   
+      %span.monospaced#currently_viewing_filename -nothing-
+
+
+    %textarea.monospaced#handler_viewer{ rows: 35 , readonly: true }

data/lib/chook/server/views/layout.haml

@@ -0,0 +1,39 @@
+!!!
+%html{ lang: 'en' }
+
+  %head
+
+    %meta{ charset: 'UTF-8' }
+    %title
+      Chook
+
+    / CSS
+    %link{ href: '/css/chook.css', rel: 'stylesheet' }
+
+    / JavaScript
+    %script{ type: 'text/javascript', language: 'javascript', src: '/js/chook.js' }
+    %script{ type: 'text/javascript', language: 'javascript', src: '/js/logstream.js' }
+
+  %body
+    / Top
+    #pageheader
+      %table{ width: '100%' }
+        %tr
+          %td{ valign: 'bottom', width: '120' }
+            #header_logo
+              %img{ alt: '', height: '120', src: '/imgs/ChookLogoAlMcWhiggin.png', width: '120' }
+            #header_version
+              v#{Chook::VERSION}
+          %td
+            #definition
+              %span.chook_title Chook
+              %br/
+              %span.def_pronunciation /tʃʊk/ (also chookie /ˈtʃʊki/ )
+              %br/
+              %span.def_part_of_speech noun
+              %span.def_dialect Australian/NZ informal
+              %br/
+              %span.def_definition a chicken or fowl
+
+
+    = yield

data/lib/chook/server/views/logstream.haml

@@ -0,0 +1,32 @@
+.section_label#log_label
+  %button#view_log_btn{ type: 'button', onClick: 'view_log();', title: 'view the live Chook log' }
+    View
+  %button#hide_log_btn{ type: 'button', onClick: 'hide_log();', title: 'hide the live Chook log' }
+    Hide
+      
+
+  The Live Chook Log
+
+
+#logbox_div
+  #logbox_btns
+    %input#pause_log{ type: 'checkbox', checked: false, onclick: 'update_logbox();' }
+      Pause
+        
+
+    %button#clear_log_btn{ type: 'button', onClick: 'clear_log();', title: 'clear the live Chook log' }
+      Clear
+
+        
+
+    Server Log Level:
+    %select#log_level_select{ onchange: 'change_log_level();',
+      title: 'changes here affect logging the server, not just your view' }
+
+      %option{ value: 'fatal', selected: Chook.logger.level == Logger::FATAL } fatal
+      %option{ value: 'error', selected: Chook.logger.level == Logger::ERROR } error
+      %option{ value: 'warn', selected: Chook.logger.level == Logger::WARN } warn
+      %option{ value: 'info', selected: Chook.logger.level == Logger::INFO } info
+      %option{ value: 'debug', selected: Chook.logger.level == Logger::DEBUG } debug
+
+  %textarea.monospaced#logbox{ readonly: true, rows: 20 }

data/lib/chook/server/views/sketch_admin

@@ -0,0 +1,44 @@
+[image] Chook v.XXX
+
+
+Log (view/hide)        Log Level: [popup list] (set)
+--------- hidable text area with streaming log -----------
+
+
+Current Handlers
+  filename/type (view/edit) (remove)
+  ...
+  ...
+  (Add new handler)
+--------- text area with editable handler -----------
+  (save)
+
+
+Configuration (save)
+--------- text area with editable (?) config file -----------
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(c) Pixar....  [links]

data/lib/chook/subject.rb

@@ -122,9 +122,8 @@ module Chook
     #       Proc: Pass an API object to the PROC to get a value
     #
     def self.classes
-      @classes
+      @classes ||= {}
     end
-    @classes = {}
 
   end # class Subject
 

data/lib/chook/subject/smart_group.rb

@@ -41,6 +41,12 @@ Chook::Subject.classes[Chook::Subject::SMART_GROUP] = {
     # sampler: :smart_group_jssid,
     api_object_attribute: :id
   },
+  groupAddedDevicesIds: {
+    validation: Array
+  },
+  groupRemovedDevicesIds: {
+    validation: Array
+  },
   computer: { # SmartGroupComputerMembershipChange == true, SmartGroupMobileDeviceMembershipChange == false
     validation: :boolean,
     randomizer: :bool,

data/lib/chook/version.rb

@@ -27,6 +27,6 @@
 module Chook
 
   ### The version of the Chook framework
-  VERSION = '1.0.1.b2'.freeze
+  VERSION = '1.1.0'.freeze
 
 end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chook
 version: !ruby/object:Gem::Version
-  version: 1.0.1.b2
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Lasell
@@ -9,27 +9,69 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-25 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.8
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.8
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: |2
     Chook is a Ruby module which implements a framework for working with webhook events
     sent by the JSS, the core of Jamf Pro, a management tool for Apple devices.
 
-    Chook also provides a simple, sinatra-based HTTP server, for handling those Events,
+    Chook also provides a simple, sinatra-based HTTP(S) server, for handling those Events,
     and classes for sending simulated TestEvents to a webhook handling server.
 email: chook@pixar.com
 executables:
@@ -38,10 +80,13 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE.txt
+- CHANGES.md
 files:
+- CHANGES.md
 - LICENSE.txt
 - README.md
 - bin/chook-server
+- data/chook.conf.example
 - data/sample_handlers/RestAPIOperation-executable
 - data/sample_handlers/RestAPIOperation.rb
 - data/sample_handlers/SmartGroupComputerMembershipChange-executable
@@ -70,6 +115,7 @@ files:
 - lib/chook/event.rb
 - lib/chook/event/handled_event.rb
 - lib/chook/event/handled_event/handlers.rb
+- lib/chook/event/handled_event_logger.rb
 - lib/chook/event/test_event.rb
 - lib/chook/event_handling.rb
 - lib/chook/event_testing.rb
@@ -78,9 +124,23 @@ files:
 - lib/chook/handled_subjects.rb
 - lib/chook/procs.rb
 - lib/chook/server.rb
+- lib/chook/server/log.rb
+- lib/chook/server/public/css/chook.css
+- lib/chook/server/public/imgs/ChookLogoAlMcWhiggin.png
+- lib/chook/server/public/js/chook.js
+- lib/chook/server/public/js/logstream.js
 - lib/chook/server/routes.rb
 - lib/chook/server/routes/handle_webhook_event.rb
+- lib/chook/server/routes/handlers.rb
 - lib/chook/server/routes/home.rb
+- lib/chook/server/routes/log.rb
+- lib/chook/server/views/admin.haml
+- lib/chook/server/views/bak.haml
+- lib/chook/server/views/config.haml
+- lib/chook/server/views/handlers.haml
+- lib/chook/server/views/layout.haml
+- lib/chook/server/views/logstream.haml
+- lib/chook/server/views/sketch_admin
 - lib/chook/subject.rb
 - lib/chook/subject/computer.rb
 - lib/chook/subject/handled_subject.rb
@@ -103,28 +163,23 @@ licenses:
 - Nonstandard
 metadata: {}
 post_install_message: 
-rdoc_options:
-- --title
-- Chook
-- --line-numbers
-- --main
-- README.md
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: A Ruby framework for simulating and processing Jamf Pro Webhooks
+summary: A Ruby framework for simulating and processing Jamf Pro Webhook Events
 test_files: []