contentful-webhook-listener 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2be61a4cf62efe827b97bf7dbf43d8191e75df8
+  data.tar.gz: 16b18e95e56e0371971fc203e1f0002cf20559e7
+SHA512:
+  metadata.gz: 9d745232369334ff7f9688afddd3943954adeec048d7c7dc44c1fbf72bcb7c27f53716a1ad4a5bf6e83cf8e57f0cd102f939b2a4a357818f65395f84034b7596
+  data.tar.gz: b796a3748378a5dd8dadbe0502482a3c636841ef7f461042185b2bce9731a64badee7c5770be1c9e3d200c49dbdf1bab0cf61dea372d17c61570d4735a8daad1

data/.gitignore

@@ -0,0 +1,42 @@
+*.gem
+*.rbc
+.bundle
+/.config
+Gemfile.lock
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+
+env: TEST=true

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## Unreleased
+### Added
+* Web Server
+* Base Controller Classes

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/contentful/contentful-webhook-listener.rb/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake test`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake test`. If your specs fail, return to step 5.
+7. Add, commit, and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Contentful
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 David Litvak Bruno
+
+MIT License
+
+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,77 @@
+[![Build Status](https://travis-ci.org/contentful/contentful-webhook-listener.rb.svg)](https://travis-ci.org/contentful/contentful-webhook-listener.rb)
+
+# Contentful Webhook Listener
+
+A Simple HTTP Webserver with pluggable behavior for listening to API Webhooks
+
+## Contentful
+[Contentful](http://www.contentful.com) is a content management platform for web applications,
+mobile apps and connected devices. It allows you to create, edit & manage content in the cloud
+and publish it anywhere via powerful API. Contentful offers tools for managing editorial
+teams and enabling cooperation between organizations.
+
+## What does `contentful-webhook-listener` do?
+The aim of `contentful-webhook-listener` is to have developers setting up their Contentful
+Webhooks for triggering background jobs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'contentful-webhook-listener'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contentful-webhook-listener
+
+## Usage
+
+Require gem:
+
+```ruby
+require 'contentful/webhook/listener'
+```
+
+Create your own Controllers:
+
+```ruby
+class MyController < Contentful::Webhook::Listener::Controllers::Wait
+  def perform(request, response)
+    super(request, response)
+    "do your process..." # This will run on a brackground Thread
+  end
+end
+```
+
+Configure and start your Webhook Listener
+
+```ruby
+require 'logger'
+
+Contentful::Webhook::Listener::Server.start do |config|
+  config[:port] = 5678         # Optional
+  config[:address] = "0.0.0.0" # Optional
+  config[:logger] = Logger.new(STDOUT) # Optional, will use a NullLogger by default
+  config[:endpoints] = [
+    {
+      endpoint: "/receive",     # Where your server will listen
+      controller: MyController, # The controller that will process the endpoint
+      timeout: 15               # If using Wait, will wait `X` seconds before executing
+    }
+  ]
+end
+```
+
+You can add multiple endpoints, each with it's own Controller.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/contentful-webhook-listener/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

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task default: :install

data/contentful-webhook-listener.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contentful/webhook/listener/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contentful-webhook-listener"
+  spec.version       = Contentful::Webhook::Listener::VERSION
+  spec.authors       = ["Contentful GmbH (David Litvak Bruno)"]
+  spec.email         = ["david.litvak@contentful.com"]
+  spec.summary       = %q{A Simple HTTP Webserver with pluggable behavior for listening to Contentful API Webhooks}
+  spec.description   = %q{A Simple HTTP Webserver with pluggable behavior for listening to Contentful API Webhooks}
+  spec.homepage      = "https://github.com/contentful/contentful-webhook-listener.rb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/contentful/webhook/listener.rb

@@ -0,0 +1,4 @@
+require "contentful/webhook/listener/version"
+require "contentful/webhook/listener/server"
+require "contentful/webhook/listener/controllers"
+require "contentful/webhook/listener/support"

data/lib/contentful/webhook/listener/controllers.rb

@@ -0,0 +1,2 @@
+require "contentful/webhook/listener/controllers/base"
+require "contentful/webhook/listener/controllers/wait"

data/lib/contentful/webhook/listener/controllers/base.rb

@@ -0,0 +1,28 @@
+require "webrick"
+
+module Contentful
+  module Webhook
+    module Listener
+      module Controllers
+        class Base < WEBrick::HTTPServlet::AbstractServlet
+          def respond(request, response)
+            response.body = ""
+            response.status = 200
+
+            Thread.new do
+              perform(request, response)
+            end
+          end
+
+          alias_method :do_GET, :respond
+          alias_method :do_POST, :respond
+
+          protected
+          def perform(request, response)
+            raise "must implement"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contentful/webhook/listener/controllers/wait.rb

@@ -0,0 +1,23 @@
+require "thread"
+
+module Contentful
+  module Webhook
+    module Listener
+      module Controllers
+        class Wait < Base
+          attr_reader :timeout
+
+          def initialize(server, wh_timeout, *options)
+            super(server, options)
+            @timeout = wh_timeout
+          end
+
+          protected
+          def perform(request, response)
+            sleep(self.timeout)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/contentful/webhook/listener/server.rb

@@ -0,0 +1,51 @@
+require 'thread'
+require 'webrick'
+require 'stringio'
+require "contentful/webhook/listener/controllers/base"
+
+module Contentful
+  module Webhook
+    module Listener
+      class Server
+        DEFAULT_PORT = 5678
+        DEFAULT_ADDRESS = "0.0.0.0"
+        DEFAULT_ENDPOINTS = [
+          {
+            endpoint: "/receive",
+            controller: Contentful::Webhook::Listener::Controllers::Base,
+            timeout: 300
+          }
+        ]
+
+        def self.start(config = {})
+          yield config if block_given?
+
+          Thread.new { Server.new(config).start }
+        end
+
+        attr_reader :port, :address, :endpoints, :logger
+
+        def initialize(config = {})
+          @port = config.fetch(:port, DEFAULT_PORT)
+          @address = config.fetch(:address, DEFAULT_ADDRESS)
+          @endpoints = config.fetch(:endpoints, DEFAULT_ENDPOINTS)
+          @logger = config.fetch(:logger, Contentful::Webhook::Listener::Support::NullLogger.new)
+        end
+
+        def start
+          @server = WEBrick::HTTPServer.new(:Port => @port, :BindAddress => @address, :AccessLog => [], :Logger => @logger)
+
+          logger.info "Webhook server starting at: http://#{@address}:#{@port}"
+          logger.info "Available Endpoints:"
+          @endpoints.each do |endpoint_config|
+            @server.mount endpoint_config[:endpoint], endpoint_config[:controller], endpoint_config[:timeout]
+
+            logger.info "\t#{endpoint_config[:endpoint]} - Controller: #{endpoint_config[:controller].name} - Timeout: #{endpoint_config[:timeout]}"
+          end
+
+          @server.start
+        end
+      end
+    end
+  end
+end

data/lib/contentful/webhook/listener/support.rb

@@ -0,0 +1 @@
+require "contentful/webhook/listener/support/null_logger.rb"

data/lib/contentful/webhook/listener/support/null_logger.rb

@@ -0,0 +1,18 @@
+module Contentful
+  module Webhook
+    module Listener
+      module Support
+        class NullLogger
+          def write(body)
+            nil
+          end
+
+          alias_method :info, :write
+          alias_method :debug, :write
+          alias_method :warn, :write
+          alias_method :error, :write
+        end
+      end
+    end
+  end
+end

data/lib/contentful/webhook/listener/version.rb

@@ -0,0 +1,7 @@
+module Contentful
+  module Webhook
+    module Listener
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: contentful-webhook-listener
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Contentful GmbH (David Litvak Bruno)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: A Simple HTTP Webserver with pluggable behavior for listening to Contentful
+  API Webhooks
+email:
+- david.litvak@contentful.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- contentful-webhook-listener.gemspec
+- lib/contentful/webhook/listener.rb
+- lib/contentful/webhook/listener/controllers.rb
+- lib/contentful/webhook/listener/controllers/base.rb
+- lib/contentful/webhook/listener/controllers/wait.rb
+- lib/contentful/webhook/listener/server.rb
+- lib/contentful/webhook/listener/support.rb
+- lib/contentful/webhook/listener/support/null_logger.rb
+- lib/contentful/webhook/listener/version.rb
+homepage: https://github.com/contentful/contentful-webhook-listener.rb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Simple HTTP Webserver with pluggable behavior for listening to Contentful
+  API Webhooks
+test_files: []