hootenanny 0.0.1 → 0.1.0

data/spec/features/subscribers/can_receive_distributions_of_topic_content_spec.rb

@@ -0,0 +1,175 @@
+require 'rspectacular/spec_helpers/rails_engine'
+require 'pathname'
+require 'hootenanny'
+
+###
+# In order me to be albe to process information I find relevant within a timely fashion
+# As a Subscriber
+# I want to be able to receive topic content updates from the hub
+#
+feature 'Subscribers receive content updates' do
+  let(:topic_content)                 { JSON.dump(JSON.load(Pathname.new('./spec/fixtures/feeds/json/sample_feed.json').read)) }
+  let(:partial_topic_content)         { JSON.dump(JSON.load(Pathname.new('./spec/fixtures/feeds/json/feed_with_one_item.json').read)) }
+  let(:topic_digest_content)          { '{"items":["1a6ed1752c74c2b7fcc0f43ce39e53f8f220cd85f85e339b06eb75a0f16bbea8","6d557b1225129abebcb56d4c986dc63bf644ee865c3833f52ca69e75b4275052"]}' }
+  let(:partial_topic_digest_content)  { '{"items":["6d557b1225129abebcb56d4c986dc63bf644ee865c3833f52ca69e75b4275052"]}' }
+  let(:broadcasted_topic_dir)         { Pathname.new('./tmp/broadcasted_topics') }
+  let(:broadcasted_topic_file)        { Pathname.new('./tmp/broadcasted_topics/5b187098da59f077f/97d79220f68b4bf27.digest') }
+
+  after(:each)                        { broadcasted_topic_dir.rmtree if broadcasted_topic_dir.exist? }
+
+  scenario 'Subscribers receive full content updates for their feed if they have never before had a feed broadcast' do
+    # Given that a topic has content
+    stub_request(:get, 'http://topic.com').
+      to_return(body:    topic_content,
+                headers: {'Content-Type' => 'application/json'})
+
+    # And the subscriber is set up to receive said content
+    content_delivery_request = \
+    stub_request(:post, 'http://subscriber.com').
+      with( :body    => topic_content,
+            :headers => {'Content-Type' => 'application/json'})
+
+    # And there is a notification that the topic has new content
+    create(:publish_notification, :topic => 'http://topic.com')
+
+    # And a subscriber is subscribed to that topic
+    create(:subscription, :active,
+                          subscriber: 'http://subscriber.com',
+                          topic:      'http://topic.com')
+
+    # And the subscriber has previously never received a content update
+    expect(broadcasted_topic_dir).not_to be_exist
+
+    # When the broadcasting process is kicked off
+    Hootenanny::Hub.broadcast
+
+    # Then the subscriber should have been sent all of the content for the feed
+    expect(content_delivery_request).to have_been_requested
+
+    # And the feed they were sent should be saved to the default broadcast store
+    expect(broadcasted_topic_file).to      be_exist
+    expect(broadcasted_topic_file.read).to eql topic_digest_content
+
+    # And the notification should be marked as processed
+    expect(Hootenanny::PublishNotification.processed).to   have(1).items
+    expect(Hootenanny::PublishNotification.unprocessed).to have(0).items
+  end
+
+  scenario 'Subscribers receive partial content updates if they have previously been sent a content update' do
+    # Given that a topic has content
+    stub_request(:get, 'http://topic.com').
+      to_return(body:    topic_content,
+                headers: {'Content-Type' => 'application/json'})
+
+    # And the subscriber is set up to receive said content
+    content_delivery_request = \
+    stub_request(:post, 'http://subscriber.com').
+      with( :body    => partial_topic_content,
+            :headers => {'Content-Type' => 'application/json'})
+
+    # And there is a notification that the topic has new content
+    create(:publish_notification, :topic => 'http://topic.com')
+
+    # And a subscriber is subscribed to that topic
+    create(:subscription, :active,
+                          subscriber: 'http://subscriber.com',
+                          topic:      'http://topic.com')
+
+    # And the subscriber has previously received a content update
+    broadcasted_topic_file.dirname.mkpath
+    ::File.write(broadcasted_topic_file, partial_topic_digest_content)
+
+    # When the broadcasting process is kicked off
+    Hootenanny::Hub.broadcast
+
+    # Then the subscriber should have been sent only the new or updated items for that feed
+    expect(content_delivery_request).to have_been_requested
+
+    # And the feed they were sent should be saved to the default broadcast store
+    expect(broadcasted_topic_file).to      be_exist
+    expect(broadcasted_topic_file.read).to eql topic_digest_content
+
+    # And the notification should be marked as processed
+    expect(Hootenanny::PublishNotification.processed).to   have(1).items
+    expect(Hootenanny::PublishNotification.unprocessed).to have(0).items
+  end
+
+  scenario 'Subscribers who reply unsuccessfully will have their content update reposted' do
+    # Given that a topic has content
+    stub_request(:get, 'http://topic.com').
+      to_return(body:    topic_content,
+                headers: {'Content-Type' => 'application/json'})
+
+    # And the subscriber is not ready to receive said content
+    content_delivery_request = \
+    stub_request(:post, 'http://subscriber.com').
+      with( :body    => topic_content,
+            :headers => {'Content-Type' => 'application/json'}).
+      to_return(:status => 500)
+
+    # And there is a notification that the topic has new content
+    create(:publish_notification, :topic => 'http://topic.com')
+
+    # And a subscriber is subscribed to that topic
+    create(:subscription, :active,
+                          subscriber: 'http://subscriber.com',
+                          topic:      'http://topic.com')
+
+    # And the subscriber has previously never received a content update
+    expect(broadcasted_topic_dir).not_to be_exist
+
+    # When the broadcasting process is kicked off
+    Hootenanny::Hub.broadcast
+
+    # Then the subscriber should have been sent the items for the feed
+    expect(content_delivery_request).to have_been_requested
+
+    # And the feed they were sent should not be saved to the default broadcast store
+    expect(broadcasted_topic_file).not_to be_exist
+
+    # And the notification should not be marked as processed
+    expect(Hootenanny::PublishNotification.processed).to   have(0).items
+    expect(Hootenanny::PublishNotification.unprocessed).to have(1).items
+  end
+
+  scenario 'Subscribers who repeatedly reply unsuccessfully will have their notification request revoked after a reasonable period of time' do
+    # Given that a topic has content
+    stub_request(:get, 'http://topic.com').
+      to_return(body:    topic_content,
+                headers: {'Content-Type' => 'application/json'})
+
+    # And the subscriber is not ready to receive said content
+    content_delivery_request = \
+    stub_request(:post, 'http://subscriber.com').
+      with( :body    => topic_content,
+            :headers => {'Content-Type' => 'application/json'}).
+      to_return(:status => 500)
+
+    # And there is a notification that the topic has new content
+    create(:publish_notification, :topic => 'http://topic.com')
+
+    # And a subscriber is subscribed to that topic
+    create(:subscription, :active,
+                          subscriber: 'http://subscriber.com',
+                          topic:      'http://topic.com')
+
+    # And the subscriber has previously never received a content update
+    expect(broadcasted_topic_dir).not_to be_exist
+
+    # And it has been retried unsuccessfully for a day
+    Timecop.travel(1.day.from_now + 1)
+
+    # When the broadcasting process is kicked off
+    Hootenanny::Hub.broadcast
+
+    # Then the subscriber should have been sent the items for the feed
+    expect(content_delivery_request).to have_been_requested
+
+    # And the feed they were sent should not be saved to the default broadcast store
+    expect(broadcasted_topic_file).not_to be_exist
+
+    # And the notification should not be marked as errored
+    expect(Hootenanny::PublishNotification.expired).to     have(1).items
+    expect(Hootenanny::PublishNotification.unprocessed).to have(0).items
+  end
+end

data/spec/features/subscribers/can_subscribe_to_a_topic_spec.rb

@@ -6,30 +6,99 @@ require 'hootenanny'
 # As a potential Subscriber
 # I want to be able to get notifications about updates to a topic I am interressted in
 #
-feature 'Subscribers can subscribe to a topic' do
+feature 'Subscribers can subscribe to a topic', :web_mock do
+  background do
+    confirmed_subscription_verification('http://mycallback',
+                                        'http://mytopic')
+  end
+
   scenario 'Potential subscribers can subscribe to a new topic' do
     # Given there are no subscriptions
     expect( Hootenanny::Subscription ).to have(0).items
 
     # When a subscription is requested for a topic
-    post( '/hootenanny/subscription', topic:     'my_topic',
-                                      callback:  'my_callback')
+    post( '/hootenanny/subscription', topic:     'http://mytopic',
+                                      callback:  'http://mycallback')
 
     # Then the subscriber should be subscribed
-    expect( Hootenanny::Subscription.to('my_topic') ).to have(1).item
+    expect( Hootenanny::Subscription.to('http://mytopic') ).to have(1).item
 
     # And the response should be 204 'No Content'
     expect( last_response.status ).to eql 204
     expect( last_response ).to be_empty
   end
 
+  scenario 'Potential subscribers can request a duration during which the subscription will be active', :time_mock do
+    # Given there are no subscriptions
+    expect( Hootenanny::Subscription ).to have(0).items
+
+    # When a subscription is requested which should be active for a given period
+    # of time
+    post( '/hootenanny/subscription', topic:          'http://mytopic',
+                                      callback:       'http://mycallback',
+                                      lease_seconds:  2)
+
+    # And that period has not yet elapsed
+
+    # Then the subscriber should be subscribed
+    expect( Hootenanny::Subscription.to('http://mytopic') ).to have(1).item
+
+    # When the subscription period has elapsed
+    Timecop.freeze(2)
+
+    # Then the subscriber should not be subscribed
+    expect( Hootenanny::Subscription.to('http://mytopic') ).to have(0).items
+  end
+
   scenario 'Potential subscribers receive error information if there is a problem' do
     # Given there are no subscriptions
     expect( Hootenanny::Subscription ).to have(0).items
 
-    # When a invalid subscription is requested for a topic
+    # When a subscription request is posted which is confirmable
+    confirmed_subscription_verification('http://mycallback', 'http://!nv4l!d')
+
+    # But is otherwise invalid
     post( '/hootenanny/subscription', topic:     'http://!nv4l!d',
-                                      callback:  'my_callback')
+                                      callback:  'http://mycallback')
+
+    # Then the subscriber should not be subscribed
+    expect( Hootenanny::Subscription ).to have(0).items
+
+    # And the response should be 400 'Bad Request'
+    expect( last_response.status ).to eql 400
+
+    # And the response should include a message indicating the problem
+    expect( last_response.body ).to eql({'error' => {
+                                          'message' => 'the scheme http does not accept registry part: !nv4l!d (or bad hostname?)' }
+                                        }.to_json)
+  end
+
+  scenario 'Potential subscribers receive error information if they do not supply all required parameters' do
+    # Given there are no subscriptions
+    expect( Hootenanny::Subscription ).to have(0).items
+
+    # When a invalid subscription is requested for a topic
+    post( '/hootenanny/subscription', callback:  'http://mycallback')
+
+    # Then the subscriber should not be subscribed
+    expect( Hootenanny::Subscription ).to have(0).items
+
+    # And the response should be 400 'Bad Request'
+    expect( last_response.status ).to eql 400
+
+    # And the response should include a message indicating the problem
+    expect( last_response.body ).to eql({'error' => {
+                                          'message' => 'Required parameter missing: topic' }
+                                        }.to_json)
+  end
+
+  scenario 'Potential subscribers receive error information if they use a non-HTTP/HTTPS URI' do
+    # Given there are no subscriptions
+    expect( Hootenanny::Subscription ).to have(0).items
+
+    # When a invalid subscription is requested for a topic
+    post( '/hootenanny/subscription', topic:     'ftp://mytopic',
+                                      callback:  'ftp://mycallback')
 
     # Then the subscriber should not be subscribed
     expect( Hootenanny::Subscription ).to have(0).items
@@ -39,7 +108,7 @@ feature 'Subscribers can subscribe to a topic' do
 
     # And the response should include a message indicating the problem
     expect( last_response.body ).to eql({'error' => {
-                                          'message' => 'All options passed need to be valid URIs' }
+                                          'message' => 'Only HTTP and HTTPS URIs are allowed.' }
                                         }.to_json)
   end
 end

data/spec/fixtures/feeds/atom/sample_feed.atom

@@ -0,0 +1,51 @@
+<feed xmlns='http://www.w3.org/2005/Atom'
+      xmlns:thr='http://purl.org/syndication/thread/1.0'
+      xml:base='https://www.tbray.org/ongoing/ongoing.atom'
+      xml:lang='en-us'>
+
+  <title>ongoing by Tim Bray</title>
+  <link rel='hub' href='http://pubsubhubbub.appspot.com/' />
+  <id>https://www.tbray.org/ongoing/</id>
+  <link href='./' />
+  <link rel='self' href='' />
+  <link rel='replies'       thr:count='101'       href='/home/tbray.org/www/html/ongoing/comments.atom' />
+  <logo>rsslogo.jpg</logo>
+  <icon>/favicon.ico</icon>
+  <updated>2013-06-17T17:33:02-07:00</updated>
+  <author><name>Tim Bray</name></author>
+  <subtitle>ongoing fragmented essay by Tim Bray</subtitle>
+  <rights>All content written by Tim Bray and photos by Tim Bray Copyright Tim Bray, some rights reserved, see /ongoing/misc/Copyright</rights>
+  <generator uri='/misc/Colophon'>Generated from XML source code using Perl, Expat, Emacs, Mysql, Ruby, Java, and ImageMagick.  Industrial-strength technology, baby.</generator>
+
+  <entry xml:base='When/201x/2013/06/16/'>
+    <title>Unmapped Lands</title>
+    <link href='The-Unmapped-Lands' />
+    <link rel='replies'        thr:count='0'        type='application/xhtml+xml'        href='The-Unmapped-Lands#comments' />
+    <id>https://www.tbray.org/ongoing/When/201x/2013/06/16/The-Unmapped-Lands</id>
+    <published>2013-06-16T12:00:00-07:00</published>
+    <updated>2013-06-16T09:47:15-07:00</updated>
+    <category scheme='https://www.tbray.org/ongoing/What/' term='Arts/Books' />
+    <category scheme='https://www.tbray.org/ongoing/What/' term='Arts' />
+    <category scheme='https://www.tbray.org/ongoing/What/' term='Books' />
+    <summary type='xhtml'><div xmlns='http://www.w3.org/1999/xhtml'>summary</div></summary>
+    <content type='xhtml'><div xmlns='http://www.w3.org/1999/xhtml'>
+      description
+    </div></content>
+  </entry>
+
+  <entry xml:base='When/201x/2013/06/16/'>
+    <title>Golang Diaries I</title>
+    <link href='Go-Love-Hate' />
+    <link rel='replies'        thr:count='27'        type='application/xhtml+xml'        href='Go-Love-Hate#comments' />
+    <id>https://www.tbray.org/ongoing/When/201x/2013/06/16/Go-Love-Hate</id>
+    <published>2013-06-16T12:00:00-07:00</published>
+    <updated>2013-06-15T13:07:09-07:00</updated>
+    <category scheme='https://www.tbray.org/ongoing/What/' term='Technology/Software' />
+    <category scheme='https://www.tbray.org/ongoing/What/' term='Technology' />
+    <category scheme='https://www.tbray.org/ongoing/What/' term='Software' />
+    <summary type='xhtml'><div xmlns='http://www.w3.org/1999/xhtml'>summary2</div></summary>
+    <content type='xhtml'><div xmlns='http://www.w3.org/1999/xhtml'>
+      description2
+    </div></content>
+  </entry>
+</feed>

data/spec/fixtures/feeds/digest/97d79220f68b4bf27.digest

@@ -0,0 +1 @@
+{}

data/spec/fixtures/feeds/digest/complete_broadcasted_items/5b187098da59f077f/97d79220f68b4bf27.digest

@@ -0,0 +1,6 @@
+{
+  "items": [
+    "a97acd993db7ef4cc74022f357954d3c4b52ab659218b89a59cdd355880d4ef6",
+    "01bfe038abb650189f78891be1581a52a7754a9be5fee7f8feeb0f7d617d3dd6"
+  ]
+}

data/spec/fixtures/feeds/digest/incomplete_broadcasted_items/5b187098da59f077f/97d79220f68b4bf27.digest

@@ -0,0 +1,5 @@
+{
+  "items": [
+    "01bfe038abb650189f78891be1581a52a7754a9be5fee7f8feeb0f7d617d3dd6"
+  ]
+}

data/spec/fixtures/feeds/digest/sample_feed.digest

@@ -0,0 +1,6 @@
+{
+  "items": [
+    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+    "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
+  ]
+}

data/spec/fixtures/feeds/json/97d79220f68b4bf27.json

@@ -0,0 +1 @@
+{}

data/spec/fixtures/feeds/json/feed_with_one_item.json

@@ -0,0 +1,21 @@
+{
+  "title":       "Ruby Rogues",
+  "feed_url":    "http://rubyrogues.com/feed/",
+  "link":        "http://rubyrogues.com",
+  "description": "Rubyist.where(:rogue => true)",
+  "language":    "en-US",
+  "author":      "Charles Max Wood, James Edward Gray II, David Brady, Avdi Grimm, Josh Susser, Katrina Owen",
+  "explicit":    "no",
+  "image":       "http://rubyrogues.com/wp-content/uploads/2013/05/RubyRogues_iTunes.jpg",
+  "items":       [
+    {
+      "guid":         "http://rubyrogues.com/?p=1361",
+      "title":        "109 RR Extreme Programming with Will Read",
+      "link":         "http://rubyrogues.com/109-rr-extreme-programming-with-will-read/",
+      "description":  "description",
+      "pubDate":      "Wed, 12 Jun 2013 13:00:31 +0000",
+      "enclosure":    "http://traffic.libsyn.com/rubyrogues/RR109ExtremeProgramming.mp3",
+      "duration":     "57:13"
+    }
+  ]
+}

data/spec/fixtures/feeds/json/sample_feed.json

@@ -0,0 +1,30 @@
+{
+  "title":       "Ruby Rogues",
+  "feed_url":    "http://rubyrogues.com/feed/",
+  "link":        "http://rubyrogues.com",
+  "description": "Rubyist.where(:rogue => true)",
+  "language":    "en-US",
+  "author":      "Charles Max Wood, James Edward Gray II, David Brady, Avdi Grimm, Josh Susser, Katrina Owen",
+  "explicit":    "no",
+  "image":       "http://rubyrogues.com/wp-content/uploads/2013/05/RubyRogues_iTunes.jpg",
+  "items":       [
+    {
+      "guid":         "http://rubyrogues.com/?p=1361",
+      "title":        "109 RR Extreme Programming with Will Read",
+      "link":         "http://rubyrogues.com/109-rr-extreme-programming-with-will-read/",
+      "description":  "description",
+      "pubDate":      "Wed, 12 Jun 2013 13:00:31 +0000",
+      "enclosure":    "http://traffic.libsyn.com/rubyrogues/RR109ExtremeProgramming.mp3",
+      "duration":     "57:13"
+    },
+    {
+      "guid":        "http://rubyrogues.com/?p=1354",
+      "title":       "108 RR Ruby Trends",
+      "link":        "http://rubyrogues.com/108-rr-ruby-trends/",
+      "description": "description 2",
+      "pubDate":     "Wed, 05 Jun 2013 13:00:46 +0000",
+      "enclosure":   "http://traffic.libsyn.com/rubyrogues/RR108CommunityTrends.mp3",
+      "duration":    "57:13"
+    }
+  ]
+}

data/spec/fixtures/feeds/rss/5b187098da59f077f/97d79220f68b4bf27.rss

@@ -0,0 +1,21 @@
+<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>