rack-superfeedr 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    mime-types (1.17.2)
+    nokogiri (1.5.0)
+    rack (1.4.0)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    shoulda (2.11.3)
+    typhoeus (0.3.3)
+      mime-types
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  nokogiri
+  rack
+  rcov
+  shoulda
+  typhoeus

data/README.rdoc

@@ -1,8 +1,36 @@
 = 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.
+A gem that provides a rack middleware to interact with {Superfeedr}[http://superfeedr.com/]'s PubSubHubbub API. It let you *subscribe*, *unsubscribe* and *receive* incoming feed notifications.
+This should work with any Rack-compatible framework, as well as fully managed platforms like {Heroku}[http://www.heroku.com/].
 
-== Contributing to rack-superfeedr
+== Installing
+
+    gem install rack-superfeedr
+    
+== Using
+
+You first need a {subscriber account}[http://superfeedr.com/subscriber] with Superfeedr.
+
+*Warning* : your web application needs to be accessible for Superfeedr to send notifications. If you want to test it locally, we suggest you use it with a tool like {showoff}[https://showoff.io/] which will make your local port accessible from the outside world.
+
+=== Sinatra
+
+See the {example}[https://github.com/superfeedr/rack-superfeedr/blob/master/examples/sinatra_app.rb]... and {check the docs}[http://rubydoc.info/github/superfeedr/rack-superfeedr/master/Rack/Superfeedr] for more details. 
+
+=== Rails
+
+Tested with Rails 3.2, but should work with any Rails version that supports Rack.
+
+Install the gem (using bundle), and then in <code>config/application.rb</code>, inside the <code>class Application < Rails::Application</code> block, just add the following line.
+
+  config.middleware.use Rack::Superfeedr, { :host => DOMAIN, :login => SUPERFEEDR_LOGIN, :password => SUPERFEEDR_PASSWORD} do |superfeedr|
+    Superfeedr = superfeedr
+  end
+
+You can then access the Superfeedr object anywhere in your rails application with <code>YOUR_APP_::Application::Superfeedr</code>.
+
+
+== Contributing
  
 * 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
@@ -10,10 +38,8 @@ A gem that provides a rack middleware to interact with Superfeedr's PubSubHubbub
 * 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.
+Copyright (c) 2012 Superfeedr. See LICENSE.txt for further details.
 

data/Rakefile

@@ -15,7 +15,7 @@ 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.homepage = "http://rubygems.org/gems/rack-superfeedr"
   gem.license = "MIT"
   gem.add_dependency "rack"
   gem.add_dependency "nokogiri"

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/examples/sinatra_app.rb

@@ -3,19 +3,20 @@ 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!"
+  "Hello World!" # Maybe serve the data you saved from Superfeedr's handler.
 end
 
 get '/subscribe' do
-  Superfeedr.subscribe("http://push-pub.appspot.com/feed", 123) 
+  Superfeedr.subscribe("http://push-pub.appspot.com/feed") 
 end
 
 get '/unsubscribe' do
-  Superfeedr.unsubscribe("http://push-pub.appspot.com/feed", 123)
-end
+  Superfeedr.unsubscribe("http://push-pub.appspot.com/feed")
+end
+
+Superfeedr.on_notification do |notification|
+  puts notification.to_s # You probably want to persist that data in some kind of data store...
+end

data/lib/rack-superfeedr.rb

@@ -16,7 +16,7 @@ module Rack
     # 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)
+    def subscribe(url, id = nil, &block)
       feed_id = "#{id ? id : Base64.urlsafe_encode64(url)}"
       if block
         @verifications[feed_id] ||= {}
@@ -42,7 +42,7 @@ module Rack
     # 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)
+    def unsubscribe(url, id = nil, &block)
       feed_id = "#{id ? id : Base64.urlsafe_encode64(url)}"
       if block
         @verifications[feed_id] ||= {}
@@ -70,7 +70,7 @@ module Rack
     end
 
     ##
-    # When using this Rack, you need to supply the following arguments:
+    # When using this Rack, you need to supply the following params (2nd argument):
     # - :host (the host for your web app. Used to build the callback urls.)
     # - :login
     # - :password

data/rack-superfeedr.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-superfeedr}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["julien51"]
+  s.date = %q{2012-01-21}
+  s.description = %q{A gem that provides a rack middleware to interract with Superfeedr's API. }
+  s.email = %q{julien@superfeedr.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "examples/sinatra_app.rb",
+    "lib/rack-superfeedr.rb",
+    "rack-superfeedr.gemspec",
+    "test/helper.rb",
+    "test/test_rack-superfeedr.rb"
+  ]
+  s.homepage = %q{http://rubygems.org/gems/rack-superfeedr}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A gem that provides a rack middleware to interract with Superfeedr's API.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<typhoeus>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<typhoeus>, [">= 0"])
+    else
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<typhoeus>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<typhoeus>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<typhoeus>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<typhoeus>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-superfeedr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-19 00:00:00.000000000 -05:00
+date: 2012-01-21 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2157754460 !ruby/object:Gem::Requirement
+  requirement: &2169168240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157754460
+  version_requirements: *2169168240
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2157753260 !ruby/object:Gem::Requirement
+  requirement: &2169166360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157753260
+  version_requirements: *2169166360
 - !ruby/object:Gem::Dependency
   name: typhoeus
-  requirement: &2157751980 !ruby/object:Gem::Requirement
+  requirement: &2169164060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157751980
+  version_requirements: *2169164060
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2157750620 !ruby/object:Gem::Requirement
+  requirement: &2169163100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157750620
+  version_requirements: *2169163100
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2157749360 !ruby/object:Gem::Requirement
+  requirement: &2169162020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2157749360
+  version_requirements: *2169162020
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2157747820 !ruby/object:Gem::Requirement
+  requirement: &2169160980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2157747820
+  version_requirements: *2169160980
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2157745760 !ruby/object:Gem::Requirement
+  requirement: &2169160080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157745760
+  version_requirements: *2169160080
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2157744040 !ruby/object:Gem::Requirement
+  requirement: &2169159000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157744040
+  version_requirements: *2169159000
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2157738420 !ruby/object:Gem::Requirement
+  requirement: &2169158160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157738420
+  version_requirements: *2169158160
 - !ruby/object:Gem::Dependency
   name: typhoeus
-  requirement: &2157737340 !ruby/object:Gem::Requirement
+  requirement: &2169157400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,7 +121,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157737340
+  version_requirements: *2169157400
 description: ! 'A gem that provides a rack middleware to interract with Superfeedr''s
   API. '
 email: julien@superfeedr.com
@@ -133,16 +133,18 @@ extra_rdoc_files:
 files:
 - .document
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
 - examples/sinatra_app.rb
 - lib/rack-superfeedr.rb
+- rack-superfeedr.gemspec
 - test/helper.rb
 - test/test_rack-superfeedr.rb
 has_rdoc: true
-homepage: http://github.com/superfeedr/rack-superfeedr
+homepage: http://rubygems.org/gems/rack-superfeedr
 licenses:
 - MIT
 post_install_message: 
@@ -157,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1927463494459343346
+      hash: -4467505655233297769
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: