faraday_middleware-reddit 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 126f0eb8d05054996da34d5bd58dbdc0f4382bf6
-  data.tar.gz: a74cfa20ebc7484a892ecf8a22b49a64c23fed0f
+  metadata.gz: 6c8176b8963036b5df1a473466816f24c7097f01
+  data.tar.gz: 4aec072756fcbccb834d32ed8dd3aeb1c66f8858
 SHA512:
-  metadata.gz: 2e00559891603a725434bdee4edc9bf87ec36f8493a5387ba6cbfa49cbabd2309e09f8613d871229b5ab264c27f5ed6a05d24fba186ee3bcc8c1fff40213f21b
-  data.tar.gz: 886f50b45522fdf140b6dc5c250d369d68cbcba1855df2fc90d207d0bbbeeaeba0f4dcd2bad535d91447aee8f1f3ba4171562c625a4fdc31c3b8376d419c0059
+  metadata.gz: ae93fb75328474ccf279951bb7582de3273794550708428e180c91d2e34030c18ae5ba956fc9c8b24f7262817cc9ace6b7da8f0e50659b17965f872708068185
+  data.tar.gz: eb6393b04f2a06a7abd3c4019a7cd3959685d8983db670140779d5bbc87393892bdd372555e44da6adc3880214b9f181fadd0d28dafe6016fdbdbc6f0abe651e

data/README.md

@@ -39,7 +39,7 @@ An example Farday client might look like:
 
     require 'faraday_middleware/reddit'
 
-    conn = Faraday.new(:url => 'http://www.reddit.com', :headers => {'User-Agent' => 'faraday_middleware-reddit example (v 0.0.1)'}) do |faraday|
+    conn = Faraday.new(url: 'http://www.reddit.com', headers: {'User-Agent' => 'faraday_middleware-reddit example (v 0.0.1)'}) do |faraday|
       faraday.request  :url_encoded
       faraday.request  :reddit_authentication, user: 'yourusername', password: 'yourpassword'
 

data/lib/faraday_middleware/reddit.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'faraday'
+require 'faraday_middleware/reddit/error'
 require 'faraday_middleware/reddit/helpers/modhash'
 
 module FaradayMiddleware
@@ -8,11 +9,14 @@ module FaradayMiddleware
     autoload :Authentication, 'faraday_middleware/reddit/request/authentication'
     autoload :ForceJson,      'faraday_middleware/reddit/use/force_json'
     autoload :Modhash,        'faraday_middleware/reddit/use/modhash'
+    autoload :RaiseError,     'faraday_middleware/reddit/response/raise_error'
     autoload :RateLimit,      'faraday_middleware/reddit/use/rate_limit'
 
     if Faraday::Middleware.respond_to? :register_middleware
       Faraday::Request.register_middleware \
         reddit_authentication: -> { Authentication }
+      Faraday::Response.register_middleware \
+        reddit_raise_error: -> { RaiseError }
       Faraday::Middleware.register_middleware \
         reddit_force_json: -> { ForceJson },
         reddit_modhash: -> { Modhash },

data/lib/faraday_middleware/reddit/error.rb

@@ -0,0 +1,12 @@
+require 'faraday/error'
+
+module FaradayMiddleware
+  module Reddit
+    class TooManyRequestsError    < Faraday::ClientError; end # HTTP Status 429
+    class BadGatewayError         < Faraday::ClientError; end # HTTP Status 502
+    class ServiceUnavailableError < Faraday::ClientError; end # HTTP Status 503
+    class GatewayTimeoutError     < Faraday::ClientError; end # HTTP Status 504
+
+    RETRIABLE_ERRORS = [ServiceUnavailableError, GatewayTimeoutError]
+  end
+end

data/lib/faraday_middleware/reddit/request/authentication.rb

@@ -12,7 +12,9 @@ module FaradayMiddleware
     class Authentication < Faraday::Middleware
       include ModhashHelpers
 
-      AUTH_URL = 'https://ssl.reddit.com/api/login'.freeze
+      AUTH_DOMAIN = 'https://ssl.reddit.com'.freeze
+      AUTH_PATH   = "/api/login".freeze
+      AUTH_URL    = "#{AUTH_DOMAIN}#{AUTH_PATH}"
 
       def initialize(app, options)
         super(app)
@@ -54,10 +56,19 @@ module FaradayMiddleware
       end
 
       def authenticate(env)
-        response = Faraday.post AUTH_URL, user: @user, passwd: @passwd, rem: @rem, api_type: 'json'
+        response = connection(env).post AUTH_PATH, user: @user, passwd: @passwd, rem: @rem, api_type: 'json'
         env[:modhash] = extract_modhash(response.env)
         @cookie = response.headers['set-cookie']
       end
+
+      def connection(env)
+        Faraday.new(url: AUTH_DOMAIN, headers: env['request_headers']) do |faraday|
+          faraday.request  :url_encoded
+          faraday.request  :retry, max: 5, interval: 2, exceptions: FaradayMiddleware::Reddit::RETRIABLE_ERRORS
+          faraday.response :reddit_raise_error
+          faraday.adapter  Faraday.default_adapter
+        end
+      end
     end
   end
 end

data/lib/faraday_middleware/reddit/response/raise_error.rb

@@ -0,0 +1,26 @@
+require 'faraday_middleware/reddit/error'
+
+module FaradayMiddleware
+  module Reddit
+    # Extended version of Faraday::Response::RaiseError
+    #
+    # Provides additional exception cases for common reddit errors, such as
+    # 429 for hitting the API rate limit or 504 for gateway timeouts.
+    class RaiseError < Faraday::Response::RaiseError
+      def on_complete(env)
+        case env[:status]
+        when 429
+          raise FaradayMiddleware::Reddit::TooManyRequestsError, response_values(env)
+        when 502
+          raise FaradayMiddleware::Reddit::BadGatewayError, response_values(env)
+        when 503
+          raise FaradayMiddleware::Reddit::ServiceUnavailableError, response_values(env)
+        when 504
+          raise FaradayMiddleware::Reddit::GatewayTimeoutError, response_values(env)
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/faraday_middleware/reddit/use/modhash.rb

@@ -19,6 +19,9 @@ module FaradayMiddleware
       end
 
       def call(env)
+        # Modhash unnecessary when using OAuth.
+        return @app.call(env) if env[:request_headers]['Authorization']
+
         @modhash = env[:modhash] if env[:modhash]
         env[:request_headers]['X-Modhash'] = @modhash if @modhash
         @app.call(env).on_complete do |response_env|

data/lib/faraday_middleware/reddit/use/rate_limit.rb

@@ -8,7 +8,7 @@ module FaradayMiddleware
     #
     # Logs reddit's ratelimit HTTP headers and applies a caching strategy
     # based on them. The default strategy is to block for x-ratelimit-reset /
-    # x-ratelimit_remaining.
+    # x-ratelimit-remaining.
     class RateLimit < Faraday::Middleware
       def initialize(app, options = nil)
         super(app)
@@ -23,12 +23,7 @@ module FaradayMiddleware
       end
 
       def call(env)
-        if @ratelimit_remaining <= 0 || env[:status] == 429
-          sleep(@ratelimit_reset)
-        else
-          @strategy.call
-        end
-
+        @strategy.call
         @app.call(env).on_complete { |response_env| on_complete_callback(response_env) }
       end
 
@@ -37,6 +32,8 @@ module FaradayMiddleware
         @ratelimit_used      = env[:response_headers]['x-ratelimit-used'].to_i
         @ratelimit_reset     = env[:response_headers]['x-ratelimit-reset'].to_i
         @ratelimit_cap       = @ratelimit_remaining + @ratelimit_used
+
+        sleep(@ratelimit_reset) if @ratelimit_remaining == 0 || env[:status] == 429
       end
 
       def linear_strategy

data/lib/faraday_middleware/reddit/version.rb

@@ -2,6 +2,6 @@
 
 module FaradayMiddleware
   module Reddit
-    VERSION = '0.3.2'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-reddit
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel O'Brien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-28 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,8 +81,10 @@ files:
 - Rakefile
 - faraday_middleware-reddit.gemspec
 - lib/faraday_middleware/reddit.rb
+- lib/faraday_middleware/reddit/error.rb
 - lib/faraday_middleware/reddit/helpers/modhash.rb
 - lib/faraday_middleware/reddit/request/authentication.rb
+- lib/faraday_middleware/reddit/response/raise_error.rb
 - lib/faraday_middleware/reddit/use/force_json.rb
 - lib/faraday_middleware/reddit/use/modhash.rb
 - lib/faraday_middleware/reddit/use/rate_limit.rb
@@ -108,10 +110,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A collection of Faraday middleware for use with the Reddit API.
 test_files:
 - spec/helper.rb
-has_rdoc: