Skip to content
A PostgreSQL connector module for OverSIP
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
.gitignore
AUTHORS
LICENSE
README.md
oversip-mod-postgresql.gemspec

README.md

oversip-mod-postgresql

Overview

oversip-mod-postgresql provides an easy to use PostgreSQL connector for OverSIP proxy based on ruby-em-pg-client driver (which is based on ruby-pg).

oversip-mod-postgresql depends on OverSIP >= 1.3.0 which enforces the usage of "sync" style coding via em-synchrony Gem.

Check the ruby-em-pg-client documentation and ruby-pg documentation 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).

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 accepts calls to any method defined for PG::EM::Client class instance.

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 Gem >= 1.3.7.
  • PostgreSQL development library (the package libpq-dev in Debian/Ubuntu).

Installation

~$ gem install oversip-mod-postgresql

Author

Iñaki Baz Castillo

Something went wrong with that request. Please try again.