divining_rod 0.4.0 → 0.5.0

data/README.markdown

@@ -1,6 +1,7 @@
 # Divining Rod
+<img src='http://public.mpercival.com.s3.amazonaws.com/images/divining_rod.jpg' />
 
-A tool to help format your sites mobile pages.
+A tool to profile web requests. Especially useful for mobile site development
 
 ## Installation
 
@@ -8,7 +9,7 @@ A tool to help format your sites mobile pages.
 
 ## Example
   
-  Using the example configuration (found in [example_config.rb](http://github.com/markpercival/divining_rod/blob/master/example_config.rb)])
+  Using the example configuration (found in [example_config.rb](http://github.com/markpercival/divining_rod/blob/master/example_config.rb))
   
     # For a request with the user agent
     # "Mozilla/5.0 (iPhone; U; CPU iPhone OS 2_2_1 like Mac OS X; en-us) AppleWebKit/525.18.1 (KHTML, like Gecko) Version/3.1.1 Mobile/5H11 Safari/525.20"
@@ -18,21 +19,40 @@ A tool to help format your sites mobile pages.
     profile.name              #=> 'iPhone'
     profile.youtube_capable?  #=> true
     profile.format            #=> :webkit
+
+## Mappings
+
+Matches happen in the order they are defined, and then proceed down to the subsequent block. So for example:
+
+    DiviningRod::Mappings.define do |map|
+      map.ua /Apple/, :format => :webkit, :tags => [:apple, :iphone_os] do
+        iphone.ua /iPad/, :tags => :ipad, :name => 'iPad', :format => nil
+        iphone.ua /iPod/, :tags => :ipod, :name => 'iPod Touch'
+        iphone.ua /iPhone/, :tags => :iphone, :name => 'iPhone'
+      end
+    end
     
+Will match "Apple iPad" first with the /Apple/ matcher, then with the /iPad/ matcher, and the tags will be
     
+    [:apple, :iphone_os, :ipad] # Notice tags get appended, *not* overridden.
+
+And _:format_ will be set to _nil_
+
+Why _nil_? Because when :format is set to _nil_ and you ask for it, DiviningRod will return the original _request_ objects format.
+
 ## Usage
 
 _initializers/divining\_rod.rb_
-
+    
     DiviningRod::Mappings.define do |map|
         # Android based phones
         map.ua /Android/, :format => :webkit, :name => 'Android', :tags => [:android, :youtube_capable, :google_gears]
 
         # Apple iPhone OS
         map.ua /Apple.*Mobile.*Safari/, :format => :webkit, :tags => [:apple, :iphone_os, :youtube_capable] do |iphone|
-          iphone.ua /iPad/, :tags => :ipad, :name => 'iPad'
+          iphone.ua /iPad/, :tags => :ipad, :name => 'iPad', :format => nil
           iphone.ua /iPod/, :tags => :ipod, :name => 'iPod Touch'
-          iphone.ua /iPhone/, :tags => [:iphone], :name => 'iPhone'
+          iphone.ua /iPhone/, :tags => :iphone, :name => 'iPhone'
         end
 
         #Blackberry, needs more detail here
@@ -76,10 +96,8 @@ _app/views/mobile/show.webkit.html_
     
 ## Note on the development
 
-Tags always merge, while all other hash keys get overridden. Tags also will always allow you to call them as
-booleans. Ex @profile.iphone? 
-
-If the :format key isn't available we default to request.format.
+In version 0.3.* it was assumed you always passed in _format_. In 0.4 on, we require _format_ to
+be passed in explicitly with the rest of the options hash.
 
 ## Todo
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/divining_rod.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{divining_rod}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Percival"]
-  s.date = %q{2010-02-23}
+  s.date = %q{2010-08-30}
   s.description = %q{A mobile phone web request profiler using definitions that look like rails routes}
   s.email = %q{mark@mpercival.com}
   s.extra_rdoc_files = [
@@ -32,17 +32,21 @@ Gem::Specification.new do |s|
      "lib/divining_rod/matchers.rb",
      "lib/divining_rod/murge.rb",
      "lib/divining_rod/profile.rb",
+     "lib/divining_rod/rack.rb",
+     "lib/divining_rod/rack/divining_rack.rb",
+     "lib/divining_rod/utilities.rb",
      "spec/definition_spec.rb",
      "spec/example_mapping_spec.rb",
      "spec/mapper_spec.rb",
      "spec/mapping_spec.rb",
      "spec/profile_spec.rb",
+     "spec/rack_spec.rb",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/markpercival/divining_rod}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{A mobile phone web request profiler}
   s.test_files = [
     "spec/definition_spec.rb",
@@ -50,6 +54,7 @@ Gem::Specification.new do |s|
      "spec/mapper_spec.rb",
      "spec/mapping_spec.rb",
      "spec/profile_spec.rb",
+     "spec/rack_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/divining_rod.rb

@@ -1,6 +1,7 @@
 module DiviningRod; end
 
 require 'divining_rod/profile'
+require 'divining_rod/utilities'
 require 'divining_rod/murge'
 require 'divining_rod/definition'
 require 'divining_rod/mappings'

data/lib/divining_rod/mappings.rb

@@ -8,6 +8,7 @@ module DiviningRod
       def define(opts = {})
         @root_definition = Definition.new { true }
         yield Mapper.new(@root_definition, opts)
+        @root_definition.freeze
       end
       
       def evaluate(obj)

data/lib/divining_rod/matchers.rb

@@ -1,23 +1,31 @@
 module DiviningRod
   class Matchers
     class << self
-      
+
       def ua(pattern, opts = {})
         Definition.new(opts) { |request|
-          if pattern.match(request.user_agent)
+          if pattern.match(request.env['HTTP_USER_AGENT'])
             true
           end
         }
       end
-      
+
       def subdomain(pattern, opts={})
         Definition.new(opts) { |request|
-          if pattern.match(request.subdomains[0])
+          if pattern.match(DiviningRod::Utilities.parse_subdomain(request)[0])
             true
           end
         }
       end
-      
+
+      def ua_prof(pattern, opts ={})
+        Definition.new(opts) {|request|
+          if pattern.match(request.env['X_WAP_PROFILE'])
+            true
+          end
+        }
+      end
+
     end
   end
 end

data/lib/divining_rod/profile.rb

@@ -1,35 +1,36 @@
 module DiviningRod
   class Profile
 
-    attr_reader :match
-
     def initialize(request)
       @request = request.clone #Lets not mess with the real one
-      @match = DiviningRod::Mappings.evaluate(request)
+    end
+    
+    def match
+      @match ||= DiviningRod::Mappings.evaluate(@request)
     end
 
     def format
-      if @match && @match.format
-        @match.format
+      if match && match.format
+        match.format
       else
         @request.format
       end
     end
 
     def recognized?
-      @match != DiviningRod::Mappings.root_definition
+      match != DiviningRod::Mappings.root_definition
     end
 
     def method_missing(meth)
       if meth.to_s.match(/(.+)\?$/)
         tag = $1
-        if @match
-          @match.tags.include?(tag.to_s) ||  @match.tags.include?(tag.to_sym) || @match.tags == tag
+        if match
+          match.tags.include?(tag.to_s) ||  match.tags.include?(tag.to_sym) || match.tags == tag
         else
           false
         end
-      elsif @match.opts.include?(meth.to_sym)
-        @match.opts[meth]
+      elsif match.opts.include?(meth.to_sym)
+        match.opts[meth]
       else
         super
       end

data/lib/divining_rod/rack.rb

@@ -0,0 +1 @@
+require 'divining_rod/rack/divining_rack'

data/lib/divining_rod/rack/divining_rack.rb

@@ -0,0 +1,16 @@
+module DiviningRod
+  class Rack
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = ::Rack::Request.new(env)
+      profile = DiviningRod::Profile.new(request)
+      env['divining_rod.profile'] = profile
+      @app.call(env)
+    end
+
+  end
+end

data/lib/divining_rod/utilities.rb

@@ -0,0 +1,19 @@
+module DiviningRod
+  class Utilities
+    
+    def self.parse_subdomain(request)
+      env = request.env
+      if forwarded = env["HTTP_X_FORWARDED_HOST"]
+        host = forwarded.split(/,\s?/).last
+      else
+        host = env['HTTP_HOST'] || env['SERVER_NAME'] || env['SERVER_ADDR']
+      end
+      if host
+        host.sub(/\:\d+/, '').split('.')
+      else
+        []
+      end
+    end
+    
+  end
+end

data/spec/example_mapping_spec.rb

@@ -1,13 +1,8 @@
 require 'spec/spec_helper'
 require 'example_config'
 
-
-def request_mock(ua, subdomain = [])
-  mock('RailsRequest', :user_agent => ua, :subdomain => subdomain)
-end
-
 def profile_ua(ua)
-  DiviningRod::Profile.new(request_mock(ua))
+  DiviningRod::Profile.new(request_mock(:ua => ua))
 end
   
 

data/spec/mapper_spec.rb

@@ -13,7 +13,7 @@ describe DiviningRod::Mapper do
   end
   
   it "should map a definition" do
-    request = mock("rails_request", :user_agent => 'Apple Mobile Safari', :format => :html)
+    request = request_mock(:ua => 'Apple Mobile Safari', :format => :html)
     result = @root_definition.evaluate(request)
     result.tags.should include(:fuck)
   end

data/spec/mapping_spec.rb

@@ -29,7 +29,7 @@ describe DiviningRod::Mappings do
   end
 
   it "should match a top level user agent" do
-    request = mock("rails_request", :user_agent => 'Apple Mobile Safari', :format => :html)
+    request = request_mock(:ua => 'Apple Mobile Safari', :format => :html)
     result = DiviningRod::Mappings.root_definition.evaluate(request)
     result.should_not be_nil
     result.tags.should include(:apple)
@@ -38,13 +38,13 @@ describe DiviningRod::Mappings do
   end
 
   it "should match a child definition" do
-    ipad_request = mock("rails_request", :user_agent => 'Apple iPad', :format => :html)
+    ipad_request = request_mock(:ua => 'Apple iPad', :format => :html)
     result = DiviningRod::Mappings.evaluate(ipad_request)
     result.tags.should include(:ipad)
   end
 
   it "should match a sub child definition" do
-    ipad_request = mock("rails_request", :user_agent => 'Apple iPad - now powered by Unicorns - OS 3.3', :format => :html)
+    ipad_request = request_mock(:ua => 'Apple iPad - now powered by Unicorns - OS 3.3', :format => :html)
     result = DiviningRod::Mappings.evaluate(ipad_request)
     result.tags.should include(:ipad)
     result.tags.should include(:omg_unicorns)
@@ -52,7 +52,7 @@ describe DiviningRod::Mappings do
   end
 
   it "should match a really really deep child definition" do
-    ipad_request = mock("rails_request", :user_agent => 'Apple iPad - now powered by Unicorns who eat kittens - OS 3.3', :format => :html)
+    ipad_request = request_mock(:ua => 'Apple iPad - now powered by Unicorns who eat kittens - OS 3.3', :format => :html)
     result = DiviningRod::Mappings.evaluate(ipad_request)
     result.tags.should include(:ipad, :youtube)
     result.tags.should include(:omg_unicorns)
@@ -61,7 +61,7 @@ describe DiviningRod::Mappings do
   end
 
   it "should match a in order defined" do
-    ipad_request = mock("rails_request", :user_agent => 'Apple iPad - now powered by Unicorns who eat kittens - OS 2', :format => :html)
+    ipad_request = request_mock(:ua => 'Apple iPad - now powered by Unicorns who eat kittens - OS 2', :format => :html)
     result = DiviningRod::Mappings.evaluate(ipad_request)
     result.tags.should include(:ipad, :youtube)
     result.tags.should_not include(:omg_they_eat_kittens, :omg_unicorns)
@@ -69,7 +69,7 @@ describe DiviningRod::Mappings do
   end
 
   it "should match a in order defined" do
-    ipad_request = mock("rails_request", :user_agent => 'Apple Newton - OS 8', :format => :html)
+    ipad_request = request_mock(:ua => 'Apple Newton - OS 8', :format => :html)
     result = DiviningRod::Mappings.evaluate(ipad_request)
     result.tags.should_not include(:omg_they_eat_kittens, :omg_unicorns)
     result.tags.should include(:os8)

data/spec/profile_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe DiviningRod do
 
   before :each do
-    @request = mock("rails_request", :user_agent => 'My iPhone which is actually an iPad')
+    @request = request_mock(:ua => 'My iPhone which is actually an iPad')
     
     DiviningRod::Mappings.define do |map|
       map.ua /iPhone/, :format => :webkit, :tags => [:iphone, :youtube, :geolocate] do |iphone|
@@ -30,7 +30,7 @@ describe DiviningRod do
   describe "without a default route" do
     
     before :each do
-      @request = mock("rails_request", :user_agent => 'My Foo Fone', :format => :html)
+      @request = request_mock(:ua => 'My Foo Fone', :format => :html)
       
       DiviningRod::Mappings.define do |map|
         map.ua /iPhone/, :format => :webkit, :tags => [:iphone, :youtube, :geolocate]
@@ -49,7 +49,7 @@ describe DiviningRod do
   describe "with a default route" do
     
     before :each do
-      @request = mock("rails_request", :user_agent => 'My Foo Fone')
+      @request = request_mock(:ua => 'My Foo Fone')
       
       DiviningRod::Mappings.define do |map|
         map.ua /iPhone/, :format => :webkit, :tags => [:iphone, :youtube, :geolocate]
@@ -68,7 +68,7 @@ describe DiviningRod do
   describe "without a default definition" do
 
     before :each do
-      @request = mock("rails_request", :user_agent => 'Foo Fone', :format => :html)
+      @request = request_mock(:ua => 'Foo Fone', :format => :html)
       
       DiviningRod::Mappings.define do |map|
         map.ua /iPhone/, :format => :webkit, :tags => [:iphone, :youtube, :geolocate]
@@ -84,7 +84,7 @@ describe DiviningRod do
   describe "matching a subdomain" do
 
     before :each do
-      @request = mock("rails_request", :user_agent => 'Foo Fone', :subdomains => ['wap'])
+      @request = request_mock(:ua => 'Foo Fone', :host => 'wap.example.com')
       
       DiviningRod::Mappings.define do |map|
         map.subdomain /wap/, :format => :wap, :tags => [:shitty]
@@ -102,7 +102,7 @@ describe DiviningRod do
   describe "matching the weird requests(no user_agent passed)" do
 
     before :each do
-      @request = mock("rails_request", :user_agent => nil, :subdomains => [])
+      @request = request_mock(:ua => nil, :subdomains => [])
       
       DiviningRod::Mappings.define do |map|
         map.ua /iPhone/, :format => :wap, :tags => [:shitty]

data/spec/rack_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require "divining_rod/rack"
+require "rack/test"
+
+describe DiviningRod do
+  include Rack::Test::Methods
+
+  def app
+    DiviningRod::Rack.new(app = lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['foo']] })
+  end
+
+  before :each do
+    DiviningRod::Mappings.define do |map|
+      map.ua /iPhone/, :format => :webkit, :tags => [:iphone, :youtube, :geolocate] do |iphone|
+        iphone.ua /iPad/, :tags => [:ipad]
+      end
+    end
+  end
+
+  it "should profile an incoming request" do
+    header 'User-Agent', "iPhone Safari"
+    get "/"
+    last_request.env['divining_rod.profile'].should be_an_instance_of(DiviningRod::Profile)
+    last_request.env['divining_rod.profile'].iphone?.should be_true
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,3 +1,12 @@
 require 'rubygems'
 require 'spec'
-require  File.expand_path('../../lib/divining_rod', __FILE__)
+require 'rack'
+require  File.expand_path('../../lib/divining_rod', __FILE__)
+
+def request_mock(opts)
+  opts = {
+           :host => 'example.com'
+         }.merge(opts)
+  env = {'HTTP_USER_AGENT' => opts[:ua], 'SERVER_NAME' => opts[:host], 'X_WAP_PROFILE' => opts[:wap_profile]}
+  mock('RailsRequest', :env => env, :format => opts[:format])
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: divining_rod
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Mark Percival
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-23 00:00:00 -05:00
+date: 2010-08-30 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 description: A mobile phone web request profiler using definitions that look like rails routes
 email: mark@mpercival.com
 executables: []
@@ -47,11 +54,15 @@ files:
 - lib/divining_rod/matchers.rb
 - lib/divining_rod/murge.rb
 - lib/divining_rod/profile.rb
+- lib/divining_rod/rack.rb
+- lib/divining_rod/rack/divining_rack.rb
+- lib/divining_rod/utilities.rb
 - spec/definition_spec.rb
 - spec/example_mapping_spec.rb
 - spec/mapper_spec.rb
 - spec/mapping_spec.rb
 - spec/profile_spec.rb
+- spec/rack_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/markpercival/divining_rod
@@ -66,18 +77,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A mobile phone web request profiler
@@ -87,4 +100,5 @@ test_files:
 - spec/mapper_spec.rb
 - spec/mapping_spec.rb
 - spec/profile_spec.rb
+- spec/rack_spec.rb
 - spec/spec_helper.rb