vast 0.2 → 1.0

data/README.rdoc

@@ -1,11 +1,13 @@
 = VAST
 
-A library for parsing Digital Video Ad Serving Template (VAST) documents, as outlined by the Interactive Advertising Bureau at 
-http://www.iab.net/iab_products_and_industry_services/508676/digitalvideo/vast. This library strives to be as true to the 
-standard as possible, while presenting a Ruby-friendly interface.
+A library for parsing Digital Video Ad Serving Template (VAST) 2.0 XML documents, as outlined by the Interactive Advertising Bureau at 
+http://www.iab.net/iab_products_and_industry_services/508676/digitalvideo/vast. VAST outlines a standard document format for communication between digital video players and ad servers, including support for 
+multiple forms of creative and tracking support that conforms to the latest IAB standards. 
 
-VAST outlines a standard document format for communication between digital video players and ad servers, including support for 
-multiple forms of creative and tracking support that conforms to the latest IAB standards.
+It's recommended that you review the resources made available for the IAB. Whenever possible the documentation in this library has been 
+pulled directly from those resources.
+
+This library strives to be as true to the standard as possible, while presenting a Ruby-friendly interface.
 
 == Installation
 
@@ -15,10 +17,16 @@ VAST is available as a RubyGem.
 
 == Usage
 
-Parse a VAST document and access it's contents easily. See the documentation for the individual classes for an overview of
-what information available for each class.
+Parse a VAST document and access its contents using an easy-to-understand model. For example:
 
   document = VAST::Document.parse(File.read("vast_document.xml"))
+  inline_ad = document.inline_ads.first
+  puts document.linear_creative.mediafile.type
+  => "video/x-flv"
+  puts document.linear_creative.mediafile.url
+  => #<URI::HTTP:0x1015ad5f0 URL:http://creativeurl.ca/mediafile>
+
+See the documentation for the individual classes for an overview of what information available for each class.
 
 == Documentation
 

data/lib/vast.rb

@@ -1,10 +1,14 @@
 require 'vast/document'
+require 'vast/element'
 require 'vast/ad'
 require 'vast/inline_ad'
+require 'vast/wrapper_ad'
 require 'vast/creative'
 require 'vast/linear_creative'
 require 'vast/mediafile'
 require 'vast/companion_creative'
+require 'vast/non_linear_creative'
+require 'vast/extension'
 
 # This module wraps VAST documents, as outlined by the IAB at http://www.iab.net/media/file/VAST-2_0-FINAL.pdf
 module VAST

data/lib/vast/ad.rb

@@ -1,10 +1,21 @@
 module VAST
-  class Ad
-    attr_reader :source_node
-    
-    def initialize(node)
-      @source_node = node
-    end
+  # Contains some combination of video, companions, and non-linear units for a single advertiser.
+  #
+  # A single VAST response may include multiple Ads from multiple advertisers. It will be up to 
+  # the Video Player to determine the order, timing, placement, etc for the multiple ads. However, 
+  # the player should generally respect the sequential order of the Ad elements within a VAST response.
+  #
+  # The VAST response does not contain information on the placement or timing of each ad. It is up 
+  # to the Video Player to determine the optimal inclusion points of the ads.
+  #
+  # Can either be of type InlineAd, meaning it contains all the elements necessary to display the 
+  # visual experience, or of type WrapperAd, which points to a downstream VAST document that must be 
+  # requested from another server.
+  # 
+  # An Ad may include one or more pieces of creative that are part of a single execution. For example, an Ad 
+  # may include a linear video element with a set of companion banners; this would be reflected by two Creative
+  # elements, one LinearCreative and one CompanionCreative.
+  class Ad < Element
     
     # Create proper ad type
     def self.create(node)
@@ -19,12 +30,12 @@ module VAST
     
     # Ad id, if indicated
     def id
-      @source_node[:id]
+      source_node[:id]
     end
     
     # Name of source ad server
     def ad_system
-      ad_system_node = @source_node.at("AdSystem")
+      ad_system_node = source_node.at("AdSystem")
       if ad_system_node
         ad_system_node.content
       else
@@ -34,45 +45,55 @@ module VAST
     
     # URI to request if ad does not play due to error
     def error_url
-      error_url_node = @source_node.at("Error")
+      error_url_node = source_node.at("Error")
       URI.parse(error_url_node.content) if error_url_node
     end
     
     # Returns an array containing all linear creatives
     def linear_creatives
-      @source_node.xpath('.//Creative/Linear').to_a.collect do |node|
+      source_node.xpath('.//Creative/Linear').to_a.collect do |node|
         LinearCreative.new(node)
       end
     end
     
+    # It's common for an ad to contain only one piece of linear creative. This is a
+    # convenience method for when only the first piece of linear creative is needed.
+    def linear_creative
+      linear_creatives.first
+    end
+    
     # Returns an array containing all non linear creatives
     def non_linear_creatives
-      @source_node.xpath('.//Creative/NonLinearAds/NonLinear').to_a.collect do |node|
+      source_node.xpath('.//Creative/NonLinearAds/NonLinear').to_a.collect do |node|
         NonLinearCreative.new(node)
       end
     end
     
     # Returns an array containing all companion creatives
     def companion_creatives
-      @source_node.xpath('.//Creative/CompanionAds/Companion').to_a.collect do |node|
+      source_node.xpath('.//Creative/CompanionAds/Companion').to_a.collect do |node|
         CompanionCreative.new(node)
       end
     end
     
-    # Each Ad should contain at least one impression.
+    # Each Ad must contain at least one impression.
     def impression
-      URI.parse(@source_node.at('Impression').content)
+      URI.parse(source_node.at('Impression').content)
     end
     
     # Array of all impressions available for this ad, excluding those specific
     # to a particular creative.
     def impressions
-      @source_node.xpath('.//Impression').to_a.collect do |node|
+      source_node.xpath('.//Impression').to_a.collect do |node|
         URI.parse(node)
       end
     end
     
+    # Extensions included in the 
+    def extensions
+      source_node.xpath('.//Extension').to_a.collect do |node|
+        Extension.new(node)
+      end
+    end
   end
-  
-  class WrapperAd < Ad; end
 end

data/lib/vast/companion_creative.rb

@@ -1,48 +1,55 @@
 module VAST
+  # Commonly text, display ads, rich media, or skins that wrap around the video experience. These ads come 
+  # in a number of sizes and shapes and typically run alongside or surrounding the video player.
   class CompanionCreative < Creative
     
     def id
-      @source_node[:id]
+      source_node[:id]
     end
     
     # Width in pixels of companion
     def width
-      @source_node[:width].to_i
+      source_node[:width].to_i
     end
     
     # Height in pixels of companion
     def height
-      @source_node[:height].to_i
+      source_node[:height].to_i
     end
     
     # Width in pixels of expanding companion ad when in expanded state  
     def expanded_width
-      @source_node[:expandedWidth].to_i
+      source_node[:expandedWidth].to_i
     end
     
     # Height in pixels of expanding companion ad when in expanded state  
     def expanded_height
-      @source_node[:expandedHeight].to_i
+      source_node[:expandedHeight].to_i
+    end
+    
+    # Defines the method to use for communication with the companion
+    def api_framework
+      source_node[:apiFramework]
     end
     
     # URI to open as destination page when user clicks on the video
     def click_through_url
-      URI.parse @source_node.at('CompanionClickThrough').content
+      URI.parse source_node.at('CompanionClickThrough').content
     end
     
     # Alternate text to be displayed when companion is rendered in HTML environment.
     def alt_text
-      node = @source_node.at('AltText')
+      node = source_node.at('AltText')
       node.nil? ? nil : node.content
     end
     
     # Type of companion resource, returned as a symbol. Either :static, :iframe, or :html.
     def resource_type
-      if @source_node.at('StaticResource')
+      if source_node.at('StaticResource')
         :static
-      elsif @source_node.at('IFrameResource')
+      elsif source_node.at('IFrameResource')
         :iframe
-      elsif @source_node.at('HTMLResource')
+      elsif source_node.at('HTMLResource')
         :html
       end
     end
@@ -50,7 +57,7 @@ module VAST
     # Returns MIME type of static creative
     def creative_type
       if resource_type == :static
-        @source_node.at('StaticResource')[:creativeType]
+        source_node.at('StaticResource')[:creativeType]
       end
     end
     
@@ -58,16 +65,16 @@ module VAST
     def resource_url
       case resource_type
       when :static
-        URI.parse @source_node.at('StaticResource').content
+        URI.parse source_node.at('StaticResource').content
       when :iframe
-        URI.parse @source_node.at('IFrameResource').content
+        URI.parse source_node.at('IFrameResource').content
       end
     end
     
     # Returns HTML text for html resource
     def resource_html
       if resource_type == :html
-        @source_node.at('HTMLResource').content
+        source_node.at('HTMLResource').content
       end
     end
   end

data/lib/vast/creative.rb

@@ -1,13 +1,14 @@
 module VAST
-  class Creative
-    attr_reader :source_node
-    
-    def initialize(node)
-      @source_node = node
-    end
+  # Contains the information related to a piece of creative.
+  # 
+  # === Sequence
+  # The Creative element takes an optional “sequence” attribute that indicates the suggested order in which the 
+  # Creatives should be displayed. If two Creative elements are intended to be shown at the same time they should 
+  # share the same sequence number.
+  class Creative < Element
     
     def ad
-      Ad.create @source_node.ancestors('Ad').first
+      Ad.create source_node.ancestors('Ad').first
     end
     
     def id
@@ -25,14 +26,19 @@ module VAST
     
     # Data to be passed into the video ad.
     def ad_parameters
-      @source_node.at('AdParameters').content
+      source_node.at('AdParameters').content
     end
     
+    # Returns a hash, keyed by event name, containing an array of URIs to be called for each event.
     def tracking_urls
       tracking_urls = {}
-      @source_node.xpath('.//Tracking').to_a.collect do |node|
+      source_node.xpath('.//Tracking').to_a.collect do |node|
         underscored_name = underscore(node[:event])
-        tracking_urls[underscored_name.to_sym] = URI.parse(node.content)
+        if tracking_urls[underscored_name.to_sym]
+           tracking_urls[underscored_name.to_sym] << URI.parse(node.content)
+        else
+           tracking_urls[underscored_name.to_sym] = [URI.parse(node.content)]
+        end
       end
       tracking_urls
     end
@@ -50,9 +56,7 @@ module VAST
     private
     
     def creative_node
-      @source_node.ancestors('Creative').first
+      source_node.ancestors('Creative').first
     end
   end
-  
-  class NonLinearCreative < Creative; end
 end

data/lib/vast/document.rb

@@ -20,7 +20,8 @@ module VAST
       xsd.valid?(self)
     end
     
-    # All ads in the document
+    # All ads in the document If no ads of any type are available, it should ould be indicated 
+    # by the absence of any Ads.
     def ads
       self.root.xpath('.//Ad').to_a.collect do |node|
         Ad.create(node)

data/lib/vast/element.rb

@@ -0,0 +1,9 @@
+module VAST
+  class Element
+    attr_reader :source_node
+
+    def initialize(node)
+      @source_node = node
+    end
+  end
+end

data/lib/vast/extension.rb

@@ -0,0 +1,16 @@
+module VAST
+  class Extension < Element
+
+    # Extension type
+    def type
+      source_node[:type]
+    end
+    
+    # Access to the XML contents of this extension, as a Nokogiri::XML::Node
+    # http://nokogiri.rubyforge.org/nokogiri/Nokogiri/XML/Node.html. Alias of
+    # Extension#source_node
+    def xml
+      source_node
+    end
+  end
+end

data/lib/vast/inline_ad.rb

@@ -1,15 +1,17 @@
 module VAST
+  # Contains all the information necessary to display the visual experience of one complete ad.
   class InlineAd < Ad
     
     # URI of request to survey vendor
     def survey_url
-      URI.parse @source_node.at('Survey').content
+      URI.parse source_node.at('Survey').content
     end
     
     # Common name of ad
     def ad_title
-      @source_node.at('AdTitle').content
+      source_node.at('AdTitle').content
     end
+    
   end
 end
 

data/lib/vast/linear_creative.rb

@@ -1,19 +1,21 @@
 module VAST
+  # LinearCreative is presented before, in the middle of, or after the video content is consumed by the user, 
+  # in very much the same way a TV commercial can play before, during or after the chosen program.
   class LinearCreative < Creative
     
     # Duration of creative
     def duration
-      @source_node.at('Duration').content
+      source_node.at('Duration').content
     end
     
     # URI to open as destination page when user clicks on the video
     def click_through_url
-      URI.parse @source_node.at('ClickThrough').content
+      URI.parse source_node.at('ClickThrough').content
     end
     
     # An array of URIs to request for tracking purposes when user clicks on the video
     def click_tracking_urls
-      @source_node.xpath('.//ClickTracking').to_a.collect do |node|
+      source_node.xpath('.//ClickTracking').to_a.collect do |node|
         URI.parse node.content
       end
     end
@@ -23,7 +25,7 @@ module VAST
     # used as the key for this hash
     def custom_click_urls
       custom_click_urls = {}
-      @source_node.xpath('.//CustomClick').to_a.collect do |node|
+      source_node.xpath('.//CustomClick').to_a.collect do |node|
         key = underscore(node[:id]).to_sym
         custom_click_urls[key] = URI.parse(node.content)
       end
@@ -31,7 +33,7 @@ module VAST
     end
     
     def mediafiles
-      @source_node.xpath('.//MediaFile').to_a.collect do |node|
+      source_node.xpath('.//MediaFile').to_a.collect do |node|
         Mediafile.new(node)
       end
     end

data/lib/vast/mediafile.rb

@@ -1,54 +1,54 @@
 module VAST
-  class Mediafile
-    attr_reader :source_node
-    
-    def initialize(node)
-      @source_node = node
-    end
+  class Mediafile < Element
     
     # Location of linear file
     def url
-      URI.parse @source_node.content
+      URI.parse source_node.content
     end
     
     def id
-      @source_node[:id]
+      source_node[:id]
     end
     
     # Method of delivery of ad, either "streaming" or "progressive"
     def delivery
-      @source_node[:delivery]
+      source_node[:delivery]
     end
     
     # MIME type. Popular MIME types include, but are not limited to “video/x-ms-wmv” for 
     # Windows Media, and “video/x-flv” for Flash Video.
     def type
-      @source_node[:type]
+      source_node[:type]
     end
     
     # Bitrate of encoded video in Kbps
     def bitrate
-      @source_node[:bitrate].to_i
+      source_node[:bitrate].to_i
     end
     
     # Pixel dimensions of video width
     def width
-      @source_node[:width].to_i
+      source_node[:width].to_i
     end
     
     # Pixel dimensions of video height
     def height
-      @source_node[:height].to_i
+      source_node[:height].to_i
+    end
+    
+    # Defines the method to use for communication with the companion
+    def api_framework
+      source_node[:apiFramework]
     end
     
-    # Whether it is acceptable to scale the image.
+    # Whether it is acceptable to scale the mediafile.
     def scalable?
-      @source_node[:scalable]=="true"
+      source_node[:scalable]=="true"
     end
     
-    # Whether the ad must have its aspect ratio maintained when scaled
+    # Whether the mediafile must have its aspect ratio maintained when scaled
     def maintain_aspect_ratio?
-      @source_node[:maintainAspectRatio]=="true"
+      source_node[:maintainAspectRatio]=="true"
     end
   end
 end

data/lib/vast/non_linear_creative.rb

@@ -0,0 +1,93 @@
+module VAST
+  # NonLinearCreative runs concurrently with the video content so the users see the ad while viewing 
+  # the content. Non-linear video ads can be delivered as text, graphical ads, or as video overlays.
+  class NonLinearCreative < Creative
+
+    def id
+      source_node[:id]
+    end
+    
+    # Width in pixels
+    def width
+      source_node[:width].to_i
+    end
+    
+    # Height in pixels
+    def height
+      source_node[:height].to_i
+    end
+    
+    # Width in pixels when in expanded state  
+    def expanded_width
+      source_node[:expandedWidth].to_i
+    end
+    
+    # Height in pixels when in expanded state  
+    def expanded_height
+      source_node[:expandedHeight].to_i
+    end
+    
+    # Defines the method to use for communication with the companion
+    def api_framework
+      source_node[:apiFramework]
+    end
+    
+    # URI to open as destination page when user clicks on creative
+    def click_through_url
+      URI.parse source_node.at('NonLinearClickThrough').content
+    end
+    
+    # Whether it is acceptable to scale the mediafile.
+    def scalable?
+      source_node[:scalable]=="true"
+    end
+    
+    # Whether the mediafile must have its aspect ratio maintained when scaled
+    def maintain_aspect_ratio?
+      source_node[:maintainAspectRatio]=="true"
+    end
+    
+    # Suggested duration to display non-linear ad, typically for animation to complete. 
+    # Expressed in standard time format hh:mm:ss  
+    def min_suggested_duration
+      source_node[:minSuggestedDuration]
+    end
+    
+    
+    # Type of non-linear resource, returned as a symbol. Either :static, :iframe, or :html.
+    def resource_type
+      if source_node.at('StaticResource')
+        :static
+      elsif source_node.at('IFrameResource')
+        :iframe
+      elsif source_node.at('HTMLResource')
+        :html
+      end
+    end
+    
+    # Returns MIME type of static creative
+    def creative_type
+      if resource_type == :static
+        source_node.at('StaticResource')[:creativeType]
+      end
+    end
+    
+    # Returns URI for static or iframe resource
+    def resource_url
+      case resource_type
+      when :static
+        URI.parse source_node.at('StaticResource').content
+      when :iframe
+        URI.parse source_node.at('IFrameResource').content
+      end
+    end
+    
+    # Returns HTML text for html resource
+    def resource_html
+      if resource_type == :html
+        source_node.at('HTMLResource').content
+      end
+    end
+    
+  end
+end

data/lib/vast/wrapper_ad.rb

@@ -0,0 +1,19 @@
+module VAST
+  # Points to another VAST document on a different server.
+  #
+  # WrapperAds may include any number of tracking urls to allow CompanionCreatives to be served 
+  # from an InlineAd response but tracked separately from the Impression. It may also include 
+  # tracking elements for separately tracking LinearCreative or NonLinearCreative views or events. 
+  #
+  # The server providing the WrapperAd may not know exactly which creative elements are to be 
+  # delivered downline in inline ads; in that case the WrapperAd should include placeholders for 
+  # the maximum set of Creatives that could be played within the Video Player.
+  class WrapperAd < Ad
+    
+    # URI of ad tag of downstream Secondary Ad Server
+    def ad_tag_url
+      URI.parse source_node.at('VASTAdTagURI').content
+    end
+    
+  end
+end

data/test/ad_test.rb

@@ -60,12 +60,20 @@ class AdTest < Test::Unit::TestCase
     end
   end
   
+  def test_ad_should_know_first_linear_creative
+    document_file = example_file('document_with_one_inline_ad.xml')
+    document = VAST::Document.parse!(document_file)
+    ad = document.inline_ads.first
+    
+    assert_equal ad.linear_creative.id, ad.linear_creatives.first.id
+  end
+  
   def test_ad_should_know_non_linear_creatives
     document_file = example_file('document_with_one_inline_ad.xml')
     document = VAST::Document.parse!(document_file)
     ad = document.inline_ads.first
     
-    assert_equal 1, ad.non_linear_creatives.count
+    assert_equal 2, ad.non_linear_creatives.count
     ad.non_linear_creatives.each do |creative|
       assert creative.kind_of?(VAST::NonLinearCreative)
     end
@@ -100,4 +108,15 @@ class AdTest < Test::Unit::TestCase
     assert_equal "http://myTrackingURL/impression", ad.impressions.first.to_s
     assert_equal "http://myTrackingURL/anotherImpression", ad.impressions.last.to_s
   end
+
+  def test_extensions
+    document_file = example_file('document_with_one_inline_ad.xml')
+    document = VAST::Document.parse!(document_file)
+    ad = document.inline_ads.first
+    
+    assert_equal 2, ad.extensions.count
+    ad.extensions.each do |extension|
+      assert extension.kind_of?(VAST::Extension)
+    end
+  end
 end

data/test/companion_creative_test.rb

@@ -14,6 +14,7 @@ class CompanionCreativeTest < Test::Unit::TestCase
     assert_equal 500, creative.expanded_height
     assert_equal "http://www.tremormedia.com", creative.click_through_url.to_s
     assert_equal "Display this instead of the ad", creative.alt_text
+    assert_equal "VPAID", creative.api_framework
   end
   
   def test_should_know_static_resource

data/test/creative_test.rb

@@ -27,8 +27,8 @@ class CreativeTest < Test::Unit::TestCase
     document = VAST::Document.parse!(document_with_creative)
     creative = document.ads.first.linear_creatives.first
     
-    assert_equal "http://myTrackingURL/creativeView", creative.tracking_urls[:creative_view].to_s
-    assert_equal "http://myTrackingURL/start", creative.tracking_urls[:start].to_s
+    assert_equal ["http://myTrackingURL/creativeView"], creative.tracking_urls[:creative_view].collect{ |url| url.to_s }
+    assert_equal ["http://myTrackingURL/start1", "http://myTrackingURL/start2"], creative.tracking_urls[:start].collect{ |url| url.to_s }
     ## There are more tracking urls, refer to spec for complete list
   end
   

data/test/examples/document_with_one_inline_ad.xml

@@ -18,7 +18,8 @@
 					<TrackingEvents>
 						<Tracking event="creativeView"><![CDATA[http://myTrackingURL/creativeView]]></Tracking>
 
-						<Tracking event="start"><![CDATA[http://myTrackingURL/start]]></Tracking>
+						<Tracking event="start"><![CDATA[http://myTrackingURL/start1]]></Tracking>
+						<Tracking event="start"><![CDATA[http://myTrackingURL/start2]]></Tracking>
 						<Tracking event="midpoint"><![CDATA[http://myTrackingURL/midpoint]]></Tracking>
 						<Tracking event="firstQuartile"><![CDATA[http://myTrackingURL/firstQuartile]]></Tracking>
 						<Tracking event="thirdQuartile"><![CDATA[http://myTrackingURL/thirdQuartile]]></Tracking>
@@ -43,13 +44,13 @@
 						<CustomClick id="customTwo"><![CDATA[http://myTrackingURL/custom2]]></CustomClick>
 					</VideoClicks>
 					<MediaFiles>
-						<MediaFile id="firstFile" delivery="progressive" type="video/x-flv" bitrate="500" width="400" height="300" scalable="true" maintainAspectRatio="true"><![CDATA[http://cdnp.tremormedia.com/video/acudeo/Carrot_400x300_500kb.flv]]></MediaFile>
+						<MediaFile id="firstFile" delivery="progressive" type="video/x-flv" bitrate="500" width="400" height="300" scalable="true" maintainAspectRatio="true"  apiFramework="VPAID"><![CDATA[http://cdnp.tremormedia.com/video/acudeo/Carrot_400x300_500kb.flv]]></MediaFile>
 					</MediaFiles>
 				</Linear>
 			</Creative>
 			<Creative AdID="601364-Companion">
 				<CompanionAds>
-					<Companion id="big_box" width="300" height="250" expandedWidth="600" expandedHeight="500">
+					<Companion id="big_box" width="300" height="250" expandedWidth="600" expandedHeight="500" apiFramework="VPAID">
 						<StaticResource creativeType="image/jpeg">http://demo.tremormedia.com/proddev/vast/Blistex1.jpg</StaticResource>
 						<TrackingEvents>
 							<Tracking event="creativeView">http://myTrackingURL/firstCompanionCreativeView</Tracking>
@@ -65,13 +66,31 @@
 			</Creative>
 			<Creative AdID="601365">
 			   <NonLinearAds>
-           			<NonLinear width="300" height="50">
+           			<NonLinear id="special_overlay" width="300" height="50" expandedWidth="600" expandedHeight="500" apiFramework="VPAID" scalable="true" maintainAspectRatio="true">
            				<StaticResource creativeType="image/jpeg"><![CDATA[http://cdn.liverail.com/adasset/228/330/overlay.jpg]]></StaticResource>
-<NonLinearClickThrough><![CDATA[http://t3.liverail.com/?metric=clickthru&pos=1&pid=1331&coid=135&nid=0&cid=330&kid=228&vid=&amid=&cc=default&pp=&url=&cb=9185&x=&y=&xy=&redirect=http%3A%2F%2Fliverail.com%2F]]></NonLinearClickThrough>
-               		</NonLinear>	
+						<NonLinearClickThrough><![CDATA[http://t3.liverail.com]]></NonLinearClickThrough>
+               		</NonLinear>
+					<NonLinear width="728" height="90">
+						<IFrameResource><![CDATA[http://ad3.liverail.com/util/non_linear.php]]></IFrameResource>
+						<NonLinearClickThrough>http://www.tremormedia.com</NonLinearClickThrough>
+					</NonLinear>	
    				</NonLinearAds>
 			</Creative>
 		</Creatives>
+		<Extensions>
+            <Extension type="DART">
+                <AdServingData>
+                    <DeliveryData>
+                        <GeoData><![CDATA[ct=CA&st=ON&ac=905&zp=L6V1X9&bw=0&dma=1&city=1869]]></GeoData>
+                    </DeliveryData>
+                </AdServingData>
+            </Extension>
+            <Extension type="value">
+                <CostPerThousand currency="CAD">
+                   125.00
+                </CostPerThousand>
+            </Extension>
+        </Extensions>
 	   </InLine>
 	  </Ad>
 	

data/test/extension_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+class ExtensionTest < Test::Unit::TestCase
+  
+  def test_should_know_attributes
+    document_file = example_file('document_with_one_inline_ad.xml')
+    document = VAST::Document.parse!(document_file)
+    extension = VAST::Extension.new(document.at('Extension'))
+    
+    assert_equal "DART", extension.type
+  end
+  
+  def test_should_know_attributes
+    document_file = example_file('document_with_one_inline_ad.xml')
+    document = VAST::Document.parse!(document_file)
+    extension = VAST::Extension.new(document.at('Extension'))
+    
+    assert_equal extension.source_node, extension.xml
+  end
+end

data/test/mediafile_test.rb

@@ -13,6 +13,7 @@ class MediafileTest < Test::Unit::TestCase
     assert_equal 400, mediafile.width
     assert_equal 300, mediafile.height
     assert_equal 500, mediafile.bitrate
+    assert_equal "VPAID", mediafile.api_framework
     assert mediafile.scalable?
     assert mediafile.maintain_aspect_ratio?
   end

data/test/non_linear_creative_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class NonLinearCreativeTest < Test::Unit::TestCase
+  
+  def test_should_know_attributes
+    document_file = example_file('document_with_one_inline_ad.xml')
+    document = VAST::Document.parse!(document_file)
+    creative = document.inline_ads.first.non_linear_creatives.first
+   
+    assert_equal "special_overlay", creative.id
+    assert_equal 300, creative.width
+    assert_equal 50, creative.height
+    assert_equal 600, creative.expanded_width
+    assert_equal 500, creative.expanded_height
+    assert_equal "http://t3.liverail.com", creative.click_through_url.to_s
+    assert_equal "VPAID", creative.api_framework 
+    assert creative.scalable?
+    assert creative.maintain_aspect_ratio?
+  end
+  
+  def test_should_know_static_resource
+    document_file = example_file('document_with_one_inline_ad.xml')
+    document = VAST::Document.parse!(document_file)
+    creative_with_static_resource = document.inline_ads.first.non_linear_creatives.first
+    
+    assert_equal :static, creative_with_static_resource.resource_type
+    assert_equal "image/jpeg", creative_with_static_resource.creative_type
+    assert_equal "http://cdn.liverail.com/adasset/228/330/overlay.jpg", creative_with_static_resource.resource_url.to_s
+  end
+
+  def test_should_know_iframe_resource
+    document_file = example_file('document_with_one_inline_ad.xml')
+    document = VAST::Document.parse!(document_file)
+    creative_with_iframe_resource = document.inline_ads.first.non_linear_creatives.last
+    
+    assert_equal :iframe, creative_with_iframe_resource.resource_type
+    assert_equal "http://ad3.liverail.com/util/non_linear.php", creative_with_iframe_resource.resource_url.to_s
+  end
+end

data/test/wrapper_ad_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class WrapperAdTest < Test::Unit::TestCase
+  
+  def test_should_know_ad_tag_url
+    document_with_wrapper_ad = example_file('document_with_one_wrapper_ad.xml')
+    document = VAST::Document.parse!(document_with_wrapper_ad)
+
+    ad_node = document.root.xpath('.//Ad').first
+    ad = VAST::WrapperAd.new(ad_node)
+
+    assert ad.ad_tag_url.kind_of?(URI)
+    assert_equal "http://demo.tremormedia.com/proddev/vast/vast_inline_linear.xml", ad.ad_tag_url.to_s
+  end
+  
+end

metadata

@@ -3,9 +3,9 @@ name: vast
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 2
-  version: "0.2"
+  version: "1.0"
 platform: ruby
 authors: 
 - Chris Dinn
@@ -46,17 +46,24 @@ files:
 - lib/vast/companion_creative.rb
 - lib/vast/creative.rb
 - lib/vast/document.rb
+- lib/vast/element.rb
+- lib/vast/extension.rb
 - lib/vast/inline_ad.rb
 - lib/vast/linear_creative.rb
 - lib/vast/mediafile.rb
+- lib/vast/non_linear_creative.rb
+- lib/vast/wrapper_ad.rb
 - test/ad_test.rb
 - test/companion_creative_test.rb
 - test/creative_test.rb
 - test/document_test.rb
+- test/extension_test.rb
 - test/inline_ad_test.rb
 - test/linear_creative_test.rb
 - test/mediafile_test.rb
+- test/non_linear_creative_test.rb
 - test/test_helper.rb
+- test/wrapper_ad_test.rb
 - test/examples/document_with_no_ads.xml
 - test/examples/document_with_one_inline_ad.xml
 - test/examples/document_with_one_inline_and_one_wrapper_ad.xml
@@ -66,7 +73,6 @@ files:
 - test/examples/invalid_document_with_missing_ad_type.xml
 - test/examples/invalid_document_with_missing_creative_type.xml
 - LICENSE
-- README.md
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/chrisdinn/vast

data/README.md

@@ -1,45 +0,0 @@
-VAST
-=====
-
-A library for parsing Digital Video Ad Serving Template (VAST) documents, as outlined by the Interactive Advertising Bureau at 
-[http://www.iab.net/iab_products_and_industry_services/508676/digitalvideo/vast]. This library strives to be as true to the 
-standard as possible, while presenting a Ruby-friendly interface.
-
-VAST outlines a standard document format for communication between digital video players and ad servers, including support for 
-multiple forms of creative and tracking support that conforms to the latest IAB standards.
-
-Installation
-------------
-
-VAST is available as a RubyGem.  
-
-    gem install vast
-
-Usage
------
-
-Parse a VAST document and access it's contents easily. See the documentation for the individual classes for an overview of
-what information available for each class.
-
-    document = VAST::Document.parse(File.read("vast_document.xml"))
-
-Problems/Bugs/Requests
------------------------------
-
-Please, file an issue.
-
-Note on Patches/Pull Requests
------------------------------
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-Copyright
------------------------------
-
-© 2010 Chris Dinn. See [LICENSE](http://github.com/chrisdinn/vast/blob/master/LICENSE) for details.