admob 1.0.2 → 1.1.0

data/History.txt

@@ -1,3 +1,6 @@
+=== 1.1.0 / 2008-10-05
+* Added support for AdMob cookies (see README.TXT)
+
 === 1.0.0 / 2008-05-08
 
 * AdMob gem created

data/README.txt

@@ -10,20 +10,52 @@ Enables easy integration of AdMob services (ads and/or analytics) into a RoR mob
 
 === Setting up
 
-* Get a publisher_id and/or analytics_id from http://www.admob.com/ and/or http://analytics.admob.com/ .
+* Get a publisher_id and/or analytics_id from http://www.admob.com and/or http://analytics.admob.com
 * Add <tt>require "admob"</tt> to app/controllers/application.rb, or to any specific controller as needed.
 * Provide some or all default settings in your environment.rb . e.g. :
- require 'admob'
- AdMob::config do |c|
-   c.publisher_id = 'YOUR_PUBLISHER_ID'
-   c.analytics_id = 'YOUR_ANALYTICS_ID'
-   c.timeout = 1
-   c.encoding = 'UTF-8'
-   c.raise_exceptions = false
- end
+    require 'admob'
+    AdMob::config do |c|
+      c.publisher_id = 'YOUR_PUBLISHER_ID'
+      c.analytics_id = 'YOUR_ANALYTICS_ID'
+      c.timeout = 1
+      c.encoding = 'UTF-8'
+      c.raise_exceptions = false
+      c.cookie_domain = 'example.com'
+    end
 * In a view, where you want an ad, place an ad request.
 * Note: You must provide your publisher_id and/or analytics_id in the default setting, or when you make the ad request (see below).
 
+=== Using Cookies
+
+* AdMob now uses cookies to enhance ad targeting and analytics data.
+* The easiest way to enable AdMob cookies on your website is to add the following code snippet to your ActionController::Base class (usually in app/controllers/application.rb)
+* This will cause AdMob::set_cookie() to be executed on every request (the function will return immediately if a cookie does not need to be set)
+
+    require 'admob'
+    class ApplicationController < ActionController::Base
+    
+      ## begin AdMob cookie snippet ##
+      before_filter :admob_set_cookie
+      
+      def admob_set_cookie
+        AdMob::set_cookie(request, cookies)
+      end
+      ## end AdMob cookie snippet ##
+      
+    end
+  
+=== Configuring Cookies (IMPORTANT if your site uses multiple subdomains)
+
+* By default, the domain of the cookie is for the host that set it. This means that cookies set from a.example.com are not visible from b.example.com
+* To allow AdMob cookies to be visible everywhere on your site, you need to set a default cookie domain in environment.rb
+* The default cookie domain should be the root domain of your mobile site (e.g. "example.com", "example.co.uk") 
+
+    require 'admob'
+    AdMob::config do |c|
+      c.cookie_domain = 'example.com' # if your main domain is www.example.com
+      c.cookie_domain = 'example.co.uk' # if your main domain is www.example.co.uk
+    end
+
 === Sample requests
 
 ==== If you've configured a default publisher and/or analytics id
@@ -50,12 +82,16 @@ See the documentation for #AdMob::request for a list of all params that can be s
 
 == REQUIREMENTS:
 
-* An AdMob publisher_id and/or analytics_id (get them at http://www.admob.com)
+* An AdMob publisher_id and/or analytics_id (get them at http://www.admob.com and http://analytics.admob.com)
 
 == INSTALL:
 
 <tt>sudo gem install admob</tt>
 
+== HELP:
+
+Additional information can be found at http://developer.admob.com
+
 == LICENSE:
 
 (The BSD License)
@@ -68,4 +104,4 @@ Redistribution and use in source and binary forms, with or without modification,
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/admob.rb

@@ -8,10 +8,10 @@ $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) ||
 # This module encapsulates functionality (ad requests, analytics requests) provided by AdMob. See README.txt for usage.
 module AdMob
   
-  GEM_VERSION = '1.0.2'
+  GEM_VERSION = '1.1.0'
 
   ENDPOINT = URI.parse('http://r.admob.com/ad_source.php')
-  PUBCODE_VERSION = '20080630-RUBY-924f7dd99e8828c2'
+  PUBCODE_VERSION = '20081105-RUBY-70e4a867449121c5'
   DEFAULT_TIMEOUT = 1.0
 
   # Make an AdMob ad/analytics request. The first param is the request variable from Rails; the second is a unique session
@@ -39,11 +39,6 @@ module AdMob
   # [<tt>:timeout</tt>] override the default timeout value for this ad request in seconds, e.g. 2
   # [<tt>:raise_exceptions</tt>] whether to raise exceptions when something goes wrong (defaults to false); exceptions will all be instances of AdMob::Error; a default can be set using <tt>AdMob::config {|c| c.raise_exceptions = true}</tt>
   def self.request(request, session_id, params = {})
-    # Guarantee that only one analytics call gets made per request
-    if request.env['admob_analytics_request_issued'] == true
-      params[:analytics_request] = false
-    end
-    
     raise_exceptions = params[:raise_exceptions].nil? ? AdMob::Defaults.raise_exceptions : params[:raise_exceptions]
     
     # Build the post request
@@ -61,27 +56,72 @@ module AdMob
     conn.read_timeout = timeout
     conn.open_timeout = timeout
     begin
+      start = Time.now.getutc.to_f
       response = conn.start {|http| http.request(req)}
-      contents = response.body     
+      contents = response.body
     rescue Timeout::Error => te
-      contents = %Q|<img src="http://t.admob.com/li.php/c.gif/#{post_data['s']}/1/#{timeout}/#{MD5.hexdigest(post_data['p'])}" alt="" width="1" height="1" />|
       raise AdMob::Error.new("AdMob::request timed out; timeout was #{timeout}, elapsed time was #{Time.now.to_f - post_data['z']}") if raise_exceptions
     rescue
       raise AdMob::Error.new("AdMob::request encountered unexpected exception #{$!}") if raise_exceptions
     ensure
       contents ||= ''
+      lt = Time.now.getutc.to_f - start
     end
-
+    
     # If appropriate, add the analytics pixel
-    if post_data['rt'] > 0
-      contents << %Q|<img src="http://a.admob.com/e0?a=#{post_data['a']}&amp;s=#{post_data['s']}&amp;z=#{post_data['z']}&amp;lt=#{Time.now.to_f - post_data['z']}&amp;rt=#{post_data['rt']}" alt="" width="1" height="1"/>|
+    if !request.env['admob_pixel_sent']
+      request.env['admob_pixel_sent'] = true
+      contents << '<img src="http://p.admob.com/e0?'
+      contents << "rt=#{post_data['rt']}&amp;"
+      contents << "z=#{post_data['z']}&amp;"
+      contents << "a=#{post_data['a']}&amp;"
+      contents << "s=#{post_data['s']}&amp;"
+      contents << "o=#{post_data['o']}&amp;"
+      contents << "lt=%0.4f&amp;" % lt
+      contents << "to=#{timeout}"
+      contents << '" alt="" width="1" height="1"/>'
     end
     
     contents
   end
 
+  # This function should be called from an ActionController to set a cookie on behalf of AdMob.
+  # AdMob recommends using a before_filter in your ActionController::Base class (usually in app/controllers/application.rb) to call set_cookie on each request.
+  # Here is a sample application.rb.
+  #   require 'admob'
+  #   # Filters added to this controller apply to all controllers in the application.
+  #   # Likewise, all the methods added will be available for all controllers.
+  #
+  #   class ApplicationController < ActionController::Base
+  #     before_filter :admob_set_cookie
+  #     
+  #     def admob_set_cookie
+  #       AdMob::set_cookie(request, cookies)
+  #     end
+  #   end
+  def self.set_cookie(request, cookies)
+    # don't make a new cookie if one already exists
+    return if request.env['admobuu'] or cookies[:admobuu]
+    
+    # make a new cookie
+    value = MD5.hexdigest(rand().to_s + request.user_agent + request.remote_ip + Time.now.to_f.to_s)
+    new_cookie = { :value    => value,
+                   :expires  => Time.at(0x7fffffff), # end of 32 bit time
+                   :path     => "/" }
+    
+    if AdMob::Defaults.cookie_domain
+      domain = AdMob::Defaults.cookie_domain
+      domain = '.' + domain if domain[0].chr != '.'
+      new_cookie[:domain] = domain
+    end
+    cookies[:admobuu] = new_cookie
+    
+    # make this cookie visible to the current page
+    request.env['admobuu'] = value
+  end
+  
   # Provides access to AdMob config, used for setting default request info.
-  # Currently, can be used to set defaults for: publisher_id, analytics_id, ad encoding, request timeout,
+  # Currently, can be used to set defaults for: publisher_id, analytics_id, ad encoding, request timeout, cookie_domain,
   # and whether exceptions are raised when something goes wrong.
   # For example, in environment.rb:
   #  require 'admob'
@@ -91,6 +131,7 @@ module AdMob
   #    c.encoding = 'SJIS'
   #    c.timeout = 3
   #    c.raise_exceptions = true
+  #    c.cookie_domain = 'example.com'
   #  end
   def self.config
     yield AdMob::Defaults
@@ -103,11 +144,11 @@ module AdMob
   end
 
 private
-
+  
   # Stores default values for AdMob requests. Set these defaults via AdMob::config.
   class Defaults
     class << self
-      attr_accessor :publisher_id, :analytics_id, :encoding, :timeout, :raise_exceptions
+      attr_accessor :publisher_id, :analytics_id, :encoding, :timeout, :raise_exceptions, :cookie_domain
     end
   end
 
@@ -119,7 +160,7 @@ private
     encoding = params[:encoding] || AdMob::Defaults.encoding
 
     # Determine the type of request
-    analytics_request = (params[:analytics_request] != false) && (!analytics_id.nil?) && (!analytics_id.strip.empty?)
+    analytics_request = (params[:analytics_request] != false) && (!analytics_id.nil?) && (!analytics_id.strip.empty?) && (!request.env['admob_pixel_sent'])
     ad_request = (params[:ad_request] != false) && (!publisher_id.nil?) && (!publisher_id.strip.empty?)
 
     case [ad_request, analytics_request]
@@ -128,27 +169,25 @@ private
     when [false, true] then request_type = 1
     when [true, true] then request_type = 2
     end
-
-    # mark for this request so we don't make analytics calls again
-    request.env['admob_analytics_request_issued'] = true if analytics_request
-
+    
     # Build the basic request
     post_data = {
-      's'         => publisher_id,
-      'a'         => analytics_id,
+      'rt'        => request_type,
+      'z'         => Time.now.getutc.to_f,
       'u'         => request.user_agent,
       'i'         => request.remote_ip,
       'p'         => request.request_uri,
       't'         => MD5.hexdigest(session_id),
-      'ma'        => params[:markup],
-      'rt'        => request_type,
       'v'         => PUBCODE_VERSION,
+      'o'         => request.cookies['admobuu'][0] || request.env['admobuu'],
+      's'         => publisher_id,
+      'a'         => analytics_id,
+      'ma'        => params[:markup],
       'd[pc]'     => params[:postal_code],
       'd[ac]'     => params[:area_code],
       'd[coord]'  => params[:coordinates],
       'd[dob]'    => params[:dob],
       'd[gender]' => params[:gender],
-      'z'         => Time.now.to_f,
       'k'         => params[:keywords],
       'search'    => params[:search],
       'f'         => 'html',
@@ -158,7 +197,7 @@ private
 
     # Add in headers
     ignore_headers = Set['HTTP_PRAGMA', 'HTTP_CACHE_CONTROL', 'HTTP_CONNECTION',
-        'HTTP_USER_AGENT', 'HTTP_COOKIE', 'ADMOB_ANALYTICS_REQUEST_ISSUED']
+        'HTTP_USER_AGENT', 'HTTP_COOKIE', 'ADMOB_PIXEL_SENT', 'ADMOBUU']
     request.env.each {|k,v| post_data["h[#{k}]"] = v unless ignore_headers.include?(k.upcase.gsub(/-/,'_'))}
 
     # Add in optional data
@@ -170,4 +209,4 @@ private
     post_data.delete_if {|k,v| v.nil?}
   end
 
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: admob
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - AdMobAdMob
@@ -9,17 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-29 00:00:00 -07:00
+date: 2008-11-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.6.0
+        version: 1.7.0
     version: 
 description: Enables easy integration of AdMob ads into a RoR mobile site.
 email: support@admob.comsupport@admob.com
@@ -60,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: admob
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Enables easy integration of AdMob ads into a RoR mobile site.