jsoncache 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 451ecce81c2292abf00ea4b993b08ac32236b592
-  data.tar.gz: 10f0b235b42b7b291db910eeee69d25f29687fc9
+  metadata.gz: 0b08ecd6e9c4902d08b774a84fd5eafc668fe297
+  data.tar.gz: 289211918f40306b69f94a26025b028802ca81d2
 SHA512:
-  metadata.gz: 9002060bd1ef998f9ffbb8ed10243d024ea9da6ca9407cbe10cdc3da3f966514a074a1b8cc0a91334c53c3a54275bf26a4c702e964a05078a0e3deed28423daa
-  data.tar.gz: e6814adf6f6d8fba88c676c6eaa6dcacf64a85690cad8f21db0154e319bcc7fbe9bb7db89fd3cd1066fa2e3d75d93bb12f26832bc4fdfb9b1df429edb1cce019
+  metadata.gz: 265fda72b840aac9515f4efaad4425b67b047ac0db604d5355d583741b9393efaf4eeeb506122a17227447db9a8c40ef644d180c03f6c4ed9b67aee8e200120a
+  data.tar.gz: c3908949c26d986c26842374a2b3bb64e60a8232cc9abd517d120044d0985ac09599befbb2662fe682630b3b3f327d585dac78839f1bc1c9648bd96059bf0c9e

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Derek Stride
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+# JSONCache [![Build Status](https://travis-ci.org/DerekStride/jsoncache.svg?branch=dynamic-caching-based-on-arguments)](https://travis-ci.org/DerekStride/jsoncache)
+
+A simple JSON Cache for use with HTTP APIs
+
+## Instructions
+
+```ruby
+require 'jsoncache'
+Class A
+  extend JSONCache
+
+  def expensive_method(args)
+    # code
+  end
+
+  cache :expensive_method, expiry: 300
+end
+```
+
+The cache method will the existing method and provide it with caching to the local filesystem. You can set a TTL (time to live) for the cache by setting the `expiry` value in seconds.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.fail_on_error = false
+end

data/lib/jsoncache.rb

@@ -1,159 +1,18 @@
-require 'json'
-require 'pp'
+require 'jsoncache/filecache'
 
 # JSONCache is a simple interface to cache JSON based API calls
 #
 # Author::    Derek Stride  (mailto:djgstride@gmail.com)
 # License::   MIT
-#
-# This module provides an easy to use class method +cache+ which caches json
-# in a key-value fashion to the filesystem in /tmp/jsoncache.
 module JSONCache
-  extend self
-
-  # Retrieves cached data for the specified key and caches the data provided
-  # if the cache isn't valid. Specify a code block after the method call that
-  # returns a hash and it will be cached.
-  #
-  # ==== Parameters
-  #
-  # +key+:: +String+ The key in which to check for cached data.
-  # +options+:: +Hash+ A hash of the parameters to use when caching.
-  #
-  # ==== Options
-  #
-  # Accepted options
-  #
-  # +:symbolize+:: +Boolean+ Symbolize keys while parsing JSON.
-  # +:cache_directory+:: +String+ The folder name in /tmp to use as the cache.
-  # +:expiry+:: +Fixnum+ The validity time of the cache in seconds.
-  #
-  # ==== Examples
-  #
-  #   def get_response(uri)
-  #     JSONCache.cache(uri_to_key(uri), expiry: 120) do
-  #       query_some_json_api(uri)
-  #     end
-  #   end
-  def cache(key, options = {})
-    options = defaults.merge(options)
-    return retrieve_cache(key, options) if cached?(key, options)
-    result = yield
-    cache_file(key, result, options)
-    result
-  end
-
-  private
-
-  ########################################################################
-  # Core Caching
-  ########################################################################
-
-  # Determine whether a file is cached and healthy
-  #
-  # ==== Parameters
-  #
-  # +key+:: +String+ The key in which to check for cached data.
-  # +options+:: +Hash+ A hash of the parameters to use when caching.
-  def cached?(key, options = {})
-    options = defaults.merge(options)
-    timestamp = timestamp_from_key(key, options[:cache_directory])
-    expiry = options[:expiry]
-    if timestamp.zero?
-      false
-    elsif expiry.zero?
-      true
-    else
-      (Time.now.to_i - timestamp) < expiry
+  def cache(method, options = {})
+    original = "__uncached_#{method}__"
+    ([Class, Module].include?(self.class) ? self : self.class).class_eval do
+      alias_method original, method
+      private original
+      define_method(method) do |*args|
+        JSONCache::FileCache.cache(*args, options) { send(original, *args) }
+      end
     end
   end
-
-  # Cache the result from the uri
-  #
-  # ==== Parameters
-  #
-  # +key+:: +String+ The key in which to check for cached data.
-  # +data+:: +Hash+ The data to cache.
-  # +options+:: +Hash+ A hash of the parameters to use when caching.
-  def cache_file(key, data, options = {})
-    options = defaults.merge(options)
-    begin
-      content = JSON.generate(data)
-    rescue
-      return
-    end
-
-    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",
-      content)
-  end
-
-  # Retrieves a cached value from a key
-  #
-  # ==== Parameters
-  #
-  # +key+:: +String+ The key in which to check for cached data.
-  # +options+:: +Hash+ A hash of the parameters to use when caching.
-  def retrieve_cache(key, options = {})
-    options = defaults.merge(options)
-    directory = options[:cache_directory]
-    filename = filename_from_key(key, directory)
-    return nil if filename.nil?
-    JSON.parse(
-      File.read("#{cache_dir(directory)}/#{filename}"),
-      symbolize_names: options[:symbolize])
-  end
-
-  ########################################################################
-  # Helpers
-  ########################################################################
-
-  # Create, if necessary, and return a cache directory
-  #
-  # ==== Parameters
-  #
-  # +directory+:: +String+ The name of the cache directory.
-  def cache_dir(directory)
-    directory ||= defaults[:cache_directory]
-    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
-  #
-  # ==== Parameters
-  #
-  # +key+:: +String+ The key in which to check for cached data.
-  # +directory+:: +String+ The name of the cache directory.
-  def filename_from_key(key, directory)
-    Dir.foreach(cache_dir(directory)) do |filename|
-      next unless filename.include?(key)
-      return filename
-    end
-  end
-
-  # Extracts a timestamp from an existing file
-  #
-  # ==== Parameters
-  #
-  # +key+:: +String+ The key in which to check for cached data.
-  # +directory+:: +String+ 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}/, '')
-      .chomp('.json')
-      .to_i
-  end
-
-  def defaults
-    { symbolize: false, cache_directory: 'jsoncache', expiry: 0 }
-  end
 end

data/lib/jsoncache/filecache.rb

@@ -0,0 +1,147 @@
+require 'json'
+require 'fileutils'
+
+module JSONCache
+  # This module provides an easy to use class method +cache+ which caches json
+  # in a key-value fashion to the filesystem in /tmp/jsoncache.
+  module FileCache
+    extend self
+
+    CACHE_DIR = '/tmp/jsoncache'.freeze
+
+    # Retrieves cached data for the specified key and caches the data provided
+    # if the cache isn't valid. Specify a code block after the method call that
+    # returns a hash and it will be cached.
+    #
+    # ==== Parameters
+    #
+    # +key+:: +String+ The key in which to check for cached data.
+    # +options+:: +Hash+ A hash of the parameters to use when caching.
+    #
+    # ==== Options
+    #
+    # Accepted options
+    #
+    # +:symbolize+:: +Boolean+ Symbolize keys while parsing JSON.
+    # +:cache_directory+:: +String+ The folder name in /tmp to use as the cache.
+    # +:expiry+:: +Fixnum+ The validity time of the cache in seconds.
+    #
+    # ==== Examples
+    #
+    #   def get_response(uri)
+    #     JSONCache.cache(uri_to_key(uri), expiry: 120) do
+    #       query_some_json_api(uri)
+    #     end
+    #   end
+    def cache(*key, expiry: 0)
+      normalized_key = normalize(key)
+      return retrieve_cache(normalized_key) if cached?(normalized_key, expiry)
+      result = yield
+      cache_file(normalized_key, result)
+      result
+    end
+
+    private
+
+    ########################################################################
+    # Core Caching
+    ########################################################################
+
+    # Determine whether a file is cached and healthy
+    #
+    # ==== Parameters
+    #
+    # +key+:: +String+ The key in which to check for cached data.
+    # +options+:: +Hash+ A hash of the parameters to use when caching.
+    def cached?(key, expiry)
+      timestamp = timestamp_from_key(key)
+      if timestamp.zero?
+        false
+      elsif expiry.zero?
+        true
+      else
+        (Time.now.to_i - timestamp) < expiry
+      end
+    end
+
+    # Cache the result from the uri
+    #
+    # ==== Parameters
+    #
+    # +key+:: +String+ The key in which to check for cached data.
+    # +data+:: +Hash+ The data to cache.
+    # +options+:: +Hash+ A hash of the parameters to use when caching.
+    def cache_file(key, data)
+      begin
+        content = JSON.generate(data)
+      rescue
+        return
+      end
+
+      existing_file = filename_from_key(key)
+      last_path = "#{cache_dir}/#{existing_file}"
+
+      File.delete(last_path) if existing_file && File.exist?(last_path)
+      File.write("#{cache_dir}/#{key}#{Time.now.to_i}.json", content)
+    end
+
+    # Retrieves a cached value from a key
+    #
+    # ==== Parameters
+    #
+    # +key+:: +String+ The key in which to check for cached data.
+    # +options+:: +Hash+ A hash of the parameters to use when caching.
+    def retrieve_cache(key)
+      filename = filename_from_key(key)
+      return nil if filename.nil?
+      JSON.parse(File.read("#{cache_dir}/#{filename}"), symbolize_names: true)
+    end
+
+    ########################################################################
+    # Helpers
+    ########################################################################
+
+    # Create, if necessary, and return a cache directory
+    #
+    # ==== Parameters
+    #
+    # +directory+:: +String+ The name of the cache directory.
+    def cache_dir
+      FileUtils.mkdir_p(CACHE_DIR) unless Dir.exist?(CACHE_DIR)
+      CACHE_DIR
+    end
+
+    # Gets an existing file from a uri if it exists
+    #
+    # ==== Parameters
+    #
+    # +key+:: +String+ The key in which to check for cached data.
+    # +directory+:: +String+ The name of the cache directory.
+    def filename_from_key(key)
+      key = 'jsoncache' if key.empty?
+      Dir.foreach(cache_dir) do |filename|
+        next unless filename.include?(key)
+        return filename
+      end
+    end
+
+    # Extracts a timestamp from an existing file
+    #
+    # ==== Parameters
+    #
+    # +key+:: +String+ The key in which to check for cached data.
+    # +directory+:: +String+ The name of the cache directory.
+    def timestamp_from_key(key)
+      path = filename_from_key(key)
+      return 0 if path.nil?
+      path.slice(/#{key}.*/)
+          .gsub(/^#{key}/, '')
+          .chomp('.json')
+          .to_i
+    end
+
+    def normalize(key)
+      key.to_s.delete('{}()[]<>."\'=+:\/?~`!@#$%^&*|;, ')
+    end
+  end
+end

data/spec/filecache_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'jsoncache'
+
+describe JSONCache::FileCache do
+  before :all do
+    @key = 'match1234567890'
+    @sample_data = { hello: 'world' }
+  end
+
+  describe '#cache' do
+    include FakeFS::SpecHelpers
+
+    context 'data not cached' do
+      it 'should yield control if there is no valid cache' do
+        expect { |b| JSONCache::FileCache.cache(@key, &b) }.to(
+          yield_control.once)
+      end
+      it 'should yield without args' do
+        expect { |b| JSONCache::FileCache.cache(@key, &b) }.not_to(
+          yield_with_args)
+      end
+      it 'should create a cache' do
+        expect(File.exist?(JSONCache::FileCache::CACHE_DIR)).to be false
+        JSONCache::FileCache.cache(@key) { @sample_data }
+        expect(File.exist?(JSONCache::FileCache::CACHE_DIR)).to be true
+      end
+    end
+
+    context 'data cached' do
+      before :each do
+        @cached_data = JSONCache::FileCache.cache(@key) { @sample_data }
+      end
+
+      it 'should not yield control' do
+        expect { |b| JSONCache::FileCache.cache(@key, &b) }.not_to yield_control
+      end
+      it 'should return the data from the block if no cache exists' do
+        expect(@cached_data).to eq @sample_data
+      end
+      it 'should return the old data if the cache is valid' do
+        new_data = { seeya: 'later' }
+        valid_cache_data = JSONCache::FileCache.cache(@key) { new_data }
+        expect(valid_cache_data).to eq @cached_data
+      end
+      it 'should return the new data if the cache is invalid' do
+        new_data = { seeya: 'later' }
+        invalid_cache_data = JSONCache::FileCache.cache(@key, expiry: -1) { new_data }
+        expect(invalid_cache_data).to eq new_data
+      end
+    end
+  end
+end

data/spec/jsoncache_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'pp'
+require_relative '../lib/jsoncache'
+
+# j
+class JSONCacheTest
+  extend JSONCache
+
+  def perform(json = nil)
+    json
+  end
+
+  def expired(json = nil)
+    json
+  end
+
+  cache :perform
+  cache :expired, expiry: -1
+end
+
+describe JSONCacheTest do
+  before :all do
+    @uut = JSONCacheTest.new
+    @sample_data = { hello: 'world' }
+  end
+
+  describe '#perform' do
+    include FakeFS::SpecHelpers
+
+    context 'data not cached' do
+      it 'should create a cache' do
+        expect(File.exist?(JSONCache::FileCache::CACHE_DIR)).to be false
+        @uut.perform
+        expect(File.exist?(JSONCache::FileCache::CACHE_DIR)).to be true
+      end
+      it 'should create a cache based on the arguments' do
+        expect(File.exist?(JSONCache::FileCache::CACHE_DIR)).to be false
+        @uut.perform(@sample_data)
+        expect(File.exist?(JSONCache::FileCache::CACHE_DIR)).to be true
+      end
+    end
+
+    context 'data cached' do
+      before :each do
+        @cached_data = @uut.perform(@sample_data)
+        @key = JSONCache::FileCache.send(:normalize, @sample_data)
+      end
+
+      it 'should read from the cache' do
+        expect(@uut.perform(@sample_data)).to eq @cached_data
+      end
+      it 'should return the old data if the cache is valid' do
+        expect(@uut.perform(@key)).to eq @cached_data
+      end
+      it 'should return the new data if the cache is invalid' do
+        expect(@uut.expired(@key)).not_to eq @cached_data
+        expect(@uut.expired(@key)).to eq @key
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'fakefs/spec_helpers'
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+    config.order = :random
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsoncache
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Derek Stride
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-05 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,7 +30,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- Rakefile
 - lib/jsoncache.rb
+- lib/jsoncache/filecache.rb
+- spec/filecache_spec.rb
+- spec/jsoncache_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/DerekStride/jsoncache
 licenses:
 - MIT
@@ -51,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Simple JSON Caching