loadrunner 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 072a2884c588a7518e9599b185cd42e45a97bfee3a6982bd833f72f0ed8655aa
-  data.tar.gz: b02abbe4a6661866a619dd669db72a9d5223be98db8add50406d6a6bb4fc812a
+  metadata.gz: bd9af2dc326ef685b9146a1b8a298abf9ed016561863165fd08e7aa5e4b5e79a
+  data.tar.gz: 75fc0ebe16b294f51f0f6aa324170cb9e653315a26b0be8af42f98ee90c2a014
 SHA512:
-  metadata.gz: 45f170d7b2738a4191da675451781ce8941a36c73e8ed3da059ea25de26898c51889503b7f43d62dfb68828e0309b0f6d2852d85e706d767c075bf834f29dfd4
-  data.tar.gz: 0f0b3e40db633939a8b6c3113396baf2ae63d0c86101d98fff041aff9e158575b120c09dba74fbdcd2885064d4b9edd163b5d057f19a586bfb4f8e7913f4c3de
+  metadata.gz: b85c8c7f3bf7d681c6e0ebc7adec6a968a78317723c47492782859068414cfe632cd25b75cf26e5f1c69e336c8b3b779718830ace0f98c8784bf235de1592323
+  data.tar.gz: d577629537efad165e299e9d9b0853239d89369f7660f455c34d54f78b468f57f5edad85f831c654ed8affe5e4765740db7a7855b323d12b2f709ff6e523a78b

data/README.md

@@ -1,14 +1,13 @@
-LoadRunner - GitHub Webhook Server and Event Simulator
+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.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)
 
 ---
 
-LoadRunner is a multi-purpose utility for working with GitHub webhooks and 
+Loadrunner is a multi-purpose utility for working with GitHub webhooks and 
 statuses.
 
 It provides these features:
@@ -35,19 +34,18 @@ $ gem install loadrunner
 Getting Started
 --------------------------------------------------
 
-1. Download the [handlers](handlers) directory from this repository, as an
-   exmaple. This directory contains several handler examples.
+1. Download the [hooks](hooks) directory from this repository, as an
+   exmaple. This directory contains several hook examples.
 2. Make sure that all files within that folder are executables.
-3. Start the server (from the `handlers` **parent** directory):
+3. Start the server (from the `hooks` **parent** directory):
    `loadrunner server`
 4. In another terminal, send a sample webhook event:
-   `loadrunner event localhost:3000/payload myrepo push master
+   `loadrunner event localhost:3000 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`).
-```
+hooks were executed (`executed_hooks`) and what hooks *could have
+been* executed, if they were defined in the hooks folder
+(`matching_hooks`).
 
 
 For more options, see the [documentation][1] or run
@@ -58,43 +56,86 @@ $ loadrunner --help
 
 
 
-Building Handlers
+Building Hooks
 --------------------------------------------------
 
-When running the server, it will look for handlers (executable scripts) in
-the `./handlers` directory, using one of these format:
+When running the server, it will look for hooks (executable scripts) in
+the `./hooks` 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>
+    hooks/global
+    hooks/<repo name>/global
+    hooks/<repo name>/<event type>
+    hooks/<repo name>/<event type>@branch=<branch name>
+    hooks/<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
+    hooks/global
+    hooks/myrepo/global
+    hooks/myrepo/push
+    hooks/myrepo/push@branch=master
+    hooks/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
+When none of the hooks are found, Loadrunner will respond with a list of
+hooks 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.
+The hooks can be written in any language, and should simply be executables.
 
 ### Environment Variables
 
-These environment variables are available to your handlers:
+These environment variables are available to your hooks:
 
 - `LOADRUNNER_REPO`
 - `LOADRUNNER_EVENT`
 - `LOADRUNNER_BRANCH`
+- `LOADRUNNER_COMMIT`
 - `LOADRUNNER_REF`
 - `LOADRUNNER_TAG`
-- `LOADRUNNER_PAYLOAD` - the entire JSON string as received from GitHub, or the client.
+
+
+
+Using as a Rack or Sinatra mount
+--------------------------------------------------
+
+If you wish to mount the Loadrunner server under another Rack or Sinatra
+application, use the `Loadrunner::Server` as the handler.
+
+
+```ruby
+# config.ru
+require "loadrunner/server"
+
+map "/github" do
+  run Loadrunner::Server
+end
+
+run YourOwnApp
+```
+
+
+
+Sending Pull Request status from Ruby code
+--------------------------------------------------
+
+You may use the `Loadrunner::Status` class to update the status of a
+GitHub pull request.
+
+First, make sure that your GitHub API access token is set in the environment
+variable `GITHUB_ACCESS_TOKEN`.
+
+```ruby
+require 'loadrunner/status'
+
+response = Loadrunner::Status.update repo: 'user/repo', 
+  sha: 'commit sha string', 
+  state: :pending,  # :pending :success :failure :error
+  context: "My Hooks Server",
+  description: "Jobs have not started yet",
+  url: "http://example.com"
+```
+
+Only `repo`, `sha` and `state` are required, the rest arguments are optional.
 
 
 
@@ -103,16 +144,20 @@ Running with Docker
 
 You can run both the server and the client using Docker.
 
-    # Server
-    $ docker run -p3000:3000 dannyben/loadrunner server
+```shell
+# Server
+$ docker run -p3000:3000 dannyben/loadrunner server
 
-    # Client
-    $ docker run dannyben/loadrunner event http://webhook.server.com/payload repo push
+# Client
+$ docker run dannyben/loadrunner event http://webhook.server.com repo push
+```
 
 If you wish to connect the client to the server you are running through Docker, 
 you can do something like this:
 
-    $ docker run --network host dannyben/loadrunner event http://localhost:3000/payload repo push
+```shell
+$ docker run --network host dannyben/loadrunner event http://localhost:3000 repo push
+```
 
 See also: The [docker-compose file](docker-compose.yml).
 

data/bin/loadrunner

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
 
 require 'loadrunner'
+require 'loadrunner/command_line'
 
 begin
-  LoadRunner::CommandLine.execute ARGV
+  Loadrunner::CommandLine.execute ARGV
 rescue => e
   STDERR.puts "#{e.class} - #{e.message}"
 end

data/lib/loadrunner.rb

@@ -1,15 +1,5 @@
-require 'load_runner/version'
-
-require 'load_runner/signature_helper'
-require 'load_runner/server_helper'
-require 'load_runner/git_hub_api'
-
-require 'load_runner/runner'
-require 'load_runner/server_base'
-require 'load_runner/server'
-
-require 'load_runner/client'
-
-require 'load_runner/command_line'
+require 'loadrunner/server'
+require 'loadrunner/client'
+require 'loadrunner/command_line'
 
 require 'byebug' if ENV['BYEBUG']

data/lib/{load_runner → loadrunner}/client.rb

@@ -1,7 +1,7 @@
 require 'httparty'
 require 'uri'
 
-module LoadRunner
+module Loadrunner
 
   # Send simulated GitHub events to any webhook server
   class Client
@@ -12,7 +12,7 @@ module LoadRunner
       @secret_token = opts[:secret_token]
       @encoding = opts[:encoding] || :json
 
-      base_url = opts[:base_url] || 'http://localhost:3000/payload'
+      base_url = opts[:base_url] || 'http://localhost:3000'
       base_url = "http://#{base_url}" unless base_url =~ /^http/
 
       url_parts = URI.parse base_url
@@ -42,7 +42,7 @@ module LoadRunner
       self.class.post host_path, body: @payload, headers: headers(event)
     end
 
-    private
+  private
 
     def headers(event=:push)
       {}.tap do |header|

data/lib/{load_runner → loadrunner}/command_line.rb

@@ -1,7 +1,11 @@
 require 'super_docopt'
 require 'colsole'
+require 'loadrunner/client'
+require 'loadrunner/server'
+require 'loadrunner/status'
+require 'loadrunner/version'
 
-module LoadRunner
+module Loadrunner
 
   # Handles the command line interface
   class CommandLine < SuperDocopt::Base
@@ -33,20 +37,17 @@ module LoadRunner
     end
 
     def status
-      api = GitHubAPI.new
-      opts = {
-        state:       args['STATE'], 
-        target_url:  args['--url'], 
-        context:     args['--context'], 
-        description: args['--desc']
-      }
-
-      response = api.status args['REPO'], args['SHA'], opts
+      response = Status.update repo: args['REPO'], 
+        sha: args['SHA'], 
+        state: args['STATE'], 
+        context: args['--context'],
+        description: args['--desc'],
+        url: args['--url']
 
       show response
     end
 
-    private
+  private
 
     def client_opts
       {

data/lib/{load_runner → loadrunner}/docopt.txt

@@ -1,4 +1,4 @@
-LoadRunner
+loadrunner
 
 Usage:
   loadrunner server [--port N --bind IP]
@@ -27,7 +27,7 @@ Parameters:
   URL
     The URL of the webhook endpoint. This path should responds
     to POST requests. If you are sending an event to a loadrunner server,
-    send it to the /payload endpoint (e.g. localhost:3000/payload).
+    send it to the root endpoint (e.g. localhost:3000).
 
   REPO
     The name of the repository. This can be either the short name 
@@ -50,7 +50,7 @@ Parameters:
     Commit SHA string.
 
   STATE
-    One of 'success', 'pending', 'error', 'failure'
+    One of 'success', 'pending', 'error', 'failure'.
 
 Options:
   --port N
@@ -80,13 +80,13 @@ Environment Variables:
 
 Examples:
   # Simulate push events
-  loadrunner event localhost:3000/payload myrepo push master
-  loadrunner event localhost:3000/payload myrepo push branch=master
-  loadrunner event localhost:3000/payload myrepo push tag=staging --form
-  loadrunner event localhost:3000/payload myrepo push refs/tags/staging
+  loadrunner event localhost:3000 myrepo push master
+  loadrunner event localhost:3000 myrepo push branch=master
+  loadrunner event localhost:3000 myrepo push tag=staging --form
+  loadrunner event localhost:3000 myrepo push refs/tags/staging
 
   # Send a payload file
-  loadrunner payload localhost:3000/payload push payload.json
+  loadrunner payload localhost:3000 push payload.json
 
   # Start the server
   loadrunner server

data/lib/{load_runner/git_hub_api.rb → loadrunner/github_api.rb}

@@ -1,8 +1,8 @@
 require 'httparty'
 
-module LoadRunner
+module Loadrunner
   # Communicate with GitHub
-  class GitHubAPI
+  class GithubAPI
     include HTTParty
     
     base_uri 'https://api.github.com'
@@ -17,7 +17,7 @@ module LoadRunner
       message = {
         body: {
           state: (opts[:state] ? opts[:state].to_s : 'pending'),
-          context: (opts[:context] || 'LoadRunner'),
+          context: (opts[:context] || 'Loadrunner'),
           description: opts[:description],
           target_url: opts[:target_url]
         }.to_json
@@ -25,7 +25,7 @@ module LoadRunner
       self.class.post "/repos/#{repo}/statuses/#{sha}", message.merge(request_options)
     end
 
-    private
+  private
 
     def request_options
       {
@@ -36,7 +36,7 @@ module LoadRunner
     def headers
       {
         "Authorization" => "token #{secret_token}",
-        "User-Agent" =>    "LoadRunner"
+        "User-Agent" =>    "Loadrunner"
       }
     end
 

data/lib/loadrunner/runner.rb

@@ -0,0 +1,79 @@
+module Loadrunner
+
+  # Executes event hooks
+  class Runner
+    attr_reader :opts
+    attr_accessor :response, :hooks_dir
+
+    def initialize(opts)
+      @hooks_dir = 'hooks'
+      @opts = opts
+    end
+
+    # Execute all matching hooks based on the input payload. This method
+    # populates the `#response` object, and returns true on success.
+    def execute
+      set_environment_vars
+
+      @response = opts.dup
+      hooks = locate_hooks
+      @response[:matching_hooks] = matching_hooks
+
+      if hooks.empty?
+        @response[:error] = "Could not find any hook to process this request. Please implement one of the 'matching_hooks'."
+        return false
+      else
+        execute_all hooks
+        @response[:executed_hooks] = hooks
+        return true
+      end
+    end
+
+  private
+
+    # Find all hooks that fit the payload meta data.
+    def locate_hooks
+      hooks = []
+
+      matching_hooks.each do |hook|
+        hooks << hook if File.exist? hook
+      end
+
+      hooks
+    end
+
+    # Execute all hooks.
+    def execute_all(hooks)
+      hooks.each do |hook|
+        run_bg hook
+      end
+    end
+
+    # Run a command in the background.
+    def run_bg(cmd)
+      job = fork { exec cmd }
+      Process.detach job
+    end
+
+    # Set all payload meta data as environment variables so that the
+    # hook can use them.
+    def set_environment_vars
+      opts.each { |key, value| ENV["LOADRUNNER_#{key.to_s.upcase}"] = value }
+    end
+
+    def matching_hooks
+      base = "#{hooks_dir}/#{opts[:repo]}/#{opts[:event]}"
+      hooks = [
+        "#{hooks_dir}/global",
+        "#{hooks_dir}/#{opts[:repo]}/global",
+        "#{base}"
+      ]
+
+      hooks.tap do |h|
+        h << "#{base}@branch=#{opts[:branch]}" if opts[:branch]
+        h << "#{base}@tag=#{opts[:tag]}" if opts[:tag]
+      end
+    end
+
+  end
+end

data/lib/{load_runner → loadrunner}/server.rb

@@ -1,4 +1,9 @@
-module LoadRunner
+require 'loadrunner/server_helper'
+require 'loadrunner/server_base'
+require 'loadrunner/signature_helper'
+require 'loadrunner/runner'
+
+module Loadrunner
 
   # The Sinatra server
   class Server < ServerBase
@@ -6,10 +11,10 @@ module LoadRunner
     include SignatureHelper
 
     get '/' do
-      "OK"
+      "loadrunner ready"
     end
 
-    post '/payload' do
+    post '/' do
       request.body.rewind
       payload_body = request.body.read
 
@@ -23,15 +28,17 @@ module LoadRunner
       else
         json_string = URI.decode_www_form(payload_body).to_h["payload"]
       end
-      payload = ActiveSupport::HashWithIndifferentAccess.new JSON.parse json_string
+      payload = JSON.parse json_string
 
       opts = {}
-      opts[:repo]    = payload.dig(:repository, :name)
+      opts[:repo]    = payload.dig('repository', 'name')
+      opts[:commit]  = payload['after']
       opts[:event]   = request.env['HTTP_X_GITHUB_EVENT']
-      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
+      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
+
+      File.write "last_payload.json", json_string if ENV['DEBUG']
 
       runner = Runner.new opts
       success = runner.execute

data/lib/{load_runner → loadrunner}/server_base.rb

@@ -1,9 +1,8 @@
 require 'sinatra/base'
 require "sinatra/reloader"
 require "sinatra/json"
-require 'active_support/core_ext/hash/indifferent_access'
 
-module LoadRunner
+module Loadrunner
 
   # The base class for the sinatra server.
   # Initialize what we can here, but since there are values that will

data/lib/{load_runner → loadrunner}/server_helper.rb

@@ -1,4 +1,4 @@
-module LoadRunner
+module Loadrunner
   module ServerHelper
     def halt_messages
       {

data/lib/{load_runner → loadrunner}/signature_helper.rb

@@ -1,4 +1,4 @@
-module LoadRunner
+module Loadrunner
   module SignatureHelper
     def verify_signature(payload_body, signature)
       return :no_client if secret_token and !signature

data/lib/loadrunner/status.rb

@@ -0,0 +1,21 @@
+require 'loadrunner/github_api'
+
+module Loadrunner
+  # Update GitHub pull request status
+  class Status
+    class << self
+      def update(repo:, sha:, state:, context: nil, description: nil, url: nil)
+        api = GithubAPI.new
+
+        opts = {
+          state: state,
+          target_url:  url,
+          context: context,
+          description: description
+        }
+
+        api.status repo, sha, opts
+      end
+    end
+  end
+end

data/lib/loadrunner/version.rb

@@ -0,0 +1,3 @@
+module Loadrunner
+  VERSION = "0.4.3"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loadrunner
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: super_docopt
@@ -72,42 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 description: Run your GitHub webhook server and Send simulated github events
 email: db@dannyben.com
 executables:
@@ -117,17 +103,18 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/loadrunner
-- lib/load_runner/client.rb
-- lib/load_runner/command_line.rb
-- lib/load_runner/docopt.txt
-- lib/load_runner/git_hub_api.rb
-- lib/load_runner/runner.rb
-- lib/load_runner/server.rb
-- lib/load_runner/server_base.rb
-- lib/load_runner/server_helper.rb
-- lib/load_runner/signature_helper.rb
-- lib/load_runner/version.rb
 - lib/loadrunner.rb
+- lib/loadrunner/client.rb
+- lib/loadrunner/command_line.rb
+- lib/loadrunner/docopt.txt
+- lib/loadrunner/github_api.rb
+- lib/loadrunner/runner.rb
+- lib/loadrunner/server.rb
+- lib/loadrunner/server_base.rb
+- lib/loadrunner/server_helper.rb
+- lib/loadrunner/signature_helper.rb
+- lib/loadrunner/status.rb
+- lib/loadrunner/version.rb
 homepage: https://github.com/DannyBen/loadrunner
 licenses:
 - MIT

data/lib/load_runner/runner.rb

@@ -1,79 +0,0 @@
-module LoadRunner
-
-  # Executes event handlers
-  class Runner
-    attr_reader :opts
-    attr_accessor :response, :handlers_dir
-
-    def initialize(opts)
-      @handlers_dir = 'handlers'
-      @opts = opts
-    end
-
-    # Execute all matching handlers based on the input payload. This method
-    # 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[:error] = "Could not find any handler to process this webhook. Please implement one of the 'matching_handlers'."
-        return false
-      else
-        execute_all handlers
-        @response[:executed_handlers] = handlers
-        return true
-      end
-    end
-
-    private
-
-    # Find all handlers that fit the payload meta data.
-    def locate_handlers
-      handlers = []
-
-      matching_handlers.each do |handler|
-        handlers << handler if File.exist? handler
-      end
-
-      handlers
-    end
-
-    # Execute all handlers.
-    def execute_all(handlers)
-      handlers.each do |handler|
-        run_bg handler
-      end
-    end
-
-    # Run a command in the background.
-    def run_bg(cmd)
-      job = fork { exec cmd }
-      Process.detach job
-    end
-
-    # Set all payload meta data as environment variables so that the
-    # handler can use them.
-    def set_environment_vars
-      opts.each { |key, value| ENV["LOADRUNNER_#{key.to_s.upcase}"] = value }
-    end
-
-    def matching_handlers
-      base = "#{handlers_dir}/#{opts[:repo]}/#{opts[:event]}"
-      handlers = [
-        "#{handlers_dir}/global",
-        "#{handlers_dir}/#{opts[:repo]}/global",
-        "#{base}"
-      ]
-
-      handlers.tap do |h|
-        h << "#{base}@branch=#{opts[:branch]}" if opts[:branch]
-        h << "#{base}@tag=#{opts[:tag]}" if opts[:tag]
-      end
-    end
-
-  end
-end

data/lib/load_runner/version.rb

@@ -1,3 +0,0 @@
-module LoadRunner
-  VERSION = "0.4.2"
-end