app_status 1.2.0 → 2.0.0.pre.alpha.1

data/spec/features/app_status_features_spec.rb

@@ -10,13 +10,13 @@ RSpec::Matchers.define :have_content_type do |expected|
     extract_content_type(actual) == expected
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "expected that page's content type would be '#{expected}', but was '#{extract_content_type(actual)}'"
   end
 
 end
 
-describe "status" do
+describe "status", type: :feature do
 
   before(:each) do
     AppStatus::CheckCollection.clear_checks!
@@ -31,30 +31,6 @@ describe "status" do
     page.should have_content_type('application/json')
   end
 
-  describe "html page" do
-
-    it "is available at status.html" do
-      visit '/status.html'
-      page.should have_content_type('text/html')
-    end
-
-    it "is available at /status/index.html" do
-      visit '/status/index.html'
-      page.should have_content_type('text/html')
-    end
-
-    it "renders in the main application's default layout" do
-      visit '/status.html'
-      page.title.should eq 'Dummy'
-    end
-
-    it "doesn't break route urls in main layout" do
-      visit '/status.html'
-      page.find('#widget_menu').should have_content('Widgets are at http://www.example.com/widgets.')
-    end
-
-  end
-
   describe "json endpoint" do
 
     it "is available at status.json" do
@@ -84,7 +60,15 @@ describe "status" do
       data['status_code'].should eq 0
       data['checks']['some_service']['status'].should eq 'ok'
       data['checks']['some_service']['details'].should eq 'foo'
+      data['checks']['some_service']['description'].should eq nil
     end
 
+    it "may include check descriptions" do
+      visit '/status.json?descriptions=1'
+      page.should have_content_type('application/json')
+      data = JSON.parse(page.body)
+
+      data['checks']['some_service']['description'].should eq 'more info'
+    end
   end
 end

data/spec/lib/app_status/checks/ruby_version_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'app_status/checks/ruby_version'
+
+RSpec.describe AppStatus::Checks::RubyVersion, type: :model do
+  let(:subject) { described_class }
+  let(:actual_ruby_version)  { '2.4.1' }
+  let(:other_ruby_version)   { '2.5.0' }
+  before(:each) do
+    stub_const('RUBY_VERSION', actual_ruby_version)
+  end
+
+  describe '.install!' do
+    after(:each) do
+      AppStatus::CheckCollection.clear_checks!
+    end
+
+    it 'should add a ruby_version check to AppStatus::CheckCollection' do
+      # add to list of checks
+      AppStatus::Checks::RubyVersion.install!(expected_version: actual_ruby_version)
+
+      # evaluate the checks which have been added
+      checks = AppStatus::CheckCollection.new
+      checks.evaluate!
+
+      # look at results
+      results = checks.as_hash
+      expect(results['checks'].keys).to include('ruby_version')
+    end
+
+    it 'should pass optional parameter along to .check' do
+      AppStatus::Checks::RubyVersion.install!(expected_version: other_ruby_version)
+
+      expect(AppStatus::Checks::RubyVersion).to(
+        receive(:check)
+          .with(expected_version: other_ruby_version)
+      )
+
+      checks = AppStatus::CheckCollection.new
+      checks.evaluate!
+    end
+  end
+
+  describe '.check' do
+    it 'should be :ok when RUBY_VERSION matches expected_version' do
+      result = subject.check(expected_version: actual_ruby_version)
+      expect(result).to(
+        eq([:ok, "expected: #{actual_ruby_version}, actual: #{actual_ruby_version}"])
+      )
+    end
+
+    it 'should be :critical when RUBY_VERSION does not match expected_version' do
+      result = subject.check(expected_version: other_ruby_version)
+      expect(result).to(
+        eq([:critical, "expected: #{other_ruby_version}, actual: #{actual_ruby_version}"])
+      )
+    end
+
+    it 'should read from .ruby-version if expected_version is not specified' do
+      expect(File).to(
+        receive(:read)
+          .with(Rails.root.join('.ruby-version'))
+          .and_return(actual_ruby_version)
+      )
+
+      result = subject.check
+      expect(result).to(
+        eq([:ok, "expected: #{actual_ruby_version}, actual: #{actual_ruby_version}"])
+      )
+    end
+  end
+end

data/spec/models/check_collection_spec.rb

@@ -35,7 +35,7 @@ describe AppStatus::CheckCollection do
       it "should raise an error if name is not supplied" do
         expect {
           AppStatus::CheckCollection.add_check
-        }.to raise_error(ArgumentError, "wrong number of arguments (0 for 1)")
+        }.to raise_error(ArgumentError)
       end
 
       it "should raise an error if block is not supplied" do
@@ -147,45 +147,68 @@ describe AppStatus::CheckCollection do
       c = AppStatus::CheckCollection.new
       Timecop.freeze('2013-10-05T12:00:00Z') { c.evaluate! }
 
-      c.as_json.should eq({
+      expect(c.as_json).to match({
         "status" => :unknown,
         "status_code" => 3,
-        "ms" => instance_of(Fixnum),
+        "ms" => an_instance_of(Fixnum),
         "finished" => "2013-10-05T12:00:00Z",
         "checks" => {
           "test1" => {
             "status" => :ok,
             "status_code" => 0,
             "details" => "looks good",
-            "ms" => instance_of(Fixnum)
+            "ms" => an_instance_of(Fixnum)
           },
           "test2" => {
             "status" => :unknown,
             "status_code" => 3,
             "details" => "Check returned invalid status 'huh'. invalid",
-            "ms" => instance_of(Fixnum)
+            "ms" => an_instance_of(Fixnum)
           },
           "test3" => {
             "status" => :warning,
             "status_code" => 1,
             "details" => "not good",
-            "ms" => instance_of(Fixnum)
+            "ms" => an_instance_of(Fixnum)
           },
           "test4" => {
             "status" => :critical,
             "status_code" => 2,
             "details" => "on fire",
-            "ms" => instance_of(Fixnum)
+            "ms" => an_instance_of(Fixnum)
           },
           "test5" => {
             "status" => :unknown,
             "status_code" => 3,
             "details" => "no idea",
-            "ms" => instance_of(Fixnum)
+            "ms" => an_instance_of(Fixnum)
           }
         }
       })
     end
 
+    it "should include optionally include descriptions" do
+      AppStatus::CheckCollection.configure do |c|
+        c.add_check('test1') { [:ok, 'looks good'] }
+        c.add_description 'test1', 'test1 description'
+
+        c.add_check('test2') { [:ok, 'looks good'] }
+        c.add_description 'test2', 'test2 description'
+      end
+
+      c = AppStatus::CheckCollection.new
+      c.evaluate!
+
+      result = c.as_json(include_descriptions: true)
+
+      expect(
+        result['checks']['test1']['description']
+      ).to eq 'test1 description'
+
+      expect(
+        result['checks']['test2']['description']
+      ).to eq 'test2 description'
+    end
+
   end
 end

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@ ENV['RAILS_ENV'] ||= 'test'
 
 require File.expand_path("../dummy/config/environment.rb", __FILE__)
 require 'rspec/rails'
-require 'rspec/autorun'
 require 'timecop'
 require 'capybara/rspec'
 
@@ -12,4 +11,5 @@ RSpec.configure do |config|
   config.mock_with :rspec
   config.infer_base_class_for_anonymous_controllers = false
   config.order = "random"
+  config.expect_with(:rspec) { |c| c.syntax = [:should, :expect] }
 end

metadata

@@ -1,153 +1,108 @@
 --- !ruby/object:Gem::Specification
 name: app_status
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 2.0.0.pre.alpha.1
 platform: ruby
 authors:
 - Alex Dean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: kramdown
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: 3.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: 3.7.2
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.14'
 description: AppStatus provides a URL which is easily consumable by Nagios or other
   monitoring tools.
 email:
-- alex@crackpot.org
+- github@mostlyalex.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/assets/javascripts/app_status/application.js
-- app/assets/stylesheets/app_status/application.css
+- MIT-LICENSE
+- README.md
+- Rakefile
 - app/controllers/app_status/application_controller.rb
 - app/controllers/app_status/status_controller.rb
-- app/helpers/app_status/application_helper.rb
 - app/models/app_status/check_collection.rb
 - app/models/app_status/check_item.rb
-- app/views/app_status/status/index.html.erb
-- bin/autospec
-- bin/erubis
-- bin/haml
-- bin/htmldiff
-- bin/kramdown
-- bin/ldiff
-- bin/nokogiri
-- bin/rackup
-- bin/rails
-- bin/rake
-- bin/rdoc
-- bin/ri
-- bin/rspec
-- bin/sprockets
-- bin/thor
-- bin/tilt
-- bin/tt
 - config/routes.rb
+- lib/app_status.rb
+- lib/app_status/checks/ruby_version.rb
 - lib/app_status/engine.rb
 - lib/app_status/version.rb
-- lib/app_status.rb
 - lib/tasks/app_status_tasks.rb
-- MIT-LICENSE
-- Rakefile
-- README.md
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
@@ -159,6 +114,7 @@ files:
 - spec/dummy/app/views/widgets/index.html.erb
 - spec/dummy/app/views/widgets/new.html.erb
 - spec/dummy/app/views/widgets/show.html.erb
+- spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
 - spec/dummy/config/database.yml
@@ -175,15 +131,12 @@ files:
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
-- spec/dummy/config.ru
 - spec/dummy/log/development.log
 - spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/dummy/Rakefile
-- spec/dummy/README.rdoc
 - spec/dummy/script/rails
 - spec/dummy/tmp/cache/assets/CA5/160/sprockets%2Fc4b6dd696758a9c186897a8c25615778
 - spec/dummy/tmp/cache/assets/CB2/070/sprockets%2Fe1b30e44248fc0395505c899c0f2357e
@@ -202,92 +155,87 @@ files:
 - spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
 - spec/dummy/tmp/cache/assets/E07/FD0/sprockets%2Fb3d7aafd7ce063e022cd29e7ccb898f9
 - spec/features/app_status_features_spec.rb
+- spec/lib/app_status/checks/ruby_version_spec.rb
 - spec/models/check_collection_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/alexdean/app_status
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3960571408936906561
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -3960571408936906561
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: AppStatus is a Rails engine for exposing app data to Nagios.
 test_files:
-- spec/dummy/app/assets/javascripts/application.js
-- spec/dummy/app/assets/stylesheets/application.css
+- spec/spec_helper.rb
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/widgets_controller.rb
-- spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/widgets/_form.html.erb
-- spec/dummy/app/views/widgets/edit.html.erb
 - spec/dummy/app/views/widgets/index.html.erb
-- spec/dummy/app/views/widgets/new.html.erb
+- spec/dummy/app/views/widgets/edit.html.erb
 - spec/dummy/app/views/widgets/show.html.erb
-- spec/dummy/config/application.rb
-- spec/dummy/config/boot.rb
-- spec/dummy/config/database.yml
-- spec/dummy/config/environment.rb
-- spec/dummy/config/environments/development.rb
+- spec/dummy/app/views/widgets/_form.html.erb
+- spec/dummy/app/views/widgets/new.html.erb
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/config/locales/en.yml
 - spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/development.rb
 - spec/dummy/config/environments/test.rb
-- spec/dummy/config/initializers/app_status.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/boot.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
-- spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
-- spec/dummy/config/initializers/secret_token.rb
 - spec/dummy/config/initializers/session_store.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
-- spec/dummy/config/locales/en.yml
-- spec/dummy/config/routes.rb
+- spec/dummy/config/initializers/app_status.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config.ru
-- spec/dummy/log/development.log
-- spec/dummy/log/test.log
-- spec/dummy/public/404.html
+- spec/dummy/script/rails
+- spec/dummy/Rakefile
+- spec/dummy/public/favicon.ico
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
-- spec/dummy/public/favicon.ico
-- spec/dummy/Rakefile
-- spec/dummy/README.rdoc
-- spec/dummy/script/rails
+- spec/dummy/public/404.html
+- spec/dummy/log/test.log
+- spec/dummy/log/development.log
+- spec/dummy/tmp/cache/assets/D15/DA0/sprockets%2Fc7e74644f623ec92a443b53b8c1d19c8
+- spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
+- spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
+- spec/dummy/tmp/cache/assets/DDD/460/sprockets%2Fe5b8947c2a5caf5460fecdfd48c818d5
+- spec/dummy/tmp/cache/assets/DB8/430/sprockets%2Ff731c6599577d8f741f3afd2d8ed2efb
+- spec/dummy/tmp/cache/assets/D3F/E00/sprockets%2Fa7629a6ce27d07753dbb05bd48098ce0
+- spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953
 - spec/dummy/tmp/cache/assets/CA5/160/sprockets%2Fc4b6dd696758a9c186897a8c25615778
+- spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655
 - spec/dummy/tmp/cache/assets/CB2/070/sprockets%2Fe1b30e44248fc0395505c899c0f2357e
 - spec/dummy/tmp/cache/assets/CB2/5B0/sprockets%2Fc8e423e85d0a1cb22332859990909a3f
-- spec/dummy/tmp/cache/assets/CD8/370/sprockets%2F357970feca3ac29060c1e3861e2c0953
-- spec/dummy/tmp/cache/assets/CF2/9A0/sprockets%2Fb3eee5a6a87662f428f47c908157f606
-- spec/dummy/tmp/cache/assets/D15/DA0/sprockets%2Fc7e74644f623ec92a443b53b8c1d19c8
+- spec/dummy/tmp/cache/assets/E07/FD0/sprockets%2Fb3d7aafd7ce063e022cd29e7ccb898f9
 - spec/dummy/tmp/cache/assets/D32/A10/sprockets%2F13fe41fee1fe35b49d145bcc06610705
-- spec/dummy/tmp/cache/assets/D3F/E00/sprockets%2Fa7629a6ce27d07753dbb05bd48098ce0
-- spec/dummy/tmp/cache/assets/D4E/1B0/sprockets%2Ff7cbd26ba1d28d48de824f0e94586655
-- spec/dummy/tmp/cache/assets/D51/F30/sprockets%2Fbe466f3302fef7895aad76d05d93963d
+- spec/dummy/tmp/cache/assets/CF2/9A0/sprockets%2Fb3eee5a6a87662f428f47c908157f606
 - spec/dummy/tmp/cache/assets/D5A/EA0/sprockets%2Fd771ace226fc8215a3572e0aa35bb0d6
-- spec/dummy/tmp/cache/assets/DB8/430/sprockets%2Ff731c6599577d8f741f3afd2d8ed2efb
-- spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
-- spec/dummy/tmp/cache/assets/DDD/460/sprockets%2Fe5b8947c2a5caf5460fecdfd48c818d5
-- spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
-- spec/dummy/tmp/cache/assets/E07/FD0/sprockets%2Fb3d7aafd7ce063e022cd29e7ccb898f9
+- spec/dummy/tmp/cache/assets/D51/F30/sprockets%2Fbe466f3302fef7895aad76d05d93963d
+- spec/dummy/README.rdoc
 - spec/features/app_status_features_spec.rb
 - spec/models/check_collection_spec.rb
-- spec/spec_helper.rb
+- spec/lib/app_status/checks/ruby_version_spec.rb