jsoncache 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e485494df98519e1a66e6af9ed06704fe7aee85
-  data.tar.gz: fea11662810ce6e0b640a75fa90ea0728c1805b1
+  metadata.gz: b8b7e2aa8007592f2c122d828b77bf832c495d93
+  data.tar.gz: e7edbb2504cb92aac6ac04dcf12802c71487f152
 SHA512:
-  metadata.gz: a5a63eec2084fef1a06d4237b75c2cf1e48aa27b5d62d570b461efd0024092d777fa63c644492c87e58cf7337ab8f738490f74de2157e66f73309142a9906242
-  data.tar.gz: 66dc29dfc029f62c6c8531ee12f0336c3bb98c1f2a8b6720d91f6291bb7c13346e27a632e2b94c2e53861eda3ee4c62fe1698b6c89067c2118ed7e94069b0cac
+  metadata.gz: 34ed662640fb70a27ee10b8cd42a2e938cb5a5626e1f4baf97fa9f637aab3b925645850da4a6ee7deb653f9cd9b60a14684644c65ba595c5ae77d67d9e79187d
+  data.tar.gz: 907ea8767eb4b034b087c9b8de095614c9c35167e103b21ca5c1a49c869d2752e41b62f5e3b4c33ef28c80d775ba2fef70ddf6b510e4e8da5114c9ca939bf9df

data/lib/jsoncache.rb

@@ -2,35 +2,35 @@ require 'json'
 
 # JSONCache is a simple interface to cache JSON based API calls
 module JSONCache
-  attr_accessor :cache_directory, :symbolize_json
-
-  private
+  extend self
 
   # Retrieves cached data for the specified key and caches the data provided
   # if the cache isn't valid.
-  # @param [String] key
-  # @param [Fixnum] delta The upperbound timestamp difference of a valid
-  #   cache, 0 if the result doesn't go stale.
-  def cache(key, delta = 0)
-    return retrieve_cache(key) if cached?(key, delta)
+  # @param [String] key The key in which to check for cached data.
+  # @param [Hash] options A hash of the parameters to use when caching.
+  # Accepted options parameters
+  # => [Boolean] symbolize
+  # => [String] cache_directory
+  # => [Fixnum] delta
+  def cache(key, options = {})
+    return retrieve_cache(key, options) if cached?(key, options)
     result = yield
-    cache_file(key, result)
+    cache_file(key, result, options)
     result
   end
 
-  # Create, if necessary, and return a cache directory
-  def cache_dir
-    cache_path = File.join('/tmp', @cache_directory || 'jsoncache')
-    Dir.mkdir(cache_path) unless Dir.exist?(cache_path)
-    cache_path
-  end
+  private
+
+  ########################################################################
+  # Core Caching
+  ########################################################################
 
   # Determine whether a file is cached and healthy
   # @param [String] key The key in which to check for cached data.
-  # @param [Fixnum] delta The upperbound timestamp difference of a valid
-  #   cache, 0 if the result doesn't go stale.
-  def cached?(key, delta = 0)
-    timestamp = timestamp_from_key(key)
+  # @param [Hash] options A hash of the parameters to use when caching.
+  def cached?(key, options = {})
+    timestamp = timestamp_from_key(key, options[:cache_directory])
+    delta = options[:delta] || 0
     if timestamp.zero?
       false
     elsif delta.zero?
@@ -43,11 +43,14 @@ module JSONCache
   # Cache the result from the uri
   # @param [String] key The key in which to check for cached data.
   # @param [Hash] data The response to cache.
-  def cache_file(key, data)
-    cache_path = cache_dir
-    existing_file = filename_from_key(key)
-    last_path = "#{cache_path}/#{existing_file}"
+  # @param [Hash] options A hash of the parameters to use when caching.
+  def cache_file(key, data, options = {})
     return unless data.respond_to?(:to_h)
+
+    cache_path = cache_dir(options[:cache_directory])
+    existing_file = filename_from_key(key, options[:cache_directory])
+    last_path = "#{cache_path}/#{existing_file}"
+
     File.delete(last_path) if existing_file && File.exist?(last_path)
     File.write(
       "#{cache_path}/#{key}#{Time.now.to_i}.json",
@@ -56,19 +59,36 @@ module JSONCache
 
   # Retrieves a cached value from a key
   # @param [String] key The key in which to check for cached data.
-  def retrieve_cache(key)
-    filename = filename_from_key(key)
+  # @param [Hash] options A hash of the parameters to use when caching.
+  def retrieve_cache(key, options = {})
+    directory = options[:cache_directory]
+    filename = filename_from_key(key, directory)
     return nil if filename.nil?
-    @symbolize_json = false if @symbolize_json.nil?
+    symbolize = options[:symbolize] || false
     JSON.parse(
-      File.read("#{cache_dir}/#{filename}"),
-      symbolize_names: @symbolize_json)
+      File.read("#{cache_dir(directory)}/#{filename}"),
+      symbolize_names: symbolize)
+  end
+
+  ########################################################################
+  # Helpers
+  ########################################################################
+
+  # Create, if necessary, and return a cache directory
+  # @param [String] directory The name of the cache directory.
+  def cache_dir(directory)
+    directory ||= 'jsoncache'
+    cache_path = File.join('/tmp', directory)
+    Dir.mkdir(cache_path) unless Dir.exist?(cache_path)
+    cache_path
   end
 
   # Gets an existing file from a uri if it exists
   # @param [String] key The key in which to check for cached data.
-  def filename_from_key(key)
-    Dir.foreach(cache_dir) do |filename|
+  # @param [String] directory The name of the cache directory.
+  def filename_from_key(key, directory)
+    directory ||= 'jsoncache'
+    Dir.foreach(cache_dir(directory)) do |filename|
       next unless filename.include?(key)
       return filename
     end
@@ -76,8 +96,9 @@ module JSONCache
 
   # Extracts a timestamp from an existing file
   # @param [String] key The key in which to check for cached data.
-  def timestamp_from_key(key)
-    path = filename_from_key(key)
+  # @param [String] directory The name of the cache directory.
+  def timestamp_from_key(key, directory)
+    path = filename_from_key(key, directory)
     return 0 if path.nil?
     path.slice(/#{key}.*/)
       .gsub(/^#{key}/, '')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsoncache
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Derek Stride