divining_rod 0.2.0 → 0.3.0

data/README.markdown

@@ -1,13 +1,6 @@
 # Divining Rod
 
-A tool to help format your sites mobile pages. The goal is to have the ability to do things in your
-views like this
-
-    <%- if request.dv_profile.youtube_capable? %>
-      <%= link_to "YouTube Video", @link.youtube_url %>
-    <%- else %>
-      Sorry, you have a shitty phone.
-    <% end %>
+A tool to help format your sites mobile pages.
 
 ## Installation
 
@@ -15,35 +8,56 @@ views like this
     
 ## Usage
 
-    require 'divining_rod'
+_initializers/divining\_rod.rb_
 
     DiviningRod::Matchers.define do |map|
+        # map.ua /user_agent_regex/, :format, :tags => []
         map.ua /iPhone/, :webkit, :tags => [:iphone, :youtube_capable]
-        map.ua /Android/, :webkit, :tags => [:youtube_capable, :google_gears]
-        map.default :unknown
+        map.ua /Android/, :webkit, :tags => [:android, :youtube_capable, :google_gears]
+        map.subdomain /wap/, :wap, :tags => [:crappy_old_phone]
+        
+        # Enable this to forces a default format if unmatched
+        # otherwise it will return the request.format
+        # map.default :html 
     end
+
+_initializers/mime\_types.rb_
     
-    profile = DiviningRod::Profile(request) #profile and incoming iphone request
-    profile.format #=> :webkit
-    profile.iphone? #=> true
+    Mime::Type.register_alias "text/html", :webkit
+    
+_app/controllers/mobile\_controller.rb_
+
+    class MobileController < ApplicationController
+      before_filter :detect_mobile_type
+
+      ....
+
+      private
+
+      def detect_mobile_type
+        # If the profile isn't matched it defaults to request.format
+        @profile = DiviningRod::Profile.new(request).format
+      end
+
+    end
+    
+_app/views/mobile/show.webkit.html_
+
+    <%- if @profile.iphone? %>
+      <%= link_to "Install our iPhone App in the AppStore", @iPhone_appstore_url %>
+    <%- elsif @profile.android? %>
+      <%= link_to "Direct download", @android_app_url %>
+    <% end %>
+
     
 ## Note on the development
 
-This is still very much in beta, but we are using in extensively in production. We plan
-to keep the API the same.
+This is still very much in beta, but we are using it in production. As such we plan
+to do our best to keep the API the same.
 
 The user agent definitions will be updated here later this week.
 
-
-### Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+## Todo
 
 ### Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/divining_rod.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{divining_rod}
-  s.version = "0.2.0"
+  s.version = "0.3.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-17}
+  s.date = %q{2010-02-18}
   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 = [

data/lib/divining_rod.rb

@@ -1,12 +1,13 @@
 require 'yaml'
 
 module DiviningRod
-  
+
   class Profile
-    
+
     attr_reader :match
-    
+
     def initialize(request)
+      @request = request
       matchers.each do |matcher|
         @match = matcher if matcher.matches?(request)
         break if @match
@@ -15,43 +16,51 @@ module DiviningRod
     end
 
     def group
-      @match.group
+      if @match
+        @match.group
+      else
+        @request.format
+      end
     end
     alias_method :format, :group
-    
+
     def recognized?
       !!@match
     end
-    
+
     def method_missing(meth)
       if meth.to_s.match(/(.+)\?$/)
         tag = $1
-        @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
       else
         super
       end
     end
-    
+
     def matchers
       DiviningRod::Matchers.definitions || []
     end
-    
+
   end
-  
+
   class Matchers
-    
+
     class << self
-      
+
       attr_accessor :definitions
-      
+
       def define
         yield(self)
       end
-      
+
       def clear_definitions
         @definitions = []
       end
-      
+
       def ua(pattern, group, opts={})
         @definitions ||= []
         @definitions << Definition.new(group, opts) { |request|
@@ -61,29 +70,38 @@ module DiviningRod
         }
       end
       
+      def subdomain(pattern, group, opts={})
+        @definitions ||= []
+        @definitions << Definition.new(group, opts) { |request|
+          if pattern.match(request.subdomains[0])
+            true
+          end
+        }
+      end
+
       def default(group, opts = {})
         @definitions ||= []
         @definitions << Definition.new(group, opts) { |request| true }
       end
-      
+
     end
-    
+
   end
-  
+
   class Definition
-    
+
     attr_accessor :prc, :tags, :group
-    
+
     def initialize(group, opts={}, &blk)
       @group = group
       @tags = opts[:tags] || []
       @prc = blk
     end
-    
+
     def matches?(request)
       !!@prc.call(request)
     end
-    
+
   end
-  
-end
+
+end

data/spec/basic_spec.rb

@@ -1,86 +1,151 @@
 require 'spec_helper'
 
 describe DiviningRod do
-  
+
   before :each do
     @request = mock("rails_request", :user_agent => 'My iPhone')
     DiviningRod::Matchers.clear_definitions
     DiviningRod::Matchers.define do |map|
-        map.ua /iPhone/, :webkit, :tags => [:iphone, :youtube, :geolocate]
-        map.default(:unknown)
+      map.ua /iPhone/, :webkit, :tags => [:iphone, :youtube, :geolocate]
     end
   end
-  
+
   it "should recognize an iPhone" do
     profile = DiviningRod::Profile.new(@request)
     profile.format.should eql(:webkit)
   end
-  
+
   it "should know if it belongs to a category tag" do
     profile = DiviningRod::Profile.new(@request)
     profile.geolocate?.should be_true
   end
-  
+
   it "should know if it does not belongs to a category" do
     profile = DiviningRod::Profile.new(@request)
     profile.wap?.should be_false
   end
   
-  it "should use the default group for unknown phones" do
-    @request = mock("rails_request", :user_agent => 'My Foo Phone')
-    profile = DiviningRod::Profile.new(@request)
-    profile.wap?.should be_false
+  describe "without a default route" do
+    
+    before :each do
+      @request = mock("rails_request", :user_agent => 'My Foo Fone', :format => :html)
+      DiviningRod::Matchers.clear_definitions
+      DiviningRod::Matchers.define do |map|
+        map.ua /iPhone/, :webkit, :tags => [:iphone, :youtube, :geolocate]
+      end
+    end
+
+    it "should use the default group for unknown phones" do
+      profile = DiviningRod::Profile.new(@request)
+      profile.wap?.should be_false
+      profile.format.should eql(:html)
+    end
+
   end
   
-  describe "without a default definition" do
+
+  describe "with a default route" do
     
+    before :each do
+      @request = mock("rails_request", :user_agent => 'My Foo Fone')
+      DiviningRod::Matchers.clear_definitions
+      DiviningRod::Matchers.define do |map|
+        map.ua /iPhone/, :webkit, :tags => [:iphone, :youtube, :geolocate]
+        map.default :html
+      end
+    end
+
+    it "should use the default group for unknown phones" do
+      profile = DiviningRod::Profile.new(@request)
+      profile.wap?.should be_false
+      profile.format.should eql(:html)
+    end
+
+  end
+
+  describe "without a default definition" do
+
     before :each do
       @request = mock("rails_request", :user_agent => 'Foo Fone')
       DiviningRod::Matchers.clear_definitions
       DiviningRod::Matchers.define do |map|
-          map.ua /iPhone/, :webkit, :tags => [:iphone, :youtube, :geolocate]
+        map.ua /iPhone/, :webkit, :tags => [:iphone, :youtube, :geolocate]
       end
     end
-    
+
     it "should not find a match" do
       DiviningRod::Profile.new(@request).recognized?.should be_false
     end
-    
+
   end
   
+  describe "matching a subdomain" do
+
+    before :each do
+      @request = mock("rails_request", :user_agent => 'Foo Fone', :subdomains => ['wap'])
+      DiviningRod::Matchers.clear_definitions
+      DiviningRod::Matchers.define do |map|
+        map.subdomain /wap/, :wap, :tags => [:shitty]
+      end
+    end
+
+    it "should not find a match" do
+      DiviningRod::Profile.new(@request).recognized?.should be_true
+      profile = DiviningRod::Profile.new(@request)
+      profile.wap?
+    end
+
+  end
+  
+  describe "matching the weird requests(no user_agent passed)" do
+
+    before :each do
+      @request = mock("rails_request", :user_agent => nil, :subdomains => [])
+      DiviningRod::Matchers.clear_definitions
+      DiviningRod::Matchers.define do |map|
+        map.ua /iPhone/, :wap, :tags => [:shitty]
+      end
+    end
+
+    it "should not find a match" do
+      DiviningRod::Profile.new(@request).recognized?.should be_false
+    end
+
+  end
+
 end
 
 
 describe DiviningRod::Matchers do
-  
+
   before :each do
     @request = mock("rails_request", :user_agent => 'iPhone Foo')
     DiviningRod::Matchers.clear_definitions
     DiviningRod::Matchers.define do |map|
-        map.ua /iPhone/, :iphone, :tags => [:iphone, :youtube]
+      map.ua /iPhone/, :iphone, :tags => [:iphone, :youtube]
     end
   end
-  
+
   it "should recognize an iPhone" do
     DiviningRod::Matchers.definitions.first.matches?(@request).should be_true
     DiviningRod::Matchers.definitions.first.group.should eql(:iphone)
   end
-  
+
   describe "defining a default definition" do
-    
+
     before :each do
       @request = mock("rails_request", :user_agent => 'Foo Fone')
       DiviningRod::Matchers.clear_definitions
       DiviningRod::Matchers.define do |map|
-          map.default :unknown, :tags => [:html]
+        map.default :unknown, :tags => [:html]
       end
     end
-    
+
     it "should use the default route if no other match is found" do
       DiviningRod::Matchers.definitions.first.matches?(@request).should be_true
       DiviningRod::Matchers.definitions.first.group.should eql(:unknown)
     end
-    
+
   end
-  
-end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: divining_rod
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mark Percival
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-17 00:00:00 -05:00
+date: 2010-02-18 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency