Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A gem that provides a rack middleware to interract with Superfeedr's API.

branch: master
README.rdoc

rack-superfeedr

A gem that provides a rack middleware to interact with Superfeedr 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.

Installing

gem install rack-superfeedr

Using

You first need a subscriber account 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 which will make your local port accessible from the outside world.

Sinatra

See the example… and check the docs 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 config/application.rb, inside the class Application < Rails::Application 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 YOUR_APP::Application::Superfeedr.

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

  • 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.

Copyright

Copyright © 2012 Superfeedr. See LICENSE.txt for further details.

Something went wrong with that request. Please try again.