service-status 0.0.4 → 1.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjZlYTdiZTI0NTllZjk1N2Y4NmVkNDRiNmUxNjQ5MjdjZmFlODM5Mw==
+    YmVlZTA1OTAxMTkyODIzMWJiMjQxMzcyOWJkZTMyNDBjZWM4MDAzOA==
   data.tar.gz: !binary |-
-    ZTQzOTllY2E0NzkyMzM1YmJkZGZkN2E0ZTU2MjM4NTc1MWYzZGJmOQ==
+    YTEyNGU4YTc1NTI0YzhkOGIyNjliMzJmZDFkMzAzNTg5YTQyMzkzZA==
 SHA512:
   metadata.gz: !binary |-
-    MDVlY2YwYzdiNWMyMzM5MjM5MzVkOThkOWNmMTc2NDI1NWM3ZTc1M2I1ZjVm
-    MWUzNDk5NDI1YmIxOWQxOWFiODY3OTBlM2UzNmYxYWRhNjA2YmUwNDdlNDUx
-    OTlkNTkwMGE2ZTk2YTI1NTUxZTYxODdkNWY0NmQxNmJiMGFmOWE=
+    YzViN2U3YmNiMTJmNzljOTE3NTk1YTgwOGM1ZDc1MTc4NzY0NzU3M2YyOGIy
+    OTE4YTFlNzI1YzQ2NDRmYThkZmI5ZWEyYjAwZDc5MDkyMjc4MTA2YzNhOTk4
+    ZWE2ODhkNDE0YWEzYjljYzcwNThmNmRiZDQxNzdiYjZmZmQ1MzI=
   data.tar.gz: !binary |-
-    NTlhM2JlOGYyZTNkZTllY2MzNjllZTBmYTUwODdiMGI1ODMzOGQ1NWUwNDI3
-    NGE4NWY1YjE3NGZiMDQwNDU1ODJkYjcxNWY0NTg4MjA5ZTI5NzM1ZmM3ZTgw
-    OTBlMjVmYmQ4NTk3MmFiNzFmMDMyODg4YmJjYzJkODQ4NjYwZjI=
+    ZTg2MjAyZGNjNzhhMWZmMTk5ZThkOTE4ZTk3OTg1ZDg0NDcyOThiMWRhODdm
+    MjZlZjRkNGY5MjNjOGZmOGY2ZjM0MTI5MDJmMDU4NmNiNzJhMjc5NjFjZjA3
+    YmExMGU4OTFjNjYzNGQxNGQ0OWNmNzA4YmUyOTQyNzUzM2QzNmM=

data/.rubocop.yml

@@ -1,3 +1,10 @@
+AllCops:
+  RunRailsCops: false
+  Exclude:
+    - 'spec/**/*'
+    - 'service-status.gemspec'
+    - 'vendor/**/*'
+
 Documentation:
   Enabled: false
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    service-status (0.0.4)
+    service-status (1.0.1)
       sys-filesystem (~> 1.1)
 
 GEM
@@ -9,10 +9,8 @@ GEM
   specs:
     addressable (2.3.8)
     ast (2.0.0)
-    astrolabe (1.3.0)
-      parser (>= 2.2.0.pre.3, < 3.0)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
     codeclimate-test-reporter (0.4.7)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
@@ -20,11 +18,11 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    ffi (1.9.8)
+    ffi (1.9.10)
     formatador (0.2.5)
-    guard (2.12.5)
+    guard (2.12.8)
       formatador (>= 0.2.4)
-      listen (~> 2.7)
+      listen (>= 2.7, <= 4.0)
       lumberjack (~> 1.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
@@ -32,14 +30,12 @@ GEM
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
-    guard-rspec (4.5.0)
+    guard-rspec (4.6.2)
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hitimes (1.2.2)
-    json (1.8.2)
-    listen (2.10.0)
-      celluloid (~> 0.16.0)
+    json (1.8.3)
+    listen (3.0.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
     lumberjack (1.0.9)
@@ -48,7 +44,7 @@ GEM
     notiffany (0.0.6)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parser (2.2.2.2)
+    parser (2.2.2.6)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.1)
     pry (0.10.1)
@@ -59,25 +55,25 @@ GEM
     rake (10.4.2)
     rb-fchange (0.0.6)
       ffi
-    rb-fsevent (0.9.4)
+    rb-fsevent (0.9.5)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
-    rubocop (0.31.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.1)
       astrolabe (~> 1.3)
-      parser (>= 2.2.2.1, < 3.0)
+      parser (>= 2.2.2.5, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
@@ -94,9 +90,7 @@ GEM
       ffi
     terminal-notifier-guard (1.6.4)
     thor (0.19.1)
-    timecop (0.7.3)
-    timers (4.0.1)
-      hitimes
+    timecop (0.7.4)
     vcr (2.9.3)
     webmock (1.21.0)
       addressable (>= 2.3.6)

data/README.md

@@ -36,7 +36,11 @@ rescue
 	redis_ok = false
 end
 
-status.add_check('redis', redis_ok)      
+#Last argument 'description' is optional
+status.add_check('redis', redis_ok, 'Can connect to Redis')
+
+#Last argument 'description' is optional
+status.add_stat('request_count', 100, 'Number of Requests')
 
 JSON.pretty_generate(status)             # render as JSON as required
 ```
@@ -49,17 +53,23 @@ they are included in 'errors' as well.
 
 ```javascript
 {
-	"name": "windows",
-	"version": "3.11",
-	"hostname": "clippy",
-	"errors": [],
-	"checks": [
-		"redis"
-	],
-	"timestamp": "2015-05-07 14:35:17",
-	"uptime": "14d:23:11:21",
-	"diskusage": "64%",
-	"status": "online"
+  "name": "windows",
+  "version": "3.11",
+  "hostname": "clippy",
+  "stats": [{
+    "name": "request_count",
+    "value": 100,
+    "description": "Number of Requests"
+  }],
+  "checks": [{
+    "name": "redis",
+    "successful": true
+    "description": "Can connect to Redis"
+  }],
+  "timestamp": "2015-05-07 14:35:17",
+  "uptime": "14d:23:11:21",
+  "diskusage": "64%",
+  "status": "online"
 }
 
 ```

data/Rakefile

@@ -24,10 +24,7 @@ task :test do
 end
 
 task :rubocop do
-  RuboCop::RakeTask.new(:rubocop) do |task|
-    task.patterns = ['lib/**/*.rb']
-    task.fail_on_error = true
-  end
+  RuboCop::RakeTask.new
 end
 
 task :gem do

data/lib/service_status/status.rb

@@ -8,7 +8,7 @@ require 'sys/filesystem'
 
 module ServiceStatus
   class Status
-    attr_reader :name, :version, :hostname, :errors, :checks, :timestamp
+    attr_reader :name, :version, :hostname, :checks, :timestamp, :stats
 
     def initialize(name, version, boot_time)
       @boot_time = boot_time
@@ -17,23 +17,33 @@ module ServiceStatus
       @hostname = Socket.gethostname
       @checks = []
       @timestamp = Time.now.strftime('%Y-%m-%d %T')
+      @stats = []
       @errors = []
     end
 
-    def add_check(name, ok)
-      @checks << name
-      @errors << name unless ok
+    def add_check(name, successful, description = nil)
+      check = { name: name, successful: successful }
+      check[:description] = description if description
+      @checks << check
+      @errors << name unless successful
     end
 
     def add_http_get_check(name, url)
-      @checks << name
+      successful = true
       uri = URI(url)
       begin
         res = Net::HTTP.get_response(uri)
-        @errors << name unless res.is_a?(Net::HTTPSuccess)
+        successful = res.is_a?(Net::HTTPSuccess)
       rescue
-        @errors << name
+        successful = false
       end
+      add_check(name, successful)
+    end
+
+    def add_stat(name, value, description = nil)
+      stat = { name: name, value: value }
+      stat[:description] = description if description
+      @stats << stat
     end
 
     def status
@@ -63,7 +73,7 @@ module ServiceStatus
         name: name,
         version: version,
         hostname: hostname,
-        errors: errors,
+        stats: stats,
         checks: checks,
         timestamp: timestamp,
         uptime: uptime,
@@ -87,7 +97,7 @@ module ServiceStatus
     end
 
     def filesystem
-      @stats ||= Sys::Filesystem.stat('/')
+      @root_filesystem ||= Sys::Filesystem.stat('/')
     end
   end
 end

data/lib/service_status/version.rb

@@ -1,3 +1,3 @@
 module ServiceStatus
-  VERSION = '0.0.4'
+  VERSION = '1.0.1'
 end

data/spec/service_status_spec.rb

@@ -4,7 +4,14 @@ require 'timecop'
 require 'json'
 
 describe ServiceStatus::Status do
+
   before :each do
+    stats = double('stats')
+    allow(stats).to receive(:blocks) { '239189165' }
+    allow(stats).to receive(:blocks_available) { '106180000' }
+    allow(Sys::Filesystem).to receive(:stat).with('/') { stats }
+    @disk_usage = '55%'
+
     @version = '0.0.1'
     @hostname = Socket.gethostname
     @app_name = 'killer-app'
@@ -23,10 +30,6 @@ describe ServiceStatus::Status do
     expect(@instance.hostname).to eql @hostname
   end
 
-  it 'errors' do
-    expect(@instance.errors).to eql []
-  end
-
   it 'checks' do
     expect(@instance.checks).to eql []
   end
@@ -74,10 +77,6 @@ describe ServiceStatus::Status do
   end
 
   it 'diskusage' do
-    stats = double('stats')
-    expect(stats).to receive(:blocks) { '239189165' }
-    expect(stats).to receive(:blocks_available) { '106180000' }
-    expect(Sys::Filesystem).to receive(:stat).with('/') { stats }
     expect(@instance.disk_usage).to eql '55%'
   end
 
@@ -88,43 +87,82 @@ describe ServiceStatus::Status do
   it 'to_json' do
     Timecop.freeze(Time.local(2015, 04, 29, 14, 52, 47))
     @instance = ServiceStatus::Status.new(@app_name, @version, Time.now)
-    stats = double('stats')
-    expect(stats).to receive(:blocks) { '239189165' }
-    expect(stats).to receive(:blocks_available) { '106180000' }
-    expect(Sys::Filesystem).to receive(:stat).with('/') { stats }
-    disk_usage = '55%'
-    expect(@instance.to_json).to eql "{\"name\":\"#{@app_name}\",\"version\":\"#{@version}\",\"hostname\":\"#{@hostname}\",\"errors\":[],\"checks\":[],\"timestamp\":\"2015-04-29 14:52:47\",\"uptime\":\"0d:00:00:00\",\"diskusage\":\"#{disk_usage}\",\"status\":\"online\"}"
+    expect(@instance.to_json).to eql %({"name":"#{@app_name}","version":"#{@version}","hostname":"#{@hostname}","stats":[],"checks":[],"timestamp":"2015-04-29 14:52:47","uptime":"0d:00:00:00","diskusage":"#{@disk_usage}","status":"online"})
     Timecop.return
   end
 
   describe 'add_check' do
     it 'had a check that was ok' do
-      @instance.add_check('ElasticSearch', true)
-      expect(@instance.checks).to eql ['ElasticSearch']
-      expect(@instance.errors).to eql []
+      @instance.add_check('elasticsearch', true)
+      expect(@instance.checks).to eql [{ name: 'elasticsearch', successful: true }]
       expect(@instance.status).to eql 'online'
     end
 
     it 'had a check that failed' do
-      @instance.add_check('ElasticSearch', false)
-      expect(@instance.checks).to eql ['ElasticSearch']
-      expect(@instance.errors).to eql ['ElasticSearch']
+      @instance.add_check('elasticsearch', false)
+      expect(@instance.checks).to eql [{ name: 'elasticsearch', successful: false }]
       expect(@instance.status).to eql 'offline'
     end
+
+    it 'supports check with description' do
+      @instance.add_check('elasticsearch', true, 'Can connect to Elasticsearch')
+      expect(@instance.checks).to eql [{ name: 'elasticsearch', successful: true, description: 'Can connect to Elasticsearch'  }]
+      expect(@instance.status).to eql 'online'
+    end
+
+
+    it 'shown in json' do
+      Timecop.freeze(Time.local(2015, 04, 29, 14, 52, 47))
+      @instance = ServiceStatus::Status.new(@app_name, @version, Time.now)
+      @instance.add_check('elasticsearch', true)
+      expect(@instance.to_json).to eql %({"name":"#{@app_name}","version":"#{@version}","hostname":"#{@hostname}","stats":[],"checks":[{"name":"elasticsearch","successful":true}],"timestamp":"2015-04-29 14:52:47","uptime":"0d:00:00:00","diskusage":"#{@disk_usage}","status":"online"})
+      Timecop.return
+    end
   end
 
   describe 'add_http_get_check', :vcr do
     it 'ok' do
       @instance.add_http_get_check('Responsys API', 'https://ws2.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl')
-      expect(@instance.checks).to eql ['Responsys API']
-      expect(@instance.errors).to eql []
+      expect(@instance.checks).to eql [{:name=>"Responsys API", :successful=>true}]
     end
 
     it 'fail' do
       @instance.add_http_get_check('Responsys API', 'https://foobar.responsys.net/webservices/wsdl/ResponsysWS_Level1.wsdl')
-      expect(@instance.checks).to eql ['Responsys API']
-      expect(@instance.errors).to eql ['Responsys API']
+      expect(@instance.checks).to eql [{:name=>"Responsys API", :successful=>false}]
       expect(@instance.status).to eql 'offline'
     end
   end
+
+  describe 'add stat' do
+
+    it 'add one' do
+      @instance.add_stat('request_counts', 100, 'Number of Requests')
+      expect(@instance.stats).to eql [{ description: 'Number of Requests', name: 'request_counts', value: 100 }]
+    end
+
+    it 'add multiple' do
+      @instance.add_stat('request_counts', 100, 'Number of Requests')
+      @instance.add_stat('error_counts', 42, 'Number of errors')
+      expect(@instance.stats).to eql [
+                                      { description: 'Number of Requests', name: 'request_counts', value: 100 },
+                                      {:name=>"error_counts", :value=>42, :description=>"Number of errors"}
+                                     ]
+    end
+
+    it 'add without description' do
+      @instance.add_stat('request_counts', 100)
+      expect(@instance.stats).to eql [{ name: 'request_counts', value: 100 }]
+    end
+
+
+
+    it 'shown in json' do
+      Timecop.freeze(Time.local(2015, 04, 29, 14, 52, 47))
+      @instance = ServiceStatus::Status.new(@app_name, @version, Time.now)
+      @instance.add_stat('request_counts', 100, 'Number of Requests')
+      expect(@instance.to_json).to eql %({"name":"#{@app_name}","version":"#{@version}","hostname":"#{@hostname}","stats":[{"name":"request_counts","value":100,"description":"Number of Requests"}],"checks":[],"timestamp":"2015-04-29 14:52:47","uptime":"0d:00:00:00","diskusage":"#{@disk_usage}","status":"online"})
+      Timecop.return
+    end
+
+  end
 end

data/spec/spec_helper.rb

@@ -22,10 +22,10 @@ require 'simplecov'
 SimpleCov.start
 
 SimpleCov.configure do
-      minimum_coverage '100%'
+  minimum_coverage '100%'
 end
 
-require "codeclimate-test-reporter"
+require 'codeclimate-test-reporter'
 CodeClimate::TestReporter.start
 
 require 'vcr'
@@ -43,7 +43,7 @@ VCR.configure do |c|
   c.configure_rspec_metadata!
 end
 
-WebMock.disable_net_connect!(:allow => "codeclimate.com")
+WebMock.disable_net_connect!(allow: 'codeclimate.com')
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service-status
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.1
 platform: ruby
 authors:
 - William Griffiths
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-filesystem