zack 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+
+= 0.1.0 / 05-31-2010
+
+  * Initial release.

data/LICENSE

@@ -0,0 +1,23 @@
+
+ Copyright (c) 2010 Kaspar Schiess, Patrick Marchi
+
+ 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

@@ -0,0 +1,49 @@
+INTRO
+
+zack climbs the beanstalk and may even return a golden harp from the sky. zack 
+allows you to do RPC via beanstalkd. It will encode your messages and handle
+return values. 
+
+SYNOPSIS
+
+  # Server
+  class Server
+    def answer
+      puts 'answer called'
+      42
+    end
+  end
+  
+  require 'zack'
+  Zack::Server.new(
+    'the_answer_to_life_the_universe_and_everything', 
+    :simple => Server, 
+    :server => 'localhost:11300'
+  ).run
+  
+  # Client
+  require 'zack'
+  answer = Zack::Client.
+    new(
+      'the_answer_to_life_the_universe_and_everything', 
+      :server => 'localhost:11300', 
+      :with_answer => [:answer]).
+    answer
+    
+  puts "The answer is #{answer}!"
+  
+This will output 'answer called' on the server and 'The answer is 41!' on the
+client. 
+
+zack is a small library that doesn't do much more than what has been shown
+above. 
+
+COMPATIBILITY
+
+Should run with most rubies of the 1.8 and 1.9 generations. 
+
+STATUS
+
+Useful and useable. First release. 
+
+(c) Kaspar Schiess, Patrick Marchi

data/Rakefile

@@ -0,0 +1,68 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+require "spec"
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new
+
+task :default => :spec
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "zack"
+  s.version           = "0.1.0"
+  s.summary           = "Ruby RPC calls via beanstalkd"
+  s.authors           = ['Kaspar Schiess', 'Patrick Marchi']
+  s.email             = ["kaspar.schiess@absurd.li", 'patrick.marchi@geo.uzh.ch']
+  s.homepage          = "http://github.com/kschiess/zack"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README)
+  s.rdoc_options      = %w(--main README)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(History.txt LICENSE Rakefile README) + Dir.glob("{spec,lib/**/*}")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  s.add_dependency("beanstalk-client", "~> 1.0.2")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("flexmock")
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+#
+# To publish your gem online, install the 'gemcutter' gem; Read more 
+# about that here: http://gemcutter.org/pages/gem_docs
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+
+  # Generate the gemspec file for github.
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end

data/lib/zack/client.rb

@@ -0,0 +1,41 @@
+
+require 'digest/md5' # ruby 1.9
+
+# Client part of Zack RPC
+#
+class Zack::Client
+  def initialize(tube_name, opts={})
+    server = opts[:server] || 'beanstalk:11300'
+    
+    @connection = Beanstalk::Connection.new(server, tube_name)
+
+    @with_answer = opts[:with_answer] || []
+    unless @with_answer.empty?
+      # Ain't it beautiful
+      digest = Digest::MD5.new
+      digest << @connection.instance_variable_get('@socket').addr.to_s
+      @answer_queue_name = "answer_"+digest.hexdigest
+    end
+  end
+  
+  def respond_to?(msg)
+    true
+  end
+  def method_missing(sym, *args, &result_callback)
+    message = [sym, args]
+    
+    if @with_answer.include? sym
+      message << @answer_queue_name
+    end
+    
+    @connection.put message.to_yaml
+
+    if @with_answer.include? sym
+      @connection.watch @answer_queue_name
+      answer = @connection.reserve
+      return YAML.load(answer.body)
+    end
+    
+    return nil
+  end
+end

data/lib/zack/server.rb

@@ -0,0 +1,54 @@
+
+# Server side for RPC calls. 
+#
+class Zack::Server
+  class SimpleFactory < Struct.new(:implementation_klass)
+    def produce; implementation_klass.new; end
+  end
+  
+  attr_reader :tube_name
+  
+  def initialize(tube_name, opts={})
+    server = opts[:server] || 'beanstalk:11300'
+    
+    if opts.has_key? :factory
+      @factory = opts[:factory]
+    elsif opts.has_key? :simple
+      @factory = SimpleFactory.new(opts[:simple])
+    else
+      raise ArgumentError, "Either :factory or :simple argument must be given." 
+    end
+        
+    @tube_name = tube_name
+    @connection = Beanstalk::Connection.new(server, tube_name)
+  end
+  
+  # Handles exactly one request. 
+  #
+  def handle_request
+    job = @connection.reserve
+    begin
+      sym, args, answer_tube = YAML.load(job.body)
+      
+      instance = @factory.produce
+      retval = instance.send(sym, *args)
+      
+      if answer_tube
+        @connection.use answer_tube
+        @connection.put retval.to_yaml
+        @connection.use tube_name
+      end
+    ensure
+      job.delete
+    end
+  end
+
+  # Runs the server and keeps running until the world ends (or the process, 
+  # whichever comes first).
+  #
+  def run
+    loop do
+      handle_request
+    end
+  end
+end

data/lib/zack.rb

@@ -0,0 +1,7 @@
+require 'beanstalk-client'
+require 'yaml'
+
+module Zack; end
+
+require 'zack/server'
+require 'zack/client'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: zack
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kaspar Schiess
+- Patrick Marchi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-31 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: beanstalk-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: 
+email: 
+- kaspar.schiess@absurd.li
+- patrick.marchi@geo.uzh.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- History.txt
+- LICENSE
+- Rakefile
+- README
+- lib/zack/client.rb
+- lib/zack/server.rb
+- lib/zack.rb
+has_rdoc: true
+homepage: http://github.com/kschiess/zack
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby RPC calls via beanstalkd
+test_files: []
+