feedjira 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a75fe90b3327d3110c7ba5e5ebe8acdbfc9e4c10
-  data.tar.gz: d4313aca74f021751d583f61c140a18aea2381b7
+SHA256:
+  metadata.gz: 3b8cec1f08ed12a497f98c7e4b622f8ab06b688a75e968175dd985ad93cfd4bd
+  data.tar.gz: 1015179ce20e86b0a02253411e02e9b78bf0294c8f18a8e2fba3fc92c5c04b01
 SHA512:
-  metadata.gz: 4004f548a5b6a3215294d5b8ebd81496c4603eaab3ba3c2f1b269815010fcbdc12cef8660a10ddd398159a09cb30443131e9c83b6973bf9cad9a746d78728c29
-  data.tar.gz: f426881efa2533cdef5bb34eb0ff57bc86259abfd26eb916fadc79dea1b30f4b95262ffc53d1539494fc306a845b4b68cd35377d79d41bcfd73976a8387fa12d
+  metadata.gz: ba84e098bed14b11cf07a816500ff853e3337039bce117abf1bedc17d28d5bc3072d39bb43f747580f8c48de57417df23284fb0d71eb1d79d9f35896ae5c2f5c
+  data.tar.gz: 8ab31a4eb8427f70d5f26f817c3296a5ab5ea650b1885d4ac5f9518cb7c85fc852ccd29923b29c2f3300f67c6efa558de44a2f4290314ba9b206fe428b6ca13e

data/.gitignore

@@ -1,7 +1,9 @@
 .bundle
+.projections.json
 .ruby-gemset
 .ruby-version
 Gemfile.lock
 doc/
+.yardoc/
 pkg/
 rdoc/

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+Style/DocumentationMethod: 
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/.travis.yml

@@ -1,18 +1,37 @@
 language: ruby
 
-bundler_args: --without tools
-
-branches:
-  only:
-    - master
+cache: bundler
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - rbx-2
+  - 2.1
+  - 2.2
+  - 2.3
+  - jruby-9
+  - ruby-head
 
 env:
-  matrix:
-    - HANDLER="nokogiri"
-    - HANDLER="ox"
+  - HANDLER=nokogiri
+  - HANDLER=ox
+  - HANDLER=oga
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: jruby-9
+    - rvm: ruby-head
+  exclude:
+    - rvm: jruby-9
+      env: HANDLER=ox
+
+before_install:
+  - gem update bundler
+
+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,10 +1,43 @@
 # Feedjira Changelog
 
+## 2.2.0
+
+* 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
+
+## 2.1.1
+
+configurable logging and parsing
+
+## 2.1.0
+
+* Enhancements
+  * AtomYoutube is now a supported parser [#337][] (@jfiorato)
+  * Oga parsing is now supported [#331][] (@krasnoukhov)
+  * DateTime Handler now supports localized dates [#313][] (@PascalTurbo)
+  * RSS now supports language attribute [#344][] (@PascalTurbo)
+  * ITunesRSS added support for:
+    * `ttl` and `last_built` [#343][] (@sferik)
+    * `itunes_category` and `itunes_category_paths` [#329][] (@knu)
+    * `itunes_complete` [#328][] (@knu)
+    * single quoted attributes [#326][] (@sferik)
+    * Add image attribute [#349][] (@sferik)
+
 ## 2.0.0
 
 * General
   * Replaced curb with faraday
-  * Removed update funcionality
+  * Removed update functionality
 
 ## 1.6.0
 

data/Dangerfile

@@ -0,0 +1 @@
+commit_lint.check(warn: :all)

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 gem 'pry'
 
 group :test do
+  gem 'oga'
+  gem 'ox', platforms: [:mri, :rbx]
   gem 'rake'
-  gem 'ox'
 end

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2009-2014:
+Copyright (c) 2009-2016:
 
 - Paul Dix
 - Julien Kirch

data/README.md

@@ -1,14 +1,217 @@
-# Feedjira [![Build Status][travis-badge]][travis] [![Code Climate][code-climate-badge]][code-climate]
+# Feedjira
 
-[travis-badge]: https://travis-ci.org/feedjira/feedjira.png
+[![Build Status][travis-badge]][travis] [![Code Climate][code-climate-badge]][code-climate] [![Gitter][gitter-badge]][gitter]
+
+[travis-badge]: https://travis-ci.org/feedjira/feedjira.svg?branch=master
 [travis]: http://travis-ci.org/feedjira/feedjira
-[code-climate-badge]: https://codeclimate.com/github/feedjira/feedjira.png
+[code-climate-badge]: https://codeclimate.com/github/feedjira/feedjira/badges/gpa.svg
 [code-climate]: https://codeclimate.com/github/feedjira/feedjira
+[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. Version 1.0 was recently released and with it an
-[awesome new website][f].
+feeds as quickly as possible.
+
+## Getting Started
+
+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:
+
+```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
+
+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
+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)
+```
+
+Now when you `fetch_and_parse`, `MyAwesomeParser` will be the first one to get a
+chance to parse the feed.
+
+If you have the XML and just want to provide a parser class for one parse, you
+can specify that using `parse_with`:
+
+```ruby
+Feedjira::Feed.parse_with(MyAwesomeParser, xml)
+```
+
+## Adding attributes to all feeds types / all entries types
+
+```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
+# => "TypePad"
+```
+
+## Adding attributes to only one class
+
+If you want to add attributes for only one class you simply have to declare them
+in the class
+
+```ruby
+# Add some GeoRss information
+class Feedjira::Parser::RSSEntry
+  element "georss:elevation", as: :elevation
+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|
+  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
+```
+
+#### Follow redirect limit
+
+For fetching feeds, the follow redirect limit defaults to 3 but can be set:
+
+```ruby
+Feedjira.configure do |config|
+  config.follow_redirect_limit = 5
+end
+```
+
+#### Request timeout
+
+The request timeout defaults to 30 but can be set:
+
+```ruby
+Feedjira.configure do |config|
+  config.request_timeout = 45
+end
+```
+
+#### User agent
+
+The default user agent is "Feedjira #{Version}" but can be set:
+
+```ruby
+Feedjira.configure do |config|
+  config.user_agent = "Awesome Feed Reader"
+end
+```
+
+## Testing
+
+Feedjira uses [faraday][] to perform requests, so testing Feedjira is really
+about [stubbing out faraday requests][stub].
+
+[faraday]: https://github.com/lostisland/faraday
+[stub]: https://github.com/lostisland/faraday#using-faraday-for-testing
+
+## Projects that use Feedjira
+
+Feedjira is used in some awesome projects around the web - from RSS readers to
+add-ons and everything in between. Here are some of them:
+
+* [Feedbin][]: Feedbin bills itself as a fast, simple RSS reader that delivers a
+  great reading experience. It's a paid RSS reader that integrates with mobile
+  apps and it even has a fully featured API!
+
+* [Stringer][]: Stringer is a self-hosted, anti-social RSS reader. It's an
+  open-source project that's easy to deploy to any host, there's even a
+  one-click button to deploy on Heroku.
+
+* [BlogFeeder][]: BlogFeeder is a paid Shopify App that makes it easy for you to
+  import any external blog into your Shopify store. It helps improve your
+  store's SEO and keeps your blogs in sync, plus a lot more.
+
+* [Feedbunch][]: Feedbunch is an open source feed reader built to fill the hole
+  left by Google Reader. It aims to support all features of Google Reader and
+  actually improve on others.
+
+* [The Old Reader][old]: The Old Reader advertises as the ultimate social RSS
+  reader. It's free to start and also has a paid premium version. There's an API
+  and it integrates with many different mobile apps.
+
+* [Solve for All][solve]: Solve for All combines search engine and feed parsing
+  while protecting your privacy. It's even extendable by the community!
 
-[f]: http://feedjira.com
+[Feedbin]: https://feedbin.com/
+[Stringer]: https://github.com/swanson/stringer
+[BlogFeeder]: https://apps.shopify.com/blogfeeder
+[Feedbunch]: https://github.com/amatriain/feedbunch
+[old]: http://theoldreader.com/
+[solve]: https://solveforall.com/
 
-There you'll find documentation, examples, announcements and more.
+Note: to get your project on this list, simply [send an email](mailto:feedjira@gmail.com)
+with your project's details.

data/Rakefile

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

data/feedjira.gemspec

@@ -2,27 +2,30 @@
 require File.expand_path('../lib/feedjira/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name    = 'feedjira'
-  s.version = Feedjira::VERSION
-  s.license = 'MIT'
-
   s.authors  = ['Paul Dix', 'Julien Kirch', 'Ezekiel Templin', 'Jon Allured']
   s.email    = 'feedjira@gmail.com'
   s.homepage = 'http://feedjira.com'
-
-  s.summary     = 'A feed fetching and parsing library'
-  s.description = 'A library designed to retrieve and parse feeds as quickly as possible'
+  s.license  = 'MIT'
+  s.name     = 'feedjira'
+  s.platform = Gem::Platform::RUBY
+  s.summary  = 'A feed fetching and parsing library'
+  s.version  = Feedjira::VERSION
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ['lib']
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
 
-  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>=1.9.3'
 
-  s.add_dependency 'sax-machine',        '~> 1.0'
-  s.add_dependency 'faraday',            '~> 0.9'
-  s.add_dependency 'faraday_middleware', '~> 0.9'
-  s.add_dependency 'loofah',             '~> 2.0'
+  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_development_dependency 'rspec', '~> 3.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'
 end

data/fixtures/vcr_cassettes/fetch_failure.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.example.com/feed.xml
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.2
+  response:
+    status:
+      code: 404
+      message: 
+    headers:
+      cache-control:
+      - max-age=604800
+      content-type:
+      - text/html
+      date:
+      - Mon, 31 Oct 2016 02:29:13 GMT
+      etag:
+      - '"359670651+gzip"'
+      expires:
+      - Mon, 07 Nov 2016 02:29:13 GMT
+      last-modified:
+      - Fri, 09 Aug 2013 23:54:35 GMT
+      server:
+      - ECS (oxr/83C7)
+      vary:
+      - Accept-Encoding
+      x-cache:
+      - HIT
+      x-ec-custom-error:
+      - '1'
+      content-length:
+      - '606'
+      connection:
+      - close
+    body:
+      encoding: ASCII-8BIT
+      string: "<!doctype html>\n<html>\n<head>\n    <title>Example Domain</title>\n\n
+        \   <meta charset=\"utf-8\" />\n    <meta http-equiv=\"Content-type\" content=\"text/html;
+        charset=utf-8\" />\n    <meta name=\"viewport\" content=\"width=device-width,
+        initial-scale=1\" />\n    <style type=\"text/css\">\n    body {\n        background-color:
+        #f0f0f2;\n        margin: 0;\n        padding: 0;\n        font-family: \"Open
+        Sans\", \"Helvetica Neue\", Helvetica, Arial, sans-serif;\n        \n    }\n
+        \   div {\n        width: 600px;\n        margin: 5em auto;\n        padding:
+        50px;\n        background-color: #fff;\n        border-radius: 1em;\n    }\n
+        \   a:link, a:visited {\n        color: #38488f;\n        text-decoration:
+        none;\n    }\n    @media (max-width: 700px) {\n        body {\n            background-color:
+        #fff;\n        }\n        div {\n            width: auto;\n            margin:
+        0 auto;\n            border-radius: 0;\n            padding: 1em;\n        }\n
+        \   }\n    </style>    \n</head>\n\n<body>\n<div>\n    <h1>Example Domain</h1>\n
+        \   <p>This domain is established to be used for illustrative examples in
+        documents. You may use this\n    domain in examples without prior coordination
+        or asking for permission.</p>\n    <p><a href=\"http://www.iana.org/domains/example\">More
+        information...</a></p>\n</div>\n</body>\n</html>\n"
+    http_version: 
+  recorded_at: Mon, 31 Oct 2016 02:29:13 GMT
+recorded_with: VCR 3.0.3