uptimr 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    uptimr (0.1.0)
+      httparty
+      multi_json (~> 1.7.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.13)
+    coderay (1.0.9)
+    httparty (0.11.0)
+      multi_json (~> 1.0)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.5)
+    metaclass (0.0.1)
+    method_source (0.8.1)
+    minitest (4.7.5)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.9)
+    multi_xml (0.5.5)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.5)
+    shoulda-matchers (2.3.0)
+      activesupport (>= 3.0.0)
+    slop (3.4.4)
+    test-unit (2.5.5)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 0.14.0)
+  pry
+  rake
+  shoulda (~> 3.5.0)
+  test-unit
+  uptimr!

data/README.md

@@ -0,0 +1,61 @@
+# Uptimr
+
+Uptimr is a *very* basic Ruby wrapper for the most excellent [Uptime](https://github.com/fzaninotto/uptime), a Node.js remote application monitoring tool. This wrapper is designed to import data using Uptime's API and transform points more familiar Ruby types
+
+## Installation
+
+```ruby
+gem install uptimr
+```
+
+or put it in your Gemfile
+
+```ruby
+gem "uptimr"
+```
+
+Then initialize Uptimr to point to your Uptime API
+
+```ruby
+Uptimr.config |config| do
+	config.base_url = "https://yoursite.com/status"
+end
+```
+
+## Usage
+
+To download your entire list of checks and its associated data
+
+```ruby
+Uptimr::Check.list
+```
+
+This will return an array of check objects with the following attributes
+
+* id (String) API id for check
+* is_up (Boolean) Indicates if service currently responds to ping
+* first_tested (Time) Time when this check was first tested
+* last_tested (Time) Time when this check was last tested
+* name (String) Name of the check
+* url (String) URL of the check
+* count (Number) Number of samples taken to calculate statistical data
+* responsiveness (Number) % responsiveness of service in a number ranging 0..1
+* response_time (Number) The mean response time in ms
+* availability (Number) % uptime of service in a number ranging 0..1
+
+Note that this wrapper doesn't currently pull hourly, daily or monthly data yet
+
+To look up an individual check by id number, use the following
+
+```ruby
+Uptimr::Check.find(id)
+```
+
+## Todo
+
+* Allow for basic HTTP authentication
+* Pull hourly, daily & monthly data on checks
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << "test"
+	t.test_files = FileList['test/test*.rb']
+	t.verbose = true
+end

data/lib/uptimr/check.rb

@@ -0,0 +1,55 @@
+require 'time'
+
+module Uptimr
+	class Check
+		attr_accessor :id, :is_up, :last_tested, :name, :responsiveness, 
+								:response_time, :availability, :url, :count,
+								:daily_stats, :hourly_stats, :monthly_stats, :first_tested
+
+		def initialize(params)
+			@id = params[:_id]
+			@is_up = params[:isUp]
+			@first_tested = Time.iso8601(params[:firstTested]).localtime
+			@last_tested = Time.iso8601(params[:lastTested]).localtime
+			@name = params[:name]
+			@url = params[:url]
+			@responsiveness = params[:qos][:responsiveness].to_f
+			@response_time = params[:qos][:responseTime].to_f
+			@availability = params[:qos][:availability].to_f
+			@count = params[:qos][:count]
+		end
+
+		def self.list
+			response = Uptimr.request "/api/checks", method: :get
+			response.map { |check| self.new check }
+		end
+
+		def self.find(id)
+			self.new Uptimr.request "/api/checks/#{id}", method: :get
+		end
+
+		def get_hourly_stats(from=0, to=Time.now)
+			@hourly_stats ||= Uptimr.request "/api/checks/#{@id}/stats/hour?begin=#{to_ms from}&end=#{to_ms to}", method: :get
+		end
+
+		def get_daily_stats(from=0, to=Time.now)
+			@daily_stats ||= Uptimr.request "/api/checks/#{@id}/stats/day?begin=#{to_ms from}&end=#{to_ms to}", method: :get
+		end
+
+		def get_monthly_stats(from=0, to=Time.now)
+			@monthly_stats ||= Uptimr.request "/api/checks/#{@id}/stats/month?begin=#{to_ms from}&end=#{to_ms to}", method: :get
+		end
+
+		def reload_stats
+			get_hourly_stats if @hourly_stats.nil?
+			get_daily_stats if @daily_stats.nil?
+			get_monthly_stats if @monthly_stats.nil?
+		end
+		
+		private
+
+		def to_ms(time)
+			time.to_i * 1000
+		end
+	end
+end

data/lib/uptimr/error.rb

@@ -0,0 +1,5 @@
+module Uptimr
+	class UptimrError < StandardError
+		
+	end
+end

data/lib/uptimr/util.rb

@@ -0,0 +1,21 @@
+module Uptimr
+	class Util
+
+		def self.keys_to_sym(raw)			
+			case raw
+			when Hash
+				temp = {}
+				raw.each do |key, value|
+					key = (key.to_sym rescue key) || key
+					temp[key] = keys_to_sym value
+				end
+				temp
+			when Array
+				raw.map { |elem| keys_to_sym(elem) }
+			else
+				raw
+			end
+		end
+		
+	end
+end

data/lib/uptimr/version.rb

@@ -0,0 +1,3 @@
+module Uptimr
+	VERSION = '0.1.0'
+end

data/lib/uptimr.rb

@@ -0,0 +1,49 @@
+require 'httparty'
+require 'multi_json'
+require 'uri'
+require 'cgi'
+
+require 'uptimr/version'
+require 'uptimr/error'
+require 'uptimr/util'
+require 'uptimr/check'
+
+module Uptimr
+	class << self
+		attr_accessor :base_url
+	end
+
+	def self.config
+		yield self
+	end
+
+	def self.request(path, options={})
+		handle_error "You have not set your API url" if base_url.nil?
+		handle_error "Invalid HTTP method" unless %w(get post).include? options[:method].to_s
+
+		options.merge! url: "#{base_url}#{path}"
+
+		puts "About to request: #{options[:url]}"
+		response = generate_request(options)
+
+		parse response.body
+	end
+
+	def self.parse(raw_json)
+		begin
+			Util.keys_to_sym MultiJson.load(raw_json)
+		rescue MultiJson::DecodeError => e
+			handle_error("JSON is buggered")
+		end
+	end
+
+	def self.handle_error(error)
+		raise Uptimr::UptimrError.new(error)
+	end
+
+	private 
+
+	def self.generate_request(options)
+		HTTParty.send options[:method], options[:url], options
+	end
+end

data/test/test_data/check.json

@@ -0,0 +1 @@
+{"__v":0,"_id":"521e420d4473195a11000229","firstTested":"2013-08-28T18:31:52.242Z","isUp":true,"lastChanged":"2013-08-31T15:21:04.062Z","lastTested":"2013-08-31T17:09:06.199Z","name":"Website","type":"https","url":"https://ideal-postcodes.co.uk/","downtime":0,"uptime":6482137,"isPaused":false,"tags":[],"errorCount":2,"alertTreshold":2,"maxTime":1500,"interval":60000}

data/test/test_data/checks.json

@@ -0,0 +1 @@
+[{"__v":0,"_id":"521e420d4473195a11000229","firstTested":"2013-08-28T18:31:52.242Z","isUp":true,"lastChanged":"2013-08-31T15:21:04.062Z","lastTested":"2013-08-31T16:41:05.574Z","name":"Website","qos":{"check":"521e420d4473195a11000229","timestamp":1377880892640,"count":1440,"responsiveness":0.9951388888888889,"responseTime":174.45625,"downtime":0,"availability":1},"type":"https","url":"https://ideal-postcodes.co.uk/","downtime":0,"uptime":4801512,"isPaused":false,"tags":[],"errorCount":2,"alertTreshold":2,"maxTime":1500,"interval":60000},{"__v":0,"_id":"521e42264473195a1100022e","firstTested":"2013-08-28T18:32:07.218Z","isUp":true,"lastChanged":"2013-08-31T10:44:12.765Z","lastTested":"2013-08-31T16:41:20.638Z","name":"API","qos":{"check":"521e42264473195a1100022e","timestamp":1377880892640,"count":1440,"responsiveness":0.9958333333333333,"responseTime":95.44097222222223,"downtime":0,"availability":1},"type":"https","url":"https://api.ideal-postcodes.co.uk/","downtime":0,"uptime":21427873,"isPaused":false,"tags":[],"errorCount":2,"alertTreshold":2,"maxTime":1500,"interval":60000}]

data/test/test_helper.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+require 'mocha/setup'
+require 'uptimr'
+require 'shoulda'
+
+module UpTimr
+	attr_accessor :mock
+
+	def self.mock=(mock)
+		@mock = mock
+	end
+
+	def self.generate_request(options)
+		@mock.execute options[:method], options
+	end
+end
+
+def test_response(body, status=200)
+	body = MultiJson.dump(body)
+	m = mock
+	m.instance_variable_set('@instance_vals', { code: status, body: body})
+	def m.body; @instance_vals[:body]; end
+	def m.code; @instance_vals[:code]; end
+	m
+end
+
+def checks
+	File.read(File.expand_path('../test_data/checks.json', __FILE__))
+end
+
+def check
+	File.read(File.expand_path('../test_data/check.json', __FILE__))
+end
+
+def pings
+	
+end
+
+def events
+	
+end

data/test/test_uptimr.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../test_helper', __FILE__)
+
+
+class TestUptimr < Test::Unit::TestCase
+	context "Utils" do
+		test_data = {
+			"ping" => "pong",
+			"ping" => ["pong", "pong", "pong"],
+			"ping" => {
+				"pong" => "pang",
+				"pong" => "pang"
+			}
+		}
+
+		expected_result = {
+			ping: "pong",
+			ping: ["pong", "pong", "pong"],
+			ping: {
+				pong: "pang",
+				pong: "pang"
+			}
+		}
+
+		should "convert keys to symbols" do
+			result = Uptimr::Util.keys_to_sym test_data
+			assert_equal expected_result, result
+		end
+	end
+
+	context "Invalid request attributes" do
+		should "throw an error if invalid http method" do
+			assert_raises Uptimr::UptimrError do
+				Uptimr::Check.list
+			end
+		end
+	end
+
+	context "API with valid credential" do
+		setup do
+			Uptimr.config do |config|
+				config.base_url = "status.ideal-postcodes.co.uk"
+			end
+		end	
+
+		teardown do
+			Uptimr.config do |config|
+				config.base_url = nil
+			end	
+		end
+
+		should "throw an error if no URL" do
+			assert_raises Uptimr::UptimrError do
+				Uptimr::Check.list
+			end
+		end
+
+	end
+
+end

data/uptimr.gemspec

@@ -0,0 +1,25 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'uptimr/version'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'uptimr'
+  s.version = Uptimr::VERSION
+  s.summary = 'Wrapper for the Uptime'
+  s.description = 'Wrapper for the Uptime, a great remote monitoring tool written in node.js. See https://github.com/fzaninotto/uptime'
+  s.authors = ['Chris Blanchard']
+  s.email = ['cablanchard@gmail.com']
+  s.homepage = 'https://github.com/cblanc/uptimr'
+
+  s.add_dependency('httparty')
+  s.add_dependency('multi_json', '~> 1.7.9')
+
+  s.add_development_dependency('mocha', '~> 0.14.0')
+  s.add_development_dependency('test-unit')
+  s.add_development_dependency('shoulda', '~> 3.5.0')
+  s.add_development_dependency('rake')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: uptimr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Blanchard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for the Uptime, a great remote monitoring tool written in node.js.
+  See https://github.com/fzaninotto/uptime
+email:
+- cablanchard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/uptimr.rb
+- lib/uptimr/check.rb
+- lib/uptimr/error.rb
+- lib/uptimr/util.rb
+- lib/uptimr/version.rb
+- test/test_data/check.json
+- test/test_data/checks.json
+- test/test_helper.rb
+- test/test_uptimr.rb
+- uptimr.gemspec
+homepage: https://github.com/cblanc/uptimr
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Wrapper for the Uptime
+test_files:
+- test/test_data/check.json
+- test/test_data/checks.json
+- test/test_helper.rb
+- test/test_uptimr.rb