RubyGems - herald - Versions diffs - 0.1 → 0.2 - Mend

herald 0.1 → 0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

data/LICENSE +22 -0
data/README.md +72 -59
data/Rakefile +1 -1
data/TODO.txt +5 -3
data/herald.gemspec +15 -5
data/lib/herald.rb +32 -12
data/lib/herald/notifiers/callback.rb +5 -1
data/lib/herald/notifiers/growl.rb +19 -15
data/lib/herald/notifiers/ping.rb +14 -33
data/lib/herald/notifiers/post.rb +31 -19
data/lib/herald/untitled.txt +5 -0
data/lib/herald/version.rb +1 -1
data/lib/herald/watcher.rb +17 -15
data/lib/herald/watchers/rss.rb +12 -5
data/lib/herald/watchers/twitter.rb +6 -5
data/lib/herald/watchers/website.rb +95 -0
data/test/herald_test.rb +3 -9
data/test/mocks/rss.xml +19 -0
data/test/mocks/web.html +17 -0
data/test/notifier_callback_test.rb +29 -0
data/test/notifier_growl_test.rb +22 -0
data/test/notifier_ping_test.rb +30 -0
data/test/notifier_post_test.rb +30 -0
data/test/notifier_stdout_test.rb +26 -0
data/test/notifier_test.rb +38 -0
data/test/watcher_rss_test.rb +59 -0
data/test/watcher_test.rb +74 -0
data/test/watcher_twitter_test.rb +17 -0
data/test/watcher_website_test.rb +33 -0
metadata +56 -25
data/lib/herald/watchers/imap.rb +0 -55

data/test/mocks/rss.xml ADDED Viewed

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<rss version="2.0">
+<channel>
+        <title>RSS Title</title>
+        <description>This is an example of an RSS feed</description>
+        <link>http://www.someexamplerssdomain.com/main.html</link>
+        <lastBuildDate>Mon, 06 Sep 2010 00:01:00 +0000 </lastBuildDate>
+        <pubDate>Mon, 06 Sep 2009 16:45:00 +0000 </pubDate>
+        <item>
+                <title>Text in the title</title>
+                <description>This is some text in the description.</description>
+                <link>http://www.wikipedia.org/</link>
+                <guid>unique string per item</guid>
+                <pubDate>Mon, 06 Sep 2009 16:45:00 +0000 </pubDate>
+        </item>
+</channel>
+</rss>

data/test/mocks/web.html ADDED Viewed

@@ -0,0 +1,17 @@
+<html>
+<head>
+	<title>Title</title>
+</head>
+<body>
+  <div>
+    <p>
+      <span id="here">Keyword</span>
+      Another keyword
+    </p>
+  </div>
+<!-- intentionally malformed -->

data/test/notifier_callback_test.rb ADDED Viewed

@@ -0,0 +1,29 @@
+# start tests by 'rake test' on root path
+require 'herald/notifiers/callback'
+describe Herald::Watcher::Notifier::Callback do
+  after do
+    Herald.clear
+  end
+  describe "basic initialisation" do
+    it "action() must take a block" do
+      Herald.watch_twitter do
+         _for "#herald"
+         action {}
+       end
+    end
+    it "must make Herald::Item available if block contains a parameter" do
+      Herald.watch_twitter do
+         _for "#herald"
+         action do |p|
+           p.must_be_kind_of(Herald::Item)
+           p.data.must_be_kind_of(Hash)
+         end
+       end
+    end
+  end
+end

data/test/notifier_growl_test.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# start tests by 'rake test' on root path
+# only run this test on mac os
+if RUBY_PLATFORM.downcase.include?("darwin")
+  require 'herald/notifiers/growl'
+  describe Herald::Watcher::Notifier::Growl do
+    after do
+      Herald.clear
+    end
+    describe "basic initialisation" do
+      it "must lazy load ruby-growl" do
+        Herald.watch_twitter { _for "#herald"; action :growl }
+        defined?(Growl).must_equal("constant")
+      end
+    end
+  end
+end

data/test/notifier_ping_test.rb ADDED Viewed

@@ -0,0 +1,30 @@
+# start tests by 'rake test' on root path
+require 'herald/notifiers/ping'
+describe Herald::Watcher::Notifier::Ping do
+  after do
+    Herald.clear
+  end
+  describe "basic initialisation" do
+    it "must throw an acception if no 'uri' param is given" do
+      assert_raises(ArgumentError) do
+        Herald.watch_twitter { _for "example"; action :ping }
+      end
+    end
+    it "must allow uri, uris, url and urls" do
+      Herald.watch_twitter { _for "example"; action(:ping, :uri => "test.com") }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:ping, :uris => ["test.com", "example.com"]) }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:ping, :url => "test.com") }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:ping, :urls => ["test.com", "example.com"]) }.must_be_kind_of(Herald)
+    end
+    it "must be able to resolve various non-perfect uris" do
+      Herald.watch_twitter { _for "example"; action(:ping, :uri => "test.com") }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:ping, :uri => "http://test.com") }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:ping, :uri => "http://test.com/resource") }.must_be_kind_of(Herald)
+    end
+  end
+end

data/test/notifier_post_test.rb ADDED Viewed

@@ -0,0 +1,30 @@
+# start tests by 'rake test' on root path
+require 'herald/notifiers/post'
+describe Herald::Watcher::Notifier::Post do
+  after do
+    Herald.clear
+  end
+  describe "basic initialisation" do
+    it "must throw an acception if no 'uri' param is given" do
+      assert_raises(ArgumentError) do
+        Herald.watch_twitter { _for "example"; action :post }
+      end
+    end
+    it "must allow uri, uris, url and urls" do
+      Herald.watch_twitter { _for "example"; action(:post, :uri => "test.com") }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:post, :uris => ["test.com", "example.com"]) }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:post, :url => "test.com") }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:post, :urls => ["test.com", "example.com"]) }.must_be_kind_of(Herald)
+    end
+    it "must be able to resolve various non-perfect uris" do
+      Herald.watch_twitter { _for "example"; action(:post, :uri => "test.com") }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:post, :uri => "http://test.com") }.must_be_kind_of(Herald)
+      Herald.watch_twitter { _for "example"; action(:post, :uri => "http://test.com/resource") }.must_be_kind_of(Herald)
+    end
+  end
+end

data/test/notifier_stdout_test.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# start tests by 'rake test' on root path
+require 'herald/notifiers/stdout'
+describe Herald::Watcher::Notifier::Stdout do
+  after do
+    Herald.clear
+  end
+  describe "basic initialisation" do
+    it "must accept a file parameter" do
+      file = File.join(File.dirname(__FILE__), "mocks" "stdout.txt")
+      # clean up any previous test
+      begin
+        File.delete(file)
+      rescue Errno::ENOENT => e
+        # do nothing
+      end
+      File.exists?(file).must_equal(false)
+      Herald.watch_twitter { _for "#herald"; action(:stdout, :file => file) }
+      File.exists?(file).must_equal(true)
+      File.delete(file)
+    end
+  end
+end

data/test/notifier_test.rb ADDED Viewed

@@ -0,0 +1,38 @@
+# start tests by 'rake test' on root path
+describe Herald::Watcher::Notifier do
+  before do
+    @notifier = Herald::Watcher::Notifier.new(:callback, {})
+  end
+  after do
+    Herald.clear
+  end
+  describe "basic initialisation" do
+    it "must have a default notifier value" do
+       Herald::Watcher::Notifier::DEFAULT_NOTIFIER.must_equal(:stdout)
+    end
+    it "must throw an error if type of notifier unexpected" do
+      assert_raises(ArgumentError) do
+        Herald::Watcher::Notifier.new(:invalid, {})
+      end
+    end
+    it "must not throw an error if type of notifier is expected" do
+      @notifier.must_be_kind_of(Herald::Watcher::Notifier)
+    end
+  end
+  describe "initialisation through Herald#watch" do
+    it "must be passed variables from the Herald class" do
+      notifier = Herald.watch_twitter do
+        _for "#herald"
+        action {}
+      end.watchers.first.notifiers.first
+      notifier.must_be_kind_of(Herald::Watcher::Notifier)
+    end
+  end
+end

data/test/watcher_rss_test.rb ADDED Viewed

@@ -0,0 +1,59 @@
+# start tests by 'rake test' on root path
+require 'herald/watchers/rss'
+describe Herald::Watcher::Rss do
+  after do
+    Herald.clear
+  end
+  describe "initialisation" do
+    it "must throw an acception if no 'from' param is given" do
+      assert_raises(ArgumentError) do
+        Herald.watch_rss { _for "example" }
+      end
+    end
+    it "must load Crack and URI libraries" do
+      defined?(Crack).must_equal("constant")
+      defined?(URI).must_equal("constant")
+    end
+    it "must accept array of uris" do
+      herald = Herald.watch_rss(:from => ["test/mocks/rss.xml", "test/mocks/rss2.xml"]) { _for "example" }
+      herald.watchers.first.uris.must_be_kind_of(Array)
+    end
+    it "must map escape URI strings" do
+      uri = "http://example.com/#character"
+      herald = Herald.watch_rss(:from => uri) { _for "example" }
+      herald.watchers.first.uris.first.wont_match(uri)
+      herald.watchers.first.uris.first.must_match(URI.encode(uri))
+    end
+  end
+  describe "activities" do
+    it "must find keywords in title of rss" do
+      skip("@items appears as empty because anything assigned in the process fork can't be accessed outside it")
+      herald = Herald.once do
+        check :rss, :from => "test/mocks/rss.xml"
+        _for ["text", "title"]
+      end
+      herald.watchers.first.items.wont_be_empty
+    end
+    it "must find keywords in description of rss" do
+      skip("@items appears as empty because anything assigned in the process fork can't be accessed outside it")
+      herald = Herald.once do
+        check :rss, :from => "test/mocks/rss.xml"
+        _for ["some", "text", "description"]
+      end
+      herald.watchers.first.items.wont_be_empty
+    end
+    it "must return no results if keywords don't match" do
+      skip("@items appears as empty because anything assigned in the process fork can't be accessed outside it")
+      herald = Herald.once do
+        check :rss, :from => "test/mocks/rss.xml"
+        _for ["no such", "match"]
+      end
+      herald.watchers.first.items.must_be_empty
+    end
+  end
+end

data/test/watcher_test.rb ADDED Viewed

@@ -0,0 +1,74 @@
+# start tests by 'rake test' on root path
+describe Herald::Watcher do
+  before do
+    @watcher = Herald::Watcher.new(:twitter, {})
+  end
+  after do
+    Herald.clear
+  end
+  describe "basic initialisation" do
+    it "must have a default timer value" do
+       Herald::Watcher::DEFAULT_TIMER.must_equal(60)
+    end
+    it "must throw an error if no options are passed in" do
+      assert_raises(ArgumentError) do
+        Herald::Watcher.new(:twitter)
+      end
+    end
+    it "must throw an error if type of watcher unexpected" do
+      assert_raises(ArgumentError) do
+        Herald::Watcher.new(:invalid, {})
+      end
+    end
+    it "must not throw an error if type of watcher is expected" do
+      @watcher.must_be_kind_of(Herald::Watcher)
+    end
+    it "must make some variables available" do
+      @watcher.type.must_equal(:twitter)
+      @watcher.timer.must_equal(Herald::Watcher::DEFAULT_TIMER)
+    end
+  end
+  describe "initialisation through Herald#watch" do
+    it "must be passed variables from the Herald class" do
+      watcher = Herald.watch_twitter { _for "test"; every 2 =>  "minutes" }.watchers.first
+      watcher.keep_alive.must_equal(true)
+      watcher.timer.must_equal(120)
+    end
+  end
+  describe "test every() method" do
+    it "must convert seconds, minutes, hours and days into quantities of seconds" do
+      @watcher.every(2 => "seconds").timer.must_equal(2)
+      @watcher.every(2 => "minutes").timer.must_equal(2*60)
+      @watcher.every(2 => "hours").timer.must_equal(2*60*60)
+      @watcher.every(2 => "days").timer.must_equal(2*60*60*24)
+    end
+    it "must allow non-pluralised variations" do
+      @watcher.every(2 => "second").timer.must_equal(2)
+      @watcher.every(2 => "minute").timer.must_equal(2*60)
+      @watcher.every(2 => "hour").timer.must_equal(2*60*60)
+      @watcher.every(2 => "day").timer.must_equal(2*60*60*24)
+    end
+  end
+  describe " every() method" do
+    it "must convert seconds, minutes, hours and days into quantities of seconds" do
+      @watcher.every(2 => "seconds").timer.must_equal(2)
+      @watcher.every(2 => "minutes").timer.must_equal(2*60)
+      @watcher.every(2 => "hours").timer.must_equal(2*60*60)
+      @watcher.every(2 => "days").timer.must_equal(2*60*60*24)
+    end
+    it "must allow non-pluralised variations" do
+      @watcher.every(2 => "second").timer.must_equal(2)
+      @watcher.every(2 => "minute").timer.must_equal(2*60)
+      @watcher.every(2 => "hour").timer.must_equal(2*60*60)
+      @watcher.every(2 => "day").timer.must_equal(2*60*60*24)
+    end
+  end
+end

data/test/watcher_twitter_test.rb ADDED Viewed

@@ -0,0 +1,17 @@
+# start tests by 'rake test' on root path
+require 'herald/watchers/twitter'
+describe Herald::Watcher::Twitter do
+  after do
+    Herald.clear
+  end
+  describe "initialisation" do
+    it "must load Crack and URI libraries" do
+      defined?(Crack).must_equal("constant")
+      defined?(URI).must_equal("constant")
+    end
+  end
+end

data/test/watcher_website_test.rb ADDED Viewed

@@ -0,0 +1,33 @@
+# start tests by 'rake test' on root path
+require 'herald/watchers/website'
+describe Herald::Watcher::Website do
+  after do
+    Herald.clear
+  end
+  describe "initialisation" do
+    it "must throw an acception if no 'from' param is given" do
+      assert_raises(ArgumentError) do
+        Herald.watch_website { _for "example" }
+      end
+    end
+    it "must load open-uri hpricot and Crack libraries" do
+      defined?(Crack).must_equal("constant")
+      defined?(URI).must_equal("constant")
+      defined?(Hpricot).must_equal("constant")
+    end
+    it "must accept array of uris" do
+      herald = Herald.watch_website(:from => ["test/mocks/web.html", "test/mocks/web.html"]) { _for "example" }
+      herald.watchers.first.uris.must_be_kind_of(Array)
+    end
+    it "must map escape URI strings" do
+      uri = "http://example.com/#character"
+      herald = Herald.watch_website(:from => uri) { _for "example" }
+      herald.watchers.first.uris.first.wont_match(uri)
+      herald.watchers.first.uris.first.must_match(URI.encode(uri))
+    end
+  end
+end

metadata CHANGED Viewed

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: herald
 version: !ruby/object:Gem::Version
-  hash: 9
   prerelease:
-  segments:
-  - 0
-  - 1
-  version: "0.1"
+  version: "0.2"
 platform: ruby
 authors:
 - Luke Duncalfe
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-04-14 00:00:00 +12:00
+date: 2011-05-03 00:00:00 +12:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -25,9 +21,6 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        hash: 3
-        segments:
-        - 0
         version: "0"
   type: :development
   version_requirements: *id001
@@ -39,24 +32,45 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        hash: 3
-        segments:
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
-description: Pass Herald some keywords and sources to watch, and Herald will notify you using Growl, email, pinging a site, or running Ruby code as soon as those keywords appear
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: "0.8"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: ruby-growl
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id004
+description: A simple and flexible notifier for Twitter, RSS, or email
 email:
 - lduncalfe@eml.cc
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
 - .gitignore
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - TODO.txt
@@ -69,12 +83,25 @@ files:
 - lib/herald/notifiers/ping.rb
 - lib/herald/notifiers/post.rb
 - lib/herald/notifiers/stdout.rb
+- lib/herald/untitled.txt
 - lib/herald/version.rb
 - lib/herald/watcher.rb
-- lib/herald/watchers/imap.rb
 - lib/herald/watchers/rss.rb
 - lib/herald/watchers/twitter.rb
+- lib/herald/watchers/website.rb
 - test/herald_test.rb
+- test/mocks/rss.xml
+- test/mocks/web.html
+- test/notifier_callback_test.rb
+- test/notifier_growl_test.rb
+- test/notifier_ping_test.rb
+- test/notifier_post_test.rb
+- test/notifier_stdout_test.rb
+- test/notifier_test.rb
+- test/watcher_rss_test.rb
+- test/watcher_test.rb
+- test/watcher_twitter_test.rb
+- test/watcher_website_test.rb
 has_rdoc: true
 homepage: http://github.com/lukes/herald
 licenses: []
@@ -89,21 +116,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      hash: 3
-      segments:
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      hash: 23
-      segments:
-      - 1
-      - 3
-      - 6
-      version: 1.3.6
+      version: "0"
 requirements: []
 rubyforge_project: herald
@@ -113,3 +132,15 @@ specification_version: 3
 summary: A simple notifier for Twitter, RSS, or email
 test_files:
 - test/herald_test.rb
+- test/mocks/rss.xml
+- test/mocks/web.html
+- test/notifier_callback_test.rb
+- test/notifier_growl_test.rb
+- test/notifier_ping_test.rb
+- test/notifier_post_test.rb
+- test/notifier_stdout_test.rb
+- test/notifier_test.rb
+- test/watcher_rss_test.rb
+- test/watcher_test.rb
+- test/watcher_twitter_test.rb
+- test/watcher_website_test.rb