http_server_manager 0.4.15 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5011647dc9079d4adf4434fe258eb22dc09a1f8
-  data.tar.gz: bd3f09b9bda5aceec005f178593b4ded5c2a99fa
+  metadata.gz: 974266fa991dd57590789d1eb1483a547205f78f
+  data.tar.gz: 136048206eed989d2b137ac240d1ea151173715f
 SHA512:
-  metadata.gz: 4a162a60b0d7c021ad8965f1098ac16673bd426ae363a4c9daa4aad4f9fcf6abdf0ed4ab9a9f3a88a91bd88aaac657e6bb0daae165e73252d2afdb66786a262d
-  data.tar.gz: da06c1fec452d2cb16262266d8d51d22094f10a9111588176eecdea14aa150616d8a5c010b3c7e950af47edc583a79fe3332716e60ff3a18da7133f8a440332b
+  metadata.gz: ed6a746de7595d9a113c9deb7ca70a1fb8657486ea3deca4383b9eabeda944186d47b2e5ed81714033c4463cc6f070b6b6ee4c51c1004b9fa6cc5c9e172a1119
+  data.tar.gz: aed4499162511bf7f7fea4a711a6c03eafa575c6220c220c3e461e341cc3d06566ff26a60af82d6d30694fe606628e48f44a76813dfd916b9a9589513d44f0a6

data/lib/http_server_manager/server.rb

@@ -8,6 +8,7 @@ module HttpServerManager
       @name                = options[:name]
       @host                = options[:host]
       @port                = options[:port]
+      @ping_uri            = options[:ping_uri] || "/"
       @timeout_in_seconds  = options[:timeout_in_seconds] || (ENV["timeout"] ? ENV["timeout"].to_i : 20)
       @deletable_artifacts = [ pid_file_path ]
     end
@@ -56,7 +57,7 @@ module HttpServerManager
     def running?
       !!(Net::HTTP.new(@host, @port).start do |http|
         http.open_timeout = http.read_timeout = @timeout_in_seconds
-        http.request_get("/")
+        http.request_get(@ping_uri)
       end)
     rescue
       false

data/lib/http_server_manager/version.rb

@@ -1,3 +1,3 @@
 module HttpServerManager
-  VERSION = "0.4.15".freeze
+  VERSION = "0.5.0".freeze
 end

data/spec/lib/http_server_manager/rake/server_tasks_spec.rb

@@ -3,24 +3,24 @@ describe HttpServerManager::Rake::ServerTasks do
   include ::Rake::DSL
 
   let(:task_namespace) { :test_server_namespace }
-  let(:task_scope) { double("TaskScope", path: task_namespace) }
-  let(:server) { double(HttpServerManager::Server, name: "test_server") }
+  let(:task_scope)     { double("TaskScope", path: task_namespace) }
+  let(:server)         { instance_double(HttpServerManager::Server, name: "test_server") }
 
-  let(:server_tasks) { HttpServerManager::Rake::ServerTasks.new(server) }
+  let(:server_tasks) { described_class.new(server) }
 
-  before(:each) do
+  before(:example) do
     namespace task_namespace do
       server_tasks
     end
   end
 
-  after(:each) { Rake.application.tasks_in_scope(task_scope).each(&:clear) }
+  after(:example) { Rake.application.tasks_in_scope(task_scope).each(&:clear) }
 
   describe "start task" do
 
     let(:task) { ::Rake::Task["#{task_namespace}:start"] }
 
-    it "should start the server" do
+    it "starts the server" do
       expect(server).to receive(:start!)
 
       task.execute
@@ -32,7 +32,7 @@ describe HttpServerManager::Rake::ServerTasks do
 
     let(:task) { ::Rake::Task["#{task_namespace}:stop"] }
 
-    it "should stop the server" do
+    it "stops the server" do
       expect(server).to receive(:stop!)
 
       task.execute
@@ -44,7 +44,7 @@ describe HttpServerManager::Rake::ServerTasks do
 
     let(:task) { ::Rake::Task["#{task_namespace}:restart"] }
 
-    it "should restart the server" do
+    it "restarts the server" do
       expect(server).to receive(:restart!)
       task.execute
     end
@@ -55,7 +55,7 @@ describe HttpServerManager::Rake::ServerTasks do
 
     let(:task) { ::Rake::Task["#{task_namespace}:status"] }
 
-    it "should write the server name and it's status to stdout" do
+    it "writes the server name and its status to stdout" do
       allow(server).to receive(:status).and_return("stopped")
       expect(server_tasks).to receive(:puts).with("test_server is stopped")
 

data/spec/lib/http_server_manager/server_integration_spec.rb

@@ -1,33 +1,35 @@
 describe HttpServerManager::Server, "managing a real server" do
   include_context "managed http server integration utilities"
 
-  let(:name) { "test_server" }
-  let(:host) { "localhost" }
-  let(:port) { 4001 }
+  let(:name)                   { "test_server" }
+  let(:host)                   { "localhost" }
+  let(:port)                   { 4001 }
+  let(:additional_server_args) { {} }
+  let(:server_args)            { { name: name, host: host, port: port }.merge(additional_server_args) }
 
-  let(:server) { RackServer.new(name: name, host: host, port: port) }
+  let(:server) { RackServer.new(server_args) }
 
   describe "#start!" do
 
-    after(:each) { force_stop! }
+    after(:example) { force_stop! }
 
-    describe "when the server is not running" do
+    context "when the server is not running" do
 
-      after(:each) { wait_until_started! } # Ensure server has completely started
+      after(:example) { wait_until_started! } # Ensure server has completely started
 
-      it "should start the server via the provided command" do
+      it "starts the server via the provided command" do
         server.start!
 
         wait_until_started!
       end
 
-      it "should create a pid file for the server in the configured pid directory" do
+      it "creates a pid file for the server in the configured pid directory" do
         server.start!
 
         ::Wait.until_true!(description: "server pid created") { pid_file_exists? }
       end
 
-      it "should create a log file capturing the stdout and stderr of the server in the configured log directory" do
+      it "creates a log file capturing the stdout and stderr of the server in the configured log directory" do
         server.start!
 
         ::Wait.until_true!(description: "log file is created") do
@@ -35,22 +37,36 @@ describe HttpServerManager::Server, "managing a real server" do
         end
       end
 
-      it "should log that the server started on the configured port" do
+      it "logs that the server started on the configured port" do
         expect(logger).to receive(:info).with(/started on #{host}:#{port}/)
 
         server.start!
       end
 
+      context "and a ping_uri is configured" do
+
+        let(:additional_server_args) { { ping_uri: "/ping" } }
+
+        let(:ping_count_endpoint) { URI("http://#{host}:#{port}/ping_count") }
+
+        it "requests the configured ping uri when determining if the server is running" do
+          server.start!
+
+          expect(Net::HTTP.get(ping_count_endpoint)).to eql("1")
+        end
+
+      end
+
     end
 
-    describe "when the server is already running" do
+    context "when the server is already running" do
 
-      before(:each) do
+      before(:example) do
         server.start!
         wait_until_started!
       end
 
-      it "should log that the server is already running on the configured port" do
+      it "logs that the server is already running on the configured port" do
         expect(logger).to receive(:info).with(/already running on #{host}:#{port}/)
 
         server.start!
@@ -62,19 +78,19 @@ describe HttpServerManager::Server, "managing a real server" do
 
   describe "#stop!" do
 
-    describe "when the server is running" do
+    context "when the server is running" do
 
-      before(:each) { force_start! }
+      before(:example) { force_start! }
 
-      after(:each) { force_stop! } # Ensure server has completely stopped
+      after(:example) { force_stop! } # Ensure server has completely stopped
 
-      it "should stop the server" do
+      it "stops the server" do
         server.stop!
 
         wait_until_stopped!
       end
 
-      it "should delete the servers pid file" do
+      it "deletes the servers pid file" do
         server.stop!
 
         ::Wait.until_false!(description: "server pid is deleted") do
@@ -82,7 +98,7 @@ describe HttpServerManager::Server, "managing a real server" do
         end
       end
 
-      it "should log that the server has stopped" do
+      it "logs that the server has stopped" do
         expect(logger).to receive(:info).with(/stopped/)
 
         server.stop!
@@ -90,9 +106,9 @@ describe HttpServerManager::Server, "managing a real server" do
 
     end
 
-    describe "when the server is not running" do
+    context "when the server is not running" do
 
-      it "should log that the server is not running" do
+      it "logs that the server is not running" do
         expect(logger).to receive(:info).with(/not running/)
 
         server.stop!
@@ -104,27 +120,27 @@ describe HttpServerManager::Server, "managing a real server" do
 
   describe "#status" do
 
-    describe "when the server is running" do
+    context "when the server is running" do
 
-      before(:each) { force_start! }
+      before(:example) { force_start! }
 
-      after(:each) { force_stop! }
+      after(:example) { force_stop! }
 
-      describe "and the pid file exists" do
+      context "and the pid file exists" do
 
-        it "should return :started" do
+        it "returns :started" do
           expect(server.status).to eql(:started)
         end
 
       end
 
-      describe "and the pid file does not exist" do
+      context "and the pid file does not exist" do
 
-        before(:each) { force_pid_file_deletion! }
+        before(:example) { force_pid_file_deletion! }
 
-        after(:each) { restore_pid_file! }
+        after(:example) { restore_pid_file! }
 
-        it "should return :started" do
+        it "returns :started" do
           expect(server.status).to eql(:started)
         end
 
@@ -132,23 +148,23 @@ describe HttpServerManager::Server, "managing a real server" do
 
     end
 
-    describe "when the server is not running" do
+    context "when the server is not running" do
 
-      describe "and the pid file does not exist" do
+      context "and the pid file does not exist" do
 
-        it "should return :stopped" do
+        it "returns :stopped" do
           expect(server.status).to eql(:stopped)
         end
 
       end
 
-      describe "and the pid file exists" do
+      context "and the pid file exists" do
 
-        before(:each) { force_pid_file_creation! }
+        before(:example) { force_pid_file_creation! }
 
-        after(:each) { force_pid_file_deletion! }
+        after(:example) { force_pid_file_deletion! }
 
-        it "should return :stopped" do
+        it "returns :stopped" do
           expect(server.status).to eql(:stopped)
         end
 
@@ -160,15 +176,15 @@ describe HttpServerManager::Server, "managing a real server" do
 
   describe "#to_s" do
 
-    it "should return a string containing the servers name" do
+    it "returns a string containing the servers name" do
       expect(server.to_s).to match(name)
     end
 
-    it "should return a string containing the servers host" do
+    it "returns a string containing the servers host" do
       expect(server.to_s).to match(host)
     end
 
-    it "should return a string containing the servers port" do
+    it "returns a string containing the servers port" do
       expect(server.to_s).to match(port.to_s)
     end
 

data/spec/lib/http_server_manager/server_spec.rb

@@ -14,19 +14,19 @@ describe HttpServerManager::Server do
 
   describe "#start!" do
 
-    before(:each) { allow(Wait).to receive(:until_true!) }
+    before(:example) { allow(Wait).to receive(:until_true!) }
 
     context "when the server is not running" do
 
       let(:env_timeout) { nil }
 
-      before(:each) do
+      before(:example) do
         allow(ENV).to receive(:[]).with("timeout").and_return(env_timeout)
         allow(server).to receive(:running?).and_return(false)
         allow(Process).to receive(:spawn)
       end
 
-      it "should start the server by spawning a process that executes the start command" do
+      it "starts the server by spawning a process that executes the start command" do
         expect(Process).to receive(:spawn).with("some command", anything).and_return(888)
 
         server.start!
@@ -36,7 +36,7 @@ describe HttpServerManager::Server do
 
         let(:server_options) { { name: "Test Server", host: "localhost", port: 8888, timeout_in_seconds: 3 } }
 
-        it "should wait for the specified amount of time in seconds for the server to start" do
+        it "waits for the specified amount of time in seconds for the server to start" do
           expect(Wait).to receive(:until_true!).with(hash_including(timeout_in_seconds: 3))
 
           server.start!
@@ -48,7 +48,7 @@ describe HttpServerManager::Server do
 
         let(:env_timeout) { "8" }
 
-        it "should wait for the specified amount of time in seconds for the server to start" do
+        it "waits for the specified amount of time in seconds for the server to start" do
           expect(Wait).to receive(:until_true!).with(hash_including(timeout_in_seconds: 8))
 
           server.start!
@@ -58,7 +58,7 @@ describe HttpServerManager::Server do
 
       context "when no timeout is provided" do
 
-        it "should wait 20 seconds for the server to start" do
+        it "waits 20 seconds for the server to start" do
           expect(Wait).to receive(:until_true!).with(hash_including(timeout_in_seconds: 20))
 
           server.start!
@@ -72,12 +72,12 @@ describe HttpServerManager::Server do
 
   describe "#restart!" do
 
-    before(:each) do
+    before(:example) do
       allow(server).to receive(:start!)
       allow(server).to receive(:stop!)
     end
 
-    it "should first stop the server and then start the server" do
+    it "stops the server first and then starts the server" do
       expect(server).to receive(:stop!).ordered
       expect(server).to receive(:start!).ordered
 

data/spec/lib/http_server_manager/stdout_logger_spec.rb

@@ -4,7 +4,7 @@ describe HttpServerManager::StdOutLogger do
 
   describe "#info" do
 
-    it "should write the message to stdout" do
+    it "writes the message to stdout" do
       message = "Some message"
       expect(logger).to receive(:puts).with(message)
 

data/spec/lib/http_server_manager/test/server_integration_examples_spec.rb

@@ -2,6 +2,6 @@ describe "server_integration_examples" do
 
   let(:server) { RackServer.new(name: "test_server", host: "localhost", port: 4001) }
 
-  it_should_behave_like "a managed http server"
+  it_behaves_like "a managed http server"
 
 end

data/spec/lib/http_server_manager_spec.rb

@@ -1,26 +1,26 @@
 describe HttpServerManager do
 
-  describe ".logger" do
+  describe "::logger" do
 
-    describe "when no logger has been explicitly configured" do
+    context "when no logger has been explicitly configured" do
 
-      before(:each) { HttpServerManager.logger = nil }
+      before(:example) { HttpServerManager.logger = nil }
 
-      it "should default to the stdout logger" do
+      it "defaults to the stdout logger" do
         expect(HttpServerManager.logger).to be_a(HttpServerManager::StdOutLogger)
       end
 
     end
 
-    describe "when a logger has been explicitly configured" do
+    context "when a logger has been explicitly configured" do
 
       let(:logger) { double("Logger").as_null_object }
 
-      before(:each) { HttpServerManager.logger = logger }
+      before(:example) { HttpServerManager.logger = logger }
 
-      after(:each) { HttpServerManager.logger = nil }
+      after(:example) { HttpServerManager.logger = nil }
 
-      it "should return the configured logger" do
+      it "returns the configured logger" do
         expect(HttpServerManager.logger).to eql(logger)
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http_server_manager
 version: !ruby/object:Gem::Version
-  version: 0.4.15
+  version: 0.5.0
 platform: ruby
 authors:
 - Matthew Ueckerman
@@ -9,118 +9,118 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-proctree
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
   name: wait_until
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '10.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: '0.44'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0.41'
+        version: '0.44'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rack
   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: travis-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
 description: Manages the lifecycle of HTTP server processes
@@ -129,24 +129,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- "./lib/http_server_manager.rb"
-- "./lib/http_server_manager/rake/server_tasks.rb"
-- "./lib/http_server_manager/rake/task_generators.rb"
-- "./lib/http_server_manager/server.rb"
-- "./lib/http_server_manager/stdout_logger.rb"
-- "./lib/http_server_manager/version.rb"
-- "./spec/lib/http_server_manager/rake/server_tasks_spec.rb"
-- "./spec/lib/http_server_manager/server_integration_spec.rb"
-- "./spec/lib/http_server_manager/server_spec.rb"
-- "./spec/lib/http_server_manager/stdout_logger_spec.rb"
-- "./spec/lib/http_server_manager/test/server_integration_examples_spec.rb"
-- "./spec/lib/http_server_manager_spec.rb"
-- "./spec/spec_helper.rb"
-- "./spec/support/http_server_manager/test/server_integration_examples.rb"
-- "./spec/support/http_server_manager/test/server_integration_utilities.rb"
-- "./spec/support/http_server_manager/test/server_integration_utilities_spec_context.rb"
-- "./spec/support/http_server_manager/test/silent_logger.rb"
-- "./spec/support/http_server_manager/test_support.rb"
+- ./lib/http_server_manager.rb
+- ./lib/http_server_manager/rake/server_tasks.rb
+- ./lib/http_server_manager/rake/task_generators.rb
+- ./lib/http_server_manager/server.rb
+- ./lib/http_server_manager/stdout_logger.rb
+- ./lib/http_server_manager/version.rb
+- ./spec/lib/http_server_manager/rake/server_tasks_spec.rb
+- ./spec/lib/http_server_manager/server_integration_spec.rb
+- ./spec/lib/http_server_manager/server_spec.rb
+- ./spec/lib/http_server_manager/stdout_logger_spec.rb
+- ./spec/lib/http_server_manager/test/server_integration_examples_spec.rb
+- ./spec/lib/http_server_manager_spec.rb
+- ./spec/spec_helper.rb
+- ./spec/support/http_server_manager/test/server_integration_examples.rb
+- ./spec/support/http_server_manager/test/server_integration_utilities.rb
+- ./spec/support/http_server_manager/test/server_integration_utilities_spec_context.rb
+- ./spec/support/http_server_manager/test/silent_logger.rb
+- ./spec/support/http_server_manager/test_support.rb
 homepage: http://github.com/MYOB-Technology/http_server_manager
 licenses:
 - MIT
@@ -158,30 +158,30 @@ require_paths:
 - spec/support
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: http_server_manager
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Manages the lifecycle of HTTP server processes
 test_files:
-- "./spec/lib/http_server_manager/rake/server_tasks_spec.rb"
-- "./spec/lib/http_server_manager/server_integration_spec.rb"
-- "./spec/lib/http_server_manager/server_spec.rb"
-- "./spec/lib/http_server_manager/stdout_logger_spec.rb"
-- "./spec/lib/http_server_manager/test/server_integration_examples_spec.rb"
-- "./spec/lib/http_server_manager_spec.rb"
-- "./spec/spec_helper.rb"
-- "./spec/support/http_server_manager/test/server_integration_examples.rb"
-- "./spec/support/http_server_manager/test/server_integration_utilities.rb"
-- "./spec/support/http_server_manager/test/server_integration_utilities_spec_context.rb"
-- "./spec/support/http_server_manager/test/silent_logger.rb"
-- "./spec/support/http_server_manager/test_support.rb"
+- ./spec/lib/http_server_manager/rake/server_tasks_spec.rb
+- ./spec/lib/http_server_manager/server_integration_spec.rb
+- ./spec/lib/http_server_manager/server_spec.rb
+- ./spec/lib/http_server_manager/stdout_logger_spec.rb
+- ./spec/lib/http_server_manager/test/server_integration_examples_spec.rb
+- ./spec/lib/http_server_manager_spec.rb
+- ./spec/spec_helper.rb
+- ./spec/support/http_server_manager/test/server_integration_examples.rb
+- ./spec/support/http_server_manager/test/server_integration_utilities.rb
+- ./spec/support/http_server_manager/test/server_integration_utilities_spec_context.rb
+- ./spec/support/http_server_manager/test/silent_logger.rb
+- ./spec/support/http_server_manager/test_support.rb