hootenanny 0.0.1 → 0.1.0

data/.gitignore

@@ -31,5 +31,6 @@ capybara-*
 *.scssc
 spec/dummy/tmp
 spec/dummy/db/schema.rb
+pkg/
 
 *_spec.js

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+script: cd spec/dummy && rake db:create:all db:migrate db:test:prepare && cd ../.. && bundle exec rspec spec

data/Gemfile

@@ -17,10 +17,8 @@ gem "jquery-rails"
 # gem 'debugger'
 gem 'strong_parameters'
 
-gem 'rspectacular', :require => false
-gem 'database_cleaner'
-gem 'sqlite3'
-gem 'rspec-rails'
-gem 'shoulda-matchers'
-gem 'factory_girl_rails'
-gem 'awesome_print'
+group :development do
+  gem 'pry'
+  # gem 'pry-plus'
+  gem 'awesome_print'
+end

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    hootenanny (0.0.1)
+    hootenanny (0.1.0)
+      chronological (~> 1.0.0beta10)
+      faraday (~> 0.8.7)
       rails (~> 3.2)
       strong_parameters (~> 0.2.1)
 
@@ -35,10 +37,14 @@ GEM
     activesupport (3.2.13)
       i18n (= 0.6.1)
       multi_json (~> 1.0)
+    addressable (2.3.4)
     arel (3.0.2)
     awesome_print (1.1.0)
     builder (3.0.4)
-    database_cleaner (1.0.1)
+    chronological (1.0.0beta10)
+    coderay (1.0.9)
+    crack (0.3.2)
+    database_cleaner (0.9.1)
     diff-lcs (1.2.4)
     erubis (2.7.0)
     factory_girl (4.2.0)
@@ -46,11 +52,13 @@ GEM
     factory_girl_rails (4.2.1)
       factory_girl (~> 4.2.0)
       railties (>= 3.0.0)
-    fuubar (1.1.0)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    fuubar (1.1.1)
       rspec (~> 2.0)
       rspec-instafail (~> 0.2.0)
-      ruby-progressbar (~> 1.0.0)
-    hike (1.2.2)
+      ruby-progressbar (~> 1.0)
+    hike (1.2.3)
     i18n (0.6.1)
     journey (1.0.4)
     jquery-rails (2.2.1)
@@ -60,10 +68,16 @@ GEM
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
+    method_source (0.8.1)
     mime-types (1.23)
-    multi_json (1.7.3)
+    multi_json (1.7.6)
+    multipart-post (1.2.0)
     pg (0.15.1)
     polyglot (0.3.3)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rack (1.4.5)
     rack-cache (1.2)
       rack (>= 0.4)
@@ -89,57 +103,61 @@ GEM
     rake (10.0.4)
     rdoc (3.12.2)
       json (~> 1.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
+    rspec (2.14.0.rc1)
+      rspec-core (= 2.14.0.rc1)
+      rspec-expectations (= 2.14.0.rc1)
+      rspec-mocks (= 2.14.0.rc1)
+    rspec-core (2.14.0.rc1)
+    rspec-expectations (2.14.0.rc1)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-instafail (0.2.4)
-    rspec-mocks (2.13.1)
-    rspec-rails (2.13.2)
+    rspec-mocks (2.14.0.rc1)
+    rspec-rails (2.14.0.rc1)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
+      rspec-core (= 2.14.0.rc1)
+      rspec-expectations (= 2.14.0.rc1)
+      rspec-mocks (= 2.14.0.rc1)
     rspectacular (0.13.0)
       fuubar (~> 1.0)
       rspec (~> 2.12)
-    ruby-progressbar (1.0.2)
-    shoulda-matchers (2.1.0)
-      activesupport (>= 3.0.0)
+    ruby-progressbar (1.1.1)
+    slop (3.4.5)
     sprockets (2.2.2)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.7)
     strong_parameters (0.2.1)
       actionpack (~> 3.0)
       activemodel (~> 3.0)
       railties (~> 3.0)
     thor (0.18.1)
     tilt (1.4.1)
-    treetop (1.4.12)
+    timecop (0.6.1)
+    treetop (1.4.14)
       polyglot
       polyglot (>= 0.3.1)
     tzinfo (0.3.37)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   awesome_print
-  database_cleaner
-  factory_girl_rails
+  database_cleaner (~> 0.9.1)
+  factory_girl_rails (~> 4.2)
   hootenanny!
   jquery-rails
   pg
-  rspec-rails
-  rspectacular
-  shoulda-matchers
-  sqlite3
+  pry
+  rspec (~> 2.14.0.rc1)
+  rspec-rails (~> 2.14.0.rc1)
+  rspectacular (~> 0.13)
   strong_parameters
+  timecop (~> 0.6.1)
+  webmock (~> 1.11)

data/app/controllers/hootenanny/notifications_controller.rb

@@ -0,0 +1,31 @@
+require 'hootenanny/hub'
+require 'controllers/hootenanny/parameters'
+
+module  Hootenanny
+class   PublishNotificationsController < ActionController::Base
+  include Hootenanny::Parameters
+
+  def create
+    if Hootenanny::Hub.notify_of_publication(publish_notification_request)
+      render :nothing => true, :status => :no_content
+    end
+  rescue Hootenanny::Error => error
+    render json:    error,
+           status:  :bad_request
+  end
+
+  private
+
+  def publish_notification_request
+    @request ||= Hootenanny::Hub.request publish_notification_request_params
+  end
+
+  def publish_notification_request_params
+    params[:type] ||= :publish_notification
+
+    params.permit(:url)
+
+    params
+  end
+end
+end

data/app/controllers/hootenanny/parameters.rb

@@ -0,0 +1,16 @@
+module  Hootenanny
+module  Parameters
+  extend ActiveSupport::Concern
+
+  included do
+    rescue_from(ActionController::ParameterMissing) do |parameter_missing_exception|
+      render  json:    {
+                         error: {
+                           message: "Required parameter missing: #{parameter_missing_exception.param}"
+                         }
+                       },
+              status:  :bad_request
+    end
+  end
+end
+end

data/app/controllers/hootenanny/subscriptions_controller.rb

@@ -1,14 +1,35 @@
 require 'hootenanny/hub'
+require 'controllers/hootenanny/parameters'
 
 module  Hootenanny
 class   SubscriptionsController < ActionController::Base
+  include Hootenanny::Parameters
+
   def create
-    if Hootenanny::Hub.subscribe(params[:callback], to: params[:topic])
+    if Hootenanny::Hub.subscribe(subscription_request)
       render :nothing => true, :status => :no_content
     end
-  rescue Hootenanny::SubscriptionAssignmentError => e
-    render json:    { error: e.to_h },
+  rescue Hootenanny::Error => error
+    render json:    error,
            status:  :bad_request
   end
+
+  private
+
+  def subscription_request
+    @request ||= Hootenanny::Hub.request subscription_request_params
+  end
+
+  def subscription_request_params
+    params[:type] ||= :subscription
+
+    params.require(:callback)
+    params.require(:topic)
+    params.permit(:lease_seconds,
+                  :verify_token,
+                  :secret)
+
+    params
+  end
 end
 end

data/app/models/hootenanny/publish_notification.rb

@@ -0,0 +1,90 @@
+require 'hootenanny/uri'
+
+module    Hootenanny
+class     PublishNotification < ActiveRecord::Base
+  self.table_name = 'hootenanny_publish_notifications'
+
+  ###
+  # Private: Retrieves a set of notifications for a given set of topics. If
+  # given one topic, only one notification should be returned since there can
+  # only be one notification for a given topic in the queue at any time.
+  #
+  # topic - A String or an Array representing the Topic to look for.
+  #
+  # Examples:
+  #
+  #   Hootenanny::PublishNotification.for('http://mytopic')
+  #   #=> <ActiveRecord::Relation>
+  #
+  #   Hootenanny::PublishNotification.for %w{http://mytopic
+  #                                          http://anothertopic}
+  #   #=> <ActiveRecord::Relation>
+  #
+  # Returns an ActiveRecord::Relation
+  #
+  def self.for(topic)
+    where(:topic => topic)
+  end
+
+  def self.unprocessed
+    where(:state => 'unprocessed')
+  end
+
+  def self.processed
+    where(:state => 'processed')
+  end
+
+  def self.expired
+    where(:state => 'expired')
+  end
+
+  ###
+  # Private: Creates a notification for a given topic. If the notification for
+  # the topic exists, it touches it to reflect the new update time and returns
+  # it.  It does _not_ create a new notification.
+  #
+  # topic - A String representing a URI of a topic which has been proposed to
+  #         have been updated.
+  #
+  # Examples:
+  #
+  #   Hootenanny::PublishNotification.notify('http://example.com')
+  #   # => <Hootenanny::PublishNotification topic: 'http://example.com'>
+  #
+  # Returns a Hootenanny::PublishNotification
+  # Raises a Hootenanny::URI::InvalidSchemeError if the topic URI are using
+  #   something other than HTTP or HTTPS
+  # Raises a Hootenanny::URI::InvalidError if the URI can't be parsed properly
+  #
+  def self.notify(topic)
+    topic = Hootenanny::URI.parse(topic).to_s
+
+    find_or_initialize(topic).touch
+  end
+
+  def self.each_unprocessed
+    unprocessed.find_each do |notification|
+      yield notification
+    end
+  end
+
+  def process
+    self.update_attributes(:state => 'processed')
+  end
+
+  def expire
+    self.update_attributes(:state => 'expired')
+  end
+
+  def processed?
+    self.state == 'processed'
+  end
+
+  private
+
+  def self.find_or_initialize(topic)
+    where(topic: topic).first ||
+    PublishNotification.create!(topic: topic)
+  end
+end
+end

data/app/models/hootenanny/subscription.rb

@@ -1,13 +1,26 @@
-require 'uri'
-require 'hootenanny/errors'
+require 'active_record'
+require 'chronological'
+require 'hootenanny/uri'
 
 module  Hootenanny
 class   Subscription < ActiveRecord::Base
+  extend Chronological
+
   self.table_name = 'hootenanny_subscriptions'
 
+  ###
+  # Chronological generates time range logic based on :started_at and
+  # :duration_in_seconds
+  #
+  timeframe type:     :duration_from_start,
+            duration: :lease_duration
+
   ###
   # Private: Finds all subscriptions which are subscribed to a given topic
   #
+  # It takes into account only _active_ subscriptions. If the subscription has
+  # expired, it will not be returned.
+  #
   # topic - A String represeenting a topic which has been subscribed to
   #
   # Example:
@@ -19,28 +32,39 @@ class   Subscription < ActiveRecord::Base
   #   subscriptions which are subscribed to the topic.
   #
   def self.to(topic)
-    where(:topic => topic)
+    active.where(:topic => topic.to_s)
   end
 
   ###
-  # Private: Assigns a given subscriber to a given topic URL by creating
+  # Private: Subscribes a given subscriber to a given topic URL by creating
   # a Subscription.
   #
+  # This operation is idempotent. It will not modify a subscription if one
+  # already exists for the subscriber/topic passed in.
+  #
   # options - A Hash of options
   #
-  #           :subscriber - A String representing the URI which should be
-  #                         notified when changes occur on the topic
-  #           :to         - A String representing the topic URI which is
-  #                         publishing the items that the subscriber is
-  #                         interested in.
+  #           :subscriber     - A String representing the URI which should be
+  #                             notified when changes occur on the topic
+  #           :to             - A String representing the topic URI which is
+  #                             publishing the items that the subscriber is
+  #                             interested in.
+  #           :digest_secret  - A String token of no more than 200 bytes which
+  #                             will be used during content distribution so that
+  #                             the subscriber can verify that the request is
+  #                             from the hub and not a undesired 3rd party
+  #                             (optional).
+  #           :lease_duration - A Number representing the length of time (in
+  #                             seconds) after the subscription is created until
+  #                             it should be considered invalid
   #
   # Example:
   #
   #   # If a subscription does not yet exist for the subscriber/topic, it
   #   # creates # a new Subscription
   #
-  #   Subscription.assign(subscriber: 'http://example.com/my_callback',
-  #                       to:         'http://example.org/my_topic')
+  #   Subscription.subscribe(subscriber: 'http://example.com/my_callback',
+  #                          to:         'http://example.org/my_topic')
   #
   #   # => <Subscription subscriber:  'http://example.com/my_callback',
   #                      topic:       'http://example.org/my_topic'>
@@ -48,24 +72,49 @@ class   Subscription < ActiveRecord::Base
   #
   #
   #   # If a subscription already exists for the subscriber/topic, it retrieves
-  #   # and returns the current Subscription
+  #   # and returns the current Subscription with all other attributes updated
+  #   # as if the subscription were new.
   #
-  #   Subscription.assign(subscriber: 'http://example.com/my_callback',
-  #                       to:         'http://example.org/my_topic')
+  #   Subscription.subscribe(subscriber:    'http://example.com/my_callback',
+  #                          to:            'http://example.org/my_topic',
+  #                          digest_secret: 'new_secret')
   #
-  #   # => <Subscription subscriber:  'http://example.com/my_callback',
-  #                      topic:       'http://example.org/my_topic'>
+  #   # => <Subscription subscriber:    'http://example.com/my_callback',
+  #                      topic:         'http://example.org/my_topic',
+  #                      digest_secret: 'new_secret'>
   #
   # Returns a Subscription
+  # Raises a Hootenanny::URI::InvalidSchemeError if the URIs are using something
+  #   other than HTTP or HTTPS
+  # Raises a Hootenanny::URI::InvalidError if the URI can't be parsed properly
   #
-  def self.assign(options = {})
-    subscriber = URI.parse(options.fetch(:subscriber)).to_s
-    topic      = URI.parse(options.fetch(:to)).to_s
+  def self.subscribe(options = {})
+    subscriber             = Hootenanny::URI.parse(options.fetch(:subscriber)).to_s
+    topic                  = Hootenanny::URI.parse(options.fetch(:to)).to_s
+
+    attrs                  = {}
+    attrs[:started_at]     = Time.now.utc
+    attrs[:digest_secret]  = options.fetch(:digest_secret, nil)
+    attrs[:lease_duration] = options.fetch(:lease_duration)
+
+    subscription = find_or_initialize(subscriber, topic)
+
+    subscription.update_attributes(attrs)
+
+    subscription
+  end
+
+  def subscriber
+    Hootenanny::URI.parse(read_attribute(:subscriber))
+  end
+
+  private
 
-    where( subscriber: subscriber, topic: topic).first ||
-    create(subscriber: subscriber, topic: topic)
-  rescue URI::InvalidURIError
-    raise Hootenanny::SubscriptionAssignmentError.new('All options passed need to be valid URIs')
+  def self.find_or_initialize(subscriber, topic)
+    where(subscriber: subscriber,
+          topic:      topic).first ||
+    Subscription.new(subscriber: subscriber,
+                     topic:      topic)
   end
 end
 end