omnihooks 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a903371f84e0b5f5115f1d1045e341c4de849a64
-  data.tar.gz: 42b89a3fe407b4e47cb814e5bf48ef2ef4255587
+SHA256:
+  metadata.gz: f8ed31eb8cc2700bd4478c12d3050c62e8a91e863c492078584b2840e1808dbd
+  data.tar.gz: eea3cd6d8f70ff68e20dfc1412c1fdeae0f4dea800b1be91217afc8b6771d82f
 SHA512:
-  metadata.gz: 107bf07dcd06cec7f7c9e2fba4745dcc16eed9f866dd54bb2d99970918217528e96d2df19826039cb31c0c8c92df13c05e3c9bd1bcfd57d5755c76b9f27c1f01
-  data.tar.gz: d555956919f628e9b81c3ec2bf04cc63a4adc51d573d2110caa71fac663010dfd56e9e6efa31f0222416381661b812f0d930230246553fa959bab2d8bfe6f4d6
+  metadata.gz: 4f6778e10925e79babec7b15ab045597573bce5161a694aeb36c90b6308286f60c74b3b19e349d58eb4215643abd390330fc291aa136d0c8608647a4cb26ada6
+  data.tar.gz: 0f0b40f402d57f36781723fb2450f4816064868ff127a35e4bb86e820ab919d7750a8954f830b1bd4f4c76fade776f5f47bf73b17b13dcf1c61cb80cda6c2e6a

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/lib/omnihooks/version.rb

@@ -1,3 +1,3 @@
 module OmniHooks
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omnihooks
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Karl Falconer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2020-04-22 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
@@ -144,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A generalized framework for multiple-provider webhooks subscriptions.