loadrunner 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8a007f7920f1973efc60d3795c4cd8dab52cb3d
-  data.tar.gz: 0baaf60bb349d17969597985c564bdb68daf1391
+  metadata.gz: 45e2aa0edf131bb75fdac7ac306131ba87791958
+  data.tar.gz: b6380a094f0d73e15e3922b3b2caea0e90db56b6
 SHA512:
-  metadata.gz: dd2ddfff2c1dfa0522871c2a41c84e60b36934e56d5785e52172d5cc4bccb17c99cde8e58d78b580a4181448ba252b9b99a512ee803e694e390598f38536ef23
-  data.tar.gz: 714bea8499b8c53e358dfca0fe09e75cd97455b97729f49bd99f71d15f6e91b51562c60b0c31386ebdb5cd954325eaa2336a5b91de7bce28f8a820dabee645f1
+  metadata.gz: a8775a42b092fb08485fdf72525ed2dcaa48f59f908f593c4ba8859a22739abdb671b0d3edfc92f3cc086198d875cccc5bc8322190f2202998846182506667be
+  data.tar.gz: 3fe722e065dab62c742d337c006b2cd2ccea46920cd2a70692a645250d721d609b47574e5af23c1d0d50d040df22cb5afa64e3c760384eb04e397430a4ed65c5

data/README.md

@@ -8,13 +8,16 @@ LoadRunner - GitHub Webhook Server and Event Simulator
 
 ---
 
-LoadRunner is a dual-purpose utility for working with GitHub webhooks.
+LoadRunner is a multi-purpose utility for working with GitHub webhooks and 
+statuses.
 
 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.
+- A command line utility for testing your webhook server configuration by
+  sending simulated events.
+- A command line utility for sending status updates to pull requests.
 
 ---
 
@@ -43,3 +46,9 @@ Getting Started
     $ cat output.txt
 
 
+For more options, see the [documentation][1] or run
+
+    $ loadrunner --help
+
+
+[1]: http://www.rubydoc.info/gems/loadrunner

data/lib/load_runner/client.rb

@@ -1,6 +1,8 @@
 require 'httparty'
 
 module LoadRunner
+
+  # Send simulated GitHub events to any webhook server
   class Client
     include HTTParty
     attr_accessor :secret_token, :base_url, :payload
@@ -11,11 +13,18 @@ module LoadRunner
       self.class.base_uri base_url
     end
 
+    # Send a simulated event using a shorthand syntax. opts can contain
+    # any of these:
+    # * +repo+: repository name
+    # * +ref+: ref ID (for example +ref/heads/branchname+)
+    # * +branch+: branch name
+    # * +tag+: tag name
     def send(event=:push, opts={})
       payload = build_payload opts
       send_payload event, payload
     end
 
+    # Send a simulated event. Payload can be a hash or a JSON string.
     def send_payload(event, payload)
       @payload = payload.is_a?(String) ? payload : payload.to_json
       headers = headers event

data/lib/load_runner/command_line.rb

@@ -1,12 +1,13 @@
 require 'singleton'
 require 'docopt'
-require 'awesome_print'
+require 'colsole'
 
 module LoadRunner
 
   # Handles the command line interface
   class CommandLine
     include Singleton
+    include Colsole
 
     attr_reader :args
 
@@ -28,15 +29,14 @@ module LoadRunner
     # delegate action to other, more specialized methods.
     def handle
       return send   if args['send']
+      return status if args['status']
       return server if args['server']
     end
 
     def send
       client = Client.new client_opts
       response = client.send args['EVENT'], payload_opts
-
-      puts "Reesponse code: #{response.code}" if response.respond_to? :code
-      ap response
+      show response
     end
 
     def server
@@ -44,6 +44,20 @@ module LoadRunner
       Server.run!
     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
+      
+      show response
+    end
+
     def client_opts
       {
         base_url: args['URL'], 
@@ -65,5 +79,16 @@ module LoadRunner
       result[:ref] = ref
       result
     end
+
+    # Print the response json to stdout, and the response code to stderr.
+    def show(response)
+      puts JSON.pretty_generate response
+
+      if response.respond_to? :code
+        code = response.code.to_s
+        color = code =~ /^2\d\d/ ? :txtgrn : :txtred
+        say! "!#{color}!Response Code: #{code}"
+      end
+    end
   end
 end

data/lib/load_runner/docopt.txt

@@ -3,6 +3,7 @@ LoadRunner
 Usage:
   loadrunner server [--port N --bind IP]
   loadrunner send URL REPO EVENT [REF]
+  loadrunner status REPO SHA STATE [--context TEXT --desc TEXT --url URL]
   loadrunner (-h|--help|--version)
 
 Commands:
@@ -12,6 +13,9 @@ Commands:
   send
     Send a simulated GitHub event to a webhook server.
 
+  status
+    Send status update to a github pull request.
+
 Parameters:
   URL
     The URL of the webhook server. This server should have a /payload
@@ -31,6 +35,12 @@ Parameters:
     * branch=branch_name
     * raw ref string (for example refs/tags/tagname)
 
+  SHA
+    Commit SHA string.
+
+  STATE
+    One of 'success', 'pending', 'error', 'failure'
+
 Options:
   --port N
     Set the port of the webhook server.
@@ -38,6 +48,14 @@ Options:
   --bind IP
     Set the listening address of the webhook server.
 
+  --context TEXT
+    Indicate what service is sending this status.
+
+  --url URL
+    The target URL to associate with this status.
+
+  --desc TEXT
+    A short description of the status.
 
 Environment Variables:
   GITHUB_SECRET_TOKEN=y0urAP1k3y
@@ -54,4 +72,8 @@ Examples:
   loadrunner server
   loadrunner server --bind 0.0.0.0 --port 3000
 
+  # Send a status
+  loadrunner status me/myrepo 018b0ac... pending
+  loadrunner status me/myrepo 018b0ac... success --context "My CI"
+
 

data/lib/load_runner/git_hub_api.rb

@@ -0,0 +1,48 @@
+require 'httparty'
+
+module LoadRunner
+  # Communicate with GitHub
+  class GitHubAPI
+    include HTTParty
+    
+    base_uri 'https://api.github.com'
+
+    # Send status update to a pull request. Supported options:
+    # * +state+: :pending, :success, :failure or :error
+    # * +context+: any string
+    # * +description+: any string
+    # * +target_url+: any valid URL
+    def status(repo, sha, opts={})
+      # sha = '018b0ac55dbf0d8e1eef6df46e04dfef8bea9b96'
+      message = {
+        body: {
+          state: (opts[:state] ? opts[:state].to_s : 'pending'),
+          context: (opts[:context] || 'LoadRunner'),
+          description: opts[:description],
+          target_url: opts[:target_url]
+        }.to_json
+      }
+      self.class.post "/repos/#{repo}/statuses/#{sha}", message.merge(request_options)
+    end
+
+    private
+
+    def request_options
+      {
+        headers: headers 
+      }
+    end
+
+    def headers
+      {
+        "Authorization" => "token #{secret_token}",
+        "User-Agent" =>    "LoadRunner"
+      }
+    end
+
+    def secret_token
+      ENV['GITHUB_ACCESS_TOKEN']
+    end
+
+  end
+end

data/lib/load_runner/runner.rb

@@ -1,5 +1,6 @@
 module LoadRunner
 
+  # Executes event handlers
   class Runner
     attr_reader :opts
     attr_accessor :response
@@ -8,6 +9,8 @@ module LoadRunner
       @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
       
@@ -35,6 +38,7 @@ module LoadRunner
 
     private
 
+    # Find all handlers that fit the payload meta data.
     def locate_handlers
       handlers = []
 
@@ -45,17 +49,21 @@ module LoadRunner
       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[key.to_s.upcase] = value }
     end

data/lib/load_runner/server.rb

@@ -3,6 +3,7 @@ module LoadRunner
   # The Sinatra server
   class Server < ServerBase
     include ServerHelper
+    include SignatureHelper
 
     get '/' do
       "OK"

data/lib/load_runner/server_helper.rb

@@ -1,23 +1,5 @@
 module LoadRunner
   module ServerHelper
-    def verify_signature(payload_body, signature)
-      return :no_client if secret_token and !signature
-      return :no_server if !secret_token and signature
-      return :ok        if !secret_token and !signature
-
-      expected_signature = generate_signature payload_body
-      signature_match = Rack::Utils.secure_compare(expected_signature, signature)
-      return signature_match ? :ok : :mismatch
-    end
-
-    def generate_signature(payload_body)
-      'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), secret_token, payload_body)
-    end
-
-    def secret_token
-      ENV['GITHUB_SECRET_TOKEN']
-    end
-
     def halt_messages
       {
         no_client: "Client did not send a signature",

data/lib/load_runner/signature_helper.rb

@@ -0,0 +1,21 @@
+module LoadRunner
+  module SignatureHelper
+    def verify_signature(payload_body, signature)
+      return :no_client if secret_token and !signature
+      return :no_server if !secret_token and signature
+      return :ok        if !secret_token and !signature
+
+      expected_signature = generate_signature payload_body
+      signature_match = Rack::Utils.secure_compare(expected_signature, signature)
+      return signature_match ? :ok : :mismatch
+    end
+
+    def generate_signature(payload_body)
+      'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), secret_token, payload_body)
+    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.4"
+  VERSION = "0.1.0"
 end

data/lib/loadrunner.rb

@@ -1,8 +1,10 @@
 require 'load_runner/version'
-require 'load_runner/exceptions'
 
-require 'load_runner/runner'
+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'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loadrunner
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.1'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: runfile
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Run your GitHub webhook server and Send simulated github events
 email: db@dannyben.com
 executables:
@@ -187,15 +201,15 @@ 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/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
 homepage: https://github.com/DannyBen/loadrunner

data/lib/load_runner/_server.rb

@@ -1,44 +0,0 @@
-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/exceptions.rb

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