atom_feed 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b74b11f808c446e829d35bd5eb51cc436c19f086
+  data.tar.gz: 3a9393324ff29f23f1a052606360b9d764bc10e4
+SHA512:
+  metadata.gz: c94274e5c1bff7d0269caa7d1e3d0f1b020c78f1c69794e13a65779f6055d6983371dbc2ba3ba8ef6353a6cd31eb438f2ec39caed2e53bb9491842b87b55cfbc
+  data.tar.gz: e45c36644bd1bce341c020d8aedd23dd745762fce317ba2877a4ba3b9ba619368ccee45cac5df32ae289ea6f81f89486c75ad03bffb941a4def85155460b156f

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,11 @@
+# AtomFeed
+
+Convenient classes for parsing an [Atom feed](http://tools.ietf.org/html/rfc4287).
+
+## Links
+
+ * [The Atom Syndication Format (RFC 4287)](http://tools.ietf.org/html/rfc4287)
+ * [AtomEnabled](http://www.atomenabled.org/)
+ * [Atom on Wikipedia](http://en.wikipedia.org/wiki/Atom_(standard))
+ * [The Atom Publishing Protocol (RFC 5023)](http://bitworking.org/projects/atom/rfc5023.html)
+

data/lib/atom_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 Atom feeds.
+
+module AtomFeed
+  VERSION = "0.1.1"
+
+  # Atom 1.0 namespace
+  NS_ATOM_2005 = "http://www.w3.org/2005/Atom"
+
+  # OpenSearch 1.1 Draft 4 namespace
+  NS_OPENSEARCH_11 = "http://a9.com/-/spec/opensearch/1.1/"
+
+  # Well-known namespaces for use in Nokogiri
+  NS = {"atom" => NS_ATOM_2005, "opensearch" => NS_OPENSEARCH_11}
+
+  autoload :CoreExt,         'atom_feed/core_ext.rb'
+  autoload :AtomFeed,        'atom_feed/atom_feed.rb'
+  autoload :AtomFeedEntry,   'atom_feed/atom_feed_entry.rb'
+  autoload :AtomCategory,    'atom_feed/atom_category.rb'
+  autoload :AtomGenerator,   'atom_feed/atom_generator.rb'
+  autoload :AtomLink,        'atom_feed/atom_link.rb'
+  autoload :AtomPerson,      'atom_feed/atom_person.rb'
+  autoload :OpenSearch,      'atom_feed/open_search.rb'
+  autoload :OpenSearchQuery, 'atom_feed/open_search_query.rb'
+end

data/lib/atom_feed/atom_category.rb

@@ -0,0 +1,23 @@
+module AtomFeed
+  class AtomCategory
+    # Initializes the link.
+    def initialize(node)
+      @node = node
+    end
+
+    # Identifies the category (required).
+    def term
+      @node["term"]
+    end
+
+    # A categorization scheme (optional).
+    def scheme
+      @node["scheme"]
+    end
+
+    # Human readable label (optional).
+    def label
+      @node["label"]
+    end
+  end
+end

data/lib/atom_feed/atom_feed.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+require 'nokogiri'
+require 'atom_feed/core_ext'
+require 'atom_feed/atom_feed_entry'
+require 'atom_feed/atom_category'
+require 'atom_feed/atom_generator'
+require 'atom_feed/atom_link'
+require 'atom_feed/atom_person'
+require 'atom_feed/atom_text'
+require 'atom_feed/open_search'
+
+module AtomFeed
+  # AtomFeed::AtomFeed is the central place for
+  # working with feeds in the Atom format.
+  #
+  # Opening an atom feed from the network or a file system
+  # is done like this:
+  #
+  #   feed = AtomFeed::AtomFeed.open(open("http://example.com/atom.xml"))
+  #
+  # If you have a file you should do:
+  #
+  #   f = File.open("feed.xml")
+  #   feed = AtomFeed::AtomFeed.open(f)
+  #   f.close
+  #
+  # If you have an XML string you can do:
+  #
+  #   feed = AtomFeed::AtomFeed.open("<feed ...")
+  #
+  # One can open and parse the feed like so:
+  #
+  #   AtomFeed::AtomFeed.open(...) do |feed|
+  #     puts feed.title
+  #     feed.entries do |entry|
+  #       puts entry.title
+  #     end
+  #   end
+  #
+  # You can access OpenSearch extensions by using +AtomFeed.open_search+.
+  # Access to other embedded XML types are available by using AtomFeed.doc+
+  # directly. It's a +Nokogiri::XML+ instance.
+  #
+  # AtomFeed uses Nokogiri for parsing.
+  #
+  class AtomFeed
+
+    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)
+      feed = AtomFeed.new(doc)
+      yield feed if block_given?
+      feed
+    end
+
+    # Feed id (required).
+    def id
+      @doc.at_xpath("atom:feed/atom:id", ::AtomFeed::NS).content
+    end
+
+    # Feed title (required).
+    def title
+      @doc.at_xpath("atom:feed/atom:title", ::AtomFeed::NS).content
+    end
+
+    # Feed update date (required).
+    def updated
+      Time.parse @doc.at_xpath("atom:feed/atom:updated", ::AtomFeed::NS).content
+    end
+
+    # Array of Authors (optional).
+    def authors
+      nodes = @doc.xpath("atom:feed/atom:author", ::AtomFeed::NS) || []
+      nodes.map { |node| AtomPerson.new(node) }
+    end
+
+    # Array of links (optional).
+    def links
+      nodes = @doc.xpath("atom:feed/atom:link", ::AtomFeed::NS) || []
+      nodes.map { |node| AtomLink.new(node) }
+    end
+
+    # Array of feed entries (optional).
+    def entries
+      nodes = @doc.xpath("atom:feed/atom:entry", ::AtomFeed::NS) || []
+      nodes.map { |node| AtomFeedEntry.new(node) }
+    end
+
+    # Array of feed categories (optional).
+    def categories
+      nodes = @doc.xpath("atom:feed/atom:category", ::AtomFeed::NS) || []
+      nodes.map { |node| AtomCategory.new(node) }
+    end
+
+    # Array of contributors (optional).
+    def contributors
+      nodes = @doc.xpath("atom:feed/atom:contributor", ::AtomFeed::NS) || []
+      nodes.map { |node| AtomPerson.new(node) }
+    end
+
+    # Generator (optional).
+    def generator
+      node = @doc.at_xpath("atom:feed/atom:generator", ::AtomFeed::NS)
+      return nil unless node
+      AtomGenerator.new(node)
+    end
+
+    # Icon (optional).
+    def icon
+      @doc.at_xpath("atom:feed/atom:icon", ::AtomFeed::NS).try(:content)
+    end
+
+    # Logo (optional).
+    def logo
+      @doc.at_xpath("atom:feed/atom:logo", ::AtomFeed::NS).try(:content)
+    end
+
+    # rights (optional)
+    def rights
+      node = @doc.at_xpath("atom:feed/atom:rights", ::AtomFeed::NS)
+      return nil unless node
+      AtomText.new(node)
+    end
+
+    # subtitle (optional)
+    def subtitle
+      node = @doc.at_xpath("atom:feed/atom:subtitle", ::AtomFeed::NS)
+      return nil unless node
+      AtomText.new(node)
+    end
+
+    # Open Search extensions (optional)
+    def open_search
+      @open_search ||= OpenSearch.new(@doc)
+    end
+
+  end
+end

data/lib/atom_feed/atom_feed_entry.rb

@@ -0,0 +1,85 @@
+module AtomFeed
+  class AtomFeedEntry
+
+    attr_reader :node
+
+    def initialize(node)
+      @node = node
+    end
+
+    # Entry id (required).
+    def id
+      @node.at_xpath("atom:id", ::AtomFeed::NS).content
+    end
+
+    # Entry title (required).
+    def title
+      @node.at_xpath("atom:title", ::AtomFeed::NS).content
+    end
+
+    # Entry update date (required).
+    def updated
+      Time.parse @node.at_xpath("atom:updated", ::AtomFeed::NS).content
+    end
+
+    # Array of authors (optional).
+    def authors
+      nodes = @node.xpath("atom:author", ::AtomFeed::NS) || []
+      nodes.map { |node| AtomPerson.new(node) }
+    end
+
+    # Array of links (optional).
+    def links
+      nodes = @node.xpath("atom:link", ::AtomFeed::NS) || []
+      nodes.map { |node| AtomLink.new(node) }
+    end
+
+    # Content (optional)
+    def content
+      node = @node.at_xpath("atom:content", ::AtomFeed::NS)
+      return nil unless node
+      AtomText.new(node)
+    end
+
+    # Summary (optional)
+    def summary
+      node = @node.at_xpath("atom:summary", ::AtomFeed::NS)
+      return nil unless node
+      AtomText.new(node)
+    end
+
+    # categories (optional)
+    def categories
+      nodes = @node.xpath("atom:category", ::AtomFeed::NS) || []
+      nodes.map { |node| AtomCategory.new(node) }
+    end
+
+    # contributors (optional)
+    def contributors
+      nodes = @node.xpath("atom:contributor", ::AtomFeed::NS) || []
+      nodes.map { |node| AtomPerson.new(node) }
+    end
+
+    # Published (optional)
+    def published
+      time = @node.at_xpath("atom:published", ::AtomFeed::NS).try(:content)
+      return nil unless time
+      Time.parse(time)
+    end
+
+    # source (optional)
+    def source
+      if node = @node.at_xpath("atom:source", ::AtomFeed::NS)
+        AtomFeedEntry.new(node)
+      end
+    end
+
+    # rights (optional)
+    def rights
+      node = @node.at_xpath("atom:rights", ::AtomFeed::NS)
+      return nil unless node
+      AtomText.new(node)
+    end
+
+  end
+end

data/lib/atom_feed/atom_generator.rb

@@ -0,0 +1,25 @@
+module AtomFeed
+  class AtomGenerator
+    # Initializes the generator element.
+    def initialize(node)
+      @node = node
+    end
+
+    # Content of the generator
+    def to_s
+      @node.content
+    end
+
+    alias_method :content, :to_s
+
+    # URI (optional)
+    def uri
+      @node["uri"]
+    end
+
+    # Version (optional)
+    def version
+      @node["version"]
+    end
+  end
+end

data/lib/atom_feed/atom_link.rb

@@ -0,0 +1,98 @@
+module AtomFeed
+  class AtomLink
+    # Initializes the link.
+    def initialize(node)
+      @node = node
+    end
+
+    # The URI of the referenced resource (required).
+    def href
+      @node["href"]
+    end
+
+    # A single link relationship type (optional).
+    # It could be a full URI or one of some predefined
+    # values. Returns "alternate" as default.
+    def rel
+      @node["rel"] || "alternate"
+    end
+
+    # An alternate represenation of the entry or feed, e.g. a
+    # permalink to the HTML version of the resource?
+    def alternate?
+      self.rel == "alternate"
+    end
+
+    # A related resource (potentially large in size and might need
+    # special handling), e.g. an image or video recording?
+    def enclosure?
+      self.rel == "enclosure"
+    end
+
+    # A document related to the feed or entry?
+    def related?
+      self.rel == "related"
+    end
+
+    # The feed itself?
+    def self?
+      self.rel == "self"
+    end
+
+    # Source of the information provided in the entry?
+    def via?
+      self.rel == "via"
+    end
+
+    # Link to edit?
+    def edit?
+      self.rel == "edit"
+    end
+
+    # Reference to OpenSearch description document (OpenSearch extension)?
+    def search?
+      self.rel == "search"
+    end
+
+    # Reference to first search result in OpenSearch (OpenSearch extension)?
+    def first?
+      self.rel == "first"
+    end
+
+    # Reference to previous search results in OpenSearch (OpenSearch extension)?
+    def previous?
+      self.rel == "previous"
+    end
+
+    # Reference to next search results in OpenSearch (OpenSearch extension)?
+    def next?
+      self.rel == "next"
+    end
+
+    # Reference to last search result in OpenSearch (OpenSearch extension)?
+    def last?
+      self.rel == "last"
+    end
+
+    # Media type of the resource (optional)
+    def type
+      @node["type"]
+    end
+
+    # Language of the referenced resource (optional)
+    def hreflang
+      @node["hreflang"]
+    end
+
+    # Human readable information about the link (optional)
+    def title
+      @node["title"]
+    end
+
+    # Length of the resource in bytes (optional).
+    def length
+      @node["length"]
+    end
+
+  end
+end

data/lib/atom_feed/atom_person.rb

@@ -0,0 +1,23 @@
+module AtomFeed
+  class AtomPerson
+    # Initializes the person.
+    def initialize(node)
+      @node = node
+    end
+
+    # Human readable name of the person (required)
+    def name
+      @node.at_xpath("atom:name", ::AtomFeed::NS).content
+    end
+
+    # Home page for the person (optional)
+    def uri
+      @node.at_xpath("atom:uri", ::AtomFeed::NS).try(:content)
+    end
+
+    # Email address of the person (optional)
+    def email
+      @node.at_xpath("atom:email", ::AtomFeed::NS).try(:content)
+    end
+  end
+end

data/lib/atom_feed/atom_text.rb

@@ -0,0 +1,36 @@
+module AtomFeed
+  class AtomText
+    # Initializes the text element.
+    def initialize(node)
+      @node = node
+    end
+
+    # Content of the text
+    def to_s
+      @node.content
+    end
+
+    alias_method :content, :to_s
+
+    # Determines how the information is encoded.
+    # Default is "text"
+    def type
+      @node["type"] || "text"
+    end
+
+    # Plain text
+    def text?
+      self.type == "text"
+    end
+
+    # Entity escaped HTML
+    def html?
+      self.type == "html"
+    end
+
+    # Inline XHTML
+    def xhtml?
+      self.type == "xhtml"
+    end
+  end
+end

data/lib/atom_feed/core_ext.rb

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

data/lib/atom_feed/core_ext/string_ext.rb

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

data/lib/atom_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/atom_feed/open_search.rb

@@ -0,0 +1,44 @@
+require 'atom_feed/open_search_query'
+
+module AtomFeed
+  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("atom:feed/opensearch:totalResults", ::AtomFeed::NS).content.to_i rescue nil
+    end
+
+    def start_index
+      @node.at_xpath("atom:feed/opensearch:startIndex", ::AtomFeed::NS).content.to_i rescue nil
+    end
+
+=begin
+    def start_page
+      @node.at_xpath("atom:feed/opensearch:startPage", ::AtomFeed::NS).content.to_i rescue nil
+    end
+=end
+
+    def items_per_page
+      @node.at_xpath("atom:feed/opensearch:itemsPerPage", ::AtomFeed::NS).content.to_i rescue nil
+    end
+
+    # queries
+    def queries
+      nodes = @node.xpath("atom:feed/opensearch:Query", ::AtomFeed::NS) rescue nil
+      nodes.map { |node| OpenSearchQuery.new(node) } if nodes
+    end
+
+    # first
+    # previous
+    # next
+    # last
+    # search
+  end
+end

data/lib/atom_feed/open_search_query.rb

@@ -0,0 +1,28 @@
+module AtomFeed
+  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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: atom_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 Atom feeds.
+email:
+- oliver.eilhard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/atom_feed.rb
+- lib/atom_feed/atom_category.rb
+- lib/atom_feed/atom_feed.rb
+- lib/atom_feed/atom_feed_entry.rb
+- lib/atom_feed/atom_generator.rb
+- lib/atom_feed/atom_link.rb
+- lib/atom_feed/atom_person.rb
+- lib/atom_feed/atom_text.rb
+- lib/atom_feed/core_ext.rb
+- lib/atom_feed/core_ext/string_ext.rb
+- lib/atom_feed/core_ext/try.rb
+- lib/atom_feed/open_search.rb
+- lib/atom_feed/open_search_query.rb
+homepage: http://github.com/olivere/atom_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 Atom feeds.
+test_files: []