site_hook 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2249764ae94c0a409237efeaf8d81005f3a2a1e
-  data.tar.gz: 2539605c765920916cebaf537f41f74e356e5799
+  metadata.gz: 77110224a51928243bd5e336829f11f626f1e9fb
+  data.tar.gz: 2ca551ebbcdc329502a333ce000a9154507d061a
 SHA512:
-  metadata.gz: 8aa433450d38fc526f833bf63429c56b0d4c29d6634afd7f4f1a10e9d39ff7a09661aa60efb3eacac8d3fea17bf2dc8cb90b0001555c21ebf4b40a7f2916f7f6
-  data.tar.gz: f140857d0b811d1e14d05641821ca6f04388cefc23bb980ed24677acb029e249e385e89be731c70e94c1fe7bdbdc47c1b9dd112acf81941fdac040c2fa9800cc
+  metadata.gz: 042c54b34afff7f71922c9d3c733f59fe4aa96fd5d0d9fa6331b7c721c41e8eddc1c67c29678513f6d52cbd1e0bdcd67b0b54735945b4bcdb92c63cd97afae56
+  data.tar.gz: fb99e9a7ab3851eba91a5f309e8e1ee58a0878899e51ed061564edd227b64a9ed4b82aa960091d47d975870e6374218155aca25caf96ffac9ef4745da210fb25

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    site_hook (0.1.0)
+    site_hook (0.2.0)
       activesupport (~> 5.1)
       git (~> 1.3)
       logging (~> 2.2)

data/bin/site_hook

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-require 'thor'
+
 require 'site_hook'
-shook = SiteHook::CLI.new(ARGV)
-shook.invoke('start')
+SiteHook::CLI.start(ARGV)

data/lib/site_hook.rb

@@ -12,12 +12,17 @@ module SiteHook
     HOOKLOG  = SiteHook::HookLogger::HookLog.new(SiteHook.log_levels['hook']).log
     BUILDLOG = SiteHook::HookLogger::BuildLog.new(SiteHook.log_levels['build']).log
     APPLOG   = SiteHook::HookLogger::AppLog.new(SiteHook.log_levels['app']).log
-
-    set port: 9090
+    JPHRC   = YAML.load_file(Pathname(Dir.home).join('.jph-rc'))
+    set port: JPHRC.fetch('port', 9090)
     set bind: '127.0.0.1'
     set server: %w(thin)
     set quiet: true
     set raise_errors: true
+
+    # @param [String] body JSON String of body
+    # @param [String] sig Signature or token from git service
+    # @param [String] secret User-defined verification token
+    # @param [Boolean] plaintext Whether the verification is plaintext
     def Webhook.verified?(body, sig, secret, plaintext:)
       if plaintext
         if sig === secret
@@ -43,8 +48,8 @@ module SiteHook
       request.body.rewind
       req_body = request.body.read
       js       = RecursiveOpenStruct.new(JSON.parse(req_body))
-      jph_rc   = YAML.load_file(Pathname(Dir.home).join('.jph-rc'))
-      projects = jph_rc['projects']
+
+      projects = JPHRC['projects']
       begin
         project = projects.fetch(params[:hook_name])
       rescue KeyError => e
@@ -72,23 +77,26 @@ module SiteHook
       end
       if Webhook.verified?(req_body.to_s, signature, project['hookpass'], plaintext: plaintext)
         BUILDLOG.info 'Building...'
-        jekyllbuild = SiteHook::Senders::Jekyll.build(project['src'], project['dst'], logger: BUILDLOG)
-        if jekyllbuild == 0
+        jekyllbuild = SiteHook::Senders::Jekyll.build(project['src'], project['dst'], BUILDLOG)
+        jekyll_status = jekyllbuild.fetch(:status, 1) == 0
+        case jekyll_status
+
+        when 0
           status 200
           headers 'Content-Type' => 'application/json'
           body {
             {'message': 'success'}.to_json
           }
-        else
-          status 404
+        when -1, -2, -3
+          status 400
           headers 'Content-Type' => 'application/json'
           body {
-            {'message': 'failure'}
+            {'message': 'exception', error: "#{jekyll_status.fetch(:message)}"}
           }
         end
 
       else
-        halt 403, {'Content-Type' => 'application/json'}, {message: 'incorrect secret'}.to_json
+        halt 403, {'Content-Type' => 'application/json'}, {message: 'incorrect secret', status: 1}.to_json
       end
     end
     post '/webhook/?' do

data/lib/site_hook/cli.rb

@@ -1,5 +1,6 @@
 require 'thor'
 
+require 'site_hook/config_class'
 module SiteHook
   def self.log_levels
     default = {
@@ -35,8 +36,12 @@ module SiteHook
     desc 'start', 'Start SiteHook'
 
     def start
-      SiteHook.mklogdir
+
+      SiteHook.mklogdir unless Pathname(Dir.home).join('.jph', 'logs').exist?
       SiteHook::Webhook.run!
     end
+
+    desc 'config SUBCOMMAND [OPTIONS]', 'Configure site_hook options'
+    subcommand('config', SiteHook::ConfigClass)
   end
 end

data/lib/site_hook/config_class.rb

@@ -0,0 +1,37 @@
+require 'thor'
+require 'yaml'
+require 'recursive-open-struct'
+module SiteHook
+  class ConfigClass < Thor
+    YML = open(Pathname(Dir.home).join('.jph-rc'), 'r')
+
+    desc 'list QUERY [options]', 'List configured options'
+
+    def list
+      puts YML.read
+    end
+    method_option '-f', type: :boolean, banner: 'FILE', default: false
+    desc 'gen [options]', "Generate a example config file if one doesn't exist"
+    def gen
+      #return if Pathname(Dir.home).join('.jph-rc').exist?
+
+      yaml = [
+          "# fatal, error, warn, info, debug",
+          "log_levels:",
+          "  hook: info",
+          "  build: info",
+          "  git: info",
+          "  app: info",
+          "projects:",
+          "  PROJECT.NAME:  # Use the name you put as your webhook url",
+          "  # https://jekyllhook.example.com/webhook/PROJECT.NAME",
+          "    src: /path/to/jekyll/site/source  # Directory you 'git pull' into",
+          "    dst: /path/to/build/destination/  # The web root will be this folder",
+          "    hookpass: SOMERANDOMSTRING  # set your Gitlab-Token or GitHub secret to this",
+          "",
+      ]
+
+      puts yaml
+    end
+  end
+end

data/lib/site_hook/logger.rb

@@ -62,6 +62,8 @@ module SiteHook
   LL.debug "#{SiteHook.safe_log_name(LL.class)} initialized."
 
   class HookLogger
+
+    # Log App Actions
     class AppLog
       attr :log
       attr :log_level
@@ -80,6 +82,8 @@ module SiteHook
         LL.debug "Initialized #{SiteHook.safe_log_name(self)}"
       end
     end
+
+    # Log Hook Actions
     class HookLog
       attr :log
       attr :log_level
@@ -98,6 +102,7 @@ module SiteHook
       end
     end
 
+    # Log Build Actions
     class BuildLog
       attr :log
 
@@ -117,6 +122,7 @@ module SiteHook
       end
     end
 
+    # Log Git Actions
     class GitLog
       attr :log
 
@@ -134,12 +140,15 @@ module SiteHook
         LL.debug "Initialized #{SiteHook.safe_log_name(self)}"
       end
     end
+
+    # Fake Logger for GitLog to preprocess output
     class FakeLog < StringIO
       attr :info_output, :debug_output
       def initialize
         @info_output = []
         @debug_output = []
       end
+      # @param [Any] message message to log
       def info(message)
         case
         when message =~ /git .* pull/
@@ -149,6 +158,7 @@ module SiteHook
           @debug_output << message
         end
       end
+      # @param [Any] message message to log
       def debug(message)
         case
         when message =~ /\n/
@@ -167,6 +177,7 @@ module SiteHook
         end
       end
 
+      # @return [Hash] Hash of log entries
       def entries
         {
             info: @info_output,

data/lib/site_hook/sender.rb

@@ -11,7 +11,6 @@ module SiteHook
 
         def do_grab_version
           jekyll_source = Jekyll.instance_variable_get('@jekyll_source')
-          build_dest    = Jekyll.instance_variable_get('@build_dest')
           log           = Jekyll.instance_variable_get('@log')
           begin
             stdout_str, status = Open3.capture2({'BUNDLE_GEMFILE' => Pathname(jekyll_source).join('Gemfile').to_path}, "jekyll --version --source #{jekyll_source}")
@@ -23,8 +22,8 @@ module SiteHook
         end
 
         def do_pull
-          fakelog = SiteHook::HookLogger::FakeLog.new
-          reallog = SiteHook::HookLogger::GitLog.new(SiteHook.log_levels['git']).log
+          fakelog       = SiteHook::HookLogger::FakeLog.new
+          reallog       = SiteHook::HookLogger::GitLog.new(SiteHook.log_levels['git']).log
           jekyll_source = Jekyll.instance_variable_get('@jekyll_source')
           build_dest    = Jekyll.instance_variable_get('@build_dest')
           g             = Git.open(jekyll_source, :log => fakelog)
@@ -37,53 +36,66 @@ module SiteHook
         def do_build
           jekyll_source = Jekyll.instance_variable_get('@jekyll_source')
           build_dest    = Jekyll.instance_variable_get('@build_dest')
-          log        = Jekyll.instance_variable_get('@log')
-          begin
-            Open3.popen2e({'BUNDLE_GEMFILE' => Pathname(jekyll_source).join('Gemfile').to_path}, "bundle exec jekyll build --source #{Pathname(jekyll_source).to_path} --destination #{Pathname(build_dest).to_path}") { |in_io, outerr_io, thr|
-              pid = thr.pid
+          log           = Jekyll.instance_variable_get('@log')
+          Open3.popen2e({'BUNDLE_GEMFILE' => Pathname(jekyll_source).join('Gemfile').to_path}, "bundle exec jekyll build --source #{Pathname(jekyll_source).realdirpath.to_path} --destination #{Pathname(build_dest).to_path}") { |in_io, outerr_io, thr|
+            pid = thr.pid
 
-              outerr = outerr_io.read.lines
-              outerr.each do |line|
-                line = Paint.unpaint(line)
-                line.squish!
-                # Configuration file: /home/ken/sites/iotaspencer.me/_config.yml
-                # Source: /home/ken/sites/iotaspencer.me
-                # Destination: /var/www/iotaspencer.me
-                # Incremental build: disabled. Enable with --incremental
-                # Generating...
-                # GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
-                # done in 6.847 seconds.
-                # Auto-regeneration: disabled. Use --watch to enable.
-                case
-                when line =~ /done in .* seconds/
-                  log.info(line)
-                when line =~ /Generating/
-                  log.info(line)
-                when line =~ /Configuration file:|Source:|Destination:/
-                  log.debug(line)
-                when line =~ /Incremental|Auto-regeneration/
-                  print ''
-                else
-                  print ''
-                end
+            outerr = outerr_io.read.lines
+            outerr.each do |line|
+              line = Paint.unpaint(line)
+              line.squish!
+              # Configuration file: /home/ken/sites/iotaspencer.me/_config.yml
+              # Source: /home/ken/sites/iotaspencer.me
+              # Destination: /var/www/iotaspencer.me
+              # Incremental build: disabled. Enable with --incremental
+              # Generating...
+              # GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
+              # done in 6.847 seconds.
+              # Auto-regeneration: disabled. Use --watch to enable.
+              case
+              when line =~ /done in .*/
+                log.info(line)
+              when line =~ /Generating/
+                log.info(line)
+              when line =~ /Configuration file:|Source:|Destination:/
+                log.debug(line)
+              when line =~ /Incremental|Auto-regeneration/
+                print ''
+              else
+                log.debug line
               end
-              exit_status = thr.value
-            }
-          end
+            end
+            exit_status = thr.value
+          }
+
         end
       end
 
-      def self.build(jekyll_source, build_dest, logger:)
+      # @param [String,Pathname] jekyll_source Jekyll Source
+      # @param [String,Pathname] build_dest Build Destination
+      # @param [BuildLog] logger Build Logger Instance
+      def self.build(jekyll_source, build_dest, logger)
         @jekyll_source = jekyll_source
         @build_dest    = build_dest
         @log           = logger
         instance       = self::Build.new
         meths          = instance.methods.select { |x| x =~ /^do_/ }
-        meths.each do |m|
-          @log.debug("Running #{m}")
-          instance.method(m).call
-          @log.debug("Ran #{m}")
+        begin
+          meths.each do |m|
+            @log.debug("Running #{m}")
+            instance.method(m).call
+            @log.debug("Ran #{m}")
+          end
+          return {message: 'success', status: 0}
+        rescue TypeError => e
+          return {message: "#{e}", status: -1}
+        rescue KeyError => e
+          return {message: "#{e}", status: -2}
+        rescue ArgumentError => e
+          return {message: "#{e}", status: -3}
+
         end
+
       end
     end
   end

data/lib/site_hook/version.rb

@@ -1,3 +1,3 @@
 module SiteHook
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: site_hook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ken Spencer
@@ -214,6 +214,7 @@ files:
 - bin/site_hook
 - lib/site_hook.rb
 - lib/site_hook/cli.rb
+- lib/site_hook/config_class.rb
 - lib/site_hook/logger.rb
 - lib/site_hook/sender.rb
 - lib/site_hook/spinner.rb