okcomputer 1.11.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e98c45fbc87628bf1d143ef54b7c3688db17445f
-  data.tar.gz: 755db783e2105b593afa77653aee78d3a8febfc9
+  metadata.gz: 68f34f802639366baa476811ef5887698d421430
+  data.tar.gz: a561e25ff0338f38ab6f74f992b0fcde158f1a27
 SHA512:
-  metadata.gz: 4f8b9332ca781d93205bdd03fc8de67a2274f8206b6df2ae6d56ce4f3e6e98a8f20235ec83f6c42e21bad4d192268a9aef3214ef11695a3ef83d89ea02def386
-  data.tar.gz: 55409375cfeee2457b4f6d59e768adc0cf8073a8860bd80c2f7fdd20a9fc31aa91c53ccfa84075366bfb942637a6a77813074f63637d82f767929ddcd21a584c
+  metadata.gz: b90dc5648bade933b9cc58c45db4e71c434e6920b3c3a3cc9ac78c1238b3b8ad1c3d49ce380533faee081ab7a055dc19547a70176a8fe3e7e37bc95c2df65918
+  data.tar.gz: 57dea05e4612d62026a7aee1bc3ec6bdffc85666a67e298332bfbab015da014218480fc76b5b9ca7742fb47cf108e91fc842cf8a33eb738ff4097e19c0e12f2a

data/README.markdown

@@ -15,6 +15,13 @@ OK Computer][blog].
 
 [blog]:http://pulse.sportngin.com/news_article/show/267646?referrer_id=543230
 
+OkComputer currently supports the following Rails versions:
+
+* 3.2
+* 4.1
+* 4.2
+* 5.0
+
 #### Not using Rails?
 
 If you use [Grape] instead of Rails, check out [okcomputer-grape].
@@ -180,6 +187,28 @@ If you'd like to intentionally count OkComputer requests in your NewRelic analyt
 OkComputer.analytics_ignore = false
 ```
 
+## Development
+
+### Setup
+
+```plaintext
+$ bundle install
+```
+
+### Running the test suite
+
+OkComputer tests are written with [RSpec](http://rspec.info/).
+
+To run the full test suite:
+
+```plaintext
+$ rake spec
+```
+
+You may also use the environment variable `RAILS_VERSION` with one
+of the supported versions of Rails (found at the top of this file) to
+bundle and run the tests with a specific version of Rails.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -9,13 +9,18 @@ Bundler::GemHelper.install_tasks
 
 task :default => :spec
 
-require "rspec/core/rake_task"
+begin
+  require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    puts "Testing with Rails #{ENV["RAILS_VERSION"]}..." if ENV["RAILS_VERSION"]
+  end
 
-namespace :spec do
-  RSpec::Core::RakeTask.new(:docs) do |t|
-    t.rspec_opts = ["--format doc"]
+  namespace :spec do
+    RSpec::Core::RakeTask.new(:docs) do |t|
+      t.rspec_opts = ["--format doc"]
+    end
   end
+rescue LoadError
 end
 

data/app/controllers/ok_computer/ok_computer_controller.rb

@@ -13,7 +13,7 @@ module OkComputer
 
     rescue_from OkComputer::Registry::CheckNotFound do |e|
       respond_to do |f|
-        f.any(:text, :html) { render plain: e.message, status: :not_found }
+        f.any(:text, :html) { render plain: e.message, status: :not_found, content_type: 'text/plain' }
         f.json { render json: { error: e.message }, status: :not_found }
       end
     end
@@ -36,7 +36,7 @@ module OkComputer
 
     def respond(data, status)
       respond_to do |format|
-         format.any(:text, :html) { render plain: data, status: status }
+         format.any(:text, :html) { render plain: data, status: status, content_type: 'text/plain' }
          format.json { render json: data, status: status }
       end
     end

data/lib/ok_computer/built_in_checks/ping_check.rb

@@ -0,0 +1,52 @@
+module OkComputer
+  # Performs a health check by making a TCPSocket request to the host and port.
+  # A non-error response is considered passing.
+  class PingCheck < Check
+    ConnectionFailed = Class.new(StandardError)
+
+    attr_accessor :host, :port, :request_timeout
+
+    # Public: Initialize a new ping check.
+    #
+    # host - the hostname
+    # port - the port, as a string
+    # request_timeout - How long to wait to connect before timing out. Defaults to 5 seconds.
+    def initialize(host, port, request_timeout = 5)
+      raise ArgumentError if host.blank? || port.blank?
+      self.host = host
+      self.port = port
+      self.request_timeout = request_timeout.to_i
+    end
+
+    # Public: Return the status of the Ping check
+    def check
+      tcp_socket_request
+      mark_message "Ping check to #{host}:#{port} successful"
+    rescue => e
+      mark_message "Error: '#{e}'"
+      mark_failure
+    end
+
+    private
+
+    # Returns true if the request was successful.
+    # Otherwise raises a PingCheck::ConnectionFailed error.
+    def tcp_socket_request
+      Timeout.timeout(request_timeout) do
+        s = TCPSocket.new(host, port)
+        s.close
+      end
+    rescue Errno::ECONNREFUSED => e
+      addl_message = "#{host} is not accepting connections on port #{port}: "
+      raise ConnectionFailed, addl_message + e.message
+    rescue SocketError => e
+      addl_message = "connection to #{host} on port #{port} failed with '#{e.message}': "
+      raise ConnectionFailed, addl_message + e.message
+    rescue TimeoutError => e
+      addl_message = "#{host} did not respond on port #{port} within #{request_timeout} seconds: "
+      raise ConnectionFailed, addl_message + e.message
+    rescue => e
+      raise ConnectionFailed, e
+    end
+  end
+end

data/lib/ok_computer/legacy_rails_controller_support.rb

@@ -10,7 +10,7 @@ module OkComputer
     end
 
     # Support 'render plain' for Rails 3
-    def render(**options, &block)
+    def render(options = {}, &block)
       options[:text] = options.delete(:plain) if options.include?(:plain)
       super
     end

data/lib/ok_computer/version.rb

@@ -1,3 +1,3 @@
 module OkComputer
-  VERSION = '1.11.1'
+  VERSION = '1.12.0'
 end

data/lib/okcomputer.rb

@@ -20,6 +20,7 @@ require "ok_computer/built_in_checks/mongoid_check"
 require "ok_computer/built_in_checks/neo4j_check"
 require "ok_computer/built_in_checks/mongoid_replica_set_check"
 require "ok_computer/built_in_checks/optional_check"
+require "ok_computer/built_in_checks/ping_check"
 require "ok_computer/built_in_checks/rabbitmq_check"
 require "ok_computer/built_in_checks/redis_check"
 require "ok_computer/built_in_checks/resque_backed_up_check"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: okcomputer
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Patrick Byrne
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -84,6 +84,7 @@ files:
 - lib/ok_computer/built_in_checks/mongoid_replica_set_check.rb
 - lib/ok_computer/built_in_checks/neo4j_check.rb
 - lib/ok_computer/built_in_checks/optional_check.rb
+- lib/ok_computer/built_in_checks/ping_check.rb
 - lib/ok_computer/built_in_checks/rabbitmq_check.rb
 - lib/ok_computer/built_in_checks/redis_check.rb
 - lib/ok_computer/built_in_checks/resque_backed_up_check.rb