Skip to content
A gem for parsing VAST 2.0 documents
Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gemfiles
lib Create mixin to replace duplicate code Aug 28, 2019
test testing across nokogiri versions Aug 22, 2019
.gitignore
.travis.yml testing across nokogiri versions Aug 22, 2019
CHANGELOG.md Formalize vast release process Aug 27, 2019
Gemfile
LICENSE
Pathfile update Gem to make vast gem work on ruby 1.9.3 Jan 30, 2013
README.rdoc Formalize vast release process Aug 27, 2019
Rakefile
vast.gemspec Formalize vast release process Aug 27, 2019

README.rdoc

VAST Build Status

A library for parsing Digital Video Ad Serving Template (VAST) 2.0 and 3.0 XML documents, as outlined by the Interactive Advertising Bureau at 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.

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

VAST is available as a RubyGem.

gem install vast

Usage

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 inline_ad.linear_creative.mediafiles.first.type
=> "video/x-flv"
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.

Documentation

Read the rdoc at rdoc.info/projects/chrisdinn/vast

Problems/Bugs/Requests

Please, file an issue.

Running Tests

bundle exec rake

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.

Release Instructions

Install project development dependencies. The release process will use gem-release for version management.

bundle install

Checkout the master branch; never release changes that haven't been merged to master.

git checkout master

Create a release branch. Release branch names should match the pattern “v+.[0-9]+.+”.

git checkout v1.0.5

Bump the project version. By default the bump command will increment the patch version in the lib/vast/version.rb file, and commit the git change.

gem bump [patch|minor|major] --branch

Modify the CHANGELOG.md file. Add the new version to the top of the file, and document all major changes.

When done commit the changelog.

export BRANCH=$(git rev-parse --abbrev-ref HEAD)
git add CHANGELOG.md
git commit -m "CHANGELOG ${BRANCH}"

Push your release branch to github.com

git push origin -u $BRANCH

Open a new pull request from your branch to github.com:chrisdinn/vast@master

Only a github user with write access to github.com/chrisdinn/vast can perform the remaining steps of the release.

Review and merge the pull request to github.com:chrisdinn/vast@master

Check Travis CI testing passed on the merge to master before continuing.

Tag the release and push to rubygems.org using gem-release.

git checkout master
git pull origin
gem release --key $RUBYGEMS_API_KEY --tag --push

Copyright

© 2010 Chris Dinn. See LICENSE for details.

You can’t perform that action at this time.