comscore_ruby 0.0.13

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in comscore_ruby.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/comscore_ruby.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "comscore_ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "comscore_ruby"
+  s.version     = ComScore::VERSION
+  s.authors     = ["Mike Sukmanowsky"]
+  s.email       = ["mike.sukmanowsky@gmail.com"]
+  s.homepage    = "https://github.com/msukmanowsky/comscore_ruby/wiki"
+  s.summary     = "Use comScore's SOAP API in a manner that does not require you to bang your head against a wall."
+  s.description = "Basic support for things like finding media, media sets (AKA categories), and fetching reports.  Documentation is...well...missing so far."
+
+  s.rubyforge_project = s.name
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "savon", ">= 0.9.7"
+  s.add_runtime_dependency "activesupport", ">= 3.1.0"
+  
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/comscore_ruby/client.rb

@@ -0,0 +1,160 @@
+module ComScore
+  class Client
+    BASE_URI = "https://api.comscore.com/"
+    SERVICES = {
+      :key_measures         => {:wsdl => "#{BASE_URI}KeyMeasures.asmx?WSDL"},
+      :audience_duplication => {:wsdl => "#{BASE_URI}DigitalCalc.asmx?WSDL"},
+      :percent_media_trend  => {:wsdl => "#{BASE_URI}PercentMediaTrend.asmx?WSDL"},
+      :percent_target_trend => {:wsdl => "#{BASE_URI}PercentTargetTrend.asmx?WSDL"},
+      :demographic_profile  => {:wsdl => "#{BASE_URI}DemographicProfile.asmx?WSDL"},
+      :media_trend          => {:wsdl => "#{BASE_URI}MediaTrend.asmx?WSDL"},
+      :target_trend         => {:wsdl => "#{BASE_URI}TargetTrend.asmx?WSDL"},
+      :cross_visit          => {:wsdl => "#{BASE_URI}CrossVisit.asmx?WSDL"},
+      :video_key_measures   => {:wsdl => "#{BASE_URI}VideoMetrix/VideoMetrixKeyMeasures.asmx?WSDL"},
+      :video_media_trend    => {:wsdl => "#{BASE_URI}VideoMetrix/VideoMetrixMediaTrend.asmx?WSDL"},
+      :video_demographic_profile => {:wsdl => "#{BASE_URI}VideoMetrix/VideoMetrixDemographicProfile.asmx?WSDL"},
+      :mobilens_audience_profile => {:wsdl => "#{BASE_URI}MobiLens/AudienceProfile.asmx?WSDL"},
+      :mobilens_trend       => {:wsdl => "#{BASE_URI}MobiLens/Trend.asmx?WSDL"}
+    }
+    
+    def initialize(uname, pw)
+      @username, @password = [uname, pw]
+    end
+    
+    def log=(value)
+      raise ArgumentError, "Parameter must be of type Boolean." unless !!value == value
+      @log = value
+      Savon.configure do |config|
+        config.log = value
+        config.log_level = :info if value == false
+      end
+      HTTPI.log = value
+    end
+    
+    def log
+      @log
+    end
+    
+    def media_sets
+      @client = Savon::Client.new(SERVICES[:key_measures][:wsdl])
+      @client.http.auth.basic(@username, @password)
+      
+      response = @client.request(:discover_parameter_values) do
+        soap.xml do |xml|
+          xml.soap(:Envelope, "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema", "xmlns:soap" => "http://schemas.xmlsoap.org/soap/envelope/") {
+            xml.soap(:Body) {
+              xml.DiscoverParameterValues(:xmlns => "http://comscore.com/") {
+                xml.parameterId("mediaSet")
+                xml.query(:xmlns => "http://comscore.com/ReportQuery") {
+                  xml.Parameter(:KeyId => "geo", :Value => "124")
+                  xml.Parameter(:KeyId => "timeType", :Value => "1")
+                  xml.Parameter(:KeyId => "timePeriod", :Value => DateTime.now.to_date.to_comscore_time_period - 2)
+                  xml.Parameter(:KeyId => "mediaSetType", :Value => "1")
+                }
+              }
+            }
+          }
+        end
+      end
+      
+      response.to_hash()[:discover_parameter_values_response][:discover_parameter_values_result][:enum_value]
+    end
+    
+    def find_media(criterion = [])
+      @client = Savon::Client.new(SERVICES[:key_measures][:wsdl])
+      @client.http.auth.basic(@username, @password)
+      response = @client.request(:fetch_media) do
+        soap.xml do |xml|
+          xml.soap(:Envelope, "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema", "xmlns:soap" => "http://schemas.xmlsoap.org/soap/envelope/") {
+            xml.soap(:Body) {
+              xml.FetchMedia("xmlns" => "http://comscore.com/") {
+                xml.parameterId("media")
+                xml.fetchMediaQuery("xmlns" => "http://comscore.com/FetchMedia") {
+                  criterion.each do |criteria|
+                    xml.SearchCritera(:ExactMatch => "false", :Critera => criteria)
+                  end
+                } if criterion.count > 0
+                xml.reportQuery("xmlns" => "http://comscore.com/ReportQuery") {
+                  xml.Parameter(:KeyId => "geo", :Value => "124")
+                  xml.Parameter(:KeyId => "loc", :Value => "0")
+                  xml.Parameter(:KeyId => "timeType", :Value => "1")
+                  xml.Parameter(:KeyId => "timePeriod", :Value => DateTime.now.to_date.to_comscore_time_period - 2)
+                  xml.Parameter(:KeyId => "mediaSetType", :Value => "1")
+                }
+              }
+            }
+          }
+        end
+      end
+      
+      response.to_hash()[:fetch_media_response][:fetch_media_result][:media_item]
+    end
+        
+    # Requires: geo, loc, timeType, timePeriod, mediaSetType
+    # Usage: find_media(:geo => "Canada", :loc => "")
+    def get_report(report_type, opts = {})
+      @client = Savon::Client.new(SERVICES[report_type][:wsdl])
+      @client.http.auth.basic(@username, @password)
+      job_queue_response = @client.request(:submit_report) do
+        soap.xml do |xml|
+          xml.soap(:Envelope, "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema", "xmlns:soap" => "http://schemas.xmlsoap.org/soap/envelope/") {
+            xml.soap(:Body) {
+              xml.SubmitReport("xmlns" => "http://comscore.com/") {
+                xml.query("xmlns" => "http://comscore.com/ReportQuery") {
+                  opts.each { |key, value|
+                    if value.is_a?(Array)
+                      value.each do |v|
+                        xml.Parameter(:KeyId => key, :Value => v)
+                      end
+                    elsif value.is_a?(Date)
+                      xml.Parameter(:KeyId => key, :Value => value.to_comscore_time_period)
+                    else
+                      xml.Parameter(:KeyId => key, :Value => value)
+                    end
+                  }
+                }
+              }
+            }
+          }
+        end
+      end
+      
+      job_id = job_queue_response.to_hash()[:submit_report_response][:submit_report_result][:job_id]
+      
+      job_status = "Starting"
+      begin
+        sleep(2) if job_status == "Starting"
+        job_status_response = @client.request(:ping_report_status) do
+          soap.xml do |xml|
+            xml.soap(:Envelope, "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema", "xmlns:soap" => "http://schemas.xmlsoap.org/soap/envelope/") {
+              xml.soap(:Body) {
+                xml.PingReportStatus("xmlns" => "http://comscore.com/") {
+                  xml.jobId(job_id)
+                }
+              }
+            }
+          end
+        end
+        job_status = job_status_response.to_hash()[:ping_report_status_response][:ping_report_status_result][:status]
+      end while (job_status != "Completed" && job_status != "Failed")
+      
+      if (job_status == "Completed") 
+        result = @client.request(:fetch_report) do
+          soap.xml do |xml|
+            xml.soap(:Envelope, "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema", "xmlns:soap" => "http://schemas.xmlsoap.org/soap/envelope/") {
+              xml.soap(:Body) {
+                xml.FetchReport("xmlns" => "http://comscore.com/") {
+                  xml.jobId(job_id)
+                }
+              }
+            }
+          end
+        end          
+        return result.to_hash()[:fetch_report_response][:fetch_report_result]
+      else
+        raise "The job with id #{job_id} failed to complete. Last known status was #{job_status}."
+      end
+    end
+    
+  end
+end

data/lib/comscore_ruby/constants.rb

@@ -0,0 +1,61 @@
+module ComScore
+  GEOGRAPHIES = {
+    "Canada" => "124"
+  }
+  LOCATIONS = {
+    "Home and Work" => "0",
+    "Home" => 1,
+    "Work" => 2
+  }
+  TIME_TYPES = {
+    "Months" => "1",
+    "3 Month Avg" => "5"
+  }
+  MEDIA_SET_TYPES = {
+    "Ranked Categories" => "1",
+    "Expanded Categories" => "2",
+    "Alternate Rollups" => "3"
+  }
+  TARGET_TYPES = {
+    "Simple" => "0",
+    "Advanced" => "1",
+    "Custom" => "2"
+  }
+  TARGET_GROUPS = {
+    "Total Audience" =>	15,
+    "Persons - Age" =>	23,
+    "Males - Age"	=> 24,
+    "Females - Age" => 25,
+    "HH Income (CA)" =>	6,
+    "Region (CA)" => 7,
+    "Children" => 8,
+    "HH Size" =>	9,
+    "Connection Speed" =>	12
+  }
+  MEDIA_FILTERS = {
+    "Top 5" => "0",
+    "All Entries" => "-1"
+  }
+  MEASURES = {
+    "Total Unique Visitors (000)" =>	1,
+    "% Reach" => 9,
+    "% Composition Unique Visitors" => 10,
+    "Composition Index UV" => 70,
+    "Composition Index PV" => 71,
+    "Average Daily Visitors (000)" => 7,
+    "Total Minutes (MM)" => 2,
+    "Average Minutes per Usage Day" => 14,
+    "Total Pages Viewed (MM)" =>	3,
+    "Average Pages per Usage Day" => 16,
+    "Average Minutes per Page" => 15,
+    "Average Usage Days per Visitor" => 8,
+    "Average Minutes per Visitor" => 6,
+    "Average Pages per Visitor" => 5,
+    "% Composition Pages" => 11,
+    "% Composition Minutes" =>	12,
+    "Total Visits (000)" => 143,
+    "Average Minutes per Visit" => 144,
+    "Average Visits per Visitor" => 145,
+    "Average Visits per Usage Day" => 146
+  }
+end

data/lib/comscore_ruby/core_ext/date.rb

@@ -0,0 +1,11 @@
+class Date
+  def to_comscore_time_period
+    initial_d = Date.new(2000, 1, 1)
+    if self.to_time.to_i < initial_d.to_time.to_i
+      raise "#{self.strftime("%Y-%m")} is before #{self.strftime("%Y-%m")}"
+    end
+    year_difference = self.year - initial_d.year
+    month_difference = (self.month - initial_d.month).modulo(12)
+    return (year_difference * 12) + month_difference + 1
+  end
+end

data/lib/comscore_ruby/version.rb

@@ -0,0 +1,3 @@
+module ComScore
+  VERSION = "0.0.13"
+end

data/lib/comscore_ruby.rb

@@ -0,0 +1,23 @@
+require 'comscore_ruby/version'
+require 'comscore_ruby/client'
+require 'comscore_ruby/constants'
+require 'comscore_ruby/core_ext/date'
+
+require 'rubygems'
+require 'savon'
+require 'active_support/core_ext/date_time/acts_like'
+require 'active_support/core_ext/date_time/calculations'
+require 'active_support/core_ext/date_time/conversions'
+require 'active_support/core_ext/date_time/zones'
+
+require 'active_support/core_ext/date/acts_like'
+require 'active_support/core_ext/date/calculations'
+require 'active_support/core_ext/date/conversions'
+require 'active_support/core_ext/date/freeze'
+require 'active_support/core_ext/date/zones'
+
+require 'active_support/core_ext/time/calculations'
+
+module ComScore
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: comscore_ruby
+version: !ruby/object:Gem::Version 
+  hash: 5
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 13
+  version: 0.0.13
+platform: ruby
+authors: 
+- Mike Sukmanowsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-02 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: savon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 0
+        - 9
+        - 7
+        version: 0.9.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 1
+        - 0
+        version: 3.1.0
+  type: :runtime
+  version_requirements: *id002
+description: Basic support for things like finding media, media sets (AKA categories), and fetching reports.  Documentation is...well...missing so far.
+email: 
+- mike.sukmanowsky@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- comscore_ruby.gemspec
+- lib/comscore_ruby.rb
+- lib/comscore_ruby/client.rb
+- lib/comscore_ruby/constants.rb
+- lib/comscore_ruby/core_ext/date.rb
+- lib/comscore_ruby/version.rb
+homepage: https://github.com/msukmanowsky/comscore_ruby/wiki
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: comscore_ruby
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: Use comScore's SOAP API in a manner that does not require you to bang your head against a wall.
+test_files: []
+