omnihooks 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06339853f7ece3c68f11ba4915da17e824ccb27d
-  data.tar.gz: 2f4d22b89574c3415920c62daed2fb54c432e213
+SHA256:
+  metadata.gz: 1f133f4e912d2bd925d5827a580c67b2971ec8698ef02105a3905f55638f3c17
+  data.tar.gz: dc3c1d619c4bdf260ae499928cacafea8b24dd06175114595b8c74c38dffe813
 SHA512:
-  metadata.gz: 52b3d2514746e528b4cf60b2adfa88fe2dc511b1c03eac56c15abfa224b19c88fe822daa024005d65cf020805ab3df569937413319ffb825559948bba285ac22
-  data.tar.gz: c51daa43fbc940543974b40c4d1568c4f62c7be1ab42ef0daa1c1201dfc8cc8e14dabdc3c242d1a1de3c66b53bd533bbbee9c970721768f20d2eae17ac602b62
+  metadata.gz: e748a268c94fa4a47fe0cf0b5287c84e63db249f6fef152924f60dc9f1671670840f4b91c5b09076d7fe9f0fbe76cfe283a39e21e8fc2ead865c924c6ac59fbf
+  data.tar.gz: 200e5903fa90f7af8f041a81a8e292ba7bac8818dd60d698ea7aa4f2f1e60b9e10a15b4ff1357b5325ebfbabc8dd08ce33f6ad1b779e8ef62a8bc19a87f160c8

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 /spec/examples.txt
+*.sublime-*

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.6
+ruby-2.4.5

data/README.md

@@ -1,31 +1,52 @@
-# OmniHooks
+# OmniHooks: Standardized Multi-Provider Webhooks 
 
-TODO: Write a gem description
+## Introduction
 
-## Installation
+OmniHooks is a library that standardizes multi-provider webhooks for web applications. It was created to be powerful, flexible, and do as little as possible. Any developer can create strategies for OmniHooks that can handle webhooks via disparate systems.
 
-Add this line to your application's Gemfile:
+In order to use OmniHooks in your applications, you will need to leverage one or more strategies. These strategies are generally released individually as RubyGems, and you can see a [community maintained list](https://github.com/dropstream/omnihooks/wiki/List-of-Strategies) on the wiki for this project.
 
-```ruby
-gem 'omnihooks'
-```
+## Getting Started
 
-And then execute:
+Each OmniHook strategy is a Rack Middleware. That means that you can use it the same way that you use any other Rack middleware. For example, to use the built-in Developer strategy in a Sinatra application I might do this:
 
-    $ bundle
+````ruby
+require 'sinatra'
+require 'omnihooks'
 
-Or install it yourself as:
+class MyApplication < Sinatra::Base
+  use Rack::Session::Cookie
+  use OmniHooks::Strategies::Developer
+end
+````
 
-    $ gem install omnihooks
+Because OmniHooks is built for multi-provider webhooks, I may want to leave room to run multiple strategies. For this, the built-in OmniHooks::Builder class gives you an easy way to specify multiple strategies.
 
-## Usage
+````ruby
+require 'sinatra'
+require 'omnihooks'
 
-TODO: Write usage instructions here
+class MyApplication < Sinatra::Base
+  use Rack::Session::Cookie
+	use OmniHooks::Builder do
+		provider :developer do |p|
+			p.configure do |c|
+				c.subscribe 'foo', Proc.new { |event| nil }
+			end
+		end
+	  provider :core_warehouse do |p|
+	  	p.configure do |c|
+	  	  c.subscribe 'Shipment', Proc.new { |event| nil }
+	  	end
+	  end
+	end
+end
+````
 
-## Contributing
+## Logging 
 
-1. Fork it ( https://github.com/[my-github-username]/omnihooks/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+OmniHooks supports a configurable logger. By default, OmniHooks will log to STDOUT but you can configure this using `OmniHooks.config.logger`:
+
+## Resources
+
+The [OmniHooks Wiki](https://github.com/dropstream/omnihooks/wiki) has actively maintained in-depth documentation for OmniHooks. It should be your first stop if you are wondering about a more in-depth look at OmniHooks, how it works, and how to use it.

data/Rakefile

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

data/lib/omnihooks/builder.rb

@@ -3,19 +3,18 @@ require "active_support/inflector"
 module OmniHooks
   class Builder < ::Rack::Builder
 
-    def initialize(app, &block)
+    def initialize(app = nil, &block)
       @options = nil
       if rack14?
         super
       else
         @app = app
-        super(&block)
-        @ins << @app
+        super(app, &block)
       end
     end
 
     def rack14?
-      Rack.release.split('.')[1].to_i >= 4
+      Rack.release.split('.')[0].to_i == 1 && Rack.release.split('.')[1].to_i >= 4
     end
 
     def on_failure(&block)

data/lib/omnihooks/strategy.rb

@@ -221,7 +221,6 @@ module OmniHooks
     # @param env [Hash] The Rack environment.
     def call!(env) # rubocop:disable CyclomaticComplexity, PerceivedComplexity
       @env = env
-
       return instrument if on_request_path? && OmniHooks.config.allowed_request_methods.include?(request.request_method.downcase.to_sym)
 
       @app.call(env)
@@ -253,13 +252,16 @@ module OmniHooks
       begin
         evt = get_event
         evt_type = get_event_type
+
         self.class.instrument(evt_type, evt) if evt
-      rescue => e
+      rescue Exception => e
         log(:error, e.message)
-        [500, {}, [nil]]
+        log(:error, e.backtrace.join("\n"))
+        [500, {}, [EMPTY_STRING]]
       else
+        log(:debug, "success")
         # Send a 200 response back to
-        [200, {}, [nil]]
+        [200, {}, [EMPTY_STRING]]
       end
     end
 

data/lib/omnihooks/version.rb

@@ -1,3 +1,3 @@
 module OmniHooks
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/omnihooks.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 3.1"
-  spec.add_dependency 'rack', '~> 1.0'
+  spec.add_dependency 'rack', ">= 1.2", "< 3"
   spec.add_dependency 'hashie', ['>= 1.2', '< 4']
   
   spec.add_development_dependency "bundler", "~> 1.7"

data/spec/omnihooks/strategy_spec.rb

@@ -203,7 +203,7 @@ RSpec.describe OmniHooks::Strategy do
 
         expect(ActiveSupport::Notifications).to receive(:instrument).with('class.bar', 'Foo')
 
-        expect(instance.call(make_env('/hooks/class'))).to eq([200, {}, [nil]])
+        expect(instance.call(make_env('/hooks/class'))).to eq([200, {}, ['']])
       end
 
       context 'with exception in event callback' do
@@ -222,7 +222,7 @@ RSpec.describe OmniHooks::Strategy do
         
         it 'should return a non 200 response' do
           instance = klass.new(app)
-          expect(instance.call(make_env('/hooks/class'))).to eq([500, {}, [nil]])
+          expect(instance.call(make_env('/hooks/class'))).to eq([500, {}, ['']])
         end
       end
     end
@@ -242,7 +242,7 @@ RSpec.describe OmniHooks::Strategy do
         it 'should return a success response' do
           expect(subscriber).to receive(:call).with('Foo')
 
-          expect(strategy.call(make_env('/hooks/test', {'rack.input' => StringIO.new('type=foo.bar&payload=test')}))).to eq([200, {}, [nil]])
+          expect(strategy.call(make_env('/hooks/test', {'rack.input' => StringIO.new('type=foo.bar&payload=test')}))).to eq([200, {}, ['']])
         end
       end
 
@@ -250,7 +250,7 @@ RSpec.describe OmniHooks::Strategy do
         it 'should return a success response' do
           expect(subscriber).not_to receive(:call)
 
-          expect(strategy.call(make_env('/hooks/test', {'rack.input' => StringIO.new('type=foo.sam&payload=test')}))).to eq([200, {}, [nil]])
+          expect(strategy.call(make_env('/hooks/test', {'rack.input' => StringIO.new('type=foo.sam&payload=test')}))).to eq([200, {}, ['']])
         end
       end
 
@@ -260,7 +260,7 @@ RSpec.describe OmniHooks::Strategy do
         end
 
         it 'should return an error response' do
-          expect(strategy.call(make_env('/hooks/test', {'rack.input' => StringIO.new('type=foo.bar&payload=test')}))).to eq([500, {}, [nil]])
+          expect(strategy.call(make_env('/hooks/test', {'rack.input' => StringIO.new('type=foo.bar&payload=test')}))).to eq([500, {}, ['']])
         end
       end
 
@@ -285,7 +285,7 @@ RSpec.describe OmniHooks::Strategy do
       end
 
       it 'allows a request method of the correct type' do
-        expect(strategy.call(make_env('/hooks/test', 'REQUEST_METHOD' => 'PUT'))).to eq([200, {}, [nil]])
+        expect(strategy.call(make_env('/hooks/test', 'REQUEST_METHOD' => 'PUT'))).to eq([200, {}, ['']])
       end
 
       after do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omnihooks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Karl Falconer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,16 +28,22 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +106,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
-description: 
+description:
 email:
 - karl.falconer@falconerdevelopment.com
 executables: []
@@ -129,7 +135,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,9 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: A generalized framework for multiple-provider webhooks subscriptions.
 test_files: