distribunaut 0.3.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 markbates
+
+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,67 @@
+==Examples
+
+===Example #1
+
+<pre>
+  <code>
+    
+# 'Server' application
+require 'distribunaut'
+
+configatron.distribunaut.app_name = :user_app
+
+class User
+  include Distribunaut::Distributable
+
+  attr_accessor :username
+
+  def self.hi
+    'hello!!!'
+  end
+
+  def save
+    puts "Saving: #{self.inspect}"
+  end
+
+end
+
+DRb.thread.join
+    
+   </code>
+</pre>
+<pre>
+  <code>
+
+# 'Client' application
+require 'distribunaut'
+
+puts Distribunaut::Distributed::User.hi
+
+User = Distribunaut::Distributed::User
+
+puts User.hi
+
+user = User.new
+
+puts user.inspect
+
+user.username = 'markbates'
+
+puts user.inspect
+
+user.save 
+
+# Saving: #<User:0x18ef764 @username="markbates">
+
+# hello!!!
+# hello!!!
+# #<DRb::DRbObject:0x192e6a8 @ref=13073330, @uri="druby://192.168.1.2:56836">|#<User:0x18ef764>
+# #<DRb::DRbObject:0x192e6a8 @ref=13073330, @uri="druby://192.168.1.2:56836">|#<User:0x18ef764 @username="markbates">
+
+   </code>
+</pre>
+
+===Contributors
+
+* Mark Bates
+* Josh Schairbaum

data/bin/distribunaut_ring_server

@@ -0,0 +1,33 @@
+#!/usr/local/bin/ruby
+# require 'rubygems'
+require 'daemons'
+require 'rinda/ring'
+require 'rinda/tuplespace'
+require 'fileutils' 
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+
+options = OpenStruct.new
+opts = OptionParser.new do |opts|
+  opts.banner = <<-BANNER
+Usage: distribunaut_ring_server <command>
+Available commands are:
+
+- start
+- stop
+- restart
+
+BANNER
+end
+
+opts.parse!(ARGV)
+
+FileUtils.mkdir_p(File.join("tmp", "pids"))
+
+Daemons.run_proc('distribunaut_ring_server', {:dir_mode => :normal, :dir => File.join("tmp", "pids"), :monitor => true, :multiple => false}) do
+  puts 'Starting distribunaut_ring_server...'
+  DRb.start_service
+  Rinda::RingServer.new(Rinda::TupleSpace.new)
+  DRb.thread.join
+end

data/lib/distribunaut.rb

@@ -0,0 +1,22 @@
+require 'configatron'
+require 'drb/drb'
+require 'drb/acl'
+require 'rinda/ring'
+require 'rinda/tuplespace'
+require 'addressable/uri'
+require 'active_support/i18n'
+require 'active_support/inflector'
+
+base = File.join(File.dirname(__FILE__), 'distribunaut')
+
+configatron.distribunaut.set_default(:app_name, nil)
+configatron.distribunaut.set_default(:timeout, 0)
+
+# load *.rb files
+Dir.glob(File.join(base, "**", "*.rb")).each do |f|
+  require(f)
+end
+
+# Make sure no one can call eval() and related 
+# methods remotely!
+$SAFE = 1 unless $SAFE > 0

data/lib/distribunaut/distributable.rb

@@ -0,0 +1,57 @@
+module Distribunaut # :nodoc:
+  # Include this module into any class it will instantly register that class with
+  # the distribunaut_ring_server. The class will be registered with the name of the class
+  # and the distribunaut.distributed_app_name configured in your config/configatron/*.rb file.
+  # If the distribunaut.distributed_app_name configuration parameter is nil it will raise
+  # an Distribunaut::Distributed::Errors::ApplicationNameUndefined exception.
+  # 
+  # Example:
+  #  class User
+  #    include Distribunaut::Distributable
+  #    def name
+  #      "mark"
+  #    end
+  #  end
+  # 
+  #  Distribunaut::Distributed::User.new.name # => "mark"
+  module Distributable
+      
+      def self.included(base) # :nodoc:
+        raise Distribunaut::Distributed::Errors::ApplicationNameUndefined.new if configatron.distribunaut.app_name.nil?
+        base.class_eval do
+          include ::DRbUndumped
+        end
+        c_name = base.name.gsub('::', '_')
+        eval %{
+          class ::Distribunaut::Distributed::#{c_name}Proxy
+            include Singleton
+            include DRbUndumped
+
+            def method_missing(sym, *args)
+              #{base}.send(sym, *args)
+            end
+            
+            undef :id if method_defined?(:id)
+            undef :inspect if method_defined?(:inspect)
+            undef :to_s if method_defined?(:to_s)
+            
+            def borrow(&block)
+              Distribunaut::Utils::Rinda.borrow(:space => :#{base}, 
+                                                :object => self,
+                                                :description => "#{base} Service",
+                                                :app_name => configatron.distribunaut.app_name.to_sym) do |tuple|
+                yield tuple.object
+              end
+            end
+          
+          end
+        }
+        obj = "Distribunaut::Distributed::#{c_name}Proxy".constantize.instance
+        Distribunaut::Utils::Rinda.register_or_renew(:space => "#{base}".to_sym, 
+                                                     :object => obj,
+                                                     :description => "#{base} Service",
+                                                     :app_name => configatron.distribunaut.app_name.to_sym)
+      end
+      
+  end # Distributable
+end # Distribunaut

data/lib/distribunaut/distributed.rb

@@ -0,0 +1,24 @@
+module Distribunaut # :nodoc:
+  module Distributed # :nodoc:
+    
+    # Looks up and tries to find the missing constant using the ring server.
+    def self.const_missing(const)
+      Distribunaut::Utils::Rinda.read(:space => "#{const}".to_sym)
+    end
+    
+    # Allows for the specific lookup of services on the ring server
+    # 
+    # Examples:
+    #   Distribunaut::Utils::Rinda.register_or_renew(:app_name => :app_1, :space => :Test, :object => "Hello World!")
+    #   Distribunaut::Utils::Rinda.register_or_renew(:app_name => :app_2, :space => :Test, :object => "Hello WORLD!")
+    #   Distribunaut::Distributed.lookup("distributed://app_1/Test") # => "Hello World!"
+    #   Distribunaut::Distributed.lookup("distributed://app_2/Test") # => "Hello WORLD!"
+    def self.lookup(address)
+      uri = Addressable::URI.parse(address)
+      path = uri.path[1..uri.path.size] # remove the first slash
+      host = uri.host
+      Distribunaut::Utils::Rinda.read(:space => path.to_sym, :app_name => host.to_sym)
+    end
+    
+  end # Distributed
+end # Distribunaut

data/lib/distribunaut/errors/errors.rb

@@ -0,0 +1,26 @@
+module Distribunaut
+  module Distributed # :nodoc:
+    module Errors # :nodoc:
+      
+      # Raised when an unknown distributed application is referenced.
+      class UnknownApplication < StandardError
+        # Takes the application name.
+        def initialize(app_name)
+          super("APPLICATION: #{app_name} is not a known/registered distributed application.")
+        end
+      end
+      
+      # Raised when an application doesn't declare it's application name for use in a distributed system.
+      class ApplicationNameUndefined < StandardError
+      end
+      
+      # Raised when the distributed path is not a well formed addressable format
+      class InvalidAddressableURIFormat < StandardError
+        def inititalize(msg)
+          super("Invalid addressable format: #{msg}")
+        end
+      end
+      
+    end # Errors
+  end # Distributed
+end # Distribunaut

data/lib/distribunaut/extensions/drb_object.rb

@@ -0,0 +1,15 @@
+module DRb # :nodoc:
+  class DRbObject # :nodoc:
+
+    alias_method :_original_inspect, :inspect unless method_defined?(:_original_inspect)
+    
+    def inspect
+      "#{_original_inspect}|#{method_missing(:inspect)}"
+    end
+    
+    undef :id if method_defined?(:id)
+    undef :kind_of? if method_defined?(:kind_of?)
+    undef :is_a? if method_defined?(:is_a?)
+    
+  end
+end

data/lib/distribunaut/tasks/ring_server_tasks.rake

@@ -0,0 +1,34 @@
+require 'rinda/ring'
+namespace :distribunaut do
+  namespace :ring_server do
+    
+    desc "Start the Rinda ring server"
+    task :start do
+      `distribunaut_ring_server start`
+    end
+    
+    desc "Stop the Rinda ring server"
+    task :stop do
+      `distribunaut_ring_server stop`
+    end
+    
+    desc "Restart the Rinda ring server"
+    task :restart => [:stop, :start]
+    
+    namespace :services do
+      
+      desc "Lists all services on the ring server"
+      task :list do
+        require 'distribunaut'
+        puts "Services on #{Distribunaut::Utils::Rinda.ring_server.__drburi}"
+        services = Distribunaut::Utils::Rinda.available_services
+        services.each do |service|
+          # puts "#{service[0]}: #{service[1]} on #{service[2].__drburi} - #{service[3]}"
+          puts "#{service.app_name}: #{service.space} on #{service.object.__drburi} - #{service.description}"
+        end
+      end
+      
+    end # services
+    
+  end # ring_server
+end # distribunaut

data/lib/distribunaut/tuple.rb

@@ -0,0 +1,42 @@
+module Distribunaut # :nodoc:
+  class Tuple
+    
+    attr_accessor :app_name
+    attr_accessor :space
+    attr_accessor :object
+    attr_accessor :description
+    attr_accessor :timeout
+    
+    def initialize(values = {})
+      values.each do |k, v|
+        self.send("#{k}=", v)
+      end
+    end
+    
+    def to_array
+      [self.app_name, self.space, self.object, self.description]
+    end
+    
+    def to_search_array
+      [self.app_name, self.space, nil, nil]
+    end
+    
+    def to_s
+      self.to_array.inspect
+    end
+    
+    class << self
+      
+      def from_array(ar)
+        tuple = Distribunaut::Tuple.new
+        tuple.app_name = ar[0]
+        tuple.space = ar[1]
+        tuple.object = ar[2]
+        tuple.description = ar[3]
+        return tuple
+      end
+      
+    end
+      
+  end # Tuple
+end # Distribunaut

data/lib/distribunaut/utils/rinda.rb

@@ -0,0 +1,83 @@
+module Distribunaut
+  module Utils # :nodoc:
+    module Rinda
+      
+      class << self
+        
+        def register_or_renew(values = {})
+          tuple = build_tuple(values)
+          begin
+            ring_server.take(tuple.to_search_array, tuple.timeout)
+          rescue ::Rinda::RequestExpiredError => e
+            # it's ok that it expired. It could be that it was never registered.
+          end
+          register(values)
+        end
+      
+        def register(values = {})
+          tuple = build_tuple(values)
+          ring_server.write(tuple.to_array, ::Rinda::SimpleRenewer.new)
+        end
+      
+        def ring_server
+          if configatron.distribunaut.retrieve(:acl, nil)
+            acl = ACL.new(configatron.distribunaut.acl)
+            DRb.install_acl(acl)
+          end
+          ::DRb.start_service
+          rs = ::Rinda::RingFinger.primary
+          rs
+        end
+      
+        def read(values = {})
+          tuple = build_tuple(values)
+          results = ring_server.read(tuple.to_array, tuple.timeout)
+          tuple = Distribunaut::Tuple.from_array(results)
+          tuple.object
+        end
+        
+        def borrow(values = {}, &block)
+          tuple = build_tuple(values)
+          results = ring_server.take(tuple.to_array, tuple.timeout)
+          tuple = Distribunaut::Tuple.from_array(results)
+          tuple.space = "#{tuple.space}-onloan-#{Time.now}".to_sym
+          register(tuple)
+          begin
+            yield tuple if block_given?
+          rescue Exception => e
+            raise e
+          ensure
+            # (.+)-onloan-.+$
+            tuple.space.to_s.match(/(.+)-onloan-.+$/)
+            tuple.space = $1.to_sym
+            register(tuple)
+          end
+        end
+      
+        def available_services
+          ring_server = self.ring_server
+          all = ring_server.read_all([nil, nil, nil, nil])
+          services = []
+          all.each do |service|
+            services << Distribunaut::Tuple.from_array(service)
+          end
+          services
+        end
+        
+        def remove_all_services!
+          available_services.each do |service|
+            ring_server.take(service.to_array)
+          end
+        end
+      
+        private
+        def build_tuple(values = {})
+          return values if values.is_a?(Distribunaut::Tuple)
+          Distribunaut::Tuple.new({:timeout => configatron.distribunaut.timeout}.merge(values))
+        end
+      
+      end # class << self
+      
+    end
+  end
+end

data/lib/distribunaut_tasks.rb

@@ -0,0 +1,4 @@
+# load tasks
+Dir.glob(File.join(File.dirname(__FILE__), 'distribunaut', 'tasks', '*.rake')).each do |f|
+  load(f)
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+name: distribunaut
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- markbates
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: configatron
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 10
+        version: 1.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+description: "distribunaut was developed by: markbates"
+email: mark+github@markbates.com
+executables: 
+- distribunaut_ring_server
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- lib/distribunaut/distributable.rb
+- lib/distribunaut/distributed.rb
+- lib/distribunaut/errors/errors.rb
+- lib/distribunaut/extensions/drb_object.rb
+- lib/distribunaut/tasks/ring_server_tasks.rake
+- lib/distribunaut/tuple.rb
+- lib/distribunaut/utils/rinda.rb
+- lib/distribunaut.rb
+- lib/distribunaut_tasks.rb
+- README
+- LICENSE
+- bin/distribunaut_ring_server
+has_rdoc: true
+homepage: http://www.metabates.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 875812335140152363
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: distribunaut
+test_files: []
+