is_it_iphone 0.1.0

data/README.txt

@@ -0,0 +1,70 @@
+= is_it_iphone
+* http://rubyforge.org/projects/isitiphone/
+
+== AUTHOR:
+
+Damon Danieli (damondanieli@gmail.com)
+
+== FEATURES/PROBLEMS:
+
+* Fast & Lightweight
+* Simple: I'm not smart enough to make something complex
+
+== DESCRIPTION:
+
+This gem was inspired by the IsItMobile gem done by Dave Myron.  
+
+The code to check for the iPhone user agent is from http://developer.apple.com.  This doesn't have any dependencies.
+
+- in app/controllers/application.rb
+
+    require 'is_it_iphone'
+    class ApplicationController < ActionController::Base
+      include IsItIPhone
+      before_filter :adjust_format_for_iphone # Always show iPhone views
+    end
+
+You will have these functions:
+
+    iphone_user_agent?
+      Returns true if the user agent is an iPhone.
+      (as spec'ed on http://developer.apple.com)
+
+    iphone_request?
+      Returns true if the request came from an iPhone.
+      Override being an iPhone with ?format=xxxx in the URL.
+
+    adjust_format_for_iphone
+      Call when you want to show iPhone views to iPhone users.
+      Note: It is recommended by Apple that you default to showing 
+      your "normal" html page to iPhone users and allow them to 
+      choose if they want an iPhone version.
+
+With Rails 2.0, you can use its multiview capabilities by simply adding this to your app:
+
+- in config/initializers/mime_types.rb
+
+    Mime::Type.register_alias "text/html", :iphone
+
+Then, just create your views using suffices of iphone.erb instead of html.erb:
+
+    index.iphone.erb
+    show.iphone.erb
+    etc.
+
+Note: you will probably want to use a Web library specific for iPhone applications.  FWIW, I use Dashcode (in the iPhone SDK) to write and debug the iPhone application and then integrate it with my Rails project.
+
+== REQUIREMENTS:
+
+None
+
+== INSTALL:
+
+sudo gem install is_it_iphone
+
+== LICENSE:
+
+Copyright (c) 2008
+
+MIT Licence
+

data/lib/is_it_iphone.rb

@@ -0,0 +1,24 @@
+# Module to be included in your ApplicationController class
+# See README.txt for description of how to use this
+module IsItIPhone
+  # Returns true if the request USER AGENT came from an iPhone
+  # (specfications from http://developer.apple.com)
+  def iphone_user_agent?
+    !!(request.env['HTTP_USER_AGENT'] && request.env['HTTP_USER_AGENT'][/(Mobile\/.+Safari)/])
+  end
+
+  # Returns true if the request or format parameter came from an iPhone 
+  def iphone_request?
+    params[:format] ? params[:format] == 'iphone' : iphone_user_agent?
+  end
+
+  # Call this as a before_filter if you always want to display 
+  # the iPhone view (i.e., index.iphone.erb).
+  # Note: According to Apple iPhone Web Developer guidelines, websites
+  # should show the normal page and then give the user the option to see 
+  # it formatted for their iPhone.
+  def adjust_format_for_iphone
+    request.format = :iphone if iphone_request?
+  end
+end
+

data/test/test_is_it_iphone.rb

@@ -0,0 +1,69 @@
+require File.join( File.dirname(__FILE__), '../lib/is_it_iphone.rb' )
+require 'test/unit'
+
+class IPhoneTestController
+  include IsItIPhone
+  class Request
+    attr_reader :env
+    def initialize(user_agent)
+      @env = { 'HTTP_USER_AGENT' => user_agent }
+    end
+  end
+  def test(user_agent, format=nil)
+    # set up mock request object and format params
+    @request = Request.new(user_agent)
+    @params  = { :format => format }
+
+    iphone_request?
+  end
+
+private
+  def request
+    @request
+  end
+  def params
+    @params
+  end
+end
+
+class TestIsItIPhone < Test::Unit::TestCase
+  PC_IE       = "IE 7 Windows Vista: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0)"
+  MAC_FIREFOX = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.1.14) Gecko/20080404 Firefox/2.0.0.14"
+  MAC_SAFARI  = "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_5_2; en-us) AppleWebKit/525.13 (KHTML, like Gecko) Version/3.1 Safari/525.13"
+  IPHONE_1_4  = "Mozilla/5.0 (iPhone; U; CPU like Mac OS X; en) AppleWebKit/420.1 (KHTML, like Gecko) Version/3.0 Mobile/4A102 Safari/419.3"
+  IPHONE_SIM  = "Mozilla/5.0 (iPhone Simulator; U; iPhone OS 2_0 like Mac OS X; en-us) AppleWebKit/525.17 (KHTML, like Gecko) Version/3.1 Mobile/5A240d Safari/5525.7"
+
+
+  def setup
+    @controller = IPhoneTestController.new
+  end
+
+  def test_pc
+    assert !@controller.test(PC_IE)
+  end
+
+  def test_mac_safari
+    assert !@controller.test(MAC_SAFARI)
+  end
+
+  def test_mac_firefox
+    assert !@controller.test(MAC_FIREFOX)
+  end
+
+  def test_iphone_1_4
+    assert @controller.test(IPHONE_1_4)
+  end
+
+  def test_iphone_simulator
+    assert @controller.test(IPHONE_SIM)
+  end
+
+  def test_iphone_override
+    assert !@controller.test(IPHONE_1_4, "json")
+  end
+
+  def test_pc_override
+    assert @controller.test(MAC_FIREFOX, "iphone")
+  end
+end
+

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+name: is_it_iphone
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Damon Danieli
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-21 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: "The code to check for the iPhone user agent is from http://developer.apple.com.  This doesn't have any dependencies.  - in app/controllers/application.rb  require 'is_it_iphone' class ApplicationController < ActionController::Base include IsItIPhone before_filter :adjust_format_for_iphone # Always show iPhone views end  You will have these functions:    iphone_user_agent? Returns true if the user agent is an iPhone. (as spec'ed on http://developer.apple.com)  iphone_request? Returns true if the request came from an iPhone. Override being an iPhone with ?format=xxxx in the URL.  adjust_format_for_iphone Call when you want to show iPhone views to iPhone users. Note: It is recommended by Apple that you default to showing your \"normal\" html page to iPhone users and allow them to choose if they want an iPhone version.  With Rails 2.0, you can use its multiview capabilities by simply adding this to your app:  - in config/initializers/mime_types.rb  Mime::Type.register_alias \"text/html\", :iphone  Then, just create your views using suffices of iphone.erb instead of html.erb:  index.iphone.erb show.iphone.erb etc.  Note: you will probably want to use a Web library specific for iPhone applications.  FWIW, I use Da shcode (in the iPhone SDK) to write and debug the iPhone application and then integrate it with my  Rails project."
+email: damondanieli@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/is_it_iphone.rb
+- README.txt
+has_rdoc: true
+homepage: http://isitiphone.rubyforge.org
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.1
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- none
+rubyforge_project: Is It IPhone
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: This gem checks for the iPhone user agent
+test_files: 
+- test/test_is_it_iphone.rb