loadrunner 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac288df3a479098d56c66cf0a2501fd5c8d59317d1243aba52290340c60892af
-  data.tar.gz: 74cdcf9ef45c4d7b913352b686160203aa03c6ef2722ea5fccc05020691bd3a8
+  metadata.gz: 3102e254b9713df61278cc81259d547f73d20015f83ee2f0ea1bb6f2399aa3c3
+  data.tar.gz: 714019cdae31109069f3d615dc21a18685317eb21edafeff91ab0ff58e8bd80d
 SHA512:
-  metadata.gz: 4fc9eec533a6d826b86b1e9c227375230c114f9763463239cd8c886cdc5d0ec57a4d53ae5be11e0363512d6c172e01b764c129ef64e740fea89549b9bc88046e
-  data.tar.gz: 981e1c6df07e8799691b69ea81528bb83db9edc2ff0b3e9c17be04ac5453a384c423e15b199d8abb86493de660ba47cf63db8eefbdf74444d312f505fba9bbd9
+  metadata.gz: 0547d09f0b585f3456dcdc1acc65ffc5b410108715db8a240870d6ce5b787660cfc04de3e854a58df6bd5c33292031f4373fb37564c2954fdd2851e9ceec5375
+  data.tar.gz: 10d21050595e15ecd56216bea4aeaa908ac17dbf9f0dfda0be7750e37adf1bfb5346778fb4a6696dc59b80f4d969946a7032dc3650cd279e28e1356c32a2b2e8

data/README.md

@@ -2,7 +2,7 @@ LoadRunner - GitHub Webhook Server and Event Simulator
 ======================================================
 
 [![Gem Version](https://badge.fury.io/rb/loadrunner.svg)](https://badge.fury.io/rb/loadrunner)
-[![Build Status](https://travis-ci.org/DannyBen/loadrunner.svg?branch=master)](https://travis-ci.org/DannyBen/loadrunner)
+[![Build Status](https://travis-ci.com/DannyBen/loadrunner.svg?branch=master)](https://travis-ci.com/DannyBen/loadrunner)
 [![Maintainability](https://api.codeclimate.com/v1/badges/f1aae46eaf6365ea2ec7/maintainability)](https://codeclimate.com/github/DannyBen/loadrunner/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/f1aae46eaf6365ea2ec7/test_coverage)](https://codeclimate.com/github/DannyBen/loadrunner/test_coverage)
 
@@ -21,6 +21,8 @@ It provides these features:
 
 ---
 
+
+
 Install
 --------------------------------------------------
 
@@ -28,28 +30,71 @@ Install
 $ gem install loadrunner
 ```
 
+
+
 Getting Started
 --------------------------------------------------
 
-    # 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
+```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
+# Start the server
+$ loadrunner server
 
-    # In another terminal, send a sample webhook event
-    $ loadrunner event localhost:3000 myrepo push master
+# In another terminal, send a sample webhook event
+$ loadrunner event localhost:3000 myrepo push master
 
-    # Verify the handler was executed
-    $ cat output.txt
+# Verify the handler was executed
+$ cat output.txt
+```
 
 
 For more options, see the [documentation][1] or run
 
-    $ loadrunner --help
+```shell
+$ loadrunner --help
+```
+
+
+
+Building Handlers
+--------------------------------------------------
+
+When running the server, it will look for handlers in the `./handlers` 
+directory, using one of these format:
+
+    handlers/<repo name>/<event type>
+    handlers/<repo name>/<event type>@branch=<branch name>
+    handlers/<repo name>/<event type>@tag=<branch name>
+
+For example:
+
+    handlers/myrepo/push
+    handlers/myrepo/push@branch=master
+    handlers/myrepo/push@tag=release
+
+When none of the handlers are found, LoadRunner will respond with a list of
+handlers it was looking for, so you can use this response to figure out what
+it needs.
+
+The handlers can be written in any language, and should simply be 
+executables.
+
+### Environment Variables
+
+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.
+
 
 
 Running with Docker

data/lib/load_runner/server.rb

@@ -23,13 +23,14 @@ module LoadRunner
       else
         json_string = URI.decode_www_form(payload_body).to_h["payload"]
       end
-      push = ActiveSupport::HashWithIndifferentAccess.new JSON.parse json_string
+      payload = ActiveSupport::HashWithIndifferentAccess.new JSON.parse json_string
 
       opts = {}
-      opts[:repo]   = push.dig(:repository, :name)
-      opts[:event]  = request.env['HTTP_X_GITHUB_EVENT']
-      opts[:branch] = push[:ref].sub('refs/heads/', '') if push[:ref] =~ /refs\/heads/
-      opts[:tag]    = push[:ref].sub('refs/tags/', '') if push[:ref] =~ /refs\/tags/
+      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[:payload] = json_string
 
       runner = Runner.new opts
       success = runner.execute

data/lib/load_runner/version.rb

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

metadata

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