oversip 1.1.0.beta4 → 1.1.0.beta5

data/AUTHORS

@@ -9,10 +9,14 @@ CONTRIBUTORS
 ============
 
 - Jon Bonilla <manwe@aholab.ehu.es> (Github @manwe)
-  Lot of help with Debian package.
 
-- Saúl Ibarra <saghul@gmail.com> (Github @saghul)
-  Testing, ideas, proposals, too much proposals.
+  Lots of help with packaging for Debian based distributions.
+  The first deployment of OverSIP in production for thousands of clients.
+
+- Saúl Ibarra Corretgé <saghul@gmail.com> (Github @saghul)
+
+  Testing, ideas, proposals, too many proposals.
 
 - José Luis Millán <jmillan@aliax.net> (Github @jmillan)
-  Intensive testing with JsSIP library acting as client with OverSIP.
+
+  Intensive testing with JsSIP library acting as a SIP Outbound UA with OverSIP.

data/LICENSE

@@ -3,7 +3,7 @@ Maintainer: Iñaki Baz Castillo <ibc@aliax.net>
 Copyright (c) 2012 Iñaki Baz Castillo <ibc@aliax.net>
 
 
-License: The MIT LICENSE
+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

data/etc/oversip.conf

@@ -21,7 +21,7 @@ core:
   #
   nameservers: null
 
-  # Syslog facility. Can be "user", "local0"..."local7".
+  # Syslog facility. Can be "kern", "user", "daemon", "local0"..."local7".
   # By default "daemon".
   #
   syslog_facility: daemon
@@ -105,7 +105,7 @@ sip:
   # TCP keepalive interval (in seconds).
   # When acting as a TCP server, OverSIP sends TCP packets with null data payload
   # as described in http://tldp.org/HOWTO/html_single/TCP-Keepalive-HOWTO/.
-  # If not set, TCP keepalive is dissabled.
+  # If not set, TCP keepalive is disabled.
   # Minimun value is 180 seconds. Default value is _null_ (not enabled).
   #
   tcp_keepalive_interval: 300
@@ -207,7 +207,7 @@ tls:
   # chain of X509 certificates in PEM format, with the most-resolved certificate at the
   # top of the file, successive intermediate certs in the middle, and the root (or CA)
   # cert at the bottom.
-  # If not set, TLS is dissabled. Default value is _null_.
+  # If not set, TLS is disabled. Default value is _null_.
   # If a relative path is given, it's searched under the tls/ directoy in the OverSIP
   # configuration directory (typically /etc/oversip/).
   #
@@ -215,7 +215,7 @@ tls:
 
   # Server TLS private certificate. It must be the name of a readable file containing a
   # private key in the PEM format.
-  # If not set, TLS is dissabled. Default value is _null_.
+  # If not set, TLS is disabled. Default value is _null_.
   # If a relative path is given, it's searched under the tls/ directoy in the OverSIP
   # configuration directory (typically /etc/oversip/).
   # NOTE: The private key MUST NOT require password.
@@ -227,7 +227,7 @@ tls:
   # This is useful for storing the list of trusted CAs (i.e. http://curl.haxx.se/ca/cacert.pem)
   # or CAs not in a standard trust hierarchy.
   # This is *required* for validating certificates provided by remote peers.
-  # If _null_ this feature is dissabled. Default value is _null_.
+  # If _null_ this feature is dssabled. Default value is _null_.
   # If a relative path is given, it's searched under the tls/ directoy in the OverSIP
   # configuration directory (typically /etc/oversip/).
   #

data/etc/proxies.conf

@@ -13,12 +13,11 @@
 #
 default_proxy:
 
-  # Loose-Routing.
-  # For initial INVITE, SUBSCRIBE and REFER requests the proxy adds Record-Route header(s).
+  # For initial INVITE, SUBSCRIBE and REFER requests and in-dialog NOTIFY the proxy adds Record-Route header(s).
   # For REGISTER requests the proxy adds Path header(s).
   # By default _yes_.
   #
-  do_loose_routing: yes
+  do_record_routing: yes
 
   # Enable DNS cache. By default _yes_.
   #
@@ -35,7 +34,7 @@ default_proxy:
   #
   use_naptr: yes
 
-  # Use DNS SRV. If set, SRV query is performed when URI host is a domain and has no port,
+  # Use DNS SRV. If set, SRV query is performed when URI host is a domain and has no port.
   # If this is set to _no_ then _use_naptr_ is also set to _no_.
   # Default value is _yes_.
   #
@@ -72,21 +71,21 @@ default_proxy:
   #
   dns_failover_on_503: yes
 
-  # INVITE transaction timeout timer (in seconds).
+  # INVITE transaction timeout (in seconds).
   # Time waiting for a provisional or final response.
   # Minimum value is 2, maximum value is 64.
   # Default value is 32.
   #
   timer_B: 32
 
-  # Proxy INVITE transaction timeout timer (in seconds).
+  # Proxy INVITE transaction timeout (in seconds).
   # Time waiting for a final response.
   # Minimum value is 8, maximum value is 180.
   # Default value is 120.
   #
   timer_C: 120
 
-  # Non-INVITE transaction timeout timer (in seconds).
+  # Non-INVITE transaction timeout (in seconds).
   # Time waiting for a final response.
   # Minimum value is 2, maximum value is 64.
   # Default value is 32.
@@ -96,7 +95,7 @@ default_proxy:
   # Validate TLS certificate from the contacted server (just when using TLS transport).
   # If set to _yes_, the contacted server MUST present a valid certificate. The connection
   # will be inmediately closed otherwise and a 500 error locally generated.
-  # NOTE: This does not match the SIP request destination host agains the hosts asserted by
+  # NOTE: This does not match the SIP request destination host against the hosts asserted by
   # the certificate. This just performs TLS certificate pure validation.
   # Default value is _no_.
   tls_validation: no
@@ -134,4 +133,4 @@ proxy_out:
   timer_F: 6
 
 
-# Add your own proxy configurations here and/or replace the above ones.
+# Add your own proxy configurations here and/or replace the above ones.

data/etc/server.rb

@@ -34,14 +34,14 @@ end
 ### OverSIP System Events:
 
 
-# This method is called once the OverSIP reactor has been started.
+# This callback is called once the OverSIP reactor has been started.
 #
 # def (OverSIP::SystemEvents).on_started
 #   [...]
 # end
 
 
-# This method is called when a USR1 signal is received by OverSIP main
+# This callback is called when a USR1 signal is received by OverSIP main
 # process and allows the user to set custom code to be executed
 # or reloaded.
 #
@@ -50,7 +50,7 @@ end
 # end
 
 
-# This method is called after OverSIP has been terminated. It's called
+# This callback is called after OverSIP has been terminated. It's called
 # with argument "error" which is _true_ in case OverSIP has died in an
 # unexpected way.
 #
@@ -64,7 +64,7 @@ end
 ### OverSIP SIP Events:
 
 
-# This method is called when a SIP request is received.
+# This callback is called when a SIP request is received.
 #
 def (OverSIP::SipEvents).on_request request
 
@@ -109,7 +109,7 @@ def (OverSIP::SipEvents).on_request request
 
   if MyExampleApp::SIP_USE_MODULE_REGISTRAR_WITHOUT_PATH
     # Extract the Outbound flow token from the RURI.
-    OverSIP::SIP::Modules::RegistrarWithoutPath.extract_outbound_from_ruri request
+    ::OverSIP::SIP::Modules::RegistrarWithoutPath.extract_outbound_from_ruri request
   end
 
   # The request goes to a client using Outbound through OverSIP.
@@ -147,7 +147,7 @@ def (OverSIP::SipEvents).on_request request
   # An outgoing initial request.
   case request.sip_method
 
-  when :INVITE, :MESSAGE, :OPTIONS, :SUBSCRIBE, :PUBLISH
+  when :INVITE, :MESSAGE, :OPTIONS, :SUBSCRIBE, :PUBLISH, :REFER
 
     if MyExampleApp::SIP_USE_MODULE_USER_ASSERTION
       ::OverSIP::SIP::Modules::UserAssertion.add_pai request
@@ -223,7 +223,7 @@ end
 ### OverSIP WebSocket Events:
 
 
-# This method is called when a new WebSocket connection is being requested.
+# This callback is called when a new WebSocket connection is being requested.
 # Here you can inspect the connection and the HTTP GET request. If you
 # decide not to accept this connection then call to:
 #
@@ -238,10 +238,10 @@ end
 # end
 
 
-# This method is called when a WebSocket connection is closed. The connection
+# This callback is called when a WebSocket connection is closed. The connection
 # is given as first argument along with a second argument "client_closed" which
 # is _true_ in case the WebSocket connection was closed by the client.
 #
-# def (OverSIP::WebSocketEvents).on_connection_closed connection, client_closed
+# def (OverSIP::WebSocketEvents).on_disconnection connection, client_closed
 #   [...]
 # end

data/lib/oversip/default_server.rb

@@ -5,15 +5,15 @@ module OverSIP
     extend ::OverSIP::Logger
 
     def self.on_started
-      log_system_notice "on_started() event is not defined"
+      log_system_notice "on_started() callback is not defined"
     end
 
     def self.on_user_reload
-      log_system_notice "on_user_reload() event is not defined"
+      log_system_notice "on_user_reload() callback is not defined"
     end
 
     def self.on_terminated error
-      log_system_notice "on_terminated() event is not defined"
+      log_system_notice "on_terminated() callback is not defined"
     end
 
 
@@ -24,7 +24,7 @@ module OverSIP
     extend ::OverSIP::Logger
 
     def self.on_request request
-      log_system_notice "on_request() event is not defined"
+      log_system_notice "on_request() callback is not defined"
     end
 
   end
@@ -34,11 +34,11 @@ module OverSIP
     extend ::OverSIP::Logger
 
     def self.on_connection connection, http_request
-      log_system_notice "on_connection() event is not defined"
+      log_system_notice "on_connection() callback is not defined"
     end
 
-    def self.on_connection_closed connection, client_closed
-      log_system_notice "on_connection_closed() event is not defined"
+    def self.on_disconnection connection, client_closed
+      log_system_notice "on_disconnection() callback is not defined"
     end
 
   end

data/lib/oversip/proxies_config.rb

@@ -10,7 +10,7 @@ module OverSIP
     end
 
     @proxy_configuration = {
-      :do_loose_routing           => true,
+      :do_record_routing          => true,
       :use_dns                    => true,
       :use_dns_cache              => true,
       :dns_cache_time             => 300,
@@ -27,7 +27,7 @@ module OverSIP
     }
 
     PROXY_CONFIG_VALIDATIONS = {
-      :do_loose_routing           => :boolean,
+      :do_record_routing          => :boolean,
       :use_dns                    => :boolean, 
       :use_dns_cache              => :boolean,
       :dns_cache_time             => [ :fixnum, [ :greater_equal_than, 300 ] ],

data/lib/oversip/sip/message.rb

@@ -5,7 +5,7 @@ module OverSIP::SIP
     include ::OverSIP::Logger
 
     DIALOG_FORMING_METHODS = { :INVITE=>true, :SUBSCRIBE=>true, :REFER=>true }
-    LOOSE_RECORD_AWARE_METHODS = { :INVITE=>true, :REGISTER=>true, :SUBSCRIBE=>true, :REFER=>true }
+    RECORD_ROUTING_AWARE_METHODS = { :INVITE=>true, :REGISTER=>true, :SUBSCRIBE=>true, :REFER=>true }
     OUTBOUND_AWARE_METHODS = { :INVITE=>true, :REGISTER=>true, :SUBSCRIBE=>true, :REFER=>true }
     EMPTY_ARRAY = [].freeze
 
@@ -79,8 +79,8 @@ module OverSIP::SIP
       DIALOG_FORMING_METHODS[@sip_method]
     end
 
-    def loose_record_aware?
-      LOOSE_RECORD_AWARE_METHODS[@sip_method]
+    def record_routing_aware?
+      RECORD_ROUTING_AWARE_METHODS[@sip_method]
     end
 
     def outbound_aware?

data/lib/oversip/sip/proxy.rb

@@ -265,17 +265,19 @@ module OverSIP::SIP
       return  if @num_target and @num_target > 0
 
       add_rr_path = false
-      if @request.initial? && @request.loose_record_aware?
-        do_loose_routing = @proxy_conf[:do_loose_routing]
 
-        # Request has no previous RR/Path and current proxy performs loose-routing.
+      # NOTE: As per RFC 6665 the proxy MUST add Record-Route to in-dialog NOTIFY's.
+      if (@request.initial? and @request.record_routing_aware?) or @request.sip_method == :NOTIFY
+        do_record_routing = @proxy_conf[:do_record_routing]
+
+        # Request has no previous RR/Path and current proxy performs record-routing.
         # So add RR/Path.
-        if ! @request.in_rr && do_loose_routing
+        if ! @request.in_rr && do_record_routing
           add_rr_path = true
 
-        # Request has previous RR/Path and current proxy does not perform loose-routing.
+        # Request has previous RR/Path and current proxy does not perform record-routing.
         # So don't add RR/Path and remove the existing one.
-        elsif @request.in_rr && ! do_loose_routing
+        elsif @request.in_rr && ! do_record_routing
           case @request.in_rr
           when :rr, :outgoing_outbound_rr, :incoming_outbound_rr, :both_outbound_rr
             @request.delete_header_top "Record-Route"
@@ -285,8 +287,8 @@ module OverSIP::SIP
           @request.in_rr = nil
 
         # Remaining cases are:
-        # - Request has previous RR/Path and current proxy performs loose-routing.
-        # - Request has no previous RR/Path and current proxy does not perform loose-routing.
+        # - Request has previous RR/Path and current proxy performs record-routing.
+        # - Request has no previous RR/Path and current proxy does not perform record-routing.
         # So don't add RR/Path.
         end
       end
@@ -300,7 +302,6 @@ module OverSIP::SIP
       end
 
       # Add Record-Route or Path header.
-      # Here we only arrive if @request.loose_record_aware?, so method is INVITE, REGISTER, SUBSCRIBE or REFER.
       if add_rr_path
         case @request.sip_method
 
@@ -321,7 +322,7 @@ module OverSIP::SIP
             @request.insert_header "Path", @request.connection.class.record_route
           end
 
-        # Record-Route for INVITE, SUBSCRIBE, REFER.
+        # Record-Route for INVITE, SUBSCRIBE, REFER and in-dialog NOTIFY.
         else
           if @request.outgoing_outbound_requested?
             if @request.incoming_outbound_requested?

data/lib/oversip/version.rb

@@ -6,16 +6,16 @@ module OverSIP
     MAJOR = 1
     MINOR = 1
     TINY  = 0
-    DEVEL = "beta4"  # Set to nil for stable releases.
+    DEVEL = "beta5"  # Set to nil for stable releases.
   end
 
   PROGRAM_NAME     = "OverSIP"
-  PROGRAM_NAME_LOW = PROGRAM_NAME.downcase
-  PROGRAM_DESC     = "OverSIP Server"
   VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].join(".")
   VERSION << ".#{Version::DEVEL}"  if Version::DEVEL
   AUTHOR = "Inaki Baz Castillo"
   AUTHOR_EMAIL = "ibc@aliax.net"
-  DESCRIPTION = "#{PROGRAM_NAME} #{VERSION}\n2012, #{AUTHOR} <#{AUTHOR_EMAIL}>"
+  HOMEPAGE = "http://www.oversip.net"
+  year = "2012"
+  DESCRIPTION = "#{PROGRAM_NAME} #{VERSION}\n#{HOMEPAGE}\n#{year}, #{AUTHOR} <#{AUTHOR_EMAIL}>"
 
 end

data/lib/oversip/websocket/constants.rb

@@ -48,7 +48,7 @@ module OverSIP::WebSocket
 
   REASON_PHARSE_NOT_SET = "Reason Phrase Not Set"
 
-  HDR_SERVER = "Server: #{::OverSIP::PROGRAM_DESC}/#{::OverSIP::VERSION}"
+  HDR_SERVER = "Server: #{::OverSIP::PROGRAM_NAME}/#{::OverSIP::VERSION}".freeze
 
   WS_SIP_PROTOCOL = "sip"
   WS_AUTOBAHN_PROTOCOL = "autobahn"

data/lib/oversip/websocket/listeners/tcp_server.rb

@@ -75,9 +75,9 @@ module OverSIP::WebSocket
 
       if @ws_handshake_done
         begin
-          ::OverSIP::WebSocketEvents.on_connection_closed self, !@ws_locally_closed
+          ::OverSIP::WebSocketEvents.on_disconnection self, !@ws_locally_closed
         rescue ::Exception => e
-          log_system_error "error calling OverSIP::WebSocketEvents.on_connection_closed():"
+          log_system_error "error calling OverSIP::WebSocketEvents.on_disconnection():"
           log_system_error e
         end
       end unless $!
@@ -264,7 +264,7 @@ module OverSIP::WebSocket
     end
 
 
-    def http_reject status_code, reason_phrase=nil, extra_headers=nil
+    def http_reject status_code=403, reason_phrase=nil, extra_headers=nil
       @http_request.reply(status_code, reason_phrase, extra_headers)
       close_connection_after_writing
       @state = :ignore

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oversip
 version: !ruby/object:Gem::Version
-  version: 1.1.0.beta4
+  version: 1.1.0.beta5
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-08 00:00:00.000000000 Z
+date: 2012-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine-le
-  requirement: &18475300 !ruby/object:Gem::Requirement
+  requirement: &19987280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *18475300
+  version_requirements: *19987280
 - !ruby/object:Gem::Dependency
   name: iobuffer
-  requirement: &18474840 !ruby/object:Gem::Requirement
+  requirement: &19986780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *18474840
+  version_requirements: *19986780
 - !ruby/object:Gem::Dependency
   name: em-posixmq
-  requirement: &18474380 !ruby/object:Gem::Requirement
+  requirement: &19986300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *18474380
+  version_requirements: *19986300
 - !ruby/object:Gem::Dependency
   name: em-udns
-  requirement: &18473920 !ruby/object:Gem::Requirement
+  requirement: &19985820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *18473920
+  version_requirements: *19985820
 - !ruby/object:Gem::Dependency
   name: escape_utils
-  requirement: &18473460 !ruby/object:Gem::Requirement
+  requirement: &19985360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *18473460
+  version_requirements: *19985360
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &18473080 !ruby/object:Gem::Requirement
+  requirement: &19984980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18473080
+  version_requirements: *19984980
 - !ruby/object:Gem::Dependency
   name: posix-spawn
-  requirement: &18472540 !ruby/object:Gem::Requirement
+  requirement: &19984260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *18472540
+  version_requirements: *19984260
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &18472040 !ruby/object:Gem::Requirement
+  requirement: &19983760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,13 +98,31 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *18472040
-description: ! "OverSIP is an async SIP server. Built on top of Ruby EventMachine\n
-  \   library it follows the Reactor Pattern, allowing thousands of concurrent connections
-  and requests\n    handled by a single processor in a never-blocking fashion. It
-  supports SIP over UDP, TCP, TLS and\n    WebSocket transports, full RFC 3263 (async
-  DNS resolution), Outbound (RFC 5626) and more features."
-email: ibc@aliax.net
+  version_requirements: *19983760
+description: ! 'OverSIP is an async SIP proxy/server programmable in Ruby language.
+  Some features of OverSIP are:
+
+  - SIP transports: UDP, TCP, TLS and WebSocket.
+
+  - Full IPv4 and IPv6 support.
+
+  - RFC 3263: SIP DNS mechanism (NAPTR, SRV, A, AAAA) for failover and load balancing
+  based on DNS.
+
+  - RFC 5626: OverSIP is a perfect Outbound Edge Proxy, including an integrated STUN
+  server.
+
+  - Fully programmable in Ruby language (make SIP easy).
+
+  - Fast and efficient: OverSIP core is coded in C language.
+
+  OverSIP is build on top of EventMachine-LE async library which follows the Reactor
+  Design Pattern, allowing thousands of concurrent connections and requests in a never-blocking
+  fashion.
+
+'
+email:
+- ibc@aliax.net
 executables:
 - oversip
 extensions:
@@ -268,7 +286,7 @@ rubyforge_project:
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: the SIP dreams factory
+summary: OverSIP (the SIP framework you dreamed about)
 test_files:
 - test/oversip_test_helper.rb
 - test/test_sip_parser.rb