rtsp 0.0.1.alpha → 0.1.0

data/.document

@@ -0,0 +1,3 @@
+-
+ChangeLog.*
+LICENSE.rdoc

data/.infinity_test

@@ -1,4 +1,4 @@
 infinity_test do
-  use :rubies => %w(1.8.7 1.9.1 1.9.2), :test_framework => :rspec
+  use :rubies => %w(1.9.2), :test_framework => :rspec
   notifications :growl
 end

data/.yardopts

@@ -0,0 +1,4 @@
+--title "rtsp Documentation"
+--protected
+--private
+--readme README.rdoc

data/ChangeLog.rdoc

@@ -0,0 +1,9 @@
+=== 0.1.0 / 2011-04-12
+
+* Happy birthday!
+* All standard RTSP methods supported.
+* Captures RTP data to a file, but doesn't ensure RTP sequencing before putting to file.
+* One client object can only handle 1 stream; use a client per stream until this functionality
+  gets implemented.
+* Only handles unicast, UDP streams.
+* RTSP exceptions are all +RTSP::Error+s; this will change.

data/Gemfile

@@ -1,12 +1,21 @@
+require 'ore/specification'
+
 source :rubygems
 
-gem 'sdp', '~> 0.2.0'
+gemspec
+gem 'sdp', '~> 0.2.2'
+
+gem 'simplecov', '>= 0.4.0', :require => false, :group => :test
 
 group :development do
-  gem "rspec", '~> 2.4.0'
-  gem "hoe-yard", :require => "hoe/yard"
-  gem 'yard', '~> 0.6.0'
-  gem 'infinity_test'
-  gem 'metric_fu'
   gem 'code_statistics', '~> 0.2.13'
+  gem 'cucumber'
+  gem 'jeweler',    '~> 1.5.0'
+  gem 'metric_fu',  '>= 2.0.0'
+  gem 'ore',        '~> 0.7.2'
+  gem 'ore-core',   '~> 0.1.5'
+  gem 'ore-tasks',  '~> 0.5.0'
+  gem 'rake',       '~> 0.8.7'
+  gem "rspec",      '~> 2.5.0'
+  gem 'yard',       '~> 0.6.0'
 end

data/Gemfile.lock

@@ -1,13 +1,21 @@
+PATH
+  remote: .
+  specs:
+    rtsp (0.1.0)
+      rtsp
+      sdp (~> 0.2.2)
+      sdp (~> 0.2.0)
+
 GEM
   remote: http://rubygems.org/
   specs:
     Saikuro (1.1.0)
     abstract (1.0.0)
-    activesupport (3.0.3)
+    activesupport (3.0.6)
     arrayfields (4.7.4)
-    blankslate (2.1.2.3)
-    chronic (0.2.3)
-      hoe (>= 1.2.1)
+    blankslate (2.1.2.4)
+    builder (3.0.0)
+    chronic (0.3.0)
     churn (0.0.13)
       chronic (>= 0.2.3)
       hirb
@@ -17,45 +25,61 @@ GEM
       sexp_processor (~> 3.0.3)
     code_statistics (0.2.13)
     colored (1.2)
+    cucumber (0.10.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (>= 2.3.5)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.5)
     diff-lcs (1.1.2)
     erubis (2.6.6)
       abstract (>= 1.0.0)
     fattr (2.2.0)
-    flay (1.4.1)
+    flay (1.4.2)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    flog (2.5.0)
+    flog (2.5.1)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
+    gherkin (2.3.5)
+      json (>= 1.4.6)
+    gherkin (2.3.5-java)
+      json (>= 1.4.6)
+    git (1.2.5)
     haml (3.0.25)
-    hirb (0.3.6)
-    hoe (2.8.0)
-      rake (>= 0.8.7)
-    hoe-yard (0.1.2)
-      yard (>= 0.2.3.1)
+    hirb (0.4.3)
     i18n (0.5.0)
-    infinity_test (1.0.2)
-      notifiers (>= 1.1.0)
-      watchr (>= 0.7)
-    json_pure (1.4.6)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.5.1)
+    json (1.5.1-java)
+    json_pure (1.5.1)
     main (4.4.0)
       arrayfields (>= 4.7.4)
       fattr (>= 2.1.0)
-    metric_fu (2.0.1)
+    metric_fu (2.1.1)
       Saikuro (>= 1.1.0)
       activesupport (>= 2.0.0)
-      chronic (~> 0.2.3)
+      chronic (~> 0.3.0)
       churn (>= 0.0.7)
       flay (>= 1.2.1)
-      flog (>= 2.2.0)
-      rails_best_practices (>= 0.3.16)
+      flog (>= 2.3.0)
+      rails_best_practices (>= 0.6.4)
       rcov (>= 0.8.3.3)
       reek (>= 1.2.6)
       roodi (>= 2.1.0)
-    notifiers (1.1.0)
-    parslet (1.0.1)
-      blankslate (~> 2.1.2.3)
-    rails_best_practices (0.6.5)
+      syntax
+    ore (0.7.2)
+      ore-core (>= 0.1.4, ~> 0.1)
+      thor (~> 0.14.3)
+    ore-core (0.1.5)
+    ore-tasks (0.5.0)
+      ore-core (>= 0.1.3, ~> 0.1)
+    parslet (1.1.1)
+      blankslate (~> 2.0)
+    rails_best_practices (0.7.5)
       activesupport
       colored (~> 1.2)
       erubis (~> 2.6.6)
@@ -65,40 +89,54 @@ GEM
       ruby_parser (~> 2.0.4)
     rake (0.8.7)
     rcov (0.9.9)
+    rcov (0.9.9-java)
     reek (1.2.8)
       ruby2ruby (~> 1.2)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
     roodi (2.1.0)
       ruby_parser
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    rspec-mocks (2.5.0)
     ruby-progressbar (0.0.9)
     ruby2ruby (1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    ruby_parser (2.0.5)
+    ruby_parser (2.0.6)
       sexp_processor (~> 3.0)
-    sdp (0.2.0)
-      parslet (~> 1.0.0)
+    sdp (0.2.2)
+      parslet (~> 1.1.0)
     sexp_processor (3.0.5)
-    watchr (0.7)
-    yard (0.6.4)
+    simplecov (0.4.2)
+      simplecov-html (~> 0.4.4)
+    simplecov-html (0.4.4)
+    syntax (1.0.0)
+    term-ansicolor (1.0.5)
+    thor (0.14.6)
+    yard (0.6.7)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES
+  bundler (~> 1.0.0)
   code_statistics (~> 0.2.13)
-  hoe-yard
-  infinity_test
-  metric_fu
-  rspec (~> 2.4.0)
-  sdp (~> 0.2.0)
+  cucumber
+  jeweler (~> 1.5.0)
+  metric_fu (>= 2.0.0)
+  ore (~> 0.7.2)
+  ore-core (~> 0.1.5)
+  ore-tasks (~> 0.5.0)
+  rake (~> 0.8.7)
+  rspec (~> 2.5.0)
+  rtsp!
+  sdp (~> 0.2.2)
+  simplecov (>= 0.4.0)
   yard (~> 0.6.0)

data/LICENSE.rdoc

@@ -0,0 +1,20 @@
+Copyright (c) 2011 sloveless, mkirby
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/PostInstall.txt

@@ -2,6 +2,3 @@
 Thanks for installing rtsp.  We hope you get some good streaming out of it!
 
 Take a look at the README to help get you started.
-
-NOTE: This is only an alpha version!!  It is not well tested and doesn't have
-much error handling built in yet.

data/README.rdoc

@@ -1,4 +1,4 @@
-= rtsp_client
+= rtsp
 
 * https://github.com/turboladen/rtsp
 
@@ -16,24 +16,91 @@ SDP: http://tools.ietf.org/html/rfc4566
 
 == FEATURES/PROBLEMS:
 
-* RTSP client
-* Currently, only unicast
+* All standard RTSP methods supported.
+* Captures RTP data to a file, but doesn't ensure RTP sequencing before putting to file.
+* One client object can only handle 1 stream; use a client per stream until this functionality
+gets implemented.
+* Only handles unicast, UDP streams.
+* RTSP exceptions are all +RTSP::Error+s; this will change.
 
 == SYNOPSIS:
 
-The uber-quick get started:
-
-  rtsp_client = RTSP::Client.new "192.168.1.10"
-  rtsp_client.setup :port => 8554
-  rtsp_client.play
-  rtsp_client.teardown
+The quick get started:
+
+  RTSP::Client.log?                # => true
+  RTSP::Client.log = false
+  client = RTSP::Client.new "rtsp://64.202.98.91/sa.sdp" do |connection, capturer|
+    connection.timeout = 5
+    capturer.rtp_port = 8554
+    capturer.rtp_file = File.open("captured_stuff.rtp", "wb")
+  end
+  
+  client.server_uri                   # => #<URI::Generic:0x00000100ba4db0 URL:rtsp://64.202.98.91:554/sa.sdp>
+  client.session_state                # => :init
+  client.cseq                         # => 1
+  client.connection.do_capture        # => true
+  client.connection.interleave        # => false
+  client.connection.timeout           # => 5
+  client.capturer.broadcast_type      # => :unicast
+  client.capturer.rtp_port            # => 8554
+  client.capturer.rtp_file            # => #<File:captured_stuff.rtp>
+  client.capturer.transport_protocol  # => :UDP
+  
+  response = client.options
+  response.class             # => RTSP::Response
+  response.code              # => 200
+  response.message           # => "OK"
+  client.cseq                # => 2
+  
+  response = client.describe
+  response.body.class             # => SDP::Description
+  response.content_type           # => "application/sdp"
+  response.server                 # => "DSS/5.5 (Build/489.7; Platform/Linux; Release/Darwin; )"
+  client.aggregate_control_track  # => "rtsp://64.202.98.91:554/sa.sdp/"
+  client.media_control_tracks     # => ["rtsp://64.202.98.91:554/sa.sdp/trackID=1"]
+  client.cseq                     # => 3
+  
+  response = client.setup(client.media_control_tracks.first)
+  response.session          # => 7098486223178290313
+  client.session            # => 7098486223178290313
+  client.cseq               # => 4
+  client.session_state      # => :ready
+
+
+  response = client.play(client.aggregate_control_track)
+  response.range            # => "npt=now="
+  resposne.rtp_info         # => "url=rtsp://64.202.98.91:554/sa.sdp/trackID=1"
+  client.session_state      # => :playing
+
+  # Wait while the video streams
+  sleep 5
+
+  client.pause(client.aggregate_control_track)
+  client.session_state    # => :ready
+
+  # Wait while the video is paused
+  sleep 2
+
+  client.teardown(client.aggregate_control_track)
+  client.session            # => 0
+  client.session_state      # => :init
+
+  # Check the streamed file's contents
+  puts client.capturer.rtp_file     # => (Lots of data)
 
 == REQUIREMENTS:
 
-* Ruby
-  * 1.8.7
-  * 1.9.1
-  * 1.9.2
+* (Tested) Rubies
+  * 1.9.2-p180
+* RubyGems
+  * sdp, '~> 0.2.2'
+* RubyGems (development)
+  * ore-core, '~> 0.1.0'
+  * jeweler, '~> 1.5.0'
+  * ore-tasks, '~> 0.3.0'
+  * yard, '~> 0.6.0'
+  * metric_fu
+  * code_statistics, '~> 0.2.13'
 
 == INSTALL:
 
@@ -43,32 +110,14 @@ The uber-quick get started:
 
 After checking out the source, run:
 
-  $ rake newb
+  $ bundle install
 
-This task will install any missing dependencies, run the tests/specs,
-and generate the RDoc.
+This task will install any missing dependencies.
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2010 FIX
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2011 Steve Loveless, Mike Kirby
+
+See LICENSE.rdoc for details.

data/Rakefile

@@ -1,57 +1,41 @@
 require 'rubygems' if RUBY_VERSION < "1.9.0"
-require 'hoe'
-require 'hoe/yard'
-require 'yard'
-require 'newgem/tasks'
-require 'bundler/setup'
-require File.expand_path(File.dirname(__FILE__)) + '/lib/rtsp'
+require 'rake'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
 
-Hoe.plugin :newgem
-Hoe.plugin :yard
-Hoe.plugin :cucumberfeatures
-Hoe.plugins.delete :rubyforge
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
 
-# Gets the description from the README file
-def get_descr_from_readme
-  paragraph_count = 0
+require 'ore/specification'
+require 'jeweler'
+Jeweler::Tasks.new(Ore::Specification.new)
 
-  File.readlines('README.rdoc', '').each do |paragraph|
-    paragraph_count += 1
+require 'ore/tasks'
+Ore::Tasks.new
 
-    return paragraph if paragraph_count == 2
-  end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = "-w"
+  t.rspec_opts = ['--format', 'documentation', '--color']
 end
+task :default => :spec
 
-# The main Gemspec definition
-Hoe.spec 'rtsp' do
-  self.summary        = 'Library to allow RTSP streaming from RTSP-enabled devices.'
-  self.developer('Steve Loveless & Mike Kirby', 'steve.loveless@gmail.com, mkirby@gmail.com')
-  self.post_install_message = File.readlines 'PostInstall.txt'
-  self.version        = RTSP::VERSION
-  self.url            = RTSP::WWW
-  self.description    = get_descr_from_readme
-  self.readme_file    = 'README.rdoc'
-  self.history_file   = 'History.txt'
-  self.rspec_options  += ['--color', '--format', 'documentation']
-  self.extra_deps     += [
-      ['sdp', '~>0.2.0']
-  ]
-  self.extra_dev_deps += [
-      ['rspec', ">=2.0.1"],
-      ['yard', '>=0.6.4'],
-      ['cucumber'],
-      ['hoe-yard', '>=0.1.2']
-  ]
-
-  self.test_globs = 'spec/*.rb'
-
-  # Extra Yard options
-  self.yard_title = "#{self.name} Documentation (#{self.version})"
-  self.yard_opts += ['--output-dir', 'doc']
-  self.yard_opts += ['--private']
-  self.yard_opts += ['--protected']
-  self.yard_opts += ['--verbose']
-  self.yard_opts += ['--files', 
-      [self.history_file, 'Manifest.txt', self.readme_file]
-  ]
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.options = ['--verbose']
 end
+
+# Load all extra rake tasks
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].each { |ext| load ext }
+