feedjira 2.2.0 → 3.0.0.beta1

data/.travis.yml

@@ -3,9 +3,9 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.1
   - 2.2
   - 2.3
+  - 2.4
   - jruby-9
   - ruby-head
 

data/CHANGELOG.md

@@ -1,19 +1,13 @@
 # Feedjira Changelog
 
-## 2.2.0
+## 3.0.0
 
+* Breaking Changes
+  * `Feedjira::Feed.parse` has moved to `Feedjira.parse`
+  * `Feedjira::Feed.fetch_and_parse` has been removed. See README examples for
+      how to request XML and parse.
 * General
-  * Backport support for parsing new iTunes podcasting tags
-
-## 2.1.4
-
-* Bug fixes
-  * Prevent errors when a feed has multiple dates and some are unparseable
-
-## 2.1.3
-
-* Enhancements
-  * No longer log date parsing errors as warnings, they are now debug messages
+  * Drop support for Ruby 2.1
 
 ## 2.1.1
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mikeastock@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,11 +1,11 @@
-source 'https://rubygems.org/'
+source "https://rubygems.org/"
 
 gemspec
 
-gem 'pry'
+gem "pry"
 
 group :test do
-  gem 'oga'
-  gem 'ox', platforms: [:mri, :rbx]
-  gem 'rake'
+  gem "oga"
+  gem "ox", platforms: [:mri, :rbx]
+  gem "rake"
 end

data/README.md

@@ -9,96 +9,34 @@
 [gitter-badge]: https://badges.gitter.im/feedjira/feedjira.svg
 [gitter]: https://gitter.im/feedjira/feedjira?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
 
-Feedjira (formerly Feedzirra) is a Ruby library designed to fetch and parse
-feeds as quickly as possible.
+Feedjira is a Ruby library designed to parse feeds.
 
-## Getting Started
+## Installation
 
-Feedjira is tested with Ruby version 1.9.3 and 2.x so like any Ruby gem, the
-first step is to install the gem:
-
-```
-$ gem install feedjira
-```
-
-Or add it to your Gemfile:
+Add this line to your application's Gemfile:
 
 ```ruby
 gem "feedjira"
 ```
 
-## Fetching and Parsing
-
-For many users, the `fetch_and_parse` method is what they use Feedjira for. This
-method takes a url and returns a Parser object:
+## Parsing
 
-```ruby
-url = "http://feedjira.com/blog/feed.xml"
-feed = Feedjira::Feed.fetch_and_parse(url)
-# => #<Feedjira::Parser::Atom...>
-```
-
-These feed objects have both the meta data for a feed and an `entries`
-collection that contains all the entries that were found:
+An example of parsing a feed with Feedjira:
 
 ```ruby
-feed.title
-# => "Feedjira Blog"
-feed.url
-# => "http://feedjira.com/blog"
-feed.entries # returns an array of Entry objects
-# => [<Feedjira::Feed::Entry ...>, <Feedjira::Feed::Entry ...>, ...]
-```
-
-These entry objects contain the data parsed from the feed XML:
-
-```ruby
-entry = feed.entries.first
-entry.title
-# => "Announcing verison 1.0"
-entry.url
-# => "http://feedjira.com/blog/2014-02-12-announcing-version-10.html"
-```
-
-## Just Parsing
-
-The parsing functionality of Feedjira has been exposed so that it can be used in
-isolation:
-
-```ruby
-xml = Faraday.get(url).body
-feed = Feedjira::Feed.parse xml
+xml = HTTParty.get(url).body
+feed = Feedjira.parse(xml)
 feed.entries.first.title
-# => "Announcing verison 1.0"
-```
-
-## Adding a feed parsing class
-
-When determining which parser to use for a given XML document, the following
-list of parser classes is used:
-
-* `Feedjira::Parser::RSSFeedBurner`
-* `Feedjira::Parser::GoogleDocsAtom`
-* `Feedjira::Parser::AtomFeedBurner`
-* `Feedjira::Parser::Atom`
-* `Feedjira::Parser::ITunesRSS`
-* `Feedjira::Parser::RSS`
-
-You can insert your own parser at the front of this stack by calling
-`add_feed_class`, like this:
-
-```ruby
-Feedjira::Feed.add_feed_class(MyAwesomeParser)
+# => "Announcing verison 3.0"
 ```
 
-Now when you `fetch_and_parse`, `MyAwesomeParser` will be the first one to get a
-chance to parse the feed.
+## Specifying parser
 
 If you have the XML and just want to provide a parser class for one parse, you
-can specify that using `parse_with`:
+can specify that using `parse` with the parser option:
 
 ```ruby
-Feedjira::Feed.parse_with(MyAwesomeParser, xml)
+Feedjira.parse(xml, parser: MyAwesomeParser)
 ```
 
 ## Adding attributes to all feeds types / all entries types
@@ -106,7 +44,8 @@ Feedjira::Feed.parse_with(MyAwesomeParser, xml)
 ```ruby
 # Add the generator attribute to all feed types
 Feedjira::Feed.add_common_feed_element("generator")
-Feedjira::Feed.fetch_and_parse("http://www.pauldix.net/atom.xml").generator
+xml = HTTParty.get("http://www.pauldix.net/atom.xml").body
+Feedjira.parse(xml).generator
 # => "TypePad"
 ```
 
@@ -123,60 +62,59 @@ end
 
 # Fetch a feed containing GeoRss info and print them
 url = "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/significant_week.atom"
-Feedjira::Feed.fetch_and_parse(url).entries.each do |entry|
+xml = HTTParty.get(url).body
+Feedjira.parse(xml).entries.each do |entry|
   puts "Elevation: #{entry.elevation}"
 end
 ```
 
 ## Configuration
 
-#### Stripping whitespace from XML
+### Parsers
 
-Feedjira can be configured to strip all whitespace but defaults to lstrip only:
+#### Adding a custom parser
 
-```ruby
-Feedjira.configure do |config|
-  config.strip_whitespace = true
-end
-```
-
-#### Follow redirect limit
-
-For fetching feeds, the follow redirect limit defaults to 3 but can be set:
+You can insert your own parser at the front of the available parser list by:
 
 ```ruby
 Feedjira.configure do |config|
-  config.follow_redirect_limit = 5
+  config.parsers.unshift(MyAwesomeParser)
 end
 ```
 
-#### Request timeout
+Now when you call `Feedjira.parse`, `MyAwesomeParser` will be the first one to
+get a chance to parse the feed.
+
+#### Explicitly set all available parsers
 
-The request timeout defaults to 30 but can be set:
+Feedjira can be configured to use a specific set of parsers and in a specific order:
 
 ```ruby
 Feedjira.configure do |config|
-  config.request_timeout = 45
+  config.parsers = [
+    Feedjira::Parser::ITunesRSS,
+    MyAwesomeParser,
+    Feedjira::Parser::RSS
+  ]
 end
 ```
 
-#### User agent
+#### Stripping whitespace from XML
 
-The default user agent is "Feedjira #{Version}" but can be set:
+Feedjira can be configured to strip all whitespace but defaults to lstrip only:
 
 ```ruby
 Feedjira.configure do |config|
-  config.user_agent = "Awesome Feed Reader"
+  config.strip_whitespace = true
 end
 ```
 
-## Testing
-
-Feedjira uses [faraday][] to perform requests, so testing Feedjira is really
-about [stubbing out faraday requests][stub].
+## Contributing
 
-[faraday]: https://github.com/lostisland/faraday
-[stub]: https://github.com/lostisland/faraday#using-faraday-for-testing
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/feedjira/feedjira. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## Projects that use Feedjira
 

data/Rakefile

@@ -1,17 +1,17 @@
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'yard'
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
 end
 
 RuboCop::RakeTask.new(:rubocop) do |t|
-  t.options = ['--display-cop-names']
+  t.options = ["--display-cop-names"]
 end
 
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb', '-', 'LICENSE']
+  t.files   = ["lib/**/*.rb", "-", "LICENSE"]
 end
 
 task default: [:spec, :rubocop]

data/feedjira.gemspec

@@ -1,31 +1,39 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/feedjira/version', __FILE__)
 
+require File.expand_path("../lib/feedjira/version", __FILE__)
+
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |s|
-  s.authors  = ['Paul Dix', 'Julien Kirch', 'Ezekiel Templin', 'Jon Allured']
-  s.email    = 'feedjira@gmail.com'
-  s.homepage = 'http://feedjira.com'
-  s.license  = 'MIT'
-  s.name     = 'feedjira'
+  s.authors = [
+    "Adam Hess",
+    "Ezekiel Templin",
+    "Jon Allured",
+    "Julien Kirch",
+    "Michael Stock",
+    "Paul Dix",
+  ]
+  s.email    = "feedjira@gmail.com"
+  s.homepage = "http://feedjira.com"
+  s.license  = "MIT"
+  s.name     = "feedjira"
   s.platform = Gem::Platform::RUBY
-  s.summary  = 'A feed fetching and parsing library'
+  s.summary  = "A feed parsing library"
   s.version  = Feedjira::VERSION
 
   s.files         = `git ls-files`.split("\n")
-  s.require_paths = ['lib']
+  s.require_paths = ["lib"]
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 
-  s.required_ruby_version = '>=1.9.3'
+  s.required_ruby_version = ">=1.9.3"
 
-  s.add_dependency 'faraday',            '>= 0.9'
-  s.add_dependency 'faraday_middleware', '>= 0.9'
-  s.add_dependency 'loofah',             '>= 2.0'
-  s.add_dependency 'sax-machine',        '>= 1.0'
+  s.add_dependency "loofah",             ">= 2.0"
+  s.add_dependency "sax-machine",        ">= 1.0"
 
-  s.add_development_dependency 'danger'
-  s.add_development_dependency 'danger-commit_lint'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '0.46'
-  s.add_development_dependency 'vcr'
-  s.add_development_dependency 'yard', '~> 0.9'
+  s.add_development_dependency "danger"
+  s.add_development_dependency "danger-commit_lint"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "yard"
 end
+# rubocop:enable Metrics/BlockLength

data/lib/feedjira.rb

@@ -1,47 +1,75 @@
-require 'zlib'
-require 'faraday'
-require 'faraday_middleware'
-require 'sax-machine'
-require 'loofah'
-require 'logger'
-
-require 'feedjira/core_ext'
-require 'feedjira/configuration'
-require 'feedjira/date_time_utilities/date_time_epoch_parser'
-require 'feedjira/date_time_utilities/date_time_language_parser'
-require 'feedjira/date_time_utilities/date_time_pattern_parser'
-require 'feedjira/date_time_utilities'
-require 'feedjira/date_time_utilities'
-require 'feedjira/feed_entry_utilities'
-require 'feedjira/feed_utilities'
-require 'feedjira/feed'
-require 'feedjira/parser'
-require 'feedjira/parser/rss_entry'
-require 'feedjira/parser/rss_image'
-require 'feedjira/parser/rss'
-require 'feedjira/parser/atom_entry'
-require 'feedjira/parser/atom'
-require 'feedjira/preprocessor'
-require 'feedjira/version'
-
-require 'feedjira/parser/rss_feed_burner_entry'
-require 'feedjira/parser/rss_feed_burner'
-require 'feedjira/parser/podlove_chapter'
-require 'feedjira/parser/itunes_rss_owner'
-require 'feedjira/parser/itunes_rss_category'
-require 'feedjira/parser/itunes_rss_item'
-require 'feedjira/parser/itunes_rss'
-require 'feedjira/parser/atom_feed_burner_entry'
-require 'feedjira/parser/atom_feed_burner'
-require 'feedjira/parser/google_docs_atom_entry'
-require 'feedjira/parser/google_docs_atom'
-require 'feedjira/parser/atom_youtube_entry'
-require 'feedjira/parser/atom_youtube'
+require "zlib"
+require "sax-machine"
+require "loofah"
+require "logger"
+require "json"
+
+require "feedjira/core_ext"
+require "feedjira/configuration"
+require "feedjira/date_time_utilities/date_time_epoch_parser"
+require "feedjira/date_time_utilities/date_time_language_parser"
+require "feedjira/date_time_utilities/date_time_pattern_parser"
+require "feedjira/date_time_utilities"
+require "feedjira/date_time_utilities"
+require "feedjira/feed_entry_utilities"
+require "feedjira/feed_utilities"
+require "feedjira/feed"
+require "feedjira/parser"
+require "feedjira/parser/rss_entry"
+require "feedjira/parser/rss_image"
+require "feedjira/parser/rss"
+require "feedjira/parser/atom_entry"
+require "feedjira/parser/atom"
+require "feedjira/preprocessor"
+require "feedjira/version"
+
+require "feedjira/parser/rss_feed_burner_entry"
+require "feedjira/parser/rss_feed_burner"
+require "feedjira/parser/podlove_chapter"
+require "feedjira/parser/itunes_rss_owner"
+require "feedjira/parser/itunes_rss_category"
+require "feedjira/parser/itunes_rss_item"
+require "feedjira/parser/itunes_rss"
+require "feedjira/parser/atom_feed_burner_entry"
+require "feedjira/parser/atom_feed_burner"
+require "feedjira/parser/google_docs_atom_entry"
+require "feedjira/parser/google_docs_atom"
+require "feedjira/parser/atom_youtube_entry"
+require "feedjira/parser/atom_youtube"
+require "feedjira/parser/json_feed"
+require "feedjira/parser/json_feed_item"
 
 # Feedjira
 module Feedjira
-  class NoParserAvailable < StandardError; end
-  class FetchFailure < StandardError; end
+  NoParserAvailable = Class.new(StandardError)
 
   extend Configuration
+
+  # Parse XML with first compatible parser
+  #
+  # @example
+  #   xml = HTTParty.get("http://example.com").body
+  #   Feedjira.parse(xml)
+  def parse(xml, parser: nil, &block)
+    parser ||= parser_for_xml(xml)
+
+    if parser.nil?
+      raise NoParserAvailable, "No valid parser for XML."
+    end
+
+    parser.parse(xml, &block)
+  end
+  module_function :parse
+
+  # Find compatible parser for given XML
+  #
+  # @example
+  #   xml = HTTParty.get("http://example.com").body
+  #   parser = Feedjira.parser_for_xml(xml)
+  #   parser.parse(xml)
+  def parser_for_xml(xml)
+    start_of_doc = xml.slice(0, 2000)
+    Feedjira.parsers.detect { |klass| klass.able_to_parse?(start_of_doc) }
+  end
+  module_function :parser_for_xml
 end