jsoncache 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 884fbc12e55809b7a28d9040a5e55446f4e30d08
+  data.tar.gz: f44a53b6f0bad030520990390d4ff4d5558112c7
+SHA512:
+  metadata.gz: 630c6d62fcaea703832f6de4b2c6a1e5628b99988f006fc223d35ee9b31ef7c1f9c203b140ebe2eb11639c860921a859bba1dce24fde7fa91e37fa62c841416a
+  data.tar.gz: 29da69e11bab483818baccf20171f0e77915cdb8b17b14fff90274d00d2d8066f3004d85214b6da06fc37a6f1b4d7f04c4a9dc3d431511f0fc609cf67f090413

data/lib/jsoncache.rb

@@ -0,0 +1,75 @@
+require 'json'
+
+# JSONCache is a simple interface to cache JSON based API calls
+module JSONCache
+  attr_accessor :cache_directory
+
+  # 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)
+    if timestamp.zero?
+      false
+    elsif !delta.zero?
+      (Time.now.to_i - timestamp) < delta
+    else
+      true
+    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)
+    cache_path = cache_dir
+    existing_file = filename_from_uri(uri)
+    last_path = "#{cache_path}/#{existing_file}"
+    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))
+  end
+
+  def retrieve_cache(uri, params = {})
+    JSON.parse(
+      File.read("#{cache_dir}/#{filename_from_uri(uri)}"),
+      params)
+  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)
+    Dir.foreach(cache_dir) do |filename|
+      next unless filename.include?(root_path)
+      return filename
+    end
+  end
+
+  # Extracts a timestamp from an existing file
+  def timestamp_from_uri(uri)
+    path = filename_from_uri(uri)
+    return 0 if path.nil?
+    last_pattern = uri_to_file_path_root(uri)
+    path.slice(/#{last_pattern}.*/)
+      .gsub(/^#{last_pattern}/, '')
+      .chomp('.json')
+      .to_i
+  end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: jsoncache
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Derek Stride
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies: []
+description: A simple JSON cache for caching data intended for usewith HTTP APIs.
+email: djgstride@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jsoncache.rb
+homepage: http://rubygems.org/gems/jsoncache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Simple JSON Caching
+test_files: []