uri-health 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cc59d728b88a63fa3122b2e8b6e517c064cdbea
+  data.tar.gz: 8c0de25d0eaa2b492efc1f801138d19169f99f1d
+SHA512:
+  metadata.gz: 1fb3a80b3b2a50f977ad952afc2b9ea824ac79101609a1ffdd3792c80354bb0e5503458830ba3bfc2fa6c50c007e5ebf6f77c31daab205561e1a989bd171392d
+  data.tar.gz: 145d217e686602a8cd4b59d488c62ad9f35040ff1af2a8810512d3b9b053458b636743818a4768d335b40160667b9b75fa4dda170005415cc5f998a5ab1db296

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uri-health.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Snape
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Uri::Health
+
+A really easy way to monitor the health of a list of endpoints over time.
+
+## Installation and Usage
+
+Add to your Gemfile:
+
+    gem 'uri-health'
+
+Create a YAML file of the URIs you wish to monitor:
+
+    - http://www.google.co.uk
+    - http://www.yahoo.co.uk
+    - http://www.itv.com
+    - http://www.itv.com/news/uk/
+
+Include the path to your YAML file when executing the code:
+
+    Uri::Health::Status.new('spec/support/uris.yaml').go
+
+The status codes are returned in a hash and written to `uri-health/last_run.json`:
+
+    {
+        "http://www.google.co.uk": 200,
+        "http://www.yahoo.co.uk": 200,
+        "http://www.itv.com": 200,
+        "http://www.itv.com/news/uk/": 200
+    }
+
+## TODO
+
+1. Introduce polling over time
+2. Test connection error cases
+3. Parse URIs
+4. A pretty report
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/uri-health/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/uri/health.rb

@@ -0,0 +1,6 @@
+require_relative 'health/version'
+require_relative 'health/status'
+
+require 'httparty'
+require 'yaml'
+require 'json'

data/lib/uri/health/status.rb

@@ -0,0 +1,32 @@
+module Uri
+
+  module Health
+
+    class Status
+
+      def initialize(path_to_yaml)
+        @uris = YAML.load_file(path_to_yaml)
+      end
+
+      def go
+        responses = {}
+        @uris.each do |uri|
+          responses.merge!({uri => HTTParty.get(uri).code})
+        end
+
+        output_json(responses)
+        responses
+      end
+
+      def output_json(output)
+        Dir.mkdir 'uri-health' unless File.directory? 'uri-health'
+        File.open('uri-health/last_run.json', 'w') do |f|
+          f.write(output.to_json)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/uri/health/version.rb

@@ -0,0 +1,9 @@
+module Uri
+
+  module Health
+
+    VERSION = '0.0.1'
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'uri/health'
+
+require 'rspec'

data/spec/support/uris.yaml

@@ -0,0 +1,4 @@
+- http://www.google.co.uk
+- http://www.yahoo.co.uk
+- http://www.itv.com
+- http://www.itv.com/news/uk/

data/spec/uri_health_spec.rb

@@ -0,0 +1,16 @@
+require_relative 'spec_helper'
+
+describe Uri::Health do
+
+  it 'should read URIs from a YAML file and return a hash with status codes' do
+    responses = Uri::Health::Status.new('spec/support/uris.yaml').go
+    responses.each { |uri, status_code| status_code.should be_a_kind_of(Fixnum) }
+  end
+
+  it 'should generate a JSON run report' do
+    response = Uri::Health::Status.new('spec/support/uris.yaml').go
+    generated_json_file = File.read 'uri-health/last_run.json'
+    response.to_json.should == generated_json_file
+  end
+
+end

data/uri-health.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uri/health/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'uri-health'
+  spec.version       = Uri::Health::VERSION
+  spec.authors       = ['Ben Snape']
+  spec.email         = %w(bsnape@gmail.com)
+  spec.summary       = %w{Monitor the health of URI's}
+  spec.description   = %w{Easily monitor the health of arbitrary URI's defined in YAML config}
+  spec.homepage      = 'http://www.bensnape.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency 'httparty', '~> 0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 2'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: uri-health
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Snape
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: "[\"Easily\", \"monitor\", \"the\", \"health\", \"of\", \"arbitrary\",
+  \"URI's\", \"defined\", \"in\", \"YAML\", \"config\"]"
+email:
+- bsnape@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uri/health.rb
+- lib/uri/health/status.rb
+- lib/uri/health/version.rb
+- spec/spec_helper.rb
+- spec/support/uris.yaml
+- spec/uri_health_spec.rb
+- uri-health.gemspec
+homepage: http://www.bensnape.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: "[\"Monitor\", \"the\", \"health\", \"of\", \"URI's\"]"
+test_files:
+- spec/spec_helper.rb
+- spec/support/uris.yaml
+- spec/uri_health_spec.rb