snoop 0.8.5 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5374fd3cf90a61d50d6a98e643c52426065aecc6
-  data.tar.gz: b52af829780967314ae4cba297b88f67049255f3
+  metadata.gz: fa3e46c444207c14e901618fd4dcebda2d071a6d
+  data.tar.gz: c618dcb9b9ee2df1e0132160b9e29271e3d36cf5
 SHA512:
-  metadata.gz: e146734d652642438bf615423846d4c8bbe932d61e03bb4abed5c2114e647b0017a564218d02f2bb353f298955ad3825b8a7571c9a1b721147d562c8765fd02e
-  data.tar.gz: 31cd694d9c0c39ed27dcd92762a287571cb436910f39dc0693eb42f83a7b1d4ec197563bb3a41f30440e497af70fe9b7b90e5b46867293726492f1d6910db25f
+  metadata.gz: 4a9c16933727dce0b5f51136766655b05879f7b6788d55b785f890574ef9863fd57690a84317565d0124c6002eac7ff93f65caf61478515ac140151d7eb17aa9
+  data.tar.gz: f353f036f82730ca2969d0b4c1fd8dd0d72ea6d69b6dd0ce0a6ede4edeac576a76b7f78d61b2e9fe620157d76f4469ed0a3173158f2f247e4f5b1883dcdf261e

data/README.md

@@ -1,5 +1,6 @@
 # Snoop
 [![Travis CI](https://travis-ci.org/chrishunt/snoop.png)](https://travis-ci.org/chrishunt/snoop)
+[![Coverage Status](https://coveralls.io/repos/chrishunt/snoop/badge.png?branch=master)](https://coveralls.io/r/chrishunt/snoop)
 [![Code Climate](https://codeclimate.com/github/chrishunt/snoop.png)](https://codeclimate.com/github/chrishunt/snoop)
 
 Snoop on content, be notified when it changes.
@@ -134,6 +135,8 @@ print our new follower count to the terminal. When we've reached 500 followers,
 the `Snoop` will stop checking.
 
 ```ruby
+require 'snoop'
+
 snoop = Snoop::Http.new(
   url: 'https://twitter.com/chrishunt',
   css: '[data-element-term="follower_stats"]'

data/lib/snoop.rb

@@ -1,2 +1,3 @@
 require 'snoop/version'
+require 'snoop/notifier'
 require 'snoop/http'

data/lib/snoop/http.rb

@@ -2,7 +2,7 @@ require 'httparty'
 require 'nokogiri'
 
 module Snoop
-  class Http
+  class Http < Notifier
     UrlRequiredException = Class.new(StandardError)
 
     DEFAULT_INIT_OPTIONS = {
@@ -11,15 +11,7 @@ module Snoop
       http_client: HTTParty
     }
 
-    DEFAULT_NOTIFY_OPTIONS = {
-      delay: 0,
-      count: 1,
-      while: -> { false },
-      until: -> { true }
-    }
-
     attr_reader :url, :css, :http_client
-    attr_accessor :content
 
     def initialize(options = {})
       options = DEFAULT_INIT_OPTIONS.merge options
@@ -31,25 +23,6 @@ module Snoop
       @http_client = options.fetch :http_client
     end
 
-    def notify(options = {})
-      options = DEFAULT_NOTIFY_OPTIONS.merge options
-
-      while (
-        (options[:count] -= 1) >= 0 ||
-        options.fetch(:while).call  ||
-        !options.fetch(:until).call
-      )
-        yield content if content_changed?
-        sleep options.fetch(:delay)
-      end
-    end
-
-    def content_changed?
-      old_content = @content
-      @content = fetch_content
-      old_content != @content
-    end
-
     def fetch_content
       content = http_client.get(url).body
 

data/lib/snoop/notifier.rb

@@ -0,0 +1,37 @@
+module Snoop
+  class Notifier
+    UnimplementedException = Class.new(StandardError)
+
+    attr_accessor :content
+
+    DEFAULT_NOTIFY_OPTIONS = {
+      delay: 0,
+      count: 1,
+      while: -> { false },
+      until: -> { true }
+    }
+
+    def notify(options = {})
+      options = DEFAULT_NOTIFY_OPTIONS.merge options
+
+      while (
+        (options[:count] -= 1) >= 0 ||
+        options.fetch(:while).call  ||
+        !options.fetch(:until).call
+      )
+        yield content if content_changed?
+        sleep options.fetch(:delay)
+      end
+    end
+
+    def content_changed?
+      old_content = @content
+      @content = fetch_content
+      old_content != @content
+    end
+
+    def fetch_content
+      raise UnimplementedException.new '#fetch_content must be implemented'
+    end
+  end
+end

data/lib/snoop/version.rb

@@ -1,3 +1,3 @@
 module Snoop
-  VERSION = '0.8.5'
+  VERSION = '0.9.0'
 end

data/snoop.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'thin'
   spec.add_development_dependency 'sinatra'
 

data/spec/acceptance/http_spec.rb

@@ -1,5 +1,6 @@
-require 'snoop/http'
+require 'spec_helper'
 require 'support/http_server'
+require 'snoop'
 
 describe Snoop::Http do
   with_http_server do |url|

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'coveralls'
+Coveralls.wear!

data/spec/unit/http_spec.rb

@@ -1,3 +1,5 @@
+require 'spec_helper'
+require 'snoop/notifier'
 require 'snoop/http'
 
 describe Snoop::Http do
@@ -30,101 +32,6 @@ describe Snoop::Http do
     end
   end
 
-  describe '#notify' do
-    let(:content) { 'abc123' }
-    let(:content_changed?) { true }
-
-    before do
-      subject.stub(
-        content: content,
-        content_changed?: content_changed?
-      )
-    end
-
-    it 'notifies the requested number of times' do
-      notification_count = 0
-
-      subject.notify count: 5 do
-        notification_count += 1
-      end
-
-      expect(notification_count).to eq 5
-    end
-
-    it 'notifies while an expression is true' do
-      notification_count = 0
-
-      subject.notify while: -> { notification_count < 3 }  do
-        notification_count += 1
-      end
-
-      expect(notification_count).to eq 3
-    end
-
-    it 'notifies until an expression is true' do
-      notification_count = 0
-
-      subject.notify until: -> { notification_count > 2 }  do
-        notification_count += 1
-      end
-
-      expect(notification_count).to eq 3
-    end
-
-    it 'yields the content to the notification block' do
-      yielded_content = nil
-
-      subject.notify { |content| yielded_content = content }
-
-      expect(yielded_content).to eq content
-    end
-
-    context 'when the content does not change' do
-      let(:content_changed?) { false }
-
-      it 'does not yield the notification block' do
-        yielded = false
-
-        subject.notify { yielded = true }
-
-        expect(yielded).to be_false
-      end
-    end
-  end
-
-  describe '#content_changed?' do
-    it 'updates the content' do
-      subject.content = 'abc123'
-      subject.stub(fetch_content: 'def456')
-
-      subject.content_changed?
-
-      expect(subject.content).to eq 'def456'
-    end
-
-    context 'when content has changed' do
-      before do
-        subject.content = 'abc123'
-        subject.stub(fetch_content: 'def456')
-      end
-
-      it 'returns true' do
-        expect(subject.content_changed?).to be_true
-      end
-    end
-
-    context 'when content has not changed' do
-      before do
-        subject.content = 'abc123'
-        subject.stub(fetch_content: 'abc123')
-      end
-
-      it 'returns false' do
-        expect(subject.content_changed?).to be_false
-      end
-    end
-  end
-
   describe '#fetch_content' do
     before do
       response = stub('HttpResponse', body: body)

data/spec/unit/notifier_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+require 'snoop/notifier'
+
+describe Snoop::Notifier do
+  describe '#fetch_content' do
+    it 'raises an exception for unimplemented required methods' do
+      expect {
+        subject.fetch_content
+      }.to raise_error Snoop::Notifier::UnimplementedException
+    end
+  end
+
+  describe '#notify' do
+    let(:content) { 'abc123' }
+    let(:content_changed?) { true }
+
+    before do
+      subject.stub(
+        content: content,
+        content_changed?: content_changed?
+      )
+    end
+
+    it 'notifies the requested number of times' do
+      notification_count = 0
+
+      subject.notify count: 5 do
+        notification_count += 1
+      end
+
+      expect(notification_count).to eq 5
+    end
+
+    it 'notifies while an expression is true' do
+      notification_count = 0
+
+      subject.notify while: -> { notification_count < 3 }  do
+        notification_count += 1
+      end
+
+      expect(notification_count).to eq 3
+    end
+
+    it 'notifies until an expression is true' do
+      notification_count = 0
+
+      subject.notify until: -> { notification_count > 2 }  do
+        notification_count += 1
+      end
+
+      expect(notification_count).to eq 3
+    end
+
+    it 'yields the content to the notification block' do
+      yielded_content = nil
+
+      subject.notify { |content| yielded_content = content }
+
+      expect(yielded_content).to eq content
+    end
+
+    context 'when the content does not change' do
+      let(:content_changed?) { false }
+
+      it 'does not yield the notification block' do
+        yielded = false
+
+        subject.notify { yielded = true }
+
+        expect(yielded).to be_false
+      end
+    end
+  end
+
+  describe '#content_changed?' do
+    it 'updates the content' do
+      subject.content = 'abc123'
+      subject.stub(fetch_content: 'def456')
+
+      subject.content_changed?
+
+      expect(subject.content).to eq 'def456'
+    end
+
+    context 'when content has changed' do
+      before do
+        subject.content = 'abc123'
+        subject.stub(fetch_content: 'def456')
+      end
+
+      it 'returns true' do
+        expect(subject.content_changed?).to be_true
+      end
+    end
+
+    context 'when content has not changed' do
+      before do
+        subject.content = 'abc123'
+        subject.stub(fetch_content: 'abc123')
+      end
+
+      it 'returns false' do
+        expect(subject.content_changed?).to be_false
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snoop
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.9.0
 platform: ruby
 authors:
 - Chris Hunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -124,11 +138,14 @@ files:
 - Rakefile
 - lib/snoop.rb
 - lib/snoop/http.rb
+- lib/snoop/notifier.rb
 - lib/snoop/version.rb
 - snoop.gemspec
 - spec/acceptance/http_spec.rb
+- spec/spec_helper.rb
 - spec/support/http_server.rb
 - spec/unit/http_spec.rb
+- spec/unit/notifier_spec.rb
 homepage: https://github.com/chrishunt/snoop
 licenses:
 - MIT
@@ -155,5 +172,7 @@ specification_version: 4
 summary: Snoop on content, be notified when it changes.
 test_files:
 - spec/acceptance/http_spec.rb
+- spec/spec_helper.rb
 - spec/support/http_server.rb
 - spec/unit/http_spec.rb
+- spec/unit/notifier_spec.rb