oversip-mod-postgresql 0.1.0

data/AUTHORS

@@ -0,0 +1,5 @@
+MAIN AUTHOR
+===========
+
+- Iñaki Baz Castillo <ibc@aliax.net> (Github @ibc)
+

data/LICENSE

@@ -0,0 +1,25 @@
+Name: oversip-mod-postgresql
+Maintainer: Iñaki Baz Castillo <ibc@aliax.net>
+Copyright (c) 2012 Iñaki Baz Castillo <ibc@aliax.net>
+
+
+License: The MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# oversip-mod-postgresql
+
+## Overview
+
+`oversip-mod-postgresql` provides an easy to use PostgreSQL connector for [OverSIP](http://www.oversip.net) proxy based on [ruby-em-pg-client](https://github.com/royaltm/ruby-em-pg-client) driver (which is based on [ruby-pg](https://bitbucket.org/ged/ruby-pg/wiki/Home)).
+
+`oversip-mod-postgresql` depends on [OverSIP](http://www.oversip.net) >= 1.3.0 which enforces the usage of "sync" style coding via [em-synchrony](https://github.com/igrigorik/em-synchrony/) Gem.
+
+* For more information about `em-synchrony` usage check [Untangling Evented Code with Ruby Fibers](http://www.igvita.com/2010/03/22/untangling-evented-code-with-ruby-fibers/).
+
+Check the [ruby-em-pg-client documentation](https://github.com/royaltm/ruby-em-pg-client/blob/master/README.rdoc) and [ruby-pg documentation](http://deveiate.org/code/pg/) for the exact syntax and usage.
+
+
+## API
+
+
+### Method `OverSIP::Modules::Postgresql.add_pool(options)`
+
+Creates a PostgreSQL connection pool by receiving a mandatory `options` (a `Hash`) with the following fields:
+* `:pool_name`: Mandatory field. Must be a `Symbol` with the name for this pool.
+* `:pool_size`: The number of parallel PostgreSQL connections to perform. By default 10.
+* The rest of fields will be passed to each `PG::EM::Client.new` being created (which inherits from [`PG::Connection`](http://deveiate.org/code/pg/PG/Connection.html)).
+
+The method allows passing a block which would be later called by passing as argument each generated `PG::EM::Client` instance.
+
+The created connection pool is an instance of [`EventMachine::Synchrony::ConnectionPool`](https://github.com/igrigorik/em-synchrony/blob/master/lib/em-synchrony/connection_pool.rb).
+
+
+### Method `OverSIP::Modules::PostgreSQL.pool(pool_name)`
+
+Retrieves a previously created pool with the given name. Raises an `ArgumentError` if the given name does not exist in the list of created pools.
+
+
+
+## Usage Example
+
+On top of `/etc/oversip/server.rb`:
+
+```
+require "oversip-mod-postgresql"
+```
+
+
+Within the `OverSIP::SipEvents.on_initialize()` method in `/etc/oversip/server.rb`:
+
+```
+def (OverSIP::SystemEvents).on_initialize
+  OverSIP::M::Postgresql.add_pool({
+    :pool_name => :my_db,
+    :pool_size => 5,
+    :host => "localhost",
+    :user => "oversip",
+    :password => "xxxxxx",
+    :dbname => "oversip"
+  }) {|conn| log_info "PostgreSQL created connection: #{conn.inspect}" }
+end
+```
+
+Somewhere within the `OverSIP::SipEvents.on_request()` method in `/etc/oversip/server.rb`:
+
+```
+pool = OverSIP::M::Postgresql.pool(:my_db)
+
+begin
+  result = pool.query "SELECT * FROM users WHERE user = \'#{request.from.user}\'"
+  log_info "DB query result: #{result.to_a.inspect}"
+  if result.any?
+    # Add a X-Header with value the 'custom_header' field of the table row:
+    request.set_header "X-Header", result.first["custom_header"]
+    proxy = ::OverSIP::SIP::Proxy.new :proxy_out
+    proxy.route request
+    return
+  else
+    request.reply 404, "User not found in DB"
+    return
+  end
+
+rescue ::PG::Error => e
+  log_error "DB query error:"
+  log_error e
+  request.reply 500, "DB query error"
+  return
+end
+```
+
+
+## Dependencies
+
+* Ruby > 1.9.2.
+* [oversip](http://www.oversip.net) Gem >= 1.3.0.
+* PostgreSQL development library (the package `libpq-dev` in Debian/Ubuntu).
+
+
+## Installation
+
+```
+~$ gem install oversip-mod-postgresql
+```
+
+
+## Author
+
+Iñaki Baz Castillo
+* Mail: ibc@aliax.net
+* Github profile: [@ibc](https://github.com/ibc)

data/lib/oversip-mod-postgresql.rb

@@ -0,0 +1,58 @@
+require "oversip-mod-postgresql/version.rb"
+
+require "em-synchrony/pg"  # NOTE: Included in em-pg-client/lib/.
+
+
+module OverSIP
+  module Modules
+
+    module Postgresql
+
+      extend ::OverSIP::Logger
+
+      DEFAULT_POOL_SIZE = 10
+
+      @log_id = "Postgresql module"
+      @pools = {}
+
+      def self.add_pool options
+        raise ::ArgumentError, "`options' must be a Hash"  unless options.is_a? ::Hash
+
+        pool_name = options.delete(:pool_name)
+        pool_size = options.delete(:pool_size) || DEFAULT_POOL_SIZE
+
+        raise ::ArgumentError, "`options[:pool_name]' must be a Symbol"  unless pool_name.is_a? ::Symbol
+        raise ::ArgumentError, "`options[:pool_size]' must be a positive Fixnum"  unless pool_size.is_a? ::Fixnum and pool_size > 0
+
+        block = ::Proc.new  if block_given?
+
+        ::OverSIP::SystemCallbacks.on_started do
+          log_info "Adding PostgreSQL connection pool (name: #{pool_name.inspect}, size: #{pool_size})..."
+          @pools[pool_name] = ::EM::Synchrony::ConnectionPool.new(size: pool_size) do
+            # Avoid the hash to be modified by PG::EM::Client.
+            new_options = options.clone
+            # Force DB autoreconnect.
+            new_options[:async_autoreconnect] = true
+
+            conn = ::PG::EM::Client.new(new_options)
+
+            # Call the given block by passing conn as argument.
+            block.call(conn)  if block
+            conn
+          end
+        end
+      end
+
+      def self.pool pool_name
+        pool = @pools[pool_name]
+        raise ::ArgumentError, "no pool with `name' #{pool_name.inspect}"  unless pool
+        pool
+      end
+      class << self
+        alias :get_pool :pool
+      end
+
+    end  # module Postgresql
+
+  end
+end

data/lib/oversip-mod-postgresql/version.rb

@@ -0,0 +1,17 @@
+module OverSIP
+  module Modules
+
+    module Postgresql
+      module Version
+        MAJOR = 0
+        MINOR = 1
+        TINY  = 0
+        DEVEL = nil  # Set to nil for stable releases.
+      end
+
+      VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].join(".")
+      VERSION << ".#{Version::DEVEL}"  if Version::DEVEL
+    end
+
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: oversip-mod-postgresql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Inaki Baz Castillo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oversip
+  requirement: &15205740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *15205740
+- !ruby/object:Gem::Dependency
+  name: em-pg-client
+  requirement: &15205280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *15205280
+description: oversip-mod-postgresql provides an easy to use PostgreSQL connector for
+  OverSIP proxy.
+email:
+- ibc@aliax.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/oversip-mod-postgresql.rb
+- lib/oversip-mod-postgresql/version.rb
+- README.md
+- AUTHORS
+- LICENSE
+homepage: https://github.com/versatica/oversip-mod-postgresql
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: PostgreSQL connector module for OverSIP
+test_files: []
+has_rdoc: false