pubsubhubbub4r 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37ad0d3e0c9a3befab14f9ed2bfacfb58656b26d
+  data.tar.gz: 38441d457c5aa08c1abc3b2bd6008979ff509a4e
+SHA512:
+  metadata.gz: 45141faed9709d6696c731cd60fbfbed0a976e245af46f1204f02639ca8eb6edfb7cf4d8e4d4eacd44c955efd15c0364ffc35749986f2c8fedb75ce6c4b98b16
+  data.tar.gz: 7a5de4c27806adb6d30094584222fef1967bc56d7b7f8d9d0114e797c76adfa341aee27b68b3adcc1eda775d4d6fccf73b1f8d06278be30b4443281a7efe0fca

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pubsubhubbub4r.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 choonkeat
+
+MIT License
+
+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,31 @@
+# Pubsubhubbub4r
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pubsubhubbub4r'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pubsubhubbub4r
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pubsubhubbub4r/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/README.rdoc

@@ -0,0 +1,85 @@
+= Pubsubhubbub4r
+
+Simple pubsubhubbub client lib for Ruby. API is Rails-friendly, not dependent.
+
+== Files
+
+  |-- README.rdoc
+  `-- lib
+      `-- pubsubhubbub4r
+          `-- client.rb
+
+== Example Rails controller
+
+  require 'pubsubhubbub4r/client'
+  class BasicPubsubhubbubController < ApplicationController
+    def notify
+      client = Pubsubhubbub4r::Client.new(Rails.cache, Rails.logger)
+      case params['hub.challenge'] && params['hub.mode']
+      when nil
+        # doc = Hpricot(request.body.read) # parse XML from "request.body.read"
+        # response.headers['X-Hub-On-Behalf-Of'] = 1 # optional subscriber count
+        render :nothing => true
+      when 'subscribe'
+        if reply = client.verify(params)
+          render :text => reply
+        else
+          render :nothing => true, :status => 404
+        end
+      when 'unsubscribe'
+        if reply = client.verify(params)
+          render :text => reply
+        else
+          render :nothing => true, :status => 404
+        end
+      end
+    end
+  end
+
+== Example script/console usage with BasicPubsubhubbubController
+
+Setup
+  require 'pubsubhubbub4r/client'
+  atom_url = "http://feedproxy.google.com/TechCrunch"
+  hub_url  = "http://pubsubhubbub.appspot.com"
+  callback_url = app.url_for(:only_path => false, :controller => 'basic_pubsubhubbub', :action => 'notify')
+  client   = Pubsubhubbub4r::Client.new(Rails.cache, Rails.logger)
+
+Subscribe
+  leased_seconds = client.subscribe(hub_url, atom_url, callback_url)
+  if leased_seconds
+    puts "Hub verified subscription until #{Time.now + leased_seconds}"
+  else
+    puts "Hub will asynchronously verify subscription at BasicPubsubhubbubController#notify"
+  end
+
+Unsubscribe
+  verified = client.unsubscribe(hub_url, atom_url, callback_url)
+  if verified
+    puts "Hub verified unsubscribe-request on the spot."
+  else
+    puts "Hub will asynchronously verify unsubscribe-request at BasicPubsubhubbubController#notify"
+  end
+
+== Example didn't work
+
+Make sure you've configured Rails.cache in your config/environments/development.rb or config/environments/production.rb; By default, memory cache is used, and data there cannot be shared between script/console and script/server. (Maglev?)
+
+e.g.
+  config.cache_store = :file_store
+
+== Production practice
+
+You can "subscribe" and Hubs can "verify". But don't fully trust things to work after that. Continue
+to use polling for any feed until you get notified (at least ONCE) of new content from the hub. Sad
+but true.
+
+== Further reading
+
+- http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.1.html
+- http://code.google.com/p/pubsubhubbub/
+- http://github.com/igrigorik/PubSubHubbub
+
+== License
+
+Copyright (c) 2009 Chew Choon Keat, released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/pubsubhubbub4r/client.rb

@@ -0,0 +1,87 @@
+begin
+  require 'digest/sha1'
+rescue LoadError
+  require 'sha1'
+end
+
+module Pubsubhubbub4r
+  class Client
+    HTTP_TIMEOUT = 60
+    attr_accessor :cache, :logger, :headers, :post_data_overrides
+
+    def initialize(cache, logger = nil, headers = nil, post_data_overrides = nil)
+      # "cache" and "logger" must respond like Rails.cache / Rails.logger
+      @cache = cache
+      @logger = logger
+      @headers = headers
+      # e.g. {'hub.verify' => 'sync'}
+      @post_data_overrides = post_data_overrides
+    end
+
+    def subscribe(hub_url, topic, callback_url, lease_seconds = 2592000, ack_timeout_seconds = 86400)
+      post('subscribe', hub_url, topic, callback_url, lease_seconds, ack_timeout_seconds)
+    end
+
+    def unsubscribe(hub_url, topic, callback_url, lease_seconds = 2592000, ack_timeout_seconds = 86400)
+      post('unsubscribe', hub_url, topic, callback_url, lease_seconds, ack_timeout_seconds)
+    end
+
+    def verify(params)
+      cache_key = verification_cache_key(params['hub.verify_token'])
+      cached_secret = self.cache.read(cache_key)
+      new_secret = verification_secret(params['hub.mode'], params['hub.topic'])
+      self.logger.debug "verifying #{cache_key.inspect}: #{cached_secret.inspect} vs #{new_secret.inspect}" if self.logger
+      if cached_secret && cached_secret == new_secret
+        self.cache.delete(cache_key)
+        params['hub.challenge']
+      else
+        false
+      end
+    end
+
+    protected
+
+      def verification_cache_key(verify_token)
+        "verify_token-#{verify_token}"
+      end
+
+      def verification_secret(mode, topic)
+        [mode, topic].join("#")
+      end
+
+      def post(mode, hub_url, topic, callback_url, lease_seconds, ack_timeout_seconds)
+        verify_token = SHA1.hexdigest("#{[mode, topic, callback_url, lease_seconds, rand(ack_timeout_seconds), Time.now.to_f].join('.')}")
+        cache_key = verification_cache_key(verify_token)
+        self.cache.write(cache_key, verification_secret(mode, topic))
+        uri = URI.parse(hub_url)
+        request_headers = { 'User-Agent' => 'Pubsubhubbub4r::Client' }.merge(self.headers || {})
+        request = Net::HTTP::Post.new(uri.request_uri, request_headers)
+        request.form_data = {
+          'hub.mode' => mode,
+          'hub.callback' => callback_url,
+          'hub.topic' => topic,
+          'hub.verify_token' => verify_token,
+          'hub.lease_seconds' => lease_seconds,
+          'hub.verify' => 'async',
+        }.merge(self.post_data_overrides || {})
+        session = Net::HTTP.new(uri.host, uri.port)
+        session.use_ssl = true if uri.scheme == "https"
+        response = session.start do |http|
+          http.read_timeout = HTTP_TIMEOUT
+          yield http if block_given?
+          http.request(request)
+        end
+        case response && response.code.to_s
+        when "204"
+          self.cache.delete(cache_key)
+          self.logger.debug "#{mode} : verified" if self.logger
+          lease_seconds
+        when "202"
+          self.logger.debug "#{mode} : accepted, verify later" if self.logger
+          nil
+        else
+          raise "#{response.code} #{response.message} #{response.body}".strip
+        end
+      end
+  end
+end

data/lib/pubsubhubbub4r/version.rb

@@ -0,0 +1,3 @@
+module Pubsubhubbub4r
+  VERSION = "0.0.1"
+end

data/lib/pubsubhubbub4r.rb

@@ -0,0 +1,5 @@
+require "pubsubhubbub4r/version"
+require "pubsubhubbub4r/client"
+
+module Pubsubhubbub4r
+end

data/pubsubhubbub4r.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pubsubhubbub4r/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pubsubhubbub4r"
+  spec.version       = Pubsubhubbub4r::VERSION
+  spec.authors       = ["choonkeat"]
+  spec.email         = ["choonkeat@gmail.com"]
+  spec.summary       = %q{Simple pubsubhubbub client lib for Ruby. API is Rails-friendly, not Rails-dependent}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: pubsubhubbub4r
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- choonkeat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- choonkeat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- lib/pubsubhubbub4r.rb
+- lib/pubsubhubbub4r/client.rb
+- lib/pubsubhubbub4r/version.rb
+- pubsubhubbub4r.gemspec
+homepage: ''
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Simple pubsubhubbub client lib for Ruby. API is Rails-friendly, not Rails-dependent
+test_files: []