loadrunner 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 45e2aa0edf131bb75fdac7ac306131ba87791958
-  data.tar.gz: b6380a094f0d73e15e3922b3b2caea0e90db56b6
+SHA256:
+  metadata.gz: e03188ae2b98426dceaa6986c04cc177fd52756d7842440b17567912a6076959
+  data.tar.gz: 534fe583d3b7ade5df62bc79ebc46fc8083eb515f157e054dbede9619d3e8152
 SHA512:
-  metadata.gz: a8775a42b092fb08485fdf72525ed2dcaa48f59f908f593c4ba8859a22739abdb671b0d3edfc92f3cc086198d875cccc5bc8322190f2202998846182506667be
-  data.tar.gz: 3fe722e065dab62c742d337c006b2cd2ccea46920cd2a70692a645250d721d609b47574e5af23c1d0d50d040df22cb5afa64e3c760384eb04e397430a4ed65c5
+  metadata.gz: baa121b508967453f6fa27c758e07791de8fdadec5380b422b1ecf407eb85ed5a07f4e3b5148be9ca3c960f7fea0ad88d2380d0a8a527b61c9f0cb4e09616d8e
+  data.tar.gz: f6cda33832faf0e4ec94102e68fbb16eb6882050bb7c6145d271e97899d5711a925a238db7db7d1111560a09ff0d4fb663f4df08de7106ee75d927f7c59ab713

data/README.md

@@ -1,10 +1,10 @@
 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)
+[![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)
+[![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)
 
 ---
 
@@ -14,7 +14,7 @@ statuses.
 It provides these features:
 
 - A webserver that responds to GitHub webhook events and can run any 
-  arbitrary script writtn in any language.
+  arbitrary script written in any language.
 - 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.
@@ -35,6 +35,7 @@ Getting Started
     $ 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
@@ -51,4 +52,21 @@ For more options, see the [documentation][1] or run
     $ loadrunner --help
 
 
+Running with Docker
+--------------------------------------------------
+
+You can run both the server and the client using Docker.
+
+    # Server
+    $ docker run -p3000:3000 dannyben/loadrunner server
+
+    # Client
+    $ docker run dannyben/loadrunner send http://webhook.server.com/payload 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 send http://localhost:3000/payload repo push
+
+
 [1]: http://www.rubydoc.info/gems/loadrunner

data/bin/loadrunner

@@ -3,7 +3,7 @@
 require 'loadrunner'
 
 begin
-  LoadRunner::CommandLine.instance.execute ARGV
+  LoadRunner::CommandLine.execute ARGV
 rescue => e
   STDERR.puts "#{e.class} - #{e.message}"
 end

data/lib/load_runner/client.rb

@@ -9,7 +9,7 @@ module LoadRunner
     
     def initialize(opts={})
       @secret_token = opts[:secret_token]
-      @base_url = opts[:base_url] || 'localhost:3000'
+      @base_url = opts[:base_url] || 'localhost:3000/payload'
       self.class.base_uri base_url
     end
 
@@ -19,7 +19,7 @@ module LoadRunner
     # * +ref+: ref ID (for example +ref/heads/branchname+)
     # * +branch+: branch name
     # * +tag+: tag name
-    def send(event=:push, opts={})
+    def send_event(event=:push, opts={})
       payload = build_payload opts
       send_payload event, payload
     end
@@ -28,7 +28,7 @@ module LoadRunner
     def send_payload(event, payload)
       @payload = payload.is_a?(String) ? payload : payload.to_json
       headers = headers event
-      self.class.post "/payload", body: @payload, headers: headers
+      self.class.post "", body: @payload, headers: headers
     end
 
     private

data/lib/load_runner/command_line.rb

@@ -1,41 +1,19 @@
-require 'singleton'
-require 'docopt'
+require 'super_docopt'
 require 'colsole'
 
 module LoadRunner
 
   # Handles the command line interface
-  class CommandLine
-    include Singleton
+  class CommandLine < SuperDocopt::Base
     include Colsole
 
-    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 status if args['status']
-      return server if args['server']
-    end
+    version VERSION
+    docopt File.expand_path 'docopt.txt', __dir__
+    subcommands [{'send' => 'send_event'}, 'status', 'server']
 
-    def send
+    def send_event
       client = Client.new client_opts
-      response = client.send args['EVENT'], payload_opts
+      response = client.send_event args['EVENT'], payload_opts
       show response
     end
 
@@ -54,10 +32,12 @@ module LoadRunner
       }
 
       response = api.status args['REPO'], args['SHA'], opts
-      
+
       show response
     end
 
+    private
+
     def client_opts
       {
         base_url: args['URL'], 
@@ -71,7 +51,7 @@ module LoadRunner
     def payload_opts
       result = { repo: args['REPO'] }
 
-      ref = args['REF']
+      ref = args['REF'] || 'master'
       ref = "refs/tags/#{$1}" if ref =~ /^tag=(.+)/
       ref = "refs/heads/#{$1}" if ref =~ /^branch=(.+)/
       ref = "refs/heads/#{ref}" if ref !~ /^refs/
@@ -82,13 +62,19 @@ module LoadRunner
 
     # Print the response json to stdout, and the response code to stderr.
     def show(response)
-      puts JSON.pretty_generate response
+      puts json_generate(response)
 
       if response.respond_to? :code
         code = response.code.to_s
         color = code =~ /^2\d\d/ ? :txtgrn : :txtred
-        say! "!#{color}!Response Code: #{code}"
+        say "!#{color}!Response Code: #{code}"
       end
     end
+
+    def json_generate(object)
+      JSON.pretty_generate(JSON.parse object.to_s)
+    rescue
+      object.to_s
+    end
   end
 end

data/lib/load_runner/docopt.txt

@@ -58,15 +58,18 @@ Options:
     A short description of the status.
 
 Environment Variables:
-  GITHUB_SECRET_TOKEN=y0urAP1k3y
-    Set Your GitHub secret token.
+  GITHUB_SECRET_TOKEN=y0urk3y
+    Set Your GitHub secret token as set in your webhook.
+  
+  GITHUB_ACCESS_TOKEN=y0urAPIk3y
+    Set Your GitHub API token (needed only for status updates).
 
 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
+  loadrunner send localhost:3000/payload my_repo push master
+  loadrunner send localhost:3000/payload my_repo push branch=master
+  loadrunner send localhost:3000/payload my_repo push tag=staging
+  loadrunner send localhost:3000/payload my_repo push refs/tags/staging
 
   # Start the server
   loadrunner server

data/lib/load_runner/server.rb

@@ -15,7 +15,7 @@ module LoadRunner
 
       signature = request.env['HTTP_X_HUB_SIGNATURE']
       state = verify_signature payload_body, signature
-      
+
       halt 401, halt_messages[state] if state != :ok
 
       push = ActiveSupport::HashWithIndifferentAccess.new JSON.parse payload_body

data/lib/load_runner/server_base.rb

@@ -13,7 +13,9 @@ module LoadRunner
     set :server, :puma
 
     configure :development do
+      # :nocov: - this is not covered in CI, but is covered in dev
       register Sinatra::Reloader if defined? Sinatra::Reloader
+      # :nocov:
     end
 
     # Since we cannot use any config values in the main body of the class,

data/lib/load_runner/version.rb

@@ -1,3 +1,3 @@
 module LoadRunner
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/loadrunner.rb

@@ -11,3 +11,5 @@ require 'load_runner/server'
 require 'load_runner/client'
 
 require 'load_runner/command_line'
+
+require 'byebug' if ENV['BYEBUG']

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: loadrunner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: super_docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  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
@@ -150,20 +178,6 @@ dependencies:
     - - "~>"
       - !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'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -232,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: GitHub Webhook Server and Simulator