rss_feed 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: caed8664b546d8b48b6c0b83154e6961a6fd3414
+  data.tar.gz: 9a8d22d3e9c4d4b95459a18d98ab986ed5824951
+SHA512:
+  metadata.gz: 7daa4da3a909178b686f973ee0fe999b0c45c6c820b162e94cda7b7f9ee2157379c6a96a26fca815bdbd74bc023469760b362872bcffc6a85bdaa09a8c4f75cf
+  data.tar.gz: 90baf4ce6576a6a64e96dab6ea7f42966d6b3f27e3a985330f4194f99f76939d1b9f3f38e02c6e2f3f75cf3759c3d18bfba6939b4b0cb4badf8dfba837fb26b0

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.1.0, released 2011-06-16
+
+* Initial release on GitHub
+

data/LICENSE

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2011 Oliver Eilhard
+
+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,10 @@
+# RssFeed
+
+Convenient classes for parsing an [RSS feed](http://www.rssboard.org/rss-specification)
+
+## Links
+
+ * [RSS 2.0 Specification](http://www.rssboard.org/rss-specification)
+ * [RSS 1.0 Specification](http://web.resource.org/rss/1.0/)
+ * [RSS on Wikipedia](http://en.wikipedia.org/wiki/RSS)
+

data/lib/rss_feed/core_ext/string_ext.rb

@@ -0,0 +1,2 @@
+class String
+end

data/lib/rss_feed/core_ext/try.rb

@@ -0,0 +1,9 @@
+class Object
+  alias_method :try, :__send__
+end
+
+class NilClass
+  def try(*args)
+    nil
+  end
+end

data/lib/rss_feed/core_ext.rb

@@ -0,0 +1,2 @@
+require 'rss_feed/core_ext/try.rb'
+require 'rss_feed/core_ext/string_ext.rb'

data/lib/rss_feed/open_search.rb

@@ -0,0 +1,38 @@
+require 'rss_feed/open_search_query'
+
+module RSSFeed
+  class OpenSearch
+    # Initializes the Open Search extensions.
+    def initialize(node)
+      @node = node
+    end
+
+    def present?
+      !self.total_results.nil?
+    end
+
+    def total_results
+      @node.at_xpath("rss/channel/opensearch:totalResults", ::RSSFeed::NS).content.to_i rescue nil
+    end
+
+    def start_index
+      @node.at_xpath("rss/channel/opensearch:startIndex", ::RSSFeed::NS).content.to_i rescue nil
+    end
+
+    def items_per_page
+      @node.at_xpath("rss/channel/opensearch:itemsPerPage", ::RSSFeed::NS).content.to_i rescue nil
+    end
+
+    # queries
+    def queries
+      nodes = @node.xpath("rss/channel/opensearch:Query", ::RSSFeed::NS) rescue nil
+      nodes.map { |node| OpenSearchQuery.new(node) } if nodes
+    end
+
+    # first
+    # previous
+    # next
+    # last
+    # search
+  end
+end

data/lib/rss_feed/open_search_query.rb

@@ -0,0 +1,28 @@
+module RSSFeed
+  class OpenSearchQuery
+    # Initializes the Open Search Query element.
+    def initialize(node)
+      @node = node
+    end
+
+    def role
+      @node["role"]
+    end
+
+    def search_terms
+      @node["searchTerms"]
+    end
+
+    def start_page
+      @node["startPage"].to_i
+    end
+
+    def start_index
+      @node["startIndex"].to_i
+    end
+
+    def items_per_page
+      @node["itemsPerPage"].to_i
+    end
+  end
+end

data/lib/rss_feed/rss_category.rb

@@ -0,0 +1,18 @@
+module RSSFeed
+  class RSSCategory
+    # Initializes the link.
+    def initialize(node)
+      @node = node
+    end
+
+    # Identifies the domain (optional).
+    def domain 
+      @node["domain"]
+    end
+
+    # Content of the RSS category.
+    def content
+      @node.content
+    end
+  end
+end

data/lib/rss_feed/rss_channel.rb

@@ -0,0 +1,177 @@
+# encoding: utf-8
+
+require 'nokogiri'
+require 'rss_feed/core_ext'
+require 'rss_feed/rss_category'
+require 'rss_feed/rss_channel_item'
+require 'rss_feed/rss_cloud'
+require 'rss_feed/rss_guid'
+require 'rss_feed/rss_image'
+require 'rss_feed/rss_text_input'
+require 'rss_feed/open_search'
+
+module RSSFeed
+  # RSSFeed::RSSChannel is the central place for
+  # working with feeds in the RSS format.
+  #
+  # Opening an RSS feed from the network or a file system
+  # is done like this:
+  #
+  #   feed = RSSFeed::RSSChannel.open(open("http://example.com/rss.xml"))
+  #
+  # If you have a file you should do:
+  #
+  #   f = File.open("rss.xml")
+  #   feed = RSSFeed::RSSChannel.open(f)
+  #   f.close
+  #
+  # If you have an XML string you can do:
+  #
+  #   feed = RSSFeed::RSSChannel.open("<rss version='1.0'> ...")
+  #
+  # One can open and parse the feed like so:
+  #
+  #   RSSFeed::RSSChannel.open(...) do |feed|
+  #     puts feed.title
+  #     feed.items do |item|
+  #       puts item.title
+  #     end
+  #   end
+  #
+  # You can access OpenSearch extensions by using +RSSChannel.open_search+.
+  # Access to other embedded XML types are available by using RSSChannel.doc+
+  # directly. It's a +Nokogiri::XML+ instance.
+  #
+  # RSSFeed uses Nokogiri for parsing.
+  #
+  class RSSChannel
+
+    attr_reader :doc
+
+    def initialize(doc)
+      @doc = doc
+    end
+
+    def self.open(string_or_io, url = nil, encoding = nil)
+      doc = Nokogiri::XML(string_or_io, url, encoding)
+      channel = RSSChannel.new(doc)
+      yield channel if block_given?
+      channel
+    end
+
+    # Title (required).
+    def title
+      @doc.at_xpath("rss/channel/title").content
+    end
+
+    # Link (required).
+    def link 
+      @doc.at_xpath("rss/channel/link").content
+    end
+    
+    # Description (required).
+    def description
+      @doc.at_xpath("rss/channel/description").content
+    end
+    
+    # Language (optional).
+    def language
+      @doc.at_xpath("rss/channel/language").try(:content)
+    end
+    
+    # Copyright (optional).
+    def copyright
+      @doc.at_xpath("rss/channel/copyright").try(:content)
+    end
+    
+    # Managing editor (optional).
+    def managing_editor
+      @doc.at_xpath("rss/channel/managingEditor").try(:content)
+    end
+    
+    # Publication date (optional).
+    def pub_date
+      if date = @doc.at_xpath("rss/channel/pubDate").try(:content)
+        Time.rfc822(date)
+      end
+    end
+    
+    # Last build date (optional).
+    def last_build_date
+      if date = @doc.at_xpath("rss/channel/lastBuildDate").try(:content)
+        Time.rfc822(date)
+      end
+    end
+    
+    # Category (optional).
+    def category
+      if node = @doc.at_xpath("rss/channel/category")
+        RSSCategory.new(node)
+      end
+    end
+    
+    # Generator (optional).
+    def generator
+      @doc.at_xpath("rss/channel/generator").try(:content)
+    end
+    
+    # Documentation link (optional).
+    def docs
+      @doc.at_xpath("rss/channel/docs").try(:content)
+    end
+
+    # Cloud (optional)
+    def cloud
+      if node = @doc.at_xpath("rss/channel/cloud")
+        RSSCloud.new(node)
+      end
+    end
+    
+    # Time to live in minutes (optional).
+    def ttl
+      @doc.at_xpath("rss/channel/ttl").try(:content).nonzero?
+    end
+    
+    # Image (optional).
+    def image
+      if node = @doc.at_xpath("rss/channel/image")
+        RSSImage.new(node)
+      end
+    end
+    
+    # PICS rating (optional).
+    def rating
+      @doc.at_xpath("rss/channel/rating").try(:content)
+    end
+    
+    # Text input box (optional).
+    def text_input
+      if node = @doc.at_xpath("rss/channel/textInput")
+        RSSTextInput.new(node)
+      end
+    end
+    
+    # Hint for aggregators telling them which hours they can skip (optional).
+    def skip_hours
+      @doc.at_xpath("rss/channel/skipHours").try(:content).nonzero?
+    end
+    
+    # Hint for aggregators telling them which days they can skip (optional).
+    def skip_days
+      @doc.at_xpath("rss/channel/skipDays").try(:content).nonzero?
+    end
+    
+    # Array of channel items (optional).
+    def items
+      nodes = @doc.xpath("rss/channel/item") || []
+      nodes.map { |node| RSSChannelItem.new(node) }
+    end
+
+    # Open Search extensions (optional)
+    def open_search
+      @open_search ||= OpenSearch.new(@doc)
+    end
+
+  end
+end
+

data/lib/rss_feed/rss_channel_item.rb

@@ -0,0 +1,73 @@
+module RSSFeed
+  class RSSChannelItem
+
+    attr_reader :node
+
+    def initialize(node)
+      @node = node
+    end
+
+    # Title (required).
+    def title
+      @node.at_xpath("title").content
+    end
+
+    # Link (required).
+    def link
+      @node.at_xpath("link").content
+    end
+
+    # Description (required).
+    def description
+      @node.at_xpath("description").content
+    end
+
+    # Email address of the author (optional).
+    def author
+      @node.at_xpath("author").try(:content)
+    end
+
+    # Array of categories (optional).
+    def categories
+      if nodes = @node.xpath("category")
+        nodes.map { |node| RSSCategory.new(node) }
+      end
+    end
+
+    # Array of URLs to comments (optional).
+    def comments
+      if nodes = @node.xpath("comments")
+        nodes.map { |node| node.content }.compact
+      end
+    end
+
+    # Enclosure (optional).
+    def enclosure
+      if node = @node.at_xpath("enclosure")
+        RSSEnclosure.new(node)
+      end
+    end
+
+    # GUID (optional).
+    def guid
+      if node = @node.at_xpath("guid")
+        RSSGuid.new(node)
+      end
+    end
+    
+    # Publication date (optional).
+    def pub_date
+      if date = @node.at_xpath("pubDate").try(:content)
+        Time.rfc822(date)
+      end
+    end
+
+    # Source (optional).
+    def source
+      if node = @node.at_xpath("source")
+        RSSSource.new(node)
+      end
+    end
+
+  end
+end

data/lib/rss_feed/rss_cloud.rb

@@ -0,0 +1,35 @@
+module RSSFeed
+  class RSSCloud
+
+    # Initializes the cloud element.
+    def initialize(node)
+      @node = node
+    end
+
+    # Domain
+    def domain
+      @node["domain"]
+    end
+
+    # Port
+    def port
+      @node["port"].nonzero?
+    end
+
+    # Path 
+    def path
+      @node["path"]
+    end
+
+    # Register procedure
+    def register_procedure
+      @node["registerProcedure"]
+    end
+
+    # Protocol
+    def protocol
+      @node["protocol"]
+    end
+
+  end
+end

data/lib/rss_feed/rss_enclosure.rb

@@ -0,0 +1,23 @@
+module RSSFeed
+  class RSSEnclosure
+    # Initializes the enclosure element.
+    def initialize(node)
+      @node = node
+    end
+
+    # URL (required)
+    def url
+      @node["url"]
+    end
+
+    # Length (required)
+    def length
+      @node["length"]
+    end
+
+    # Media type (required)
+    def type
+      @node["type"]
+    end
+  end
+end

data/lib/rss_feed/rss_guid.rb

@@ -0,0 +1,18 @@
+module RSSFeed
+  class RSSGuid
+    # Initializes the link.
+    def initialize(node)
+      @node = node
+    end
+  
+    # Content
+    def content
+      @node.content
+    end
+
+    # Is permalink?
+    def is_permalink?
+      @node["isPermaLink"]
+    end
+  end
+end

data/lib/rss_feed/rss_image.rb

@@ -0,0 +1,38 @@
+module RSSFeed
+  class RSSImage
+    # Initializes the image element.
+    def initialize(node)
+      @node = node
+    end
+
+    # URL (required)
+    def url
+      @node.at_xpath("url").content
+    end
+
+    # Title (required)
+    def title
+      @node.at_xpath("title").content
+    end
+
+    # Link (required)
+    def link
+      @node.at_xpath("link").content
+    end
+
+    # Width (optional)
+    def width
+      @node.at_xpath("width").try(:content).to_i
+    end
+
+    # Height (optional)
+    def height
+      @node.at_xpath("height").try(:content).to_i
+    end
+
+    # Description (optional)
+    def description
+      @node.at_xpath("description").try(:content)
+    end
+  end
+end

data/lib/rss_feed/rss_source.rb

@@ -0,0 +1,18 @@
+module RSSFeed
+  class RSSSource
+    # Initializes the source element.
+    def initialize(node)
+      @node = node
+    end
+
+    # URL (required)
+    def url
+      @node["url"]
+    end
+
+    # Content 
+    def content
+      @node.content
+    end
+  end
+end

data/lib/rss_feed/rss_text_input.rb

@@ -0,0 +1,28 @@
+module RSSFeed
+  class RSSTextInput
+    # Initializes the text input element.
+    def initialize(node)
+      @node = node
+    end
+
+    # Title (required)
+    def title
+      @node.at_xpath("title").content
+    end
+
+    # Description (required)
+    def description
+      @node.at_xpath("description").content
+    end
+
+    # Name (required)
+    def name 
+      @node.at_xpath("name").content
+    end
+
+    # Link (required)
+    def link
+      @node.at_xpath("link").content
+    end
+  end
+end

data/lib/rss_feed.rb

@@ -0,0 +1,30 @@
+# Copyright (C) 2011 Oliver Eilhard
+#
+# This library is freely distributable under
+# the terms of an MIT-style license.
+# See COPYING or http://www.opensource.org/licenses/mit-license.php.
+
+# This library is for parsing RSS feeds.
+
+module RSSFeed
+  VERSION = "0.1.1"
+
+  # OpenSearch 1.1 Draft 4 namespace
+  NS_OPENSEARCH_11 = "http://a9.com/-/spec/opensearch/1.1/"
+
+  # Well-known namespaces for use in Nokogiri
+  NS = {"rss" => "", "opensearch" => NS_OPENSEARCH_11}
+
+  autoload :CoreExt,         'rss_feed/core_ext.rb'
+  autoload :OpenSearch,      'rss_feed/open_search.rb'
+  autoload :OpenSearchQuery, 'rss_feed/open_search_query.rb'
+  autoload :RSSChannel,      'rss_feed/rss_channel.rb'
+  autoload :RSSChannelItem,  'rss_feed/rss_channel_item.rb'
+  autoload :RSSCategory,     'rss_feed/rss_category.rb'
+  autoload :RSSCloud,        'rss_feed/rss_cloud.rb'
+  autoload :RSSEnclosure,    'rss_feed/rss_enclosure.rb'
+  autoload :RSSGuid,         'rss_feed/rss_guid.rb'
+  autoload :RSSImage,        'rss_feed/rss_image.rb'
+  autoload :RSSSource,       'rss_feed/rss_source.rb'
+  autoload :RSSTextInput,    'rss_feed/rss_text_input.rb'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rss_feed
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Oliver Eilhard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.12.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+description: Ruby library for parsing RSS feeds.
+email:
+- oliver.eilhard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/rss_feed.rb
+- lib/rss_feed/core_ext.rb
+- lib/rss_feed/core_ext/string_ext.rb
+- lib/rss_feed/core_ext/try.rb
+- lib/rss_feed/open_search.rb
+- lib/rss_feed/open_search_query.rb
+- lib/rss_feed/rss_category.rb
+- lib/rss_feed/rss_channel.rb
+- lib/rss_feed/rss_channel_item.rb
+- lib/rss_feed/rss_cloud.rb
+- lib/rss_feed/rss_enclosure.rb
+- lib/rss_feed/rss_guid.rb
+- lib/rss_feed/rss_image.rb
+- lib/rss_feed/rss_source.rb
+- lib/rss_feed/rss_text_input.rb
+homepage: http://github.com/olivere/rss_feed
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby library for parsing RSS feeds.
+test_files: []