adops_report_scrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 368ff448654fe142f098a05d72c263f4a7c7bacc
+  data.tar.gz: 8664f20d302251678c328d37401275164476451a
+SHA512:
+  metadata.gz: 652e2f66cc8326a1e6ebedfd5615f1b0ebaf555c80fd2c8763ac57e69a3e804ca6d2cbd7ed8d3a00b2f59471dd67117c59bc0befd6eb96386758e30eaac3d45e
+  data.tar.gz: 60ebf84d57a88314c7c922cd445ef943b572e38ba295e6c0e1ba4df100c8ad800eca2377627560898988cd0050fb4df9c8eadddfea12999972d92c2f8ed4325b

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/secret.yml
+/tmp/*
+!/tmp/.keep
+/.byebug_history
+/capybara-*.png
+/*-oauth2.json
+/discovery.cache
+/adops_report_scrapper*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in adops_report_scrapper.gemspec
+gemspec
+
+gem 'byebug'
+
+gem 'httpclient'
+gem 'kaminari'
+gem 'rest-client'
+gem 'capybara'
+gem 'poltergeist', require: 'phantomjs/poltergeist'
+gem 'phantomjs'
+gem 'http-cookie'
+gem 'rubyzip'
+gem 'google-api-client', '~> 0.8.2'
+gem 'cheddar'
+gem 'roo', '~> 2.4.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stayman Hou
+
+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 @@
+# Adops_Report_Scrapper
+
+Adops Report Scrapper is a collection of web scrappers that can automatically extract the data from your ad server, ad networks, ad exchanges, and other ad partners. It is an open source alternative to [STAQ](http://www.staq.com/). Say good-bye to spreadsheet. At the moment, this gem only focus on getting the data in. It is up to you how you would aggregate the data into your pageview & dfp/ad server data set.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'adops_report_scrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adops_report_scrapper
+
+## Usage
+
+#### Example
+
+```ruby
+require 'adops_report_scrapper'
+AdopsReportScrapper.get_scrapper(:brightroll, 'login', 'secret', {}).get_data
+
+# return an array of arrays. First array is the header of the data table. Other arrays are the data
+# example: [["Watch", "Status", "Name", "ID", "CPM Floor", "Revenue", "eCPM", "Requests", "Responses", "Response Rate", "Impressions", "Impression Rate", "Fill Rate", "Viewable Rate", "Clicks", "CTR", "Mid Rate", "Completion Rate", "Companion Impressions", "Companion Clicks", "Companion CTR", "Created On", "Last Modified"], ["", "", "My Post RON CDN", "3863603", "$6.00", "$9.99", "$6.68", "14,951", "2,556", "17.10%", "1,496", "58.53%", "10.01%", "60.87%", "7", "0.47%", "51.80%", "45.05%", "0.00%", "0", "0.00%", "03/23/2015", "06/25/2016"], ["", "", "My Post 400x300", "3855941", "$6.00", "$0.04", "$6.07", "78", "37", "47.44%", "6", "16.22%", "7.69%", "0.00%", "0", "0.00%", "50.00%", "66.67%", "0.00%", "0", "0.00%", "12/20/2013", "06/24/2016"], ["", "", "My Post", "3860218", "$7.00", "$0.03", "$8.07", "26", "12", "46.15%", "4", "33.33%", "15.38%", "0.00%", "0", "0.00%", "125.00%", "125.00%", "0.00%", "0", "0.00%", "10/10/2014", "06/09/2016"], ["", "", "My Post 640x480", "3855297", "$7.00", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "11/25/2013", "06/28/2016"], ["", "", "My Post 300x250", "3855943", "$2.00", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "12/20/2013", "06/09/2016"], ["", "", "Mobile - iPhone web…e My Post NCT", "3856072", "$4.00", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "01/07/2014", "05/23/2016"], ["", "", "Mobile - Android we…- The My Post", "3856089", "$4.00", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "01/08/2014", "05/23/2016"], ["", "", "Mobile - iPad web -…e My Post NCT", "3856127", "$4.00", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "01/10/2014", "05/23/2016"], ["", "", "My Today 6836382", "3860216", "$7.00", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "10/10/2014", "06/29/2016"], ["", "", "My Herald", "3860220", "$6.00", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "10/10/2014", "06/09/2016"], ["", "", "My News", "3860222", "$7.00", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "10/10/2014", "06/29/2016"], ["", "", "My Blog", "3860224", "$5.00", "$0.00", "$0.00", "15", "7", "46.67%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "10/10/2014", "06/09/2016"], ["", "", "My Times 400x300", "3863146", "$7.00", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "03/02/2015", "06/29/2016"], ["", "", "My Post RON UK", "3863604", "$5.46", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "03/23/2015", "06/09/2016"], ["", "", "My Post RON AU", "3863906", "$4.43", "$0.00", "$0.00", "0", "0", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0", "0.00%", "0.00%", "0.00%", "0.00%", "0", "0.00%", "04/01/2015", "06/09/2016"]]
+```
+
+## Supported Scrappers
+
+Check `lib/adops_report_scrapper` directory for implemented scrappers.
+
+Check `secret.sample.yml` for expected args to be passed to each scrapper.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/StaymanHou/adops_report_scrapper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,152 @@
+require 'bundler/gem_tasks'
+require 'yaml'
+require 'csv'
+require 'date'
+require 'adops_report_scrapper'
+
+require 'byebug'
+
+desc 'Collect all data'
+task :all => [:openx, :tremor, :brightroll, :yellowhammer, :adaptv, :fourninefive, :adx, :revcontent, :gcs, :browsi, :netseer, :sonobi, :nativo, :adsupply, :marfeel, :adsense, :criteo, :triplelift, :conversant, :liveintent, :adiply, :contentad, :facebookaudience] do # openx is the most unstable one, run it first
+  puts '========== You are all set'
+end
+
+desc 'Collect tremor data'
+task :tremor do
+  save_as_csv :tremor, :tremor
+end
+
+desc 'collect brightroll data'
+task :brightroll do
+  save_as_csv :brightroll, :brightroll
+end
+
+desc 'Collect yellowhammer data'
+task :yellowhammer do
+  save_as_csv :yellowhammer, :springserve
+end
+
+desc 'Collect adaptv data'
+task :adaptv do
+  save_as_csv :adaptv, :adaptv
+end
+
+desc 'Collect fourninefive data'
+task :fourninefive do
+  save_as_csv :fourninefive, :adforge
+end
+
+desc 'Collect adx data'
+task :adx do
+  save_as_csv :adx, :adx
+end
+
+desc 'Collect revcontent data'
+task :revcontent do
+  save_as_csv :revcontent, :revcontent
+end
+
+desc 'Collect gcs data'
+task :gcs do
+  save_as_csv :gcs, :gcs
+end
+
+desc 'Collect browsi data'
+task :browsi do
+  save_as_csv :browsi, :browsi
+end
+
+desc 'Collect openx data'
+task :openx do
+  save_as_csv :openx, :openx
+end
+
+desc 'Collect netseer data'
+task :netseer do
+  save_as_csv :netseer, :netseer
+end
+
+desc 'Collect sonobi data'
+task :sonobi do
+  save_as_csv :sonobi, :sonobi
+end
+
+desc 'Collect nativo data'
+task :nativo do
+  save_as_csv :nativo, :nativo
+end
+
+desc 'Collect adsupply data'
+task :adsupply do
+  save_as_csv :adsupply, :adsupply
+end
+
+desc 'Collect marfeel data'
+task :marfeel do
+  save_as_csv :marfeel, :marfeel
+end
+
+desc 'Collect adsense data'
+task :adsense do
+  save_as_csv :adsense, :adsense
+end
+
+desc 'Collect criteo data'
+task :criteo do
+  save_as_csv :criteo, :criteo
+end
+
+desc 'Collect triplelift data'
+task :triplelift do
+  save_as_csv :triplelift, :triplelift
+end
+
+desc 'Collect conversant data'
+task :conversant do
+  save_as_csv :conversant, :conversant
+end
+
+desc 'Collect liveintent data'
+task :liveintent do
+  save_as_csv :liveintent, :liveintent
+end
+
+desc 'Collect adiply data'
+task :adiply do
+  save_as_csv :adiply, :adiply
+end
+
+desc 'Collect contentad data'
+task :contentad do
+  save_as_csv :contentad, :contentad
+end
+
+desc 'Collect facebookaudience data'
+task :facebookaudience do
+  save_as_csv :facebookaudience, :facebookaudience
+end
+
+def get_yesterdays_file_path(adnetwork)
+  "tmp/#{Date.today.prev_day}/#{adnetwork}.csv"
+end
+
+def write_csv(adnet, data)
+  Dir.mkdir "tmp/#{Date.today.prev_day}" unless Dir.exists? "tmp/#{Date.today.prev_day}"
+  CSV.open(get_yesterdays_file_path(adnet), 'w') do |csv|
+    data.each do |row|
+      csv << row
+    end
+  end
+end
+
+def save_as_csv(adnet, scrapper) # adnet and scrapper are both sym
+  if File.file?(get_yesterdays_file_path(adnet))
+    puts "========== #{adnet} data already scraped"
+    return
+  end
+  puts "========== working on #{adnet}"
+  cred = YAML.load_file('secret.yml')[adnet.to_s]
+  data = AdopsReportScrapper.get_scrapper(adnet, cred['login'], cred['secret'], cred['options']).get_data
+  byebug
+  write_csv(adnet, data)
+end

data/adops_report_scrapper.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adops_report_scrapper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "adops_report_scrapper"
+  spec.version       = AdopsReportScrapper::VERSION
+  spec.authors       = ["Stayman Hou"]
+  spec.email         = ["stayman.hou@gmail.com"]
+
+  spec.summary       = %q{Adops Report Scrapper is a collection of web scrappers that can automatically extract the data from your ad partners.}
+  spec.description   = %q{Adops Report Scrapper is a collection of web scrappers that can automatically extract the data from your ad server, ad networks, ad exchanges, and other ad partners. It is an open source alternative to [STAQ](http://www.staq.com/). Say good-bye to spreadsheet. At the moment, this gem only focus on getting the data in. It is up to you how you would aggregate the data into your pageview & dfp/ad server data set.}
+  spec.homepage      = 'https://github.com/StaymanHou/adops_report_scrapper'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "adops_report_scrapper"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/adops_report_scrapper.rb

@@ -0,0 +1,38 @@
+require "adops_report_scrapper/version"
+
+module AdopsReportScrapper
+  def self.get_scrapper(module_name, login, secret, options = nil)
+    scrapper_client_klass = self.const_get "#{self.camelcase(module_name)}Client"
+    scrapper_client_klass.new(login, secret, options)
+  end
+
+  private
+
+  def self.camelcase(str)
+    str.to_s.downcase.split('_').map { |word| word.capitalize }.join
+  end
+end
+
+require 'adops_report_scrapper/adaptv_client'
+require 'adops_report_scrapper/adforge_client'
+require 'adops_report_scrapper/adiply_client'
+require 'adops_report_scrapper/adsense_client'
+require 'adops_report_scrapper/adsupply_client'
+require 'adops_report_scrapper/adx_client'
+require 'adops_report_scrapper/brightroll_client'
+require 'adops_report_scrapper/browsi_client'
+require 'adops_report_scrapper/contentad_client'
+require 'adops_report_scrapper/conversant_client'
+require 'adops_report_scrapper/criteo_client'
+require 'adops_report_scrapper/facebookaudience_client'
+require 'adops_report_scrapper/gcs_client'
+require 'adops_report_scrapper/liveintent_client'
+require 'adops_report_scrapper/marfeel_client'
+require 'adops_report_scrapper/nativo_client'
+require 'adops_report_scrapper/netseer_client'
+require 'adops_report_scrapper/openx_client'
+require 'adops_report_scrapper/revcontent_client'
+require 'adops_report_scrapper/sonobi_client'
+require 'adops_report_scrapper/springserve_client'
+require 'adops_report_scrapper/tremor_client'
+require 'adops_report_scrapper/triplelift_client'

data/lib/adops_report_scrapper/adaptv_client.rb

@@ -0,0 +1,80 @@
+require 'date'
+require_relative 'base_client'
+
+class AdopsReportScrapper::AdaptvClient < AdopsReportScrapper::BaseClient
+  private
+
+  def login
+    @client.visit 'https://onevideo.aol.com/#/logon'
+    @client.fill_in 'adaptv_email', :with => @login
+    @client.fill_in 'adaptv_password', :with => @secret
+    @client.click_button 'Sign in >'
+    begin
+      @client.find :xpath, '//*[text()="Analytics"]'
+    rescue Exception => e
+      raise e, 'Adaptv login error'
+    end
+  end
+
+  def scrap
+    request_report
+    extract_data_from_report
+  end
+
+  def request_report
+    @client.find(:xpath, '//*[text()="Analytics"]').click
+    @client.find(:xpath, '//*[text()="Reports"]').click
+    wait_for_spin
+    @client.find(:xpath, '//*[text()="New Report"]').click
+    wait_for_spin
+
+    @client.fill_in 'Report Name', :with => "tmp-#{Time.now.to_i}"
+
+    @client.check 'Media'
+    @client.check 'Geo: Country'
+
+    @client.click_link 'Metrics'
+
+    @client.check 'Ad Attempts'
+    @client.check 'Ad Opportunities'
+    @client.check 'Ad Break Impressions'
+    @client.check 'Ad Impressions'
+    @client.check 'IAB Viewable Ad Impressions'
+    @client.check '100% Completed Views'
+    @client.check 'Ad Skips'
+    @client.check 'Clicks'
+    @client.check 'Ad Revenue'
+
+    @client.click_button 'Run Report'
+    wait_for_spin
+
+    @client.find(:xpath, '//option[text()="100"]').select_option
+    sleep 5
+  end
+
+  def extract_data_from_report
+    @data = []
+    thead = @client.find :xpath, '//table[1]/thead/tr'
+    @data << thead.find_css('td,th').map { |td| td.visible_text }
+    99.times do |_i|
+      rows = @client.find_all :xpath, '//table[1]/tbody/tr'
+      @data += rows.map { |tr| tr.find_css('td,th').map { |td| td.visible_text } }
+      pagee = @client.find(:xpath, '//*[contains(text()," / ")]').text.split(' / ')
+      break if pagee[0] == pagee[1]
+      @client.click_button 'Next'
+      sleep 5
+    end
+  end
+
+  def wait_for_spin
+    30.times do |_i| # wait 5 min
+      begin
+        @client.find(:css, '.busy-spinner-large')
+      rescue Exception => e
+        break
+      end
+      sleep 10
+    end
+    sleep 5
+  end
+end