langrove 0.0.4.5 → 0.0.5.3

data/.rvmrc

@@ -3,60 +3,51 @@
 # This is an RVM Project .rvmrc file, used to automatically load the ruby
 # development environment upon cd'ing into the directory
 
-# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
-environment_id="ruby-1.9.2-p0@langrove"
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.2" > .rvmrc
+environment_id="ruby-1.9.2-p318@langrove"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.12.3 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
 
-#
-# Uncomment following line if you want options to be set only for given project.
-#
-# PROJECT_JRUBY_OPTS=( --1.9 )
-
-#
 # First we attempt to load the desired environment directly from the environment
 # file. This is very fast and efficient compared to running through the entire
 # CLI and selector. If you want feedback on which environment was used then
 # insert the word 'use' after --create as this triggers verbose mode.
-#
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
   && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
 then
   \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-
-  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
-  then
-    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
   fi
 else
   # If the environment file has not yet been created, use the RVM CLI to select.
-  if ! rvm --create use  "$environment_id"
-  then
+  rvm --create use  "$environment_id" || {
     echo "Failed to create RVM environment '${environment_id}'."
     return 1
-  fi
+  }
 fi
 
-#
-# If you use an RVM gemset file to install a list of gems (*.gems), you can have
-# it be automatically loaded. Uncomment the following and adjust the filename if
-# necessary.
-#
-# filename=".gems"
-# if [[ -s "$filename" ]]
-# then
-#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
-# fi
 
 # If you use bundler, this might be useful to you:
-# if command -v bundle && [[ -s Gemfile ]]
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
+# }
 # then
-#   bundle install
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | grep -vE '^Using|Your bundle is complete'
 # fi
-
-if [[ $- == *i* ]] # check for interactive shells
-then
-    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
-else 
-	echo "Using: $GEM_HOME" # don't use colors in interactive shells
-fi
-
-

data/Gemfile

@@ -1,16 +1,22 @@
 source :gemcutter
 source "http://rubygems.org"
 
-gem 'watchr'
-gem 'rspec'
+group :development do
+	
+	gem 'rspec'
+	gem 'guard-rspec'
+	gem 'guard'
+	gem 'rake'
+  gem 'em-rspec'
+
+end
+
+
+gem 'awesome_print'
 
-# daemon-kit
 gem 'daemon-kit'
 gem 'eventmachine'
 gem 'em-http-request'
-gem 'awesome_print'
-
+gem 'em-websocket'
 gem 'eventmachine_httpserver'
 
-gem 'resque'
-gem 'rake'

data/Gemfile.lock

@@ -2,7 +2,7 @@ GEM
   remote: http://rubygems.org/
   remote: http://rubygems.org/
   specs:
-    addressable (2.2.7)
+    addressable (2.2.8)
     awesome_print (1.0.2)
     daemon-kit (0.1.8.2)
       eventmachine (>= 0.12.10)
@@ -12,39 +12,40 @@ GEM
       addressable (>= 2.0.0)
       escape_utils
       eventmachine (>= 0.12.9)
+    em-rspec (0.1.1)
+      eventmachine (>= 0.12.10)
+    em-websocket (0.3.8)
+      addressable (>= 2.1.1)
+      eventmachine (>= 0.12.9)
     escape_utils (0.2.4)
     eventmachine (0.12.10)
     eventmachine_httpserver (0.2.1)
-    multi_json (1.3.2)
-    rack (1.4.1)
-    rack-protection (1.2.0)
-      rack
-    rake (0.8.7)
-    redis (2.2.2)
-    redis-namespace (1.0.3)
-      redis (< 3.0.0)
-    resque (1.20.0)
-      multi_json (~> 1.0)
-      redis-namespace (~> 1.0.2)
-      sinatra (>= 0.9.2)
-      vegas (~> 0.1.2)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
+    ffi (1.0.11)
+    guard (1.2.3)
+      listen (>= 0.4.2)
+      thor (>= 0.14.6)
+    guard-rspec (1.2.0)
+      guard (>= 1.1)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    rake (0.9.2.2)
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    safely (0.3.1)
-    sinatra (1.3.2)
-      rack (~> 1.3, >= 1.3.6)
-      rack-protection (~> 1.2)
-      tilt (~> 1.3, >= 1.3.3)
-    tilt (1.3.3)
-    vegas (0.1.11)
-      rack (>= 1.0.0)
-    watchr (0.7)
+    rspec-mocks (2.11.1)
+    safely (0.3.2)
+    thor (0.15.4)
 
 PLATFORMS
   ruby
@@ -53,9 +54,11 @@ DEPENDENCIES
   awesome_print
   daemon-kit
   em-http-request
+  em-rspec
+  em-websocket
   eventmachine
   eventmachine_httpserver
+  guard
+  guard-rspec
   rake
-  resque
   rspec
-  watchr

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec',
+
+	:cli => "--color",
+	:all_on_start => false,
+	:all_after_pass => false,
+	:spec_paths => ['spec'] do
+
+	watch(%r{^spec/.+_spec\.rb$})
+	watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+
+end

data/README.md

@@ -0,0 +1,34 @@
+LanGrove
+========
+
+[LanGrove](http://www.google.com/search?hl=en&safe=off&biw=1065&bih=884&tbm=isch&sa=1&q=mangrove&btnG=) levarages [EventMachine](http://eventmachine.rubyforge.org/EventMachine.html) and [DaemonKit](https://github.com/kennethkalmer/daemon-kit/) to provide a framework for quick to implement network aware systems by providing an easily configurable transport and session layer and exposing generic interfaces into the application layer.
+
+### Getting started quickly with [Scaffold and Configuration](https://github.com/cluetechnologies/langrove-enterprise/tree/master/bin)
+
+### Understanding the [Framework Components](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove)
+
+Change Log
+----------
+
+### 2012-08-08
+
+* v0.0.5.3
+
+
+Todo
+----
+
+* Rename this to `langrove`
+* Rename the original to `langrove-enterprise`
+* Swing all document links
+* Publish this repo
+* Start on the Enterprise Extensions
+
+
+Note to Developers
+------------------
+
+* Uses [Guard](https://github.com/guard/guard/) to watch for changes in `lib` or `spec` directories
+* Runs specs accordingly.
+* `bundle exec guard` 
+

data/Rakefile

@@ -16,9 +16,11 @@ task :publish do
 
 end
 
-desc "Push to github"
-task :push_world do
-  
-  puts "TODO"
-  
-end
+#
+# brew install markdown
+#
+desc "Make ./tmp/readme.html"
+task :readme do
+  sh "markdown< README.md > tmp/README.html"
+end
+

data/bin/README.md

@@ -0,0 +1,3 @@
+Scaffold and Configuration
+==========================
+

data/bin/langrove

@@ -1,3 +1,2 @@
 #!/usr/bin/env ruby
-
-puts "warbel"
+puts "pending config scaffolding tool"

data/langrove.gemspec

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift 'lib'
+
+require 'date'
+require 'langrove/version'
+
+Gem::Specification.new do |spec|
+  spec.name = %q{langrove}
+  spec.version = ::LanGrove::Version
+  spec.date = DateTime.now.strftime( "%Y-%m-%d" )
+  spec.authors = ["Richard","","",""]
+  spec.email = %q{ops@clue.co.za}
+  spec.summary = %q{eventmachine based networked daemon framework}
+  spec.homepage = %q{}
+  spec.description = %q{}
+  
+  # Executables
+  spec.executables << 'langrove'
+  
+  #spec.executables << 'langrove-init'
+  #spec.executables << 'langrove-stats'
+  #spec.executables << 'langrove-error-stats'
+  #spec.executables << 'error_report'
+
+  spec.add_runtime_dependency 'eventmachine'
+  spec.add_runtime_dependency 'em-http-request'
+  spec.add_runtime_dependency 'em-websocket'
+  spec.add_runtime_dependency 'eventmachine_httpserver'
+  spec.add_runtime_dependency 'daemon-kit'
+  spec.add_runtime_dependency 'awesome_print'
+    
+  spec.files = `git ls-files`.strip.split("\n")
+    
+end
+    
+  

data/lib/langrove/README.md

@@ -0,0 +1,82 @@
+Foundation
+==========
+
+### [Langrove::Root::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/root)
+
+Provides the `Config` and `Logger`.
+
+### [LanGrove::Daemon::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/daemon)
+
+Defines the `Container` that houses the Primary Daemon Components
+
+
+Primary Components
+==================
+
+
+### [LanGrove::Adaptor::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/adaptor)
+
+Defines the `Object` to which remote processes attach.
+
+
+### [LanGrove::Handler::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler)
+
+Defines the `Object` that is spawned to handle each attached remote process.
+
+
+### [LanGrove::Protocol::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/protocol)
+
+Defines the `Object` that encapsulates the method of communication.
+
+
+### [LanGrove::Server::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/server)
+
+Defines the `Object` that houses the collection of all presently connected remote processes.
+
+Configuration
+-------------
+
+Each component is configured in a subtree nested at the root of the daemons config branch.
+
+<pre>
+
+:daemons:
+  ...
+  ...
+  my_daemon:
+
+    :adaptor:
+      ...
+
+    :handler:
+      ...
+
+    :protocol:
+      ...
+
+    :server:
+      ...
+
+</pre>
+
+
+Secondary Components
+====================
+
+
+### [LanGrove::Behaviour::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/behaviour)
+
+Defines a set of Behaviours that can be applied to Primary Daemon Components
+
+
+### [LanGrove::Plugin::Base](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/plugin)
+
+Defines the `Interface Base` to implement Behaviour actions.
+
+
+
+Tools and Things
+================
+
+### [LanGrove::Ext](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/ext)
+

data/lib/langrove/adaptor/README.md

@@ -0,0 +1,92 @@
+<pre>
+
+</pre>
+
+LanGrove::Adaptor::Base
+========================
+
+Defines the extendable `Interface` for spawning [Handler](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/handler)s into the [Server](https://github.com/cluetechnologies/langrove-enterprise/tree/master/lib/langrove/server) process.
+
+
+EventMachineAdaptor
+-------------------
+
+This is the default Adaptor and will be used when :class: is unspecified.
+
+It listens.
+
+### `./config/my_daemon.yml`
+
+<pre>
+
+:daemons:
+
+  my_daemon:
+    ...
+    ...
+
+    :adaptor:
+      # :class: Unspecified
+      :connect: tcp
+      :iface: 10.0.0.2
+      :port: 16369
+
+    ...
+    ...
+
+</pre>
+
+
+
+QueryAdaptor
+------------
+
+### Pending...
+
+[EventMachine::Protocols::Postgres3](http://eventmachine.rubyforge.org/EventMachine/Protocols/Postgres3.html)
+
+
+
+Implementing a custom Adaptor
+=============================
+
+* Adaptor implementations should define validate_config() and connector()
+* connector() receives a params Hash containing the definition of the Handler and Protocol along with their configs.
+* connector() should instanciate a new Handler with each connection made and yield that Handler
+
+### `lib/adaptor/my_adaptor.rb`
+
+<pre>
+
+module Adaptor
+
+  class MyAdaptor <code>&#60;</code> LanGrove::Adaptor::Base
+
+    def validate_config
+
+      @config
+
+    end
+
+    def connector( params, &block )
+
+      #
+      # Event Loop (or something)
+      # 
+      # 
+      # (Listen)
+      # 
+      # 
+      # Yield new Handlers
+      # 
+      # 
+      # But keep looping (probably)
+      # 
+
+    end
+
+  end
+
+end
+
+</pre>

data/lib/langrove/adaptor/adaptor_base.rb

@@ -0,0 +1,123 @@
+module LanGrove
+
+  module Adaptor
+  
+    class Base < LanGrove::Base
+
+      def stop
+        
+        #
+        # OVERRIDE
+        #
+        # Daemon has been called to stop
+        #
+
+      end
+
+      def reload
+
+        #
+        # OVERRIDE
+        # 
+        # Daemon has been called to HUP
+        #
+
+      end
+
+      def validate_config
+
+        #
+        # OVERRIDE
+        # 
+
+        @config
+
+      end
+    
+      def connector( params, &block )
+        
+        #
+        # OVERRIDE
+        # 
+        # To define the adaptor device to which clients 
+        # connect.
+        # 
+        
+        raise LanGrove::PluginException.new( 
+        
+          "#{self.class}.connector() - missing implementation."  
+          
+        )
+        
+      end
+      
+
+      ###
+
+      def stop_adaptor
+
+        stop
+
+      end
+
+      def reload_adaptor
+
+        reload
+
+      end
+      
+      def initialize( root, config, deamon_name )
+        
+        super( root )
+
+        @config = config
+
+        validate_config_adaptor
+      
+      end
+
+      def validate_config_adaptor
+
+        unless @config.nil? or @config[:plugin].nil?
+
+          @config[:plugin] = @root.config.get_plugin_config( @config[:plugin] )
+
+        end
+
+        validate_config
+
+      end
+      
+      def listen( handler, protocol, server )
+        
+        connector( {
+          
+          :handler  => handler,
+          :protocol => protocol
+          
+        } ) do |connected_handler|
+
+            #
+            # A newly connected Handler
+            #
+
+            connected_handler.assign( {
+
+              :root    => @root,
+              :handler => handler,
+              :protocol => protocol,
+              :server => server
+              
+            } )
+            
+            connected_handler.start_handler
+            
+        end
+
+      end
+    
+    end
+  
+  end
+  
+end

data/lib/langrove/adaptor/base.rb

@@ -1,2 +1,12 @@
-module LanGrove::Adaptor; end
-require 'langrove/adaptor_base'
+module LanGrove
+
+  module Adaptor
+
+  end
+
+end
+
+require 'langrove/adaptor/adaptor_base'
+
+require 'langrove/adaptor/event_machine_adaptor'
+require 'langrove/adaptor/query_adaptor'

data/lib/langrove/adaptor/default.rb

@@ -0,0 +1,8 @@
+require 'langrove/adaptor/base'
+
+LanGrove::Adaptor::Default = LanGrove::Adaptor::EventMachineAdaptor
+
+#
+# Base does not define the adaptor.connect() method.
+# Default to EventMachines socket listener.
+#