rack-superfeedr 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'rack'
+gem 'nokogiri'
+gem 'typhoeus'
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 julien
+
+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.rdoc

@@ -0,0 +1,19 @@
+= rack-superfeedr
+
+A gem that provides a rack middleware to interact with Superfeedr's PubSubHubbub API. It let you subscribe, unsubscribe and receive incoming notifications.
+
+== Contributing to rack-superfeedr
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Superfeedr. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rack-superfeedr"
+  gem.homepage = "http://github.com/superfeedr/rack-superfeedr"
+  gem.license = "MIT"
+  gem.add_dependency "rack"
+  gem.add_dependency "nokogiri"
+  gem.add_dependency "typhoeus"
+  gem.summary = %Q{A gem that provides a rack middleware to interract with Superfeedr's API. }
+  gem.description = %Q{A gem that provides a rack middleware to interract with Superfeedr's API. }
+  gem.email = "julien@superfeedr.com"
+  gem.authors = ["julien51"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-superfeedr #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/examples/sinatra_app.rb

@@ -0,0 +1,21 @@
+require 'sinatra'
+require 'rack-superfeedr'
+
+use Rack::Superfeedr, { :host => "plant-leg.showoff.io", :login => "demo", :password => "demo", :format => "json", :async => false } do |superfeedr|
+  Superfeedr = superfeedr
+  superfeedr.on_notification do |notification|
+    puts notification.to_s
+  end
+end
+
+get '/hi' do
+  "Hello World!"
+end
+
+get '/subscribe' do
+  Superfeedr.subscribe("http://push-pub.appspot.com/feed", 123) 
+end
+
+get '/unsubscribe' do
+  Superfeedr.unsubscribe("http://push-pub.appspot.com/feed", 123)
+end

data/lib/rack-superfeedr.rb

@@ -0,0 +1,135 @@
+require 'base64'
+require 'typhoeus'
+require 'json'
+require 'nokogiri'
+
+module Rack
+  ##
+  # This is a Rack Middleware that can be used in your rack-compatible web framework (Rails, Sinatra...) to perform subscriptions over at superfeedr
+  # using the PubSubHubbub API.
+  class Superfeedr
+    
+    SUPERFEEDR_ENDPOINT = "http://superfeedr.com/hubbub"
+    
+    ##
+    # Subscribe you to a url. id is optional, but recommanded has a unique identifier for this url. It will be used to help you identify which feed
+    # is concerned by a notification.
+    # The optional block will be called to let you confirm the subscription (or not). 
+    # It returns true if the subscription was successful (or will be confirmed if you used async => true in the options), false otherwise
+    def subscribe(url, id, &block)
+      feed_id = "#{id ? id : Base64.urlsafe_encode64(url)}"
+      if block
+        @verifications[feed_id] ||= {}
+        @verifications[feed_id]['subscribe'] = block
+      end
+      response = Typhoeus::Request.post(SUPERFEEDR_ENDPOINT, 
+      :params => {
+        :'hub.mode' => 'subscribe', 
+        :'hub.verify' => @params[:async] ? 'async' : 'sync',
+        :'hub.topic' => url,
+        :'hub.callback' =>  generate_callback(url, feed_id)
+        },
+      :headers => {
+        :Accept => @params[:format] == "json" ? "application/json" : "application/atom+xml"
+        },
+      :username => @params[:login], 
+      :password => @params[:password]
+      )
+      @params[:async] && response.code == 202 || response.code == 204 # We return true to indicate the status.
+    end
+
+    ##
+    # Unsubscribes a url. If you used an id for the susbcription, you need to use _the same_.
+    # The optional block will be called to let you confirm the subscription (or not). This is not applicable for if you use params[:async] => true
+    # It returns true if the unsubscription was successful (or will be confirmed if you used async => true in the options), false otherwise
+    def unsubscribe(url, id, &block)
+      feed_id = "#{id ? id : Base64.urlsafe_encode64(url)}"
+      if block
+        @verifications[feed_id] ||= {}
+        @verifications[feed_id]['unsubscribe'] = block
+      end
+      response = Typhoeus::Request.post(SUPERFEEDR_ENDPOINT, 
+      :params => {
+        :'hub.mode' => 'unsubscribe', 
+        :'hub.verify' => @params[:async] ? 'async' : 'sync',
+        :'hub.topic' => url,
+        :'hub.callback' =>  generate_callback(url, feed_id)
+        },
+      :username => @params[:login], 
+      :password => @params[:password]
+      )
+      @params[:async] && response.code == 202 || response.code == 204 # We return true to indicate the status.
+    end
+
+    ##
+    # This allows you to define what happens with the notifications. The block passed in argument is called for each notification, with 2 arguments
+    # - the payload itself (ATOM or JSON, based on what you selected in the params)
+    # - the id for the feed, if you used any upon subscription
+    def on_notification(&block)
+      @callback = block 
+    end
+
+    ##
+    # When using this Rack, you need to supply the following arguments:
+    # - :host (the host for your web app. Used to build the callback urls.)
+    # - :login
+    # - :password
+    # - :format (atom|json, atom being default)
+    # - :async (true|false), false is default. You need to set that to false if you're using platforms like Heroku that may disallow concurrency.
+    def initialize(app, params = {}, &block)
+      raise ArgumentError, 'Missing :host in params' unless params[:host]
+      raise ArgumentError, 'Missing :login in params' unless params[:login]
+      raise ArgumentError, 'Missing :password in params' unless params[:password]
+      @callback = Proc.new { |notification, feed_id|
+        # Bh default, do nothing
+      }
+      @verifications = {}
+      @params = params
+      @app = app
+      block.call(self)
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      if env['REQUEST_METHOD'] == 'GET' && feed_id = env['REQUEST_PATH'].match(/\/superfeedr\/feed\/(.*)/)
+        # Verification of intent!
+        if @verifications[feed_id[1]] && verification = @verifications[feed_id[1]][req.params['hub.mode']]
+          # Check with the user
+          if verification.call(req.params['hub.topic'], feed_id[1])
+            Rack::Response.new(req.params['hub.challenge'], 200).finish
+          else
+            Rack::Response.new("not valid", 404).finish
+          end
+        else
+          # By default, we accept all
+          Rack::Response.new(req.params['hub.challenge'], 200).finish
+        end
+      elsif env['REQUEST_METHOD'] == 'POST' && feed_id = env['REQUEST_PATH'].match(/\/superfeedr\/feed\/(.*)/)
+        # Notification
+        content = nil
+        content_type = env["CONTENT_TYPE"].split(";").first
+        if content_type == "application/json"
+          # Let's parse the body as JSON
+          content = JSON.parse(req.body.read)
+        elsif content_type == "application/atom+xml"
+          # Let's parse the body as ATOM using nokogiri
+          content = Nokogiri.parse(req.body.read)
+        end
+        # Let's now send that data back to the user.
+        if !@callback.call(content, feed_id[1])
+          # We need to unsubscribe the user
+        end
+        Rack::Response.new("Thanks!", 200).finish
+      else
+        @app.call(env)
+      end
+    end  
+    
+    protected
+    
+    def generate_callback(url, feed_id)
+      URI::HTTP.build({:host => @params[:host], :path => "/superfeedr/feed/#{feed_id}" }).to_s
+    end
+    
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack-superfeedr'
+
+class Test::Unit::TestCase
+end

data/test/test_rack-superfeedr.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRackSuperfeedr < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: rack-superfeedr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- julien51
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-19 00:00:00.000000000 -05:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2157754460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157754460
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2157753260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157753260
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &2157751980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157751980
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2157750620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157750620
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2157749360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157749360
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2157747820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2157747820
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2157745760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157745760
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2157744040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157744040
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2157738420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157738420
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &2157737340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157737340
+description: ! 'A gem that provides a rack middleware to interract with Superfeedr''s
+  API. '
+email: julien@superfeedr.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/sinatra_app.rb
+- lib/rack-superfeedr.rb
+- test/helper.rb
+- test/test_rack-superfeedr.rb
+has_rdoc: true
+homepage: http://github.com/superfeedr/rack-superfeedr
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1927463494459343346
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A gem that provides a rack middleware to interract with Superfeedr's API.
+test_files: []