firebolt 0.9.0

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in firebolt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Hutchison
+
+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,58 @@
+# Firebolt
+
+Firebolt is a simple cache warmer. It warms the cache using a specially defined warmer class. It also has an optional file-based warmer.
+
+It's not quite ready for Prime Time™ and needs specs (YIKES!). Feel free add some, if you like...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'firebolt'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firebolt
+
+## Usage
+
+To use Firebolt, you first need to configure it:
+
+```Ruby
+::Firebolt.initialize! do |firebolt_config|
+  firebolt_config.cache = ::Rails.cache
+  firebolt_config.frequency = 12.hours
+  firebolt_config.warmer = ::YourAwesomeCacheWarmer
+end
+```
+
+Firebolt uses a cache warmer that you create. Valid cache warmers must:
+
+1. Include `Firebolt::Warmer`
+2. Define a `perform` method that returns a hash
+
+Here's an example:
+
+```Ruby
+class YourAwesomeCacheWarmer
+  include ::Firebolt::Warmer
+
+  def perform
+    # Returns a hash. The keys become the cache keys and the values become cache values.
+  end
+end
+```
+
+More documentation coming soon...
+
+## 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 @@
+require "bundler/gem_tasks"

data/firebolt.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'firebolt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "firebolt"
+  spec.version       = Firebolt::VERSION
+  spec.authors       = ["Adam Hutchison","BJ Neilsen"]
+  spec.email         = ["liveh2o@gmail.com","bj.neilsen@gmail.com"]
+  spec.description   = %q{Simple little cache warmer.}
+  spec.summary       = %q{Firebolt is a simple cache warmer. It warms the cache using a specially defined warmer class.}
+  spec.homepage      = "https://github.com/moneydesktop/firebolt"
+  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"]
+
+  ##
+  # Dependencies
+  #
+  spec.add_dependency "json"
+  spec.add_dependency "rufus-scheduler"
+  spec.add_dependency "sucker_punch"
+
+  ##
+  # Development Dependencies
+  #
+  spec.add_development_dependency "rake"
+end

data/lib/firebolt/cache.rb

@@ -0,0 +1,27 @@
+module Firebolt
+  module Cache
+    include ::Firebolt::Keys
+
+    def fetch(suffix, options = nil, &block)
+      salted_key = self.cache_key_with_salt(key_suffix, salt)
+      return nil if salted_key.nil?
+
+      ::Firebolt.config.cache.fetch(salted_key, options, &block)
+    end
+
+    def read(key_suffix, options = nil)
+      salted_key = self.cache_key_with_salt(key_suffix, salt)
+      return nil if salted_key.nil?
+
+      ::Firebolt.config.cache.read(salted_key, options)
+    end
+
+    def reset_salt!(new_salt)
+      ::Firebolt.config.cache.write(self.salt_key, new_salt)
+    end
+
+    def salt
+      ::Firebolt.config.cache.read(self.salt_key)
+    end
+  end
+end

data/lib/firebolt/cache_worker.rb

@@ -0,0 +1,30 @@
+module Firebolt
+  class CacheWorker
+    include ::SuckerPunch::Worker
+
+    def perform(warmer_class)
+      cache_warmer = warmer_class.new
+      results = cache_warmer.warm
+      return unless write_results_to_cache_file?
+
+      write_results_to_cache_file(results)
+    end
+
+  private
+
+    def cache_file
+      ::Firebolt.config.cache_file
+    end
+
+    def write_results_to_cache_file(results)
+      ::File.open(cache_file, 'w') do |file|
+        json_results = ::JSON.dump(results)
+        file.write(json_results)
+      end
+    end
+
+    def write_results_to_cache_file?
+      ::Firebolt.config.use_file_warmer?
+    end
+  end
+end

data/lib/firebolt/config.rb

@@ -0,0 +1,86 @@
+module Firebolt
+  class Config < Hash
+    CACHE_FILENAME = "firebolt.cache.json".freeze
+
+    ##
+    # Constructor!
+    #
+    def initialize(options = {})
+      merge!(options)
+
+      self[:cache_file_path] ||= '/tmp'
+      self[:namespace] ||= ::SecureRandom.hex
+    end
+
+    ##
+    # Class methods
+    #
+
+    # Creates an accessor that simply sets and reads a key in the hash:
+    #
+    #   class Config < Hash
+    #     hash_accessor :app
+    #   end
+    #
+    #   config = Config.new
+    #   config.app = Foo
+    #   config[:app] #=> Foo
+    #
+    #   config[:app] = Bar
+    #   config.app #=> Bar
+    #
+    def self.hash_accessor(*names) #:nodoc:
+      names.each do |name|
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{name}
+            self[:#{name}]
+          end
+
+          def #{name}=(value)
+            self[:#{name}] = value
+          end
+        METHOD
+      end
+    end
+
+    hash_accessor :cache, :cache_file_enabled, :cache_file_path, :namespace, :warmer, :warming_frequency
+
+    ##
+    # Public instance methods
+    #
+
+    def cache_file
+      ::File.join(self[:cache_file_path], CACHE_FILENAME)
+    end
+
+    def cache_file_enabled?
+      !! ::Firebolt.config.cache_file_enabled
+    end
+
+    def cache_file_path=(path)
+      raise ArgumentError, "Directory '#{path}' does not exist or is not writable." unless ::File.writable?(path)
+
+      self[:cache_file_enabled] = true
+      self[:cache_file_path] = path
+    end
+
+    def cache_file_readable?
+      ::File.readable?(cache_file)
+    end
+
+    def namespace
+      @namespace ||= "firebolt.#{self[:namespace]}"
+    end
+
+    def use_file_warmer?
+      cache_file_enabled? && cache_file_readable?
+    end
+
+    def warmer=(value)
+      raise ArgumentError, "Warmer must include the ::Firebolt::Warmer module." unless value.ancestors.include?(::Firebolt::Warmer)
+      raise ArgumentError, "Warmer must respond to `perform`." unless value.instance_methods.include?(:perform)
+
+      self[:warmer] = value
+    end
+  end
+end

data/lib/firebolt/file_warmer.rb

@@ -0,0 +1,34 @@
+module Firebolt
+  class FileWarmer
+    include ::Firebolt::Warmer
+
+    def perform
+      return nil unless cache_file_exists?
+
+      return parsed_contents
+    end
+
+  private
+
+    def cache_file
+      ::Firebolt.config.cache_file
+    end
+
+    def cache_file_exists?
+      ::File.exists?(cache_file)
+    end
+
+    def file_contents
+      ::File.open(cache_file) do |file|
+        file.read
+      end
+    end
+
+    def parsed_contents
+      ::JSON.parse(file_contents)
+    rescue => e
+      warn "Could not parse #{cache_file}, falling back to default warmer."
+      return nil
+    end
+  end
+end

data/lib/firebolt/keys.rb

@@ -0,0 +1,19 @@
+module Firebolt
+  module Keys
+    def cache_key(key_suffix)
+      "#{namespace}.#{key_suffix}"
+    end
+
+    def cache_key_with_salt(key_suffix, salt)
+      "#{namespace}.#{salt}.#{key_suffix}"
+    end
+
+    def namespace
+      ::Firebolt.config.namespace
+    end
+
+    def salt_key
+      cache_key(:salt)
+    end
+  end
+end

data/lib/firebolt/tasks/cache.rake

@@ -0,0 +1,36 @@
+require 'rake'
+require 'fileutils'
+
+namespace :firebolt do
+  namespace :cache do
+
+    desc 'Rebuild the cache by purging and re-warming'
+    task :rebuild do
+      ::Rake::Task['firebolt:cache:purge'].invoke
+      ::Rake::Task['firebolt:cache:warm'].invoke
+      puts 'Cache rebuilt'
+    end
+
+    desc 'Purge the cache and startup file'
+    task :purge do
+      pattern = ::Firebolt.cache_key_with_salt('*', ::Firebolt.salt)
+      puts "Purging keys matching pattern '#{pattern}'"
+      ::Firebolt.config.cache.delete_matched(pattern)
+
+      if ::Firebolt.config.cache_file_readable?
+        cache_file = ::Firebolt.config.cache_file
+        puts "Removing cache file at '#{cache_file}'"
+        ::FileUtils.rm(cache_file)
+      end
+    end
+
+    desc 'Warm the cache with a new salt'
+    task :warm do
+      ::Firebolt.initialize!
+      warmer = ::Firebolt.config.warmer
+      puts "Warming the cache with #{warmer}"
+      ::SuckerPunch::Queue[:firebolt_queue].perform(warmer)
+    end
+
+  end
+end

data/lib/firebolt/version.rb

@@ -0,0 +1,3 @@
+module Firebolt
+  VERSION = "0.9.0"
+end

data/lib/firebolt/warmer.rb

@@ -0,0 +1,51 @@
+module Firebolt
+  module Warmer
+    include ::Firebolt::Keys
+
+    ##
+    # Public instance methods
+    #
+    def warm
+      results = perform
+
+      _warmer_write_results_to_cache(results)
+      _warmer_reset_salt!
+
+      results
+    end
+
+  private
+
+    ##
+    # Private instance methods
+    #
+    def _warmer_expires_in
+      @_warmer_expires_in ||= ::Firebolt.config.frequency + 1.hour
+    end
+
+    def _warmer_raise_failed_result
+      raise "Warmer must return an object that responds to #each_pair."
+    end
+
+    def _warmer_reset_salt!
+      ::Firebolt.reset_salt!(_warmer_salt)
+    end
+
+    def _warmer_salt
+      @_warmer_salt ||= ::SecureRandom.hex
+    end
+
+    def _warmer_salted_cache_key(suffix)
+      cache_key_with_salt(suffix, _warmer_salt)
+    end
+
+    def _warmer_write_results_to_cache(results)
+      _warmer_raise_failed_result unless results.respond_to?(:each_pair)
+
+      results.each_pair do |key, value|
+        cache_key = _warmer_salted_cache_key(key)
+        ::Firebolt.config.cache.write(cache_key, value, :expires_in => _warmer_expires_in)
+      end
+    end
+  end
+end

data/lib/firebolt.rb

@@ -0,0 +1,87 @@
+require "json"
+require "securerandom"
+require "sucker_punch"
+require "rufus/scheduler"
+
+require "firebolt/keys"
+require "firebolt/cache"
+require "firebolt/cache_worker"
+require "firebolt/config"
+require "firebolt/warmer"
+require "firebolt/file_warmer"
+
+require "firebolt/version"
+
+module Firebolt
+  extend ::Firebolt::Cache
+
+  # Using a mutex to control access while creating a ::Firebolt::Config
+  @firebolt_mutex = ::Mutex.new
+
+  def self.config
+    return @config unless @config.nil?
+
+    @firebolt_mutex.synchronize do
+      @config = ::Firebolt::Config.new if @config.nil?
+    end
+
+    return @config
+  end
+
+  def self.configure
+    ::Thread.exclusive do
+      yield(config)
+    end
+  end
+
+  def self.configure_sucker_punch
+    ::SuckerPunch.config do
+      queue :name => :firebolt_queue, :worker => ::Firebolt::CacheWorker, :workers => 2
+    end
+  end
+
+  def self.initialize_rufus_scheduler
+    frequency = ::Rufus.to_time_string(config.warming_frequency)
+
+    ::Rufus::Scheduler.start_new.every(frequency) do
+      ::SuckerPunch::Queue[:firebolt_queue].async.perform(config.warmer)
+    end
+  end
+
+  def self.initialize!(&block)
+    return if initialized? || skip_warming?
+
+    configure(&block) if block_given?
+
+    raise "Firebolt.config.cache has not been set" unless config.cache
+    raise "Firebolt.config.warmer has not been set" unless config.warmer
+    raise "Firebolt.config.warming_frequency has not been set" unless config.warming_frequency
+
+    configure_sucker_punch
+    initialize_rufus_scheduler
+
+    # Initial warming
+    warmer = config.use_file_warmer? ? ::Firebolt::FileWarmer : config.warmer
+    ::SuckerPunch::Queue[:firebolt_queue].async.perform(warmer)
+
+    initialized!
+  end
+
+  def self.initialized!
+    return @initialized unless @initialized.nil?
+
+    @firebolt_mutex.synchronize do
+      @initialized = true if @initialized.nil?
+    end
+
+    return @initialized
+  end
+
+  def self.initialized?
+    !! @initialized
+  end
+
+  def self.skip_warming?
+    ENV['FIREBOLT_SKIP_WARMING'] || ENV['RAILS_ENV'] == 'test'
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: firebolt
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Hutchison
+- BJ Neilsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sucker_punch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple little cache warmer.
+email:
+- liveh2o@gmail.com
+- bj.neilsen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- firebolt.gemspec
+- lib/firebolt.rb
+- lib/firebolt/cache.rb
+- lib/firebolt/cache_worker.rb
+- lib/firebolt/config.rb
+- lib/firebolt/file_warmer.rb
+- lib/firebolt/keys.rb
+- lib/firebolt/tasks/cache.rake
+- lib/firebolt/version.rb
+- lib/firebolt/warmer.rb
+homepage: https://github.com/moneydesktop/firebolt
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3262743682020511243
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3262743682020511243
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Firebolt is a simple cache warmer. It warms the cache using a specially defined
+  warmer class.
+test_files: []