watcher_in_the_water 0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.0 / 2008-09-06
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/watcher_in_the_water
+lib/watcher_in_the_water.rb
+test/fixtures/dimrill_gate
+test/fixtures/durins_bridge
+test/fixtures/west_gate
+test/live.yml
+test/live_test.rb
+test/test_watcher_in_the_water.rb
+test/watcher/test.yml

data/README.rdoc

@@ -0,0 +1,34 @@
+= Watcher In The Water - http://en.wikipedia.org/wiki/Watcher_in_the_Water
+
+== Description
+
+Want to know when the page at a given URL changes? The Watcher in the
+Water will tell you over Jabber; just create a ~/.watcher/config.yml
+file and toss +watcher_in_the_water+ into your crontab!
+
+  ---
+  jid: watcher-in-the-water@jabber.org
+  password: mellon
+  recipient: phil@hagelb.org
+  urls:
+  - http://rubyconf.org
+
+== Issues
+
+XMPP4R takes a really long time to authenticate with my Jabber
+server. Maybe it's just me though... No idea. This shouldn't run more
+than once an hour or so, whatever; shouldn't matter.
+
+== Install
+
+  $ sudo gem install technomancy-watcher_in_the_water --source=http://gems.github.com
+
+== TODO
+
+* Finish live tests?
+* Just send a diff over IM?
+* Only look at a given XPath?
+
+== Author
+
+By Phil Hagelberg (http://technomancy.us)

data/Rakefile

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/watcher_in_the_water.rb'
+
+Hoe.new('watcher_in_the_water', WatcherInTheWater::VERSION) do |p|
+  p.rubyforge_name = "seattlerb"
+  p.summary = "Want to know when the page at a given URL changes?
+The Watcher in the Water will tell you over Jabber."
+  p.developer('Phil Hagelberg', 'http://technomancy.us')
+  p.url = 'http://en.wikipedia.org/wiki/Watcher_in_the_Water'
+  p.extra_deps << 'xmpp4r'
+end
+
+# vim: syntax=Ruby

data/bin/watcher_in_the_water

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/watcher_in_the_water'
+
+WatcherInTheWater.configure(ARGV.first)
+WatcherInTheWater.watch

data/lib/watcher_in_the_water.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'open-uri'
+require 'yaml'
+require 'digest/sha1'
+require 'xmpp4r'
+require 'fileutils'
+
+module WatcherInTheWater
+  include Jabber
+  VERSION = '0.1'
+
+  module_function
+
+  def configure(config = nil)
+    config = File.expand_path(config || '~/.watcher/config.yml')
+    FileUtils.cd(File.dirname(config))
+    @config = YAML.load(File.read(config))
+  rescue
+    abort "You need #{config} to contain a sender jabber ID, password,
+a recipient jabber ID, and a list of URLs in YAML format. Example:
+
+---
+jid: watcher-in-the-water@jabber.org
+password: mellon
+recipient: phil@hagelb.org
+urls: ---
+  http://rubyconf.org
+"
+  end
+
+  def watch
+    @config['urls'].each do |url|
+      content = open(url).read
+      hash = Digest::SHA1.hexdigest(content)
+      filename = 'hashes/' + url_transform(url)
+
+      if File.exist?(filename)
+        if File.read(filename) != hash
+          alert("#{url} changed to #{content[0 .. 200]}")
+        end
+      else
+        alert("Watching #{url} for you!")
+      end
+      FileUtils.mkdir_p(File.dirname(filename))
+      File.open(filename, 'w') { |f| f.write hash }
+    end
+  end
+
+  def alert(message)
+    connect
+    @client.send Message.new(@config['recipient'],
+                             message).set_type(:normal).set_id('1')
+  end
+
+  def connect
+    return if @client
+    jid = JID.new("#{@config['jid']}/#{`hostname`.chomp}-watcher")
+    @client = Client.new(jid)
+    @client.connect
+    @client.auth(@config['password'])
+  end
+
+  def url_transform(url)
+    url.gsub(/[^\w]/, '_')[0 .. 50] + '_' + Digest::SHA1.hexdigest(url)
+  end
+end

data/test/fixtures/dimrill_gate

@@ -0,0 +1 @@
+Dimrill Gate

data/test/fixtures/durins_bridge

@@ -0,0 +1 @@
+Durin's Bridge

data/test/fixtures/west_gate

@@ -0,0 +1 @@
+West Gate

data/test/live.yml

@@ -0,0 +1,6 @@
+---
+jid: test@hagelb.org
+password: mellon
+recipient: testrecipient@hagelb.org
+urls:
+- http://localhost:8123/

data/test/live_test.rb

@@ -0,0 +1,54 @@
+require 'rubygems'
+begin; gem 'miniunit'; rescue LoadError; end
+require 'test/unit'
+require 'mongrel'
+require File.dirname(__FILE__) + '/../lib/watcher_in_the_water'
+
+# launch Mongrel
+class LiveServer < Mongrel::HttpHandler
+  attr_accessor :string
+  def process(request, response)
+    response.start(200) do |head,out|
+      out.write(@string || "hello!\n")
+    end
+  end
+end
+
+MONGREL = Mongrel::HttpServer.new("0.0.0.0", "3000")
+MONGREL.register("/test", SimpleHandler.new)
+MONGREL.run
+
+class LiveTest < Test::Unit::TestCase
+  def setup
+    WatcherInTheWater.configure(File.dirname(__FILE__) + '/live.yml')
+  end
+
+  def test_live_usage
+    # should alert about all pages being watched on first run
+    # then should alert for a single change
+    # then should send no alerts if nothing's changed
+  end
+
+  def test_host_not_found
+  end
+
+  def test_404
+  end
+
+  def test_sender_jabber_down
+  end
+
+  def test_bad_auth
+  end
+
+  def test_recipient_jabber_down
+  end
+
+  def test_recipient_jid_not_found
+  end
+
+  private
+  def watch
+    system "#{File.dirname(__FILE__)}/../bin/watcher #{File.dirname(__FILE__)}/live.yml"
+  end
+end

data/test/test_watcher_in_the_water.rb

@@ -0,0 +1,60 @@
+require 'rubygems'
+begin; gem 'miniunit'; rescue LoadError; end
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/watcher_in_the_water'
+
+module WatcherInTheWater
+  # Let's mock out the Jabber connection
+  @client = Object.new
+  @messages = []
+  messages_for_closure = @messages
+
+  def @client.send(message)
+    WatcherInTheWater.messages << message
+  end
+
+  def self.messages; @messages; end
+  def self.config; @config; end
+end
+
+WatcherInTheWater.configure(File.dirname(__FILE__) + '/watcher/test.yml')
+
+class TestWatcherInTheWater < Test::Unit::TestCase
+  def setup
+    FileUtils.rm_rf('hashes')
+    FileUtils.rm_rf('fixtures')
+    FileUtils.cp_r('../fixtures', 'fixtures')
+    WatcherInTheWater.messages.clear
+  end
+
+  def test_watch_first_time
+    WatcherInTheWater.watch
+
+    ['fixtures_dimrill_gate_d2785ed5a8c89b47e541e85b7216d0153a383651',
+     'fixtures_durins_bridge_f81c948ae30baa391371150bc42cc935ebf8287c',
+     'fixtures_west_gate_cdef5d9283f6bdeddfa89de21bbca8d5acb3c673'].each do |u|
+      assert_equal 40, File.read('hashes/' + u).length
+    end
+
+    assert_equal 3, WatcherInTheWater.messages.size
+  end
+
+  def test_watch_one_change
+    WatcherInTheWater.watch
+    WatcherInTheWater.messages.clear
+
+    File.open('fixtures/durins_bridge', 'w') { |f| f.puts "Durin's Super-Bridge!" }
+    WatcherInTheWater.watch
+
+    assert_equal 1, WatcherInTheWater.messages.size
+  end
+
+  def test_watch_no_changes
+    WatcherInTheWater.watch
+    WatcherInTheWater.messages.clear
+
+    WatcherInTheWater.watch
+
+    assert_equal [], WatcherInTheWater.messages
+  end
+end

data/test/watcher/test.yml

@@ -0,0 +1,8 @@
+---
+jid: watcher-in-the-water@jabber.org
+password: mellon
+recipient: phil@hagelb.org
+urls:
+- fixtures/west_gate
+- fixtures/durins_bridge
+- fixtures/dimrill_gate

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: watcher_in_the_water
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Phil Hagelberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-07 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: 
+email: 
+- http://technomancy.us
+executables: 
+- watcher_in_the_water
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/watcher_in_the_water
+- lib/watcher_in_the_water.rb
+- test/fixtures/dimrill_gate
+- test/fixtures/durins_bridge
+- test/fixtures/west_gate
+- test/live.yml
+- test/live_test.rb
+- test/test_watcher_in_the_water.rb
+- test/watcher/test.yml
+has_rdoc: true
+homepage: http://en.wikipedia.org/wiki/Watcher_in_the_Water
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: seattlerb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Want to know when the page at a given URL changes? The Watcher in the Water will tell you over Jabber.
+test_files: 
+- test/test_watcher_in_the_water.rb