sipatra 0.0.3 → 0.1.0

data/lib/sipatra/base.rb

@@ -7,26 +7,21 @@ module Sipatra
   
   class Base
     include HelperMethods
-    attr_accessor :sip_factory, :context, :session, :msg, :params
-    
+    attr_accessor :sip_factory, :context, :session, :message, :params, :log
+    alias :request  :message 
+    alias :response :message 
+            
     def initialize()
-      @params = Hash.new {|hash,key| hash[key.to_s] if Symbol === key }
+      @params = Hash.new { |hash,key| hash[key.to_s] if Symbol === key }
     end
     
     # called from Java to set SIP servlet bindings
     def set_bindings(*args)
-      @context, @sip_factory, @session, @msg = args
+      @context, @sip_factory, @session, @message, @log = args
       session.extend Sipatra::SessionExtension
-      msg.extend Sipatra::MessageExtension
+      message.extend Sipatra::MessageExtension
     end
-    
-    def session=(session)
-      @session = session
-      class << @session
-         include SessionExtension
-       end
-    end
-    
+
     # called to process a SIP request
     def do_request
       call! self.class.req_handlers
@@ -36,7 +31,17 @@ module Sipatra
     def do_response
       call! self.class.resp_handlers
     end
-    
+
+    # Access settings defined with Base.set.
+    def self.settings
+      self
+    end
+
+    # Access settings defined with Base.set.
+    def settings
+      self.class.settings
+    end
+
     # Exit the current block, halts any further processing
     # of the message.
     # TODO: handle a response (as param)
@@ -50,16 +55,28 @@ module Sipatra
     end
     
     def request?
-      !msg.respond_to?(:getRequest)
+      !message.respond_to?(:getRequest)
     end
     
     def response?
-      msg.respond_to?(:getRequest)
+      message.respond_to?(:getRequest)
     end
     
     private
     
-    def msg_type
+    def session=(session)
+      @session = session
+      class << @session
+         include SessionExtension
+       end
+    end
+
+    # Retrieve the OUTBOUND_INTERFACES value from cipango.
+    def get_addresses
+      context.getAttribute('javax.servlet.sip.outboundInterfaces')
+    end
+    
+    def message_type
       response? ? :response : :request
     end
     
@@ -75,7 +92,7 @@ module Sipatra
       #clear (for multi usage)
       @params.clear
       if request?
-        match = arg.match msg.requestURI.to_s
+        match = arg.match message.requestURI.to_s
         if match
           eval_options(opts)
           if keys.any?
@@ -89,7 +106,7 @@ module Sipatra
           return true
         end
       else
-        if ((arg == 0) or (arg == msg.status))
+        if ((arg == 0) or (arg == message.status))
           eval_options(opts)
           return true
         end
@@ -117,7 +134,7 @@ module Sipatra
     def call!(handlers)
       filter! :before
       catch(:halt) do
-        process_handler(handlers, msg.method)
+        process_handler(handlers, message.method)
         process_handler(handlers, "_")
       end
     ensure 
@@ -131,7 +148,36 @@ module Sipatra
       def configure(*envs, &block)
         yield self if envs.empty? || envs.include?(environment.to_sym)
       end
-      
+
+      # Sets an option to the given value.  If the value is a proc,
+      # the proc will be called every time the option is accessed.
+      def set(option, value=self, &block)
+        raise ArgumentError if block && value != self
+        value = block if block
+        if value.kind_of?(Proc)
+          metadef(option, &value)
+          metadef("#{option}?") { !!__send__(option) }
+          metadef("#{option}=") { |val| metadef(option, &Proc.new{val}) }
+        elsif value == self && option.respond_to?(:each)
+          option.each { |k,v| set(k, v) }
+        elsif respond_to?("#{option}=")
+          __send__ "#{option}=", value
+        else
+          set option, Proc.new{value}
+        end
+        self
+      end
+
+      # Same as calling `set :option, true` for each of the given options.
+      def enable(*opts)
+        opts.each { |key| set(key, true) }
+      end
+
+      # Same as calling `set :option, false` for each of the given options.
+      def disable(*opts)
+        opts.each { |key| set(key, false) }
+      end
+
       # Methods defined in the block and/or in the module
       # arguments available to handlers.
       def helpers(*modules, &block)
@@ -182,12 +228,12 @@ module Sipatra
         end
       end
       
-      def before(msg_type = nil, &block)
-        add_filter(:before, msg_type, &block)
+      def before(message_type = nil, &block)
+        add_filter(:before, message_type, &block)
       end
       
-      def after(msg_type = nil, &block)
-        add_filter(:after, msg_type, &block)
+      def after(message_type = nil, &block)
+        add_filter(:after, message_type, &block)
       end
             
       def reset!
@@ -210,10 +256,14 @@ module Sipatra
         filters[:after]
       end
       
+      def invoke_hook(name, *args)
+        extensions.each { |e| e.send(name, *args) if e.respond_to?(name) }
+      end
+
       private
       
-      def add_filter(type, message_type = nil, &block)
-        if message_type
+      def add_filter(type, msg_type = nil, &block)
+        if msg_type
           add_filter(type) do
             next unless msg_type == message_type
             instance_eval(&block)
@@ -222,7 +272,15 @@ module Sipatra
           filters[type] << block
         end
       end
-            
+
+      def metadef(message, &block)
+        (class << self; self; end).
+          send :define_method, message, &block
+        if !['?', '='].include?(message.to_s[-1, 1])
+          invoke_hook(:option_set, self, message)
+        end
+      end
+
       # compiles a URI pattern
       def compile_uri_pattern(uri)
         keys = []
@@ -241,6 +299,7 @@ module Sipatra
       end
       
       def handler(method_name, verb, pattern, keys, options={}, &block)
+        raise ArgumentError, "A block should be given to a handler definition method" if block.nil?
         define_method method_name, &block
         unbound_method = instance_method(method_name)
         block =
@@ -287,7 +346,7 @@ module Sipatra
     delegate :ack, :bye, :cancel, :info, :invite, :message,
       :notify, :options, :prack, :publish, :refer, 
       :register, :subscribe, :update, 
-      :helpers, :configure,
+      :helpers, :configure, :settings, :set, :enable, :disable,
       :before, :after, :request, :response
   end
   
@@ -298,4 +357,4 @@ module Sipatra
   def self.register_extension(*extensions, &block)
     Application.register_extension(*extensions, &block)
   end
-end
+end

data/lib/sipatra/helpers.rb

@@ -1,146 +1,146 @@
 module Sipatra
   STATUS_CODES_MAP = {
-    :accepted => 202,
-    :address_incomplete => 484,
-    :alternative_service => 380,
-    :ambiguous => 485,
-    :bad_event => 489,
-    :bad_extension => 420,
-    :bad_gateway => 502,
-    :bad_identity_info => 436,
-    :bad_request => 400,
-    :busy_everywhere => 600,
-    :busy_here => 486,
-    :call_being_forwarded => 181,
-    :call_leg_done => 481,
-    :call_queued => 182,
-    :conditional_request_failed => 412,
-    :decline => 603,
-    :does_not_exit_anywhere => 604,
-    :extension_required => 421,
-    :forbidden => 403,
-    :gone => 410,
-    :interval_too_brief => 423,
-    :invalid_identity_header => 438,
-    :loop_detected => 482,
-    :message_too_large => 513,
-    :method_not_allowed => 405,
-    :moved_permanently => 301,
-    :moved_temporarily => 302,
-    :multiple_choices => 300,
-    :not_acceptable => 406,
-    :not_acceptable_anywhere => 606,
-    :not_acceptable_here => 488, 
-    :not_found => 404,
-    :not_implemented => 501,
-    :ok => 200,
-    :payment_required => 402,
-    :precondition_failure => 580,
-    :provide_referer_identity => 429,
+    :accepted                      => 202,
+    :address_incomplete            => 484,
+    :alternative_service           => 380,
+    :ambiguous                     => 485,
+    :bad_event                     => 489,
+    :bad_extension                 => 420,
+    :bad_gateway                   => 502,
+    :bad_identity_info             => 436,
+    :bad_request                   => 400,
+    :busy_everywhere               => 600,
+    :busy_here                     => 486,
+    :call_being_forwarded          => 181,
+    :call_leg_done                 => 481,
+    :call_queued                   => 182,
+    :conditional_request_failed    => 412,
+    :decline                       => 603,
+    :does_not_exit_anywhere        => 604,
+    :extension_required            => 421,
+    :forbidden                     => 403,
+    :gone                          => 410,
+    :interval_too_brief            => 423,
+    :invalid_identity_header       => 438,
+    :loop_detected                 => 482,
+    :message_too_large             => 513,
+    :method_not_allowed            => 405,
+    :moved_permanently             => 301,
+    :moved_temporarily             => 302,
+    :multiple_choices              => 300,
+    :not_acceptable                => 406,
+    :not_acceptable_anywhere       => 606,
+    :not_acceptable_here           => 488,
+    :not_found                     => 404,
+    :not_implemented               => 501,
+    :ok                            => 200,
+    :payment_required              => 402,
+    :precondition_failure          => 580,
+    :provide_referer_identity      => 429,
     :proxy_authentication_required => 407,
-    :request_entity_too_large => 413,
-    :request_pending => 491,
-    :request_terminated => 487,
-    :request_timeout => 408,
-    :request_uri_too_long => 414,
-    :ringing => 180,
-    :security_agreement_required => 494,
-    :server_internal_error => 500,
-    :server_timeout => 504,
-    :service_unavailable => 503,
-    :session_interval_too_small => 422,
-    :session_progress => 183,
-    :temporarily_unavailable => 480,
-    :too_many_hops => 483,
-    :trying => 100,
-    :unauthorized => 401,
-    :undecipherable => 493,
-    :unsupported_certificate => 437,
-    :unsupported_media_type => 415,
-    :unsupported_uri_scheme => 416,
-    :use_identity_header => 428,
-    :use_proxy => 305,
-    :version_not_supported => 505,
+    :request_entity_too_large      => 413,
+    :request_pending               => 491,
+    :request_terminated            => 487,
+    :request_timeout               => 408,
+    :request_uri_too_long          => 414,
+    :ringing                       => 180,
+    :security_agreement_required   => 494,
+    :server_internal_error         => 500,
+    :server_timeout                => 504,
+    :service_unavailable           => 503,
+    :session_interval_too_small    => 422,
+    :session_progress              => 183,
+    :temporarily_unavailable       => 480,
+    :too_many_hops                 => 483,
+    :trying                        => 100,
+    :unauthorized                  => 401,
+    :undecipherable                => 493,
+    :unsupported_certificate       => 437,
+    :unsupported_media_type        => 415,
+    :unsupported_uri_scheme        => 416,
+    :use_identity_header           => 428,
+    :use_proxy                     => 305,
+    :version_not_supported         => 505,
   }
-  
+
   class HeadersWrapper
     def initialize(app, plural = false, address = false)
       @app = app
       method_definitions = <<-RUBY
         def [](name)
-          @app.msg.get#{address ? "Address" : ""}Header#{plural ? "s" : ""}(name.to_s)#{plural ? ".to_a" : ""}
+          @app.message.get#{address ? "Address" : ""}Header#{plural ? "s" : ""}(name.to_s)#{plural ? ".to_a" : ""}
         end
       RUBY
       if plural
         method_definitions += <<-RUBY
           def []=(name, values)
             name = name.to_s
-            @app.msg.removeHeader(name)
+            @app.message.removeHeader(name)
             if !values.nil?
-              values.each do |value| 
-                @app.msg.add#{address ? "Address" : ""}Header(name, value#{address ? ", true" : ".to_s"})
+              values.each do |value|
+                @app.message.add#{address ? "Address" : ""}Header(name, value#{address ? ", true" : ".to_s"})
               end
             end
-          end 
+          end
         RUBY
       else
         method_definitions += <<-RUBY
           def []=(name, value)
             if !value.nil?
-              @app.msg.set#{address ? "Address" : ""}Header(name.to_s, value)
+              @app.message.set#{address ? "Address" : ""}Header(name.to_s, value)
             else
-              @app.msg.removeHeader(name.to_s)
+              @app.message.removeHeader(name.to_s)
             end
-          end 
+          end
         RUBY
       end
       class << self; self; end.class_eval method_definitions
-      end 
+      end
     end
-    
-    module HelperMethods  
+
+    module HelperMethods
       def proxy(*args)
         uri = args.shift
         uri, options = nil, uri if uri.kind_of? Hash
         options ||= args.shift || {}
         if uri.nil?
-          uri = msg.requestURI
+          uri = message.requestURI
         else
           uri = sip_factory.createURI(uri)
         end
-        proxy = msg.getProxy()
+        proxy = message.proxy
         proxy.setRecordRoute(options[:record_route]) if options.has_key? :record_route
         proxy.proxyTo(uri)
-      end    
-      
+      end
+
       def header
         @header_wrapper ||= HeadersWrapper::new(self)
       end
-      
+
       def headers
         @headers_wrapper ||= HeadersWrapper::new(self, true)
       end
-      
+
       def address_header
         @address_header_wrapper ||= HeadersWrapper::new(self, false, true)
       end
-      
+
       def address_headers
         @address_headers_wrapper ||= HeadersWrapper::new(self, true, true)
       end
-      
+
       def add_header(name, value)
-        msg.addHeader(name.to_s, value)
+        message.addHeader(name.to_s, value)
       end
-      
+
       def add_address_header(name, value, first = true)
-        msg.addAddressHeader(name.to_s, value, first)
+        message.addAddressHeader(name.to_s, value, first)
       end
-      
+
       def header?(name)
-        !msg.getHeader(name.to_s).nil?
+        !message.getHeader(name.to_s).nil?
       end
-      
+
       def modify_header(header_name, pattern = nil, new_value = nil)
         #FIXME: "JAVA" Code
         if pattern
@@ -154,46 +154,71 @@ module Sipatra
           end
         end
       end
-      
+
       def remove_header(name)
-        msg.removeHeader(name.to_s)
+        message.removeHeader(name.to_s)
+      end
+
+      class ResponseEnvironment
+        instance_methods.each do |m|
+          undef_method m unless m.to_s =~ /^__|respond_to?|instance_eval/
+        end
+
+        attr_reader :response, :app
+        alias :message :response
+
+        def initialize(app, response)
+          @app, @response = app, response
+        end
+
+        # TODO: complete with some direct access to app ?
       end
-      
-      def send_response(status, *args)
+
+      def send_response(status, *args, &block)
         create_args = [convert_status_code(status)]
         create_args << args.shift unless args.empty? || args.first.kind_of?(Hash)
-        response = msg.createResponse(*create_args)
+        response = message.createResponse(*create_args)
         unless args.empty?
           raise ArgumentError, "last argument should be a Hash" unless args.first.kind_of? Hash
           args.first.each_pair do |name, value|
             response.addHeader(name.to_s, value.to_s)
           end
         end
-        if block_given?
-          yield response
+        unless block.nil?
+          ResponseEnvironment::new(self, response).instance_eval(&block)
         end
         response.send
       end
-      
+
       def create_address(addr, options = {})
         addr = addr.to_s # TODO: Handle URI instances
         address = sip_factory.createAddress(addr)
         address.setExpires(options[:expires]) if options.has_key? :expires
         address.setDisplayName(options[:display_name]) if options.has_key? :display_name
-        
-        address      
+
+        address
       end
-      
+
+      def create_uri(value, params = {})
+        uri = sip_factory.createURI(value)
+        if uri.respond_to? :setLrParam
+            uri.setLrParam(params.has_key?(:lr) ? params.delete(:lr) : true)
+        end
+        params.each { |name, value| uri.setParameter(name.to_s, value.to_s) }
+        uri
+      end
+
       def push_route(route)
-        msg.pushRoute(sip_factory.createAddress(route))
-      end    
-      
+        message.pushRoute(sip_factory.createAddress(route))
+      end
+
       private
-      
+
       def convert_status_code(symbol_or_int)
         case symbol_or_int
-          when Integer: return symbol_or_int
-          when Symbol: 
+          when Integer
+            return symbol_or_int
+          when Symbol
           code = STATUS_CODES_MAP[symbol_or_int]
           raise ArgumentError, "Unknown status code symbol: '#{symbol_or_int}'" unless code
           code
@@ -202,4 +227,4 @@ module Sipatra
         end
       end
     end
-  end
+  end