medularis-daemons_common 0.0.4

data/HISTORY.md

@@ -0,0 +1,24 @@
+## (12-07-2011) Claudio Alvarez (claudio at medularis.com)
+* redis >= 2.2.0 is now allowed.
+
+## (23-05-2011) Claudio Alvarez (claudio at medularis.com)
+* Version 0.0.4.
+* Added functions for facilitating Ruby 1.9/1.8 compatibility.
+* Added functions for facilitating debugging.
+
+## (17-05-2011) Claudio Alvarez (claudio at medularis.com)
+* Changed required version of resque to 1.16.1.
+* Corrected gem dependency errors.
+* Increased version number to 0.0.3.
+* Changed required version of json to 1.5.1.
+
+## (02-05-2011) Claudio Alvarez (claudio at medularis.com)
+* Updated dependencies in gemspec.
+
+## (02-05-2011) Claudio Alvarez (claudio at medularis.com)
+* Added constant `MedularisDaemonsCommon::ESL_EVENT_VARIABLE_PREFIX`.
+* Added ThreadPool class to the `MedularisDaemonsCommon` module.
+
+## (27-04-2011) Claudio Alvarez (claudio at medularis.com)
+* Adding `HISTORY.md` file to the project.
+* Adding `MedularisDaemonsCommon::FSConnection`, which encapsulates connections to FreeSWITCH's ESL.

data/build.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+rm *.gem
+gem build medularis-daemons_common.gemspec
+cp *.gem ../medularis-core-deployment/server/common/ruby-install/localgems
+

data/lib/debug_utils.rb

@@ -0,0 +1,27 @@
+# SCM_ID: $Id$
+# encoding: UTF-8
+
+def this_method
+  method = caller[0]
+  pieces = method.split('/')
+  
+  if (pieces.length >= 1)
+    method = pieces[pieces.length - 1]
+  end
+  
+  return "[#{method}]"
+end  
+
+def this_method_w_timestamp
+  method = caller[0]
+  pieces = method.split('/')
+  
+  if (pieces.length >= 1)
+    method = pieces[pieces.length - 1]
+  end
+  
+  time = Time.now
+  strtime = time.strftime("%H:%M:%S")
+  
+  return "[#{strtime} #{method}]"
+end

data/lib/fs_connection.rb

@@ -0,0 +1,54 @@
+# SCM_ID: $Id$
+# encoding: UTF-8
+module MedularisDaemonsCommon
+  require('ruby_compat')
+  require(File.join(File.expand_path('../../bin/freeSWITCH', __FILE__),'ESL'))
+    
+  # Singleton for FS event socket access
+  class FSConnection
+      
+      def self.instance(host = 'localhost', port = '8021', password = 'ClueCon')
+    
+        @@singleton__mutex__.synchronize {
+          if @@singleton__instance__
+            return @@singleton__instance__
+          end
+          
+          @@singleton__instance__ = FSConnection.new(host, port, password)
+        }
+            
+        return @@singleton__instance__
+      end
+      
+      def connection
+        if (@connection.nil?)
+          ruby_18 { @connection = ESL::ESLconnection.new(@host, @port, @password) } ||
+          ruby_19 { @connection = ESL::ESLconnection.new(@host.force_encoding("US-ASCII"), @port.force_encoding("US-ASCII"), @password.force_encoding("US-ASCII")) }
+
+          return @connection
+        else
+          return @connection
+        end    
+      end
+      
+      private
+      # private_class_method :new      
+      
+      def initialize(host, port, password)
+        @host = host
+        @port = port
+        @password = password
+      end
+
+      @host
+      @port
+      @password
+      @connection = nil
+
+      @@singleton__instance__ = nil
+      @@singleton__mutex__ = Mutex.new
+  end
+
+  FSCONNECTION = FSConnection.instance.connection  
+end
+  

data/lib/medularis-daemons_common.rb

@@ -0,0 +1,9 @@
+# SCM_ID: $Id:$
+require('debug_utils')
+require('fs_connection')
+require('threadpool')
+require('ruby_compat')
+
+module MedularisDaemonsCommon
+  ESL_EVENT_VARIABLE_PREFIX = 'variable_'
+end

data/lib/medularis-daemons_common/version.rb

@@ -0,0 +1,5 @@
+# SCM_ID: $Id: $
+# encoding: UTF-8
+module MedularisDaemonsCommon
+  Version = '0.0.4'
+end

data/lib/ruby_compat.rb

@@ -0,0 +1,20 @@
+# SCM_ID: $Id$
+# encoding: UTF-8
+
+if RUBY_VERSION < "1.9"
+  def ruby_18
+    yield
+  end
+
+  def ruby_19
+    false
+  end
+else
+  def ruby_18
+    false
+  end
+
+  def ruby_19
+    yield
+  end
+end

data/lib/threadpool.rb

@@ -0,0 +1,123 @@
+# SCM_ID: $Id$
+module MedularisDaemonsCommon
+  require 'thread'
+
+  # Work item to be executed in thread pool
+  class ThreadPoolJob
+  	attr_accessor :handler
+  	attr_accessor :params
+  	
+  	def initialize(*params, &block)
+  		@params = params
+  		@handler = block
+  	end
+  end
+  
+  
+  # Launches a specified number of threads on instantiation,
+  # assigning work to them as it arrives
+  class ThreadPool
+  	
+  	# Encapsulate each thread pool thread in object
+  	class ThreadPoolJobRunner
+  		attr_accessor :time_started
+  		
+  		def initialize(thread_pool)
+  			@thread_pool = thread_pool
+  			@timeout_lock = Mutex.new
+  			@thread_lock  = Mutex.new
+  		end
+  	
+  		def run
+  			@thread_lock.synchronize {
+  				@thread = Thread.new {
+  					until @thread_pool.terminate
+  						@timeout_lock.synchronize { @time_started = nil }
+  						work = @thread_pool.next_job
+  						@timeout_lock.synchronize { @time_started = Time.now }
+  						work.handler.call *work.params unless work.nil?
+  					end
+  				}
+  			}
+  		end
+  		
+  		def check_timeout(timeout)
+  			@timeout_lock.synchronize {
+  				if !@time_started.nil? && Time.now - @time_started > timeout
+  					stop
+  					run
+  				end
+  			}
+  		end
+  		
+  		def stop
+  			@thread_lock.synchronize {
+  				if @thread.alive?
+  					@thread.kill
+  					@thread.join
+  				end
+  			}
+  		end
+  	end
+  	
+  	# Create a thread pool with a specified number of threads
+  	def initialize(num_threads, args = {})
+  		@num_threads = num_threads
+  		@timeout     = args[:timeout]
+  		@job_runners = []
+  		@job_runners_lock = Mutex.new
+  		@terminate = false
+  		@terminate_lock = Mutex.new
+  		
+  		@work_queue  = Queue.new
+  		
+  		0.upto(@num_threads) { |i|
+  			runner = ThreadPoolJobRunner.new(self)
+  			@job_runners << runner
+  			runner.run
+  		}
+  		
+  		# optional timeout thread
+  		unless @timeout.nil?
+  			@timeout_thread = Thread.new {
+  				until terminate
+  					sleep @timeout
+  					@job_runners_lock.synchronize {
+  						@job_runners.each { |jr|
+  							jr.check_timeout(@timeout)
+  						}
+  					}
+  				end
+  			}
+  		end
+  	end
+  	
+  	# terminate reader
+  	def terminate
+  		@terminate_lock.synchronize { @terminate }
+  	end
+  	
+  	# terminate setter
+  	def terminate=(val)
+  		@terminate_lock.synchronize { @terminate = val }
+  	end
+  	
+  	# Add work to the pool
+  	def <<(work)
+  		@work_queue.push work
+  	end
+  	
+  	# Return the next job queued up
+  	def next_job
+  		@work_queue.pop
+  	end
+  	
+  	# Terminate the thread pool
+  	def stop
+  		terminate = true
+  		@timeout_thread.join unless @timout_thread.nil?
+  		@work_queue.clear
+  		@job_runners_lock.synchronize { @job_runners.each { |jr| jr.stop } }
+  	end
+  end
+end

data/medularis-daemons_common.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+# SCM_ID: $Id: $
+require File.expand_path("../lib/medularis-daemons_common/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name    = 'medularis-daemons_common'
+  gem.version = MedularisDaemonsCommon::Version
+  gem.date    = Date.today.to_s
+
+  gem.summary = "Common utilities and functionality required by Medularis Click-To-Call Daemons."
+  gem.description = "Library contaning common features shared by the Medularis Click-To-Call Daemons, supporting the ClickFono service (http://www.clickfono.com)."
+
+  gem.authors  = ['Medularis']
+  gem.email    = 'info@medularis.com'
+  gem.homepage = 'http://www.medularis.com'
+
+  gem.add_dependency('rubygems-update', '= 1.4.1')
+  gem.add_dependency('rake','>= 0.8.7')  
+  gem.add_dependency('json', '>= 1.5.1')
+  gem.add_dependency('log4r', '>= 1.1.9')
+  gem.add_dependency('mysql', '>= 2.8.1')
+  gem.add_dependency('redis', '>= 2.2.0')
+  gem.add_dependency('resque', '>= 1.16.1')
+  gem.add_dependency('resque-scheduler', '= 2.0.0.d')  
+  gem.add_dependency('rest-open-uri', '>= 1.0.0')  
+  gem.add_dependency('url', '>= 0.2.0')  
+  gem.add_dependency('amqp', '>= 0.7.1')
+  gem.add_development_dependency('rspec', [">= 2.0.0"])
+
+  # ensure the gem is built out of versioned files1
+  # gem.files = Dir['{bin,lib,man,test,spec}/**/*', 'README*', 'LICENSE*'] & `git ls-files -z`.split("\0")
+  gem.files = `git ls-files -z`.split("\0")  
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification 
+name: medularis-daemons_common
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Medularis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubygems-update
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.9
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.8.1
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.16.1
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: resque-scheduler
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.d
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rest-open-uri
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: url
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: amqp
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.1
+  type: :runtime
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+  type: :development
+  version_requirements: *id012
+description: Library contaning common features shared by the Medularis Click-To-Call Daemons, supporting the ClickFono service (http://www.clickfono.com).
+email: info@medularis.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- HISTORY.md
+- bin/freeSWITCH/ESL.so
+- build.sh
+- lib/debug_utils.rb
+- lib/fs_connection.rb
+- lib/medularis-daemons_common.rb
+- lib/medularis-daemons_common/version.rb
+- lib/ruby_compat.rb
+- lib/threadpool.rb
+- medularis-daemons_common.gemspec
+has_rdoc: true
+homepage: http://www.medularis.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Common utilities and functionality required by Medularis Click-To-Call Daemons.
+test_files: []
+