sinatra-mobile-adsense 0.1.1

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by milk1000cc, munshkr
+
+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,42 @@
+# Mobile Adsense for Sinatra #
+
+A Sinatra extension that provides a helper to show Google Adsense for Mobile.
+
+## Usage ##
+
+To use it, just use the `mobile_adsense` helper in your application template. A `:client` option must be provided:
+
+    <%= mobile_adsense :client => 'pub-1234567890' %>
+
+And that's it! You can pass any options.
+
+    <%= mobile_adsense :client => 'pub-1234567890', :format => 'mobile_double', :color_border => 'FFFFFF', :color_bg => 'FFFFFF' %>
+
+The `mobile_adsense` helper accesses Google server to get advertisements. If an error occurs doing the request, it returns an empty string. Exceptions are **not** raised.
+
+## Install ##
+
+You can install manually the gem:
+
+    $ gem install munshkr-sinatra-mobile-adsense -s http://gems.github.com/
+
+Or, if you use Bundler, add this line on your Gemfile:
+
+    gem "sinatra-mobile-adsense", :git => "git://github.com/munshkr/sinatra-mobile-adsense.git"
+
+and run `bundle install`.
+
+Finally, register the extension in your Sinatra application:
+
+    class MyApp < Sinatra::Base
+      register Sinatra::MobileAdsense
+      
+      # Your app code goes here
+    end
+
+## Legal ##
+
+This extension is mostly based on the Rails [plugin](http://github.com/milk1000cc/mobile_adsense) by milk1000cc.
+
+Copyright (c) 2011 milk1000cc, munshkr
+Released under the MIT license

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test sinatra-mobile-adsense extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/spec_*.rb'
+  t.verbose = true
+end

data/lib/sinatra/mobile_adsense.rb

@@ -0,0 +1,88 @@
+require "sinatra/base"
+require "open-uri"
+
+module Sinatra
+  module MobileAdsense
+
+    module Helpers
+      def mobile_adsense(options)
+        raise ArgumentError, ":client option must be defined" unless options[:client]
+
+        # TODO Should be timezone aware?
+        dt = "%.0f" % (1000 * Time.now.to_f)
+        user_agent = request.user_agent
+
+        options = options.dup
+        unless options[:client] =~ /^ca\-mb\-/
+          options[:client] = "ca-mb-#{ options[:client] }" 
+        end
+        options = {
+          :ad_type => "text_image",
+          :channel => "",
+          :dt => dt,
+          :format => "mobile_single",
+          :ip => request.ip,
+          :markup => "xhtml",
+          :oe => "utf8",
+          :output => "xhtml",
+          :ref => (request.referer || ""),
+          :url => request.url,
+          :useragent => user_agent
+        }.merge(google_screen_res(request)).merge(google_muid(request)).merge(google_via_and_accept(request, user_agent)).merge(options)
+
+        ad_url = "http://pagead2.googlesyndication.com/pagead/ads?"
+        ad_url += options.map { |k, v|
+          v = google_color(v, dt) if k =~ /color_/
+          "#{ k }=#{ ERB::Util.u(v) }"
+        }.join("&")
+
+        begin
+          result = URI(ad_url).read
+        rescue StandardError, Timeout::Error
+          ""
+        end
+      end
+    end
+
+    def self.registered(app)
+      app.helpers MobileAdsense::Helpers
+    end
+
+
+    def google_color(color, time)
+      color_array = color.split(",")
+      color_array[time.to_i % color_array.size]
+    end
+
+    def google_screen_res(request)
+      screen_res =
+        request.env["HTTP_UA_PIXELS"] ||
+        request.env["HTTP_X_UP_DEVCAP_SCREENPIXELS"] ||
+        request.env["HTTP_X_JPHONE_DISPLAY"] ||
+        ""
+      res_array = screen_res.split(/[x,*]/)
+      (res_array.size == 2) ? { :u_w => res_array[0], :u_h => res_array[1] } : {}
+    end
+
+    def google_muid(request)
+      muid =
+        request.env["HTTP_X_DCMGUID"] ||
+        request.env["HTTP_X_UP_SUBNO"] ||
+        request.env["HTTP_X_JPHONE_UID"] ||
+        request.env["HTTP_X_EM_UID"]
+      muid ? { :muid => muid } : {}
+    end
+
+    def google_via_and_accept(request, ua)
+      return {} if ua
+      via_and_accept = {}
+      via = request.env["HTTP_VIA"]
+      via_and_accept[:via] = request.env["HTTP_VIA"] if via
+      accept = request.env["HTTP_ACCEPT"]
+      via_and_accept[:accept] = request.env["HTTP_ACCEPT"] if accept
+      via_and_accept
+    end
+  end
+
+  register MobileAdsense
+end

data/spec/spec_mobile_adsense.rb

@@ -0,0 +1,172 @@
+require "rubygems"
+gem "rspec", ">= 2.0"
+
+require "rspec"
+require "sinatra"
+require "rack/test"
+require "webmock"
+
+require "sinatra/mobile_adsense"
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  WebMock.disable_net_connect!
+end
+
+set :environment, :test
+
+class Rack::Request
+  def secure?
+    (@env['HTTP_X_FORWARDED_PROTO'] || @env['rack.url_scheme']) == 'https'
+  end
+end
+
+
+describe "MobileAdsense" do
+  include Rack::Test::Methods
+  include Sinatra::MobileAdsense
+  include Sinatra::MobileAdsense::Helpers
+
+  attr_accessor :request
+
+  def app
+    Sinatra::Application
+  end
+
+  def reset_request
+    get "/"
+    @request = last_request
+  end
+
+  before { reset_request }
+
+  describe "::mobile_adsense" do
+    def set_stub_request(query = {})
+      stub_request(:get, "pagead2.googlesyndication.com/pagead/ads").
+        with(:query => {
+          :client => "ca-mb-pub-1234567890",
+          :ad_type => "text_image",
+          :channel => "",
+          :dt => "1287840160591",
+          :format => "mobile_single",
+          :ip => @request.ip,
+          :markup => "xhtml",
+          :oe => "utf8",
+          :output => "xhtml",
+          :ref => "/",
+          :url => @request.url,
+          :useragent => @request.user_agent
+        }.merge(query)).
+        to_return :body => @ad_output
+    end
+
+    before { @ad_output = "<adsense>" }
+
+    before do
+      Time.stub_chain :now, :to_f => 1287840160.59053
+    end
+
+    it "should need 'client' option" do
+      set_stub_request
+      lambda { mobile_adsense(:client => "pub-1234567890") }.should_not raise_error(ArgumentError)
+      lambda { mobile_adsense(:foo => "var", :client => "pub-1234567890") }.should_not raise_error(ArgumentError)
+      lambda { mobile_adsense }.should raise_error(ArgumentError)
+      lambda { mobile_adsense(:foo => "var") }.should raise_error(ArgumentError)
+    end
+
+    it "should return the adsense's output" do
+      set_stub_request
+      mobile_adsense(:client => "pub-1234567890").should == @ad_output
+      mobile_adsense(:client => "ca-mb-pub-1234567890").should == @ad_output
+    end
+
+    it "should consider passed paramerters" do
+      set_stub_request :color_border => "ffffff"
+      mobile_adsense(:client => "pub-1234567890", :color_border => "ffffff").should == @ad_output
+    end
+
+    context "when an error happens while requesting for google" do
+      it "should return empty string" do
+        stub_request(:get, %r!pagead2.googlesyndication.com/pagead/ads!).to_timeout
+        lambda { mobile_adsense(:client => "pub-1234567890") }.should_not raise_error
+        mobile_adsense(:client => "pub-1234567890").should == ""
+      end
+    end
+  end
+
+  describe "::google_color" do
+    it "should return color code" do
+      google_color("ffffff,cccccc", 0).should == "ffffff"
+      google_color("ffffff,cccccc", 1).should == "cccccc"
+      google_color("ffffff,cccccc", 2).should == "ffffff"
+    end
+  end
+
+  describe "::google_screen_res" do
+    it "should return 'u_w' and 'u_h' parameters" do
+      @request.env["HTTP_UA_PIXELS"] = "240x320"
+      google_screen_res(@request).should == { :u_w => "240", :u_h => "320" }
+
+      reset_request
+      @request.env["HTTP_X_UP_DEVCAP_SCREENPIXELS"] = "200,300"
+      google_screen_res(@request).should == { :u_w => "200", :u_h => "300" }
+
+      reset_request
+      @request.env["HTTP_X_JPHONE_DISPLAY"] = "250*330"
+      google_screen_res(@request).should == { :u_w => "250", :u_h => "330" }
+
+      reset_request
+      @request.env["HTTP_UA_PIXELS"] = "240"
+      google_screen_res(@request).should == {}
+
+      reset_request
+      google_screen_res(@request).should == {}
+    end
+  end
+
+  describe "::google_muid" do
+    it "should return 'muid' parameter" do
+      @request.env["HTTP_X_DCMGUID"] = "XXXXX000000"
+      google_muid(@request).should == { :muid => "XXXXX000000" }
+
+      reset_request
+      @request.env["HTTP_X_UP_SUBNO"] = "00000000000000_mj.ezweb.ne.jp"
+      google_muid(@request).should == { :muid => "00000000000000_mj.ezweb.ne.jp" }
+
+      reset_request
+      @request.env["HTTP_X_JPHONE_UID"] = "aaaaaaaaaaaaaaaa"
+      google_muid(@request).should == { :muid => "aaaaaaaaaaaaaaaa" }
+
+      reset_request
+      @request.env["HTTP_X_EM_UID"] = "bbbbbbbbbbbbbbbb"
+      google_muid(@request).should == { :muid => "bbbbbbbbbbbbbbbb" }
+
+      reset_request
+      google_muid(@request).should == {}
+    end
+  end
+
+  describe "::google_via_and_accept" do
+    it "should return 'via' and 'accept' parameters when user agent is undefined" do
+      @request.env["HTTP_VIA"] = "via"
+      google_via_and_accept(@request, nil).should == { :via => "via" }
+
+      reset_request
+      @request.env["HTTP_ACCEPT"] = "accept"
+      google_via_and_accept(@request, nil).should == { :accept => "accept" }
+
+      reset_request
+      @request.env["HTTP_VIA"] = "via!"
+      @request.env["HTTP_ACCEPT"] = "accept!"
+      google_via_and_accept(@request, nil).should == { :via => "via!", :accept => "accept!" }
+
+      reset_request
+      google_via_and_accept(@request, "ua").should == {}
+
+      reset_request
+      @request.env["HTTP_VIA"] = "via!!"
+      @request.env["HTTP_ACCEPT"] = "accept!!"
+      google_via_and_accept(@request, "ua").should == {}
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-mobile-adsense
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- milk1000cc
+- munshkr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-15 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: 
+email: munshkr@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/mobile_adsense.rb
+- spec/spec_mobile_adsense.rb
+has_rdoc: true
+homepage: http://github.com/munshkr/sinatra-mobile-adsense
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Sinatra extension that provides a helper for showing Google Adsense for Mobile.
+test_files: 
+- spec/spec_mobile_adsense.rb