loadrunner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed96c8d23afef79bc83474cdeb980cdea9a27177
+  data.tar.gz: 0bf010a529fad2cb7b1aa6b701be77e719e8c213
+SHA512:
+  metadata.gz: 0c32f1097bcee3743adc63cb1148fecf533b4e78fdd24e1a2f1ead011f7e9301431f4894bb1fa30e3db081c3badb100c252a9389961fba5f09c17406ea3f4537
+  data.tar.gz: 2c47338a7941d91f70b91b260fa0806f6cc97694f6520f9d1e02c68f71a9b27884befdd9c0ae9000bc3a1c18c4d30483d04c0a943c286340e68006adf8324357

data/README.md

@@ -0,0 +1,36 @@
+LoadRunner - GitHub Webhook Server and Event Simulator
+======================================================
+
+[![Gem](https://img.shields.io/gem/v/loadrunner.svg?style=flat-square)](https://rubygems.org/gems/loadrunner)
+[![Travis](https://img.shields.io/travis/DannyBen/loadrunner.svg?style=flat-square)](https://travis-ci.org/DannyBen/loadrunner)
+[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/loadrunner.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/loadrunner)
+[![Gemnasium](https://img.shields.io/gemnasium/DannyBen/loadrunner.svg?style=flat-square)](https://gemnasium.com/DannyBen/loadrunner)
+
+---
+
+LoadRunner is a dual-purpose utility for working with GitHub webhooks.
+
+It provides these features:
+
+- A webserver that responds to GitHub webhook events and can run any 
+  arbitrary script writtn in any language.
+- A command line utility for testing your webhook server configuration.
+
+---
+
+Install
+--------------------------------------------------
+
+```
+$ gem install loadrunner
+```
+
+Getting Started
+--------------------------------------------------
+
+Soon
+
+Usage
+--------------------------------------------------
+
+Soon

data/bin/loadrunner

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

data/lib/load_runner/_server.rb

@@ -0,0 +1,44 @@
+require 'sinatra'
+require "sinatra/reloader" if development?
+require 'json'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'byebug'
+
+set port: 3000
+set bind: '0.0.0.0'
+
+ENV['SECRET_TOKEN'] = '123'
+
+post '/payload' do
+  request.env['HTTP_X_HUB_SIGNATURE']
+
+  request.body.rewind
+  payload_body = request.body.read
+
+  verify_signature payload_body
+
+  push = ActiveSupport::HashWithIndifferentAccess.new JSON.parse payload_body
+
+  branch = push[:ref] =~ /refs\/head/ ? push[:ref].sub('refs/heads/', '') : nil;
+  tag    = push[:ref] =~ /refs\/tags/ ? push[:ref].sub('refs/tags/', '') : nil;
+
+  result = {
+    event: request.env['HTTP_X_GITHUB_EVENT'],
+    repo: push[:repository][:name],
+    branch: branch,
+    tag: tag
+    # payload: push
+  }
+
+  result.inspect
+end
+
+post '/debug' do
+  request.env['HTTP_X_HUB_SIGNATURE']
+end
+
+def verify_signature(payload_body)
+  signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), ENV['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

data/lib/load_runner/client.rb

@@ -0,0 +1,70 @@
+require 'httparty'
+
+module LoadRunner
+  class Client
+    include HTTParty
+    attr_accessor :secret_token, :base_url, :payload
+    
+    def initialize(opts={})
+      @secret_token = opts[:secret_token]
+      @base_url = opts[:base_url] || 'localhost:3000'
+      self.class.base_uri base_url
+    end
+
+    def send(event=:push, opts={})
+      payload = build_payload opts
+      send_payload event, payload
+    end
+
+    def send_payload(event=:push, payload)
+      @payload = payload.is_a?(String) ? payload : payload.to_json
+      self.class.post "/payload", body: @payload, headers: headers(:push)
+    end
+
+    private
+
+    def headers(event=:push)
+      {}.tap do |header|
+        header['X_GITHUB_EVENT'] = event.to_s if event
+        header['X_HUB_SIGNATURE'] = signature if secret_token
+      end
+    end
+
+    def signature
+      return nil unless secret_token
+      signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), secret_token, payload)
+    end
+
+    def build_payload(opts={})
+      {}.tap do |result|
+        result[:ref] = ref_from_opts opts
+        result[:repository] = repo_from_opts opts
+      end
+    end
+
+    def ref_from_opts(opts)
+      if opts[:ref]
+        opts[:ref]
+      elsif opts[:branch]
+        "refs/heads/#{opts[:branch]}" 
+      elsif opts[:tag]
+        "refs/tags/#{opts[:tag]}"
+      end
+    end
+
+    def repo_from_opts(opts)
+      if opts[:repo] =~ /.+\/.+/
+        _owner, name = opts[:repo].split '/'
+        {
+          name: name,
+          full_name: opts[:repo]
+        }
+      else 
+        {
+          name: opts[:repo]
+        }
+      end
+    end
+
+  end
+end

data/lib/load_runner/command_line.rb

@@ -0,0 +1,62 @@
+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

data/lib/load_runner/docopt.txt

@@ -0,0 +1,55 @@
+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
+
+

data/lib/load_runner/exceptions.rb

@@ -0,0 +1,3 @@
+module LoadRunner
+  class Error < StandardError; end
+end

data/lib/load_runner/server.rb

@@ -0,0 +1,35 @@
+module LoadRunner
+
+  # The Sinatra server
+  class Server < ServerBase
+    post '/payload' do
+      request.body.rewind
+      payload_body = request.body.read
+
+      verify_signature payload_body if secret_token
+
+      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
+
+      file = "handlers/#{repo}/#{event}"
+      File.exist?(file) ? `#{file}` : result.inspect
+    end
+
+    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/server_base.rb

@@ -0,0 +1,29 @@
+require 'sinatra/base'
+require "sinatra/reloader"
+require 'active_support/core_ext/hash/indifferent_access'
+
+module LoadRunner
+
+  # The base class for the sinatra server.
+  # Initialize what we can here, but since there are values that will
+  # become known only later, the #prepare method is provided.
+  class ServerBase < Sinatra::Application
+    set :root, File.expand_path('../../', __dir__)
+    set :server, :puma
+
+    configure :development do
+      register Sinatra::Reloader if defined? Sinatra::Reloader
+    end
+
+    # Since we cannot use any config values in the main body of the class,
+    # since they will be updated later, we need to set anything that relys
+    # on the config values just before running the server.
+    # The CommandLine class and the test suite should both call
+    # `Server.prepare` before calling Server.run!
+    def self.prepare(opts={})
+      set :bind, opts[:bind] || '0.0.0.0'
+      set :port, opts[:port] || '3000'
+    end
+  end
+
+end

data/lib/load_runner/version.rb

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

data/lib/loadrunner.rb

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

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: loadrunner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  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'
+- !ruby/object:Gem::Dependency
+  name: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: runfile-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Run your GitHub webhook server and Send simulated github events
+email: db@dannyben.com
+executables:
+- loadrunner
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/loadrunner
+- lib/load_runner/_server.rb
+- lib/load_runner/client.rb
+- lib/load_runner/command_line.rb
+- lib/load_runner/docopt.txt
+- lib/load_runner/exceptions.rb
+- lib/load_runner/server.rb
+- lib/load_runner/server_base.rb
+- lib/load_runner/version.rb
+- lib/loadrunner.rb
+homepage: https://github.com/DannyBen/loadrunner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: GitHub Webhook Server and Simulator
+test_files: []