loadrunner 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3102e254b9713df61278cc81259d547f73d20015f83ee2f0ea1bb6f2399aa3c3
-  data.tar.gz: 714019cdae31109069f3d615dc21a18685317eb21edafeff91ab0ff58e8bd80d
+  metadata.gz: d79a3a28613d0ed9bb71220d16f44796bdf2e4b4b20eeb2c463df46ac8b10837
+  data.tar.gz: 82a2d95737162857f764a7ab87745fcc504fb8544066ec3037c7b1985a2e1891
 SHA512:
-  metadata.gz: 0547d09f0b585f3456dcdc1acc65ffc5b410108715db8a240870d6ce5b787660cfc04de3e854a58df6bd5c33292031f4373fb37564c2954fdd2851e9ceec5375
-  data.tar.gz: 10d21050595e15ecd56216bea4aeaa908ac17dbf9f0dfda0be7750e37adf1bfb5346778fb4a6696dc59b80f4d969946a7032dc3650cd279e28e1356c32a2b2e8
+  metadata.gz: 61a9ca38c6a7a2622d30e5e089fe4b442d6c74355f11592310945da3298241349328787c18758a303956e1477779216a367a3c438049c01be21ccaafd89acbc7
+  data.tar.gz: d47d260866de2fb6909142b9887563ef0826b8598fa7879454807f8d2c43edd1db2191d07a35370e2d13c98cbaa53edb970fb02d4fd2c8019f571b08fe0d6781

data/README.md

@@ -35,21 +35,18 @@ $ gem install loadrunner
 Getting Started
 --------------------------------------------------
 
-```shell
-# Create a sample hook handler
-$ mkdir -p handlers/myrepo
-$ echo '#!/usr/bin/env bash' > handlers/myrepo/push
-$ echo 'echo hello > output.txt' >> handlers/myrepo/push
-$ chmod +x handlers/myrepo/push
-
-# Start the server
-$ loadrunner server
-
-# In another terminal, send a sample webhook event
-$ loadrunner event localhost:3000 myrepo push master
-
-# Verify the handler was executed
-$ cat output.txt
+1. Download the [handlers](handlers) directory from this repository, as an
+   exmaple. This directory contains several handler examples.
+2. Make sure that all files within that folder are executables.
+3. Start the server (from the `handlers` **parent** directory):
+   `loadrunner server`
+4. In another terminal, send a sample webhook event:
+   `loadrunner event localhost:3000/payload myrepo push master
+
+The server should respond with a detailed JSON response, specifying what
+handlers were executed (`executed_handlers`) and what handlers *could have
+been* executed, if they were defined in the handlers folder
+(`matching_handlers`).
 ```
 
 
@@ -64,15 +61,19 @@ $ loadrunner --help
 Building Handlers
 --------------------------------------------------
 
-When running the server, it will look for handlers in the `./handlers` 
-directory, using one of these format:
+When running the server, it will look for handlers (executable scripts) in
+the `./handlers` directory, using one of these format:
 
+    handlers/global
+    handlers/<repo name>/global
     handlers/<repo name>/<event type>
     handlers/<repo name>/<event type>@branch=<branch name>
     handlers/<repo name>/<event type>@tag=<branch name>
 
 For example:
 
+    handlers/global
+    handlers/myrepo/global
     handlers/myrepo/push
     handlers/myrepo/push@branch=master
     handlers/myrepo/push@tag=release
@@ -88,12 +89,12 @@ executables.
 
 These environment variables are available to your handlers:
 
-- `REPO`
-- `EVENT`
-- `BRANCH`
-- `REF`
-- `TAG`
-- `PAYLOAD` - the entire JSON string as received from GitHub, or the client.
+- `LOADRUNNER_REPO`
+- `LOADRUNNER_EVENT`
+- `LOADRUNNER_BRANCH`
+- `LOADRUNNER_REF`
+- `LOADRUNNER_TAG`
+- `LOADRUNNER_PAYLOAD` - the entire JSON string as received from GitHub, or the client.
 
 
 

data/lib/load_runner/runner.rb

@@ -3,9 +3,10 @@ module LoadRunner
   # Executes event handlers
   class Runner
     attr_reader :opts
-    attr_accessor :response
+    attr_accessor :response, :handlers_dir
 
     def initialize(opts)
+      @handlers_dir = 'handlers'
       @opts = opts
     end
 
@@ -13,12 +14,12 @@ module LoadRunner
     # populates the `#response` object, and returns true on success.
     def execute
       set_environment_vars
-      
+
       @response = opts.dup
       handlers = locate_handlers
+      @response[:matching_handlers] = matching_handlers
 
       if handlers.empty?
-        @response[:matching_handlers] = matching_handlers
         @response[:error] = "Could not find any handler to process this webhook. Please implement one of the 'matching_handlers'."
         return false
       else
@@ -28,14 +29,6 @@ module LoadRunner
       end
     end
 
-    def handlers_dir
-      @handlers_dir ||= 'handlers'
-    end
-
-    def handlers_dir=(path)
-      @handlers_dir = path
-    end
-
     private
 
     # Find all handlers that fit the payload meta data.
@@ -65,12 +58,16 @@ module LoadRunner
     # Set all payload meta data as environment variables so that the
     # handler can use them.
     def set_environment_vars
-      opts.each { |key, value| ENV[key.to_s.upcase] = value }
+      opts.each { |key, value| ENV["LOADRUNNER_#{key.to_s.upcase}"] = value }
     end
 
     def matching_handlers
       base = "#{handlers_dir}/#{opts[:repo]}/#{opts[:event]}"
-      handlers = ["#{base}"]
+      handlers = [
+        "#{handlers_dir}/global",
+        "#{handlers_dir}/#{opts[:repo]}/global",
+        "#{base}"
+      ]
 
       handlers.tap do |h|
         h << "#{base}@branch=#{opts[:branch]}" if opts[:branch]

data/lib/load_runner/server.rb

@@ -28,8 +28,9 @@ module LoadRunner
       opts = {}
       opts[:repo]    = payload.dig(:repository, :name)
       opts[:event]   = request.env['HTTP_X_GITHUB_EVENT']
-      opts[:branch]  = payload[:ref].sub('refs/heads/', '') if payload[:ref] =~ /refs\/heads/
-      opts[:tag]     = payload[:ref].sub('refs/tags/', '') if payload[:ref] =~ /refs\/tags/
+      opts[:ref]     = payload[:ref]
+      opts[:branch]  = payload[:ref] =~ /refs\/heads/ ? payload[:ref].sub('refs/heads/', '') : nil
+      opts[:tag]     = payload[:ref] =~ /refs\/tags/ ? payload[:ref].sub('refs/tags/', '') : nil
       opts[:payload] = json_string
 
       runner = Runner.new opts

data/lib/load_runner/version.rb

@@ -1,3 +1,3 @@
 module LoadRunner
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loadrunner
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_docopt