mutle-neighborhoodwatch-agent 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.swp

data/README.markdown

@@ -0,0 +1,52 @@
+## What does the NEIGHBORHOODWAT.CH agent do?
+
+Our agent is a little Ruby program that recieves URL-lists, pings them and reports the results to [NEIGHBORHOODWAT.CH][3]. There we list our user's monitored websites statuses and notify them if something goes wrong.
+
+## What do I need to run the agent?
+
+First of all, what you _don't_ need: root privileges. You do need a Unix server running the following software:
+
+1. Ruby
+2. Ruby Gems
+3. Cron
+4. and a NEIGHBORHOODWAT.CH account
+
+The agent has so far been tested on Ruby 1.8.6 only but should work on 1.9, too.
+
+## You got me convinced. How do I install the agent?
+
+Installing the agent is easy and takes just about 2 minutes.
+
+_If you're running Ubuntu_, you might have to install Cron. To do this enter the following into your console:
+
+    $ sudo apt-get install cron - on Ubuntu
+
+Start out by installing the NEIGHBORHOODWAT.CH agent gem.
+
+    $ sudo gem install mutle-neighborhoodwatch-agent --source=http://gems.github.com/
+
+Before continuing, make sure you have an ID for your agent. He needs this ID to report to the neighborhood watch. To get an ID sign into your NEIGHBORHOODWAT.CH account. Go to your [dashboard][1], click the button "Add an agent" and name him. Now, click "Add agent" and the new agent will apear in the list above. Right beneath the agent name you'll a link "Instructions". Click it and you'll open a modal containing your agent's ID. Copy it.
+
+Now that you have an agent ID, give it to your agent.
+
+    $ neighborhoodwatch-agent <agent id>
+
+Your agent is now ready to pick up work and is waiting for you to say the word. Tell him how often to check the servers in his list by configuring Cron.
+
+    $ crontab -e
+
+This will open your Crontab in a text editor. Now add the following to the bottom of the file:
+
+    */5 * * * * neighborhoodwatch-agent <agent id>
+
+What this means is that your agent will check on it's neighborhood every 5 Minutes. Replacing the 5 by 20 will result in a 20 minute interval. Many other intervals are possible. To see how to configure Crontab in more detail, please consult a [Crontab reference][2]. We encourage to use an interval of five minutes, though. _If your agent doesn't report in every 60 minutes we consider him as being down._
+
+After a couple of minutes, check your NEIGHBORHOODWAT.CH dashboard again, to see whether your agent has successfully picked up his work.
+
+## Thank you for using and supporting our monitoring network!
+  
+If you have any other issues, please contact us on Twitter [thehoodwatch](https://twitter.com/thehoodwatch) and we'll get back at you.
+
+[1]: http://neighborhoodwat.ch/dashboard (NEIGHBORHOODWAT.CH dashboard)
+[2]: http://www.mostlygeek.com/tech-reference/crontab-reference/ (Mostly Geek: Crontab reference)
+[3]: http://neighborhoodwat.ch/ (Free social website monitoring for you - NEIGHBORHOODWAT.CH)

data/bin/neighborhoodwatch-agent

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'neighborhoodwatch-agent'
+
+CLIENT_ID = ARGV[0] || "unknown"
+NeighborhoodWatch::Agent.run

data/lib/neighborhoodwatch-agent.rb

@@ -0,0 +1,73 @@
+require 'em-http'
+require 'json'
+
+module NeighborhoodWatch
+  module Agent
+
+    TIMEOUT = 20
+    SERVER = "beta.neighborhoodwat.ch"
+
+    def self.run
+       EventMachine.run {
+         http = get_list
+
+         http.callback {
+           process_list(http)
+         }
+
+       }
+    end
+
+    def self.get_list
+     EventMachine::HttpRequest.new("http://#{SERVER}/ping/#{CLIENT_ID}").get :timeout => TIMEOUT
+    end
+
+    def self.send_response(response)
+      EventMachine::HttpRequest.new("http://#{SERVER}/report/#{CLIENT_ID}").post :timeout => TIMEOUT, :body => {:reports => response}
+    end
+
+    def self.process_list(http)
+      status = http.response_header.status
+      if status == 200
+        sites = JSON.parse(http.response)
+        done if !sites || sites.size == 0
+
+        multi = EventMachine::MultiRequest.new
+        site_requests = []
+        sites.each do |site|
+          req = EventMachine::HttpRequest.new(site['url']).get(:timeout => TIMEOUT)
+          multi.add(req); site_requests << req
+        end
+        multi.callback  {
+          status = {}
+          multi.responses[:succeeded].each do |resp|
+            site = sites[site_requests.index(resp)]
+            if resp.response_header.status == 200
+              status[site['id']] = "up"
+            else
+              status[site['id']] = "error-#{resp.response_header.status}"
+            end
+          end
+          multi.responses[:failed].each do |resp|
+            site = sites[site_requests.index(resp)]
+            status[site['id']] = "down"
+          end
+
+          http = send_response(status)
+          http.callback {
+            done
+          }
+        }
+
+      else
+        puts "ERROR: #{http.response}" if status == 403
+        done
+      end
+    end
+
+    def self.done
+      EventMachine.stop
+    end
+
+  end
+end

data/neighborhoodwatch-agent.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+ 
+Gem::Specification.new do |s|
+  s.name = %q{neighborhoodwatch-agent}
+  s.version = "0.0.1"
+ 
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mutwin Kraus"]
+  s.date = %q{2009-08-23}
+  s.email = %q{mutle@redcursor.de}
+  s.executables = ["neighborhoodwatch-agent"]
+  s.extra_rdoc_files = []
+  s.files = [
+     ".gitignore",
+     "README.markdown",
+     "bin/neighborhoodwatch-agent",
+     "lib/neighborhoodwatch-agent.rb",
+     "neighborhoodwatch-agent.gemspec"
+  ]
+  s.homepage = %q{http://neighborhoodwat.ch/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Client for the the neighborhoodwat.ch web service}
+  s.test_files = []
+ 
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+ 
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: mutle-neighborhoodwatch-agent
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mutwin Kraus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mutle@redcursor.de
+executables: 
+- neighborhoodwatch-agent
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README.markdown
+- bin/neighborhoodwatch-agent
+- lib/neighborhoodwatch-agent.rb
+- neighborhoodwatch-agent.gemspec
+has_rdoc: false
+homepage: http://neighborhoodwat.ch/
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Client for the the neighborhoodwat.ch web service
+test_files: []
+