vast 1.0 → 1.0.1

data/README.rdoc

@@ -21,9 +21,9 @@ Parse a VAST document and access its contents using an easy-to-understand model.
 
   document = VAST::Document.parse(File.read("vast_document.xml"))
   inline_ad = document.inline_ads.first
-  puts document.linear_creative.mediafile.type
+  puts inline_ad.linear_creative.mediafiles.first.type
   => "video/x-flv"
-  puts document.linear_creative.mediafile.url
+  puts inline_ad.linear_creative.mediafiles.first.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.

data/lib/vast/ad.rb

@@ -8,8 +8,8 @@ module VAST
   # 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 
+  # Can either be a InlineAd, meaning it contains all the elements necessary to display the 
+  # visual experience, or a 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 
@@ -17,7 +17,7 @@ module VAST
   # elements, one LinearCreative and one CompanionCreative.
   class Ad < Element
     
-    # Create proper ad type
+    # Creates proper ad type
     def self.create(node)
       if node.at('InLine')
         InlineAd.new(node)
@@ -33,7 +33,7 @@ module VAST
       source_node[:id]
     end
     
-    # Name of source ad server
+    # Returns name of source ad server
     def ad_system
       ad_system_node = source_node.at("AdSystem")
       if ad_system_node
@@ -43,33 +43,33 @@ module VAST
       end
     end
     
-    # URI to request if ad does not play due to error
+    # Returns URI to request if ad does not play due to error.
     def error_url
       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
+    # Returns an array containing all linear creatives.
     def linear_creatives
       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.
+    # This is a convenience method for when only the first piece of linear creative is needed. 
+    # It's common for an ad to contain only one piece of linear creative.
     def linear_creative
       linear_creatives.first
     end
     
-    # Returns an array containing all non linear creatives
+    # Returns an array containing all non linear creatives.
     def non_linear_creatives
       source_node.xpath('.//Creative/NonLinearAds/NonLinear').to_a.collect do |node|
         NonLinearCreative.new(node)
       end
     end
     
-    # Returns an array containing all companion creatives
+    # Returns an array containing all companion creatives.
     def companion_creatives
       source_node.xpath('.//Creative/CompanionAds/Companion').to_a.collect do |node|
         CompanionCreative.new(node)
@@ -89,7 +89,7 @@ module VAST
       end
     end
     
-    # Extensions included in the 
+    # All extensions included with this ad.
     def extensions
       source_node.xpath('.//Extension').to_a.collect do |node|
         Extension.new(node)

data/lib/vast/creative.rb

@@ -35,9 +35,9 @@ module VAST
       source_node.xpath('.//Tracking').to_a.collect do |node|
         underscored_name = underscore(node[:event])
         if tracking_urls[underscored_name.to_sym]
-           tracking_urls[underscored_name.to_sym] << URI.parse(node.content)
+           tracking_urls[underscored_name.to_sym] << URI.parse(node.content.strip)
         else
-           tracking_urls[underscored_name.to_sym] = [URI.parse(node.content)]
+           tracking_urls[underscored_name.to_sym] = [URI.parse(node.content.strip)]
         end
       end
       tracking_urls

data/lib/vast/document.rb

@@ -1,4 +1,5 @@
 module VAST
+  # A complete VAST document
   class Document < Nokogiri::XML::Document
     
     # Parse a VAST XML document
@@ -20,8 +21,11 @@ module VAST
       xsd.valid?(self)
     end
     
-    # All ads in the document If no ads of any type are available, it should ould be indicated 
-    # by the absence of any Ads.
+    # 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 the ad.
+    #
+    # If no ads of any type are available, it would 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/extension.rb

@@ -1,4 +1,6 @@
 module VAST
+  # The VAST allows any valid XML within the extensions element. Use of extensions will necessarily 
+  # require offline coordination between VAST sender and VAST receiver. 
   class Extension < Element
 
     # Extension type

data/lib/vast/linear_creative.rb

@@ -32,6 +32,10 @@ module VAST
       custom_click_urls
     end
     
+    # Returns mediafiles containing the information required to display the linear creative's media
+    # 
+    # It is assumed that all mediafiles accessible represent the same creative unit with the same 
+    # duration, Ad-ID (ISCI code), etc.
     def mediafiles
       source_node.xpath('.//MediaFile').to_a.collect do |node|
         Mediafile.new(node)

data/lib/vast/mediafile.rb

@@ -1,4 +1,6 @@
 module VAST
+  # Any number of Mediafile objects can be provided for a single Ad, but it is assumed that all Mediafiles belongs
+  # to a single Ad object represent the same creative unit with the same  duration, Ad-ID (ISCI code), etc.
   class Mediafile < Element
     
     # Location of linear file

data/test/examples/document_with_one_inline_ad.xml

@@ -18,7 +18,9 @@
 					<TrackingEvents>
 						<Tracking event="creativeView"><![CDATA[http://myTrackingURL/creativeView]]></Tracking>
 
-						<Tracking event="start"><![CDATA[http://myTrackingURL/start1]]></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>

data/test/examples/document_with_one_wrapper_ad.xml

@@ -26,7 +26,9 @@
 				</Companion>
 				<Companion width="728" height="90">
 
-					<StaticResource creativeType="image/jpeg">http://demo.tremormedia.com/proddev/vast/728x90_banner1.jpg</StaticResource>
+					<StaticResource creativeType="image/jpeg">
+					  http://demo.tremormedia.com/proddev/vast/728x90_banner1.jpg
+					</StaticResource>
 					<CompanionClickThrough>http://www.tremormedia.com</CompanionClickThrough>
 				</Companion>
 			</CompanionAds>

metadata

@@ -1,11 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: vast
 version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  version: "1.0"
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Chris Dinn
@@ -13,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-23 00:00:00 -04:00
+date: 2011-06-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 1
         segments: 
         - 1
         - 4
@@ -84,23 +88,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A gem for working with VAST 2.0 documents