vast 0.1 → 0.2

data/lib/vast.rb

@@ -4,19 +4,22 @@ require 'vast/inline_ad'
 require 'vast/creative'
 require 'vast/linear_creative'
 require 'vast/mediafile'
+require 'vast/companion_creative'
 
 # This module wraps VAST documents, as outlined by the IAB at http://www.iab.net/media/file/VAST-2_0-FINAL.pdf
 module VAST
   VAST_VERSION = 2.0
   VAST_SCHEMA_XSD_FILE = File.expand_path(File.join(File.dirname(__FILE__), 'vast_2.0.1.xsd'))
   
+  class VASTError < StandardError; end
+  
   # Raised when parsing a VAST document that does not conform to the VAST spec XSD
-  class InvalidDocumentError < StandardError; end
+  class InvalidDocumentError < VASTError; end
   
   # Raised when parsing a VAST ad node that is not complete
-  class InvalidAdError < StandardError; end
+  class InvalidAdError < VASTError; end
   
   # Raised when parsing a VAST creative node that is not complete
-  class InvalidCreativeError < StandardError; end
+  class InvalidCreativeError < VASTError; end
   
 end

data/lib/vast/companion_creative.rb

@@ -0,0 +1,74 @@
+module VAST
+  class CompanionCreative < Creative
+    
+    def id
+      @source_node[:id]
+    end
+    
+    # Width in pixels of companion
+    def width
+      @source_node[:width].to_i
+    end
+    
+    # Height in pixels of companion
+    def height
+      @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
+    end
+    
+    # Height in pixels of expanding companion ad when in expanded state  
+    def expanded_height
+      @source_node[:expandedHeight].to_i
+    end
+    
+    # URI to open as destination page when user clicks on the video
+    def click_through_url
+      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.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')
+        :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/creative.rb

@@ -55,5 +55,4 @@ module VAST
   end
   
   class NonLinearCreative < Creative; end
-  class CompanionCreative < Creative; end
 end

data/test/companion_creative_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class CompanionCreativeTest < 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.companion_creatives.first
+    
+    assert_equal "big_box", creative.id
+    assert_equal 300, creative.width
+    assert_equal 250, creative.height
+    assert_equal 600, creative.expanded_width
+    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
+  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.companion_creatives.first
+    
+    assert_equal :static, creative_with_static_resource.resource_type
+    assert_equal "image/jpeg", creative_with_static_resource.creative_type
+    assert_equal "http://demo.tremormedia.com/proddev/vast/Blistex1.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.companion_creatives.last
+    
+    assert_equal :iframe, creative_with_iframe_resource.resource_type
+    assert_equal "http://ad3.liverail.com/util/companions.php", creative_with_iframe_resource.resource_url.to_s
+  end
+end

data/test/examples/document_with_one_inline_ad.xml

@@ -49,20 +49,18 @@
 			</Creative>
 			<Creative AdID="601364-Companion">
 				<CompanionAds>
-					<Companion width="300" height="250">
+					<Companion id="big_box" width="300" height="250" expandedWidth="600" expandedHeight="500">
 						<StaticResource creativeType="image/jpeg">http://demo.tremormedia.com/proddev/vast/Blistex1.jpg</StaticResource>
 						<TrackingEvents>
 							<Tracking event="creativeView">http://myTrackingURL/firstCompanionCreativeView</Tracking>
-
 						</TrackingEvents>
-
 						<CompanionClickThrough>http://www.tremormedia.com</CompanionClickThrough>
+						<AltText>Display this instead of the ad</AltText>
 					</Companion>
 					<Companion width="728" height="90">
-						<StaticResource creativeType="image/jpeg">http://demo.tremormedia.com/proddev/vast/728x90_banner1.jpg</StaticResource>
+						<IFrameResource><![CDATA[http://ad3.liverail.com/util/companions.php]]></IFrameResource>
 						<CompanionClickThrough>http://www.tremormedia.com</CompanionClickThrough>
 					</Companion>
-
 				</CompanionAds>
 			</Creative>
 			<Creative AdID="601365">

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Chris Dinn
@@ -43,12 +43,14 @@ files:
 - lib/vast.rb
 - lib/vast_2.0.1.xsd
 - lib/vast/ad.rb
+- lib/vast/companion_creative.rb
 - lib/vast/creative.rb
 - lib/vast/document.rb
 - lib/vast/inline_ad.rb
 - lib/vast/linear_creative.rb
 - lib/vast/mediafile.rb
 - test/ad_test.rb
+- test/companion_creative_test.rb
 - test/creative_test.rb
 - test/document_test.rb
 - test/inline_ad_test.rb