contentful-webhook-listener 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 382b718018bfcb1215a64a6aeb222c7d54bf9417
-  data.tar.gz: ed7e2df879c2878252b5fb56722bbc69408fba49
+  metadata.gz: c8b4a6280628a73f9bbd6ca719228b5cbcbc7398
+  data.tar.gz: 92e8e9344d9f42c84ebea75180744f94d21fede4
 SHA512:
-  metadata.gz: e5eccc8b497c478a1ee20e18abd252bca1b603b5e694357fe9008cad6ccc76d1043a1bba52166a4b453170ff85ff1109e14f819dcb2ff64800639eff64e77302
-  data.tar.gz: 29ef8f044881f404f0c1cdc870a9c600be03b5095798f93005a50265001641c6917fc2be0ef18d3b269ec75d66192763137194171c1c1a463eeb504df3c0b590
+  metadata.gz: 7e7b67146a95642319490f8664f56828063ed9d7bf79ba92977fbeec9784f86c4d1496aa07134d08332d0dc5fa6bf6192047704387f68bb65bb05fb6b4dc12bf
+  data.tar.gz: b659e728a75d5ca1f2addf41796f7da3e68c5be2e2fc920cb0cbfd8446833afd58c3d57836dd6a8837f86771b8c1ca69176f3f9b5a9cd84738ec0345909e6893

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## v0.1.0
+### Added
+* Full Spec Coverage
+
+### Changed
+* Small refactor on Server
+
 ## v0.0.4
 ### Added
 * `logger` now available from Controllers

data/Rakefile

@@ -1,3 +1,11 @@
 require "bundler/gem_tasks"
 
-task default: :install
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = '--format documentation --color'
+  end
+  task default: :spec
+rescue LoadError
+end
+

data/contentful-webhook-listener.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

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

@@ -34,7 +34,7 @@ module Contentful
           Thread.new { Server.new(config).start }
         end
 
-        attr_reader :port, :address, :endpoints, :logger
+        attr_reader :port, :address, :endpoints, :logger, :server
 
         def initialize(config = {})
           @port = config.fetch(:port, DEFAULT_PORT)
@@ -49,15 +49,16 @@ module Contentful
         def start
           logger.info "Webhook server starting at: http://#{@address}:#{@port}"
 
+          @server = create_server
           mount_endpoints
 
-          server.start
+          @server.start
         end
 
         protected
 
-        def server
-          @server ||= WEBrick::HTTPServer.new(
+        def create_server
+          WEBrick::HTTPServer.new(
             Port: @port,
             BindAddress: @address,
             AccessLog: [],
@@ -68,7 +69,7 @@ module Contentful
         def mount_endpoints
           logger.info 'Available Endpoints:'
           @endpoints.each do |endpoint_config|
-            server.mount(
+            @server.mount(
               endpoint_config[:endpoint],
               endpoint_config[:controller],
               @logger,

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

@@ -2,7 +2,7 @@ module Contentful
   module Webhook
     # Webhook Listener
     module Listener
-      VERSION = '0.0.4'
+      VERSION = '0.1.0'
     end
   end
 end

data/spec/contentful/webhook/listener/controllers/base_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Contentful::Webhook::Listener::Controllers::Base do
+  let(:server) { MockServer.new }
+  let(:logger) { Contentful::Webhook::Listener::Support::NullLogger.new }
+  let(:base) { Contentful::Webhook::Listener::Controllers::Base.new server, logger }
+
+  describe "instance methods" do
+    [:do_GET, :do_POST, :respond].each do |name|
+      it "##{name} spawn a background job" do
+        expect(Thread).to receive(:new)
+
+        base.send(name, MockRequest.new, MockResponse.new)
+      end
+    end
+  end
+end

data/spec/contentful/webhook/listener/controllers/wait_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+class Contentful::Webhook::Listener::Controllers::Wait
+  @@sleeping = false
+
+  def sleep(time)
+    @@sleeping = true
+  end
+
+  def self.sleeping
+    value = @@sleeping
+    @@sleeping = false
+    value
+  end
+end
+
+describe Contentful::Webhook::Listener::Controllers::Wait do
+  let(:server) { MockServer.new }
+  let(:logger) { Contentful::Webhook::Listener::Support::NullLogger.new }
+  let(:timeout) { 10 }
+  let(:wait) { Contentful::Webhook::Listener::Controllers::Wait.new server, logger, timeout }
+
+  describe "instance methods" do
+    [:do_GET, :do_POST, :respond].each do |name|
+      it "##{name} spawn a background job" do
+        expect(Thread).to receive(:new)
+
+        wait.send(name, MockRequest.new, MockResponse.new)
+      end
+
+      # This spec requires to read/erase a Class Variable
+      # because RSpec doesn't know how to test within spawned Threads
+      it "##{name} wait on background" do
+        wait.send(name, MockRequest.new, MockResponse.new)
+
+        sleep(0.1) # Wait for Thread to actually run
+
+        expect(wait.class.sleeping).to be_truthy
+      end
+    end
+  end
+end

data/spec/contentful/webhook/listener/server_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Contentful::Webhook::Listener::Server do
+  let(:server) { Contentful::Webhook::Listener::Server.new }
+
+  describe 'class methods' do
+    describe '::start' do
+      it 'spawns a brackground thread' do
+        expect(Thread).to receive(:new)
+
+        Contentful::Webhook::Listener::Server.start
+      end
+    end
+  end
+
+  describe 'instance methods' do
+    describe "#start" do
+      before do
+        expect_any_instance_of(WEBrick::HTTPServer).to receive(:start)
+        expect(WEBrick::Utils).to receive(:create_listeners) { [] } # Mock TCP Port binding
+      end
+
+      it "logs server messages" do
+        expect(server.logger).to receive(:info).once.ordered.with("Webhook server starting at: http://#{server.address}:#{server.port}")
+        expect(server.logger).to receive(:info).once.ordered.with("Available Endpoints:")
+        expect(server.logger).to receive(:info).once.ordered.with("\t/receive - Controller: Contentful::Webhook::Listener::Controllers::Wait - Timeout: 300")
+
+        server.start
+      end
+
+      it "mounts endpoints" do
+        expect_any_instance_of(WEBrick::HTTPServer).to receive(:mount).with(
+          "/receive",
+          Contentful::Webhook::Listener::Controllers::Wait,
+          Contentful::Webhook::Listener::Support::NullLogger,
+          300
+        )
+
+        server.start
+      end
+    end
+  end
+
+  describe "defaults" do
+    it ":port" do
+      expect(server.port).to eq 5678
+    end
+
+    it ":address" do
+      expect(server.address).to eq "0.0.0.0"
+    end
+
+    it ":endpoints" do
+      expected = [
+        {
+          endpoint: '/receive',
+          controller: Contentful::Webhook::Listener::Controllers::Wait,
+          timeout: 300
+        }
+      ]
+
+      expect(server.endpoints).to match_array expected
+    end
+
+    it ":logger" do
+      expect(server.logger).to be_a Contentful::Webhook::Listener::Support::NullLogger
+    end
+  end
+end

data/spec/contentful/webhook/listener/support/null_logger_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Contentful::Webhook::Listener::Support::NullLogger do
+  let(:logger) { Contentful::Webhook::Listener::Support::NullLogger.new }
+
+  describe "instance methods" do
+    [:info, :debug, :warn, :error, :write].each do |name|
+      it "##{name} returns nil" do
+        expect(logger.send(name, "foo")).to eq nil
+      end
+
+      it "##{name} doesn't output to STDOUT" do
+        expect { logger.send(name, "foo") }.to_not output("foo").to_stdout
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('lib', __FILE__)
+
+require 'contentful/webhook/listener'
+require 'rspec'
+require 'rspec/mocks'
+
+class MockServer
+  def [](key)
+    nil
+  end
+end
+
+class MockRequest
+end
+
+class MockResponse
+  attr_accessor :status, :body
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful-webhook-listener
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno)
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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:
@@ -64,6 +78,11 @@ files:
 - lib/contentful/webhook/listener/support.rb
 - lib/contentful/webhook/listener/support/null_logger.rb
 - lib/contentful/webhook/listener/version.rb
+- spec/contentful/webhook/listener/controllers/base_spec.rb
+- spec/contentful/webhook/listener/controllers/wait_spec.rb
+- spec/contentful/webhook/listener/server_spec.rb
+- spec/contentful/webhook/listener/support/null_logger_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/contentful/contentful-webhook-listener.rb
 licenses:
 - MIT
@@ -89,4 +108,9 @@ signing_key:
 specification_version: 4
 summary: A Simple HTTP Webserver with pluggable behavior for listening to Contentful
   API Webhooks
-test_files: []
+test_files:
+- spec/contentful/webhook/listener/controllers/base_spec.rb
+- spec/contentful/webhook/listener/controllers/wait_spec.rb
+- spec/contentful/webhook/listener/server_spec.rb
+- spec/contentful/webhook/listener/support/null_logger_spec.rb
+- spec/spec_helper.rb