lib/lol/request.rb in ruby-lol-0.9.10 vs lib/lol/request.rb in ruby-lol-0.9.11

@@ -1,8 +1,9 @@
 module Lol
   class InvalidAPIResponse < StandardError; end
   class NotFound < StandardError; end
+  class InvalidCacheStore < StandardError; end
 
   # Encapsulates common methods for all requests
   # Request classes inherit from this
   class Request
     include HTTParty
@@ -14,10 +15,13 @@
 
     # @!attribute [rw] region
     # @return [String] region
     attr_accessor :region
 
+    # @!attribute[r] cache_store
+    # @return [Object] the cache_store
+    attr_reader :cache_store
 
     # Stub method. Each subclass should have its own api version
     # @return [String] api version
     def self.api_version
       "v1.1"
@@ -33,19 +37,52 @@
 
     # Calls the API via HTTParty and handles errors
     # @param url [String] the url to call
     # @return [String] raw response of the call
     def perform_request url
+      if cached? && result = store.get(url)
+        return result
+      end
+
       response = self.class.get(url)
       raise NotFound.new("404 Not Found") if response.respond_to?(:code) && response.not_found?
       raise InvalidAPIResponse.new(response["status"]["message"]) if response.is_a?(Hash) && response["status"]
 
+      if cached?
+        store.set url, response
+        store.expire url, ttl
+      end
+
       response
     end
 
-    def initialize api_key, region
+    # @return [Redis] returns the cache store
+    def store
+      cache_store[:redis]
+    end
+
+    # @return [Boolean] true if the request should be cached
+    def cached?
+      cache_store[:cached]
+    end
+
+    # @return [Fixnum] the ttl to apply to cached keys
+    def ttl
+      cache_store[:ttl]
+    end
+
+    # Initializes a new Request
+    # @param api_key [String] the Riot Games API key
+    # @param region [String] the region you want to use in API calls
+    # @param cache_store [Hash]
+    # @option cache_store [Redis] :redis Redis instance to use
+    # @option cache_store [Boolean] :cached should the request be cached
+    # @option cacche_store [Fixnum] :ttl ttl for cache keys
+    # @return [Request]
+    def initialize api_key, region, cache_store = {}
+      @cache_store = cache_store
+      raise InvalidCacheStore if cached? && !store.is_a?(Redis)
       @api_key = api_key
       @region = region
     end
-
   end
 end