warming_drawer 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Ball
+
+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,29 @@
+# WarmingDrawer
+
+Warms caches based on a specified url using an optional background queueing system. For now, only supports Sidekiq or the lack of a queing system, but in the future will support others.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'warming_drawer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install warming_drawer
+
+## 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,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => [ :test ]
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib' << 'spec'
+  t.test_files = FileList['spec/*_spec.rb', 'spec/helper.rb']
+  t.verbose = true
+end

data/lib/warming_drawer/configuration.rb

@@ -0,0 +1,24 @@
+module WarmingDrawer
+  class Configuration
+    attr_accessor :queue_name, :retry, :queue_system, :basic_auth_username, :basic_auth_password
+
+    def initialize
+      @queue_name = 'high'
+      @retry      = false
+      # TODO: would be nice to have values:
+      #   :inline, :sidekiq, :resque, :delayed_job
+      #   use Rails queue if defined
+      @queue_system = :inline
+    end
+
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/lib/warming_drawer/version.rb

@@ -0,0 +1,3 @@
+module WarmingDrawer
+  VERSION = "0.0.1"
+end

data/lib/warming_drawer/workers/base_worker.rb

@@ -0,0 +1,39 @@
+module WarmingDrawer
+  module Workers
+    class BaseWorker
+
+      class << self
+
+        # Sets up perform with or without queue
+        def perform_with(*args)
+          if WarmingDrawer.use_queue?
+            perform_with_queue(args)
+          else
+            perform_without_queue(args)
+          end
+        end
+
+        def options(options_hash)
+          # TODO: change this based on queuing system
+          sidekiq_options options_hash
+        end
+
+        def perform_with_queue(*args)
+          # TODO: change this based on queuing system
+          perform_async(args)
+        end
+
+        def perform_without_queue(*args)
+          new.perform(args)
+        end
+
+      end
+
+      # Does the actual work
+      def perform(*args)
+        raise 'Override perform in your worker'
+      end
+
+    end
+  end
+end

data/lib/warming_drawer/workers/url_worker.rb

@@ -0,0 +1,22 @@
+module WarmingDrawer
+  module Workers
+    class UrlWorker < BaseWorker
+      require 'httpclient'
+      require 'sidekiq'
+
+      # for now since we assume Sidekiq, just add that in.
+      include Sidekiq::Worker
+
+      def perform(*urls)
+        config = WarmingDrawer.configuration
+        auth_present = config.basic_auth_username && config.basic_auth_password
+
+        http = HTTPClient.new
+        http.set_auth(nil, config.basic_auth_username, config.basic_auth_password)
+
+        urls.flatten.each { |url| http.get url }
+      end
+
+    end
+  end
+end

data/lib/warming_drawer.rb

@@ -0,0 +1,33 @@
+require 'warming_drawer/configuration'
+require 'warming_drawer/version'
+require 'warming_drawer/workers/base_worker'
+require 'warming_drawer/workers/url_worker'
+
+module WarmingDrawer
+
+  # Warms a cache. Delegates to the proper worker depending on the type.
+  #
+  # @example
+  #   WarmingDrawer.warm('http://sweet.dev/1', 'http://sweet2.dev/2', :type => :url)
+  def self.warm(*args)
+    options = args.extract_options!
+    options[:type] ||= :url
+
+    if worker = available_worker_for_type(options[:type])
+      # TODO: can this move into worker since its reading config?
+      worker.options queue: configuration.queue_name, retry: configuration.retry
+      worker.perform_with(args)
+    end
+  end
+
+  def self.use_queue?
+    configuration.queue_system != :inline
+  end
+
+  def self.available_worker_for_type(type)
+    if worker_name = Workers.constants.detect {|c| c.downcase.match /^#{type.to_s.downcase}/}
+      WarmingDrawer::Workers.const_get worker_name.to_s
+    end
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,3 @@
+begin; require 'simplecov'; rescue LoadError; end
+begin; require 'turn/autorun'; rescue LoadError; end
+require 'webmock/minitest'

data/spec/url_worker_spec.rb

@@ -0,0 +1,28 @@
+require 'helper'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'warming_drawer'
+
+describe WarmingDrawer::Workers::UrlWorker do
+
+  describe 'with Sidekiq as a queuing system' do
+    before do
+      WarmingDrawer.configure do |config|
+        config.queue_system = :sidekiq
+      end
+    end
+
+    it 'queues up http calls'
+  end
+
+  describe 'without a queuing system' do
+    before do
+      WarmingDrawer.configure do |config|
+        config.queue_system = :sidekiq
+      end
+    end
+
+    it 'makes the http calls directly'
+  end
+
+end

data/spec/warming_drawer_spec.rb

@@ -0,0 +1,41 @@
+require 'helper'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'warming_drawer'
+
+describe WarmingDrawer do
+
+  describe 'warm' do
+
+    it 'takes any number of items to warm' do
+      stub_request(:any, 'foo.com').to_return(:body => "good", :status => 200)
+      stub_request(:any, 'yep.com').to_return(:body => "good", :status => 200)
+      lambda {
+        WarmingDrawer.warm 'http://foo.com'
+        WarmingDrawer.warm 'http://foo.com', 'http://yep.com'
+        WarmingDrawer.warm 'http://foo.com', :something => :else
+      }.must_be_silent
+    end
+  end
+
+  describe 'use_queue?' do
+    it 'uses a queue if the queue_system is not inline' do
+      WarmingDrawer.configure { |c| c.queue_system = :sidekiq }
+      WarmingDrawer.use_queue?.must_equal true
+    end
+
+    it 'doesnt use a queue if the queue system is inline' do
+      WarmingDrawer.configure { |c| c.queue_system = :inline }
+      WarmingDrawer.use_queue?.must_equal false
+    end
+  end
+
+  describe 'available_worker_for_type' do
+    it 'returns a worker based on a type' do
+      worker = WarmingDrawer.available_worker_for_type(:url)
+      worker.must_be_kind_of Class
+      worker.new.must_be_instance_of WarmingDrawer::Workers::UrlWorker
+    end
+  end
+
+end

data/warming_drawer.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'warming_drawer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "warming_drawer"
+  gem.version       = WarmingDrawer::VERSION
+  gem.authors       = ["Chris Ball"]
+  gem.email         = ["chris@echobind.com"]
+  gem.description   = %q{Adds a generic worker that hits url's to prewarm caches}
+  gem.summary       = %q{Adds a generic worker that hits url's to prewarm caches}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'sidekiq'
+  gem.add_dependency 'httpclient'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: warming_drawer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Ball
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: httpclient
+  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: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Adds a generic worker that hits url's to prewarm caches
+email:
+- chris@echobind.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/warming_drawer.rb
+- lib/warming_drawer/configuration.rb
+- lib/warming_drawer/version.rb
+- lib/warming_drawer/workers/base_worker.rb
+- lib/warming_drawer/workers/url_worker.rb
+- spec/helper.rb
+- spec/url_worker_spec.rb
+- spec/warming_drawer_spec.rb
+- warming_drawer.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Adds a generic worker that hits url's to prewarm caches
+test_files:
+- spec/helper.rb
+- spec/url_worker_spec.rb
+- spec/warming_drawer_spec.rb
+has_rdoc: