hootenanny 0.0.1 → 0.1.0

data/spec/fixtures/feeds/rss/feed_with_one_item.rss

@@ -0,0 +1,15 @@
+<rss xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:wfw="http://wellformedweb.org/CommentAPI/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:sy="http://purl.org/rss/1.0/modules/syndication/" xmlns:slash="http://purl.org/rss/1.0/modules/slash/" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:rawvoice="http://www.rawvoice.com/rawvoiceRssModule/" version="2.0">
+<channel>
+  <title>Ruby Rogues</title>
+  <link>http://rubyrogues.com</link>
+  <description>Rubyist.where(:rogue => true)</description>
+  <language>en-US</language>
+  <item>
+    <title>109 RR Extreme Programming with Will Read</title>
+    <link>http://rubyrogues.com/109-rr-extreme-programming-with-will-read/</link>
+    <guid isPermaLink="false">http://rubyrogues.com/?p=1361</guid>
+    <description>description text</description>
+    <enclosure url="http://traffic.libsyn.com/rubyrogues/RR109ExtremeProgramming.mp3" length="73410493" type="audio/mpeg"/>
+  </item>
+</channel>
+</rss>

data/spec/fixtures/feeds/rss/minimal_feed.rss

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="1.0"
+  xmlns:content="http://purl.org/rss/1.0/modules/content/"
+  xmlns:dc="http://purl.org/dc/elements/1.1/"
+  xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd"
+  xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
+  <channel>
+    <title>Feed Title</title>
+    <link>http://feed.com</link>
+    <description>Feed Description</description>
+  </channel>
+</rss>

data/spec/fixtures/feeds/rss/sample_feed.rss

@@ -0,0 +1,22 @@
+<rss xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:wfw="http://wellformedweb.org/CommentAPI/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:sy="http://purl.org/rss/1.0/modules/syndication/" xmlns:slash="http://purl.org/rss/1.0/modules/slash/" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:rawvoice="http://www.rawvoice.com/rawvoiceRssModule/" version="2.0">
+<channel>
+  <title>Ruby Rogues</title>
+  <link>http://rubyrogues.com</link>
+  <description>Rubyist.where(:rogue => true)</description>
+  <language>en-US</language>
+  <item>
+    <title>109 RR Extreme Programming with Will Read</title>
+    <link>http://rubyrogues.com/109-rr-extreme-programming-with-will-read/</link>
+    <guid isPermaLink="false">http://rubyrogues.com/?p=1361</guid>
+    <description>description text</description>
+    <enclosure url="http://traffic.libsyn.com/rubyrogues/RR109ExtremeProgramming.mp3" length="73410493" type="audio/mpeg"/>
+  </item>
+  <item>
+    <title>108 RR Ruby Trends</title>
+    <link>http://rubyrogues.com/108-rr-ruby-trends/</link>
+    <guid isPermaLink="false">http://rubyrogues.com/?p=1354</guid>
+    <description>description text 2</description>
+    <enclosure url="http://traffic.libsyn.com/rubyrogues/RR108CommunityTrends.mp3" length="63807463" type="audio/mpeg"/>
+  </item>
+</channel>
+</rss>

data/spec/fixtures/feeds/rss/sample_feed_2.rss

@@ -0,0 +1,22 @@
+<rss xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:wfw="http://wellformedweb.org/CommentAPI/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:sy="http://purl.org/rss/1.0/modules/syndication/" xmlns:slash="http://purl.org/rss/1.0/modules/slash/" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" xmlns:rawvoice="http://www.rawvoice.com/rawvoiceRssModule/" version="2.0">
+<channel>
+  <title>Javascript Jabber</title>
+  <link>http://javascriptjabber.com</link>
+  <description>Javascripter.where(:jabber => true)</description>
+  <language>en-US</language>
+  <item>
+    <title>1 JS Jabber</title>
+    <link>http://rubyrogues.com/109-rr-extreme-programming-with-will-read/</link>
+    <guid isPermaLink="false">http://rubyrogues.com/?p=1361</guid>
+    <description>description text</description>
+    <enclosure url="http://traffic.libsyn.com/rubyrogues/RR109ExtremeProgramming.mp3" length="73410493" type="audio/mpeg"/>
+  </item>
+  <item>
+    <title>2 JS Jabber</title>
+    <link>http://rubyrogues.com/108-rr-ruby-trends/</link>
+    <guid isPermaLink="false">http://rubyrogues.com/?p=1354</guid>
+    <description>description text 2</description>
+    <enclosure url="http://traffic.libsyn.com/rubyrogues/RR108CommunityTrends.mp3" length="63807463" type="audio/mpeg"/>
+  </item>
+</channel>
+</rss>

data/spec/lib/hootenanny/configuration_spec.rb

@@ -0,0 +1,7 @@
+require 'rspectacular'
+require 'hootenanny/configuration'
+
+module    Hootenanny
+describe  Configuration do
+end
+end

data/spec/lib/hootenanny/correspondent_spec.rb

@@ -0,0 +1,94 @@
+require 'rspectacular/spec_helpers/active_record_basic'
+require 'hootenanny/correspondent'
+
+module    Hootenanny
+describe  Correspondent do
+  it 'can broadcast a topic to all subscribers' do
+    synchronizer = double
+    subscription = Subscription.new(:subscriber => 'http://subscriber.com')
+
+    allow(Subscription).to  receive(:to).
+                            and_return [subscription]
+    allow(synchronizer).to  receive(:sync).
+                            and_return(true)
+
+    correspondent = Correspondent.new('http://topic.com',
+                                      synchronizer: synchronizer)
+    correspondent.broadcast
+
+    expect(synchronizer).to have_received(:sync).
+                            with(
+                              subscriber: URI.parse('http://subscriber.com'),
+                              topic:      URI.parse('http://topic.com'),
+                              digest_secret: nil)
+  end
+
+  it 'returns true if the broadcast is completely successful' do
+    synchronizer  = double
+    subscription1 = Subscription.new( :subscriber => 'http://subscriber1.com',
+                                      :topic      => 'http://topic.com')
+    subscription2 = Subscription.new( :subscriber => 'http://subscriber2.com',
+                                      :topic      => 'http://topic.com')
+
+    allow(Subscription).to  receive(:to).
+                            and_return [subscription1, subscription2]
+
+    allow(synchronizer).to  receive(:sync).
+                            with(
+                              subscriber: URI.parse('http://subscriber1.com'),
+                              topic:      URI.parse('http://topic.com'),
+                              digest_secret: nil).
+                            and_return(true)
+
+    allow(synchronizer).to  receive(:sync).
+                            with(
+                              subscriber: URI.parse('http://subscriber2.com'),
+                              topic:      URI.parse('http://topic.com'),
+                              digest_secret: nil).
+                            and_return(true)
+
+    correspondent = Correspondent.new('http://topic.com',
+                                      synchronizer: synchronizer)
+
+    expect(correspondent.broadcast).to be_a TrueClass
+  end
+
+  it 'returns false if the broadcast is only partially successful' do
+    synchronizer  = double
+    subscription1 = Subscription.new( :subscriber => 'http://subscriber1.com',
+                                      :topic      => 'http://topic.com')
+    subscription2 = Subscription.new( :subscriber => 'http://subscriber2.com',
+                                      :topic      => 'http://topic.com')
+
+    allow(Subscription).to  receive(:to).
+                            and_return [subscription1, subscription2]
+
+    allow(synchronizer).to  receive(:sync).
+                            with(
+                              subscriber: URI.parse('http://subscriber1.com'),
+                              topic:      URI.parse('http://topic.com'),
+                              digest_secret: nil).
+                            and_return(true)
+
+    allow(synchronizer).to  receive(:sync).
+                            with(
+                              subscriber: URI.parse('http://subscriber2.com'),
+                              topic:      URI.parse('http://topic.com'),
+                              digest_secret: nil).
+                            and_return(false)
+
+    correspondent = Correspondent.new('http://topic.com',
+                                      synchronizer: synchronizer)
+
+    expect(correspondent.broadcast).to be_a FalseClass
+  end
+
+  it 'loads the object used to synchronize from the global configuration if none is passed in' do
+    allow(Configuration.instance).to receive(:default_synchronizer)
+
+    Correspondent.new('http://topic.com')
+
+    expect(Configuration.instance).to have_received(:default_synchronizer)
+  end
+end
+end

data/spec/lib/hootenanny/errors_spec.rb

@@ -0,0 +1,21 @@
+require 'rspectacular'
+require 'hootenanny/errors'
+
+module    Hootenanny
+describe  Error do
+  it 'can wrap an exception with itself' do
+    exception = Exception.new('my exception')
+    exception.set_backtrace(['file_name.rb:1234 line'])
+
+    wrapped_exception = Error.wrap(exception)
+
+    expect(wrapped_exception).to            be_an Error
+    expect(wrapped_exception.message).to    eql   'my exception'
+    expect(wrapped_exception.backtrace).to  eql   ['file_name.rb:1234 line']
+  end
+
+  it 'can describe InvalidSchemeErrors properly' do
+    expect(URI::InvalidSchemeError.new.message).to eql 'Only HTTP and HTTPS URIs are allowed.'
+  end
+end
+end

data/spec/lib/hootenanny/feed/atom_feed_item_spec.rb

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'hootenanny/feed/atom_feed_item'
+
+module    Hootenanny
+class     Feed
+describe  AtomFeedItem do
+end
+end
+end

data/spec/lib/hootenanny/feed/atom_feed_spec.rb

@@ -0,0 +1,40 @@
+require 'rspectacular'
+require 'hootenanny/feed/atom_feed'
+
+module    Hootenanny
+class     Feed
+describe  AtomFeed do
+  let(:atom_content_path) { ::File.expand_path('./spec/fixtures/feeds/atom/sample_feed.atom') }
+  let(:atom_content)      { ::File.read(atom_content_path) }
+
+  it 'can create itself from some Atom' do
+    allow(RSS::Parser).to       receive(:parse)
+                               .and_return('content')
+
+    adapter = AtomFeed.from_content(atom_content)
+
+    expect(adapter).to          be_a Hootenanny::Feed::AtomFeed
+    expect(adapter.content).to  eql  'content'
+    expect(RSS::Parser).to      have_received(:parse)
+                               .with(atom_content)
+  end
+
+  it 'throws an error if the content is not parsable' do
+    expect { AtomFeed.from_content('<asdf') }
+      .to raise_error(Hootenanny::Feed::ParseError)
+  end
+
+  it 'can iterate over each of the items in the feed' do
+    adapter = AtomFeed.from_content(atom_content)
+
+    expect(adapter).to have(2).items
+  end
+
+  it 'can wrap each item in a AtomFeedItem' do
+    adapter = AtomFeed.from_content(atom_content)
+
+    expect(adapter.items.first).to be_a Hootenanny::Feed::AtomFeedItem
+  end
+end
+end
+end

data/spec/lib/hootenanny/feed/digest_feed_item_spec.rb

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'hootenanny/feed/digest_feed_item'
+
+module    Hootenanny
+class     Feed
+describe  DigestFeedItem do
+end
+end
+end

data/spec/lib/hootenanny/feed/digest_feed_spec.rb

@@ -0,0 +1,40 @@
+require 'rspectacular'
+require 'hootenanny/feed/digest_feed'
+
+module    Hootenanny
+class     Feed
+describe  DigestFeed do
+  let(:digest_content_path) { ::File.expand_path('./spec/fixtures/feeds/digest/sample_feed.digest') }
+  let(:digest_content)      { ::File.read(digest_content_path) }
+
+  it 'can create itself from a digest list' do
+    allow(JSON).to receive(:parse)
+                  .and_return 'content'
+
+    adapter = DigestFeed.from_content(digest_content)
+
+    expect(adapter).to          be_a Hootenanny::Feed::DigestFeed
+    expect(adapter.content).to  eql  'content'
+    expect(JSON).to             have_received(:parse)
+                               .with(digest_content)
+  end
+
+  it 'throws an error if the content is not parsable' do
+    expect { DigestFeed.from_content('asdf') }
+      .to raise_error(Hootenanny::Feed::ParseError)
+  end
+
+  it 'can iterate over each of the items in the feed' do
+    adapter = DigestFeed.from_content(digest_content)
+
+    expect(adapter).to have(2).items
+  end
+
+  it 'can wrap each item in a DigestFeedItem' do
+    adapter = DigestFeed.from_content(digest_content)
+
+    expect(adapter.items.first).to be_a Hootenanny::Feed::DigestFeedItem
+  end
+end
+end
+end

data/spec/lib/hootenanny/feed/feed_item_spec.rb

@@ -0,0 +1,49 @@
+require 'rspectacular'
+require 'hootenanny/feed/feed_item'
+require 'rss'
+
+module    Hootenanny
+class     Feed
+describe  FeedItem do
+  let(:rss_content_path)    { ::File.expand_path('./spec/fixtures/feeds/rss/sample_feed.rss') }
+  let(:rss_content)         { ::File.read(rss_content_path) }
+  let(:rss)                 { RSS::Parser.parse(rss_content) }
+  let(:rss_item)            { rss.items.first }
+
+  context 'when the feed item represents an object' do
+    it 'can determine equality based on a digest' do
+      feed_item = FeedItem.new(rss_item)
+      digest    = double(:to_digest => '01bfe038abb650189f78891be1581a52a7754a9be5fee7f8feeb0f7d617d3dd6')
+
+      expect(feed_item).to eql digest
+    end
+
+    it 'can determine equality based on another feed item with the same object' do
+      feed_item        = FeedItem.new(rss_item)
+      second_feed_item = FeedItem.new(rss_item)
+
+      expect(feed_item).to eql second_feed_item
+    end
+
+    it 'can determine equality based on another feed time with a different object' do
+      feed_item        = FeedItem.new(rss_item)
+      second_feed_item = FeedItem.new(rss.items[1])
+
+      expect(feed_item).not_to eql second_feed_item
+    end
+
+    it 'can determine equality for operations that require hashing' do
+      feed_item        = [FeedItem.new(rss_item)]
+      second_feed_item = [FeedItem.new(rss_item)]
+
+      expect(feed_item - second_feed_item).to be_empty
+
+      feed_item        = [FeedItem.new(rss_item)]
+      second_feed_item = [FeedItem.new(rss.items[1])]
+
+      expect(feed_item - second_feed_item).to eql feed_item
+    end
+  end
+end
+end
+end

data/spec/lib/hootenanny/feed/file_spec.rb

@@ -0,0 +1,66 @@
+require 'rspectacular'
+require 'hootenanny/feed/file'
+require 'securerandom'
+
+module    Hootenanny
+class     Feed
+describe  File do
+  it 'can add a string or path onto itself to create a new file' do
+    original_file = File.new('./spec/fixtures/feeds/rss')
+    new_file      = original_file << 'sample_feed.rss'
+
+    expect(new_file.object_id).not_to eql original_file.object_id
+    expect(new_file.to_s).to          eql './spec/fixtures/feeds/rss/sample_feed.rss'
+  end
+
+  it 'can find the first file when the path represents a glob' do
+    file = File.new('./spec/fixtures/feeds/rss/*.rss')
+
+    expect(file.to_s).to match %r{/spec/fixtures/feeds/rss/\w+\.rss}
+  end
+
+  it 'does not create a new path if the passed in value is nil' do
+    file       = File.new('./spec/fixtures/feeds/rss')
+    other_file = file << nil
+
+    expect(other_file.to_s).to eql './spec/fixtures/feeds/rss'
+  end
+
+  it 'does not create a new path if the passed in value is blank' do
+    file       = File.new('./spec/fixtures/feeds/rss')
+    other_file = file << ''
+
+    expect(other_file.to_s).to      eql './spec/fixtures/feeds/rss'
+    expect(other_file.object_id).to eql file.object_id
+  end
+
+  it 'can map a file extension to a type' do
+    file = File.new('./spec/fixtures/feeds/rss/sample_feed.rss')
+
+    expect(file.type).to eql 'RSS'
+  end
+
+  it 'can read the file' do
+    file = File.new('./spec/fixtures/feeds/rss/sample_feed.rss')
+
+    expect(file.read).to match /Ruby Rogues/
+  end
+
+  it 'is empty if the file does not exist' do
+    file = File.new('./spec/fixtures/feeds/rss/unknown_feed.rss')
+
+    expect(file.read).to eql ''
+  end
+
+  it 'can write to the file' do
+    filename = "./tmp/#{SecureRandom.hex(4)}/myfile.txt"
+
+    feed_file = File.new(filename)
+
+    feed_file.write('my stuff')
+
+    expect(feed_file.read).to eql 'my stuff'
+  end
+end
+end
+end

data/spec/lib/hootenanny/feed/json_feed_item_spec.rb

@@ -0,0 +1,9 @@
+require 'rspectacular'
+require 'hootenanny/feed/json_feed_item'
+
+module    Hootenanny
+class     Feed
+describe  JSONFeedItem do
+end
+end
+end

data/spec/lib/hootenanny/feed/json_feed_spec.rb

@@ -0,0 +1,128 @@
+require 'rspectacular'
+require 'hootenanny/feed'
+
+module    Hootenanny
+class     Feed
+describe  JSONFeed do
+  let(:json_content_path) { ::File.expand_path('./spec/fixtures/feeds/json/sample_feed.json') }
+  let(:json_content)      { ::File.read(json_content_path) }
+
+  it 'can create itself from some JSON' do
+    allow(JSON).to receive(:parse)
+                  .and_return('content')
+
+    adapter = JSONFeed.from_content(json_content)
+
+    expect(adapter).to          be_a Hootenanny::Feed::JSONFeed
+    expect(adapter.content).to  eql  'content'
+    expect(JSON).to             have_received(:parse)
+                               .with(json_content)
+  end
+
+  it 'throws an error if the content is not parsable' do
+    expect { JSONFeed.from_content('asdf') }
+      .to raise_error(Hootenanny::Feed::ParseError)
+  end
+
+  it 'can iterate over each of the items in the feed' do
+    adapter = JSONFeed.from_content(json_content)
+
+    expect(adapter).to have(2).items
+  end
+
+  it 'can wrap each item in a JSONFeedItem' do
+    adapter = JSONFeed.from_content(json_content)
+
+    expect(adapter.items.first).to be_a Hootenanny::Feed::JSONFeedItem
+  end
+
+  it 'can properly set content for itself from a String' do
+    feed = JSONFeed.from_content('{"key": "value", "items": []}')
+
+    expect(feed.to_s).to eql '{"key":"value","items":[]}'
+  end
+
+  it 'if content is not blank, it always returns a String containing items' do
+    feed = JSONFeed.from_content('{"key": "value"}')
+
+    expect(feed.to_s).to eql '{"key":"value","items":[]}'
+  end
+
+  it 'if it is blank' do
+    feed = JSONFeed.from_content('{}')
+
+    expect(feed.to_s).to eql '{"items":[]}'
+  end
+
+  it 'it properly sets items to an empty array even if no items are in the content' do
+    feed = JSONFeed.from_content('{"key": "value"}')
+
+    expect(feed.items).to eql []
+  end
+
+  it 'can properly set content for itself from a String' do
+    feed = JSONFeed.from_content('{"key": "value", "items": []}')
+
+    expect(feed.content).to eql(
+                                'key'   => 'value',
+                                'items' => []
+                               )
+  end
+
+  it 'can properly set content for itself from a Hash' do
+    feed = JSONFeed.from_content(key: 'value')
+
+    expect(feed.content).to eql(
+                                'key' => 'value'
+                               )
+  end
+
+  it 'raises an error if it does not know how to parse content' do
+    expect { JSONFeed.from_content(2) }.to raise_error Hootenanny::Feed::ParseError
+  end
+
+  it 'can determine the difference between two feeds' do
+    first_content_path  = ::File.expand_path('./spec/fixtures/feeds/json/sample_feed.json')
+    first_content       = ::File.read(first_content_path)
+
+    second_content_path = ::File.expand_path('./spec/fixtures/feeds/json/feed_with_one_item.json')
+    second_content      = ::File.read(second_content_path)
+
+    first_feed          = Feed.infer(first_content,   type: :json)
+    second_feed         = Feed.infer(second_content,  type: :json)
+
+    difference_feed = first_feed - second_feed
+
+    expect(difference_feed.items).to                        have(1).item
+    expect(difference_feed.items).to                        eql [first_feed.items[1]]
+    expect(difference_feed.content['title']).to             eql 'Ruby Rogues'
+    expect(difference_feed.items.first.content['title']).to eql '108 RR Ruby Trends'
+
+    expect(difference_feed.to_s).to                         include 'Ruby Rogues'
+    expect(difference_feed.to_s).to                         include '108 RR Ruby Trends'
+    expect(difference_feed.to_s).not_to                     include '109 RR Extreme Programming with Will Read'
+  end
+
+  it 'can determine the difference between two feeds of differing types' do
+    first_content_path = ::File.expand_path('./spec/fixtures/feeds/json/sample_feed.json')
+    first_content      = ::File.read(first_content_path)
+
+    second_content     = '{"items": ["1a6ed1752c74c2b7fcc0f43ce39e53f8f220cd85f85e339b06eb75a0f16bbea8"]}'
+
+    first_feed         = Feed.infer(first_content,  type: :json)
+    second_feed        = Feed.infer(second_content, type: :digest)
+
+    difference_feed    = first_feed - second_feed
+
+    expect(difference_feed.items).to                        have(1).item
+    expect(difference_feed.items).to                        eql [first_feed.items[1]]
+    expect(difference_feed.content['title']).to             eql 'Ruby Rogues'
+    expect(difference_feed.items.first.content['title']).to eql '108 RR Ruby Trends'
+
+    expect(difference_feed.to_s).to                         include 'Ruby Rogues'
+    expect(difference_feed.to_s).to                         include '108 RR Ruby Trends'
+    expect(difference_feed.to_s).not_to                     include '109 RR Extreme Programming with Will Read'
+  end
+end
+end
+end