vast_analyzer 1.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95231bcd4f18f2c61528dc8a3f8e37e52e8d41a7
+  data.tar.gz: 640ae6723ab95abda094640b611f7815559b2395
+SHA512:
+  metadata.gz: 5689492655bd3f8a3031e18b6d606b427e9a18310a2911aeeb1f73687e49a86039252a27ddbaa0d2f9667530f315f07b8502774e12869dc970b764495873a318
+  data.tar.gz: 33cb4786e59ab981a441a235b881dff108f2b0895b2a17486f480174dc3879c54688b47491521d1eb297a51890175300def5da11f7a95639a7029b2021c34717

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_from:
+  - style/ruby/style.yml
+
+Rails:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Documentation:
+    Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+ClassLength:
+  Max: 150

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vast_analyzer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marina Chirchikova
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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:
+
+```ruby
+result = VastAnalyzer::parse('https://www.vastexample.xml')
+```
+
+You can then check attributes of the result:
+
+```ruby
+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](https://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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'vast_analyzer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vast_analyzer.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+require 'vast_analyzer/version'
+require 'vast_analyzer/errors'
+require 'nokogiri'
+require 'net/http'
+require 'addressable/uri'
+
+module VastAnalyzer
+
+  def self.parse(url, max_redirects: 5)
+    ParserResult.new(url)
+  end
+
+  class ParserResult
+    attr_reader :vast, :vast_version
+
+    def initialize(url, max_redirects: 5)
+      open_xml(url)
+      vast_root = @vast&.xpath('//VAST')
+      raise NotVastError.new("Not vast, url: #{url}") unless vast_root&.any?
+      unwrap(max_redirects) unless @vast.xpath('//VASTAdTagURI').empty?
+      @vast_version = vast_root.attr('version').value
+    end
+
+    def vpaid_status
+      if include_flash_vpaid? && include_js?
+        'flash_js_vpaid'
+      elsif include_flash_vpaid?
+        'flash_vpaid'
+      elsif include_js?
+        'js_vpaid'
+      else
+        'neither'
+      end
+    end
+
+    def skippable?
+      @skippable ||=
+        case @vast_version
+        when '2.0', '2.0.1'
+          !!@vast.xpath('//Tracking')&.any? { |track| track.attr('event') == 'skip' }
+        when '3.0'
+          !!@vast.xpath('//Linear').attr('skipoffset')
+        end
+    end
+
+    def mediafiles
+      @mediafiles ||= @vast.xpath('//MediaFile')&.map do |node|
+        h = node.to_h
+        h['url'] = node.content
+        h
+      end
+    end
+
+    private
+
+    def open_xml(url, limit: 2)
+      raise ArgumentError.new('Too many HTTP redirects') if limit == 0
+      uri = Addressable::URI.parse(url)
+      response = Net::HTTP.get_response(uri)
+      case response
+      when Net::HTTPSuccess
+        @vast = Nokogiri::XML(response.body){ |config| config.noblanks }
+      when Net::HTTPRedirection
+        open_xml(response['location'], :limit => limit - 1)
+      else
+        raise ErrorOpeningUrl.new("Net/http error, #{response.code}, #{response.message}"\
+          "url: #{url}")
+      end
+    rescue Timeout::Error
+      raise UrlTimeoutError.new('Timeout error')
+    rescue StandardError => e
+      raise ErrorOpeningUrl.new("Error opening url, #{e.message}")
+    end
+
+    def unwrap(max_redirects)
+      max_redirects.times do
+        return if @vast.xpath('//VASTAdTagURI').empty?
+        begin
+          url = @vast.xpath('//VASTAdTagURI')[0].content
+          open_xml(url)
+        rescue
+          raise WrapperRedirectError.new('Error with opening the wrapper url')
+        end
+      end
+      raise WrapperDepthError.new('Error: Wrapper depth exceeds five redirects')
+    end
+
+    def include_flash_vpaid?
+      @include_flash ||= mediafiles.any? do |mediafile|
+        is_vpaid_api = mediafile['apiFramework'] == 'VPAID'
+        uses_flash = ['application/x-shockwave-flash', 'video/x-flv']
+                     .include?(mediafile['type'])
+        is_vpaid_api && uses_flash
+      end
+    end
+
+    def include_js?
+      @include_js ||= mediafiles.any? do |mediafile|
+        ['application/x-javascript', 'application/javascript'].include?(mediafile['type'])
+      end
+    end
+  end
+  private_constant :ParserResult
+end

data/lib/vast_analyzer/errors.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module VastAnalyzer
+  class Error < StandardError; end
+  class ErrorOpeningUrl < Error; end
+  class WrapperRedirectError < Error; end
+  class NotVastError < Error; end
+  class WrapperDepthError < Error; end
+  class UrlTimeoutError < Error; end
+  class ErrorWithHttp < Error; end
+end

data/lib/vast_analyzer/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module VastAnalyzer
+  VERSION = '1.0.2'
+end

data/vast_analyzer.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vast_analyzer/version'
+
+Gem::Specification.new 'vast_analyzer', '1.0.4' do |spec|
+  spec.name = 'vast_analyzer'
+  spec.version = '1.0.4'
+  spec.authors = ['Marina Chirchikova']
+
+  spec.summary = 'A VAST analyzer that autodetects VPAID, flash, and js in VAST media files'
+  spec.homepage = 'https://github.com/marina101/vast-analyzer'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3.0'
+  spec.add_runtime_dependency 'bundler', '~> 1.13'
+  spec.add_runtime_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_runtime_dependency 'nokogiri', '>= 1.8.1'
+  spec.add_development_dependency 'rubocop', '0.39.0'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'minitest-vcr'
+  spec.add_development_dependency 'byebug'
+  spec.add_runtime_dependency 'addressable'
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: vast_analyzer
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+platform: ruby
+authors:
+- Marina Chirchikova
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vast_analyzer.rb
+- lib/vast_analyzer/errors.rb
+- lib/vast_analyzer/version.rb
+- vast_analyzer.gemspec
+homepage: https://github.com/marina101/vast-analyzer
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A VAST analyzer that autodetects VPAID, flash, and js in VAST media files
+test_files: []