servitude 0.1.0 → 0.2.0

data/examples/5_echo_server_with_cli_daemon_and_env_config

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'servitude'
+require 'socket'
+require 'trollop'
+require 'pry'
+
+# The echo server accepts with CLI builds on the 2_echo_server example, addiing a command line interface.
+#
+# Note: Due to TcpServer#accept's implementation, the server is not currently gracefully shutting down as the trap of INT
+# appears to never happen.
+#
+# The CLI has 4 sub-commands: start, stop, status and restart.
+#
+# Using the -i of --interactive switch on the start command will run the server attached in the terminal you execute the command
+# in.  Without the interactive switch, the server will run as a daemon.  The start, stop, and status commands are used to control
+# the daemonized process.  If run in daemon mode, you can tail the log:
+#
+# $ tail -f tmp/echo-server.log
+#
+# Usage:
+#   Help:
+#     bundle exec examples/5_echo_server_with_cli_daemon_and_env_config -h
+#
+#   Start (interactive):
+#     bundle exec examples/5_echo_server_with_cli_daemon_and_env_config start -i
+#
+#   Notice the line in the log just under the start banner that states: (Resolved for env production) key2: value3.  This is because
+#   The config file has an environment key in it with the value production.  Start the server again overridin ghte environemnt on the cammand
+#   line:
+#     bundle exec examples/5_echo_server_with_cli_daemon_and_env_config start -i -d development
+#
+#   Notice the line in the log just under the start banner that states: (Resolved for env development) key2: value2.  The environment was 
+#   successfully overridden on the caommand line and the value for key2 changed accordingly.
+#
+#   Then use telnet to exercise the server:
+#   $ telnet localhost 1234
+#   Hello World!
+#   You said: Hello World!
+#   Connection closed by foreign host.
+#
+module EchoServer
+
+  include Servitude::Base
+
+  APP_FOLDER = 'echo-server'
+  VERSION    = '1.0.0'
+
+  PROJECT_ROOT = File.expand_path( '../..', __FILE__ )
+  
+  boot host_namespace: EchoServer,
+       app_id: 'echo-server-with-cli-and-env-config',
+       app_name: 'Echo Server With CLI And Env Config',
+       company: 'LFE',
+       use_config: true,
+       default_config_path: "#{PROJECT_ROOT}/config/5.conf",
+       default_log_path: "#{PROJECT_ROOT}/tmp/#{APP_FOLDER}.log",
+       default_pid_path: "#{PROJECT_ROOT}/tmp/#{APP_FOLDER}.pid",
+       default_thread_count: nil,
+       version_copyright: "v#{VERSION} \u00A9#{Time.now.year} LFE"
+
+  class Cli
+
+    include Servitude::Cli
+
+  end
+
+  class Server
+
+    include Servitude::Server
+
+    after_initialize do
+      @tcp_server = TCPServer.open( 'localhost', '1234' )
+    end
+
+    before_run do
+      info "(Resolved for env #{config.environment}) key2: #{config.for_env.key2}"
+    end
+
+    finalize do
+      info 'Shutting down ...'
+    end
+
+    def run
+      while client = tcp_server.accept
+        line = client.gets
+        info "Received '#{line.strip}'"
+        response = "You said: #{line.strip}"
+        client.puts response 
+        info "Responded with '#{response}'"
+        info "Closing connection"
+        client.close
+      end
+    end
+
+  protected
+
+    def configuration_class
+      Servitude::EnvironmentConfiguration
+    end
+
+    def config_filters
+      %w(threads)
+    end
+
+  private
+
+    attr_reader :tcp_server
+
+  end
+end
+
+EchoServer::Cli.new( ARGV ).run

data/lib/servitude.rb

@@ -3,16 +3,19 @@ require 'rainbow'
 
 module Servitude
 
-  autoload :Actor,            'servitude/actor'
-  autoload :Base,             'servitude/base'
-  autoload :Cli,              'servitude/cli'
-  autoload :Configuration,    'servitude/configuration'
-  autoload :Daemon,           'servitude/daemon'
-  autoload :Logging,          'servitude/logging'
-  autoload :ServerLogging,    'servitude/server_logging'
-  autoload :Server,           'servitude/server'
-  autoload :ServerThreaded,   'servitude/server_threaded'
-  autoload :SupervisionError, 'servitude/supervision_error'
+  autoload :Actor,                    'servitude/actor'
+  autoload :Base,                     'servitude/base'
+  autoload :Cli,                      'servitude/cli'
+  autoload :ConfigHelper,             'servitude/config_helper'
+  autoload :Configuration,            'servitude/configuration'
+  autoload :Daemon,                   'servitude/daemon'
+  autoload :EnvironmentConfiguration, 'servitude/environment_configuration'
+  autoload :Logging,                  'servitude/logging'
+  autoload :PrettyPrint,              'servitude/pretty_print'
+  autoload :ServerLogging,            'servitude/server_logging'
+  autoload :Server,                   'servitude/server'
+  autoload :ServerThreaded,           'servitude/server_threaded'
+  autoload :SupervisionError,         'servitude/supervision_error'
 
   INT  = "INT"
   TERM = "TERM"

data/lib/servitude/base.rb

@@ -14,15 +14,16 @@ module Servitude
 
     module ClassMethods
 
-      def boot( host_namespace:,
-                app_id:,
-                app_name:,
-                company:,
-                default_config_path:,
-                default_log_path:,
-                default_pid_path:,
-                default_thread_count:,
-                version_copyright:)
+      def boot( host_namespace: raise(ArgumentError, 'host_namespace keyword is required'),
+                app_id: raise(ArgumentError, 'app_id keyword is required'),
+                app_name: raise(ArgumentError, 'app_name keyword is required'),
+                company: raise(ArgumentError, 'company keyword is required'),
+                use_config: raise(ArgumentError, 'use_config keyword is required'),
+                default_config_path: raise(ArgumentError, 'default_config_path keyword is required'),
+                default_log_path: raise(ArgumentError, 'default_log_path keyword is required'),
+                default_pid_path: raise(ArgumentError, 'default_pid_path keyword is required'),
+                default_thread_count: raise(ArgumentError, 'default_thread_count keyword is required'),
+                version_copyright: raise(ArgumentError, 'version_copyright keyword is required') )
         Servitude::const_set :NS, host_namespace
 
         const_set :APP_ID, app_id
@@ -32,13 +33,14 @@ module Servitude
         const_set :DEFAULT_LOG_PATH, default_log_path
         const_set :DEFAULT_PID_PATH, default_pid_path
         const_set :DEFAULT_THREAD_COUNT, default_thread_count
+        const_set :USE_CONFIG, use_config
         const_set :VERSION_COPYRIGHT, version_copyright
 
         Servitude::boot_called = true
       end
 
       def configuration
-        @configuration ||= Servitude::NS::Configuration.new
+        @configuration
       end
 
       def configuration=( configuration )

data/lib/servitude/cli.rb

@@ -52,6 +52,7 @@ options:
         when "restart"
           Trollop::options do
             opt :config, "The path for the config file", :type => String, :short => '-c', :default => Servitude::NS::DEFAULT_CONFIG_PATH
+            opt :environment, "The log level", :type => String, :short => '-e'
             opt :log_level, "The log level", :type => String, :default => 'info', :short => '-o'
             opt :log, "The path for the log file", :type => String, :short => '-l', :default => Servitude::NS::DEFAULT_LOG_PATH
             opt :pid, "The path for the PID file", :type => String, :default => Servitude::NS::DEFAULT_PID_PATH
@@ -60,6 +61,7 @@ options:
         when "start"
           Trollop::options do
             opt :config, "The path for the config file", :type => String, :short => '-c', :default => Servitude::NS::DEFAULT_CONFIG_PATH
+            opt :environment, "The log level", :type => String, :short => '-e'
             opt :interactive, "Execute the server in interactive mode", :short => '-i'
             opt :log_level, "The log level", :type => String, :default => 'info', :short => '-o'
             opt :log, "The path for the log file", :type => String, :short => '-l', :default => Servitude::NS::DEFAULT_LOG_PATH
@@ -91,9 +93,6 @@ options:
       end
     end
 
-    def self.commands( &block )
-    end
-
     def run
       send( cmd )
     end
@@ -109,17 +108,17 @@ options:
     end
 
     def start_interactive
-      server = Servitude::NS::Server.new( options.merge( log: nil ))
+      server = Servitude::NS::Server.new( options.merge( use_config: Servitude::NS::USE_CONFIG, log: 'STDOUT' ))
       server.start
     end
 
     def start_daemon
-      server = Servitude::Daemon.new( options )
+      server = Servitude::Daemon.new( options.merge( use_config: Servitude::NS::USE_CONFIG ))
       server.start
     end
 
     def stop
-      server = Servitude::Daemon.new( options )
+      server = Servitude::Daemon.new( options.merge( use_config: Servitude::NS::USE_CONFIG ))
       server.stop
     end
 
@@ -129,7 +128,7 @@ options:
     end
 
     def status
-      Servitude::Daemon.new( options ).status
+      Servitude::Daemon.new( options.merge( use_config: Servitude::NS::USE_CONFIG )).status
     end
 
   end

data/lib/servitude/config_helper.rb

@@ -0,0 +1,11 @@
+require 'celluloid/autostart'
+
+module Servitude
+  module ConfigHelper
+
+    def config
+      Servitude::NS::configuration
+    end
+
+  end
+end

data/lib/servitude/configuration.rb

@@ -1,58 +1,34 @@
-module Servitude
-  module Configuration
-
-    def self.included( base )
-      base.extend ClassMethods
-
-      base.class_eval do
-        class << self
-          attr_accessor :attributes,
-                        :configured
-        end
-      end
-    end
-
-    module ClassMethods
-
-      def configurations( *attrs )
-        raise 'Already configured: cannot call configurations more than once' if self.configured
+require 'delegate'
+require 'hashie'
+require 'oj'
 
-        self.attributes = attrs.map { |attr| Array( attr ).first.to_s }
-
-        class_eval do
-          attr_accessor( *self.attributes )
-        end
-
-        attrs.select { |attr| attr.is_a?( Array ) }.
-              each do |k, v|
-
-          define_method k do
-            instance_variable_get( "@#{k}" ) ||
-              instance_variable_set( "@#{k}", v )
-          end
+module Servitude
+  class Configuration < SimpleDelegator
 
-        end
+    def initialize( options={} )
+      options.reject! { |k,v| v.nil? }
 
-        self.configured = true
+      if options[:use_config]
+        @_config = Hashie::Mash.new( file_options( options[:config] ))
+        _config.merge!( options )
+      else
+        @_config = Hashie::Mash.new( options )
       end
 
-      def from_file( file_path )
-        unless File.exists?( file_path )
-          raise "Configuration file #{file_path} does not exist"
-        end
+      super _config
+    end
 
-        options = Oj.load( File.read( file_path ))
-        Servitude::NS::configuration = Servitude::NS::Configuration.new
+  protected
 
-        attributes.each do |c|
-          if options[c]
-            Servitude::NS::configuration.send( :"#{c}=", options[c] )
-          end
-        end
+    attr_reader :_config
 
-        options[:config_loaded] = true
+    def file_options( file_path )
+      unless File.exists?( file_path )
+        raise "Configuration file #{file_path} does not exist"
       end
 
+      Oj.load( File.read( file_path ))
     end
+
   end
 end

data/lib/servitude/environment_configuration.rb

@@ -0,0 +1,13 @@
+require 'delegate'
+require 'hashie'
+require 'oj'
+
+module Servitude
+  class EnvironmentConfiguration < Servitude::Configuration
+
+    def for_env
+      _config.send( _config.environment )
+    end
+
+  end
+end

data/lib/servitude/pretty_print.rb

@@ -0,0 +1,36 @@
+require 'pry'
+module Servitude
+  module PrettyPrint
+
+    def self.configuration_lines( config, pre='', filters=[] )
+      return [] if config.nil? || config.empty?
+
+      formatted = format_configuration( config )
+
+      formatted.map do |line_parts|
+        if !filters.nil? && !filters.empty? && filters.include?( line_parts.first )
+          nil
+        else
+          [pre, line_parts.join( ': ' )].join
+        end
+      end.reject( &:nil? )
+    end
+
+    def self.format_configuration( config, path=[], result=[] )
+      config.each do |element|
+        key, value = *element
+        cur_path = path + [key]
+        if value.is_a?( Hash )
+          format_configuration( value, cur_path, result )
+        elsif value.is_a?( Array )
+          result << [cur_path.map( &:to_s ).join( '.' ), value.inspect]
+        else
+          result << [cur_path.map( &:to_s ).join( '.' ), value]
+        end
+      end
+
+      result
+    end
+
+  end
+end

data/lib/servitude/server.rb

@@ -6,38 +6,42 @@ module Servitude
 
     def self.included( base )
       base.class_eval do
+        include ConfigHelper
         include Logging
         include ServerLogging
         include Hooks
 
         define_hook :after_initialize,
                     :before_initialize,
+                    :before_run,
                     :before_sleep,
                     :finalize
 
-        attr_reader :options
+        attr_reader :cli_options
       end
     end
 
-    def initialize( options={} )
+    def initialize( cli_options={} )
       unless Servitude.boot_called
         raise 'You must call boot before starting server'
       end
 
-      @options = options
+      @cli_options = cli_options
 
       run_hook :before_initialize
+      initialize_config
       initialize_loggers
       run_hook :after_initialize
     end
 
     def start
       log_startup
-      run
 
       trap( INT )  { stop }
       trap( TERM ) { stop }
 
+      run_hook :before_run
+      run
       run_hook :before_sleep
       sleep
     end
@@ -48,6 +52,14 @@ module Servitude
       raise NotImplementedError
     end
 
+    def initialize_config
+      Servitude::NS::configuration = configuration_class.new( cli_options )
+    end
+
+    def configuration_class
+      Servitude::Configuration
+    end
+
   private
 
     def finalize