sdp 0.1.0

data/spec/sdp/parser_spec.rb

@@ -0,0 +1,167 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'sdp/parser'
+require 'base64'
+
+describe SDP::Parser do
+  before :each do
+    @parser = SDP::Parser.new
+  end
+
+  context "does NOT raise when missing required values" do
+    it "version" do
+      lambda do
+        @parser.parse "o=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\nt=11111 22222\n"
+      end.should_not raise_error Parslet::ParseFailed
+    end
+
+    it "origin" do
+      lambda do
+        @parser.parse "v=0\ns=This is a test session\nt=11111 22222\n"
+      end.should_not raise_error Parslet::ParseFailed
+    end
+
+    it "name" do
+      lambda do
+        @parser.parse "v=0\no=steve 1234 5555 IN IP4 123.33.22.123\nt=11111 22222\n"
+      end.should_not raise_error Parslet::ParseFailed
+    end
+
+    it "timing" do
+      lambda do
+        @parser.parse "v=0\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\n"
+      end.should_not raise_error Parslet::ParseFailed
+    end
+  end
+
+  context "parses" do
+    it "required values" do
+      sdp = "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\nt=11111 22222\nm=audio 49170 RTP/AVP 0\n"
+      lambda { @parser.parse sdp }.should_not raise_error
+      sdp_hash = @parser.parse sdp
+      sdp_hash.should == { 
+        :session_section => {
+          :protocol_version=>"1",
+          :username=>"steve",
+          :id=>"1234",
+          :version=>"5555",
+          :network_type=>"IN",
+          :address_type=>"IP4",
+          :unicast_address=>"123.33.22.123",
+          :name=>"This is a test session",
+          :start_time=>"11111",
+          :stop_time=>"22222"
+          }, 
+        :media_sections=>[
+          { :media=>"audio", :port=>"49170", :protocol=>"RTP/AVP", :format=>"0" }
+        ]
+      }
+    end
+
+    it "other combinations" do
+      sdps = [
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\nb=CT:1000\nt=11111 22222\nr=7d 1h 0 25h\nz=2882844526 -1h 2898848070 0\n\k=prompt\na=recvonly\na=bobo:the clown\nm=video 49170/2 RTP/AVP 31\na=hotness\na=attribute2:do stuff\nm=audio 12335 RTP/AVP 99\na=make:it now\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\nb=CT:1000\nt=11111 22222\nr=7d 1h 0 25h\nz=2882844526 -1h 2898848070 0\n\k=prompt\na=recvonly\na=bobo:the clown\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\nb=CT:1000\nt=11111 22222\nr=7d 1h 0 25h\nz=2882844526 -1h 2898848070 0\n\k=prompt\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\nb=CT:1000\nt=11111 22222\nr=7d 1h 0 25h\nz=2882844526 -1h 2898848070 0\n\k=clear:password\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\nb=CT:1000\nt=11111 22222\nr=7d 1h 0 25h\nz=2882844526 -1h 2898848070 0\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\nb=CT:1000\nt=11111 22222\nr=7d 1h 0 25h\nz=2882844526 -1h\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\nb=CT:1000\nt=11111 22222\nr=7d 1h 0 25h\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\nb=CT:1000\nt=11111 22222\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\nb=CT:1000\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\nc=IN IP4 224.5.234.22/24\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\np=+1 555 123 0987\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\ne=bob@thing.com (Bob!)\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\nu=http://bobo.net/thispdf.pdf\n",
+       "v=1\no=steve 1234 5555 IN IP4 123.33.22.123\ns=This is a test session\ni=And here's some info\n"
+      ]
+
+      sdps.each do |sdp|
+        lambda { @parser.parse sdp }.should_not raise_error
+      end
+    end
+
+    it "alternate email address" do
+      sdp = "e=Jane Doe <j.doe@example.com>\r\n"
+      sdp_hash = @parser.parse sdp
+      sdp_hash[:session_section][:email_address].should == "Jane Doe <j.doe@example.com>"
+    end
+
+    it "connection data that uses TTL value" do
+      sdp = "c=IN IP4 224.2.36.42/127\r\n"
+      sdp_hash = @parser.parse sdp
+      sdp_hash[:session_section][:connection_address].should == "224.2.36.42/127"
+    end
+
+    it "connection data that uses IPv6 and address count" do
+      sdp = "c=IN IP6 FF15::101/3\r\n"
+      sdp_hash = @parser.parse sdp
+      sdp_hash[:session_section][:connection_address].should == "FF15::101/3"
+    end
+
+    it "repeat times in seconds" do
+      sdp = "r=604800 3600 0 90000\r\n"
+      sdp_hash = @parser.parse sdp
+      sdp_hash[:session_section][:repeat_interval].should == "604800"
+      sdp_hash[:session_section][:active_duration].should == "3600"
+      sdp_hash[:session_section][:offsets_from_start_time].should == "0 90000"
+    end
+
+    it "time zones" do
+      sdp = "z=2882844526 -1h 2898848070 0\r\n"
+      sdp_hash = @parser.parse sdp
+      sdp_hash[:session_section][:time_zones].first[:adjustment_time].should == "2882844526"
+      sdp_hash[:session_section][:time_zones].first[:offset].should == "-1h"
+      sdp_hash[:session_section][:time_zones].last[:adjustment_time].should == "2898848070"
+      sdp_hash[:session_section][:time_zones].last[:offset].should == "0"
+    end
+
+    context "encryption keys" do
+      it "clear" do
+        sdp = "k=clear:password\r\n"
+        sdp_hash = @parser.parse sdp
+        sdp_hash[:session_section][:encryption_method].should == "clear"
+        sdp_hash[:session_section][:encryption_key].should == "password"
+      end
+      
+      it "base64" do
+        # #encode64 adds newlines every 60 chars; remove them--they're unnecessary
+        password = Base64.encode64('password').gsub("\n", '')
+        sdp = "k=base64:#{password}\r\n"
+        sdp_hash = @parser.parse sdp
+        sdp_hash[:session_section][:encryption_method].should == "base64"
+        sdp_hash[:session_section][:encryption_key].should == password
+      end
+      
+      it "uri" do
+        uri = "http://aserver.com/thing.pdf"
+        sdp = "k=uri:#{uri}\r\n"
+        sdp_hash = @parser.parse sdp
+        sdp_hash[:session_section][:encryption_method].should == "uri"
+        sdp_hash[:session_section][:encryption_key].should == uri
+      end
+      
+      it "prompt" do
+        sdp = "k=prompt\r\n"
+        sdp_hash = @parser.parse sdp
+        sdp_hash[:session_section][:encryption_method].should == "prompt"
+        sdp_hash[:session_section][:encryption_key].should be_nil
+      end
+    end
+  end
+  
+  context "parses EOLs" do
+    it "parses \\r\\n" do
+      sdp = "v=123\r\n"
+      lambda { @parser.parse sdp }.should_not raise_error
+      sdp_hash = @parser.parse sdp
+      sdp_hash[:session_section][:protocol_version].should == "123"
+    end
+
+    it "parses \\n" do
+      sdp = "v=456\n"
+      lambda { @parser.parse sdp }.should_not raise_error
+      sdp_hash = @parser.parse sdp
+      sdp_hash[:session_section][:protocol_version].should == "456"
+    end
+  end
+end

data/spec/sdp_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+require 'sdp'
+
+SDP_TEXT =<<EOF
+v=0
+o=jdoe 2890844526 2890842807 IN IP4 10.47.16.5
+s=SDP Seminar
+i=A Seminar on the session description protocol
+u=http://www.example.com/seminars/sdp.pdf
+e=j.doe@example.com (Jane Doe)
+p=+1 617 555-6011
+c=IN IP4 224.2.17.12/127
+b=CT:1000
+t=2873397496 2873404696
+r=604800 3600 0 90000
+z=2882844526 -1h
+k=clear:password
+a=recvonly
+a=type:test
+m=audio 49170 RTP/AVP 0
+m=video 51372 RTP/AVP 99
+a=rtpmap:99 h263-1998/90000
+EOF
+
+describe SDP do
+  it "should have a VERSION constant" do
+    SDP.const_get('VERSION').should_not be_empty
+  end
+  
+  context "parses SDP text into a Hash" do
+    before do
+      @parsed_sdp = SDP.parse SDP_TEXT
+    end
+
+    it "has a version number of 0" do
+      @parsed_sdp.protocol_version.should == "0"
+      @parsed_sdp.protocol_version.class.should == String
+    end
+
+    context "origin" do
+      it "has a username of 'jdoe'" do
+        @parsed_sdp.username.should == 'jdoe'
+        @parsed_sdp.username.class.should == String
+      end
+
+      it "has a session_id of '2890844526'" do
+        @parsed_sdp.id.should == "2890844526"
+        @parsed_sdp.id.class.should == String
+      end
+
+      it "has a session_version of '2890842807'" do
+        @parsed_sdp.version.should == '2890842807'
+        @parsed_sdp.version.class.should == String
+      end
+
+      it "has a net_type of 'IN'" do
+        @parsed_sdp.network_type.should == "IN"
+        @parsed_sdp.network_type.class.should == String
+      end
+
+      it "has a address_type of 'IP4'" do
+        @parsed_sdp.address_type.should == "IP4"
+        @parsed_sdp.address_type.class.should == String
+      end
+
+      it "has a unicast_address of '10.47.16.5'" do
+        @parsed_sdp.unicast_address.should == "10.47.16.5"
+        @parsed_sdp.unicast_address.class.should == String
+      end
+    end
+
+    it "has a session name of 'SDP Seminar'" do
+      @parsed_sdp.name.should == "SDP Seminar"
+      @parsed_sdp.name.class.should == String
+    end
+
+    it "has a session information of 'A Seminar on the session description protocol'" do
+      @parsed_sdp.information.should == "A Seminar on the session description protocol"
+      @parsed_sdp.information.class.should == String
+    end
+
+    it "has a URI of 'http://www.example.com/seminars/sdp.pdf'" do
+      @parsed_sdp.uri.should == "http://www.example.com/seminars/sdp.pdf"
+      @parsed_sdp.uri.class.should == String
+    end
+
+    it "has an email address of 'j.doe@example.com (Jane Doe)'" do
+      @parsed_sdp.email_address.should == "j.doe@example.com (Jane Doe)"
+      @parsed_sdp.email_address.class.should == String
+    end
+
+    it "has a phone number of '+1 617 555-6011'" do
+      @parsed_sdp.phone_number.should == "+1 617 555-6011"
+      @parsed_sdp.phone_number.class.should == String
+    end
+
+    it "has a bandwidth type of 'CT'" do
+      @parsed_sdp.bandwidth_type.should == "CT"
+      @parsed_sdp.bandwidth_type.class.should == String
+    end
+
+    it "has a bandwidth of '1000'" do
+      @parsed_sdp.bandwidth.should == "1000"
+      @parsed_sdp.bandwidth.class.should == String
+    end
+
+    it "has a start time of '2873397496'" do
+      @parsed_sdp.start_time.should == '2873397496'
+      @parsed_sdp.start_time.class.should == String
+    end
+
+    it "has a stop time of '2873404696'" do
+      @parsed_sdp.stop_time.should == '2873404696'
+      @parsed_sdp.stop_time.class.should == String
+    end
+
+    it "has a repeat interval of '604800'" do
+      @parsed_sdp.repeat_interval.should == '604800'
+      @parsed_sdp.repeat_interval.class.should == String
+    end
+
+    it "has an active duration of '3600'" do
+      @parsed_sdp.active_duration.should == '3600'
+      @parsed_sdp.active_duration.class.should == String
+    end
+
+    it "has a offsets from start time of '0 90000'" do
+      @parsed_sdp.offsets_from_start_time.should == '0 90000'
+      @parsed_sdp.offsets_from_start_time.class.should == String
+    end
+
+    it "has a time zone adjustment of '2882844526'" do
+      @parsed_sdp.time_zones[:adjustment_time].should == '2882844526'
+      @parsed_sdp.time_zones[:adjustment_time].class.should == String
+    end
+
+    it "has a time zone offset of '-1h'" do
+      @parsed_sdp.time_zones[:offset].should == '-1h'
+      @parsed_sdp.time_zones[:offset].class.should == String
+    end
+
+    context "connection data" do
+      it "has a nettype of 'IN'" do
+        @parsed_sdp.network_type.should == "IN"
+        @parsed_sdp.network_type.class.should == String
+      end
+
+      it "has a addrtype of :IP4" do
+        @parsed_sdp.address_type.should == "IP4"
+        @parsed_sdp.address_type.class.should == String
+      end
+
+      it "has a connection address of '224.2.17.12/127'" do
+        @parsed_sdp.connection_address.should == '224.2.17.12/127'
+        @parsed_sdp.connection_address.class.should == String
+      end
+    end
+
+    context "session attributes" do
+      it "has an attribute of type 'recvonly' with an empty value" do
+        @parsed_sdp.attributes[0][:attribute].should == 'recvonly'
+        @parsed_sdp.attributes[0][:value].should == nil
+      end
+
+      it "has a second attribute 'type' with value 'test'" do
+        @parsed_sdp.attributes[1][:attribute].should == 'type'
+        @parsed_sdp.attributes[1][:value].should == 'test'
+      end
+    end
+  end
+
+  context "PROTOCOL_VERSION" do
+    it "has an PROTOCOL_VERSION constant defined" do
+      SDP.const_defined?('PROTOCOL_VERSION').should be_true
+    end
+
+    it "is set to 0" do
+      SDP::PROTOCOL_VERSION.should == 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'sdp/version'

data/tasks/metrics.rake

@@ -0,0 +1,25 @@
+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.graphs   = [:flog, :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

data/tasks/roodi_config.yml

@@ -0,0 +1,14 @@
+---
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 300 }
+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_<>=~@\[\]]*[=!\?]?$/ }
+ModuleLineCountCheck:            { line_count: 300 }
+ModuleNameCheck:                 { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+ParameterNumberCheck:            { parameter_count: 5 }

data/tasks/stats.rake

@@ -0,0 +1,13 @@
+require 'code_statistics'
+
+STATS_DIRECTORIES = [
+  %w(Library            lib/),
+  %w(Behavior\ tests    features/),
+  %w(Unit\ tests        spec/)
+].collect { |name, dir| [ name, "#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+
+desc "Report code statistics (KLOCs, etc) from the application"
+task :stats do
+  CodeStatistics.new(*STATS_DIRECTORIES).to_s
+end
+

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: sdp
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- sloveless
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: parslet
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: "This gem allows for parsing SDP (Session Description Protocol) information in to a Ruby object, making it easy to read and work with that data.  It also allows for easily creating SDP objects that can be converted to text using #to_s."
+email: steve.loveless@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- ChangeLog.rdoc
+- LICENSE.txt
+files: 
+- .document
+- .infinity_test
+- .rspec
+- .yardopts
+- ChangeLog.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- features/sdp_create.feature
+- features/sdp_get.feature
+- features/step_definitions/sdp_create_steps.rb
+- features/step_definitions/sdp_get_steps.rb
+- features/support/env.rb
+- features/support/sdp_file.txt
+- gemspec.yml
+- lib/sdp.rb
+- lib/sdp/description.rb
+- lib/sdp/parser.rb
+- lib/sdp/session_template.erb
+- lib/sdp/version.rb
+- sdp.gemspec
+- spec/sdp/description_spec.rb
+- spec/sdp/parser_spec.rb
+- spec/sdp_spec.rb
+- spec/spec_helper.rb
+- tasks/metrics.rake
+- tasks/roodi_config.yml
+- tasks/stats.rake
+has_rdoc: yard
+homepage: http://rubygems.org/gems/sdp
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: sdp
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Parse and create SDP (Session Description Protocol) text based on RFC4566.
+test_files: 
+- spec/sdp/description_spec.rb
+- spec/sdp/parser_spec.rb
+- spec/sdp_spec.rb