faraday_middleware-reddit 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c8176b8963036b5df1a473466816f24c7097f01
-  data.tar.gz: 4aec072756fcbccb834d32ed8dd3aeb1c66f8858
+  metadata.gz: 3a8bf096bc82afbfb647b67b46d95a2197a760ae
+  data.tar.gz: f1cea4e6ffe5be56610905ecf3471e7279383c61
 SHA512:
-  metadata.gz: ae93fb75328474ccf279951bb7582de3273794550708428e180c91d2e34030c18ae5ba956fc9c8b24f7262817cc9ace6b7da8f0e50659b17965f872708068185
-  data.tar.gz: eb6393b04f2a06a7abd3c4019a7cd3959685d8983db670140779d5bbc87393892bdd372555e44da6adc3880214b9f181fadd0d28dafe6016fdbdbc6f0abe651e
+  metadata.gz: 3b5462123374a82de0a701da5188855bd1b2766478c027b8070d0c56fe460effd53013af394341bce6cb9d6bad5ecef64c220f5a6b22fac281a5be9e5ae7db2e
+  data.tar.gz: ab18755c20a5c60d31b9b600d2dd26aacafc8e7f4b90d314767fd22fe76fc5a381531a609a1dbec30785d5300f6e6d56fcd93a29115c8b4b1acc58d43d4172d5

data/README.md

@@ -2,6 +2,8 @@
 
 A collection of Faraday middleware for use with the Reddit API.
 
+This project is the backbone for [reddit-base](https://github.com/dobs/reddit-base). If you're building a client from scratch or just want to get up and running quickly you might want to check it out instead.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,29 +31,34 @@ Like `faraday_middleware`, `faraday_middleware-reddit` requires a `json` library
 | Middleware | Type | Description |
 | --- | --- | --- |
 | `:reddit_authentication` | request | Authentication based on a username, password or pre-generated cookie. |
-| `:reddit_force_json` | request | Coerces reddit into returnign JSON for GET and POST requests. |
+| `:reddit_force_json` | use | Coerces reddit into returnign JSON for GET and POST requests. |
 | `:reddit_modhash` | use | Automatic modhash handling. |
+| `:reddit_raise_error` | response | Raises errors for common reddit error cases. |
 | `:reddit_rate_limit` | use | Rate limiting based on reddit's `x-ratelimit` headers. Accepts a `strategy` proc to override default linear strategy. |
 
 ## Examples
 
 An example Farday client might look like:
 
-    require 'faraday_middleware/reddit'
+```ruby
+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|
-      faraday.request  :url_encoded
-      faraday.request  :reddit_authentication, user: 'yourusername', password: 'yourpassword'
+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'
+  faraday.request  :retry, max: 2, interval: 2, exceptions: FaradayMiddleware::Reddit::RETRIABLE_ERRORS
 
-      faraday.response :logger
-      faraday.response :follow_redirects
+  faraday.response :logger
+  faraday.response :follow_redirects
+  faraday.response :reddit_raise_error
 
-      faraday.use  :reddit_force_json
-      faraday.use  :reddit_rate_limit
-      faraday.use  :reddit_modhash
+  faraday.use  :reddit_force_json
+  faraday.use  :reddit_rate_limit
+  faraday.use  :reddit_modhash
 
-      faraday.adapter  Faraday.default_adapter
-    end
+  faraday.adapter  Faraday.default_adapter
+end
+```
 
 ## Contributing
 

data/lib/faraday_middleware/reddit/error.rb

@@ -2,11 +2,48 @@ 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
+    class ClientError < Faraday::ClientError; end
+    class ServerError < Faraday::ClientError; end
 
-    RETRIABLE_ERRORS = [ServiceUnavailableError, GatewayTimeoutError]
+    # Many of these errors are hypothetical, but better safe than sorry.
+    class BadRequestError            < ClientError; end
+    class UnauthorizedError          < ClientError; end
+    class ForbiddenError             < ClientError; end
+    class NotFoundError              < ClientError; end
+    class MethodNotAllowedError      < ClientError; end
+    class NotAcceptableError         < ClientError; end
+    class RequestTimeoutError        < ClientError; end
+    class RequestEntityTooLargeError < ClientError; end
+    class RequestURITooLongError     < ClientError; end
+    class UnsupportedMediaTypeError  < ClientError; end
+    class TooManyRequestsError       < ClientError; end
+    class InternalServerError        < ServerError; end
+    class NotImplementedError        < ServerError; end
+    class BadGatewayError            < ServerError; end
+    class ServiceUnavailableError    < ServerError; end
+    class GatewayTimeoutError        < ServerError; end
+
+    ERROR_CODES = {
+      400 => BadRequestError,
+      401 => UnauthorizedError,
+      403 => ForbiddenError,
+      404 => NotFoundError,
+      405 => MethodNotAllowedError,
+      406 => NotAcceptableError,
+      408 => RequestTimeoutError,
+      413 => RequestEntityTooLargeError,
+      414 => RequestURITooLongError,
+      429 => TooManyRequestsError,
+      500 => InternalServerError,
+      501 => NotImplementedError,
+      502 => BadGatewayError,
+      503 => ServiceUnavailableError,
+      504 => GatewayTimeoutError
+    }.freeze
+
+    RETRIABLE_ERRORS = [
+      ServiceUnavailableError,
+      GatewayTimeoutError
+    ].freeze
   end
 end

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

@@ -14,8 +14,8 @@ module FaradayMiddleware
 
         body = env[:body]
         body = JSON.parse(body) if body.is_a?(String) && !body.strip.empty?
-        body = body['json'] if body['json']
-        body['data']['modhash'] if body['data']
+        body = body['json'] if body.is_a?(Hash) && body['json']
+        body['data']['modhash'] if body.is_a?(Hash) && body['data']
       end
     end
   end

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

@@ -8,18 +8,11 @@ module FaradayMiddleware
     # 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)
+        if FaradayMiddleware::Reddit::ERROR_CODES.include? env[:status]
+          raise FaradayMiddleware::Reddit::ERROR_CODES[env[:status]], response_values(env)
+        else
+          super
         end
-
-        super
       end
     end
   end

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

@@ -30,7 +30,8 @@ module FaradayMiddleware
       end
 
       def update_modhash(env)
-        @modhash = extract_modhash(env)
+        modhash = extract_modhash(env)
+        @modhash = modhash if modhash
       rescue JSON::JSONError
         # Ignore -- modhash can be acquired lazily.
       end

data/lib/faraday_middleware/reddit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-reddit
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Daniel O'Brien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler