feedzirra 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bba513269bf90729e08896726cf12f62ece4880a
-  data.tar.gz: 1ea0c67b87dafccdb90cc5485f3997311adb9f63
+  metadata.gz: cdb3db9a21bc3184dd6da19a6f3d42b705b39b51
+  data.tar.gz: daabebe14cf96c5b64e36c96807be17ce22f8340
 SHA512:
-  metadata.gz: 35d266b0c2c150d19cc9dd38ab2248c82799b445a74e1f9d7cd664c523cbee4bc81f819bec80e14de5abe54db5d11e0adb4cb411e0c08b1fe55c4c9a285965fe
-  data.tar.gz: 1b87203126ac584717625ff6d80300be97fa26239dcea493b59e17eedc922ba2481587f4719d804d27ba9a93ad4d17fe3fd31fe6c13f3450fb03b0769a72360d
+  metadata.gz: 385cbc0091086ef09db6a9b5c112691342aa01c6cbe96196ec05cbdc768248a6c41eafe6127f9dd94e39a9b1e801696618e04d91f8abfcc063262b74bd247808
+  data.tar.gz: 549fe428debf283e32b6b06887bf2a9b23fffc398e73eced27a8bac13f916a87973775b7171450c237ebb84d8ba8ed1f9ba4faba2541447ec935af922568aeff

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Feedzirra Changelog
 
+## 0.3.0
+
+* General
+  * Add CodeClimate badge [[#192](https://github.com/pauldix/feedzirra/pull/192)]
+
+* Enhancements
+  * CURL SSL Version option [[#156](https://github.com/pauldix/feedzirra/pull/156)]
+  * Cookie support for Curb [[#98](https://github.com/pauldix/feedzirra/pull/98)]
+
+* Deprecations
+  * For `ITunesRSSItem`, use `id` instead of `guid` [[#169](https://github.com/pauldix/feedzirra/pull/169)]
+
 ## 0.2.2
 
 * General

data/README.md

@@ -1,4 +1,4 @@
-# Feedzirra [![Build Status](https://secure.travis-ci.org/pauldix/feedzirra.png)](http://travis-ci.org/pauldix/feedzirra)
+# Feedzirra [![Build Status](https://secure.travis-ci.org/pauldix/feedzirra.png)](http://travis-ci.org/pauldix/feedzirra) [![Code Climate](https://codeclimate.com/github/pauldix/feedzirra.png)](https://codeclimate.com/github/pauldix/feedzirra)
 
 I'd like feedback on the api and any bugs encountered on feeds in the wild. I've set up a [google group here](http://groups.google.com/group/feedzirra).
 

data/lib/feedzirra/feed.rb

@@ -113,14 +113,23 @@ module Feedzirra
     # Possible parameters:
     # * :user_agent          - overrides the default user agent.
     # * :compress            - any value to enable compression
-    # * :http_authentication - array containing http authentication parameters
+    # * :enable_cookies      - boolean
+    # * :cookiefile          - file to read cookies
+    # * :cookies             - contents of cookies header
+    # * :http_authentication - array containing username, then password
     # * :proxy_url           - proxy url
     # * :proxy_port          - proxy port
     # * :max_redirects       - max number of redirections
     # * :timeout             - timeout
-    def self.setup_easy curl, options
+    # * :ssl_verify_host     - boolean
+    # * :ssl_verify_peer     - boolean
+    # * :ssl_version         - the ssl version to use, see OpenSSL::SSL::SSLContext::METHODS for options
+    def self.setup_easy(curl, options={})
       curl.headers["Accept-encoding"]   = 'gzip, deflate' if options.has_key?(:compress)
       curl.headers["User-Agent"]        = (options[:user_agent] || USER_AGENT)
+      curl.enable_cookies               = options[:enable_cookies] if options.has_key?(:enable_cookies)
+      curl.cookiefile                   = options[:cookiefile] if options.has_key?(:cookiefile)
+      curl.cookies                      = options[:cookies] if options.has_key?(:cookies)
 
       curl.userpwd = options[:http_authentication].join(':') if options.has_key?(:http_authentication)
       curl.proxy_url = options[:proxy_url] if options.has_key?(:proxy_url)
@@ -128,6 +137,8 @@ module Feedzirra
       curl.max_redirects = options[:max_redirects] if options[:max_redirects]
       curl.timeout = options[:timeout] if options[:timeout]
       curl.ssl_verify_host = options[:ssl_verify_host] if options.has_key?(:ssl_verify_host)
+      curl.ssl_verify_peer = options[:ssl_verify_peer] if options.has_key?(:ssl_verify_peer)
+      curl.ssl_version = options[:ssl_version] if options.has_key?(:ssl_version)
 
       curl.follow_location = true
     end

data/lib/feedzirra/parser/itunes_rss_item.rb

@@ -8,7 +8,7 @@ module Feedzirra
       include FeedEntryUtilities
 
       element :author
-      element :guid
+      element :guid, :as => :entry_id
       element :title
       element :link, :as => :url
       element :description, :as => :summary
@@ -26,6 +26,11 @@ module Feedzirra
       element :enclosure, :value => :length, :as => :enclosure_length
       element :enclosure, :value => :type, :as => :enclosure_type
       element :enclosure, :value => :url, :as => :enclosure_url
+
+      def guid
+        warn "Feedzirra: ITunesRSSItem.guid is deprecated, please use `id` or `entry_id` instead. This will be removed in version 1.0"
+        id
+      end
     end
   end
 

data/lib/feedzirra/version.rb

@@ -1,3 +1,3 @@
 module Feedzirra
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/spec/feedzirra/feed_spec.rb

@@ -123,6 +123,71 @@ describe Feedzirra::Feed do
 
   end
 
+  describe "#setup_easy" do
+    class MockCurl
+      attr_accessor :follow_location, :userpwd, :proxy_url, :proxy_port, :max_redirects, :timeout, :ssl_verify_host, :ssl_verify_peer, :ssl_version, :enable_cookies, :cookiefile, :cookies
+
+      def headers
+        @headers ||= {}
+      end
+    end
+
+    let(:curl) { MockCurl.new }
+
+    it "sets defaults on curl" do
+      Feedzirra::Feed.setup_easy curl
+
+      curl.headers["User-Agent"].should eq Feedzirra::Feed::USER_AGENT
+      curl.follow_location.should eq true
+    end
+
+    it "allows user agent over-ride" do
+      Feedzirra::Feed.setup_easy(curl, user_agent: '007')
+      curl.headers["User-Agent"].should eq '007'
+    end
+
+    it "enables compression" do
+      Feedzirra::Feed.setup_easy(curl, compress: true)
+      curl.headers["Accept-encoding"].should eq 'gzip, deflate'
+    end
+
+    it "enables compression even when you act like you don't want it" do
+      Feedzirra::Feed.setup_easy(curl, compress: false)
+      curl.headers["Accept-encoding"].should eq 'gzip, deflate'
+    end
+
+    it "sets up http auth" do
+      Feedzirra::Feed.setup_easy(curl, http_authentication: ['user', 'pass'])
+      curl.userpwd.should eq 'user:pass'
+    end
+
+    it "passes known options to curl" do
+      known_options = {
+        enable_cookies: true,
+        cookiefile: 'cookies.txt',
+        cookies: 'asdf',
+        proxy_url: 'http://proxy.url.com',
+        proxy_port: '1234',
+        max_redirects: 2,
+        timeout: 500,
+        ssl_verify_host: true,
+        ssl_verify_peer: true,
+        ssl_version: :omg
+      }
+
+      Feedzirra::Feed.setup_easy curl, known_options
+
+      known_options.each do |option|
+        key, value = option
+        curl.send(key).should eq value
+      end
+    end
+
+    it "ignores unknown options" do
+      expect { Feedzirra::Feed.setup_easy curl, foo: :bar }.to_not raise_error
+    end
+  end
+
   describe "when adding feed types" do
     it "should prioritize added types over the built in ones" do
       feed_text = "Atom asdf"

data/spec/feedzirra/parser/itunes_rss_item_spec.rb

@@ -29,8 +29,8 @@ describe Feedzirra::Parser::ITunesRSSItem do
     @item.enclosure_url.should == "http://example.com/podcasts/everything/AllAboutEverythingEpisode3.m4a"
   end
 
-  it "should parse the guid" do
-    @item.guid.should == "http://example.com/podcasts/archive/aae20050615.m4a"
+  it "should parse the guid as id" do
+    @item.id.should == "http://example.com/podcasts/archive/aae20050615.m4a"
   end
 
   it "should parse the published date" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feedzirra
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Paul Dix
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: A feed fetching and parsing library