RSS reading and writing
Clone or download
Latest commit 181eb0b Jan 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin bundle gem rss Jun 1, 2018
lib Remove needless block Jan 23, 2019
test/rss Stop passing needless block Jan 23, 2019
.gitignore Ignore Gemfile.lock Jun 1, 2018
.travis.yml Enabled Travis Jun 1, 2018
Gemfile bundle gem rss Jun 1, 2018
LICENSE.txt Update license: MIT to BSD-2-Clause Jun 1, 2018
README.md README Aug 22, 2018
Rakefile Enabled test suite with test-unit Jun 1, 2018
rss.gemspec default gems: add missing comment in gemspec Oct 20, 2018
run-test.rb Add a test runner Jan 19, 2019

README.md

RSS

Really Simple Syndication (RSS) is a family of formats that describe 'feeds,' specially constructed XML documents that allow an interested person to subscribe and receive updates from a particular web service. This portion of the standard library provides tooling to read and create these feeds.

The standard library supports RSS 0.91, 1.0, 2.0, and Atom, a related format. Here are some links to the standards documents for these formats:

Installation

Add this line to your application's Gemfile:

gem 'rss'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rss

Usage

Consuming RSS

If you'd like to read someone's RSS feed with your Ruby code, you've come to the right place. It's really easy to do this, but we'll need the help of open-uri:

  require 'rss'
  require 'open-uri'

  url = 'http://www.ruby-lang.org/en/feeds/news.rss'
  open(url) do |rss|
    feed = RSS::Parser.parse(rss)
    puts "Title: #{feed.channel.title}"
    feed.items.each do |item|
      puts "Item: #{item.title}"
    end
  end

As you can see, the workhorse is RSS::Parser#parse, which takes the source of the feed and a parameter that performs validation on the feed. We get back an object that has all of the data from our feed, accessible through methods. This example shows getting the title out of the channel element, and looping through the list of items.

Producing RSS

Producing our own RSS feeds is easy as well. Let's make a very basic feed:

  require "rss"

  rss = RSS::Maker.make("atom") do |maker|
    maker.channel.author = "matz"
    maker.channel.updated = Time.now.to_s
    maker.channel.about = "http://www.ruby-lang.org/en/feeds/news.rss"
    maker.channel.title = "Example Feed"

    maker.items.new_item do |item|
      item.link = "http://www.ruby-lang.org/en/news/2010/12/25/ruby-1-9-2-p136-is-released/"
      item.title = "Ruby 1.9.2-p136 is released"
      item.updated = Time.now.to_s
    end
  end

  puts rss

As you can see, this is a very Builder-like DSL. This code will spit out an Atom feed with one item. If we needed a second item, we'd make another block with maker.items.new_item and build a second one.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/rss.

License

The gem is available as open source under the terms of the BSD-2-Clause.