snoop 0.0.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fd5c1237486ef935e48c655df057e062a2f73da
-  data.tar.gz: cab236fa1b0af6d51125a36d8955c8727e4cf22c
+  metadata.gz: e402f8be7361f82aa03e369c4dd3a2479e930c99
+  data.tar.gz: f03d974b6a042f46071073792787d568fe78f9b3
 SHA512:
-  metadata.gz: 1afd73ec6e6fff288053c02213c68d14a20ae2f04706036a9a8ce81d30c5ad2694415dc00cba2d1d417cf3f554c6dbc985a44e1ac43e8a81e96b326ea03dba09
-  data.tar.gz: b3aa4b4d891f75a31a1ca9bafeea0e603f7600fcc7a753cfddd83e15ef066833b1b9a1bf597c2dc3ef77669e113a3a538818ff3a7030776caa2037d366594982
+  metadata.gz: 32e12e8737830b2414f437b126cbe5c9a6ca3496f1e799572d75575741b47ca2727cfa6a13361ac1101e84e9fb3a74330b9bb3341112716bcd785bbb2691171a
+  data.tar.gz: d5a95a8b02e38f49d48146932d901253fe13b416e0df69a1e14d1571ee5d2ea685a1a5bb7be139816d91091a558640a3cdc13dee71e63b4e2bf540c90255689c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snoop (0.0.4)
+    snoop (0.8.0)
       httparty
       nokogiri
 

data/README.md

@@ -1,9 +1,148 @@
-# Snoop `wip`
-Be notified when content changes.
+# Snoop
+Snoop on content, be notified when it changes.
 
-Supported snoops:
+## Usage
+
+Want to know when the next version of JRuby is released? Me too! Let's `Snoop`
+the [JRuby homepage](http://jruby.org) and print to the terminal when a new
+version has been posted. In this example, we'll check
+[jruby.org](http://jruby.org) every 5 minutes for a new version.
+
+```ruby
+require 'snoop'
+
+snoop = Snoop::Http.new(
+  url: 'http://jruby.org',
+  css: '#latest_release strong'
+)
+
+snoop.notify while: -> { true }, delay: 300 do |version|
+  puts "New JRuby Version! #{version}"
+end
+```
+
+### Mac OS Notifications
+
+`Snoop` works really well with Mac OS X notifications. Install
+[terminal-notifier](https://github.com/alloy/terminal-notifier) and use it in
+your notify callback.
+
+```bash
+$ gem install terminal-notifier
+```
+
+Let's send Mac OS X notifications when people start watching our video on
+[Confreaks](http://www.confreaks.com). We'll use `Snoop` to check for updates
+every 2 minutes and send a notification if we get more views. In this example,
+the `Snoop` will run until the video has reached 2000 views, then stop.
+
+```ruby
+require 'snoop'
+
+video = '2291-larubyconf2013-impressive-ruby-productivity-with-vim-and-tmux'
+
+snoop = Snoop::Http.new(
+  url: "http://www.confreaks.com/videos/#{video}",
+  css: '.video-rating'
+)
+
+view_count = 0
+
+snoop.notify until: -> { view_count >= 2000 }, delay: 120 do |video_rating|
+  current_view_count = video_rating.gsub(/\D/, '').to_i
+  new_view_count     = current_view_count - view_count
+  view_count         = current_view_count
+
+  message = "#{current_view_count} views (#{new_view_count} new) on your video!"
+
+  puts "Sending notification: #{message}"
+  `terminal-notifier -message "#{message}"`
+end
+```
+
+## Options
+
+### CSS Selectors
+
+Each `Snoop` requires a URL, but you can also provide a css selector if you're
+only interested in part of the page's content. The css selector you provide is
+handed directly to [Nokogiri](http://nokogiri.org), so the same syntax is
+required.
+
+```ruby
+require 'snoop'
 
-  - `HTTP`
+# Receive notifications if any part of the page changes
+snoop = Snoop::Http.new(
+  url: 'http://jruby.org'
+)
+
+# Receive notifications if just the latest JRuby release changes
+snoop = Snoop::Http.new(
+  url: 'http://jruby.org',
+  css: '#latest_release strong'
+)
+```
+
+### Delay and Count
+
+If you'd like to have your `Snoop` check for new content more than once, you
+can provided a `count`. Alternatively, you can use [Conditional
+Snooping](#conditional-snooping).
+
+The `count` option is most useful for timeboxing a `Snoop`.
+
+```ruby
+require 'snoop'
+snoop = Snoop::Http.new(url: 'http://jruby.org')
+
+# Check JRuby for updates, every minute for 10 minutes
+snoop.notify count: 10, delay: 60 do |content|
+  puts content
+end
+```
+
+### Conditional Snooping
+
+By default, a `Snoop` will only check once and return immediately. This is almost
+useless since we are interested in change over time. Conditional Snooping is
+possible with the `while` and `until` arguments. It is almost *always*
+recommended to provide a `delay` when using conditional Snooping unless you are
+trying to [DDoS](http://en.wikipedia.org/wiki/Denial-of-service_attack)
+someone.
+
+Here's an example of a daemon `Snoop` that runs forever, checking the JRuby
+homepage every minute for changes.
+
+```ruby
+require 'snoop'
+
+snoop = Snoop::Http.new(url: 'http://jruby.org')
+
+snoop.notify while: -> { true }, delay: 60 do |content|
+  puts content
+end
+```
+
+Something else we might want to do is check our
+[Twitter](https://twitter.com/chrishunt) follower count. Here's an example that
+checks twitter every 3 minutes for changes. If the content changes, then we
+print our new follower count to the terminal. When we've reached 500 followers,
+the `Snoop` will stop checking.
+
+```ruby
+snoop = Snoop::Http.new(
+  url: 'https://twitter.com/chrishunt',
+  css: '[data-element-term="follower_stats"]'
+)
+
+follower_count = 0
+
+snoop.notify until: -> { follower_count >= 500 }, delay: 180 do |content|
+  follower_count = content.gsub(/\D/, '').to_i
+  puts "You have #{follower_count} followers!"
+end
+```
 
 ## Installation
 
@@ -25,10 +164,6 @@ Or install it yourself as:
 $ gem install snoop
 ```
 
-## Usage
-
-`wip`
-
 ## Contributing
 
 1. Fork it

data/lib/snoop/version.rb

@@ -1,3 +1,3 @@
 module Snoop
-  VERSION = '0.0.4'
+  VERSION = '0.8.0'
 end

data/snoop.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Snoop::VERSION
   spec.authors       = ['Chris Hunt']
   spec.email         = ['c@chrishunt.co']
-  spec.description   = %q{Monitor content for changes}
-  spec.summary       = %q{Monitor content for changes and be notified}
+  spec.description   = %q{Snoop on content, be notified when it changes.}
+  spec.summary       = %q{Snoop on content, be notified when it changes.}
   spec.homepage      = 'https://github.com/chrishunt/snoop'
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snoop
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Chris Hunt
@@ -108,7 +108,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Monitor content for changes
+description: Snoop on content, be notified when it changes.
 email:
 - c@chrishunt.co
 executables: []
@@ -151,7 +151,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Monitor content for changes and be notified
+summary: Snoop on content, be notified when it changes.
 test_files:
 - spec/acceptance/http_spec.rb
 - spec/support/http_server.rb