webhook_recorder 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b28c08371915ba53f2690fd7265983c59845cbb8
+  data.tar.gz: d16f369b1cdbb9ee00e2aa6c258754ac90f90754
+SHA512:
+  metadata.gz: 37db9108e7916a5b22267517a89e349c1c7727790cd99c8d65e9cb9ce3a50bb3e0b4f847023983dd26f9235fcc14f3a2071f66895f0e47f54165739b24e62276
+  data.tar.gz: 69d7024537cbccc2dfb778c71e77addeb3b2807d8c47543032184a473022c20efad9fa90b77d6958785d91163d9e0d1a1f97ac388889c2caecac0c93f3af75f4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in webhook_recorder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Senthil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# WebhookRecorder
+
+When you build a feature that makes calls to webhooks of subscribers, this library helps to test that behaviour.
+
+This runs a simple WEBrick server, makes it accessible via [ngrok](https://ngrok.com) and records the results. You can assert on the recorded requests to ensure the code you built made calls to registered webhooks.
+
+[![CircleCI](https://circleci.com/gh/siliconsenthil/webhook_recorder/tree/master.svg?style=svg)](https://circleci.com/gh/siliconsenthil/webhook_recorder/tree/master)
+
+Read the intro blog post [here](http://siliconsenthil.in/blog/2017/04/02/so-you-built-webhooks-and-wanna-test/).
+
+## Dependency
+
+This uses [ngrok](https://ngrok.com) to publish URL that's accessible via internet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webhook_recorder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webhook_recorder
+
+## Usage
+
+* If you have ngrok account, set env. var `NGROK_AUTH_TOKEN` before running
+
+```ruby
+it 'should respond as defined as response_config' do
+  response_config = { '/hello' => { code: 200, body: 'Expected result' } }
+  WebhookRecorder::Server.open(@port, response_config) do |server|
+    #These URLs are accessible from internet
+    p server.http_url
+    p server.https_url
+
+    # Register the webhook with any of the above URLs
+    # Make call to the code that invokes webhooks
+    # For e.g. if it made call to /hello with query params as q=1 and JSON body as {some: 1, other: 2}, you can assert like below.
+
+    req1 = server.recorded_reqs.first
+    expect(req1[:request_path]).to eq('/hello')
+    expect(req1[:query_string]).to include('q=1')
+    expect(JSON.parse(req1[:request_body]).symbolize_keys).to eq({some: 1, other: 2})
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/siliconsenthil]/webhook_recorder.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "webhook_recorder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,9 @@
+checkout:
+  pre:
+    - wget https://bin.equinox.io/c/4VmDzA7iaHb/ngrok-stable-linux-amd64.zip
+    - unzip ngrok-stable-linux-amd64.zip
+    - mv ngrok $HOME/bin
+
+dependencies:
+  pre:
+    - gem install bundler -v 1.14.6

data/lib/webhook_recorder.rb

@@ -0,0 +1,6 @@
+require "webhook_recorder/version"
+require "webhook_recorder/server"
+
+module WebhookRecorder
+  # Your code goes here...
+end

data/lib/webhook_recorder/server.rb

@@ -0,0 +1,67 @@
+require 'webhook_recorder/version'
+require 'rack'
+require 'webrick'
+require 'ngrok/tunnel'
+require 'active_support/core_ext/hash'
+
+module WebhookRecorder
+  class Server
+    attr_accessor :recorded_reqs, :http_url, :https_url, :response_config, :port, :log_verbose
+
+    def initialize(port, response_config, log_verbose = false)
+      self.port = port
+      self.response_config = response_config
+      self.recorded_reqs = []
+      self.log_verbose = log_verbose
+      @started = false
+    end
+
+    def self.open(port, response_config, log_verbose=false)
+      server = new(port, response_config, log_verbose)
+      server.start
+      server.wait
+      Ngrok::Tunnel.start(port: port, authtoken: ENV['NGROK_AUTH_TOKEN'])
+      server.http_url = Ngrok::Tunnel.ngrok_url
+      server.https_url = Ngrok::Tunnel.ngrok_url_https
+      yield server
+    ensure
+      server.recorded_reqs.clear
+      server.stop
+      Ngrok::Tunnel.stop
+    end
+
+    def start
+      Thread.new do
+        options = {
+          Port: @port,
+          Logger: WEBrick::Log.new(self.log_verbose ? STDOUT : "/dev/null"),
+          AccessLog: [],
+          DoNotReverseLookup: true,
+          StartCallback: -> { @started = true }
+        }
+        Rack::Handler::WEBrick.run(self, options) { |s| @server = s }
+      end
+    end
+
+    def wait
+      Timeout.timeout(10) { sleep 0.1 until @started }
+    end
+
+    def call(env)
+      path = env['PATH_INFO']
+      request = Rack::Request.new(env)
+      recorded_reqs << env.merge(request_body: request.body.string).deep_transform_keys(&:downcase).with_indifferent_access
+      if response_config[path]
+        res = response_config[path]
+        [res[:code], res[:headers] || {}, [res[:body] || "Missing body in response_config"]]
+      else
+        warn "WebhookRecorder::Server: Missing response_config for path #{path}"
+        [404, {}, ["WebhookRecorder::Server: Missing response_config for path #{path}"]]
+      end
+    end
+
+    def stop
+      @server.shutdown if @server
+    end
+  end
+end

data/lib/webhook_recorder/version.rb

@@ -0,0 +1,3 @@
+module WebhookRecorder
+  VERSION = "0.1.1"
+end

data/webhook_recorder.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webhook_recorder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'webhook_recorder'
+  spec.version       = WebhookRecorder::VERSION
+  spec.authors       = ['Senthil V S']
+  spec.email         = ['vss123@gmail.com']
+
+  spec.summary       = 'Simple HTTP server helps to test behaviour that calls webhooks'
+  spec.description   = 'It runs a HTTP server, exposes in internet via ngrok, and records the requests'
+  spec.homepage      = 'https://github.com/siliconsenthil/webhook_recorder'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  # spec.bindir        = 'exe'
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '~>5.0.2'
+  spec.add_runtime_dependency 'webrick', '~>1.3.1'
+  spec.add_runtime_dependency 'ngrok-tunnel', '~>2.1.0'
+  spec.add_runtime_dependency 'rack', '~>2.0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rest-client', '~> 2.0.1'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: webhook_recorder
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Senthil V S
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: ngrok-tunnel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: It runs a HTTP server, exposes in internet via ngrok, and records the
+  requests
+email:
+- vss123@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/webhook_recorder.rb
+- lib/webhook_recorder/server.rb
+- lib/webhook_recorder/version.rb
+- webhook_recorder.gemspec
+homepage: https://github.com/siliconsenthil/webhook_recorder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Simple HTTP server helps to test behaviour that calls webhooks
+test_files: []