contentful-webhook-listener 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2be61a4cf62efe827b97bf7dbf43d8191e75df8
-  data.tar.gz: 16b18e95e56e0371971fc203e1f0002cf20559e7
+  metadata.gz: 24fa6b57b9a36276814cf1d78945c628e999b1e3
+  data.tar.gz: 5c2818ade815ce97b5ebc64f4ccd1ff7c95aec1d
 SHA512:
-  metadata.gz: 9d745232369334ff7f9688afddd3943954adeec048d7c7dc44c1fbf72bcb7c27f53716a1ad4a5bf6e83cf8e57f0cd102f939b2a4a357818f65395f84034b7596
-  data.tar.gz: b796a3748378a5dd8dadbe0502482a3c636841ef7f461042185b2bce9731a64badee7c5770be1c9e3d200c49dbdf1bab0cf61dea372d17c61570d4735a8daad1
+  metadata.gz: 32f2bc1c7f9353a9203cdce071cdb47f19d167ddc872d2aa15eca27b29b83920f8d00b0041276f76b8e1fe587dafeba03231fc086e2b86f8e03f8443527ed1d0
+  data.tar.gz: b29e84f6fe0049a1ce816ed9bd5e58f526231b0071f02671188fb01f876bd340a33be166965204eee8baa5887700b9ca6a7563df256b42a377db066cf43445b3

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
 ## Unreleased
+
+## v0.0.3
+### Fixed
+* Fixed require on `Server`
+
+## v0.0.2 [YANKED]
+### Changed
+* Refactored to comply with RuboCop
+
+## v0.0.1
 ### Added
 * Web Server
 * Base Controller Classes

data/lib/contentful/webhook/listener.rb

@@ -1,4 +1,4 @@
-require "contentful/webhook/listener/version"
-require "contentful/webhook/listener/server"
-require "contentful/webhook/listener/controllers"
-require "contentful/webhook/listener/support"
+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

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

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

@@ -1,12 +1,14 @@
-require "webrick"
+require 'webrick'
 
 module Contentful
   module Webhook
     module Listener
       module Controllers
+        # Abstract Base Controller
+        # Extend and redefine #perform to run a process in background
         class Base < WEBrick::HTTPServlet::AbstractServlet
           def respond(request, response)
-            response.body = ""
+            response.body = ''
             response.status = 200
 
             Thread.new do
@@ -18,8 +20,9 @@ module Contentful
           alias_method :do_POST, :respond
 
           protected
-          def perform(request, response)
-            raise "must implement"
+
+          def perform(_request, _response)
+            fail 'must implement'
           end
         end
       end

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

@@ -1,20 +1,23 @@
-require "thread"
+require 'thread'
 
 module Contentful
   module Webhook
     module Listener
       module Controllers
+        # Wait Controller
+        # Sleeps a determined amount of `:timeout` seconds on #perform
         class Wait < Base
-          attr_reader :timeout
+          attr_reader :webhook_timeout
 
           def initialize(server, wh_timeout, *options)
             super(server, options)
-            @timeout = wh_timeout
+            @webhook_timeout = wh_timeout
           end
 
           protected
-          def perform(request, response)
-            sleep(self.timeout)
+
+          def perform(_request, _response)
+            sleep(webhook_timeout)
           end
         end
       end

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

@@ -1,18 +1,28 @@
 require 'thread'
 require 'webrick'
 require 'stringio'
-require "contentful/webhook/listener/controllers/base"
+require 'contentful/webhook/listener/controllers'
 
 module Contentful
   module Webhook
     module Listener
+      # Server is the responsible for handling Webhook receiver endpoints
+      # Configuration defaults are:
+      #   - port: 5678
+      #   - address: '0.0.0.0'
+      #   - logger: Contentful::Webhook::Support::NullLogger.new
+      #   - endpoints: [{
+      #       endpoint: '/receive',
+      #       controller: Contentful::Webhook::Listener::Controllers::Wait,
+      #       timeout: 300
+      #     }]
       class Server
         DEFAULT_PORT = 5678
-        DEFAULT_ADDRESS = "0.0.0.0"
+        DEFAULT_ADDRESS = '0.0.0.0'
         DEFAULT_ENDPOINTS = [
           {
-            endpoint: "/receive",
-            controller: Contentful::Webhook::Listener::Controllers::Base,
+            endpoint: '/receive',
+            controller: Contentful::Webhook::Listener::Controllers::Wait,
             timeout: 300
           }
         ]
@@ -29,21 +39,52 @@ module Contentful
           @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)
+          @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:"
+
+          mount_endpoints
+
+          server.start
+        end
+
+        protected
+
+        def server
+          @server ||= WEBrick::HTTPServer.new(
+            Port: @port,
+            BindAddress: @address,
+            AccessLog: [],
+            Logger: @logger
+          )
+        end
+
+        def mount_endpoints
+          logger.info 'Available Endpoints:'
           @endpoints.each do |endpoint_config|
-            @server.mount endpoint_config[:endpoint], endpoint_config[:controller], endpoint_config[:timeout]
+            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]}"
+            log_endpoint_data(endpoint_config)
           end
+        end
+
+        def log_endpoint_data(endpoint_config)
+          endpoint_data = [
+            endpoint_config[:endpoint],
+            "Controller: #{endpoint_config[:controller].name}",
+            "Timeout: #{endpoint_config[:timeout]}"
+          ]
 
-          @server.start
+          logger.info "\t#{endpoint_data.join(' - ')}"
         end
       end
     end

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

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

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

@@ -2,8 +2,9 @@ module Contentful
   module Webhook
     module Listener
       module Support
+        # NullLogger will silence any call to the :logger instance
         class NullLogger
-          def write(body)
+          def write(_body)
             nil
           end
 

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

@@ -1,7 +1,8 @@
 module Contentful
   module Webhook
+    # Webhook Listener
     module Listener
-      VERSION = "0.0.1"
+      VERSION = '0.0.3'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentful-webhook-listener
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-10 00:00:00.000000000 Z
+date: 2015-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A Simple HTTP Webserver with pluggable behavior for listening to Contentful