Skip to content

marina101/vast-analyzer

Repository files navigation

Installation

Add this line to your application's Gemfile:

gem 'vast_analyzer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vast_analyzer

Usage

Simply pass your xml vast url to the parser object to instantiate a parser linked to that vast:

result = VastAnalyzer::parse('https://www.vastexample.xml')

You can then check attributes of the result:

result.vpaid_status
=> 'flash_js_vpaid'

result.skippable?
=> false

Vpaid status will return one of four options: 'flash_js_vpaid', 'flash_vpaid', 'js_vpaid', 'neither'

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/marina101/vast-analyzer.

License

The gem is available as open source under the terms of the MIT License.