colloquy 1.0.0

data/lib/colloquy/helpers.rb

@@ -0,0 +1,15 @@
+
+module Colloquy::Helpers
+    require_relative 'helpers/url'
+    require_relative 'helpers/mysql'
+    require_relative 'helpers/redis'
+    require_relative 'helpers/scribe'
+    require_relative 'helpers/settings'
+    
+    include Colloquy::Helpers::Url
+    include Colloquy::Helpers::MySQL
+    include Colloquy::Helpers::Redis
+    include Colloquy::Helpers::Scribe
+    include Colloquy::Helpers::Settings
+end
+  

data/lib/colloquy/helpers/mysql.rb

@@ -0,0 +1,110 @@
+require 'singleton'
+require 'yaml'
+require 'active_support/core_ext/hash'
+
+class Colloquy::MySQLConfigurationNotFoundException < Exception
+end
+
+class Colloquy::MySQLGemsNotFoundException < Exception
+end
+
+class Colloquy::MySQLConnectionNotFoundException < Exception
+end
+
+module Colloquy::Helpers::MySQL
+  def self.included(klass)
+    klass.class_eval do
+      include InstanceMethods
+    end
+  end
+  
+  class MySQLProxy
+    DEFAULT_OPTIONS = { :host => "localhost", :port => 3306, :socket => "/tmp/mysql.sock", :username => "root", :password => "", :reconnect => true, :pool => 5}
+    
+    include Singleton
+    
+    def initialize
+      @configured = false
+    end
+    
+    def configure
+      return if configured?
+      configure!
+    end
+    
+    def configure!
+      unless mysql_configuration_file.exist?
+        raise Colloquy::MySQLConfigurationNotFoundException, "Cannot find #{mysql_configuration_file}"
+      end
+
+      begin
+        require_mysql_libraries
+      rescue LoadError
+        raise Colloquy::MySQLGemsNotFoundException, "Cannot load the mysql2 gem."
+      end    
+
+      @mysql_db_connections ||= {}
+      mysql_configuration_load
+      
+      @configured = true
+    end
+    
+    def configured?
+      @configured
+    end
+    
+    def require_mysql_libraries
+      require "em-synchrony/mysql2"
+    end
+    
+    def [](identifier)
+      unless @mysql_db_connections[identifier.to_sym]
+        raise Colloquy::MySQLConnectionNotFoundException, "A connection for #{identifier} was not found, did you mis-spell or forget to configure it?"
+      end
+            
+      @mysql_db_connections[identifier.to_sym]
+    end
+    
+    def configuration
+      @mysql_configuration_entries
+    end
+    
+    private
+    
+    def mysql_configuration_file
+      Colloquy.root.join('config', 'mysql.yaml')
+    end
+
+    def mysql_configuration_load
+      return unless mysql_configuration_exists?
+
+      @mysql_configuration_entries = File.open(mysql_configuration_file, "r") { |f| YAML.load(f.read) }
+      @mysql_configuration_entries.to_options!
+      
+      if @mysql_configuration_entries
+        @mysql_configuration_entries.each do |identifier, params|
+          params.to_options!.merge!(DEFAULT_OPTIONS) { |key, v1, v2| v1 }
+          @mysql_db_connections[identifier.to_sym] = mysql_connection(params)
+        end
+      else
+        raise Colloquy::MySQLConfigurationNotFoundException, "Cannot find configuration in #{mysql_configuration_file}. Is it empty?"
+      end
+    end
+    
+    def mysql_connection(params)
+      Mysql2::EM::Client.new(params)
+    end
+
+    def mysql_configuration_exists?
+      mysql_configuration_file.exist?
+    end
+  end
+  
+  module InstanceMethods
+    def mysql
+      MySQLProxy.instance.configure
+      
+      MySQLProxy.instance
+    end
+  end
+end

data/lib/colloquy/helpers/redis.rb

@@ -0,0 +1,103 @@
+require 'singleton'
+require 'yaml'
+
+class Colloquy::RedisConfigurationNotFoundException < Exception
+end
+
+class Colloquy::RedisGemsNotFoundException < Exception
+end
+
+class Colloquy::RedisConnectionNotFoundException < Exception
+end
+
+module Colloquy::Helpers::Redis
+  def self.included(klass)
+    klass.class_eval do
+      include InstanceMethods
+    end
+  end
+  
+  class RedisProxy
+    include Singleton
+    
+    def initialize
+      @configured = false
+    end
+    
+    def configure
+      return if configured?
+      configure!
+    end
+    
+    def configure!
+      unless redis_configuration_file.exist?
+        raise Colloquy::RedisConfigurationNotFoundException, "Cannot find #{redis_configuration_file}"
+      end
+
+      begin
+        require_redis_libraries
+      rescue LoadError
+        raise Colloquy::RedisGemsNotFoundException, "Cannot load the em-redis gem."
+      end    
+
+      @redis_connections ||= {}
+      redis_configuration_load
+      
+      @configured = true
+    end
+    
+    def configured?
+      @configured
+    end
+    
+    def require_redis_libraries
+      require "em-redis"
+      require "em-synchrony"
+      require "em-synchrony/em-redis"
+    end
+    
+    def [](identifier)
+      unless @redis_connections[identifier.to_sym]
+        raise Colloquy::RedisConnectionNotFoundException, "A Redis connection for #{identifier} was not found, did you mis-spell or forget to configure it?"
+      end
+            
+      @redis_connections[identifier.to_sym]
+    end
+    
+    private
+    
+    def redis_configuration_file
+      Colloquy.root.join('config', 'redis.yaml')
+    end
+
+    def redis_configuration_load
+      return unless redis_configuration_exists?
+
+      redis_configuration = File.open(redis_configuration_file, "r") { |f| YAML.load(f.read) }
+      
+      if redis_configuration
+        redis_configuration.each do |identifier, params|
+          @redis_connections[identifier.to_sym] = redis_connection(params.to_options)
+        end
+      else
+        raise Colloquy::RedisConfigurationNotFoundException, "Cannot find configuration in #{redis_configuration_file}. Is it empty?"
+      end
+    end
+    
+    def redis_connection(params = {})
+      EM::Protocols::Redis.connect(params)
+    end
+
+    def redis_configuration_exists?
+      redis_configuration_file.exist?
+    end
+  end
+  
+  module InstanceMethods
+    def redis
+      RedisProxy.instance.configure
+      
+      RedisProxy.instance
+    end
+  end
+end

data/lib/colloquy/helpers/scribe.rb

@@ -0,0 +1,103 @@
+require 'singleton'
+require 'yaml'
+
+class Colloquy::ScribeConfigurationNotFoundException < Exception
+end
+
+class Colloquy::ScribeGemsNotFoundException < Exception
+end
+
+class Colloquy::ScribeConnectionNotFoundException < Exception
+end
+
+module Colloquy::Helpers::Scribe
+  def self.included(klass)
+    klass.class_eval do
+      include InstanceMethods
+    end
+  end
+
+  class ScribeProxy
+    include Singleton
+
+    def initialize
+      @configured = false
+    end
+
+    def configure
+      return if configured?
+      configure!
+    end
+
+    def configure!
+      unless scribe_configuration_file.exist?
+        raise Colloquy::ScribeConfigurationNotFoundException, "Cannot find #{scribe_configuration_file}"
+      end
+
+      begin
+        require_scribe_libraries
+      rescue LoadError
+        raise Colloquy::ScribeGemsNotFoundException, "Cannot load the scribe gem."
+      end
+
+      @scribe_connections ||= {}
+      scribe_configuration_load
+
+      @configured = true
+    end
+
+    def configured?
+      @configured
+    end
+
+    def connections
+      @scribe_connections
+    end
+
+    def [](identifier)
+      unless @scribe_connections[identifier.to_sym]
+        raise Colloquy::ScribeConnectionNotFoundException, "A connection for #{identifier} was not found, did you mis-spell or forget to configure it?"
+      end
+
+      @scribe_connections[identifier.to_sym]
+    end
+
+    def require_scribe_libraries
+      require 'scribe-logger'
+    end
+
+    def scribe_configuration_file
+      Colloquy.root.join('config', 'scribe.yaml')
+    end
+
+    def scribe_configuration_load
+      return unless scribe_configuration_exists?
+
+      scribe_configuration = File.open(scribe_configuration_file, "r") { |f| YAML.load(f.read) }
+
+      if scribe_configuration
+        scribe_configuration.each do |identifier, params|
+          @scribe_connections[identifier.to_sym] = scribe_connection(params)
+        end
+      else
+        raise Colloquy::ScribeConfigurationNotFoundException, "Cannot find configuration in #{scribe_configuration_file}. Is it empty?"
+      end
+    end
+
+    def scribe_connection(params)
+      Scribe.loggers(params)
+    end
+
+    def scribe_configuration_exists?
+      scribe_configuration_file.exist?
+    end
+  end
+
+  module InstanceMethods
+    def scribe
+      ScribeProxy.instance.configure
+      ScribeProxy.instance
+    end
+  end
+
+end

data/lib/colloquy/helpers/settings.rb

@@ -0,0 +1,111 @@
+require 'singleton'
+require 'yaml'
+
+class Colloquy::SettingsConfigurationNotFoundException < Exception
+end
+
+class Colloquy::SettingsGemsNotFoundException < Exception
+end
+
+module Colloquy::Helpers::Settings
+  def self.included(klass)
+    klass.class_eval do
+      include InstanceMethods
+    end
+  end
+
+  class SettingsProxy
+    include Singleton
+
+    def configure
+      return if configured?
+      configure!
+    end
+
+    def configured?
+      @configured
+    end
+
+    def configure!
+      unless settings_configuration_file.exist?
+        raise Colloquy::SettingsConfigurationNotFoundException, "Cannot find #{settings_configuration_file}"
+      end
+
+      begin
+        require_settings_libraries
+      rescue LoadError
+        raise Colloquy::SettingsGemsNotFoundException, "Cannot load the required settings gems."
+      end
+
+      @settings_configurations ||= {}
+      settings_configuration_load
+
+      @configured = true
+    end
+
+    def settings_configuration_file
+      Colloquy.root.join('config', 'settings.yaml')
+    end
+
+    def require_settings_libraries
+      require "yaml"
+    end
+
+    def settings_configuration_load
+      return unless settings_configuration_exists?
+
+      @settings_configuration_entries = File.open(settings_configuration_file, "r") { |f| YAML.load(f.read) }
+
+      if @settings_configuration_entries
+        @settings_configuration_entries.each do |identifier, params|
+          @settings_configurations[identifier.to_sym] = settings_configuration(params)
+        end
+      else
+        raise Colloquy::SettingsConfigurationNotFoundException, "Cannot find configuration in #{settings_configuration_file}. Is it empty?"
+      end
+    end
+
+    def settings_configuration_exists?
+      settings_configuration_file.exist?
+    end
+
+    def [](identifier)
+      unless @settings_configurations[identifier.to_sym]
+        raise Colloquy::SettingsFileNotFoundException, "A settings file for #{identifier} was not found, did you mis-spell or forget to configure it?"
+      end
+
+      @settings_configurations[identifier.to_sym]
+    end
+
+    def settings_configuration(params)
+      begin
+        if params[0] == "/"
+          yaml = YAML::load(File.open(params))
+        else
+          yaml = YAML::load(File.open(Colloquy.root.join(params)))
+        end
+      rescue Errno::ENOENT => e
+        logger.error "File not found: #{params}"
+        return {}
+      rescue Psych::SyntaxError => e
+        logger.error "File #{params} is not valid YAML"
+        return {}
+      end
+    end
+
+    def logger
+      Colloquy.logger
+    end
+
+  end
+
+
+  module InstanceMethods
+    def settings
+      SettingsProxy.instance.configure
+
+      SettingsProxy.instance
+    end
+  end
+
+end

data/lib/colloquy/helpers/url.rb

@@ -0,0 +1,10 @@
+require 'url-agent'
+
+module Colloquy::Helpers::Url
+  def url
+    url_agent = URLAgent::Base.instance
+    url_agent.configure(:path_root => Colloquy.root)
+    
+    url_agent
+  end
+end