rtsptools 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b86ed8e316a052abb7e55d25326be700868c9f0b
+  data.tar.gz: 0dd8b6c307a20b885428265dd54ac590b15acef6
+SHA512:
+  metadata.gz: a76271c8d6791eab809385bb545c9c2438ebb97fafc334a236eeef4a0d0a3b4fc34bbe2f131c259fd0ef2968df9175ca95d480cfa41c6d9f1b5d0130716f4781
+  data.tar.gz: f8a946c4898a67135e2bae5b82fc062ec478c8351fc8cf4e4f2e74241c2332c67c3940ac8b4668c53d0360f58f50967dce63e72c3c1312633e65ff764f24c886

data/lib/rtsptools.rb

@@ -0,0 +1,146 @@
+require 'socket'
+require 'uri'
+require 'base64'
+
+##
+# rtsptools is a simple module for testing RTSP media sources.
+# Initiallly, this is intended to be used by applications that need to
+# constantly check the status of RTSP media sources, such as IP Cameras.
+#
+# Author::    Mario Gasparoni Jr  (mailto:mario@mgasp.info)
+# License::   GNU General Public License 2 (GPL-2.0)
+module RTSPTools
+
+    ##
+    # RTSPConnectionTester is a simple class to test RTSP connectivity.
+    # This was intended to be used by applications that need to constantly
+    # check the status of RTSP media sources, such as IP Cameras.
+    #
+    class RTSPConnectionTester
+        attr_reader :uri, :host, :port, :timeout, :logging #:nodoc:
+        LOG = "[logger] - " #:nodoc:
+        LOG_WARNING = LOG + "WARNING: " #:nodoc:
+
+        #RTSP user agent
+        USER_AGENT = "RTSPConnectionTester-beta" #:nodoc:
+        #Current RTSP version
+        RTSP_VERSION = 1.0 #:nodoc:
+        #RTSP status code OK
+        RTSP_STATUS_CODE_OK = 200 #:nodoc:
+
+        #RTSP Successfull response string
+        RTSP_SUCCESSFULL_RESPONSE_LINE =
+            "RTSP/#{RTSP_VERSION} #{RTSP_STATUS_CODE_OK} OK\r\n" #:nodoc:
+
+        #Default connection timeout
+        DEFAULT_TIMEOUT = 5
+        #Default RTSP port
+        RTSP_DEFAULT_PORT = 554
+
+        ## Creates an RTSPConnectionTester instance.
+        # ==== Params
+        #
+        # * +:uri+ - An RTSP URI to be tested
+        # * +:timeout+ - A timeout for connection test
+        # * +:logging+ - Set this flag to enable logging
+        #
+        # === Alternative params
+        #
+        # Instead of passing an RTSP URI, you can pass the following parameters,
+        # for testing port connectivity only
+        # * +:host+ - The media source host
+        # * +:port+ - The media source port
+        def initialize(params = {})
+            @uri = params[:uri]
+            @cseq = 0
+            if @uri
+                @p_uri = URI(@uri)
+                @host = @p_uri.host
+                @port = @p_uri.port || RTSP_DEFAULT_PORT
+            else
+                @host = params[:host]
+                @port = params[:port] || RTSP_DEFAULT_PORT
+            end
+            raise ArgumentError.new("Missing arguments") unless @host
+            @timeout = params[:timeout] || DEFAULT_TIMEOUT
+            @logging = params[:logging]
+        end
+
+        ##
+        # Test connectivity against media source..
+        # When deep_check is set, RTSP protocol is check using OPTIONS
+        # message. This method blocks until finishes it test, or timeout
+        # exceeds
+        #
+        # ==== Options
+        #
+        # * +:deep_check+
+        # Set this flag to test connectivity using OPTIONS
+        # message. You must set an RTSP URI to use this option
+        def test_rtsp_connectivity(options = {})
+            @deep_check = options[:deep_check]
+            initialize_socket()
+            begin
+                @socket.connect_nonblock(@saddress)
+            rescue IO::WaitWritable
+                if IO.select([@socket],[@socket],nil,@timeout)
+                    begin
+                        @socket.connect_nonblock(@saddress)
+                    rescue Errno::EISCONN
+                    rescue => error
+                        @socket.close
+                        raise error
+                    end
+                else
+                    @socket.close
+                    raise "Error: connection timed out after #{@timeout} seconds"
+                end
+            end
+
+            result = true
+
+            if (@deep_check)
+                if (@p_uri)
+                    send_options_message()
+                    if RTSP_SUCCESSFULL_RESPONSE_LINE != @socket.gets
+                        result = false
+                    end
+                else
+                    if @logging
+                        puts LOG_WARNING + "skipping deep_check, since no " \
+                        "RTSP uri was given"
+                    end
+                end
+            end
+
+            @socket.close
+            return result
+        end
+
+        private
+
+            def initialize_socket
+                @socket = Socket.new(Socket::AF_INET,Socket::SOCK_STREAM,0)
+                @saddress = Socket.sockaddr_in(@port,@host)
+            end
+
+            def send_options_message
+                @cseq = @cseq + 1
+                options_message = "OPTIONS #{@uri} RTSP/1.0\r\n" \
+                    "CSeq: #{@cseq}\r\n" \
+                    "User-Agent: #{USER_AGENT}\r\n"
+
+                if @p_uri.userinfo
+                    options_message = options_message +
+                    "Authorization: Basic " + Base64.encode64(@p_uri.userinfo) + "\r\n"
+                end
+
+                options_message = options_message + "\r\n"
+                @socket.write(options_message)
+            end
+
+            attr_accessor :socket, :saddress, :cseq, :user_agent
+    end
+end
+
+

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: rtsptools
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Mario Gasparoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-13 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  rtsptools is a simple module for testing RTSP media sources.
+    Initiallly, this is intended to be used by applications that need to
+    constantly check the status of RTSP media sources, such as IP Cameras.
+email: mariogasparoni@mgmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rtsptools.rb
+homepage: https://github.com/mariogasparoni/rtsptools
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A set of tools for testing RTSP media sources
+test_files: []