hootenanny 0.0.1 → 0.1.0

data/config/routes.rb

@@ -1,3 +1,4 @@
 Hootenanny::Engine.routes.draw do
-  resource :subscription, :only => :create
+  resource :subscription,         :only => :create
+  resource :publish_notification, :only => :create
 end

data/db/migrate/20130607182642_add_started_at_and_lease_duration_to_subscriptions.rb

@@ -0,0 +1,15 @@
+class AddStartedAtAndLeaseDurationToSubscriptions < ActiveRecord::Migration
+  def change
+    remove_index :hootenanny_subscriptions, :subscriber
+    remove_index :hootenanny_subscriptions, [:subscriber, :topic]
+
+    add_column :hootenanny_subscriptions, :started_at,     :datetime
+    add_column :hootenanny_subscriptions, :lease_duration, :integer
+
+    change_column :hootenanny_subscriptions, :started_at,     :datetime,  :null => false
+    change_column :hootenanny_subscriptions, :lease_duration, :integer,   :null => false
+
+    add_index :hootenanny_subscriptions, :subscriber,            :unique => false
+    add_index :hootenanny_subscriptions, [:subscriber, :topic],  :unique => true
+  end
+end

data/db/migrate/20130608225621_add_hmac_secret_to_subscription.rb

@@ -0,0 +1,5 @@
+class AddHmacSecretToSubscription < ActiveRecord::Migration
+  def change
+    add_column :hootenanny_subscriptions, :digest_secret, :string, :null => true, :limit => 200
+  end
+end

data/db/migrate/20130611235218_add_publish_notifications.rb

@@ -0,0 +1,9 @@
+class AddPublishNotifications < ActiveRecord::Migration
+  def change
+    create_table :hootenanny_publish_notifications do |t|
+      t.string :topic, :limit => 250, :null => false
+    end
+
+    add_index 'hootenanny_publish_notifications', 'topic', :name => 'index_hootenanny_publish_notifications_on_topic', :unique => true
+  end
+end

data/db/migrate/20130612153138_add_timestamps_to_publish_notification.rb

@@ -0,0 +1,5 @@
+class AddTimestampsToPublishNotification < ActiveRecord::Migration
+  def change
+    add_timestamps :hootenanny_publish_notifications
+  end
+end

data/db/migrate/20130705200729_add_processed_flag_to_publish_notifications.rb

@@ -0,0 +1,6 @@
+class AddProcessedFlagToPublishNotifications < ActiveRecord::Migration
+  def change
+    add_column :hootenanny_publish_notifications, :processed, :boolean, :null => false, :default => false
+    add_index  :hootenanny_publish_notifications, :processed
+  end
+end

data/db/migrate/20130711061329_switch_publish_notification_process_state_from_boolean_to_string.rb

@@ -0,0 +1,11 @@
+class SwitchPublishNotificationProcessStateFromBooleanToString < ActiveRecord::Migration
+  def up
+    add_column    :hootenanny_publish_notifications, :state, :string, :limit => 15, :null => false, :default => 'unprocessed'
+    remove_column :hootenanny_publish_notifications, :processed
+  end
+
+  def down
+    add_column    :hootenanny_publish_notifications, :processed, :boolean, :default => false, :null => false
+    remove_column :hootenanny_publish_notifications, :state
+  end
+end

data/db/migrate/20130711061558_add_index_to_notifications_state.rb

@@ -0,0 +1,5 @@
+class AddIndexToNotificationsState < ActiveRecord::Migration
+  def change
+    add_index :hootenanny_publish_notifications, :state
+  end
+end

data/hootenanny.gemspec

@@ -31,11 +31,15 @@ Gem::Specification.new do |s|
 
   s.add_dependency              'rails',                '~> 3.2'
   s.add_dependency              'strong_parameters',    '~> 0.2.1'
+  s.add_dependency              'faraday',              '~> 0.8.7'
+  s.add_dependency              'chronological',        '~> 1.0.0beta10'
 
   s.add_development_dependency  'pg'
-  s.add_development_dependency  'sqlite3'
-  s.add_development_dependency  'rspec-rails',          '~> 2.13'
+  s.add_development_dependency  'rspec-rails',          '~> 2.14.0.rc1'
+  s.add_development_dependency  'rspec',                '~> 2.14.0.rc1'
   s.add_development_dependency  'database_cleaner',     '~> 0.9.1'
   s.add_development_dependency  'rspectacular',         '~> 0.13'
   s.add_development_dependency  'factory_girl_rails',   '~> 4.2'
+  s.add_development_dependency  'timecop',              '~> 0.6.1'
+  s.add_development_dependency  'webmock',              '~> 1.11'
 end

data/lib/hootenanny/configuration.rb

@@ -0,0 +1,43 @@
+require 'singleton'
+require 'hootenanny/topic_synchronizer'
+require 'hootenanny/subscription_delivery'
+require 'hootenanny/feed_store/web_feed_store'
+require 'hootenanny/feed_store/file_feed_store'
+
+module  Hootenanny
+  def self.config
+    Hootenanny::Configuration.instance
+  end
+
+  class   Configuration
+    include Singleton
+
+    attr_accessor :default_local_feed_store,
+                  :default_remote_feed_store,
+                  :default_synchronizer,
+                  :default_subscription_delivery
+
+    def default_local_feed_store
+      FeedStore::FileFeedStore.new(
+        :location => File.join('.',
+                               'tmp',
+                               'broadcasted_topics'))
+    end
+
+    def default_remote_feed_store
+      FeedStore::WebFeedStore.new
+    end
+
+    def default_synchronizer
+      TopicSynchronizer
+    end
+
+    def default_subscription_delivery
+      SubscriptionDelivery
+    end
+
+    def default_publish_notification_expiration_threshold
+      Time.now - (24 * 60 * 60)
+    end
+  end
+end

data/lib/hootenanny/correspondent.rb

@@ -0,0 +1,44 @@
+require 'hootenanny/configuration'
+require 'hootenanny/subscription'
+require 'hootenanny/topic'
+
+module  Hootenanny
+class   Correspondent
+  def initialize(topic, options = {})
+    self.topic              = topic
+    self.synchronizer_class = options[:synchronizer] ||
+                              Hootenanny.config.default_synchronizer
+  end
+
+  def self.broadcast(topic, options = {})
+    correspondent = new(topic, options = {})
+
+    correspondent.broadcast
+  end
+
+  def broadcast
+    subscriptions.all? do |subscription|
+      synchronizer_class.sync(subscriber:    subscription.subscriber,
+                              digest_secret: subscription.digest_secret,
+                              topic:         topic.url)
+    end
+  end
+
+  protected
+
+  def subscriptions
+    Hootenanny::Subscription.to(topic.url)
+  end
+
+  attr_accessor :topic,
+                :synchronizer_class
+
+  def topic=(other)
+    @topic =  if other.respond_to?(:url)
+                other
+              else
+                Hootenanny::Topic.from_url(other)
+              end
+  end
+end
+end

data/lib/hootenanny/errors.rb

@@ -1,7 +1,48 @@
-class Hootenanny::SubscriptionAssignmentError < ArgumentError
+require 'delegate'
+
+class Hootenanny::Error < StandardError
   def to_h
     {
       message: self.message
     }
   end
+
+  def as_json(options = {})
+    {
+      error: {
+        message: self.message
+      }
+    }
+  end
+
+  def self.wrap(exception)
+    hootenanny_error = self.new(exception.message)
+
+    hootenanny_error.set_backtrace exception.backtrace
+
+    hootenanny_error
+  end
+end
+
+module  Hootenanny
+class   Request;      end
+class   URI < SimpleDelegator; end
+class   Feed;         end
+class   FeedStore;    end
+end
+
+class Hootenanny::Request::BuildError                   < Hootenanny::Error; end
+
+class Hootenanny::URI::InvalidError                     < Hootenanny::Error; end
+class Hootenanny::URI::InvalidSchemeError               < Hootenanny::Error
+  def initialize(message = 'Only HTTP and HTTPS URIs are allowed.')
+    super
+  end
 end
+
+class Hootenanny::SubscriptionError                     < Hootenanny::Error; end
+class Hootenanny::Feed::UnknownContentTypeError         < Hootenanny::Error; end
+class Hootenanny::Feed::ParseError                      < Hootenanny::Error; end
+class Hootenanny::Feed::CombinationError                < Hootenanny::Error; end
+class Hootenanny::FeedStore::InferenceError             < Hootenanny::Error; end
+class Hootenanny::FeedStore::UnknownStorageTypeError    < Hootenanny::Error; end

data/lib/hootenanny/feed.rb

@@ -0,0 +1,75 @@
+require 'active_support/inflector'
+require 'hootenanny/errors'
+require 'hootenanny/feed/rss_feed'
+require 'hootenanny/feed/json_feed'
+require 'hootenanny/feed/atom_feed'
+require 'hootenanny/feed/digest_feed'
+require 'hootenanny/feed/null_feed'
+
+module  Hootenanny
+class   Feed
+  FEED_TYPE_MAPPINGS = {
+    :rss    => 'RSS',
+    :json   => 'JSON',
+    :atom   => 'Atom',
+    :digest => 'Digest',
+    :''     => 'Null',
+  }
+
+  def self.infer(content, options = {})
+    type = options.fetch(:type).to_s.downcase.to_sym
+
+    feed_class(type).from_content(content)
+  rescue KeyError => e
+    raise ::Hootenanny::Feed::UnknownContentTypeError.wrap(e)
+  end
+
+  def self.from_content(content)
+    adapter = allocate
+
+    adapter.send :content=, content
+
+    adapter
+  end
+
+  def -(other)
+    feed       = self.class.from_content(self.content)
+    feed.items = self.items - other.items
+    feed
+  end
+
+  def +(other)
+    raise Hootenanny::Feed::CombinationError unless self.class == other.class
+
+    feed       = self.class.from_content(self.content)
+    feed.items = (self.items + other.items).uniq
+    feed
+  end
+
+  def empty?
+    items.empty?
+  end
+
+  def to_digest_feed
+    feed = DigestFeed.from_content('{}')
+    feed.items = self.items.map { |item| DigestFeedItem.new(item.to_digest) }
+    feed
+  end
+
+  def type
+    self.class.name.match(/Hootenanny::Feed::(\w+)Feed/)[1].downcase.to_sym
+  end
+
+  protected
+
+  attr_writer :items
+
+  private
+
+  def self.feed_class(type)
+    type_class_partial = FEED_TYPE_MAPPINGS.fetch(type)
+
+    "Hootenanny::Feed::#{type_class_partial}Feed".constantize
+  end
+end
+end

data/lib/hootenanny/feed/atom_feed.rb

@@ -0,0 +1,18 @@
+require 'rss'
+require 'hootenanny/feed'
+require 'hootenanny/feed/atom_feed_item'
+
+module  Hootenanny
+class   Feed
+class   AtomFeed < ::Hootenanny::Feed::RSSFeed
+
+  def items
+    @items ||= content.entries.map { |i| Hootenanny::Feed::AtomFeedItem.new i }
+  end
+
+  def content_type
+    'application/atom+xml'
+  end
+end
+end
+end

data/lib/hootenanny/feed/atom_feed_item.rb

@@ -0,0 +1,8 @@
+require 'hootenanny/feed/feed_item'
+
+module  Hootenanny
+class   Feed
+class   AtomFeedItem < ::Hootenanny::Feed::FeedItem
+end
+end
+end

data/lib/hootenanny/feed/digest_feed.rb

@@ -0,0 +1,14 @@
+require 'json'
+require 'hootenanny/feed'
+require 'hootenanny/feed/digest_feed_item'
+
+module  Hootenanny
+class   Feed
+class   DigestFeed < ::Hootenanny::Feed::JSONFeed
+
+  def items
+    @items ||= content.fetch('items', []).map { |i| Hootenanny::Feed::DigestFeedItem.new i }
+  end
+end
+end
+end

data/lib/hootenanny/feed/digest_feed_item.rb

@@ -0,0 +1,11 @@
+require 'hootenanny/feed/feed_item'
+
+module  Hootenanny
+class   Feed
+class   DigestFeedItem < ::Hootenanny::Feed::FeedItem
+  def to_digest
+    content
+  end
+end
+end
+end

data/lib/hootenanny/feed/feed_item.rb

@@ -0,0 +1,30 @@
+require 'digest'
+
+module  Hootenanny
+class   Feed
+class   FeedItem
+
+  attr_accessor :content
+
+  def initialize(content)
+    self.content = content
+  end
+
+  def hash
+    self.to_digest.hash
+  end
+
+  def ==(comparee)
+    self.to_digest == comparee.to_digest
+  end
+
+  def eql?(comparee)
+    self == comparee
+  end
+
+  def to_digest
+    Digest::SHA256.hexdigest content.to_s
+  end
+end
+end
+end

data/lib/hootenanny/feed/file.rb

@@ -0,0 +1,66 @@
+require 'pathname'
+
+module  Hootenanny
+class   Feed
+class   File
+  FILE_EXTENSION_MAPPINGS = {
+    '.rss'    => 'RSS',
+    '.atom'   => 'Atom',
+    '.json'   => 'JSON',
+    '.digest' => 'Digest',
+  }
+
+  def initialize(base_path)
+    self.path = base_path
+  end
+
+  def <<(other_path)
+    return self if other_path.nil? || other_path == ''
+
+    self.class.new(path + other_path)
+  end
+
+  def read
+    file.exist? ? file.read : ''
+  end
+
+  def write(content)
+    path.dirname.mkpath
+
+    path.open('w+') do |f|
+      f.write(content)
+    end
+  end
+
+  def type
+    FILE_EXTENSION_MAPPINGS[extension]
+  end
+
+  def to_s
+    file.to_s
+  end
+
+  protected
+
+  attr_accessor :path
+
+  def path=(other)
+    @path = Pathname.new(other)
+  end
+
+  def file
+    @file ||= if path.file?
+                path
+              else
+                Pathname.glob(path).fetch(0, Pathname.new(''))
+              end
+  end
+
+  private
+
+  def extension
+    file.extname
+  end
+end
+end
+end