sdp 0.1.0

data/lib/sdp/parser.rb

@@ -0,0 +1,116 @@
+require 'sdp'
+require 'parslet'
+
+# Class for parsing SDP description text, ideally when receiving as some sort
+# of client that uses SDP for describing the session for that protocol.
+#
+# This parser _could_ raise an error when not finding a required SDP field, but
+# was instead designed to not do so.  For example, if the parser parses the
+# text from an SDP description, and that text is missing the Timing field (t=),
+# the RFC 4566 implies that this description isn't valid (because that field is
+# required).  Instead ofraising an exception, the parser lets the
+# SDP::Description class deal with this.
+class SDP::Parser < Parslet::Parser
+  # All of the fields
+  rule(:version) { str('v=') >> field_value.as(:protocol_version) >> eol }
+
+  rule(:origin) do
+    str('o=') >> field_value.as(:username) >> space >>
+      field_value.as(:id) >> space >>
+      field_value.as(:version) >> space >>
+      field_value.as(:network_type) >> space >>
+      field_value.as(:address_type) >> space >>
+      field_value.as(:unicast_address) >> eol
+  end
+
+  rule(:session_name) { str('s=') >> field_value_string.as(:name) >> eol }
+
+  rule(:session_information) do
+    str('i=') >> field_value_string.as(:information) >> eol
+  end
+
+  rule(:uri)  { str('u=') >> field_value.as(:uri) >> eol }
+
+  rule(:email_address) do
+    str('e=') >> field_value_string.as(:email_address) >> eol
+  end
+
+  rule(:phone_number) do
+    str('p=') >> field_value_string.as(:phone_number) >> eol
+  end
+
+  rule(:connection_data) do
+    str('c=') >> field_value >> space >> field_value >> space >>
+      field_value.as(:connection_address) >> eol
+  end
+
+  rule(:bandwidth) do
+    str('b=') >> match('[\w]').repeat(2).as(:bandwidth_type) >> str(':') >>
+      field_value.as(:bandwidth) >> eol
+  end
+
+  rule(:timing) do
+    str('t=') >> field_value.as(:start_time) >> space >>
+      field_value.as(:stop_time) >> eol
+  end
+
+  rule(:repeat_times) do
+    str('r=') >> field_value.as(:repeat_interval) >> space >>
+      field_value.as(:active_duration) >>
+      space >> field_value_string.as(:offsets_from_start_time) >> eol
+  end
+
+  rule(:time_zone_group) do
+    field_value.as(:adjustment_time) >> space >> field_value.as(:offset)
+  end
+
+  rule(:time_zones) do
+    str('z=') >> (time_zone_group >>
+      (space >> time_zone_group).repeat).as(:time_zones) >> eol
+  end
+
+  rule(:encryption_keys) do
+    str('k=') >> match('[\w]').repeat.as(:encryption_method) >>
+      (str(':') >> field_value.as(:encryption_key)).maybe >> eol
+  end
+
+  rule(:attribute) do
+    str('a=') >> match('[\w]').repeat(1).as(:attribute) >>
+      (str(':') >> field_value_string.as(:value)).maybe >> eol
+  end
+
+  rule(:attributes) { attribute.repeat(1).as(:attributes) }
+
+  rule(:media_description) do
+    str('m=') >> field_value.as(:media) >> space >>
+      field_value.as(:port) >> space >>
+      field_value.as(:protocol) >> space >>
+      field_value.as(:format) >> eol
+  end
+
+  # Generics
+  rule(:space)          { match('[ ]').repeat(1) }
+  rule(:eol)            { match('[\r]').maybe >> match('[\n]') }
+  rule(:field_value)    { match('\S').repeat }
+  rule(:field_value_string) { match('[^\r\n]').repeat }
+
+  # The SDP description
+  rule(:session_section) do
+    version.maybe >> origin.maybe >> session_name.maybe >>
+      session_information.maybe >> uri.maybe >> email_address.maybe >>
+      phone_number.maybe >> connection_data.maybe >> bandwidth.maybe >>
+      timing.maybe >> repeat_times.maybe >> time_zones.maybe >>
+      encryption_keys.maybe >> attributes.maybe
+  end
+
+  rule(:media_section) do
+    media_description >> attributes.maybe
+  end
+
+  rule(:description) do
+    session_section.as(:session_section) >>
+      media_section.repeat.as(:media_sections)
+  end
+
+  root :description
+end

data/lib/sdp/session_template.erb

@@ -0,0 +1,41 @@
+<%# -*- coding: UTF-8 -*- %>
+v=<%= protocol_version %>
+o=<%= username %> <%= id %> <%= version %> <%= network_type %> <%= address_type %> <%= unicast_address %>
+s=<%= name %>
+<% if information %>
+i=<%= information %>
+<% end %>
+<% if uri %>
+u=<%= uri %>
+<% end %>
+<% if email_address %>
+e=<%= email_address %>
+<% end %>
+<% if phone_number %>
+p=<%= phone_number %>
+<% end %>
+c=<%= network_type %> <%= address_type %> <%= connection_address %>
+<% if bandwidth %>
+b=<%= bandwidth_type %>:<%= bandwidth %>
+<% end %>
+t=<%= start_time %> <%= stop_time %>
+<% if repeat_interval %>
+r=<%= repeat_interval %> <%= active_duration %> <%= offsets_from_start_time %>
+<% end %>
+<% unless time_zones.empty? %>
+<% if time_zones.class == Array %>
+z=<% time_zones.each do |time_zone| %><%= time_zone[:adjustment_time] %> <%= time_zone[:offset] %><% end %>
+<% else %>
+z=<%= time_zones[:adjustment_time] %> <%= time_zones[:offset] %><% end %>
+<% end %>
+<% if encryption_method %>
+k=<%= encryption_method %><% if encryption_key %>:<%= encryption_key %><% end %>
+<% end %>
+<% unless attributes.empty? %>
+a=<% attributes.each do |a| %><%= a[:attribute] %><% if a[:value] %>:<%= a[:value] %><% end %><% end %>
+<% end %>
+<% media_sections.each do |media_section| %>
+m=<%= media_section[:media] %> <%= media_section[:port]%> <%= media_section[:protocol]%> <%= media_section[:format]%>
+<% if media_section[:attributes] %>
+<% media_section[:attributes].each do |attribute| %>
+a=<%= attribute[:attribute] %><% if attribute[:value] %>:<%= attribute[:value] %><% end %><% end %><% end %><% end %>

data/lib/sdp/version.rb

@@ -0,0 +1,4 @@
+class SDP
+  # sdp version
+  VERSION = "0.1.0"
+end

data/lib/sdp.rb

@@ -0,0 +1,23 @@
+require 'sdp/version'
+require 'sdp/description'
+require 'sdp/parser'
+
+# The only use for this class is the #parse method, which is in this
+# base class solely for convenience.  Other than this method, this
+# base class doesn't really do anything.
+class SDP
+
+  # Creates a parser and parses the given text in to an SDP::Description
+  # object.
+  #
+  # @param [String] sdp_text The text from an SDP description.
+  # @return [SDP::Description] The object that represents the description
+  # that was parsed.
+  def self.parse sdp_text
+    sdp_hash = SDP::Parser.new.parse sdp_text
+    SDP::Description.new(sdp_hash)
+  end
+end
+
+# Reclass so we can raise our own Exceptions.
+class SDP::RuntimeError < StandardError; end;

data/sdp.gemspec

@@ -0,0 +1,114 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sdp}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
+  s.authors = ["sloveless"]
+  s.date = %q{2011-01-22}
+  s.description = %q{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.}
+  s.email = %q{steve.loveless@gmail.com}
+  s.extra_rdoc_files = [
+    "ChangeLog.rdoc",
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.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"
+  ]
+  s.has_rdoc = %q{yard}
+  s.homepage = %q{http://rubygems.org/gems/sdp}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{sdp}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Parse and create SDP (Session Description Protocol) text based on RFC4566.}
+  s.test_files = [
+    "spec/sdp/description_spec.rb",
+    "spec/sdp/parser_spec.rb",
+    "spec/sdp_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<parslet>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_runtime_dependency(%q<parslet>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_development_dependency(%q<ore-core>, ["~> 0.1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.0"])
+      s.add_development_dependency(%q<ore-tasks>, ["~> 0.3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<infinity_test>, [">= 0"])
+      s.add_development_dependency(%q<metric_fu>, [">= 0"])
+      s.add_development_dependency(%q<code_statistics>, ["~> 0.2.13"])
+    else
+      s.add_dependency(%q<parslet>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<parslet>, ["~> 1.0.0"])
+      s.add_dependency(%q<rake>, ["~> 0.8.7"])
+      s.add_dependency(%q<ore-core>, ["~> 0.1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.0"])
+      s.add_dependency(%q<ore-tasks>, ["~> 0.3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<infinity_test>, [">= 0"])
+      s.add_dependency(%q<metric_fu>, [">= 0"])
+      s.add_dependency(%q<code_statistics>, ["~> 0.2.13"])
+    end
+  else
+    s.add_dependency(%q<parslet>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<parslet>, ["~> 1.0.0"])
+    s.add_dependency(%q<rake>, ["~> 0.8.7"])
+    s.add_dependency(%q<ore-core>, ["~> 0.1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.0"])
+    s.add_dependency(%q<ore-tasks>, ["~> 0.3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<infinity_test>, [">= 0"])
+    s.add_dependency(%q<metric_fu>, [">= 0"])
+    s.add_dependency(%q<code_statistics>, ["~> 0.2.13"])
+  end
+end
+

data/spec/sdp/description_spec.rb

@@ -0,0 +1,370 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'sdp/description'
+require 'base64'
+
+describe SDP::Description do
+  before :each do
+    @sdp = SDP::Description.new
+  end
+
+  it "initializes with the protocol_version value set" do
+    @sdp.protocol_version.should == SDP::PROTOCOL_VERSION
+  end
+
+  context "can add and retrieve fields" do
+    it "protocol_version" do
+      @sdp.protocol_version = 1
+      @sdp.protocol_version.should == 1
+    end
+
+    it "username" do
+      @sdp.username = "jdoe"
+      @sdp.username.should == "jdoe"
+    end
+
+    it "id" do
+      @sdp.id = 2890844526
+      @sdp.id.should == 2890844526
+    end
+
+    it "version" do
+      @sdp.version = 2890842807
+      @sdp.version.should == 2890842807
+    end
+
+    it "network_type" do
+      @sdp.network_type = :IN
+      @sdp.network_type.should == :IN
+    end
+
+    it "address_type" do
+      @sdp.address_type = :IP4
+      @sdp.address_type.should == :IP4
+    end
+
+    it "unicast_address" do
+      @sdp.unicast_address = "10.47.16.5"
+      @sdp.unicast_address.should == "10.47.16.5"
+    end
+
+    it "name" do
+      @sdp.name = "This is a session"
+      @sdp.name.should == "This is a session"
+    end
+
+    it "name can be a ' '" do
+      @sdp.name = " "
+      @sdp.name.should == " "
+    end
+
+    it "information" do
+      @sdp.information = "This is a session"
+      @sdp.information.should == "This is a session"
+    end
+
+    it "uri" do
+      @sdp.uri = "http://localhost"
+      @sdp.uri.should == "http://localhost"
+    end
+
+    it "email_address" do
+      @sdp.email_address = 'me@me.com'
+      @sdp.email_address.should == 'me@me.com'
+    end
+
+    it "email_address in alternate form" do
+      @sdp.email_address = "Jane Doe <j.doe@example.com>"
+      @sdp.email_address.should == "Jane Doe <j.doe@example.com>"
+    end
+
+    it "phone_number" do
+      @sdp.phone_number = "+1 555 123 4567"
+      @sdp.phone_number.should == "+1 555 123 4567"
+    end
+
+    it "connection_address" do
+      @sdp.connection_address = 'localhost'
+      @sdp.connection_address.should == 'localhost'
+    end
+
+    it "connection_address using TTL" do
+      @sdp.connection_address = "224.2.36.42/127"
+      @sdp.connection_address.should == "224.2.36.42/127"
+    end
+
+    it "connection_address using IPv6 address and count" do
+      @sdp.connection_address = "FF15::101/3"
+      @sdp.connection_address.should == "FF15::101/3"
+    end
+
+    it "bandwidth_type" do
+      @sdp.bandwidth = :CT
+      @sdp.bandwidth.should == :CT
+    end
+
+    it "bandwidth" do
+      @sdp.bandwidth = 100
+      @sdp.bandwidth.should == 100
+    end
+
+    it "start_time" do
+      @sdp.start_time = 99112299
+      @sdp.start_time.should == 99112299
+    end
+
+    it "stop_time" do
+      @sdp.stop_time = 99999999
+      @sdp.stop_time.should == 99999999
+    end
+  
+    it "repeat_interval" do
+      @sdp.repeat_interval = 12345
+      @sdp.repeat_interval.should == 12345
+    end
+
+    it "active_duration" do
+      @sdp.active_duration = 12345
+      @sdp.active_duration.should == 12345
+    end
+
+    it "offsets_from_start_time" do
+      @sdp.offsets_from_start_time = 99
+      @sdp.offsets_from_start_time.should == 99
+    end
+  
+    context "time_zones" do
+      it "one time zone" do
+        new_values = { :adjustment_time => 111111,
+          :offset => 99 }
+        @sdp.time_zones << new_values
+        @sdp.time_zones.should == [new_values]
+      end
+
+      it "two time_zones" do
+        new_values1 = { :adjustment_time => 111111,
+          :offset => 99 }
+        new_values2 = { :adjustment_time => 222222,
+          :offset => 88 }
+        @sdp.time_zones << new_values1
+        @sdp.time_zones << new_values2
+        @sdp.time_zones.should == [new_values1, new_values2]
+      end
+    end
+  
+    context "encryption keys" do
+      it "clear" do
+        @sdp.encryption_method = 'clear'
+        @sdp.encryption_method.should == 'clear'
+        @sdp.encryption_key = 'password'
+        @sdp.encryption_key.should == 'password'
+      end
+  
+      it "base64" do
+        @sdp.encryption_method = 'base64'
+        @sdp.encryption_method.should == 'base64'
+        enc = Base64.encode64('password')
+        @sdp.encryption_key = enc
+        @sdp.encryption_key.should == enc
+      end
+  
+      it "uri" do
+        @sdp.encryption_method = 'uri'
+        @sdp.encryption_method.should == 'uri'
+        uri = "http://aserver.com/thing.pdf"
+        @sdp.encryption_key = uri
+        @sdp.encryption_key.should == uri
+      end
+  
+      it "prompt" do
+        @sdp.encryption_method = 'prompt'
+        @sdp.encryption_method.should == 'prompt'
+        @sdp.encryption_key.should be_nil
+      end
+    end
+
+    context "attributes" do
+      it "one attribute with value" do
+        new_values = { :attribute => 'rtpmap',
+          :value => "99 h263-1998/90000" }
+        @sdp.attributes << new_values
+        @sdp.attributes.first.should == new_values
+      end
+
+      it "one attribute with empty value" do
+        new_values = { :attribute => 'rtpmap',
+          :value => "" }
+        @sdp.attributes << new_values
+        @sdp.attributes.first.should == new_values
+      end
+
+      it "one attribute with nil value" do
+        new_values = { :attribute => 'rtpmap' }
+        @sdp.attributes << new_values
+        @sdp.attributes.first.should == new_values
+      end
+
+      it "two attributes" do
+        new_values1 = { :attribute => 'test' }
+        new_values2 = { :attribute => 'rtpmap',
+          :value => "99 h263-1998/90000" }
+        @sdp.attributes << new_values1
+        @sdp.attributes << new_values2
+        @sdp.attributes.should == [new_values1, new_values2]
+      end
+    end
+  
+    context "media_sections" do
+      it "can add a basic media section" do
+        new_values = { :media => 'audio',
+          :port => 12345,
+          :protocol => 'RTP/AVP',
+          :format => 99 }
+        @sdp.media_sections << new_values
+        @sdp.media_sections.first.should == new_values
+      end
+
+      it "can add a basic media section with attributes" do
+        new_values = { :media => 'audio',
+          :port => 12345,
+          :protocol => 'RTP/AVP',
+          :format => 99,
+          :attributes => [
+            {
+              :attribute => "rtpmap",
+              :value => "99 h263-1998/90000"
+            }
+          ]
+        }
+        @sdp.media_sections << new_values
+        @sdp.media_sections.first.should == new_values
+      end
+
+      it "can add 2 basic media sections" do
+        new_values = []
+        new_values << { :media => 'audio',
+          :port => 12345,
+          :protocol => 'RTP/AVP',
+          :format => 99 }
+        @sdp.media_sections << new_values[0]
+
+        new_values << { :media => 'video',
+          :port => 5678,
+          :protocol => 'RTP/AVP',
+          :format => 33 }
+        @sdp.media_sections << new_values[1]
+
+        @sdp.media_sections.class.should == Array
+        @sdp.media_sections[0].should == new_values[0]
+        @sdp.media_sections[1].should == new_values[1]
+      end
+    end
+  end
+
+  context "#to_s" do
+    it "contains required session section values" do
+      @sdp.to_s.should match /v=0/
+      @sdp.to_s.should match /o=/
+      @sdp.to_s.should match /s=/
+      @sdp.to_s.should match /t=/
+    end
+  end
+
+  context "#valid?" do
+    before :each do
+      @sdp = SDP::Description.new
+
+      @sdp.protocol_version = 0
+      @sdp.username = "jdoe"
+      @sdp.id = 12345
+      @sdp.version = 12345
+      @sdp.network_type = :IN
+      @sdp.address_type = :IP4
+      @sdp.unicast_address = "127.0.0.1"
+      @sdp.name = "This is a test"
+      @sdp.start_time = 12345678
+      @sdp.stop_time = 12345680
+      @sdp.media_sections << { :media => "audio", :port => 123,
+        :protocol => "RTP/AVP", :format => 99 }
+    end
+
+    it "is valid when all required fields have values" do
+      @sdp.valid?.should be_true
+    end
+
+    it "is NOT valid when protocol_version isn't set" do
+      @sdp.protocol_version = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is NOT valid when username isn't set" do
+      @sdp.username = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is NOT valid when id isn't set" do
+      @sdp.id = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is NOT valid when version isn't set" do
+      @sdp.version = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is NOT valid when network_type isn't set" do
+      @sdp.network_type = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is NOT valid when address_type isn't set" do
+      @sdp.address_type = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is NOT valid when unicast_address isn't set" do
+      @sdp.unicast_address = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is NOT valid when name isn't set" do
+      @sdp.name = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is valid when name is ' '" do
+      @sdp.name = ' '
+      @sdp.valid?.should be_true
+    end
+
+    it "is NOT valid when start_time isn't set" do
+      @sdp.start_time = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is NOT valid when stop_time isn't set" do
+      @sdp.stop_time = nil
+      @sdp.valid?.should be_false
+    end
+
+    it "is NOT valid when media_sections is empty" do
+      @sdp[:media_sections] = []
+      @sdp.valid?.should be_false
+    end
+  end
+
+  context "bad initialize values" do
+    it "ensures a Hash is passed in" do
+      lambda do
+        SDP::Description.new 1
+      end.should raise_error SDP::RuntimeError
+    end
+
+    it "handles a Hash with irrelvant keys" do
+      session_values = { :bobo => "thing" }
+
+      lambda do
+        SDP::Description.new session_values
+      end.should raise_error SDP::RuntimeError
+    end
+  end
+end