jsoncache 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ac4af13f9b13e89db67a6b9767e1fbfb3e9915a
-  data.tar.gz: d9ad825180586ebfc54fe89cd67adb497153cc75
+  metadata.gz: 0e485494df98519e1a66e6af9ed06704fe7aee85
+  data.tar.gz: fea11662810ce6e0b640a75fa90ea0728c1805b1
 SHA512:
-  metadata.gz: 5462932d8627ad9efce646253cd17d6121ad626228fd13933cd3f95a06b5c6ed2ab438d1f8d87d2e8eefa0c70e04cd5012599113057bee21e5ff6306a84d10aa
-  data.tar.gz: 040e9587050f419bd36c9f3adaf1494addbf98dd3a2d8ec25e664274a977cf4005a21d1e5e48319b64a0300ef3fe3dd6bfc3642a82e927701c09988ab633573c
+  metadata.gz: a5a63eec2084fef1a06d4237b75c2cf1e48aa27b5d62d570b461efd0024092d777fa63c644492c87e58cf7337ab8f738490f74de2157e66f73309142a9906242
+  data.tar.gz: 66dc29dfc029f62c6c8531ee12f0336c3bb98c1f2a8b6720d91f6291bb7c13346e27a632e2b94c2e53861eda3ee4c62fe1698b6c89067c2118ed7e94069b0cac

data/lib/jsoncache.rb

@@ -2,73 +2,85 @@ require 'json'
 
 # JSONCache is a simple interface to cache JSON based API calls
 module JSONCache
-  attr_accessor :cache_directory
+  attr_accessor :cache_directory, :symbolize_json
+
+  private
+
+  # 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)
+    result = yield
+    cache_file(key, result)
+    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
 
   # Determine whether a file is cached and healthy
-  # @param [String] uri the uri in which to check for a cached call.
-  # @param [boolean] stale whether or not a cached file can go stale.
-  # @param [Fixnum] delta the upperbound timestamp difference of a valid cache.
-  def cached?(uri, delta = 0)
-    timestamp = timestamp_from_uri(uri)
+  # @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)
     if timestamp.zero?
       false
-    elsif !delta.zero?
-      (Time.now.to_i - timestamp) < delta
-    else
+    elsif delta.zero?
       true
+    else
+      (Time.now.to_i - timestamp) < delta
     end
   end
 
   # Cache the result from the uri
-  # @param [Hash] response the response to cache.
-  # @param [String] uri the uri in which to check for a cached call.
-  def cache_file(response, 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_uri(uri)
+    existing_file = filename_from_key(key)
     last_path = "#{cache_path}/#{existing_file}"
+    return unless data.respond_to?(:to_h)
     File.delete(last_path) if existing_file && File.exist?(last_path)
     File.write(
-      "#{cache_path}/#{uri_to_file_path_root(uri)}#{Time.now.to_i}.json",
-      JSON.generate(response))
+      "#{cache_path}/#{key}#{Time.now.to_i}.json",
+      JSON.generate(data.to_h))
   end
 
-  def retrieve_cache(uri, params = {})
+  # 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)
+    return nil if filename.nil?
+    @symbolize_json = false if @symbolize_json.nil?
     JSON.parse(
-      File.read("#{cache_dir}/#{filename_from_uri(uri)}"),
-      params)
+      File.read("#{cache_dir}/#{filename}"),
+      symbolize_names: @symbolize_json)
   end
 
-  private
-
-  # Create, if necessary, and return a cache directory
-  def cache_dir
-    cache_path = File.join('/tmp', @cache_directory)
-    Dir.mkdir(cache_path) unless Dir.exist?(cache_path)
-    cache_path
-  end
-
-  # Converts uri to the base portion of the filename
-  # TODO requires overwrite
-  # def uri_to_file_path_root(uri)
-  #   uri.gsub(%r{[\.\/]|https:\/\/.*v\d\.\d|\?api=.*}, '')
-  # end
-
   # Gets an existing file from a uri if it exists
-  def filename_from_uri(uri)
-    root_path = uri_to_file_path_root(uri)
+  # @param [String] key The key in which to check for cached data.
+  def filename_from_key(key)
     Dir.foreach(cache_dir) do |filename|
-      next unless filename.include?(root_path)
+      next unless filename.include?(key)
       return filename
     end
   end
 
   # Extracts a timestamp from an existing file
-  def timestamp_from_uri(uri)
-    path = filename_from_uri(uri)
+  # @param [String] key The key in which to check for cached data.
+  def timestamp_from_key(key)
+    path = filename_from_key(key)
     return 0 if path.nil?
-    last_pattern = uri_to_file_path_root(uri)
-    path.slice(/#{last_pattern}.*/)
-      .gsub(/^#{last_pattern}/, '')
+    path.slice(/#{key}.*/)
+      .gsub(/^#{key}/, '')
       .chomp('.json')
       .to_i
   end

metadata

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