warming_drawer 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/.yardopts

@@ -0,0 +1,3 @@
+lib/**/*.rb
+-
+LICENSE

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Chris Ball and echobind, inc.
+
+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

@@ -1,4 +1,5 @@
 # WarmingDrawer
+[![Build Status](https://secure.travis-ci.org/echobind/warming_drawer.png?branch=master)](https://travis-ci.org/echobind/warming_drawer) [![Dependency Status](https://gemnasium.com/echobind/warming_drawer.png)](https://gemnasium.com/echobind/warming_drawer) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/echobind/warming_drawer)
 
 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.
 

data/lib/warming_drawer/configuration.rb

@@ -1,6 +1,6 @@
 module WarmingDrawer
   class Configuration
-    attr_accessor :queue_name, :retry, :queue_system, :basic_auth_username, :basic_auth_password
+    attr_accessor :queue_name, :retry, :queue_system, :basic_auth_username, :basic_auth_password, :preheat_url
 
     def initialize
       @queue_name = 'high'
@@ -12,13 +12,4 @@ module WarmingDrawer
     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

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

data/lib/warming_drawer.rb

@@ -5,12 +5,31 @@ require 'warming_drawer/workers/url_worker'
 
 module WarmingDrawer
 
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
   # Warms a cache. Delegates to the proper worker depending on the type.
+  # If being used within Rails, returns false unless action_controller caching is enabled.
   #
+  # @param [Array] Arguments or Array to warm
+  # @return [Boolean]
   # @example
   #   WarmingDrawer.warm('http://sweet.dev/1', 'http://sweet2.dev/2', :type => :url)
+  #   => true
   def self.warm(*args)
-    options = args.extract_options!
+    return false unless cachable?
+
+    if args.last.is_a?(Hash)
+      options = args.pop
+    else
+      options = {}
+    end
     options[:type] ||= :url
 
     if worker = available_worker_for_type(options[:type])
@@ -18,16 +37,31 @@ module WarmingDrawer
       worker.options queue: configuration.queue_name, retry: configuration.retry
       worker.perform_with(args)
     end
+
+    !worker.nil?
   end
 
+  # Returns true if a queuing system is defined
+  # @return [Boolean]
   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
+
+  private
+
+    def self.cachable?
+      (using_rails? && Rails.configuration.action_controller.perform_caching) || !using_rails?
+    end
+
+    def self.using_rails?
+      defined?(::Rails)
+    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
 
 end

data/spec/warming_drawer_spec.rb

@@ -7,15 +7,27 @@ describe WarmingDrawer do
 
   describe 'warm' do
 
-    it 'takes any number of items to warm' do
+    before do
       stub_request(:any, 'foo.com').to_return(:body => "good", :status => 200)
       stub_request(:any, 'yep.com').to_return(:body => "good", :status => 200)
+    end
+
+    it 'takes any number of items to warm' do
       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
+
+    it 'returns true if the warming request is queued' do
+      warmed = WarmingDrawer.warm 'http://foo.com'
+      warmed.must_equal true
+    end
+
+    it 'returns false if the warming request fails' do
+      warmed = WarmingDrawer.warm 'http://foo.com', :type => :fakeworker
+      warmed.must_equal false
+    end
   end
 
   describe 'use_queue?' do

data/warming_drawer.gemspec

@@ -10,16 +10,18 @@ Gem::Specification.new do |gem|
   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.homepage      = "http://github.com/echobind/warming_drawer"
 
   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.require_paths = ["lib", "spec"]
 
   gem.add_dependency 'sidekiq'
   gem.add_dependency 'httpclient'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'webmock'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: warming_drawer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -91,6 +91,38 @@ dependencies:
     - - ! '>='
       - !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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
@@ -99,8 +131,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- .yardopts
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/warming_drawer.rb
@@ -112,12 +146,13 @@ files:
 - spec/url_worker_spec.rb
 - spec/warming_drawer_spec.rb
 - warming_drawer.gemspec
-homepage: ''
+homepage: http://github.com/echobind/warming_drawer
 licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
+- spec
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/LICENSE.txt

@@ -1,22 +0,0 @@
-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.