pubsubhubbub-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03e9b6b69ab33bb77de497c4f4ab2390c07e042a
+  data.tar.gz: cd017828e6c4251cdad04a1bf1a567d19b892004
+SHA512:
+  metadata.gz: f479aa3bcbdb92e5f6ca7b0f63360d2c6b678b7f65d3f8f0831076264e90151cafcc77717581fd92d5cfeeb2f6f61ed2fc935ee8cc5be00bb2cf9454b76cd974
+  data.tar.gz: 70e2f01dc594db5732642cc78c9fd50f81c94a8abd54b44556cba23e7030c36159c5d25416230be3919b4a5b2de861d7d96586379a3c804ee3b619207214f249

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Eugen Rochko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Pubsubhubbub
+
+This is a mountable PubSubHubbub server conforming to the v0.4 of the spec.
+
+## Usage
+
+In `routes.rb`:
+
+    mount Pubsubhubbub::Engine => '/pubsubhubbub', as: :pubsubhubbub
+
+In feed:
+
+    <link rel="hub" href="<%= pubsubhubbub_hub_url %>" />
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pubsubhubbub-rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install pubsubhubbub-rails
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pubsubhubbub'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/pubsubhubbub/application_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Pubsubhubbub
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/pubsubhubbub/subscriptions_controller.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+require_dependency 'pubsubhubbub/application_controller'
+
+module Pubsubhubbub
+  class SubscriptionsController < ApplicationController
+    def index
+      @callback      = params['hub.callback']
+      @mode          = params['hub.mode']
+      @topic         = params['hub.topic']
+      @lease_seconds = params['hub.lease_seconds']
+      @secret        = params['hub.secret']
+      @url           = params['hub.url']
+
+      case @mode
+      when 'subscribe'
+        subscribe
+      when 'unsubscribe'
+        unsubscribe
+      when 'publish'
+        publish
+      else
+        render plain: 'Unknown mode', status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def check_topic_hub
+      uri      = Addressable::URI.parse(@topic)
+      response = HTTP.get(uri)
+
+      if response['Link']
+        link  = LinkHeader.parse(response['Link'].is_a?(Array) ? response['Link'].first : response['Link'])
+        hub   = link.find_link(%w(rel hub))
+        topic = link.find_link(%w(rel self))
+
+        return true if hub&.href == hub_url && topic&.href == @topic
+      end
+
+      xml = Nokogiri::XML(response.body)
+      xml.encoding = 'utf-8'
+
+      link  = xml.at_xpath('//xmlns:link[@rel="hub"]')
+      topic = xml.at_xpath('//xmlns:link[@rel="self"]')
+
+      link['href'] == hub_url && topic['href'] == @topic
+    end
+
+    def subscribe
+      render(plain: 'Missing callback URL', status: :unprocessable_entity) && return if @callback.blank?
+      render(plain: 'Missing topic URL', status: :unprocessable_entity) && return if @topic.blank?
+      render(plain: 'Topic advertises a different hub or topic URL', status: :unprocessable_entity) && return unless check_topic_hub
+
+      @subscription = Subscription.where(topic: @topic, callback: @callback).first_or_initialize(topic: @topic, callback: @callback, mode: @mode, secret: @secret)
+      @subscription.lease_seconds = @lease_seconds
+      @subscription.save!
+
+      VerifyIntentJob.perform_later(@subscription.id)
+
+      head 202
+    end
+
+    def unsubscribe
+      render(plain: 'Missing callback URL', status: :unprocessable_entity) && return if @callback.blank?
+      render(plain: 'Missing topic URL', status: :unprocessable_entity) && return if @topic.blank?
+      render(plain: 'Topic advertises a different hub or topic URL', status: :unprocessable_entity) && return unless check_topic_hub
+
+      @subscription = Subscription.where(topic: @topic, callback: @callback).first
+
+      head 202 && return if @subscription.nil?
+      @subscription.destroy && head(202) && return unless @subscription.confirmed?
+
+      @subscription.update!(mode: @mode)
+      VerifyIntentJob.perform_later(@subscription.id)
+
+      head 202
+    end
+
+    def publish
+      render(plain: 'Missing URL', status: :unprocessable_entity) && return if @url.blank?
+      FetchTopicJob.perform_later(hub_url, @url)
+      head 202
+    end
+  end
+end

data/app/jobs/pubsubhubbub/application_job.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Pubsubhubbub
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/pubsubhubbub/deliver_payload_job.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pubsubhubbub
+  class DeliverPayloadJob < ApplicationJob
+    queue_as :push
+
+    def perform(hub_url, subscription_id, current_payload)
+      subscription = Subscription.find(subscription_id)
+      link         = LinkHeader.new([[hub_url, [%w(rel hub)]], [subscription.topic, [%w(rel self)]]])
+      headers      = {}
+
+      headers['Link']            = link
+      headers['X-Hub-Signature'] = sign_payload(subscription.secret, current_payload) if subscription.secret
+
+      response = HTTP.timeout(:per_operation, write: 60, connect: 20, read: 60)
+                     .headers(headers)
+                     .post(subscription.callback, body: current_payload)
+
+      raise FailedDeliveryError unless response.code > 199 && response.code < 300
+    end
+
+    private
+
+    def sign_payload(secret, payload)
+      OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), secret, payload)
+    end
+  end
+end

data/app/jobs/pubsubhubbub/fetch_topic_job.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Pubsubhubbub
+  class FetchTopicJob < ApplicationJob
+    queue_as :push
+
+    def perform(hub_url, url)
+      return unless Subscription.where(topic: url).active.any?
+      current_payload = HTTP.timeout(:per_operation, write: 60, connect: 20, read: 60).get(url).body.to_s
+
+      Subscription.where(topic: url).active.find_each do |subscription|
+        DeliverPayloadJob.perform_later(hub_url, subscription.id, current_payload)
+      end
+    end
+  end
+end

data/app/jobs/pubsubhubbub/verify_intent_job.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Pubsubhubbub
+  class VerifyIntentJob < ApplicationJob
+    queue_as :push
+
+    def perform(subscription_id)
+      subscription = Subscription.find(subscription_id)
+      verified     = verify_intent(subscription)
+
+      if verified && subscription.mode == 'subscribe'
+        subscription.update(confirmed: true)
+      else
+        subscription.destroy
+      end
+    end
+
+    private
+
+    def verify_intent(subscription)
+      uri = Addressable::URI.parse(subscription.callback)
+      response = HTTP.timeout(:per_operation, write: 60, connect: 20, read: 60).get(uri, params: { 'hub.mode' => subscription.mode, 'hub.topic' => subscription.topic, 'hub.challenge' => subscription.challenge, 'hub.lease_seconds' => subscription.lease_seconds })
+      response.code > 199 && response.code < 300 && response.body.to_s == subscription.challenge
+    end
+  end
+end

data/app/models/pubsubhubbub/application_record.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Pubsubhubbub
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/pubsubhubbub/subscription.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Pubsubhubbub
+  class Subscription < ApplicationRecord
+    validates :topic, :callback, :mode, presence: true
+
+    scope :active, -> { where(confirmed: true).where('expires_at > ?', Time.now.utc) }
+
+    def lease_seconds
+      (expires_at - Time.now.utc).to_i
+    end
+
+    def lease_seconds=(seconds)
+      self.expires_at = Time.now.utc + [[3600 * 24, seconds.to_i].max, 3600 * 24 * 30].min.seconds
+    end
+
+    before_validation :generate_challenge
+
+    private
+
+    def generate_challenge
+      self.challenge = SecureRandom.hex
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+Pubsubhubbub::Engine.routes.draw do
+  post '/', to: 'subscriptions#index', as: :hub
+end

data/db/migrate/20161126203748_create_pubsubhubbub_subscriptions.rb

@@ -0,0 +1,17 @@
+class CreatePubsubhubbubSubscriptions < ActiveRecord::Migration[5.0]
+  def change
+    create_table :pubsubhubbub_subscriptions do |t|
+      t.string :topic, null: false, default: ''
+      t.string :callback, null: false, default: ''
+      t.string :mode, null: false, default: ''
+      t.string :challenge, null: false, default: ''
+      t.string :secret, null: true, default: nil
+      t.boolean :confirmed, null: false, default: false
+      t.datetime :expires_at, null: false
+
+      t.timestamps
+    end
+
+    add_index :pubsubhubbub_subscriptions, [:topic, :callback], unique: true
+  end
+end

data/lib/pubsubhubbub.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+require 'pubsubhubbub/engine'
+require 'addressable/uri'
+require 'nokogiri'
+require 'http'
+require 'link_header'
+require 'httplog'
+
+module Pubsubhubbub
+  class FailedDeliveryError < StandardError
+  end
+end

data/lib/pubsubhubbub/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Pubsubhubbub
+  class Engine < ::Rails::Engine
+    isolate_namespace Pubsubhubbub
+  end
+end

data/lib/pubsubhubbub/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Pubsubhubbub
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: pubsubhubbub-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eugen Rochko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: link_header
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httplog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A PubSubHubbub server conforming to the v0.4 spec, mountable from a Rails
+  app
+email:
+- eugen@zeonfederated.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/pubsubhubbub/application_controller.rb
+- app/controllers/pubsubhubbub/subscriptions_controller.rb
+- app/jobs/pubsubhubbub/application_job.rb
+- app/jobs/pubsubhubbub/deliver_payload_job.rb
+- app/jobs/pubsubhubbub/fetch_topic_job.rb
+- app/jobs/pubsubhubbub/verify_intent_job.rb
+- app/models/pubsubhubbub/application_record.rb
+- app/models/pubsubhubbub/subscription.rb
+- config/routes.rb
+- db/migrate/20161126203748_create_pubsubhubbub_subscriptions.rb
+- lib/pubsubhubbub.rb
+- lib/pubsubhubbub/engine.rb
+- lib/pubsubhubbub/version.rb
+homepage: https://github.com/Gargron/pubsubhubbub
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A PubSubHubbub server conforming to the v0.4 spec, mountable from a Rails
+  app
+test_files: []