https://github.com/ruby/rss

RSS reading and writing
https://github.com/ruby/rss

Last synced: 27 days ago
JSON representation

RSS reading and writing

• Host: GitHub
• URL: https://github.com/ruby/rss
• Owner: ruby
• License: bsd-2-clause
• Created: 2018-05-31T03:10:57.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-21T06:21:26.000Z (2 months ago)
• Last Synced: 2024-09-29T21:01:18.845Z (about 1 month ago)
• Language: Ruby
• Homepage:
• Size: 639 KB
• Stars: 183
• Watchers: 41
• Forks: 36
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# 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:

* RSS

  * [0.9.1](http://www.rssboard.org/rss-0-9-1-netscape)

  * [1.0](http://web.resource.org/rss/1.0/)

  * [2.0](http://www.rssboard.org/rss-specification)

* [Atom](https://tools.ietf.org/html/rfc4287)

## Installation

Add this line to your application's Gemfile:

```ruby

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:

```ruby

  require 'rss'

  require 'open-uri'

  url = 'https://www.ruby-lang.org/en/feeds/news.rss'

  URI.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:

```ruby

  require "rss"

  rss = RSS::Maker.make("atom") do |maker|

    maker.channel.author = "matz"

    maker.channel.updated = Time.now.to_s

    maker.channel.about = "https://www.ruby-lang.org/en/feeds/news.rss"

    maker.channel.title = "Example Feed"

    maker.items.new_item do |item|

      item.link = "https://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 `rake test` to run the tests.

To install this gem onto your local machine, run `rake install`. To release a new version, update the version number in `lib/rss/version.rb`, and then run `rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://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](LICENSE.txt).