yarss 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb5a8eb19140ed00473aa01207c73ed9f9d7eb46
+  data.tar.gz: ec2f4a8d882acf25c80c6b9a1b90b97b08ee65ac
+SHA512:
+  metadata.gz: 894f9cda3adfb3e109350028d1ba7b825c3871bb94ec265a13581728cbe54bd6f8d548bcec1f8b3f420fc99fb1624590fd0333eceac9021f60deb09702a91d23
+  data.tar.gz: 2f679583c97b1c728c2da37d36f70f98ef243b9d63c6f4fb23373e2dc02cd61c8cdafdc20f2d454640aa963f91772bef80f5d5c5704fbdcaabb9f8ef84c66fd1

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+/.bundle/
+/.yardoc
+/data/
+/dump/
+/examples/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper.rb

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'bin/console'
+    - 'examples/rss.rb'
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+rvm:
+  - 2.3.0
+  - jruby-19mode
+
+branches:
+  only:
+    - master
+
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+
+before_install: "gem install bundler -v 1.11.2"
+install: "bundle --jobs 4"
+script: "bundle exec rspec"

data/.yardopts

@@ -0,0 +1,7 @@
+--protected
+--private
+--embed-mixins
+lib/**/*.rb
+-
+README.md
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yarss.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Oldrich Vetesnik
+
+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.md

@@ -0,0 +1,60 @@
+# Yarss – Yet Another RSS Feed Normalizer. [![Build Status](https://travis-ci.org/ollie/yarss.svg?branch=master)](https://travis-ci.org/ollie/yarss) [![Gem Version](https://img.shields.io/gem/v/yarss.svg)](https://rubygems.org/gems/yarss)
+
+Parse and access RSS/RDF/Atom feeds with a uniform interface. Yarss uses
+[MutliXml](https://rubygems.org/gems/multi_xml) behind the scenes so you may
+want to drop in your favourite XML parser.
+
+For MRI users [Ox](https://rubygems.org/gems/ox) is highly recommended as it is
+the fastest XML parser I know of. JRuby users should probably use
+[Nokogiri](https://rubygems.org/gems/nokogiri).
+
+## Usage
+
+```ruby
+['path/to/feed.rss', 'path/to/feed.atom', 'path/to/feed.rdf'].each do |file_path|
+  feed = Yarss.new(file_path)
+
+  puts "#{feed.title}, #{feed.link}, #{feed.description}"
+
+  feed.items.each do |item|
+    puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
+    puts item.content
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yarss'
+
+# To increase performance, add one of these gems:
+# gem 'ox'       # MRI compatible.
+# gem 'nokogiri' # MRI and JRuby compatible.
+# gem 'oga'      # MRI, JRuby, Rubinius compatible.
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yarss
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ollie/yarss.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+task default: :combo
+
+desc 'Run tests, rubocop and generate documentation'
+task :combo do
+  sh 'bundle exec rspec'
+  sh('bundle exec rubocop') {} # ignore status > 0
+  sh 'bundle exec yardoc'
+end
+
+desc 'Same as :combo but build a gem, too'
+task mega_combo: :combo do
+  sh 'gem build yarss.gemspec'
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'multi_xml'
+require 'yarss'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yarss/atom/feed_parser.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative 'item_parser'
+
+module Yarss
+  # Contains feed and item parsers.
+  module Atom
+    # Extract title, link, description and items from a parsed Atom feed.
+    #
+    # @see http://atomenabled.org/developers/syndication/#requiredFeedElements
+    class FeedParser
+      # Parsed Atom feed.
+      #
+      # @return [Hash]
+      attr_accessor :data
+
+      # @param data [Hash] Parsed Atom feed.
+      def initialize(data)
+        self.data = data
+      end
+
+      # Parse out the feed title, link, description and items and wrap them
+      # in a data object.
+      #
+      # @raise [ParseError] If a required field is not found.
+      #
+      # @return [Feed]
+      def parse
+        Feed.new(
+          title:       title,
+          link:        link,
+          description: description,
+          items:       items
+        )
+      end
+
+      # Extract the feed data.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [Hash]
+      def feed
+        @feed ||= data.fetch('feed')
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the title.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def title
+        Attribute.value(feed.fetch('title'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the link.
+      #
+      # @return [String]
+      def link
+        Attribute.link_value(feed['link'] || '')
+      end
+
+      # Extract the description.
+      #
+      # @return [String]
+      def description
+        Attribute.value(feed['subtitle'] || '')
+      end
+
+      # Extract and parse the items.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [Array<Item>]
+      def items
+        items = feed.fetch('entry')
+        items = [items] unless items.is_a?(Array)
+        items.map { |d| ItemParser.new(d).parse }
+      rescue KeyError => e
+        raise ParseError, e
+      end
+    end
+  end
+end

data/lib/yarss/atom/item_parser.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Yarss
+  module Atom
+    # Extract id, title, updated, link and content from a feed item.
+    #
+    # http://atomenabled.org/developers/syndication/#requiredEntryElements
+    class ItemParser
+      # Parsed Atom feed item.
+      #
+      # @return [Hash]
+      attr_accessor :data
+
+      # @param data [Hash] Parsed Atom feed item.
+      def initialize(data)
+        self.data = data
+      end
+
+      # Parse out the feed item id, title, updated, link and content and wrap
+      # them in a data object.
+      #
+      # @raise [ParseError] If a required field is not found.
+      #
+      # @return [Item]
+      def parse
+        Item.new(
+          id:         id,
+          title:      title,
+          updated_at: updated,
+          link:       link,
+          content:    content
+        )
+      end
+
+      # Extract the ID.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def id
+        data.fetch('id')
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the title.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def title
+        Attribute.value(data.fetch('title'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the updated date.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [DateTime]
+      def updated
+        DateTime.parse(data.fetch('updated'))
+      rescue KeyError, ArgumentError => e
+        raise ParseError, e
+      end
+
+      # Extract the link.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def link
+        Attribute.link_value(data.fetch('link'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the content.
+      #
+      # @return [String]
+      def content
+        summary = Attribute.value(data['summary'] || '')
+        content = Attribute.value(data['content'] || '')
+        return content unless content.empty?
+        summary
+      end
+    end
+  end
+end

data/lib/yarss/attribute.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Yarss
+  # A bunch of helpers to extract a +String+ value out of a +Hash+, +Array+,
+  # etc.
+  module Attribute
+    # Extract a +String+ value from a given attribute.
+    #
+    # @raise [ParseError] If type of value is not known.
+    #
+    # @example
+    #   Yarss::Attribute.value('Foo') # => 'Foo'
+    #   Yarss::Attribute.value('__content__' => 'Foo') # => 'Foo'
+    #
+    # @param value [String, Hash] An attribute.
+    #
+    # @return [String]
+    def self.value(value)
+      value ||= ''
+
+      case value
+      when Hash
+        value(value.fetch('__content__'))
+      when String
+        value.strip
+      else
+        raise ParseError, "Unknown #{value.class} attribute: #{value.inspect}"
+      end
+    rescue KeyError => e
+      raise ParseError, e
+    end
+
+    # Extract a +String+ value from a given link attribute.
+    #
+    # @raise [ParseError] If type of value is not known or no link is found.
+    #
+    # @example
+    #   Yarss::Attribute.link_value('Foo') # => 'Foo'
+    #   Yarss::Attribute.link_value('href' => 'Foo') # => 'Foo'
+    #   Yarss::Attribute.link_value([{ 'rel' => 'self', 'href' => 'Foo' }])
+    #     # => 'Foo'
+    #   Yarss::Attribute.link_value([{ 'rel' => 'alternate', 'href' => 'Foo' }])
+    #     # => 'Foo'
+    #
+    # @param value [String, Hash, Array] A link attribute.
+    #
+    # @return [String]
+    def self.link_value(value)
+      value ||= ''
+
+      case value
+      when Hash
+        link_value(value.fetch('href'))
+      when Array
+        item = value.find { |l| l.is_a?(String) } ||
+               value.find { |l| l['rel'] && l['rel'] == 'self' } ||
+               value.find { |l| l['rel'] && l['rel'] == 'alternate' }
+        raise KeyError unless item
+        link_value(item)
+      when String
+        value.strip
+      else
+        raise ParseError, "Unknown #{value.class} attribute: #{value.inspect}"
+      end
+    rescue KeyError => e
+      raise ParseError, e
+    end
+  end
+end

data/lib/yarss/feed.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Yarss
+  # Feed data holder.
+  class Feed
+    # Title.
+    #
+    # @return [String]
+    attr_accessor :title
+
+    # URL to the related Web page.
+    #
+    # @return [String]
+    attr_accessor :link
+
+    # Description.
+    #
+    # @return [String]
+    attr_accessor :description
+
+    # Feed items.
+    #
+    # @return [Array<Item>]
+    attr_accessor :items
+
+    # @param attributes [Hash, nil] Data to set.
+    def initialize(attributes = nil)
+      attributes.each do |attribute, value|
+        setter = "#{attribute}="
+        send(setter, value)
+      end if attributes
+    end
+
+    # Treat this class as a value object.
+    #
+    # @param other [Feed]
+    #
+    # @return [Bool]
+    def ==(other)
+      return false unless other.is_a?(self.class)
+
+      title         == other.title       &&
+        link        == other.link        &&
+        description == other.description &&
+        items       == other.items
+    end
+  end
+end

data/lib/yarss/item.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Yarss
+  # Feed item data holder.
+  class Item
+    # ID.
+    #
+    # @return [String]
+    attr_accessor :id
+
+    # Title.
+    #
+    # @return [String]
+    attr_accessor :title
+
+    # Date and time of the last modification.
+    #
+    # @return [DateTime]
+    attr_accessor :updated_at
+
+    # URL to the related Web page.
+    #
+    # @return [String]
+    attr_accessor :link
+
+    # Content.
+    #
+    # @return [String]
+    attr_accessor :content
+
+    # @param attributes [Hash, nil] Data to set.
+    def initialize(attributes = nil)
+      attributes.each do |attribute, value|
+        setter = "#{attribute}="
+        send(setter, value)
+      end if attributes
+    end
+
+    # Treat this class as a value object.
+    #
+    # @param other [Item]
+    #
+    # @return [Bool]
+    def ==(other) # rubocop:disable Metrics/AbcSize
+      return false unless other.is_a?(self.class)
+
+      id           == other.id         &&
+        title      == other.title      &&
+        updated_at == other.updated_at &&
+        link       == other.link       &&
+        content    == other.content
+    end
+  end
+end

data/lib/yarss/rdf/feed_parser.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require_relative 'item_parser'
+
+module Yarss
+  # Contains feed and item parsers.
+  module Rdf
+    # Extract title, link, description and items from a parsed Rdf feed.
+    #
+    # @see http://atomenabled.org/developers/syndication/#requiredFeedElements
+    class FeedParser
+      # Parsed Rdf feed.
+      #
+      # @return [Hash]
+      attr_accessor :data
+
+      # @param data [Hash] Parsed Rdf feed.
+      def initialize(data)
+        self.data = data
+      end
+
+      # Parse out the feed title, link, description and items and wrap them
+      # in a data object.
+      #
+      # @raise [ParseError] If a required field is not found.
+      #
+      # @return [Feed]
+      def parse
+        Feed.new(
+          title:       title,
+          link:        link,
+          description: description,
+          items:       items
+        )
+      end
+
+      # Extract the feed data.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [Hash]
+      def feed
+        @feed ||= begin
+          if data['RDF']
+            data['RDF']
+          else
+            data.fetch('rdf:RDF')
+          end
+        end
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the channel data.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [Hash]
+      def channel
+        @channel ||= feed.fetch('channel')
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the title.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def title
+        Attribute.value(channel.fetch('title'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the link.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def link
+        Attribute.link_value(channel.fetch('link'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the description.
+      #
+      # @return [String]
+      def description
+        Attribute.value(channel.fetch('description'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract and parse the items.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [Array<Item>]
+      def items
+        items = feed.fetch('item')
+        items = [items] unless items.is_a?(Array)
+        items.map { |d| ItemParser.new(d).parse }
+      rescue KeyError => e
+        raise ParseError, e
+      end
+    end
+  end
+end

data/lib/yarss/rdf/item_parser.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Yarss
+  module Rdf
+    # Extract id, title, updated, link and content from a feed item.
+    class ItemParser
+      # Parsed Rdf feed item.
+      #
+      # @return [Hash]
+      attr_accessor :data
+
+      # @param data [Hash] Parsed Rdf feed item.
+      def initialize(data)
+        self.data = data
+      end
+
+      # Parse out the feed item id, title, updated, link and content and wrap
+      # them in a data object.
+      #
+      # @raise [ParseError] If a required field is not found.
+      #
+      # @return [Item]
+      def parse
+        Item.new(
+          id:         id,
+          title:      title,
+          updated_at: updated,
+          link:       link,
+          content:    description
+        )
+      end
+
+      # Extract the ID.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def id
+        if data['about']
+          data['about']
+        else
+          data.fetch('rdf:about')
+        end
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the title.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def title
+        Attribute.value(data.fetch('title'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the updated date.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [DateTime]
+      def updated
+        date = if data['date']
+                 data['date']
+               else
+                 data.fetch('dc:date')
+               end
+        DateTime.parse(date)
+      rescue KeyError, ArgumentError => e
+        raise ParseError, e
+      end
+
+      # Extract the link.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def link
+        Attribute.link_value(data.fetch('link'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the description.
+      #
+      # @return [String]
+      def description
+        Attribute.value(data.fetch('description'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+    end
+  end
+end

data/lib/yarss/rss/feed_parser.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative 'item_parser'
+
+module Yarss
+  # Contains feed and item parsers.
+  module Rss
+    # Extract title, link, description and items from a parsed RSS feed.
+    #
+    # @see https://validator.w3.org/feed/docs/rss2.html#requiredChannelElements
+    class FeedParser
+      # Parsed RSS feed.
+      #
+      # @return [Hash]
+      attr_accessor :data
+
+      # @param data [Hash] Parsed RSS feed.
+      def initialize(data)
+        self.data = data
+      end
+
+      # Parse out the feed title, link, description and items and wrap them
+      # in a data object.
+      #
+      # @raise [ParseError] If a required field is not found.
+      #
+      # @return [Feed]
+      def parse
+        Feed.new(
+          title:       title,
+          link:        link,
+          description: description,
+          items:       items
+        )
+      end
+
+      # Extract the channel data.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [Hash]
+      def feed
+        @feed ||= data.fetch('rss').fetch('channel')
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the title.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def title
+        Attribute.value(feed.fetch('title'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the link.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def link
+        Attribute.link_value(feed.fetch('link'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the description.
+      #
+      # @return [String]
+      def description
+        Attribute.value(feed.fetch('description'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract and parse the items.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [Array<Item>]
+      def items
+        items = feed.fetch('item')
+        items = [items] unless items.is_a?(Array)
+        items.map { |d| ItemParser.new(d).parse }
+      rescue KeyError => e
+        raise ParseError, e
+      end
+    end
+  end
+end

data/lib/yarss/rss/item_parser.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Yarss
+  module Rss
+    # Extract id, title, updated, link and content from a feed item.
+    #
+    # https://validator.w3.org/feed/docs/rss2.html#hrelementsOfLtitemgt
+    class ItemParser
+      # Parsed RSS feed item.
+      #
+      # @return [Hash]
+      attr_accessor :data
+
+      # @param data [Hash] Parsed RSS feed item.
+      def initialize(data)
+        self.data = data
+      end
+
+      # Parse out the feed item id, title, updated, link and content and wrap
+      # them in a data object.
+      #
+      # @raise [ParseError] If a required field is not found.
+      #
+      # @return [Item]
+      def parse
+        Item.new(
+          id:         guid,
+          title:      title,
+          updated_at: pub_date,
+          link:       link,
+          content:    description
+        )
+      end
+
+      # Extract the ID. Use the title if guid is not present and title is.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def guid
+        Attribute.value(data.fetch('guid'))
+      rescue KeyError => e
+        return Digest::MD5.hexdigest(data['title']) if data['title']
+        raise ParseError, e
+      end
+
+      # Extract the title. Use guid if title is not present and guid is.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def title
+        Attribute.value(data.fetch('title'))
+      rescue KeyError => e
+        return Attribute.value(data['guid']) if data['guid']
+        raise ParseError, e
+      end
+
+      # Extract the updated date.
+      #
+      # @return [DateTime]
+      def pub_date
+        DateTime.parse(data.fetch('pubDate'))
+      rescue ArgumentError => e
+        raise ParseError, e
+      rescue KeyError
+        DateTime.now
+      end
+
+      # Extract the link.
+      #
+      # @raise [ParseError] If not found.
+      #
+      # @return [String]
+      def link
+        Attribute.link_value(data.fetch('link'))
+      rescue KeyError => e
+        raise ParseError, e
+      end
+
+      # Extract the content.
+      #
+      # @return [String]
+      def description
+        description = Attribute.value(data['description'] || '')
+
+        return Attribute.value(data['content:encoded']) if
+          description.empty? && data['content:encoded']
+
+        description
+      end
+    end
+  end
+end

data/lib/yarss/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Yarss
+  # Version number, happy now?
+  VERSION = '0.0.1'
+end

data/lib/yarss.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'yarss/version'
+require 'yarss/feed'
+require 'yarss/item'
+require 'yarss/attribute'
+require 'yarss/rss/feed_parser'
+require 'yarss/atom/feed_parser'
+require 'yarss/rdf/feed_parser'
+
+# RSS, RDF and Atom feeds parser.
+module Yarss
+  # Generic Yarss error.
+  class Error < StandardError; end
+
+  # Parsing of the XML failed or a required field is not present.
+  class ParseError < Error; end
+
+  # Not a RSS, RDF or Atom feed.
+  class UnknownParserError < Error; end
+
+  # Parse a {Feed} out of a path to a XML or an IO (or whatever responds
+  # to +read+).
+  #
+  # @raise [UnknownParserError] If no corresponding parser was found.
+  # @raise [ParseError]         If XML parsing or field extracting failed.
+  #
+  # @param path_or_io [String, #read] A path to the XML file or an IO, a
+  #                                   Pathname, something that can be read.
+  #
+  # @example
+  #   feed = Yarss.new('path/to/feed.rss')
+  #
+  #   puts "#{feed.title}, #{feed.link}, #{feed.description}"
+  #
+  #   feed.items.each do |item|
+  #     puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
+  #     puts item.content
+  #   end
+  #
+  # @return [Feed]
+  def self.new(path_or_io)
+    if path_or_io.respond_to?(:read)
+      from_io(path_or_io)
+    else
+      from_file(path_or_io)
+    end
+  end
+
+  # Parse a {Feed} out of an IO (or whatever responds to +read+).
+  #
+  # @raise [UnknownParserError] If no corresponding parser was found.
+  # @raise [ParseError]         If XML parsing or field extracting failed.
+  #
+  # @param io [#read] An IO, a Pathname, something that can be read.
+  #
+  # @example
+  #   feed = Yarss.from_io(Pathname.new('path/to/feed.rss'))
+  #   feed = Yarss.from_io(File.open('path/to/feed.rss', 'rb'))
+  #
+  #   puts "#{feed.title}, #{feed.link}, #{feed.description}"
+  #
+  #   feed.items.each do |item|
+  #     puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
+  #     puts item.content
+  #   end
+  #
+  # @return [Feed]
+  def self.from_io(io)
+    data = io.read
+    from_string(data, io)
+  end
+
+  # Parse a {Feed} out of a path to a XML.
+  #
+  # @raise [UnknownParserError] If no corresponding parser was found.
+  # @raise [ParseError]         If XML parsing or field extracting failed.
+  #
+  # @param path [String] Path to a XML.
+  #
+  # @example
+  #   feed = Yarss.from_file('path/to/feed.rss')
+  #
+  #   puts "#{feed.title}, #{feed.link}, #{feed.description}"
+  #
+  #   feed.items.each do |item|
+  #     puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
+  #     puts item.content
+  #   end
+  #
+  # @return [Feed]
+  def self.from_file(path)
+    data = File.read(path)
+    from_string(data, path)
+  end
+
+  # Parse a {Feed} out of raw XML.
+  #
+  # @raise [UnknownParserError] If no corresponding parser was found.
+  # @raise [ParseError]         If XML parsing or field extracting failed.
+  #
+  # @param data       [String]        Raw RSS, RDF or Atom XML data.
+  # @param path_or_io [String, #read] Path to a file or an IO.
+  #
+  # @example
+  #   feed = Yarss.from_string('...)
+  #
+  #   puts "#{feed.title}, #{feed.link}, #{feed.description}"
+  #
+  #   feed.items.each do |item|
+  #     puts "#{item.id}, #{item.title}, #{item.updated_at}, #{item.link}"
+  #     puts item.content
+  #   end
+  #
+  # @return [Feed]
+  def self.from_string(data, path_or_io)
+    data = MultiXml.parse(data)
+
+    return Rss::FeedParser.new(data).parse  if data['rss']
+    return Atom::FeedParser.new(data).parse if data['feed']
+    return Rdf::FeedParser.new(data).parse  if data['rdf:RDF'] || data['RDF']
+
+    raise UnknownParserError, "Cannot find parser for #{path_or_io}"
+  rescue MultiXml::ParseError => e
+    raise ParseError, e
+  end
+end

data/yarss.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yarss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'yarss'
+  spec.version       = Yarss::VERSION
+  spec.authors       = ['Oldrich Vetesnik']
+  spec.email         = ['oldrich.vetesnik@gmail.com']
+
+  spec.summary       = 'Yet Another RSS Feed Normalizer.'
+  spec.description   = 'Parse and access RSS/RDF/Atom feeds with ' \
+                       'a uniform interface.'
+  spec.homepage      = 'https://github.com/ollie/yarss'
+  spec.license       = 'MIT'
+
+  # rubocop:disable Metrics/LineLength
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # System
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  # spec.add_development_dependency 'ox',       '~> 2.2'
+  # spec.add_development_dependency 'nokogiri', '~> 1.6'
+  # spec.add_development_dependency 'oga',      '~> 2.0'
+
+  # Test
+  spec.add_development_dependency 'rspec',     '~> 3.4'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+
+  # Code style, debugging, docs
+  spec.add_development_dependency 'rubocop',    '~> 0.37'
+  spec.add_development_dependency 'pry',        '~> 0.10'
+  # spec.add_development_dependency 'pry-doc',    '~> 0.8'
+  # spec.add_development_dependency 'pry-byebug', '~> 3.3'
+  spec.add_development_dependency 'yard',       '~> 0.8'
+  spec.add_development_dependency 'rake',       '~> 10.5'
+
+  # Provides swappable XML backends utilizing LibXML, Nokogiri, Ox, Oga or REXML.
+  spec.add_runtime_dependency 'multi_xml', '~> 0.5'
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: yarss
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oldrich Vetesnik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Parse and access RSS/RDF/Atom feeds with a uniform interface.
+email:
+- oldrich.vetesnik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yarss.rb
+- lib/yarss/atom/feed_parser.rb
+- lib/yarss/atom/item_parser.rb
+- lib/yarss/attribute.rb
+- lib/yarss/feed.rb
+- lib/yarss/item.rb
+- lib/yarss/rdf/feed_parser.rb
+- lib/yarss/rdf/item_parser.rb
+- lib/yarss/rss/feed_parser.rb
+- lib/yarss/rss/item_parser.rb
+- lib/yarss/version.rb
+- yarss.gemspec
+homepage: https://github.com/ollie/yarss
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Yet Another RSS Feed Normalizer.
+test_files: []
+has_rdoc: