reddit-base 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3050b7e6d6b2a676067d35bc9a5027fc4f27e4b
-  data.tar.gz: a88430d27af49335827efe29d4118a8bfb28e0bb
+  metadata.gz: b67f0344526fb1cfd6c7913c61452d9bdc138bdc
+  data.tar.gz: f303e6f16741a9c946c20847b6aff850ccefd293
 SHA512:
-  metadata.gz: e354d7e5b264c18eb5e6a6181ae7023fc42a3571dfc5c2bb59537fc32480a189208c2627221cc452ac8832b82fa5a40e169d3425d15bcc3aea2eb7a0d7695b28
-  data.tar.gz: f6e90de8c1dba0a229139ed42207eb6b9a20c3c84c2421a4ebf3529f4bb8f4595263f35b8f29489ab31b9e0ede496743588702dc8c6318acf7bf9fdfbd9f430e
+  metadata.gz: 00bd9c8bf4c7e32a7114143c518415a6867928c9d8ac4a8370b25204d0da6a368fd1dfa0d9544b7199a2086af2d1c850d8b6155248936ea9d73f1b323c0551ad
+  data.tar.gz: b454f237ccd5e4fb16073ec839babea60bf7d2398e5d626f7b7795fc7d47ad86a977b9550991c4289c0fdca4e316eb4ccac41ab2262c9db0b3cbf39fa050d172

data/README.md

@@ -44,6 +44,7 @@ What it Does
   * Multipart POST.
   * Reddit error wrapping.
   * Retries for common errors (e.g. Gateway Timeout).
+  * Request caching.
 
 What it Doesn't
 ---------------
@@ -119,6 +120,16 @@ so you can take it a step further and just do:
 client.get('/r/AskReddit').children
 ```
 
+### Caching
+
+Reddit recommends not request the same endpoint more than once every 30 seconds, and `Client` respects that.
+
+But this can be by passed by passing in a `nocache` parameter, useful if you're polling a frequently-updated endpoint, e.g.:
+
+```ruby
+client.get('/r/all/comments', nocache: true)
+```
+
 Recommended Reading
 -------------------
 

data/lib/reddit/base/basic_client.rb

@@ -38,8 +38,8 @@ module Reddit
           builder.request  :retry, max: @retries, interval: 2, exceptions: FaradayMiddleware::Reddit::RETRIABLE_ERRORS
           builder.response :follow_redirects
           builder.response :reddit_raise_error
-          builder.use      :reddit_rate_limit
           builder.use      :reddit_modhash
+          builder.use      :reddit_rate_limit
           builder.adapter  Faraday.default_adapter
         end
       end

data/lib/reddit/base/client.rb

@@ -9,17 +9,27 @@ module Reddit
         super(options)
 
         connection.builder.insert_before FaradayMiddleware::FollowRedirects, FaradayMiddleware::ParseJson
-        connection.builder.insert_before FaradayMiddleware::Reddit::RateLimit, FaradayMiddleware::Reddit::ForceJson
+        connection.builder.insert_before FaradayMiddleware::Reddit::Modhash, Faraday::ManualCache, expires_in: 30
+        connection.builder.insert_before Faraday::ManualCache, FaradayMiddleware::Reddit::ForceJson
       end
 
-      def get(*args, **options)
-        body = connection.get(*args, **options).body
-        Mash.new body
+      def get(url, **options)
+        nocache = options.delete(:nocache)
+
+        response = connection.get do |req|
+          req.url url
+          req.headers['x-faraday-manual-cache'] = 'NOCACHE' if nocache
+          req.params = options
+        end
+
+        Mash.new response.body
       end
 
-      def post(*args, **options)
-        body = connection.post(*args, **options).body
-        Mash.new body
+      def post(url, **options)
+        nocache = options.delete(:nocache)
+
+        response = connection.post(url, **options)
+        Mash.new response.body
       end
     end
   end

data/lib/reddit/base/version.rb

@@ -1,5 +1,5 @@
 module Reddit
   module Base
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

data/lib/reddit/base.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'faraday-manual-cache'
 require 'faraday_middleware'
 require 'faraday_middleware/reddit'
 require 'json'

data/reddit-base.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Reddit::Base::VERSION
   spec.authors       = ["Daniel O'Brien"]
   spec.email         = ["dan@dobs.org"]
+  spec.homepage      = "https://github.com/dobs/reddit-base"
   spec.summary       = %q{A minimal reddit API client for Ruby.}
   spec.description   = %q{A minimal reddit API client for Ruby that
     simplifies concerns such as authentication, rate limiting and extracting
@@ -24,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", '~> 0'
 
-  spec.add_dependency 'faraday_middleware-reddit', '0.4.0'
+  spec.add_dependency 'faraday-manual-cache', '~> 0.1.1'
+  spec.add_dependency 'faraday_middleware-reddit', '~> 0.4.0'
   spec.add_dependency 'hashie', '~> 2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reddit-base
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Daniel O'Brien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,18 +38,32 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-manual-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware-reddit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency