service-status 0.0.4

data/spec/service_status_spec.rb

@@ -0,0 +1,130 @@
+require 'service_status/status'
+require 'socket'
+require 'timecop'
+require 'json'
+
+describe ServiceStatus::Status do
+  before :each do
+    @version = '0.0.1'
+    @hostname = Socket.gethostname
+    @app_name = 'killer-app'
+    @instance = ServiceStatus::Status.new(@app_name, @version, Time.now)
+  end
+
+  it 'name' do
+    expect(@instance.name).to eql @app_name
+  end
+
+  it 'version' do
+    expect(@instance.version).to eql @version
+  end
+
+  it 'hostname' 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
+
+  it 'timestamp' do
+    Timecop.freeze
+    @instance = ServiceStatus::Status.new(@app_name, @version, Time.now)
+    timestamp =  Time.now.strftime '%Y-%m-%d %T'
+    expect(@instance.timestamp).to eql timestamp
+    Timecop.return
+  end
+
+  describe 'uptime' do
+    it 'seconds' do
+      Timecop.freeze
+      @instance = ServiceStatus::Status.new(@app_name, @version, Time.now)
+      Timecop.travel(Time.now + 55)
+      expect(@instance.uptime).to eql '0d:00:00:55'
+      Timecop.return
+    end
+
+    it 'minutes' do
+      Timecop.freeze
+      @instance = ServiceStatus::Status.new(@app_name, @version, Time.now)
+      Timecop.travel(Time.now + 301)
+      expect(@instance.uptime).to eql '0d:00:05:01'
+      Timecop.return
+    end
+
+    it 'hours' do
+      Timecop.freeze
+      @instance = ServiceStatus::Status.new(@app_name, @version, Time.now)
+      Timecop.travel(Time.now + 5000)
+      expect(@instance.uptime).to eql '0d:01:23:20'
+      Timecop.return
+    end
+
+    it 'days' do
+      Timecop.freeze
+      @instance = ServiceStatus::Status.new(@app_name, @version, Time.now)
+      Timecop.travel(Time.now + 100_000)
+      expect(@instance.uptime).to eql '1d:27:46:40'
+      Timecop.return
+    end
+  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
+
+  it 'status' do
+    expect(@instance.status).to eql 'online'
+  end
+
+  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\"}"
+    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 []
+      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']
+      expect(@instance.status).to eql 'offline'
+    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 []
+    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.status).to eql 'offline'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,118 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#
+
+require 'simplecov'
+SimpleCov.start
+
+SimpleCov.configure do
+      minimum_coverage '100%'
+end
+
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'vcr'
+
+VCR.configure do |c|
+  c.ignore_hosts 'codeclimate.com'
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.default_cassette_options = { match_requests_on: [:method, :uri, :body] }
+  c.before_record do |cx|
+    cx.request.headers = nil
+    cx.response.headers = nil
+  end
+
+  c.configure_rspec_metadata!
+end
+
+WebMock.disable_net_connect!(:allow => "codeclimate.com")
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow you to limit a spec run
+  #   # to individual examples or groups you care about by tagging them with
+  #   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  #   # get run.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,276 @@
+--- !ruby/object:Gem::Specification
+name: service-status
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- William Griffiths
+- Luke Farrar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys-filesystem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rb-fchange
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: When monitoring REST servers it is useful to have a standard /status
+  page. This gem provides such content.
+email:
+- william.griffiths@thebookpeople.co.uk
+- luke.farrar@thebookpeople.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/service_status/status.rb
+- lib/service_status/version.rb
+- service-status.gemspec
+- spec/cassettes/ServiceStatus_Status/add_http_get_check/ok.yml
+- spec/service_status_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/TheBookPeople/service-status-ruby
+licenses:
+- GPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Provides a simple JSON service status report.
+test_files:
+- spec/cassettes/ServiceStatus_Status/add_http_get_check/ok.yml
+- spec/service_status_spec.rb
+- spec/spec_helper.rb