feedjira 2.2.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b8cec1f08ed12a497f98c7e4b622f8ab06b688a75e968175dd985ad93cfd4bd
-  data.tar.gz: 1015179ce20e86b0a02253411e02e9b78bf0294c8f18a8e2fba3fc92c5c04b01
+  metadata.gz: 0146f6f9717aa2550c7c3ee8ad10bdc2d1670b5a877979ec3b4b92acc8556a01
+  data.tar.gz: 336327b583cbda573b23b35c6c7e43633fb832ff8054be34126340ad8c8bff3a
 SHA512:
-  metadata.gz: ba84e098bed14b11cf07a816500ff853e3337039bce117abf1bedc17d28d5bc3072d39bb43f747580f8c48de57417df23284fb0d71eb1d79d9f35896ae5c2f5c
-  data.tar.gz: 8ab31a4eb8427f70d5f26f817c3296a5ab5ea650b1885d4ac5f9518cb7c85fc852ccd29923b29c2f3300f67c6efa558de44a2f4290314ba9b206fe428b6ca13e
+  metadata.gz: db78dc79cc38419c6f81a0336f4794d8f744b2cab24786c3c9ac9b92f2b72f2c5db190a982fcfb16de6ccec1b358309c76e3c165ec16141b8816736774339662
+  data.tar.gz: b9a4466a3371c7d1fb837cdc8ffcced9af1a830810b47113cd2a790c8c1145c0aae1a9faad91b642bec50a12469917ead27a48fc798e257e2017d736ef0e5101

data/.github/ISSUE_TEMPLATE/feed-parsing.md

@@ -0,0 +1,15 @@
+---
+name: Feed Parsing
+about: Your feed is parsing incorrectly, or you have a feed type that is not supported
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+### Steps to reproduce
+<!-- (Guidelines for creating a bug report are [available
+here](https://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html#creating-a-bug-report)) -->
+
+### Example feed URL
+<!-- Tell us what should happen -->

data/.rubocop.yml

@@ -1,15 +1,39 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
 
-Style/Documentation:
-  Enabled: true
+Gemspec/RequiredRubyVersion:
   Exclude:
-    - 'spec/**/*'
+    - 'feedjira.gemspec'
+
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 24
+
+# Offense count: 33
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 235
 
-Style/DocumentationMethod: 
-  Enabled: true
+# Offense count: 7
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 25
+
+Layout/LineLength:
   Exclude:
-    - 'spec/**/*'
+    - 'spec/**/*.rb'
+
+Style/AsciiComments:
+  Enabled: false
 
-Style/ClassAndModuleChildren:
+Style/IfUnlessModifier:
   Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,11 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-09-02 20:02:06 UTC using RuboCop version 0.90.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 20
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -3,9 +3,9 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3
+  - 2.5
+  - 2.6
+  - 2.7
   - jruby-9
   - ruby-head
 
@@ -28,10 +28,6 @@ before_install:
 
 script:
   - bundle exec rake
-  - bundle exec danger
 
 notifications:
   email: false
-  webhooks:
-    urls:
-      secure: XjoUz2rPXFHnitw//jN4qA92jq7bH19iOI/5KnuptLzz5HrWq1VAXxAr/Fh0KxYZT29G/9i5szaHX1QacfO7he4xa2tZKudRL70Dw3KRLgqLi70G6kFuZYlh+MgMHZy6KwZ/4/250wO31fpv24PCb2M56iTsev2g2uporeobO0Q=

data/CHANGELOG.md

@@ -1,19 +1,28 @@
 # Feedjira Changelog
 
-## 2.2.0
+## Unreleased
 
-* General
-  * Backport support for parsing new iTunes podcasting tags
-
-## 2.1.4
+* Enhancements
+  * Add support for the `a10` namespace used in RSS 2.0 feeds generated by .NET applications.  Currently `a10:link`, `a10:updated`, `a10:content` and `a10:name` are supported. [#440][] (@knu)
 
-* Bug fixes
-  * Prevent errors when a feed has multiple dates and some are unparseable
+## 3.1.0
 
-## 2.1.3
+* Breaking Changes
+  * `title` of Atom entry classes always return a plain text even in case the entry has a title of the HTML or XML type. [#423][] (@knu)
 
 * Enhancements
-  * No longer log date parsing errors as warnings, they are now debug messages
+  * `raw_title` and `title_type` are added to Atom entry classes. [#423][] (@knu)
+  * AtomGoogleAlerts is now a supported parser [#424][] (@knu)
+
+## 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
+  * 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,14 @@
-source 'https://rubygems.org/'
+# frozen_string_literal: true
+
+source "https://rubygems.org/"
 
 gemspec
 
-gem 'pry'
+gem "pry"
+gem "rubocop", "~> 0.90"
 
 group :test do
-  gem 'oga'
-  gem 'ox', platforms: [:mri, :rbx]
-  gem 'rake'
+  gem "oga"
+  gem "ox", platforms: %i[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:
-
-```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:
-
-```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
+## Parsing
 
-The parsing functionality of Feedjira has been exposed so that it can be used in
-isolation:
+An example of parsing a feed with Feedjira:
 
 ```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 version 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
-
-Feedjira can be configured to strip all whitespace but defaults to lstrip only:
-
-```ruby
-Feedjira.configure do |config|
-  config.strip_whitespace = true
-end
-```
+### Parsers
 
-#### Follow redirect limit
+#### Adding a custom parser
 
-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.
 
-The request timeout defaults to 30 but can be set:
+#### Explicitly set all available parsers
+
+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
 
@@ -205,6 +143,12 @@ add-ons and everything in between. Here are some of them:
 
 * [Solve for All][solve]: Solve for All combines search engine and feed parsing
   while protecting your privacy. It's even extendable by the community!
+  
+* [Feedi API][feedi]: Feedi simplifies how you handle RSS, Atom, or JSON feeds. You can add and keep track of your favourite           feed data with a simple and clean REST API. All entries are enriched by Machine Learning and Semantic engines.
+
+* [Breaker][breaker]: The social podcast app
+
+* [Huginn][huginn]: Huginn is a system for building agents that perform automated tasks for you online.
 
 [Feedbin]: https://feedbin.com/
 [Stringer]: https://github.com/swanson/stringer
@@ -212,6 +156,9 @@ add-ons and everything in between. Here are some of them:
 [Feedbunch]: https://github.com/amatriain/feedbunch
 [old]: http://theoldreader.com/
 [solve]: https://solveforall.com/
+[feedi]: https://github.com/davidesantangelo/feedi
+[breaker]: https://breaker.audio
+[huginn]: https://github.com/huginn/huginn
 
 Note: to get your project on this list, simply [send an email](mailto:feedjira@gmail.com)
 with your project's details.