comscore_ruby 0.0.13 → 0.0.20

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+test/config.yml
+doc/*

data/Rakefile

@@ -1 +1,10 @@
 require "bundler/gem_tasks"
+
+namespace :test do 
+  desc "Run all tests in /test"
+  task :all do
+    Dir["test/**/*_test.rb"].each do |test_path|
+      system "ruby #{test_path}"
+    end
+  end
+end

data/comscore_ruby.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "savon", ">= 0.9.7"
-  s.add_runtime_dependency "activesupport", ">= 3.1.0"
+  #s.add_runtime_dependency "activesupport", ">= 3.0.0"
+  s.add_runtime_dependency "activesupport"
   
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"

data/lib/comscore_ruby/client.rb

@@ -1,6 +1,7 @@
 module ComScore
   class Client
     BASE_URI = "https://api.comscore.com/"
+    DEFAULT_REPORT_WAIT_TIME = 5
     SERVICES = {
       :key_measures         => {:wsdl => "#{BASE_URI}KeyMeasures.asmx?WSDL"},
       :audience_duplication => {:wsdl => "#{BASE_URI}DigitalCalc.asmx?WSDL"},
@@ -19,142 +20,112 @@ module ComScore
     
     def initialize(uname, pw)
       @username, @password = [uname, pw]
+      @client = Savon::Client.new
+      @client.http.auth.basic(@username, @password)
     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)
+    # Executes a request against ComScore's SOAP API.  Service name should correspond to one of the available services you've subscribed to:
+    # - +:key_measures+
+    # - +:audience_duplication+
+    # - +:percent_media_trend+
+    # - etc... see http://api.comscore.com for more information
+    # You can (and should) pass a block to build the details of the request you're sending to the method.  See the examples below.
+    #
+    # == Examples
+    #
+    #   # Find the media property named "The Globe And Mail" within the Canadian dictionary from two months ago.
+    #   client = ComScore::Client.new(username, password)
+    #   client.request(:key_measures, :fetch_media) do |xml|
+    #     xml.parameterId("media")
+    #     xml.fetchMediaQuery("xmlns" => "http://comscore.com/FetchMedia") {
+    #       xml.SearchCritera(:ExactMatch => "false", :Critera => "The Globe And Mail")
+    #     }
+    #     xml.reportQuery("xmlns" => "http://comscore.com/ReportQuery") {
+    #       xml.Parameter(:KeyId => "geo", :Value => ComScore::GEOGRAPHIES["Canada"])
+    #       xml.Parameter(:KeyId => "loc", :Value => ComScore::LOCATIONS["Home and Work"])
+    #       xml.Parameter(:KeyId => "timeType", :Value => ComScore::TIME_TYPES["Months"])
+    #       xml.Parameter(:KeyId => "timePeriod", :Value => DateTime.now.to_date.to_comscore_time_period - 2)
+    #       xml.Parameter(:KeyId => "mediaSetType", :Value => ComScore::MEDIA_SET_TYPES["Ranked Categories"])
+    #     }
+    #   end
+    def request(service_name, method)
+      @client.wsdl.document = SERVICES[service_name][:wsdl]
       
-      response = @client.request(:discover_parameter_values) do
+      @client.request(method) 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")
-                }
+              xml.tag!(method.to_s.camelize, :xmlns => "http://comscore.com/") {
+                yield xml if block_given?
               }
             }
           }
         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
-                  }
-                }
-              }
-            }
+    # Fetches report data against a given comScore +service+ (e.g. KeyMeasures, MediaTrend, etc).
+    #
+    # == Examples
+    #
+    #   # Get a Key Measures report for a given media set ID
+    #   client.get_report(:key_measures,
+    #    :geo => ComScore::GEOGRAPHIES["Canada"],
+    #    :loc => ComScore::LOCATIONS["Home and Work"],
+    #    :timeType => ComScore::TIME_TYPES["Months"],
+    #    :timePeriod => Date.new(2011, 8),
+    #    :mediaSet => 778226,
+    #    :mediaSetType => ComScore::MEDIA_SET_TYPES["Ranked Categories"],
+    #    :targetType => ComScore::TARGET_TYPES["Simple"],
+    #    :targetGroup => ComScore::TARGET_GROUPS["Total Audience"],
+    #    :measure => [ComScore::MEASURES["Total Unique Visitors (000)"]]
+    #   )
+    def get_report(service, opts = {})
+      job_queue_response = self.request(service, :submit_report) do |xml|
+        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 = ""
       
-      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]
+        sleep(DEFAULT_REPORT_WAIT_TIME) if job_status != ""
+        job_status_response = self.request(service, :ping_report_status) { |xml| xml.jobId(job_id) }.to_hash
+        job_status = job_status_response[: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]
+      if job_status == "Completed"
+        return self.request(service, :fetch_report) {|xml| xml.jobId(job_id) }
       else
         raise "The job with id #{job_id} failed to complete. Last known status was #{job_status}."
       end
     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
+      
   end
 end

data/lib/comscore_ruby/constants.rb

@@ -37,6 +37,7 @@ module ComScore
     "All Entries" => "-1"
   }
   MEASURES = {
+    "Target Audience (000)" => 73,
     "Total Unique Visitors (000)" =>	1,
     "% Reach" => 9,
     "% Composition Unique Visitors" => 10,

data/lib/comscore_ruby/version.rb

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

data/lib/comscore_ruby.rb

@@ -18,6 +18,8 @@ require 'active_support/core_ext/date/zones'
 
 require 'active_support/core_ext/time/calculations'
 
+require 'active_support/inflector'
+
 module ComScore
 
 end

data/test/client_test.rb

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'test/unit'
+require 'yaml'
+
+require 'comscore_ruby'
+
+class ClientTest < Test::Unit::TestCase
+  
+  def setup
+    @config = YAML::load(File.open("test/config.yml"))["comscore"]
+    
+    @client = ComScore::Client.new(@config["username"], @config["password"])
+    @client.log = false
+  end
+  
+  def test_fetch_media
+    response = @client.request(:key_measures, :fetch_media) do |xml|
+      xml.parameterId("media")
+      xml.fetchMediaQuery("xmlns" => "http://comscore.com/FetchMedia") {
+        xml.SearchCritera(:ExactMatch => "false", :Critera => "The Globe And Mail")
+      }
+      xml.reportQuery("xmlns" => "http://comscore.com/ReportQuery") {
+        xml.Parameter(:KeyId => "geo", :Value => ComScore::GEOGRAPHIES["Canada"])
+        xml.Parameter(:KeyId => "loc", :Value => ComScore::LOCATIONS["Home and Work"])
+        xml.Parameter(:KeyId => "timeType", :Value => ComScore::TIME_TYPES["Months"])
+        xml.Parameter(:KeyId => "timePeriod", :Value => DateTime.now.to_date.to_comscore_time_period - 2)
+        xml.Parameter(:KeyId => "mediaSetType", :Value => ComScore::MEDIA_SET_TYPES["Ranked Categories"])
+      }
+    end
+    
+    assert_equal("The Globe And Mail", response.to_hash[:fetch_media_response][:fetch_media_result][:media_item][:@name])
+  end
+  
+  def test_category_list
+    response = @client.request(:key_measures, :discover_parameter_values) do |xml|
+      xml.parameterId("mediaSet")
+      xml.query(:xmlns => "http://comscore.com/ReportQuery") {
+        xml.Parameter(:KeyId => "geo", :Value => ComScore::GEOGRAPHIES["Canada"])
+        xml.Parameter(:KeyId => "timeType", :Value => ComScore::TIME_TYPES["Months"])
+        xml.Parameter(:KeyId => "timePeriod", :Value => DateTime.now.to_date.to_comscore_time_period - 2)
+        xml.Parameter(:KeyId => "mediaSetType", :Value => ComScore::MEDIA_SET_TYPES["Ranked Categories"])
+      }
+    end
+    
+    assert_instance_of(Array, response.to_hash[:discover_parameter_values_response][:discover_parameter_values_result][:enum_value])
+  end
+  
+  def test_key_measures
+    response = @client.get_report(:key_measures,
+      :geo => ComScore::GEOGRAPHIES["Canada"],
+      :loc => ComScore::LOCATIONS["Home and Work"],
+      :timeType => ComScore::TIME_TYPES["Months"],
+      :timePeriod => Date.new(2011, 8),
+      :mediaSet => 778226,
+      :mediaSetType => ComScore::MEDIA_SET_TYPES["Ranked Categories"],
+      :targetType => ComScore::TARGET_TYPES["Simple"],
+      :targetGroup => ComScore::TARGET_GROUPS["Total Audience"],
+      :measure => [ComScore::MEASURES["Total Unique Visitors (000)"]]
+    )
+    
+    assert_instance_of(Array, response.to_hash[:fetch_report_response][:fetch_report_result][:report][:table][:tbody][:tr])
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: comscore_ruby
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 55
   prerelease: 
   segments: 
   - 0
   - 0
-  - 13
-  version: 0.0.13
+  - 20
+  version: 0.0.20
 platform: ruby
 authors: 
 - Mike Sukmanowsky
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-02 00:00:00 Z
+date: 2011-09-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: savon
@@ -43,10 +43,8 @@ dependencies:
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
-        - 3
-        - 1
         - 0
-        version: 3.1.0
+        version: "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.
@@ -68,6 +66,7 @@ files:
 - lib/comscore_ruby/constants.rb
 - lib/comscore_ruby/core_ext/date.rb
 - lib/comscore_ruby/version.rb
+- test/client_test.rb
 homepage: https://github.com/msukmanowsky/comscore_ruby/wiki
 licenses: []
 
@@ -101,5 +100,5 @@ 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: []
-
+test_files: 
+- test/client_test.rb