activemessaging-kestrel-adapter 0.0.1

data/.bnsignore

@@ -0,0 +1,18 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   Bones {
+#     ignore_file  '.gitignore'
+#   }
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/History.txt

@@ -0,0 +1,7 @@
+== 0.0.1 / 2011-02-02
+* First release, actually works in a Rails application.
+
+== 0.0.0 / 2011-01-31
+
+* 1 major enhancement
+  * Birthday!

data/README.md

@@ -0,0 +1,78 @@
+activemessaging-kestrel-adapter
+===========
+
+This is an adapter to the kestrel messaging server for the ActiveMessaging framework.  It is 
+in the early stages of development.
+
+Features
+--------
+
+* send to any queue
+* receive from any subscribed queue
+
+Examples
+--------
+
+    require 'activemessaging-kestrel-adapter'
+
+    # configure ActiveMessaging broker in an appropriate broker.yml file:
+    # development:
+    #   adapter: kestrel
+    #   servers: localhost:22133
+    config = YAML.load(File.read("broker.yml"))
+
+    adapter = ActiveMessaging::Adapter::Kestrel::Connection.new(config[:development])
+
+    adapter.send("arbitrarily_named_queue", "message as string")
+    adapter.subscribe("queue1")
+    adapter.subscribe("queue2")
+    adapter.receive # get a message from any of the subscribed queues, or nil if they are all empty
+
+
+Requirements
+------------
+
+* depends on memcached-client
+* flesh out the configuration
+
+Future
+------
+
+* Handle a cluster of kestrel servers
+* Write some tests (need a mock kestrel service?)
+
+Install
+-------
+
+* gem install activemessaging-kestrel-adapter
+
+Author
+------
+
+Original author: Douglas A. Seifert <doug@dseifert.net>
+
+License
+-------
+
+The MIT License
+
+Copyright (c) 2011 Douglas A. Seifert
+
+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/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+task :default => 'test:run'
+task 'gem:release' => 'test:run'
+
+Bones {
+  name     'activemessaging-kestrel-adapter'
+  authors  'Douglas A. Seifert'
+  email    'doug@dseifert.net'
+  url      'http://github.org/seifertd/activemessaging-kestrel-adapter'
+  ignore_file '.gitignore'
+  readme_file 'README.md'
+  version '0.0.1'
+
+  depend_on 'memcache-client'
+
+  rdoc.include << 'README.md'
+
+}
+

data/bin/activemessaging-kestrel-adapter

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib activemessaging-kestrel-adapter]))
+
+# Put your code here
+

data/config/kestrel.yml.sample

@@ -0,0 +1,8 @@
+development:
+  servers: localhost:22133
+
+test:
+  servers: localhost:22133
+
+production:
+  servers: localhost:22133

data/lib/active_messaging/adapters/kestrel.rb

@@ -0,0 +1,97 @@
+require 'memcache'
+require 'activemessaging/adapters/base'
+
+module ActiveMessaging
+  module Adapters
+    # This module contains code to integrate the ActiveMessaging framework with a
+    # kestrel message queue server.
+    module Kestrel
+      # Simple struct for wrapping received messages
+      Message = Struct.new(:headers, :body, :command)
+
+      # Connection to a kestrel message queue server
+      class Connection < ActiveMessaging::Adapters::Base::Connection
+        include ActiveMessaging::Adapter
+        register :kestrel
+        attr_accessor :reliable
+        # Time to sleep between polls of empty queues
+        attr_accessor :receive_throttle
+        # Reconnect on error
+        attr_accessor :error_policy
+
+        def initialize(cfg)
+          @receive_throttle = cfg.delete(:receive_throttle) || 0.1
+          # TODO: Implement error policies
+          @error_policy = cfg.delete(:error_policy) || :reconnect
+          @config = cfg
+          @queues = {}
+          connect
+          nil
+        end
+
+        # Connect to the kestrel server using a Memcached client
+        def connect
+          @kestrel = MemCache.new(@config)
+          @kestrel.servers = @config[:servers]
+        end
+ 
+        # Subscribe to the named destination and begin receiving
+        # messages from it
+        def subscribe(destination_name, headers = {})
+          headers[:destination] = destination_name
+          if @queues[destination_name]
+            # TODO: Should you get an exception or no?
+          else
+            @queues[destination_name] = headers
+          end
+          nil
+        end
+
+        # Stop receiving messages from the named destination
+        def unsubscribe(destination_name, headers = {})
+          @queues.delete(destination_name)
+        end
+
+        # Send a message to the named destination.  headers can
+        # include any of the following keys:
+        #    :ttl => Set the time to live of the message in seconds
+        def send(destination_name, body, headers = {})
+          ttl = (headers[:ttl] || 0).to_i
+          if ttl <= 0
+            @kestrel.set(normalize(destination_name), body)
+          else
+            @kestrel.set(normalize(destination_name), body, ttl)
+          end
+        end
+
+        # Gets a message from any subscribed destination and returns it as a 
+        # ActiveMessaging::Adaptors::Kestrel::Message object
+        def receive
+          # TODO: Is this what ActiveMessaging expects: can it handle a nil return?
+          #while (true)
+            # Get a message from a subscribed queue, but don't favor any queue over another
+            queues_to_check = @queues.size > 1 ? @queues.keys.sort_by{rand} : @queues.keys
+            queues_to_check.each do |queue|
+              if item = @kestrel.get(normalize(queue))
+                # TODO: ActiveMessaging ought to provide a way to do messaging
+                # without having to wrap the messages in another object
+                return Message.new({'destination' => queue}, item, 'MESSAGE')
+              end
+            end
+          #  # Sleep a bit so we don't get into a spinloop
+          #  sleep @receive_throttle
+          #end
+          return nil
+        end
+
+        private
+          def normalize(name)
+            # Kestrel doesn't like '/' chars in queue names, so get rid of them
+            # (and memoize the calculation)
+            @normalized_names ||= Hash.new {|h,k| h[k] = k.gsub('/', '--FS--')}
+            @normalized_names[name]
+          end
+      end
+    end
+  end
+end

data/lib/activemessaging-kestrel-adapter.rb

@@ -0,0 +1,60 @@
+
+module ActivemessagingKestrelAdapter
+
+  # :stopdoc:
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  VERSION = ::File.read(PATH + 'version.txt').strip
+  # :startdoc:
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+    if block_given?
+      begin
+        $LOAD_PATH.unshift LIBPATH
+        rv = yield
+      ensure
+        $LOAD_PATH.shift
+      end
+    end
+    return rv
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    rv = args.empty? ? PATH : ::File.join(PATH, args.flatten)
+    if block_given?
+      begin
+        $LOAD_PATH.unshift PATH
+        rv = yield
+      ensure
+        $LOAD_PATH.shift
+      end
+    end
+    return rv
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module ActivemessagingKestrelAdapter
+
+ActivemessagingKestrelAdapter.require_all_libs_relative_to(__FILE__, 'active_messaging')
+

data/spec/activemessaging-kestrel-adapter_spec.rb

@@ -0,0 +1,6 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe ActivemessagingKestrelAdapter do
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib activemessaging-kestrel-adapter]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+

data/version.txt

@@ -0,0 +1 @@
+0.0.1

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: activemessaging-kestrel-adapter
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Douglas A. Seifert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: memcache-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 1
+        - 8
+        - 3
+        version: 1.8.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 3
+        - 6
+        - 2
+        version: 3.6.2
+  type: :development
+  version_requirements: *id002
+description: |-
+  This is an adapter to the kestrel messaging server for the ActiveMessaging framework.  It is 
+  in the early stages of development.
+email: doug@dseifert.net
+executables: 
+- activemessaging-kestrel-adapter
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.md
+- bin/activemessaging-kestrel-adapter
+files: 
+- .Rakefile.swp
+- .bnsignore
+- History.txt
+- README.md
+- Rakefile
+- bin/activemessaging-kestrel-adapter
+- config/kestrel.yml.sample
+- lib/active_messaging/adapters/kestrel.rb
+- lib/activemessaging-kestrel-adapter.rb
+- spec/activemessaging-kestrel-adapter_spec.rb
+- spec/spec_helper.rb
+- test/test_activemessaging-kestrel-adapter.rb
+- version.txt
+has_rdoc: true
+homepage: http://github.org/seifertd/activemessaging-kestrel-adapter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+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: activemessaging-kestrel-adapter
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This is an adapter to the kestrel messaging server for the ActiveMessaging framework.
+test_files: 
+- test/test_activemessaging-kestrel-adapter.rb