rtsp 0.2.2 → 0.3.0

data/ChangeLog.rdoc

@@ -1,3 +1,10 @@
+=== 0.3.0 / 2012-03-02
+
+* Extracted RTP-esque functionality to an +rtp+ gem, on which this gem is now
+  dependent on version 0.0.1 of that.
+* Laxed dependency requirement on parslet.
+* Bumped dependency requirement on sdp to ~> 0.2.6, due to parslet conflicts
+
 === 0.2.2 / 2011-11-02
 
 * Added a queue for listening and building the RTP file from the received data.

data/features/step_definitions/client_requests_steps.rb

@@ -41,7 +41,7 @@ Then /^I should receive an RTSP response to that OPTIONS request$/ do
   @response.message.should == "OK"
   @response.cseq.should == 1
   @response.public.should == "DESCRIBE, SETUP, TEARDOWN, PLAY, PAUSE"
-  @response.body.should be_nil
+  @response.body.should be_empty
 end
 
 Then /^I should receive an RTSP response to that DESCRIBE request$/ do

data/lib/rtsp.rb

@@ -3,6 +3,4 @@ require_relative 'rtsp/version'
 
 # This base module simply defines properties about the library.  See child
 # classes/modules for the meat.
-module RTSP
-  
-end
+module RTSP; end

data/lib/rtsp/client.rb

@@ -1,9 +1,9 @@
 require 'socket'
 require 'tempfile'
 require 'timeout'
+require 'rtp/receiver'
 
 require_relative 'transport_parser'
-require_relative 'capturer'
 require_relative 'error'
 require_relative 'global'
 require_relative 'helpers'
@@ -13,7 +13,7 @@ require_relative 'response'
 module RTSP
 
   # This is the main interface to an RTSP server.  A client object uses a couple
-  # main objects for configuration: an +RTSP::Capturer+ and a Connection Struct.
+  # main objects for configuration: an +RTP::Receiver+ and a Connection Struct.
   # Use the capturer to configure how to capture the data which is the RTP
   # stream provided by the RTSP server.  Use the connection object to control
   # the connection to the server.
@@ -56,7 +56,6 @@ module RTSP
     include RTSP::Helpers
     extend RTSP::Global
 
-    DEFAULT_CAPFILE_NAME = "ruby_rtsp_capture.rtsp"
     MAX_BYTES_TO_RECEIVE = 3000
 
     # @return [URI] The URI that points to the RTSP server's resource.
@@ -80,8 +79,8 @@ module RTSP
     attr_accessor :connection
 
     # Use to get/set an object for capturing received data.
-    # @param [RTSP::Capturer]
-    # @return [RTSP::Capturer]
+    # @param [RTP::Receiver]
+    # @return [RTP::Receiver]
     attr_accessor :capturer
 
     # @return [Symbol] See {RFC section A.1.}[http://tools.ietf.org/html/rfc2326#page-76]
@@ -95,7 +94,7 @@ module RTSP
 
     # @param [String] server_url URL to the resource to stream.  If no scheme is
     #   given, "rtsp" is assumed.  If no port is given, 554 is assumed.
-    # @yield [Struct::Connection, RTSP::Capturer]
+    # @yield [Struct::Connection, RTP::Receiver]
     # @yieldparam [Struct::Connection] server_url=
     # @yieldparam [Struct::Connection] timeout=
     # @yieldparam [Struct::Connection] socket=
@@ -111,7 +110,7 @@ module RTSP
       end
 
       @connection = Struct::Connection.new
-      @capturer   = RTSP::Capturer.new
+      @capturer   = RTP::Receiver.new
 
       yield(connection, capturer) if block_given?
 
@@ -124,7 +123,7 @@ module RTSP
       @capturer.rtp_port           ||= 9000
       @capturer.transport_protocol ||= :UDP
       @capturer.broadcast_type     ||= :unicast
-      @capturer.rtp_file           ||= Tempfile.new(DEFAULT_CAPFILE_NAME)
+      @capturer.rtp_file           ||= Tempfile.new(RTP::Receiver::DEFAULT_CAPFILE_NAME)
 
       @play_thread = nil
       @cseq        = 1

data/lib/rtsp/message.rb

@@ -138,8 +138,8 @@ module RTSP
     end
 
     # @param [String] value Content to send as the body of the message.
-    # Generally this will be a String of some sort, but could be binary data as
-    # well. Also, this adds the Content-Length header to the header list.
+    #   Generally this will be a String of some sort, but could be binary data as
+    #   well. Also, this adds the Content-Length header to the header list.
     def body= value
       add_body value
     end
@@ -201,7 +201,9 @@ module RTSP
     # @return [String]
     def headers_to_s headers
       header_string = headers.inject("") do |result, (key, value)|
-        header_name = key.to_s.split(/_/).map { |header| header.capitalize }.join('-')
+        header_name = key.to_s.split(/_/).map do |header|
+          header.capitalize
+        end.join('-')
 
         header_name = "CSeq" if header_name == "Cseq"
 
@@ -248,8 +250,8 @@ module RTSP
     # Turns header values into a single string.
     #
     # @param [] values The header values to put to string.
-    # @param [String] separator The character to use to separate multiple values
-    # that define a header.
+    # @param [String] separator The character to use to separate multiple
+    #   values that define a header.
     # @return [String] The header values as a single string.
     def values_to_s(values, separator=";")
       result = values.inject("") do |values_string, (header_field, header_field_value)|

data/lib/rtsp/response.rb

@@ -16,7 +16,8 @@ module RTSP
     # server/client.
     def initialize(raw_response)
       if raw_response.nil? || raw_response.empty?
-        raise RTSP::Error, "#{self.class} received nil string--this shouldn't happen."
+        raise RTSP::Error,
+          "#{self.class} received nil string--this shouldn't happen."
       end
 
       @raw_response = raw_response
@@ -77,9 +78,9 @@ module RTSP
       end
     end
 
-    # Reads through each header line of the RTSP response, extracts the response
-    # code, response message, response version, and creates a snake-case
-    # accessor with that value set.
+    # Reads through each header line of the RTSP response, extracts the
+    # response code, response message, response version, and creates a
+    # snake-case accessor with that value set.
     #
     # @param [String] head The section of headers from the response text.
     def parse_head head
@@ -90,7 +91,7 @@ module RTSP
           extract_status_line(line)
           next
         end
-        
+
         if line.include? ": "
           header_and_value = line.strip.split(":", 2)
           header_name = header_and_value.first.downcase.gsub(/-/, "_")
@@ -119,8 +120,8 @@ module RTSP
 
     private
 
-    # Creates an attr_reader with the name given and sets it to the value that's
-    # given.
+    # Creates an attr_reader with the name given and sets it to the value
+    # that's given.
     #
     # @param [String] name
     # @param [String] value

data/lib/rtsp/version.rb

@@ -1,4 +1,4 @@
 module RTSP
   # rtsp version
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/rtsp.gemspec

@@ -8,37 +8,33 @@ Gem::Specification.new do |s|
   s.name = "rtsp"
   s.version = RTSP::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Steve Loveless, Mike Kirby"]
-  s.date = %q{2011-04-14}
+  s.homepage = %q{http://rubygems.org/gems/rtsp}
+  s.authors = ["Steve Loveless, Mike Kirby", "Sujin Philip"]
+  s.summary = %q{Library to allow RTSP streaming from RTSP-enabled devices.}
   s.description = %q{This library intends to follow the RTSP RFC document (2326)
 to allow for working with RTSP servers.  At this point, it's up to you to parse
 the data from a play call, but we'll get there.  ...eventually.
 For more information see: http://www.ietf.org/rfc/rfc2326.txt}
-  s.email = ["steve.loveless@gmail.com, mkiby@gmail.com"]
-  s.executables = ["rtsp_client"]
-  s.extra_rdoc_files = [
-    "ChangeLog.rdoc",
-      "LICENSE.rdoc",
-      "README.rdoc"
-  ]
-  s.files = Dir.glob("{lib,bin,tasks}/**/*") +
-    %w(.gemtest rtsp.gemspec) +
-    %w(Gemfile ChangeLog.rdoc LICENSE.rdoc README.rdoc Rakefile)
-  s.homepage = %q{http://rubygems.org/gems/rtsp}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{rtsp}
+  s.email = %w{steve.loveless@gmail.com}
+  s.licenses = %w{MIT}
+
+  s.executables = %w{rtsp_client}
+  s.files = Dir.glob("{lib,bin,spec,tasks}/**/*") + Dir.glob("*.rdoc") +
+    %w(.gemtest rtsp.gemspec Gemfile Rakefile)
+  s.extra_rdoc_files = %w{ChangeLog.rdoc LICENSE.rdoc README.rdoc}
+  s.require_paths = %w{lib}
   s.rubygems_version = %q{1.7.2}
-  s.summary = %q{Library to allow RTSP streaming from RTSP-enabled devices.}
   s.test_files = Dir.glob("{spec,features}/**/*")
 
-  s.add_runtime_dependency(%q<parslet>, ["~> 1.1.0"])
-  s.add_runtime_dependency(%q<sdp>, ["~> 0.2.2"])
+  s.add_runtime_dependency(%q<parslet>, [">= 1.1.0"])
+  s.add_runtime_dependency(%q<rtp>, [">= 0.0.1"])
+  s.add_runtime_dependency(%q<sdp>, ["~> 0.2.6"])
 
-  s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+  s.add_development_dependency(%q<bundler>)
   s.add_development_dependency(%q<code_statistics>, ["~> 0.2.13"])
-  s.add_development_dependency(%q<metric_fu>, [">= 2.0.0"])
+  s.add_development_dependency(%q<cucumber>, [">= 1.1.0"])
+  s.add_development_dependency(%q<roodi>, [">= 2.1.0"])
+  s.add_development_dependency(%q<rake>, [">= 0.8.7"])
   s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
   s.add_development_dependency(%q<simplecov>, [">= 0.4.0"])
   s.add_development_dependency(%q<yard>, [">= 0.6.0"])

data/spec/rtsp/client_spec.rb

@@ -1,7 +1,7 @@
 require 'sdp'
 require_relative '../spec_helper'
 require 'rtsp/client'
-require 'support/fake_rtsp_server'
+require_relative '../support/fake_rtsp_server'
 
 describe RTSP::Client do
   def setup_client_at(url)
@@ -20,8 +20,8 @@ describe RTSP::Client do
   end
 
   before do
-    RTSP::Capturer.any_instance.stub(:run)
-    RTSP::Capturer.any_instance.stub(:stop)
+    RTP::Receiver.any_instance.stub(:run)
+    RTP::Receiver.any_instance.stub(:stop)
   end
 
   describe "#initialize" do

data/tasks/roodi.rake

@@ -0,0 +1,9 @@
+require 'rake/tasklib'  # roodi_task fails without this.
+require 'roodi'
+require 'roodi_task'
+
+RoodiTask.new do |t|
+  t.config = 'tasks/roodi_config.yaml'
+  t.patterns = Dir.glob("{features,lib,spec}/**/*.rb")
+  t.verbose = true
+end

data/tasks/{roodi_config.yml → roodi_config.yaml}

@@ -2,13 +2,13 @@
 AssignmentInConditionalCheck:    { }
 CaseMissingElseCheck:            { }
 ClassLineCountCheck:             { line_count: 300 }
-ClassNameCheck:                  { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+ClassNameCheck:                  { pattern: !ruby/regexp '/^[A-Z][a-zA-Z0-9]*$/' }
 CyclomaticComplexityBlockCheck:  { complexity: 4 }
 CyclomaticComplexityMethodCheck: { complexity: 8 }
 EmptyRescueBodyCheck:            { }
 ForLoopCheck:                    { }
 MethodLineCountCheck:            { line_count: 30 }
-MethodNameCheck:                 { pattern: !ruby/regexp /^[_a-z<>=\[\]|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ }
+MethodNameCheck:                 { pattern: !ruby/regexp '/^[_a-z<>=\[\]|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/' }
 ModuleLineCountCheck:            { line_count: 300 }
-ModuleNameCheck:                 { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+ModuleNameCheck:                 { pattern: !ruby/regexp '/^[A-Z][a-zA-Z0-9]*$/' }
 ParameterNumberCheck:            { parameter_count: 5 }

metadata

@@ -1,52 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: rtsp
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
 - Steve Loveless, Mike Kirby
+- Sujin Philip
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-04-14 00:00:00.000000000 Z
+date: 2012-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
-  requirement: &70200108735200 !ruby/object:Gem::Requirement
+  requirement: &70350646954280 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70200108735200
+  version_requirements: *70350646954280
+- !ruby/object:Gem::Dependency
+  name: rtp
+  requirement: &70350646952740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70350646952740
 - !ruby/object:Gem::Dependency
   name: sdp
-  requirement: &70200108733900 !ruby/object:Gem::Requirement
+  requirement: &70350646950580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *70200108733900
+  version_requirements: *70350646950580
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70200108733140 !ruby/object:Gem::Requirement
+  requirement: &70350646949960 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70200108733140
+  version_requirements: *70350646949960
 - !ruby/object:Gem::Dependency
   name: code_statistics
-  requirement: &70200108731600 !ruby/object:Gem::Requirement
+  requirement: &70350646948280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,21 +66,43 @@ dependencies:
         version: 0.2.13
   type: :development
   prerelease: false
-  version_requirements: *70200108731600
+  version_requirements: *70350646948280
 - !ruby/object:Gem::Dependency
-  name: metric_fu
-  requirement: &70200108731040 !ruby/object:Gem::Requirement
+  name: cucumber
+  requirement: &70350646946800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *70200108731040
+  version_requirements: *70350646946800
+- !ruby/object:Gem::Dependency
+  name: roodi
+  requirement: &70350646945400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *70350646945400
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70350646944500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *70350646944500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70200108730460 !ruby/object:Gem::Requirement
+  requirement: &70350646943460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +110,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *70200108730460
+  version_requirements: *70350646943460
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70200108729440 !ruby/object:Gem::Requirement
+  requirement: &70350646942580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +121,10 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *70200108729440
+  version_requirements: *70350646942580
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70200108727820 !ruby/object:Gem::Requirement
+  requirement: &70350646941760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +132,7 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70200108727820
+  version_requirements: *70350646941760
 description: ! 'This library intends to follow the RTSP RFC document (2326)
 
   to allow for working with RTSP servers.  At this point, it''s up to you to parse
@@ -107,7 +141,7 @@ description: ! 'This library intends to follow the RTSP RFC document (2326)
 
   For more information see: http://www.ietf.org/rfc/rfc2326.txt'
 email:
-- steve.loveless@gmail.com, mkiby@gmail.com
+- steve.loveless@gmail.com
 executables:
 - rtsp_client
 extensions: []
@@ -117,7 +151,6 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - lib/ext/logger.rb
-- lib/rtsp/capturer.rb
 - lib/rtsp/client.rb
 - lib/rtsp/error.rb
 - lib/rtsp/global.rb
@@ -128,17 +161,6 @@ files:
 - lib/rtsp/version.rb
 - lib/rtsp.rb
 - bin/rtsp_client
-- tasks/metrics.rake
-- tasks/roodi_config.yml
-- tasks/stats.rake
-- .gemtest
-- rtsp.gemspec
-- Gemfile
-- ChangeLog.rdoc
-- LICENSE.rdoc
-- README.rdoc
-- Rakefile
-- spec/rtsp/capturer_spec.rb
 - spec/rtsp/client_spec.rb
 - spec/rtsp/helpers_spec.rb
 - spec/rtsp/message_spec.rb
@@ -147,6 +169,16 @@ files:
 - spec/rtsp_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_rtsp_server.rb
+- tasks/roodi.rake
+- tasks/roodi_config.yaml
+- tasks/stats.rake
+- ChangeLog.rdoc
+- LICENSE.rdoc
+- README.rdoc
+- .gemtest
+- rtsp.gemspec
+- Gemfile
+- Rakefile
 - features/client_changes_state.feature
 - features/client_requests.feature
 - features/control_streams_as_client.feature
@@ -173,15 +205,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubyforge_project: rtsp
-rubygems_version: 1.8.10
+rubyforge_project: 
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Library to allow RTSP streaming from RTSP-enabled devices.
 test_files:
-- spec/rtsp/capturer_spec.rb
 - spec/rtsp/client_spec.rb
 - spec/rtsp/helpers_spec.rb
 - spec/rtsp/message_spec.rb

data/lib/rtsp/capturer.rb

@@ -1,223 +0,0 @@
-require 'tempfile'
-require 'socket'
-
-require_relative 'error'
-
-module RTSP
-
-  # Objects of this type can be used with a +RTSP::Client+ object in order to
-  # capture the RTP data transmitted to the client as a result of an RTSP
-  # PLAY call.
-  #
-  # In this version, objects of this type don't do much other than just capture
-  # the data to a file; in later versions, objects of this type will be able
-  # to provide a "sink" and allow for ensuring that the received  RTP packets
-  # will be reassembled in the correct order, as they're written to file
-  # (objects of this type don't don't currently allow for checking RTP sequence
-  # numbers on the data that's been received).
-  class Capturer
-
-    # Name of the file the data will be captured to unless #rtp_file is set.
-    DEFAULT_CAPFILE_NAME = "rtsp_capture.rtsp"
-
-    # Maximum number of bytes to receive on the socket.
-    MAX_BYTES_TO_RECEIVE = 3000
-
-    # Maximum times to retry using the next greatest port number.
-    MAX_PORT_NUMBER_RETRIES = 50
-
-    # @param [File] rtp_file The file to capture the RTP data to.
-    # @return [File]
-    attr_accessor :rtp_file
-
-    # @param [Fixnum] rtp_port The port on which to capture the RTP data.
-    # @return [Fixnum]
-    attr_accessor :rtp_port
-
-    # @param [Symbol] transport_protocol +:UDP+ or +:TCP+.
-    # @return [Symbol]
-    attr_accessor :transport_protocol
-
-    # @param [Symbol] broadcast_type +:multicast+ or +:unicast+.
-    # @return [Symbol]
-    attr_accessor :broadcast_type
-
-    # @param [Symbol] transport_protocol The type of socket to use for capturing
-    #   the data. +:UDP+ or +:TCP+.
-    # @param [Fixnum] rtp_port The port on which to capture RTP data.
-    # @param [File] capture_file The file object to capture the RTP data to.
-    def initialize(transport_protocol=:UDP, rtp_port=9000, rtp_capture_file=nil)
-      @transport_protocol = transport_protocol
-      @rtp_port = rtp_port
-      @rtp_file = rtp_capture_file || Tempfile.new(DEFAULT_CAPFILE_NAME)
-      @listener = nil
-      @file_builder = nil
-      @queue = Queue.new
-    end
-
-    # Initializes a server of the correct socket type.
-    #
-    # @return [UDPSocket, TCPSocket]
-    # @raise [RTSP::Error] If +@transport_protocol was not set to +:UDP+ or
-    #   +:TCP+.
-    def init_server(protocol, port=9000)
-      if protocol == :UDP
-        server = init_udp_server(port)
-      elsif protocol == :TCP
-        server = init_tcp_server(port)
-      else
-        raise RTSP::Error, "Unknown streaming_protocol requested: #{@transport_protocol}"
-      end
-
-      server
-    end
-
-    # Simply calls #start_file_builder and #start_listener.
-    def run
-      log "Starting #{self.class} on port #{@rtp_port}..."
-
-      start_file_builder
-      start_listener
-    end
-
-    # Starts the +@file_builder+ thread that pops data off of the Queue that
-    # #start_listener pushed data on to.  It then takes that data and writes it
-    # to +@rtp_file+.
-    #
-    # @return [Thread] The file_builder thread (+@file_builder+)
-    def start_file_builder
-      return @file_builder if @file_builder and @file_builder.alive?
-
-      @file_builder = Thread.start(@rtp_file) do |rtp_file|
-        loop do
-          rtp_file.write @queue.pop until @queue.empty?
-        end
-      end
-
-      @file_builder.abort_on_exception = true
-    end
-
-    # Starts the +@listener+ thread that starts up the server, then takes the
-    # data received from the server and pushes it on to the +@queue+ so
-    # the +@file_builder+ thread can deal with it.
-    #
-    # @return [Thread] The listener thread (+@listener+).
-    def start_listener
-      return @listener if @listener and @listener.alive?
-
-      @listener = Thread.start do
-        server = init_server(@transport_protocol, @rtp_port)
-
-        loop do
-          data = server.recvfrom(MAX_BYTES_TO_RECEIVE).first
-          log "received data with size: #{data.size}"
-          @queue << data
-        end
-      end
-
-      @listener.abort_on_exception = true
-    end
-
-    # @return [Boolean] true if the +@listener+ thread is running; false if not.
-    def listening?
-      if @listener then @listener.alive? else false end
-    end
-
-    # @return [Boolean] true if the +@file_builder+ thread is running; false if
-    #   not.
-    def file_building?
-      if @file_builder then @file_builder.alive? else false end
-    end
-
-    # Returns if the #run loop is in action.
-    #
-    # @return [Boolean] true if the run loop is running.
-    def running?
-      listening? || file_building?
-    end
-
-    # Breaks out of the run loop.
-    def stop
-      log "Stopping #{self.class} on port #{@rtp_port}..."
-      stop_listener
-      log "listening? #{listening?}"
-      stop_file_builder
-      log "file building? #{file_building?}"
-      log "running? #{running?}"
-      @queue = Queue.new
-    end
-
-    # Kills the +@listener+ thread and sets the variable to nil.
-    def stop_listener
-      @listener.kill if @listener
-      @listener = nil
-    end
-
-    # Kills the +@file_builder+ thread and sets the variable to nil.
-    def stop_file_builder
-      @file_builder.kill if @file_builder
-      @file_builder = nil
-    end
-
-    # Sets up to receive data on a UDP socket, using +@rtp_port+.
-    #
-    # @param [Fixnum] port Port number to listen for RTP data on.
-    # @return [UDPSocket]
-    def init_udp_server(port)
-      port_retries = 0
-
-      begin
-        server = UDPSocket.open
-        server.bind('0.0.0.0', port)
-      rescue Errno::EADDRINUSE
-        log "RTP port #{port} in use, trying #{port + 1}..."
-        port += 1
-        port_retries += 1
-        retry until port_retries == MAX_PORT_NUMBER_RETRIES + 1
-        port = 9000
-        raise
-      end
-
-      @rtp_port = port
-      log "UDP server setup to receive on port #{@rtp_port}"
-
-      server
-    end
-
-    # Sets up to receive data on a TCP socket, using +@rtp_port+.
-    #
-    # @param [Fixnum] port Port number to listen for RTP data on.
-    # @return [TCPServer]
-    def init_tcp_server(port)
-      port_retries = 0
-
-      begin
-        server = TCPServer.new(port)
-      rescue Errno::EADDRINUSE
-        log "RTP port #{port} in use, trying #{port + 1}..."
-        port += 1
-        port_retries += 1
-        retry until port_retries == MAX_PORT_NUMBER_RETRIES + 1
-        port = 9000
-        raise
-      end
-
-      @rtp_port = port
-      log "TCP server setup to receive on port #{@rtp_port}"
-
-      server
-    end
-
-    # PRIVATES!
-    private
-
-    # Quick wrapper for when not using RTSP::Client (i.e. during tests).
-    #
-    # @param [String] message The String to log.
-    def log(message)
-      if defined? RTSP::Client
-        RTSP::Client.log "<#{self.class}> #{message}"
-      end
-    end
-  end
-end

data/spec/rtsp/capturer_spec.rb

@@ -1,258 +0,0 @@
-require_relative '../spec_helper'
-require 'rtsp/capturer'
-
-Thread.abort_on_exception = true
-
-def use_udp_ports(range)
-  sockets = []
-
-  range.each do |port|
-    begin
-      socket = UDPSocket.open
-      socket.bind('0.0.0.0', port)
-      sockets << socket
-    rescue Errno::EADDRINUSE
-      # That's ok
-    end
-  end
-
-  sockets
-end
-
-describe RTSP::Capturer do
-  before do
-    if defined? RTSP::Client
-      RTSP::Client.log = false
-    end
-  end
-
-  describe "#initialize" do
-    context "with default parameters" do
-      it "uses UDP" do
-        subject.instance_variable_get(:@transport_protocol).should == :UDP
-      end
-
-      it "uses port 9000" do
-        subject.instance_variable_get(:@rtp_port).should == 9000
-      end
-
-      it "creates a new Tempfile" do
-        subject.instance_variable_get(:@rtp_file).should be_a Tempfile
-      end
-    end
-
-    context "non-default parameters" do
-      it "can use TCP" do
-        capturer = RTSP::Capturer.new(:TCP)
-        capturer.instance_variable_get(:@transport_protocol).should == :TCP
-      end
-
-      it "can take another port" do
-        capturer = RTSP::Capturer.new(:UDP, 12345)
-        capturer.instance_variable_get(:@rtp_port).should == 12345
-      end
-
-      it "can take an IO object" do
-        fd = IO.sysopen("/dev/null", "w")
-        io = IO.new(fd, 'w')
-        capturer = RTSP::Capturer.new(:UDP, 12345, io)
-        capturer.instance_variable_get(:@rtp_file).should be_a IO
-      end
-    end
-
-    it "isn't running" do
-      RTSP::Capturer.new.should_not be_running
-    end
-  end
-
-  describe "#init_server" do
-    context "UDP" do
-      it "calls #init_udp_server with port 9000" do
-        subject.should_receive(:init_udp_server).with(9000)
-        subject.init_server(:UDP)
-      end
-
-      it "returns a UDPSocket" do
-        subject.init_server(:UDP).should be_a(UDPSocket)
-      end
-    end
-
-    context "TCP" do
-      it "calls #init_tcp_server with port 9000" do
-        subject.should_receive(:init_tcp_server).with(9000)
-        subject.init_server(:TCP)
-      end
-
-      it "returns a TCPServer" do
-        subject.init_server(:TCP).should be_a(TCPServer)
-      end
-    end
-
-    it "raises an RTSP::Error when some other protocol is given" do
-      expect { subject.init_server(:BOBO) }.to raise_error RTSP::Error
-    end
-  end
-
-  describe "#init_udp_server" do
-    after :each do
-      unless @sockets.nil?
-        @sockets.each { |s| s.close }
-      end
-    end
-
-    it "returns a UDPSocket" do
-      server = subject.init_udp_server(subject.rtp_port)
-      server.should be_a UDPSocket
-    end
-
-    it "retries MAX_PORT_NUMBER_RETRIES to get a port" do
-      @sockets = use_udp_ports 9000...(9000 + RTSP::Capturer::MAX_PORT_NUMBER_RETRIES)
-      subject.init_udp_server(subject.rtp_port)
-
-      subject.rtp_port.should == 9000 + RTSP::Capturer::MAX_PORT_NUMBER_RETRIES
-    end
-
-    context "when no available ports, it retries MAX_PORT_NUMBER_RETRIES times, then" do
-      before do
-        @sockets = use_udp_ports 9000..(9000 + RTSP::Capturer::MAX_PORT_NUMBER_RETRIES)
-      end
-
-      it "retries MAX_PORT_NUMBER_RETRIES times then raises" do
-        expect { subject.init_udp_server(subject.rtp_port) }.to raise_error Errno::EADDRINUSE
-      end
-
-      it "sets @rtp_port back to 9000 after trying all" do
-        expect { subject.init_udp_server(subject.rtp_port) }.to raise_error Errno::EADDRINUSE
-        subject.rtp_port.should == 9000
-      end
-    end
-  end
-
-  describe "#init_tcp_server" do
-    it "returns a TCPSocket" do
-      subject.init_tcp_server(3456).should be_a TCPSocket
-    end
-
-    it "uses port a port between 9000 and 9000 + MAX_PORT_NUMBER_RETRIES" do
-      subject.init_tcp_server(9000)
-      subject.rtp_port.should >= 9000
-      subject.rtp_port.should <= 9000 + RTSP::Capturer::MAX_PORT_NUMBER_RETRIES
-    end
-  end
-
-  describe "#run" do
-    after(:each) { subject.stop }
-
-    it "calls #start_file_builder and #start_listener" do
-      subject.should_receive(:start_listener)
-      subject.should_receive(:start_file_builder)
-      subject.run
-    end
-  end
-
-  describe "#running?" do
-    after(:each) { subject.stop }
-
-    it "returns false before issuing #run" do
-      subject.running?.should be_false
-    end
-
-    it "returns true after running" do
-      subject.run
-      subject.running?.should be_true
-    end
-
-    it "returns false after running then stopping" do
-      subject.run
-      subject.running?.should be_true
-      subject.stop
-      subject.running?.should be_false
-    end
-  end
-
-  describe "#stop" do
-    it "calls #stop_listener" do
-      subject.should_receive(:stop_listener)
-      subject.stop
-    end
-
-    it "calls #stop_file_builder" do
-      subject.should_receive(:stop_file_builder)
-      subject.stop
-    end
-
-    it "sets @queue back to a new Queue" do
-      queue = subject.instance_variable_get(:@queue)
-      subject.stop
-      subject.instance_variable_get(:@queue).should_not equal queue
-      subject.instance_variable_get(:@queue).should_not be_nil
-    end
-  end
-
-  [
-    {
-      start_method: "start_file_builder",
-      stop_method: "stop_file_builder",
-      ivar: "@file_builder"
-    },
-      {
-        start_method: "start_listener",
-        stop_method: "stop_listener",
-        ivar: "@listener"
-      }
-  ].each do |method_set|
-    describe "##{method_set[:start_method]}" do
-      before(:each) do
-        rtp_file = double "rtp_file"
-        rtp_file.stub(:write)
-        subject.rtp_file = rtp_file
-
-        server = double "A Server"
-        server.stub_chain(:recvfrom, :first).and_return("not nil")
-        subject.stub(:init_server).and_return(server)
-      end
-
-      after(:each) { subject.send(method_set[:stop_method].to_sym) }
-
-      it "starts the #{method_set[:ivar]} thread" do
-        subject.send(method_set[:start_method])
-        subject.instance_variable_get(method_set[:ivar].to_sym).should be_a Thread
-      end
-
-      it "returns the same #{method_set[:ivar]} if already started" do
-        subject.send(method_set[:start_method])
-        original_ivar = subject.instance_variable_get(method_set[:ivar].to_sym)
-        new_ivar = subject.send method_set[:start_method].to_sym
-        original_ivar.should equal new_ivar
-      end
-
-      if method_set[:start_method] == "start_listener"
-        it "pushes data on to the @queue" do
-          subject.start_listener
-          subject.instance_variable_get(:@queue).pop.should == "not nil"
-        end
-      end
-    end
-
-    describe "##{method_set[:stop_method]}" do
-      context "#{method_set[:ivar]} thread is running" do
-        before { subject.send(method_set[:start_method]) }
-
-        it "kills the thread" do
-          original_ivar = subject.instance_variable_get(method_set[:ivar].to_sym)
-          original_ivar.should_receive(:kill)
-          subject.send(method_set[:stop_method])
-        end
-      end
-
-      context "#{method_set[:ivar]} thread isn't running" do
-        it "doesn't try to kill the thread" do
-          allow_message_expectations_on_nil
-          original_ivar = subject.instance_variable_get(method_set[:ivar].to_sym)
-          original_ivar.should_not_receive(:kill)
-          subject.send(method_set[:stop_method])
-        end
-      end
-    end
-  end
-end

data/tasks/metrics.rake

@@ -1,27 +0,0 @@
-require 'metric_fu'
-
-MetricFu::Configuration.run do |config|
-  #define which metrics you want to use
-  #config.metrics  = [:churn, :flog, :flay, :reek, :roodi, :rcov, :stats]
-  config.metrics  = [:churn, :flay, :reek, :roodi, :rcov, :stats]
-  #config.graphs   = [:flog, :flay, :reek, :roodi, :rcov, :stats]
-  config.graphs   = [:flay, :reek, :roodi, :rcov, :stats]
-  config.churn    = { :start_date => "1 year ago", :minimum_churn_count => 10 }
-  config.flay     = { :dirs_to_flay => ['lib'],
-                      :minimum_score => 10,
-                      :filetypes => ['rb', 'erb'] }
-  config.flog     = { :dirs_to_flog => ['lib'] }
-  config.rcov     = { :environment => 'test',
-                      :test_files => ["spec/**/*_spec.rb"],
-                      :rcov_opts => ["--sort coverage",
-                                     "--no-html",
-                                     "--text-coverage",
-                                     "--spec-only",
-                                     "--no-color",
-                                     "--profile",
-                                     "--exclude /gems/,/Library/"]
-                    }
-  config.reek     = { :dirs_to_reek => ['lib'] }
-  config.roodi    = { :dirs_to_roodi => ['lib'], :roodi_config => "tasks/roodi_config.yml" }
-  config.graph_engine = :bluff
-end