app_status 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3f92be251f2e5e1e9663ca7fbd128c37d8cef85b
-  data.tar.gz: a376f86a882cc42e2e4deeb5953dda8a45151999
+SHA256:
+  metadata.gz: 46ea6b514829437f9e026f13f298a68ef3e9fdac9b19bfe52aefc5415867001c
+  data.tar.gz: 3a7126c9a9741bc9286e65fe945b0a2a174dd9ba0b0a3f7509ded5b735569d9a
 SHA512:
-  metadata.gz: 219bdfb084a8dd3b26f0db68dc8026e7f5fd770ae0a2a611745435d99beaf354a5ee8da8bfb496d0e4cae3d66470ff4f836acb693385ecb8f0841594087e5bca
-  data.tar.gz: c92ddd4bc3d6352df646c92a96f024ecac48bf95b8e243a60f26b3a0affc0d09807a9db10b3a7d77376f50fe6dfae8d7c77ad18e3dddec6da12e49e572d515d3
+  metadata.gz: 06ec7104c17a631a9de11ef98fc2950f12b44048a02f503c5f2dd7c597b08ccfcd93e18cd6d40c350e09c47b040dba003c7ac9513055535f95f10679b880fe5a
+  data.tar.gz: 3233c1b5b3f23256f5f3cf590e5f3a9c6c232357ebaaa6bf779203380f423c701c95db1b1b6d130c1f2b83eff6fc948639659548c5f0dd8a148c6412d5abe906

data/README.md

@@ -50,15 +50,8 @@ gem 'app_status'
 mount AppStatus::Engine => "/status(.:format)", defaults: {format: 'json'}
 ```
 
-This exposes the following URLs
-  - `http://localhost:3000/status`
-    renders html or json according to Accept headers. Defaults to JSON.
-  - `http://localhost:3000/status.json`
-  - `http://localhost:3000/status.html`
-
-The HTML status page will use your application's default layout.
-
-**NOTE :** The engine assumes that you have a top-level `::ApplicationController`.
+This exposes `http://localhost:3000/status.json`. (Support for HTML output was
+dropped in v2.0. see [PR #3](https://github.com/alexdean/app_status/pull/3).)
 
 ### `config/initializers/app_status.rb`
 
@@ -104,12 +97,8 @@ These are set up to be compatible with Nagios.
 `add_description` allows you to specify extended description and troubleshooting
 information for any check which has been added via `add_check`.
 
-Currently these are not returned via the JSON endpoint, but are available
-via the HTML status page.
-
-Description information is parsed by kramdown for display. Refer to the
-[kramdown style guide](http://kramdown.rubyforge.org/quickref.html) for
-usage information.
+These descriptions are not included in the `status.json` payload by default.
+Add `?descriptions=1` to include them.
 
 ```ruby
 AppStatus::CheckCollection.configure do |c|

data/app/controllers/app_status/status_controller.rb

@@ -6,12 +6,8 @@ module AppStatus
 
       json_data = @checks.as_json(include_descriptions: params[:descriptions])
 
-      more_info = app_status_engine.root_url
-      # try to build html url, when main app has route like '/status(.:format)'
-      if match = more_info.match(/(.*)\.json/)
-        more_info = match[1]+'.html'
-      end
-      json_data['more_info'] = more_info
+      more_info_url = app_status_engine.root_url(descriptions: true)
+      json_data['more_info'] = more_info_url
 
       render json: json_data
     end

data/lib/app_status/version.rb

@@ -1,3 +1,3 @@
 module AppStatus
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/dummy/log/test.log

@@ -2554,3 +2554,155 @@ Completed 200 OK in 1ms (Views: 0.3ms)
 Started GET "/status.json" for 127.0.0.1 at 2018-02-16 16:08:37 -0600
 Processing by AppStatus::StatusController#index as JSON
 Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status" for 127.0.0.1 at 2019-02-27 09:59:44 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 2ms (Views: 0.3ms)
+Started GET "/status/index.json" for 127.0.0.1 at 2019-02-27 09:59:44 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json?descriptions=1" for 127.0.0.1 at 2019-02-27 09:59:44 -0600
+Processing by AppStatus::StatusController#index as JSON
+  Parameters: {"descriptions"=>"1"}
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 09:59:44 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 09:59:44 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 09:59:44 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status" for 127.0.0.1 at 2019-02-27 10:00:35 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 2ms (Views: 0.3ms)
+Started GET "/status/index.json" for 127.0.0.1 at 2019-02-27 10:00:35 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json?descriptions=1" for 127.0.0.1 at 2019-02-27 10:00:35 -0600
+Processing by AppStatus::StatusController#index as JSON
+  Parameters: {"descriptions"=>"1"}
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:00:35 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:00:35 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:00:35 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status" for 127.0.0.1 at 2019-02-27 10:01:04 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 500 Internal Server Error in 6ms
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:01:04 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 500 Internal Server Error in 5ms
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:01:04 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 500 Internal Server Error in 5ms
+Started GET "/status/index.json" for 127.0.0.1 at 2019-02-27 10:01:04 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 500 Internal Server Error in 5ms
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:01:04 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 500 Internal Server Error in 5ms
+Started GET "/status.json?descriptions=1" for 127.0.0.1 at 2019-02-27 10:01:04 -0600
+Processing by AppStatus::StatusController#index as JSON
+  Parameters: {"descriptions"=>"1"}
+Completed 500 Internal Server Error in 6ms
+Started GET "/status" for 127.0.0.1 at 2019-02-27 10:01:15 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 2ms (Views: 0.3ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:01:15 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:01:15 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:01:15 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status/index.json" for 127.0.0.1 at 2019-02-27 10:01:15 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json?descriptions=1" for 127.0.0.1 at 2019-02-27 10:01:15 -0600
+Processing by AppStatus::StatusController#index as JSON
+  Parameters: {"descriptions"=>"1"}
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status" for 127.0.0.1 at 2019-02-27 10:02:39 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 1ms (Views: 0.2ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:02:39 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:02:39 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status/index.json" for 127.0.0.1 at 2019-02-27 10:02:40 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json?descriptions=1" for 127.0.0.1 at 2019-02-27 10:02:40 -0600
+Processing by AppStatus::StatusController#index as JSON
+  Parameters: {"descriptions"=>"1"}
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:02:40 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status" for 127.0.0.1 at 2019-02-27 10:05:34 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 1ms (Views: 0.2ms)
+Started GET "/status.json?descriptions=1" for 127.0.0.1 at 2019-02-27 10:05:34 -0600
+Processing by AppStatus::StatusController#index as JSON
+  Parameters: {"descriptions"=>"1"}
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:05:34 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status/index.json" for 127.0.0.1 at 2019-02-27 10:05:34 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:05:34 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:05:34 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status" for 127.0.0.1 at 2019-02-27 10:05:49 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 2ms (Views: 0.2ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:05:49 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 1ms (Views: 0.5ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:05:49 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:05:49 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status/index.json" for 127.0.0.1 at 2019-02-27 10:05:49 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json?descriptions=1" for 127.0.0.1 at 2019-02-27 10:05:49 -0600
+Processing by AppStatus::StatusController#index as JSON
+  Parameters: {"descriptions"=>"1"}
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status" for 127.0.0.1 at 2019-02-27 10:07:01 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 2ms (Views: 0.5ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:07:01 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 1ms (Views: 0.2ms)
+Started GET "/status/index.json" for 127.0.0.1 at 2019-02-27 10:07:01 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.2ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:07:01 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json?descriptions=1" for 127.0.0.1 at 2019-02-27 10:07:01 -0600
+Processing by AppStatus::StatusController#index as JSON
+  Parameters: {"descriptions"=>"1"}
+Completed 200 OK in 0ms (Views: 0.1ms)
+Started GET "/status.json" for 127.0.0.1 at 2019-02-27 10:07:01 -0600
+Processing by AppStatus::StatusController#index as JSON
+Completed 200 OK in 0ms (Views: 0.1ms)

data/spec/features/app_status_features_spec.rb

@@ -43,12 +43,12 @@ describe "status", type: :feature do
       page.should have_content_type('application/json')
     end
 
-    it "links to html status page" do
+    it "links to more-details page" do
       visit '/status.json'
       page.should have_content_type('application/json')
       data = JSON.parse(page.body)
 
-      data['more_info'].should eq 'http://www.example.com/status.html'
+      data['more_info'].should eq 'http://www.example.com/status/?descriptions=true'
     end
 
     it "contains status information" do

data/spec/models/check_collection_spec.rb

@@ -150,38 +150,38 @@ describe AppStatus::CheckCollection do
       expect(c.as_json).to match({
         "status" => :unknown,
         "status_code" => 3,
-        "ms" => an_instance_of(Fixnum),
+        "ms" => an_instance_of(Integer),
         "finished" => "2013-10-05T12:00:00Z",
         "checks" => {
           "test1" => {
             "status" => :ok,
             "status_code" => 0,
             "details" => "looks good",
-            "ms" => an_instance_of(Fixnum)
+            "ms" => an_instance_of(Integer)
           },
           "test2" => {
             "status" => :unknown,
             "status_code" => 3,
             "details" => "Check returned invalid status 'huh'. invalid",
-            "ms" => an_instance_of(Fixnum)
+            "ms" => an_instance_of(Integer)
           },
           "test3" => {
             "status" => :warning,
             "status_code" => 1,
             "details" => "not good",
-            "ms" => an_instance_of(Fixnum)
+            "ms" => an_instance_of(Integer)
           },
           "test4" => {
             "status" => :critical,
             "status_code" => 2,
             "details" => "on fire",
-            "ms" => an_instance_of(Fixnum)
+            "ms" => an_instance_of(Integer)
           },
           "test5" => {
             "status" => :unknown,
             "status_code" => 3,
             "details" => "no idea",
-            "ms" => an_instance_of(Fixnum)
+            "ms" => an_instance_of(Integer)
           }
         }
       })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_status
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Alex Dean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: AppStatus is a Rails engine for exposing app data to Nagios.