swagger 1.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test.db

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 mdeiters
+
+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.rdoc

@@ -0,0 +1,45 @@
+= swagger = (Resque - Redis) + ActiveRecord
+ 
+ Swagger allows you to use Resque full featured by only adding one table in your existing database.
+ 
+ Resque is a great library for creating/running/administering background jobs. Redis is great too but may be overkill for just a few simple background jobs. Swagger marries the power and robustness of Resque with the trivial setup of delayed_job. 
+
+ 
+== Getting Started
+
+  1. Add resque and swagger to your gem dependencies (order is important)
+
+    config.gem 'resque'
+    config.gem 'swagger'
+
+  2. In your rails app, create the file initializers/resque.rb with the following:
+
+    Resque.swagger! 
+    Resque.connect_to_database YAML::load(ERB.new(IO.read(File.join(File.dirname(__FILE__), '..', 'database.yml'))).result)[RAILS_ENV]
+    
+  3. Create an active record migration
+  
+    create_table :resque_values do |table|
+      table.column :key,      :string
+      table.column :key_type, :string
+      table.column :value, :text
+    end
+  
+    add_index :resque_values, :key
+    add_index :resque_values, [:key, :key_type]
+
+  NOTE: To start up the administration sinatra app with swagger, do the following: resque-web config/initializers/resque.rb
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Matthew Deiters. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "swagger"
+    gem.summary = %Q{Everything Resque provides minus Redis}
+    gem.description = %Q{Duck punch Resque to use active record for backround jobs instead of redis}
+    gem.email = "mdeiters@gmail.com"
+    gem.homepage = "http://github.com/mdeiters/swagger"
+    gem.authors = ["mdeiters"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency "activerecord" #, "2.3.8"
+    gem.add_dependency "resque", "1.9.7"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "swagger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.1

data/lib/redis_impersonator.rb

@@ -0,0 +1,113 @@
+class RedisImpersonator
+  SET  = 'set'
+  LIST = 'list'
+  
+  def self.swallow(method, return_value = nil)
+    define_method(method) do |*args|
+      LOGGER.write("RedisImpersonator: Swallowed #{method} with the following arguments #{args.inspect}") if defined?(LOGGER)
+      return_value
+    end
+  end
+  swallow(:namespace=)
+  swallow(:namespace, 'not applicable')
+  swallow(:server, 'ActiveRecord')
+  swallow(:info,   self.inspect)
+    
+  def srem(set_name, value)
+    ResqueValue.delete_all(:key => set_name.to_s, :key_type => SET, :value => value.to_s)
+    nil
+  end
+  
+  def smembers(set_name)
+    ResqueValue.all(:conditions => {:key => set_name.to_s, :key_type => SET}).map(&:value)
+  end
+
+  def sismember(set_name, value)
+    ResqueValue.exists?(:key => set_name.to_s, :key_type => SET, :value => value.to_s)
+  end
+  
+  def sadd(set_name, value)
+    sismember(set_name, value) || ResqueValue.create!(:key => set_name.to_s, :key_type => SET, :value => value.to_s)
+  end
+  
+  def set(key, value)
+    resque_value = ResqueValue.find_or_initialize_by_key(key.to_s)
+    resque_value.value = value
+    resque_value.save!
+    value
+  end
+
+  def get(key)
+    resque_value = ResqueValue.first(:conditions => {:key => key})
+    resque_value.value if resque_value
+  end
+  
+  def del(key)
+    ResqueValue.delete_all(:key => key.to_s)
+    nil
+  end
+  
+  def exists(key)
+    ResqueValue.exists?(:key => key.to_s)
+  end
+  
+  def incrby(key, value)
+    object = ResqueValue.find_or_initialize_by_key(key.to_s)
+    object.value = (object.value.to_i + value.to_i).to_s
+    object.save!
+    object.value    
+  end
+  
+  def decrby(key, value)
+    object = ResqueValue.find_or_initialize_by_key(key.to_s)
+    object.value = (object.value.to_i - value.to_i).to_s
+    object.save!
+    object.value
+  end
+    
+  def mapped_mget(*keys)
+    Hash[*keys.zip(mget(*keys)).flatten]
+  end
+  
+  def mget(*keys)
+    keys.collect!{|key| key.to_s }
+    resque_values = ResqueValue.all(:conditions => {:key => keys})
+    resque_values.map(&:value)    
+  end    
+      
+  def llen(list_name)
+    ResqueValue.all(:conditions => {:key => list_name.to_s, :key_type=> LIST }).size
+  end
+  
+  def lset(list_name, index, value)
+    rpush(list_name, value)
+  end
+    
+  def lrange(list_name, start_range, end_range)
+    values = ResqueValue.all(
+                :conditions => {
+                  :key => list_name.to_s,
+                  :key_type=> LIST}, 
+                :offset => start_range, 
+                :limit => end_range)
+    values.map(&:value)
+  end
+  
+  def lpop(list_name)
+    last = ResqueValue.last(:conditions => {:key => list_name.to_s, :key_type => LIST})
+    if last
+      last.destroy
+      return last.value
+    end
+  end
+  
+  def rpush(list_name, value)
+    ResqueValue.create!(:key => list_name.to_s, :key_type => LIST, :value => value.to_s)
+  end
+  
+  def keys(pattern = '*')
+    raise "Pattern '#{pattern}' not supported" if pattern != '*'
+    ResqueValue.all(:select => 'DISTINCT resque_values.key').map(&:key)
+  end
+
+end

data/lib/resque_extension.rb

@@ -0,0 +1,11 @@
+Resque.module_eval do
+  def swagger!
+    define_method(:redis=) do |*args|
+      @redis = RedisImpersonator.new
+    end
+    
+    define_method(:connect_to_database) do |database|
+      ResqueValue.establish_connection(database)
+    end
+  end  
+end

data/lib/resque_value.rb

@@ -0,0 +1,3 @@
+class ResqueValue < ActiveRecord::Base
+  
+end

data/lib/swagger.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+require 'resque_value'
+require 'redis_impersonator'
+require 'resque_extension'

data/spec/redis_impersonator_spec.rb

@@ -0,0 +1,136 @@
+require 'spec/spec_helper'
+
+describe 'RedisImpersonator' do
+  let(:impersonator) { RedisImpersonator.new }
+
+  
+  it 'responds to info' do
+    impersonator.info.should_not be_nil
+  end
+  
+  it 'swallows calls to namespace' do
+    lambda{impersonator.namespace = 'value'}.should_not raise_error    
+  end
+
+  describe 'manipulating key values' do
+    it 'it can get key values' do
+      impersonator.set('key', 'value').should == 'value'
+      impersonator.get('key').should == 'value'
+    end
+  
+    it 'can create new key values' do
+      impersonator.set('key', 'value').should == 'value'
+      ResqueValue.first.value.should == 'value'
+    end
+  
+    it 'can delete key values' do
+      impersonator.set('key', 'value').should == 'value'
+      impersonator.del('key')
+      impersonator.get('key').should be_nil
+    end
+    
+    it 'can get multiple values by keys' do
+      impersonator.set('key-1', 'one')
+      impersonator.set('key-2', 'two')
+      impersonator.mapped_mget('key-1', 'key-2')['key-1'].should == 'one'
+      impersonator.mapped_mget('key-1', 'key-2')['key-2'].should == 'two'
+    end
+    
+    it 'always returns all keys when pattern is *' do
+      impersonator.set('key-1', 'one')
+      impersonator.set('key-2', 'two')
+      impersonator.keys('*').should include('key-1', 'key-2')
+    end
+
+    it 'raies error when pattern is not *' do
+      lambda{impersonator.keys('something not *')}.should raise_error
+    end
+  end
+
+  describe 'managing workes in a set' do
+    it 'can add workers to the queue' do
+      worker = Resque::Worker.new(queues = ['queue1'])
+      impersonator.sadd(:workers, worker)
+      ResqueValue.first.value.should == worker.to_s
+    end
+      
+    it 'returns all values in the workers set' do
+      worker = Resque::Worker.new(queues = ['queue1'])
+      impersonator.sadd(:workers, worker)
+      impersonator.smembers(:workers).first.should == worker.to_s
+    end
+  
+    it 'removes a worker from the workers set by name' do
+      worker = Resque::Worker.new(queues = ['queue1'])
+      impersonator.sadd(:workers, worker)
+      impersonator.srem(:workers, worker)
+      impersonator.smembers(:workers).should be_empty
+    end
+    
+    it 'should only add a value to a set once' do
+      impersonator.sadd(:test, 'one')
+      impersonator.sadd(:test, 'one')
+      impersonator.smembers(:test).size.should == 1
+    end
+  
+    it 'indicates when worker is in the workers set' do
+      worker = Resque::Worker.new(queues = ['queue1'])
+    
+      impersonator.sismember(:workers, worker).should == false
+      impersonator.sadd(:workers, worker)
+      impersonator.sismember(:workers, worker).should == true    
+    end  
+    
+    it 'can delete a whole set by name'  do
+      impersonator.sadd(:test, 'one')
+      impersonator.sadd(:test, 'two')
+      impersonator.del(:test)
+      impersonator.smembers(:test).should be_empty
+    end
+  end
+  
+  describe 'working with lists' do
+    it 'should return nil if no items on a queue' do
+      impersonator.lpop('some_queue').should be_nil
+    end
+    
+    it 'ingores index and adds item to list' do
+      impersonator.lset('some_queue', 88, 'value')
+      impersonator.llen('some_queue').should == 1
+    end
+    
+    it 'should add item to queue and then pop it back off' do
+      impersonator.rpush('some_queue', 'value')
+      impersonator.lpop('some_queue').should == 'value'
+      impersonator.lpop('some_queue').should be_nil
+    end
+    
+    it 'should tell you how many items are in a list' do
+      impersonator.rpush('some_queue', 'one')
+      impersonator.rpush('some_queue', 'two')
+      impersonator.llen('some_queue').should == 2
+    end
+    
+    it 'should be able to paginate through a list' do
+      impersonator.rpush('some_queue', 'one')
+      impersonator.rpush('some_queue', 'two')
+      impersonator.rpush('some_queue', 'three')        
+      impersonator.lrange('some_queue', 0, 1).first.should == 'one'
+      impersonator.lrange('some_queue', 2, 3).first.should == 'three'
+    end
+  end
+  
+  it 'should increment a value' do
+    impersonator.incrby('something', 2)
+    impersonator.get('something').should == '2'
+    impersonator.incrby('something', 1)
+    impersonator.get('something').should == '3'
+  end
+  
+  it 'should decrement a value' do
+    impersonator.incrby('something', 2)
+    impersonator.get('something').should == '2'
+    impersonator.decrby('something', 1)
+    impersonator.get('something').should == '1'
+  end
+end  

data/spec/resque_extension_spec.rb

@@ -0,0 +1,12 @@
+require 'spec/spec_helper'
+
+describe 'Resque' do
+  
+  it 'swaps redis implementation with impersonator' do
+    Resque.redis.should be_a(RedisImpersonator)
+  end  
+  
+  it 'can connect to the database' do
+    Resque.should.respond_to?(:connect_to_database)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'resque'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'swagger'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+
+  config.prepend_before :each do
+    ResqueValue.delete_all
+  end  
+  
+end
+
+Resque.swagger!
+
+ActiveRecord::Base.establish_connection('adapter' => 'sqlite3', 'database' => 'test.db')
+
+ActiveRecord::Base.connection.drop_table :resque_values rescue puts "unable to drop resque_values, probably because it has not been created yet"
+ActiveRecord::Base.connection.create_table :resque_values do |table|
+  table.column :key,      :string
+  table.column :key_type, :string
+  table.column :value, :text
+end
+
+ActiveRecord::Base.connection.add_index :resque_values, :key
+ActiveRecord::Base.connection.add_index :resque_values, [:key, :key_type]
+

data/swagger.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{swagger}
+  s.version = "1.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mdeiters"]
+  s.date = %q{2010-07-14}
+  s.description = %q{Duck punch Resque to use active record for backround jobs instead of redis}
+  s.email = %q{mdeiters@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/redis_impersonator.rb",
+     "lib/resque_extension.rb",
+     "lib/resque_value.rb",
+     "lib/swagger.rb",
+     "spec/redis_impersonator_spec.rb",
+     "spec/resque_extension_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "swagger.gemspec"
+  ]
+  s.homepage = %q{http://github.com/mdeiters/swagger}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Everything Resque provides minus Redis}
+  s.test_files = [
+    "spec/redis_impersonator_spec.rb",
+     "spec/resque_extension_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_runtime_dependency(%q<resque>, ["= 1.9.7"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<resque>, ["= 1.9.7"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<resque>, ["= 1.9.7"])
+  end
+end
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: swagger
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 1
+  version: 1.1.1
+platform: ruby
+authors: 
+- mdeiters
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 9
+        - 7
+        version: 1.9.7
+  type: :runtime
+  version_requirements: *id003
+description: Duck punch Resque to use active record for backround jobs instead of redis
+email: mdeiters@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/redis_impersonator.rb
+- lib/resque_extension.rb
+- lib/resque_value.rb
+- lib/swagger.rb
+- spec/redis_impersonator_spec.rb
+- spec/resque_extension_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- swagger.gemspec
+has_rdoc: true
+homepage: http://github.com/mdeiters/swagger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Everything Resque provides minus Redis
+test_files: 
+- spec/redis_impersonator_spec.rb
+- spec/resque_extension_spec.rb
+- spec/spec_helper.rb