pushcart 0.0.1.proto1

data/lib/pushcart/deliverable.rb

@@ -0,0 +1,5 @@
+module Pushcart
+  module Deliverable
+    extend ActiveSupport::Concern
+  end
+end

data/lib/pushcart/engine.rb

@@ -0,0 +1,5 @@
+module Pushcart
+  class Engine < ::Rails::Engine
+    isolate_namespace Pushcart
+  end
+end

data/lib/pushcart/errors.rb

@@ -0,0 +1,4 @@
+module Pushcart
+  class ConfigurationError < StandardError
+  end
+end

data/lib/pushcart/requestable.rb

@@ -0,0 +1,68 @@
+module Pushcart
+  module Requestable
+    extend ActiveSupport::Concern
+
+    def request_subscription
+      request(:subscription)
+    end
+
+    def request_renewal
+      update_columns(
+        renewal_requested_at: nil,
+        renewal_request_responded_at: nil,
+        renewal_request_response_code: nil,
+        renewal_request_response_error: nil,
+        renewal_denied_at: nil,
+        renewal_denial_reason: nil,
+        renewal_challenged_at: nil,
+        renewal_verified_at: nil,
+      )
+
+      request(:renewal)
+    end
+
+    def request_unsubscription
+      request(:unsubscription)
+    end
+
+    def request(type)
+      modes = {
+        subscription:     "subscribe",
+        renewal:          "subscribe",
+        unsubscription:   "unsubscribe"
+      }
+
+      mode = mode[type]
+      prefix = types.to_s
+
+      # Subscriber Sends Subscription Request
+
+      update_attribute(:"#{prefix}_requested_at", Time.now)
+      response = connection(mode: mode).post(hub)
+
+      # Subscription Response Details
+
+      update_attribute(:"#{prefix}_request_responded_at", Time.now)
+      update_attribute(:"#{prefix}_request_response_code", response.status)
+
+      (response.status == 202) ? _accepted(response) : _rejected(response)
+    end
+
+    # If the request was accepted, trigger the +receive+ event on the state
+    # machine (which will transition to different states depending on whether
+    # this is a subscribe, renew, or unsubscribe request).
+    def _accepted(response)
+      receive!
+    end
+
+    # If the request was not accepted for any reason (rejected by the hub, or
+    # the response returned any status other than 202), trigger the +reject+
+    # event. This will move the subscription to a `rejected` state regardless
+    # of what kind of request was made.
+    # TODO Make sure unsub. rejections are being handled correctly.
+    def _rejected(response)
+      update_attribute(:"#{prefix}_request_response_error", request_response.body)
+      reject!
+    end
+  end
+end

data/lib/pushcart/stateable.rb

@@ -0,0 +1,166 @@
+module Pushcart
+  module Stateable
+    extend ActiveSupport::Concern
+    include AASM
+
+    included do
+      aasm do
+        state :undiscovered, initial: true
+      #   state :discovered
+      #
+      #   state :requesting
+      #   state :received
+      #   state :verified
+      #
+      #   state :rerequesting
+      #   state :rereceived
+      #
+      #   state :unrequesting
+      #   state :unreceived
+      #
+      #   state :canceled
+      #   state :rejected
+      #   state :denied
+      #   state :unsubscribed
+      #   state :lapsed
+      #
+      #   event :cancel do
+      #     transitions from: [:undiscovered, :discovered, :requesting, :received], to: :canceled
+      #   end
+      #
+      #   event :discover, if: :discoverable? do
+      #     transitions from: :undiscovered, to: :discovered
+      #   end
+      #
+      #   event :request do
+      #     transitions from: :discovered, to: :requesting
+      #     transitions from: :verified, to: :rerequesting
+      #
+      #     # If the request state change is successful, actually trigger the
+      #     # request based on whether it's a renewal or not.
+      #     success do
+      #       rerequesting? ? request_renewal : request_subscription
+      #     end
+      #   end
+      #
+      #   event :receive do
+      #     transitions from: :requesting, to: :received
+      #     transitions from: :rerequesting, to: :rereceived
+      #     transitions from: :unrequesting, to: :unreceived
+      #   end
+      #
+      #   event :verify, unless: :terminated?, success: Proc.new {|*args| _verify_success(*args) } do
+      #     transitions from: [:requesting, :received, :rerequesting, :rereceived], to: :verified
+      #     transitions from: [:unrequesting, :unreceived], to: :unsubscribed
+      #   end
+      #
+      #   event :reject do
+      #     transitions from: [:requesting, :rerequesting], to: :rejected
+      #     # transitions from: :unrequesting, to: :?? TODO
+      #   end
+      #
+      #   event :unsubscribe, unless: :terminated? do
+      #     transitions from: [:verified, :rerequesting, :rereceived], to: :unrequesting
+      #   end
+      #
+      #   event :deny do
+      #     # TODO `after` seems like the wrong callback here, but the docs say it
+      #     # will happen before the transition...
+      #     transitions from: [:requesting, :received, :verified, :rerequesting, :rereceived, :unrequesting, :unreceived], to: :denied, after: Proc.new {|*args| _deny_after(*args) }
+      #   end
+      #
+      #   event :lapse do
+      #     transitions from: [:verified, :rerequesting, :rereceived, :unrequesting, :unreceived], to: :lapsed
+      #   end
+      end
+    end
+
+    # TODO Make sure this callback is happening at the right point in the chain
+    def _verify_success(lease)
+      if unsubscribed?
+        update_attribute(:unsubscription_verified_at, Time.now)
+      elsif renewal_requested_at
+        # TODO Find a better way to know if this is a renewal
+        increment!(:renewals)
+        update_attribute(:renewal_verified_at, Time.now)
+      else
+        update_attribute(:subscription_verified_at, Time.now)
+      end
+    end
+
+    # TODO Make sure this callback is happening at the right point in the chain
+    def _deny_after(reason)
+      # NOTE: Unsubscribe requests should never be denied during validation, so
+      # even if a denial request comes in while the subscription is in an
+      # `unsubscribing?` state, it is assumed that the denial is unrelated to
+      # that request, and the denial will be attached to either the originally
+      # subscription, or the most recent renewal.
+      if renewing? || renewed?
+        update_attribute(:renewal_denied_at, Time.now)
+        update_attribute(:renewal_denial_reason, reason)
+      else
+        update_attribute(:subscription_denied_at, Time.now)
+        update_attribute(:subscription_denial_reason, reason)
+      end
+    end
+
+    def discoverable?
+      # TODO has all the info it needs to make a request
+    end
+
+    # Returns `true` if the subscription has a pending initial subscription
+    # request or renewal request open with the hub.
+    def subscribing?
+      !expired && (renewing? || requesting? || received?)
+    end
+
+    # Returns `true` if the subscription has a pending subscription renewal
+    # request open with the hub.
+    def renewing?
+      !expired? && (rerequesting? || rereceived?)
+    end
+
+    # Return `true` if this subscription has ever been successfully renewed,
+    # even if it has since been terminated (by expiring, unsubscribing, etc).
+    def renewed?
+      renewals > 0
+    end
+
+    # Returns `true` if the subscription has a pending unsubscription
+    # request open with the hub.
+    def unsubscribing?
+      !expired? && (unrequesting? || unreceived?)
+    end
+
+    # Returns `true` if the subscription has been verified, and has not expired
+    # or been otherwise invalidated (denied, unsubscribed, etc). When a
+    # subscription is `active` it is expecting to get updates from the hub.
+    # Once a subscription has been verified, it remains active throughout
+    # the renewal and unsubscribe processes unless something invalidates it.
+    def active?
+      !expired? && (verified? || renewing? || unsubscribing?)
+    end
+
+    # Returns `true` if the subscription (and any subsequent renewals) have
+    # exceeded the lease provided by the hub. Because expiration is passive and
+    # has results in no callbacks, it is possible that a subscription expired
+    # without its state being updated to reflect the change. Any time +expired?+
+    # is called, it will ensure the state is in sync with reality.
+    # @return [true, false]
+    def expired?
+      return true if lapsed?
+
+      if expired_at <= Time.now
+        lapse if may_lapse?
+
+        return true
+      end
+    end
+
+    # Returns `true` if the subscription has been canceled for any reason, such
+    # as expiring or being ended by the hub.
+    def terminated?
+      canceled? || rejected? || denied? || unsubscribed? || lapsed? || expired?
+    end
+  end
+end

data/lib/pushcart/subscribable.rb

@@ -0,0 +1,25 @@
+module Pushcart
+  module Subscribable
+    extend ActiveSupport::Concern
+    include Composable
+
+    included do
+      # Callbacks
+      # before_validation(on: :create) do
+      #   # Create a secret key that the hub will use to generate HMAC digests,
+      #   # allowing for validation of content delivery payloads.
+      #   # NOTE: Must be less than 200 bytes in length.
+      #   self.hmac_secret_key = SecureRandom.hex
+      # end
+
+      # Validations
+      validates :hub, presence: true, url: true
+      validates :topic, presence: true, url: true
+      validates :topic_content_type, presence: true
+      validates :hmac_secret_key, presence: true
+
+      # Scopes
+      # scope :expired, -> { where(["expired_at <= ?", Time.now]) }
+    end
+  end
+end

data/lib/pushcart/version.rb

@@ -0,0 +1,3 @@
+module Pushcart
+  VERSION = "0.0.1.proto1"
+end

data/lib/tasks/pushcart_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pushcart do
+#   # Task goes here
+# end

data/test/connectable_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+class ConnectableTest < ActiveSupport::TestCase
+  fixtures :subscriptions
+
+  def setup
+    @subscription = subscriptions(:example)
+  end
+
+  test "callback URI errors when missing config values" do
+    ENV["PUSH_CALLBACK_SCHEME"] = nil
+    assert_raises(Pushcart::ConfigurationError) { @subscription.callback_uri }
+    ENV["PUSH_CALLBACK_SCHEME"] = "http"
+  end
+
+  test "callback URI errors when missing id" do
+    @subscription.id = nil
+    assert_raises(ArgumentError) { @subscription.callback_uri }
+  end
+
+  test "returns an entire callback URL" do
+    assert_equal "http://pubsub.example.com:88/subscriptions/1/callback", @subscription.callback_uri.to_s
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path("../config/application", __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/subscription.rb

@@ -0,0 +1,9 @@
+class Subscription < ActiveRecord::Base
+  include Pushcart::Subscribable
+  # before_validation(on: :create) do
+  #   # Create a secret key that the hub will use to generate HMAC digests,
+  #   # allowing for validation of content delivery payloads.
+  #   # NOTE: Must be less than 200 bytes in length.
+  #   self.hmac_secret_key = SecureRandom.hex
+  # end
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end