alloc8 0.0.1 → 0.0.2

data/README.md

@@ -1,18 +1,46 @@
 Simple distributed resource allocation using Redis.
 
+To use resources:
 <pre>
+require 'rubygems'
 require 'alloc8'
 
 HOST = "my-redis"
 PORT = 6379 # default Redis port
 
-# to create resources
-@allocator = Alloc8::Tor.new(HOST, PORT)
-@allocator.create("worker", "worker1.my.org")
-@allocator.create("worker", "worker2.my.org")
-
-# to use them
+puts "acquiring worker"
 Alloc8::Tor.with_resource("worker", HOST, PORT) do |worker|
+  puts "about to do something with #{worker}"
   # something
 end
-</pre>
+</pre>
+
+Command-line tool to set up resources:
+<pre>
+$ alloc8
+Tasks:
+  alloc8 create CLASS RESOURCE  # Create a resource of a specific class
+  alloc8 help [TASK]            # Describe available tasks or one specific task
+  alloc8 list CLASS [-A]        # List all instances (or just available) of a resource class
+  alloc8 purge CLASS            # Delete all resources from a class
+  alloc8 reset CLASS            # Release acquired resources for a class
+
+Options:
+  -p, [--port=N]     # Redis store port
+                     # Default: 6379
+      [--db=N]       # Redis store database number
+  -h, [--host=HOST]  # Redis store hostname
+                     # Default: localhost
+
+$ export ALLOC8_HOST="my-redis"
+$ alloc8 list worker
+List entries for worker:
+$ alloc8 create worker worker1.my.org
+Added worker1.my.org to worker.
+$ alloc8 create worker worker2.my.org
+Added worker2.my.org to worker.
+$ alloc8 list worker
+List entries for worker:
+  worker1.my.org
+  worker2.my.org
+</pre>

data/alloc8.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "redis", "~> 2.2.0"
+  s.add_runtime_dependency "redis", ">= 2.0"
+  s.add_runtime_dependency "thor"
   s.add_development_dependency "rspec", "~> 2.0"
 end

data/bin/alloc8

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'thor'
+require 'alloc8'
+
+class Alloc8Cmd < Thor
+
+  class_option :host, :aliases => "-h", :type => :string, :default => (ENV["ALLOC8_HOST"] || "localhost"),
+    :desc => "Redis store hostname"
+  class_option :port, :aliases => "-p", :type => :numeric, :default => 6379, :desc => "Redis store port"
+  class_option :db, :type => :numeric, :desc => "Redis store database number"
+
+  desc "list CLASS [-A]", "List all instances (or just available) of a resource class"
+  method_option :available, :aliases => "-A", :type => :boolean, :desc => "List only the available (non-acquired) instances"
+  def list(klass)
+    allocator = Alloc8::Tor.new options[:host], options[:port], options[:db]
+    verb = options[:available] ? :available : :list
+    puts "#{verb.to_s.capitalize} entries for #{klass}:"
+    allocator.send(verb, klass).each do |res|
+      puts "  #{res}"
+    end
+  end
+
+  desc "create CLASS RESOURCE", "Create a resource of a specific class"
+  def create(klass, resource)
+    allocator = Alloc8::Tor.new options[:host], options[:port], options[:db]
+    allocator.create(klass, resource)
+    puts "Added #{resource} to #{klass}."
+  end
+
+  desc "purge CLASS", "Delete all resources from a class"
+  def purge(klass)
+    allocator = Alloc8::Tor.new options[:host], options[:port], options[:db]
+    allocator.purge(klass)
+    puts "Purged all entries for #{klass}."
+  end
+
+  desc "reset CLASS", "Release acquired resources for a class"
+  def reset(klass)
+    allocator = Alloc8::Tor.new options[:host], options[:port], options[:db]
+    allocator.reset(klass)
+    puts "Reset all acquired entries for #{klass}."
+  end
+end
+
+Alloc8Cmd.start

data/lib/alloc8.rb

@@ -2,51 +2,72 @@ require 'redis'
 
 module Alloc8
   class Tor
-    # initialize connection to a redis
+    # initialize connection to redis
     def initialize(host, port, db=nil)
       @redis = Redis.new(:host => host, :port => port)
       @redis.select(db) if db
     end
 
     # create a resource in a class
-    def create(resource_class, resource)
-      if @redis.sadd("resource:#{resource_class}", resource.to_s)
-        @redis.lpush "resource:#{resource_class}:avail", resource.to_s
+    def create(klass, resource)
+      if @redis.sadd(key(klass), resource.to_s)
+        @redis.lpush key(klass, :avail), resource.to_s
       end
     end
 
-    # delete a resource
-    def purge(resource_class)
-      nkeys = @redis.del "resource:#{resource_class}:avail", "resource:#{resource_class}"
+    # list all resources in class
+    def list(klass)
+      @redis.smembers(key(klass))
+    end
+
+    # delete a resource class
+    def purge(klass)
+      nkeys = @redis.del key(klass, :avail), key(klass)
       nkeys == 2 # true if purged all
     end
 
     # reset available items in resource class
-    def reset(resource_class)
-      @redis.del "resource:#{resource_class}:avail"
-      @redis.smembers("resource:#{resource_class}").each do |resource|
-        @redis.lpush "resource:#{resource_class}:avail", resource.to_s
+    def reset(klass)
+      akey = key(klass, :avail)
+      @redis.del akey
+      @redis.smembers(key(klass)).each do |resource|
+        @redis.lpush akey, resource.to_s
       end
     end
 
+    # list all available items in resource class
+    def available(klass)
+      akey = key(klass, :avail)
+      avail = []
+      @redis.llen(akey).times do |i|
+        avail << @redis.lindex(akey, i)
+      end
+      avail
+    end
+
     # acquire next available resource
-    def acquire(resource_class, timeout = 0)
-      key, res = @redis.brpop "resource:#{resource_class}:avail", timeout
+    def acquire(klass, timeout = 0)
+      akey, res = @redis.brpop key(klass, :avail), timeout
       res
     end
 
     # return resource
-    def return(resource_class, resource)
-      raise Exception if !@redis.sismember "resource:#{resource_class}", resource.to_s
-      @redis.lpush "resource:#{resource_class}:avail", resource.to_s
+    def return(klass, resource)
+      raise Exception.new("Invalid resource #{resource} for class #{klass}") if !@redis.sismember key(klass), resource.to_s
+      @redis.lpush key(klass, :avail), resource.to_s
     end
 
     # block to allocate a resource
-    def self.with_resource(resource_class, host, port, db=nil)
-       a = Alloc8::Tor.new host, port, db
-       res = a.acquire(resource_class)
-       yield res
-       a.return(resource_class, res)
+    def self.with_resource(klass, host, port, db=nil)
+      a = Alloc8::Tor.new host, port, db
+      res = a.acquire(klass)
+      yield res
+      a.return(klass, res)
+    end
+
+    private
+    def key(klass, suffix = nil)
+      "resource:#{klass}" << (suffix ? suffix.to_s : "")
     end
   end
 end

data/lib/alloc8/version.rb

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

data/spec/alloc8_spec.rb

@@ -19,6 +19,11 @@ describe Alloc8 do
   context "having a single resource" do
     before { @allocator.create KIND, "a" }
 
+    it "can return a list of resources, available resources" do
+      @allocator.list(KIND).should eq(["a"])
+      @allocator.available(KIND).should eq(["a"])
+    end
+
     it "can't allocate it again" do
       @allocator.create(KIND, "a").should == nil
     end
@@ -30,11 +35,21 @@ describe Alloc8 do
 
     it "can purge resource class" do
       @allocator.purge(KIND).should == true
+      @allocator.list(KIND).should eq([])
+      @allocator.available(KIND).should eq([])
     end
 
     it "can acquire and return a resource" do
       @allocator.acquire(KIND).should == "a"
+      @allocator.available(KIND).should eq([])
+
       @allocator.return(KIND, "a").should == 1
+      @allocator.list(KIND).should eq(["a"])
+      @allocator.available(KIND).should eq(["a"])
+    end
+
+    it "can't return an invalid resource" do
+      lambda { @allocator.return(KIND, "foo") }.should raise_error
     end
 
     it "can acquire with a block" do
@@ -52,6 +67,13 @@ describe Alloc8 do
   context "having multiple resources" do
     before { ["a", "b", "c"].each {|r| @allocator.create KIND, r} }
 
+    it "can return a list of resources, available resources" do
+      @allocator.list(KIND).should include("a", "b", "c")
+      @allocator.list(KIND).should have(3).items
+      @allocator.available(KIND).should include("a", "b", "c")
+      @allocator.available(KIND).should have(3).items
+    end
+
     it "can purge resource class" do
       @allocator.purge(KIND).should == true
     end
@@ -66,4 +88,4 @@ describe Alloc8 do
     end
   end
 
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: alloc8
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ariel Salomon
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 -07:00
+date: 2011-05-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,20 +24,33 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 3
         segments: 
         - 2
-        - 2
         - 0
-        version: 2.2.0
+        version: "2.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: thor
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -48,14 +61,14 @@ dependencies:
         - 0
         version: "2.0"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 description: |-
   Simple distributed resource allocation using Redis.
       Alloc8::Tor.with_resource do ...
 email: 
 - ariel@oscillatory.org
-executables: []
-
+executables: 
+- alloc8
 extensions: []
 
 extra_rdoc_files: []
@@ -66,6 +79,7 @@ files:
 - README.md
 - Rakefile
 - alloc8.gemspec
+- bin/alloc8
 - lib/alloc8.rb
 - lib/alloc8/version.rb
 - spec/alloc8_spec.rb