sessionm-vast 1.0.4

data/lib/vast/non_linear_creative.rb

@@ -0,0 +1,97 @@
+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 URI.escape(source_node.at('NonLinearClickThrough').content.strip)
+    end
+
+    def click_tracking_url
+      URI.parse URI.escape(source_node.at('NonLinearClickTracking').content.strip)
+    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 URI.escape(source_node.at('StaticResource').content.strip)
+      when :iframe
+        URI.parse URI.escape(source_node.at('IFrameResource').content.strip)
+      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 URI.escape(source_node.at('VASTAdTagURI').content.strip)
+    end
+    
+  end
+end

data/lib/vast.rb

@@ -0,0 +1,33 @@
+require 'nokogiri'
+
+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/icon'
+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
+  VAST_VERSION = 2.0
+  VAST_SCHEMA_XSD_FILE = File.expand_path(File.join(File.dirname(__FILE__), 'vast_2.0.1.xsd'))
+  VAST3_SCHEMA_XSD_FILE = File.expand_path(File.join(File.dirname(__FILE__), 'vast3_draft.xsd'))
+
+  class VASTError < StandardError; end
+  
+  # Raised when parsing a VAST document that does not conform to the VAST spec XSD
+  class InvalidDocumentError < VASTError; end
+  
+  # Raised when parsing a VAST ad node that is not complete
+  class InvalidAdError < VASTError; end
+  
+  # Raised when parsing a VAST creative node that is not complete
+  class InvalidCreativeError < VASTError; end
+  
+end