tatyree-admob 1.1.0

data/History.txt

@@ -0,0 +1,9 @@
+=== 1.1.0 / 2009-03-08
+* Modified version to track without the use of cookies. 
+
+=== 1.1.0 / 2008-10-05
+* Added support for AdMob cookies (see README.TXT)
+
+=== 1.0.0 / 2008-05-08
+
+* AdMob gem created

data/Manifest

@@ -0,0 +1,6 @@
+admob.gemspec
+History.txt
+lib/admob.rb
+Manifest
+Rakefile
+README.rdoc

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('admob', '1.1.0') do |p|
+  p.description    = "Enables easy integration of AdMob ads into a RoR mobile site. Bypasses the original gem's cookie requirement."
+  p.url            = "http://github.com/tatyree/admob"
+  p.author         = "AdMob, Todd Tyree"
+  p.email          = "todd@snappl.co.uk"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end

data/admob.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{admob}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["AdMob, Todd Tyree"]
+  s.date = %q{2009-03-08}
+  s.description = %q{Enables easy integration of AdMob ads into a RoR mobile site. Bypasses the original gem's cookie requirement.}
+  s.email = %q{todd@snappl.co.uk}
+  s.extra_rdoc_files = ["lib/admob.rb", "README.txt"]
+  s.files = ["History.txt", "lib/admob.rb", "Manifest.txt", "Rakefile", "README.txt", "Manifest", "admob.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/tatyree/admob}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Admob", "--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{admob}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Enables easy integration of AdMob ads into a RoR mobile site. Bypasses the original gem's cookie requirement.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/admob.rb

@@ -0,0 +1,218 @@
+require 'net/http'
+require 'uri'
+require 'md5'  
+
+# Set up include path correctly
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# This module encapsulates functionality (ad requests, analytics requests) provided by AdMob. See README.txt for usage.
+module AdMob
+  
+  GEM_VERSION = '1.1.0'
+
+  ENDPOINT = URI.parse('http://r.admob.com/ad_source.php')
+  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
+  # identifier. In general, requests should always be of the form <tt><%= AdMob::request(request, session, ...) %></tt>.
+  # Regardless of how many times AdMob::request is called, only one analytics call will be made per page load.
+  # The remaining params set optional features of the request. Params that can be set are:
+  #
+  # [<tt>:publisher_id</tt>] your admob publisher_id, a default can be set using <tt>AdMob::config {|c| c.publisher_id = "YOUR_PUBLISHER_ID"}</tt>
+  # [<tt>:analytics_id</tt>] your admob analytics_id, a default can be set using <tt>AdMob::config {|c| c.analytics_id = "YOUR_ANALYTICS_ID"}</tt>
+  # [<tt>:ad_request</tt>] whether to make an ad request, defaults to true
+  # [<tt>:analytics_request</tt>] whether to make an analytics request, defaults to true
+  # [<tt>:encoding</tt>] char encoding of the response, either "UTF-8" or "SJIS", defaults to UTF-8
+  # [<tt>:markup</tt>] your site's markup, e.g. "xhtml", "wml", "chtml"
+  # [<tt>:postal_code</tt>] postal code of the current user, e.g. "94401"
+  # [<tt>:area_code</tt>] area code of the current user, e.g. "415"
+  # [<tt>:coordinates</tt>] lat/long of the current user, comma separated, e.g. "37.563657,-122.324807"
+  # [<tt>:dob</tt>] date of birth of the current user, e.g. "19800229"
+  # [<tt>:gender</tt>] gender of the current user, e.g. "m" or "f"
+  # [<tt>:keywords</tt>] keywords, e.g. "ruby gem admob"
+  # [<tt>:search</tt>] searchwords (much more restrictive than keywords), e.g. "ruby gem admob"
+  # [<tt>:title</tt>] title of the page, e.g. "Home Page"
+  # [<tt>:event</tt>] the event you want to report to analytics, e.g. "reg_success"
+  # [<tt>:text_only</tt>] if set to true, don't return a banner ad for this request
+  # [<tt>:test</tt>] whether this should issue a test ad request, not a real one
+  # [<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, params = {})
+    raise_exceptions = params[:raise_exceptions].nil? ? AdMob::Defaults.raise_exceptions : params[:raise_exceptions]
+    
+    # Build the post request
+    post_data = self.build_post_data(request, session, params)
+    if post_data.nil?
+      raise AdMob::Error.new("AdMob::request called as neither an ad nor an analytics request") if raise_exceptions
+      return ''
+    end
+    
+    # Send request
+    req = Net::HTTP::Post.new(ENDPOINT.path)
+    req.set_form_data(post_data)
+    conn = Net::HTTP.new(ENDPOINT.host, ENDPOINT.port)
+    timeout = params[:timeout] || AdMob::Defaults.timeout || DEFAULT_TIMEOUT
+    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
+    rescue Timeout::Error => te
+      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 !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, session)    
+    # First, see if the env or the cookies is set and return.
+    return cookies[:admobuu][0] if cookies[:admobuu]
+    
+    # Try the session for recovering the value next.  For unreliable handlers of cookies, this *SHOULD* allow us
+    # to maintain the admobuu across a flip-flopping session. 
+    return session[:admobuu] if !session[:admobuu].blank?
+    
+    # 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
+    
+    session[:admobuu] = value
+    
+    # Return the value so we can manually set the environment if cookies aren't on
+    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, cookie_domain,
+  # and whether exceptions are raised when something goes wrong.
+  # For example, in environment.rb:
+  #  require 'admob'
+  #  AdMob::config do |c|
+  #    c.publisher_id = 'YOUR_DEFAULT_PUBLISHER_ID'
+  #    c.analytics_id = 'YOUR_DEFAULT_ANALYTICS_ID'
+  #    c.encoding = 'SJIS'
+  #    c.timeout = 3
+  #    c.raise_exceptions = true
+  #    c.cookie_domain = 'example.com'
+  #  end
+  def self.config
+    yield AdMob::Defaults
+  end
+
+  # Simple exception class used for all AdMob exceptions. By default, exceptions are never raised.
+  # To enable raising of exceptions, set parameter :raise_exceptions => true for a request, or
+  # set a default using AdMob::config (see AdMob::config documentation).
+  class Error < StandardError
+  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, :cookie_domain
+    end
+  end
+
+  def self.build_post_data(request, session, params)
+    # Gather basic data
+    publisher_id = params[:publisher_id] || AdMob::Defaults.publisher_id
+    analytics_id = params[:analytics_id] || AdMob::Defaults.analytics_id
+    test = params[:test].nil? ? (RAILS_ENV == 'test') : params[:test]
+    encoding = params[:encoding] || AdMob::Defaults.encoding
+
+    # Determine the type of request
+    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]
+    when [false, false] then return nil
+    when [true, false] then request_type = 0
+    when [false, true] then request_type = 1
+    when [true, true] then request_type = 2
+    end
+    
+    # Build the basic request
+    post_data = {
+      '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.session_id),
+      'v'         => PUBCODE_VERSION,
+      'o'         => request.cookies['admobuu'][0] || session[: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],
+      'k'         => params[:keywords],
+      'search'    => params[:search],
+      'f'         => 'html',
+      'title'     => params[:title],
+      'event'     => params[:event]
+    }
+
+    # Add in headers
+    ignore_headers = Set['HTTP_PRAGMA', 'HTTP_CACHE_CONTROL', 'HTTP_CONNECTION',
+        '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
+    post_data['e'] = encoding if encoding
+    post_data['y'] = 'text' if params[:text_only]
+    post_data['m'] = 'test' if test
+    
+    # Don't send anything that's nil (but send if empty string)
+    post_data.delete_if {|k,v| v.nil?}
+  end
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: tatyree-admob
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- AdMob, Todd Tyree
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-08 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Enables easy integration of AdMob ads into a RoR mobile site. Bypasses the original gem's cookie requirement.
+email: todd@snappl.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/admob.rb
+- README.txt
+files: 
+- History.txt
+- lib/admob.rb
+- Manifest.txt
+- Rakefile
+- README.txt
+- Manifest
+- admob.gemspec
+has_rdoc: true
+homepage: http://github.com/tatyree/admob
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Admob
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: admob
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Enables easy integration of AdMob ads into a RoR mobile site. Bypasses the original gem's cookie requirement.
+test_files: []
+