carioca 1.4 → 2.0.1

data/lib/carioca/private.rb

@@ -1,168 +0,0 @@
-# coding: utf-8
-#---
-# Author : Romain GEORGES
-# type : gem component library
-# obj : Carioca Private Module (mixin for Carioca::Services::Registry)
-#---
-
-# private methods to mixin  Carioca::Services::Registry
-# @private
-module PrivateMethodsCariocaServicesRegistry
-
-
-  # private initializer
-  def initialize(_options)
-    @logger_not_in_reg = false
-    @debug = _options[:debug]
-    @registry_filename = _options[:file]
-    @name = _options[:name]
-    @list  = Hash::new
-    load if File::exist?(@registry_filename)
-    unless @list.include?('logger') then
-      self.register_service({:name => 'logger',
-                              :service => 'Carioca::Services::InternalLogger',
-                              :resource => 'logger',
-                              :description => "The standard ruby Logger internal wrapper Service",
-                              :type => :builtin,
-                              :init_options => { :target => "/tmp/log.file"}})
-      @logger_not_in_reg = true
-    end
-    @loaded_services = Hash::new
-    # preload logger service
-    @log = self.start_service :name => 'logger'
-    @log.level =(@debug)? Logger::DEBUG : Logger::INFO
-    @log.debug('Carioca') { "Registry started, service logger preloaded" }
-    @log.debug('Carioca') { "Logger registered, not in configured registry" } if @logger_not_in_reg
-  end
-
-  # verify dependancies in services structure
-  # in @list from a service defition
-  # in _options and start it if needed
-  def verify_requires_dependancies(_options)
-    _name = _options[:shortname]
-    if @list[_name].include?(:requires) then
-      @list[_name][:requires].each do |service|
-        raise RegistryError::new 'Missing Required depedancy #{service}' unless @list.keys.include? service
-        unless @loaded_services.include?(service) then
-          @log.debug('Carioca') { "Registry dependancy found and not loaded : #{service}" }
-          restart_service :name => service
-        end
-      end
-    end
-  end
-
-  # require file for a service
-  # from a service definition in _options
-  def require_service(_options)
-    _name = _options[:shortname]
-    sym = ":#{@list[_name][:service].split('::').last}"
-    case @list[_name][:type]
-    when :file then
-      require @list[_name][:resource]
-    when :builtin then
-      _file = Carioca::Services::search_builtins _name
-      if _file then
-        require _file
-      else
-        raise RegistryError::new("Config failed")
-      end
-    when :gem then
-      require @list[_name][:resource]
-    when :gem_file then
-      (_name,_file) = @list[_name][:resource].split(':')
-      _dfile = Carioca::Services::search_file_in_gem _name,_file
-      if _dfile then
-        require _dfile
-      else
-        raise RegistryError::new("Config failed")
-      end
-    else
-      raise RegistryError::new("Config failed")
-    end
-  end
-
-
-  # scan for <service>_<instance> and rewrite options with :name and :shortname, :instance
-  def scan_instance_suffix(options)
-    if options[:name] =~ /.*_.*/ then
-      (options[:shortname],options[:instance]) = options[:name].split(/_/)
-    else
-      options[:shortname] = options[:name]
-    end
-    return options
-  end
-
-  #shutdown ring server if empty
-  def shutdown_ring_if_empty
-    get_ring if @ring_server.nil?
-    if @ring_server.list_services.empty? then
-      @log.debug('Carioca') { "Stopping Ultragreen Ring server if no distributed services found" }
-      @dorsal_controller.stop_ring_server
-    end
-  end
-
-  # run a ring servier instance or get existing
-  def get_ring
-    @dorsal_controller = start_service :name => 'dorsal'
-    @ring_server = @dorsal_controller.bind_to_ring
-    if @ring_server.nil? then
-      @dorsal_controller.start_ring_server
-      @ring_server = @dorsal_controller.bind_to_ring
-      @log.debug('Carioca') { "Starting new Ring Server" } if @log
-    else
-      @log.debug('Carioca') { "Getting already started Ring Server" } if @log
-    end
-  end
-
-  # instanciate Object from class defintion of a service defined in
-  # the service definition in _opts
-  def instanciate_service(_opts)
-    _name = _opts[:shortname]
-    dist = (@list[_name][:distributed].nil?)? false : @list[_name][:distributed]
-    get_ring if dist
-    @list[_name][:init_options].merge! _opts[:params] unless _opts[:params].nil?
-    @obj = Object::new
-    if @list[_name][:init_options].nil? then
-      eval("@obj = #{@list[_name][:service]}::new")
-    else
-      eval("@obj = #{@list[_name][:service]}::new(@list[_name][:init_options])")
-    end
-    if dist then
-      @ring_server.start_service({ :name => _opts[:name], :object => @obj, :description => @list[_name][:description], :owner => @name })
-      @loaded_services[_opts[:name]] = @ring_server.bind_to_service :name => _opts[:name]
-    else
-      @loaded_services[_opts[:name]] = @obj
-    end
-    return @loaded_services[_opts[:name]]
-  end
-
-  # call the garbage method of a service if exist and
-  # Delete from the loaded services list
-  def kill_service(options)
-    @log.debug('Carioca') { "Service #{options[:name]} stopped" } if @log
-    @loaded_services[options[:name]].garbage if @loaded_services[options[:name]].respond_to? :garbage
-    @loaded_services.delete(options[:name])
-    return true
-  end
-
-  def kill_distributed_service(options)
-    preserve = (options[:preserve].nil?)? false : options[:preserve]
-    get_ring if @ring_server.nil?
-    if @ring_server.list_services.include?(options[:name]) then
-      if options[:preserve] and  @ring_server.list_services[options[:name]][:owner] != @name then
-        @log.debug('Carioca') { "Unlinking distributed Service #{options[:name]} owned by #{@name}." } if @log
-      else
-        @ring_server.destroy_service :name => options[:name]
-        @log.debug('Carioca') { "Killing distributed Service #{options[:name]}." } if @log
-      end
-      @loaded_services.delete(options[:name])
-      shutdown_ring_if_empty
-      return true
-    else
-      @log.debug('Carioca') { "Distributed service #{options[:name]} not in ring" } if @log
-      return false
-    end
-  end
-
-
-end # end of PrivateMethodsCariocaServicesRegistry

data/lib/carioca/services/configuration.rb

@@ -1,203 +0,0 @@
-# coding: utf-8
-# $BUILTIN
-# $NAME configuration
-# $SERVICE Carioca::Services::Configuration
-# $RESOURCE configuration
-# $DESCRIPTION The Carioca Configuration Service
-# $INIT_OPTIONS config_file => ./.config
-
-# Copyright Ultragreen (c) 2005
-#---
-# Author : Romain GEORGES
-# type : class definition Ruby
-# obj : Generic config library
-#---
-# $Id$
-
-
-require 'rubygems'
-require 'methodic'
-require_relative '../services'
-require 'yaml'
-require 'drb/drb'
-require 'xmlsimple'
-require 'active_support/all'
-
-# overwriting Hash class
-# @private
-class Hash
-
-  # recursively transform Hash keys form String to Symbols
-  # come from Rails code
-  # exist in Ruby 2.0
-  def deep_symbolize
-    target = dup
-    target.inject({}) do |memo, (key, value)|
-      value = value.deep_symbolize if value.is_a?(Hash)
-      memo[key.to_sym] = value
-      memo
-    end
-  end
-
-  # pretty accessor for hash record
-  # like ahash[:key] => ahash.key
-  # r/w accessor
-  def method_missing(name, *args, &block)
-    if name.to_s =~ /(.+)=$/
-      self[$1.to_sym] = args.first
-    else
-      self[name.to_sym]
-    end
-  end
-end
-
-
-
-
-
-module Carioca
-
-  module Services
-
-    # settings Hash record utilities class
-    # @note please do not use Standalone ( dependancy of Configuration class )
-    # @private
-    class Settings < Hash
-
-
-      # the name of the config file in YAML format
-      attr_accessor :config_file
-
-      # constructor  (pre-open the config file in default:YAML)
-      # @param [Hash] options the options records
-      # @option options [String] :config_file (REQUIRED) the name of the config file
-      # @option options [String] :context a context (root) name to bind in YAML Structure
-      # @option options [String] :content a string (xml or yaml) content for configuration
-      # @option options [String] :xml_input a boolean if you want load and save in XML
-      def initialize(options = {})
-        @config_file = options[:config_file]
-        @xml_input = options[:xml_input]
-        @content  = options[:content]
-        @force_array =  options[:force_array]
-        newsets = {}
-        if @config_file then
-          @content = File::readlines(@config_file).join if File::exist?(@config_file)
-        end
-        if options[:xml_input] then
-          newsets = XmlSimple.xml_in( @content, {
-                                        'ForceArray' => @force_array,
-                                        'KeepRoot' => true,
-                                      }).deep_symbolize_keys
-        else
-          newsets = YAML::load(@content).deep_symbolize_keys
-        end
-        newsets = newsets[options[:context].to_sym] if options[:context] && newsets[options[:context].to_sym]
-        deep_merge!(self, newsets)
-      end
-
-      # save the Hash(self) in the file named by @config_file
-      # @return [TrueClass,FalseClass] true if save! successfull
-      # @note TODO save in XML format
-      def save!
-        res = false
-        File.open(@config_file, "w") do |f|
-          res = true if f.write(self.to_yaml)
-        end
-        return res
-      end
-
-
-      private
-      # full recursive merger for hash
-      def deep_merge!(target, data)
-        merger = proc{|key, v1, v2|
-          Settings === v1 && Settings === v2 ? v1.merge(v2, &merger) : v2 }
-        target.merge! data, &merger
-      end
-
-
-    end
-
-
-
-
-    # Service Configuration of Carioca
-    class Configuration
-
-      include DRb::DRbUndumped
-
-      # @example
-      #   config = Carioca::Services::Configuration::new :config_file => 'afilename', :context => 'production'
-      #   p config.config_file
-      #   config_file = 'newfilename'
-      # @attr_reader [String] the filename of the YAML struct
-      attr_accessor :settings
-
-
-      # Configuration service constructor (open config)
-      # @param [Hash] _options the params
-      # @option _options [String] :config_file the filename of the config
-      def initialize(_opts = {})
-
-
-        options = Methodic.get_options(_opts)
-        options.specify_default_value :config_file => "./.config"
-        options.merge
-        @settings = Carioca::Services::Settings.new(options)
-      end
-
-      # Proxy to @settings.save!
-      #  save the Hash(self) in the file named by @config_file
-      # @return [TrueClass,FalseClass] true if save! successfull
-      # @example usage
-      #   config = Carioca::Services::Configuration::new :config_file => 'afilename', :context => 'production'
-      #   config.config_file = 'newfile'
-      #   config.save!
-      def save!
-        @settings.save!
-      end
-
-
-      # reading wrapper to @settings.config_file accessor
-      # @return [String] @config_file the file name
-      # @example usage
-      #   config = Carioca::Services::Configuration::new :config_file => 'afilename', :context => 'production'
-      #   p config.config_file
-      def config_file
-        @settings.config_file
-      end
-
-      # writting wrapper to @settings.config_file accessor
-      # @param [String] name the file name
-      # @example usage
-      #   config = Carioca::Services::Configuration::new :config_file => 'afilename', :context => 'production'
-      #   config.config_file = 'newfile'
-      def config_file=(name)
-        @settings.config_file = name
-      end
-
-
-      # garbage service hook
-      # @note close the logger
-      # @note call by Carioca::Services::Registry#close
-      def garbage
-        @settings = nil
-        return true
-      end
-
-    end
-  end
-end
-
-
-
-
-
-# interactive hacks
-if $0 == __FILE__ then
-  conf =Carioca::Services::Configuration::new :config_file => 'spec/config/.config'
-  p conf
-  puts "#{File::basename(__FILE__)}:"
-  puts 'this is a RUBY library file'
-  puts "Copyright (c) Ultragreen"
-end

data/lib/carioca/services/debug.rb

@@ -1,71 +0,0 @@
-# coding: utf-8
-# $BUILTIN
-# $NAME debug
-# $SERVICE Carioca::Services::ProxyDebug
-# $RESOURCE debug
-# $DESCRIPTION Proxy class debugger Service for Carioca
-# Copyright Ultragreen (c) 2012
-#---
-# Author : Romain GEORGES
-# type : class definition Ruby
-# obj : Generic Debugs tools library
-#---
-
-
-require 'rubygems'
-require 'methodic'
-
-
-module Carioca
-  module Services
-
-
-    # Service Debug of Carioca
-    # Proxy Class Debug for devs
-    class ProxyDebug
-
-      # ProxyDebug service constructor (has a class proxy => so a service proxy)
-      # @param [Hash] _options the params
-      # @option _options [String] :service the name of the service you want to proxyfying
-      # @option _options [Hash] :params the params of the proxyfied service
-      def initialize(_options)
-        options = Methodic.get_options(_options)
-        options.specify_classes_of :service => String
-        options.specify_presence_of([:service])
-        options.validate!
-        if options[:params] then
-          @obj = Registry.init.start_service :name  => options[:service], :params => options[:params]
-        else
-          @obj = Registry.init.start_service :name  => options[:service]
-        end
-        @log  = Registry.init.get_service :name => 'logger'
-        @mapped_service = options[:service]
-      end
-
-      # method_missing overload to make the class proxy efficient
-      def method_missing(methodname, *args,&block)
-        @log.debug("ProxyDebug") { "BEGIN CALL for mapped service #{@mapped_service} "}
-        @log.debug("ProxyDebug") { "called: #{methodname} " }
-        @log.debug("ProxyDebug") { "args : #{args.join " "}" }
-        if block_given? then
-          @log.debug("ProxyDebug") { "block given" }
-          a = @obj.send(methodname, *args,&block)
-        else
-          a = @obj.send(methodname, *args)
-        end
-        @log.debug("ProxyDebug") { "=> returned: #{a} " }
-        @log.debug("ProxyDebug") { 'END CALL' }
-        return a
-      end
-
-
-    end
-  end
-end
-
-# protection for loading libs
-if $0 == __FILE__ then
-  puts "#{File::basename(__FILE__)}:"
-  puts 'this is a RUBY library file'
-  puts "Copyright (c) Ultragreen"
-end

data/lib/carioca/services/logger.rb

@@ -1,58 +0,0 @@
-# coding: utf-8
-# $BUILTIN
-# $NAME logger
-# $SERVICE Carioca::Services::InternalLogger
-# $RESOURCE logger
-# $DESCRIPTION The standard ruby Logger internal wrapper Service for Carioca
-# $INIT_OPTIONS target => /tmp/log.file
-# Copyright Ultragreen (c) 2005
-#---
-# Author : Romain GEORGES
-# type : class definition Ruby
-# obj : Generic config library
-#---
-# $Id$
-
-require 'rubygems'
-require 'logger'
-require 'methodic'
-
-module Carioca
-  module Services
-
-    # Service Logger (InternalLogger) of Carioca,
-    # @note integrally based on Logger from logger Gem
-    class InternalLogger < Logger
-
-      private
-
-      # logger service constructor (open log)
-      # @param [Hash] _options the params
-      # @option _options [String] :target the filename where to log
-      def initialize(_options = {})
-        options = Methodic.get_options(_options)
-        options.specify_default_value :target => STDOUT
-        options.merge
-        super(options[:target])
-      end
-
-      # garbage service hook
-      # @note close the logger
-      def garbage
-        self.close
-      end
-
-    end
-  end
-
-
-
-end
-
-
-# interactive hacks
-if $0 == __FILE__ then
-  puts "#{File::basename(__FILE__)}:"
-  puts 'this is a RUBY library file'
-  puts "Copyright (c) Ultragreen"
-end

data/lib/carioca/services.rb

@@ -1,143 +0,0 @@
-# coding: utf-8
-#---
-# Author : Romain GEORGES
-# type : gem component library
-# obj : Carioca::Services Module
-#---
-
-
-
-module Carioca
-
-  # namespace Services for Registry AND buitlins
-  module  Services
-    # class method returning full path in Carioca gem for builtin services files according to installed gem path.
-    # @note do not use directly for generale purpose (expert/hacks only)
-    # @param [String] _name the name of a service
-    # @return [String,false] the full path filename orfalse if not found
-    def Services::search_builtins(_name)
-      if Gem::Specification.respond_to?(:find_by_name)
-        begin
-        spec = Gem::Specification.find_by_name('carioca')
-        rescue LoadError
-          spec = nil
-        end
-      else
-        spec = Gem.searcher.find('carioca')
-    end
-      if spec then
-        if Gem::Specification.respond_to?(:find_by_name)
-
-          res = spec.lib_dirs_glob.split('/')
-        else
-          res = Gem.searcher.lib_dirs_for(spec).split('/')
-        end
-        res.pop
-        services_path = res.join('/').concat('/lib/carioca/services')
-      else
-        services_path = "./lib/carioca/services"
-      end
-      _file ="#{services_path}/#{_name}.rb"
-      if ( File::exist? _file or File::exist? "lib/#{_file}" ) then
-        return _file
-      else
-        return false
-      end
-    end
-
-    # class method returning the path of a file in gem if exist or false
-    # @note do not use directly for generale purpose (expert/hacks only)
-    # @return [String|FalseClass] the full path of a service file
-    def Services::search_file_in_gem(_gem,_file)
-      if Gem::Specification.respond_to?(:find_by_name)
-        begin
-        spec = Gem::Specification.find_by_name(_gem)
-        rescue LoadError
-          spec = nil
-        end
-      else
-        spec = Gem.searcher.find(_gem)
-      end
-      if spec then
-        if Gem::Specification.respond_to?(:find_by_name)
-          res = spec.lib_dirs_glob.split('/')
-        else
-          res = Gem.searcher.lib_dirs_for(spec).split('/')
-        end
-        res.pop
-        services_path = res.join('/').concat("/#{_file}")
-        return services_path if File::exist?(services_path)
-        return false
-      else
-        return false
-      end
-    end
-
-
-    # class method returning the [Carioca::Services::Registry]@list complement for builtins service found for a carioca gem version
-    # @note do not use directly for generale purpose (expert/hacks only)
-    # @return [Hash] the [Carioca::Services::Registry]@list complement
-    def Services::discover_builtins
-      if Gem::Specification.respond_to?(:find_by_name)
-        begin
-          spec = Gem::Specification.find_by_name('carioca')
-        rescue LoadError
-          spec = nil
-        end
-      else
-        spec = Gem.searcher.find('carioca')
-      end
-
-      if spec then
-        if Gem::Specification.respond_to?(:find_by_name)
-          res = spec.lib_dirs_glob.split('/')
-        else
-          res = Gem.searcher.lib_dirs_for(spec).split('/')
-        end
-        res.pop
-        services_path = res.join('/').concat('/lib/carioca/services')
-      else
-        services_path = "./lib/carioca/services"
-      end
-
-      map = Dir["#{services_path}/*"]
-      map.delete_if { |item| not File::file?(item) }
-      map.delete_if { |item| File::basename(item) == 'logger.rb' }
-
-      res = {}
-      map.each do |file|
-        Services::validate_service(file,res)
-      end
-      return res
-    end
-
-    def Services::validate_service(file,res)
-        init_options =  {}
-        if open(file).grep(/^# \$BUILTIN/).size > 0 then
-          service = open(file).grep(/# \$SERVICE/).first.split[2]
-          resource = open(file).grep(/# \$RESOURCE/).first.split[2]
-          desc = open(file).grep(/# \$DESCRIPTION/).first
-          desc = desc.split(' ')
-          desc.shift(2)
-          description= desc.join(' ')
-          open(file).grep(/# \$INIT_OPTIONS/).each do |opt|
-            prev = opt.split
-            init_options[prev[2].to_sym] = prev[4]
-          end
-          distributed = (open(file).grep(/# \$DISTRIBUTED/))? true : false
-          req = open(file).grep(/# \$REQUIRES/)
-          if req.empty? then
-            requires = []
-          else
-            requires = req.split
-            requires.shift
-          end
-
-        end
-        unless service.nil? or resource.nil? or description.nil? then
-          res[resource] = { :service => service, :type => :builtin, :description => description, :resource => resource}
-          res[resource][:init_options] = init_options unless init_options.empty?
-        end
-    end
-  end
-end

data/lib/carioca/tasks/registry_init.rake

@@ -1,12 +0,0 @@
-# coding: utf-8
-require 'carioca'
-namespace :carioca  do
-  desc "initialize Carioca Registry"
-  task :init_registry do
-    mkdir 'services'
-    carioca = Carioca::Services::Registry.init :name => 'services/registry.yml', :debug => true
-    carioca.discover_builtins
-    carioca.save!
-    puts "Carioca : Registry initialize in services/registry.yml (see /tmp/log.file for details)"
-  end
-end