webhook_handler 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac325d09df2af3cb4a38aac89d747a2d9044eeb7
-  data.tar.gz: abfc52014ac55628ab27ade5318b9ee1efa79ea2
+  metadata.gz: acc1eb247b5f94b23259728fc1eee27ecfaf2f86
+  data.tar.gz: 82da8ac47464e6651a407dc106c7d13eb688a452
 SHA512:
-  metadata.gz: 0149f03dcbdcce0428b46e77fe2e96dc9b5016ccc22754e167dd44dcac352c11a3c22ed8209ac0b76b962a37d98a1281b2bccee66141ec772278e9a2337fcbfc
-  data.tar.gz: 13195bb1a675c25d2e199e9f05fac3546f3f16454f08967883de0171bf990c6041e159a2089a6463ba2d8c13e93e4ac3b58aec411f0f2fc2e3e0205fc282ba4a
+  metadata.gz: 25b9fb6b1dd76fc50fd1565bffbe3940de858a7c84716a2459869d2b93fb62f81712226b04f512558040b7c0b51e85207e9fba5dd42c82e7d72f9dd8758a7c35
+  data.tar.gz: 0dd20c18c026a181139ae072db4a69c2f6051020e66521a8b0af8cd4d574803d49400b8a8ef9debd330022f6d17bda670987ff52b77517cdcdabe1fecc36bfe3

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.4.0] - 2015-11-26
+
+### Changed
+
+- Removed the dependency on Sinatra, it now operates as a simple Rack app.
+
 ## [0.3.1] - 2015-11-26
 
 ### Fixed
@@ -28,3 +34,4 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 [0.2.0]: https://github.com/chrismytton/webhook_handler/compare/v0.1.0...v0.2.0
 [0.3.0]: https://github.com/chrismytton/webhook_handler/compare/v0.2.0...v0.3.0
 [0.3.1]: https://github.com/chrismytton/webhook_handler/compare/v0.3.0...v0.3.1
+[0.3.1]: https://github.com/chrismytton/webhook_handler/compare/v0.3.1...v0.4.0

data/README.md

@@ -1,6 +1,6 @@
 # WebhookHandler [![Build Status](https://travis-ci.org/chrismytton/webhook_handler.svg?branch=master)](https://travis-ci.org/chrismytton/webhook_handler)
 
-Combines Sinatra and Sidekiq into a neat package that makes creating simple apps that respond to webhooks a pleasure.
+Combines Rack and Sidekiq into a neat package that makes creating simple apps that respond to webhooks a pleasure.
 
 ## Installation
 
@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-Define a class and include the `WebhookHandler` module. This class then acts as a Sidekiq worker and a Sinatra app.
+Define a class and include the `WebhookHandler` module. This class then acts as a Sidekiq worker and a Rack app.
 
 **app.rb**
 
@@ -44,20 +44,22 @@ require_relative './app'
 run MyApp
 ```
 
-### Sinatra compatibility
-
-You can also declare other routes in the class:
+If you want to pass some arguments from the request into the background job you can define a `handle_webhook` method.
 
 ```ruby
 class MyApp
   include WebhookHandler
 
-  def perform
-    # ...
+  def handle_webhook
+    request.body.rewind
+    payload = JSON.parse(request.body.read)
+    self.class.perform_async(payload['message'])
   end
 
-  get '/status' do
-    "I'm a regular Sinatra route!"
+  def perform(message)
+    puts "Got a message: #{message}"
+    # Do some long running task...
+    sleep 2
   end
 end
 ```

data/example/app.rb

@@ -2,12 +2,22 @@ lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'webhook_handler'
+require 'json'
+
+# Trigger this with:
+# curl -X POST http://localhost:5000 -d '{"message": "bar"}'
 
 class MyApp
   include WebhookHandler
 
-  def perform
-    puts "Working hard!"
+  def handle_webhook
+    request.body.rewind
+    payload = JSON.parse(request.body.read)
+    self.class.perform_async(payload['message'])
+  end
+
+  def perform(message)
+    puts "Working hard! Message: #{message}"
     sleep 5
   end
 end

data/lib/webhook_handler.rb

@@ -1,25 +1,40 @@
 require 'webhook_handler/version'
 require 'sidekiq'
-require 'sinatra'
+require 'rack'
 
 module WebhookHandler
+  attr_reader :request
+  attr_reader :response
+
   def self.included(klass)
-    klass.extend self
+    klass.extend ClassMethods
     klass.send(:include, Sidekiq::Worker)
-    klass.extend Sinatra::Delegator
-    klass.instance_eval do
-      get '/' do
-        'Send a POST request to this URL to trigger the webhook'
-      end
+  end
+
+  module ClassMethods
+    def call(env)
+      new.call(env)
+    end
+  end
 
-      post '/' do
-        klass.perform_async
-        'ok'
+  def call(env)
+    @request = Rack::Request.new(env)
+    @response = Rack::Response.new
+
+    if request.get?
+      response.write('Send a POST request to this URL to trigger the webhook')
+    elsif request.post?
+      if respond_to?(:handle_webhook)
+        send(:handle_webhook)
+      else
+        _handle_webhook
       end
     end
+
+    response.finish
   end
 
-  def call(*args)
-    Sinatra::Application.call(*args)
+  def _handle_webhook
+    response.write(self.class.perform_async)
   end
 end

data/lib/webhook_handler/cli.rb

@@ -5,7 +5,7 @@ require 'webhook_handler/version'
 module WebhookHandler
   class CLI < Thor
     include Thor::Actions
-    desc "new NAME", "create a new app called NAME"
+    desc 'new NAME', 'create a new app called NAME'
 
     def self.source_root
       File.dirname(__FILE__)
@@ -13,7 +13,7 @@ module WebhookHandler
 
     def new(name)
       # @see http://git.io/vBqrp
-      @constant_name = name.tr('-', '_').gsub(/-[_-]*(?![_-]|$)/) { "::" }.gsub(/([_-]+|(::)|^)(.|$)/) { $2.to_s + $3.upcase }
+      @constant_name = name.tr('-', '_').gsub(/-[_-]*(?![_-]|$)/) { '::' }.gsub(/([_-]+|(::)|^)(.|$)/) { Regexp.last_match(2).to_s + Regexp.last_match(3).upcase }
 
       FileUtils.mkdir_p(name)
       puts "Creating app '#{name}'..."

data/lib/webhook_handler/version.rb

@@ -1,3 +1,3 @@
 module WebhookHandler
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/webhook_handler.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'sidekiq', ['>= 3', '< 5']
-  spec.add_dependency 'sinatra', ['>= 1', '< 2']
+  spec.add_dependency 'rack', ['>= 1', '< 2']
   spec.add_dependency 'thor'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'foreman'
   spec.add_development_dependency 'puma'
+  spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webhook_handler
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Mytton
@@ -31,7 +31,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -162,6 +162,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - chrismytton@gmail.com