heuristic_cache 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2NlNjM4YjhkNWJjZDA2YzJiYjllOGRlM2JkMWIwMDUzNTAwMmIwZQ==
+  data.tar.gz: !binary |-
+    ODZlNzE5Yzg3NjcwMTg5MGE4NWM0Y2M5NWYzZGM0NmViNDRmOWU1Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzhiYTJjOTA5ODU4NDdjODY0OWUwZjgwNzlkMGYxY2Q1MmZmOGZmNGY3Yjg5
+    ODFhZDA2NjgzNjM0YjUwNDBjZDM0NzkyZjMwNzU3OTllZWMxZjU4NWY0Y2Ni
+    NzYwYTc0M2VkYzJhMDY0NzIzNzNjYTJlYzFmOTg0YWE5MTgwNjE=
+  data.tar.gz: !binary |-
+    NzBmNDE2YWI2NTA1OWQzNTQwZDRhYzgyMzU2MWU1NjdjNmJlMzU0MjQzMjUx
+    ZjQ4ZGVjMDU3ZWUxNmIxMzVkOTg1OTUzMTc0OWQyNWNjY2RlYzI2YzQ5ZWUx
+    MjM1NDE0ODdiYTE3NzQ4MzMwZTgwMWM5ZWVhYTM1OTZjOTBkZGY=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format progress
+

data/.ruby-gemset

@@ -0,0 +1 @@
+heuristic_cache

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p392

data/.travis.yml

@@ -0,0 +1,12 @@
+bundler_args: --without development
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - rbx-19mode
+  - jruby
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head 
+

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development do
+  gem 'debugger', :require => false
+end
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'mocha', '= 0.13.3', :require => false
+  gem 'timecop'
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Wilson Souza, Luiz Rocha
+
+MIT License
+
+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,31 @@
+# Heuristic Cache
+
+[![Build Status](https://travis-ci.org/abril/heuristic-cache.png?branch=master)](https://travis-ci.org/abril/heuristic-cache)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'heuristic_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heuristic_cache
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/config/heuristic_cache_test.yml

@@ -0,0 +1,30 @@
+commom: &commom
+  cache_config:
+    coefficient:
+      materia:
+        show: 0.02
+      lista_editorial: 
+        show: 0.02
+      galeria_multimidia: 
+        show: 0.02
+    time_to_live:
+      maximum: 3600
+      minimum: 60
+      default: 60
+    cacheable_statuses:
+      - disponivel
+
+development:
+  <<: *commom
+dev:
+  <<: *commom
+test: 
+  <<: *commom
+qa:
+  <<: *commom
+qalegado:
+  <<: *commom
+stage:
+  <<: *commom
+production:
+  <<: *commom

data/heuristic_cache.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heuristic_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'heuristic_cache'
+  spec.version       = AlxHeuristicCache::VERSION.to_s
+  spec.authors       = ['Wilson Souza', 'Luiz Rocha']
+  spec.email         = ['willroberto@gmail.com', 'lsdrocha@gmail.com']
+  spec.summary       = 'Heuristic TTL for HTTP-Cache Headers'
+  spec.homepage      = 'https://github.com/abril/heuristic-cache'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'step-up', '0.8.2'
+end
+

data/lib/commons/yml.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+
+module Commons
+
+  require "yaml"
+  
+  class Yml < Hash
+    
+    attr_accessor :from
+    
+    def initialize(from)
+      self.from = from
+    end
+    
+    def self.read(file)
+
+      raise ArgumentError, 'Param file é required' if file == nil
+
+      yaml_file = file.end_with?(".yml") ? file : "#{file}.yml"
+      begin
+        yaml_configs = YAML::load_file(yaml_file)
+        return self.prepare_configs(yaml_configs, yaml_file, true)
+      rescue Exception => e
+        message = "Error when reading yml file: #{e.message}"        
+        STDOUT.puts(message)
+        raise e
+      end
+    end
+    
+    def [](key)
+      prepare_value(super(key), key)
+    end
+    
+    def fetch(*args)
+      begin
+        return prepare_value(super(*args), args.first)
+      rescue IndexError => e
+        message = "Missing attribute '#{args.first}' in #{self.from}"
+        STDOUT.puts(message)
+        raise RuntimeError.new(message)
+      end
+    end
+
+    def self.prepare_configs(configs, file, symbolize_keys = false)
+      if configs.is_a?(Hash) 
+        configs.symbolize_keys! if symbolize_keys && configs.respond_to?(:symbolize_keys!)
+        configs = Yml.new(file).merge(configs)
+      end
+      configs
+    end
+    
+    private
+    def prepare_value(value, from_key)
+      value.is_a?(Hash) ? Yml.new("'#{from_key}:#{self.from}'").merge(value) : value
+    end
+    
+  end
+
+end

data/lib/heuristic_cache/cache_helper.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require File.expand_path("heuristic_cache", File.dirname(__FILE__)) unless defined?(::HeuristicCache)
+
+module AlxHeuristicCache
+
+  module Helpers
+
+    def cacheable?(object)
+      ::HeuristicCache.cacheable?(object)
+    end
+
+    def ttl_for(object, action)
+      ::HeuristicCache::TTL.for(object, action)
+    end
+
+  end
+
+end

data/lib/heuristic_cache/heuristic_cache.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+
+module HeuristicCache
+  CACHEABLE_STATUSES  = Array.new
+
+  def self.init(file, env = 'development')
+
+    raise ArgumentError, 'Param env is required' if env == nil
+
+    raise ArgumentError, 'Param file (path config file) is required' if file == nil
+
+    raise ArgumentError, 'Param file (path config file) is invalid' unless File.exists?(file)
+
+    config = ::Commons::Yml.read(file)[env.to_s]['cache_config']
+
+    STDOUT.puts 'WARNING: attr time_to_live is required' if config["time_to_live"] == nil
+    TTL.init(config["time_to_live"])
+
+    STDOUT.puts 'WARNING: attr coefficient is required' if config["coefficient"] == nil
+    Coefficient.init(config["coefficient"])
+
+    CACHEABLE_STATUSES.concat(config["cacheable_statuses"])
+
+    nil
+
+  end
+
+  def self.cacheable?(object)
+    CACHEABLE_STATUSES.empty? ? true : object.respond_to?(:status) && CACHEABLE_STATUSES.include?(object.status)
+  end
+  
+  class TTL
+
+    def self.init(yml)
+      @ttls = yml
+    end
+
+    def self.maximum
+      @ttls["maximum"]
+    end
+
+    def self.greater_than_maximum?(value)
+      value > self.maximum
+    end
+
+    def self.minimum
+      @ttls["minimum"]
+    end
+
+    def self.lower_than_minimum?(value)
+      value < self.minimum
+    end
+
+    def self.default
+      @ttls["default"]
+    end
+   
+    def self.for(object, action)
+      return TTL.default unless object.respond_to?(:updated_at) && !object.updated_at.nil?
+
+      difference    = Time.now.to_i - object.updated_at.to_i
+      coefficient   = Coefficient.for(object.class.to_s.downcase, action)
+      heuristic_ttl = (difference * coefficient).to_i
+      
+      return TTL.minimum if TTL.lower_than_minimum?(heuristic_ttl)
+      return TTL.maximum if TTL.greater_than_maximum?(heuristic_ttl)
+
+      heuristic_ttl
+    end
+
+  end
+
+  class Coefficient
+    def self.init(yml)
+      @coefficients = yml
+    end
+    def self.for(model, action)
+      @coefficients[model][action.to_s]
+    end
+  end
+
+end

data/lib/heuristic_cache/version.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+module AlxHeuristicCache
+
+  VERSION = '0.0.1'
+
+end

data/lib/heuristic_cache.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+require "heuristic_cache/version"
+require "heuristic_cache/heuristic_cache"
+require "heuristic_cache/cache_helper"
+require "commons/yml"

data/spec/lib/alx_heuristic_cache/cache_helper_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe "AlxHeuristicCache::Helpers" do
+
+  context "When call any helper" do
+
+    it "should call class HeuristicCache.cacheable?" do 
+      ::HeuristicCache.expects(:cacheable?).returns(true)
+      TestAlxHeuristicCache.new.cacheable?("teste")
+    end
+
+    it "should call class HeuristicCache::TTL.for" do 
+      ::HeuristicCache::TTL.expects(:for).returns(1)
+      TestAlxHeuristicCache.new.ttl_for("teste", "new")
+    end
+
+  end
+
+end
+
+class TestAlxHeuristicCache
+  include AlxHeuristicCache::Helpers
+end

data/spec/lib/alx_heuristic_cache/heuristic_cache_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe ::HeuristicCache do
+  context "cacheable? method" do
+
+    it "should return false for a nil parameter" do
+      ::HeuristicCache.cacheable?(nil).should == false
+    end
+
+    it "should return false for a object without status method" do
+      ::HeuristicCache.cacheable?("").should == false
+    end
+
+    it "should return false for a object with rascunho status" do
+      ::HeuristicCache.cacheable?(HeuristicCacheObj.new(:status => "rascunho")).should == false
+    end
+
+    it "should return false for a object with agendado status" do
+      ::HeuristicCache.cacheable?(HeuristicCacheObj.new(:status => "agendado")).should == false
+    end
+
+    it "should return true for a object with disponivel status" do
+      ::HeuristicCache.cacheable?(HeuristicCacheObj.new(:status => "disponivel")).should == true
+    end
+
+  end
+
+end

data/spec/lib/alx_heuristic_cache/heuristic_cache_ttl_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require "spec_helper"
+require 'timecop'
+
+describe ::HeuristicCache::TTL do
+
+  context "for method" do
+
+    before(:each) do
+      Timecop.travel(Time.local(2013, 1, 1, 15, 0, 0))
+      Timecop.freeze(Time.local(2013, 1, 1, 15, 0, 0))
+
+      ::HeuristicCache::Coefficient.stubs(:for).returns(0.1)
+      ::HeuristicCache::TTL.stubs(:minimum).returns(60)
+      ::HeuristicCache::TTL.stubs(:maximum).returns(86400)
+    end
+
+    after(:all) do
+      Timecop.return
+      
+      ::HeuristicCache::Coefficient.unstub(:for)
+      ::HeuristicCache::TTL.unstub(:minimum)
+      ::HeuristicCache::TTL.unstub(:maximum)
+    end
+    
+    it "should return the default_ttl for nil instances" do
+      ::HeuristicCache::TTL.for(nil, :show).should == ::HeuristicCache::TTL.default
+    end
+
+    it "should return the default_ttl for objects that doesn't respond to updated_at" do
+      ::HeuristicCache::TTL.for("", :show).should == ::HeuristicCache::TTL.default
+    end
+
+    it "should return the default_ttl for objects with null updated_at" do
+      materia = HeuristicCacheObj.new(:updated_at => nil)
+      ::HeuristicCache::TTL.for(materia, :show).should == ::HeuristicCache::TTL.default
+    end
+
+    it "should return a calculated ttl for objects with updated_at" do
+      materia = HeuristicCacheObj.new(:updated_at => Time.parse("2013-01-01 10:00:00"))
+      ::HeuristicCache::TTL.for(materia, :show).should == 1800 # 30 minutos
+    end
+
+    it "should return ::HeuristicCache::TTL.maximum of ttl for objects with old updated_at" do
+      materia = HeuristicCacheObj.new(:updated_at => Time.parse("2000-01-01 10:00:00"))
+      ::HeuristicCache::TTL.for(materia, :show).should == ::HeuristicCache::TTL.maximum
+    end
+
+    it "should return ::HeuristicCache::TTL.minimum of ttl for objects with very new updated_at" do
+      materia = HeuristicCacheObj .new(:updated_at => Time.parse("2013-01-01 15:01:00"))
+      ::HeuristicCache::TTL.for(materia, :show).should == ::HeuristicCache::TTL.minimum
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+gem_root = File.expand_path("../../lib")
+$:.unshift gem_root unless $:.include? gem_root
+
+STDOUT.puts Dir[File.expand_path("../../lib/**/*.rb", __FILE__)]
+
+Dir[File.expand_path("../../lib/**/*.rb", __FILE__)].each {|f| require f }
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f }
+
+::HeuristicCache.init(File.join(File.dirname(__FILE__), "..", "config", "heuristic_cache_test.yml"), 'test')
+

data/spec/support/heuristc_cache_obj.rb

@@ -0,0 +1,7 @@
+class HeuristicCacheObj
+  attr_accessor :status, :updated_at
+  def initialize(hash)
+    @status = hash[:status]
+    @updated_at = hash[:updated_at]
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: heuristic_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wilson Souza
+- Luiz Rocha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: step-up
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: 
+email:
+- willroberto@gmail.com
+- lsdrocha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- config/heuristic_cache_test.yml
+- heuristic_cache.gemspec
+- lib/commons/yml.rb
+- lib/heuristic_cache.rb
+- lib/heuristic_cache/cache_helper.rb
+- lib/heuristic_cache/heuristic_cache.rb
+- lib/heuristic_cache/version.rb
+- spec/lib/alx_heuristic_cache/cache_helper_spec.rb
+- spec/lib/alx_heuristic_cache/heuristic_cache_spec.rb
+- spec/lib/alx_heuristic_cache/heuristic_cache_ttl_spec.rb
+- spec/spec_helper.rb
+- spec/support/heuristc_cache_obj.rb
+homepage: https://github.com/abril/heuristic-cache
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Heuristic TTL for HTTP-Cache Headers
+test_files:
+- spec/lib/alx_heuristic_cache/cache_helper_spec.rb
+- spec/lib/alx_heuristic_cache/heuristic_cache_spec.rb
+- spec/lib/alx_heuristic_cache/heuristic_cache_ttl_spec.rb
+- spec/spec_helper.rb
+- spec/support/heuristc_cache_obj.rb