loadrunner 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed96c8d23afef79bc83474cdeb980cdea9a27177
-  data.tar.gz: 0bf010a529fad2cb7b1aa6b701be77e719e8c213
+  metadata.gz: 3b9fd36357c745fed71eae60ca9b40ee65a4efa9
+  data.tar.gz: 6bae665acbdf5c16086c7c31f041f6a5e855c78b
 SHA512:
-  metadata.gz: 0c32f1097bcee3743adc63cb1148fecf533b4e78fdd24e1a2f1ead011f7e9301431f4894bb1fa30e3db081c3badb100c252a9389961fba5f09c17406ea3f4537
-  data.tar.gz: 2c47338a7941d91f70b91b260fa0806f6cc97694f6520f9d1e02c68f71a9b27884befdd9c0ae9000bc3a1c18c4d30483d04c0a943c286340e68006adf8324357
+  metadata.gz: baeaa1f2dee184b212ed6e9c0fff2437b05d2d5ed9c553708e383b06dfec022415e01eb7d90aebc131ce8eab26da683e9d6c2446ca2ee1e4619a30525ec40343
+  data.tar.gz: e99dc43867d5b07839a0e9a94d3e1330e74b803c1ba9a5afaed3d7493b50d4636a3b927651308697662f9777a6ba8938508f10c05f1510005128587477cc0292

data/README.md

@@ -28,9 +28,18 @@ $ gem install loadrunner
 Getting Started
 --------------------------------------------------
 
-Soon
+    # 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
+
+    # Start the server
+    $ loadrunner server
+
+    # In another terminal, send a sample webhook event
+    $ loadrunner send localhost:3000 myrepo push master
+
+    # Verify the handler was executed
+    $ cat output.txt
 
-Usage
---------------------------------------------------
 
-Soon

data/lib/load_runner/client.rb

@@ -18,7 +18,8 @@ module LoadRunner
 
     def send_payload(event=:push, payload)
       @payload = payload.is_a?(String) ? payload : payload.to_json
-      self.class.post "/payload", body: @payload, headers: headers(:push)
+      headers = headers event
+      self.class.post "/payload", body: @payload, headers: headers
     end
 
     private
@@ -32,7 +33,7 @@ module LoadRunner
 
     def signature
       return nil unless secret_token
-      signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), secret_token, payload)
+      'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), secret_token, payload)
     end
 
     def build_payload(opts={})
@@ -55,14 +56,9 @@ module LoadRunner
     def repo_from_opts(opts)
       if opts[:repo] =~ /.+\/.+/
         _owner, name = opts[:repo].split '/'
-        {
-          name: name,
-          full_name: opts[:repo]
-        }
+        { name: name, full_name: opts[:repo] }
       else 
-        {
-          name: opts[:repo]
-        }
+        { name: opts[:repo] }
       end
     end
 

data/lib/load_runner/command_line.rb

@@ -1,62 +1,63 @@
-require 'singleton'
-require 'docopt'
-
-module LoadRunner
-
-  # Handles the command line interface
-  class CommandLine
-    include Singleton
-
-    attr_reader :args
-
-    # Gets an array of arguments (e.g. ARGV), executes the command if valid
-    # and shows usage patterns / help otherwise.
-    def execute(argv=[])
-      doc = File.read File.dirname(__FILE__) + '/docopt.txt'
-      begin
-        @args = Docopt::docopt(doc, argv: argv, version: VERSION)
-        handle
-      rescue Docopt::Exit => e
-        puts e.message
-      end
-    end
-
-    private
-
-    # Called when the arguments match one of the usage patterns. Will 
-    # delegate action to other, more specialized methods.
-    def handle
-      return send   if args['send']
-      return server if args['server']
-    end
-
-    def send
-      client = Client.new client_opts
-      response = client.send args['EVENT'], payload_opts
-      puts response
-    end
-
-    def server
-      Server.prepare port: args['--port'], bind: args['--bind']
-      Server.run!
-    end
-
-    def client_opts
-      {
-        base_url: args['URL'], 
-        secret_token: '123'
-      }
-    end
-
-    def payload_opts
-      result = { repo: args['REPO'] }
-
-      ref = args['REF']
-      ref = "refs/tags/#{$1}" if ref =~ /^tag:(.+)/
-      ref = "refs/heads/#{$1}" if ref =~ /^branch:(.+)/
-
-      result[:ref] = ref
-      result
-    end
-  end
-end
+require 'singleton'
+require 'docopt'
+
+module LoadRunner
+
+  # Handles the command line interface
+  class CommandLine
+    include Singleton
+
+    attr_reader :args
+
+    # Gets an array of arguments (e.g. ARGV), executes the command if valid
+    # and shows usage patterns / help otherwise.
+    def execute(argv=[])
+      doc = File.read File.dirname(__FILE__) + '/docopt.txt'
+      begin
+        @args = Docopt::docopt(doc, argv: argv, version: VERSION)
+        handle
+      rescue Docopt::Exit => e
+        puts e.message
+      end
+    end
+
+    private
+
+    # Called when the arguments match one of the usage patterns. Will 
+    # delegate action to other, more specialized methods.
+    def handle
+      return send   if args['send']
+      return server if args['server']
+    end
+
+    def send
+      client = Client.new client_opts
+      response = client.send args['EVENT'], payload_opts
+      puts response
+    end
+
+    def server
+      Server.prepare port: args['--port'], bind: args['--bind']
+      Server.run!
+    end
+
+    def client_opts
+      {
+        base_url: args['URL'], 
+        secret_token: '123'
+      }
+    end
+
+    def payload_opts
+      result = { repo: args['REPO'] }
+
+      ref = args['REF']
+      ref = "refs/tags/#{$1}" if ref =~ /^tag=(.+)/
+      ref = "refs/heads/#{$1}" if ref =~ /^branch=(.+)/
+      ref = "refs/heads/#{ref}" if ref !~ /^refs/
+
+      result[:ref] = ref
+      result
+    end
+  end
+end

data/lib/load_runner/docopt.txt

@@ -1,55 +1,57 @@
-LoadRunner
-
-Usage:
-  loadrunner server [--port N --bind IP]
-  loadrunner send URL REPO EVENT REF
-  loadrunner (-h|--help|--version)
-
-Commands:
-  server
-    Start the webhook server.
-
-  send
-    Send a simulated GitHub event to a webhook server.
-
-Parameters:
-  URL
-    The URL of the webhook server. This server should have a /payload
-    endpoint that responds to POST requests.
-
-  REPO
-    The name of the repository. This can be either the short name 
-    (my_repo), or the full name (my_name/my_repo).
-
-  EVENT
-    Any GitHub event, for example: push or ping.
-
-  REF
-    A branch or tag specifier. This parameter supports three formats:
-    * tag:tag_name
-    * branch:branch_name
-    * raw ref string (for example /refs/tags/tagname)
-
-Options:
-  --port N
-    Set the port of the webhook server.
-
-  --bind IP
-    Set the listening address of the webhook server.
-
-
-Environment Variables:
-  GITHUB_SECRET_TOKEN=y0urAP1k3y
-    Set Your GitHub secret token.
-
-Examples:
-  # Simulate push events
-  loadrunner send localhost:3000 my_repo push branch:master
-  loadrunner send localhost:3000 my_repo push tag:staging
-  loadrunner send localhost:3000 my_repo push refs/tags/staging
-
-  # Start the server
-  loadrunner server
-  loadrunner server --bind 0.0.0.0 --port 3000
-
-
+LoadRunner
+
+Usage:
+  loadrunner server [--port N --bind IP]
+  loadrunner send URL REPO EVENT [REF]
+  loadrunner (-h|--help|--version)
+
+Commands:
+  server
+    Start the webhook server.
+
+  send
+    Send a simulated GitHub event to a webhook server.
+
+Parameters:
+  URL
+    The URL of the webhook server. This server should have a /payload
+    endpoint that responds to POST requests.
+
+  REPO
+    The name of the repository. This can be either the short name 
+    (my_repo), or the full name (my_name/my_repo).
+
+  EVENT
+    Any GitHub event, for example: push or ping.
+
+  REF
+    A branch or tag specifier. This parameter supports four formats:
+    * branch_name
+    * tag=tag_name
+    * branch=branch_name
+    * raw ref string (for example refs/tags/tagname)
+
+Options:
+  --port N
+    Set the port of the webhook server.
+
+  --bind IP
+    Set the listening address of the webhook server.
+
+
+Environment Variables:
+  GITHUB_SECRET_TOKEN=y0urAP1k3y
+    Set Your GitHub secret token.
+
+Examples:
+  # Simulate push events
+  loadrunner send localhost:3000 my_repo push master
+  loadrunner send localhost:3000 my_repo push branch=master
+  loadrunner send localhost:3000 my_repo push tag=staging
+  loadrunner send localhost:3000 my_repo push refs/tags/staging
+
+  # Start the server
+  loadrunner server
+  loadrunner server --bind 0.0.0.0 --port 3000
+
+

data/lib/load_runner/runner.rb

@@ -0,0 +1,66 @@
+module LoadRunner
+
+  class Runner
+    attr_reader :opts
+    attr_accessor :response
+
+    def initialize(opts)
+      @opts = opts
+    end
+
+    def execute
+      set_environment_vars
+      
+      @response = opts.dup
+      handlers = locate_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
+        execute_all handlers
+        @response[:executed_handlers] = handlers
+        return true
+      end
+    end
+
+    private
+
+    def locate_handlers
+      handlers = []
+
+      matching_handlers.each do |handler|
+        handlers << handler if File.exist? handler
+      end
+
+      handlers
+    end
+
+    def execute_all(handlers)
+      handlers.each do |handler|
+        run_bg handler
+      end
+    end
+
+    def run_bg(cmd)
+      job = fork { exec cmd }
+      Process.detach job
+    end
+
+    def set_environment_vars
+      opts.each { |key, value| ENV[key.to_s.upcase] = value }
+    end
+
+    def matching_handlers
+      base = "handlers/#{opts[:repo]}"
+      handlers = ["#{base}/#{opts[:event]}"]
+
+      handlers.tap do |h|
+        h << "#{base}/#{opts[:event]}@branch-#{opts[:branch]}" if opts[:branch]
+        h << "#{base}/#{opts[:event]}@tag-#{opts[:tag]}" if opts[:tag]
+      end
+    end
+
+  end
+end

data/lib/load_runner/server.rb

@@ -2,6 +2,8 @@ module LoadRunner
 
   # The Sinatra server
   class Server < ServerBase
+    include ServerHelper
+
     post '/payload' do
       request.body.rewind
       payload_body = request.body.read
@@ -10,26 +12,18 @@ module LoadRunner
 
       push = ActiveSupport::HashWithIndifferentAccess.new JSON.parse payload_body
 
-      branch = push[:ref] =~ /refs\/heads/ ? push[:ref].sub('refs/heads/', '') : nil
-      tag    = push[:ref] =~ /refs\/tags/ ? push[:ref].sub('refs/tags/', '') : nil
-      repo   = push[:repository][:name]
-      event  = request.env['HTTP_X_GITHUB_EVENT']
-
-      result = { event: event, repo: repo, branch: branch, tag: tag }
-      result.inspect
+      opts = {}
+      opts[:repo]   = push[: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/
 
-      file = "handlers/#{repo}/#{event}"
-      File.exist?(file) ? `#{file}` : result.inspect
-    end
+      runner = Runner.new opts
+      success = runner.execute
 
-    def verify_signature(payload_body)
-      signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), secret_token, payload_body)
-      signature_match = Rack::Utils.secure_compare(signature, request.env['HTTP_X_HUB_SIGNATURE'])
-      return halt 401, "Bad Signature" unless signature_match
-    end
+      status 404 unless success
 
-    def secret_token
-      ENV['GITHUB_SECRET_TOKEN']
+      json runner.response
     end
   end
 end

data/lib/load_runner/server_base.rb

@@ -1,5 +1,6 @@
 require 'sinatra/base'
 require "sinatra/reloader"
+require "sinatra/json"
 require 'active_support/core_ext/hash/indifferent_access'
 
 module LoadRunner
@@ -25,5 +26,4 @@ module LoadRunner
       set :port, opts[:port] || '3000'
     end
   end
-
 end

data/lib/load_runner/server_helper.rb

@@ -0,0 +1,13 @@
+module LoadRunner
+  module ServerHelper
+    def verify_signature(payload_body)
+      signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), secret_token, payload_body)
+      signature_match = Rack::Utils.secure_compare(signature, request.env['HTTP_X_HUB_SIGNATURE'])
+      return halt 401, "Bad Signature" unless signature_match
+    end
+
+    def secret_token
+      ENV['GITHUB_SECRET_TOKEN']
+    end
+  end
+end

data/lib/load_runner/version.rb

@@ -1,3 +1,3 @@
 module LoadRunner
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/loadrunner.rb

@@ -1,6 +1,11 @@
 require 'load_runner/version'
 require 'load_runner/exceptions'
+
+require 'load_runner/runner'
+require 'load_runner/server_helper'
 require 'load_runner/server_base'
 require 'load_runner/server'
+
 require 'load_runner/client'
+
 require 'load_runner/command_line'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loadrunner
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -164,8 +164,10 @@ files:
 - lib/load_runner/command_line.rb
 - lib/load_runner/docopt.txt
 - lib/load_runner/exceptions.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/version.rb
 - lib/loadrunner.rb
 homepage: https://github.com/DannyBen/loadrunner