divining_rod 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark Percival
+
+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.markdown

@@ -0,0 +1,50 @@
+# 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 %>
+
+## Installation
+
+    gem install divining_rod
+    
+## Usage
+
+    require 'divining_rod'
+
+    DiviningRod::Matchers.define do |map|
+        map.ua /iPhone/, :webkit, :tags => [:iphone, :youtube_capable]
+        map.ua /Android/, :webkit, :tags => [:youtube_capable, :google_gears]
+        map.default :unknown
+    end
+    
+    profile = DiviningRod::Profile(request) #profile and incoming iphone request
+    profile.format #=> :webkit
+    profile.iphone? #=> true
+    
+## 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.
+
+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.
+
+### Copyright
+
+Copyright (c) 2010 Mark Percival. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "divining_rod"
+    gem.summary = %Q{A mobile phone web request profiler}
+    gem.description = %Q{A mobile phone web request profiler using definitions that look like rails routes}
+    gem.email = "mark@mpercival.com"
+    gem.homepage = "http://github.com/markpercival/divining_rod"
+    gem.authors = ["Mark Percival"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "divining_rod #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/divining_rod.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{divining_rod}
+  s.version = "0.1.1"
+
+  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.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 = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "divining_rod.gemspec",
+     "lib/divining_rod.rb",
+     "spec/basic_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.summary = %q{A mobile phone web request profiler}
+  s.test_files = [
+    "spec/basic_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/divining_rod.rb

@@ -0,0 +1,89 @@
+require 'yaml'
+
+module DiviningRod
+  
+  class UndefinedDefault < StandardError
+    
+  end
+  
+  class Profile
+    
+    attr_reader :match
+    
+    def initialize(request)
+      matchers.each do |matcher|
+        @match = matcher if matcher.matches?(request)
+        break if @match
+      end
+      raise UndefinedDefault, "Please define a default group for DiviningRod" unless @match
+    end
+
+    def group
+      @match.group
+    end
+    alias_method :format, :group
+    
+    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
+      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|
+          if pattern.match(request.user_agent)
+            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

data/spec/basic_spec.rb

@@ -0,0 +1,70 @@
+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)
+    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
+  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]
+    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]
+      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

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'spec'
+require  File.expand_path('../../lib/divining_rod', __FILE__)

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: divining_rod
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Mark Percival
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-17 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A mobile phone web request profiler using definitions that look like rails routes
+email: mark@mpercival.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- divining_rod.gemspec
+- lib/divining_rod.rb
+- spec/basic_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/markpercival/divining_rod
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A mobile phone web request profiler
+test_files: 
+- spec/basic_spec.rb
+- spec/spec_helper.rb