mobvious 0.1.1 → 0.1.2

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Jiri Stransky
+
+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,142 @@
+# Mobvious
+
+Mobvious detects whether your app / website is being accessed by a phone, or by a tablet,
+or by a personal computer.
+
+## Key Features
+
+* **It's easy to get running.** Just a Rack middleware with almost no config. (See
+  section Get Started below.)
+
+* **It supports multiple strategies for detection.** If you don't like the default ones,
+  you can easily write your own. (See section Detection Strategies below.)
+
+* **Works with Rails, Sinatra, or whatever.** Does not depend on any application
+  framework, uses just Rack.
+
+* **[Documentation](http://rdoc.info/github/jistr/mobvious/frames).**
+  
+
+## Get Started
+
+1.  **Include Mobvious in your Gemfile**: `gem 'mobvious'`
+
+2.  **Tell your app to use Mobvious::Manager as Rack middleware.**  
+    If you use Rails, simply add `config.middleware.use Mobvious::Manager` into your
+    `config/application.rb` file.
+
+3.  **Tell Mobvious which strategies it should use.**  
+    A good place to put this code for Rails is an initializer – create a file
+    `config/initializers/mobvious.rb` and put this in:
+
+        Mobvious.configure do
+          strategies = [ Mobvious::Strategies::MobileESP.new ]
+        end
+
+4.  **Done! From now on, device type is detected for each request.**  
+    The information is
+    in a Rack environment variable `env['mobvious.device_type']`, this variable will
+    have a value of `:desktop` or `:mobile` depending on the device type that issued
+    the request. In Rails, you can access it via `request.env['mobvious.device_type']`.
+
+*This is just a very basic way of setting up Mobvious. If you want to detect
+tablets separately, or let the user manually switch between interface versions of your
+app, or do some funnier stuff, see sections Detection Process and Detection Strategies.*
+
+## Detection Process
+
+Mobvious uses an array of strategies to detect the device type.
+Strategies are evaluated in order of appearance in the array. Each strategy may or
+may not be successful in determining the device type. The result of the first successful
+strategy is used. If no strategy is successful, the implicit device type is used
+(defaults to `:desktop`, but this is configurable via `default_device_type` attribute
+in the `configure` block).
+
+
+## Detection Strategies
+
+### MobileESP (User-Agent sniffing)
+
+`Mobvious::Strategies::MobileESP`
+
+Selects the device type using information present in the User-Agent HTTP header.
+
+Constructor takes a detection procedure.
+Detection procedure decides what device type it should return based on the
+information it can dig out of MobileESPConverted::UserAgentInfo instance.
+
+There are two predefined detection procedures (and you can write your own):
+
+*   `DEVICE_TYPES_MOBILE_DESKTOP` (this is the default)
+    distinguishes between `:mobile` and `:desktop`. Tablets
+    are reported as `:desktop`, because their screens are usually large enough to handle
+    web interfaces meant for desktops.
+
+*   `DEVICE_TYPES_MOBILE_TABLET_DESKTOP` distinguishes between `:mobile`, `:tablet`
+    and `:desktop`.
+
+### URL (URL pattern matching)
+
+`Mobvious::Strategies::URL`
+
+Selects the device type by matching a pattern against the request's URL (whole URL,
+including protocol information).
+
+Constructor takes a hash of rules in format `/regular_expression/ => :device_type`.
+
+There is one predefined rule set:
+
+*   `MOBILE_PATH_RULES` detects all URLs that begin with m. (e.g. `http://m.foo.com/`)
+    as `:mobile`. Doesn't make assumption about other URLs (the detection process
+    continues to the next strategy in order).
+
+### Cookie (remembering user's manual choice)
+
+`Mobvious::Strategies::Cookie`
+
+This strategy is useful when user should be able to make a manual switch between
+interface versions and you want all the interface versions running on the exact same URL.
+
+Call this anywhere in your app:
+
+        Mobvious.strategy('Cookie').set_device_type(response, :desktop)
+        
+… and Mobvious will report `:desktop` from now on for this particular user, regardless
+of what is his/her real device type. (Response parameter is your Rack::Response instance.
+In Rails it is accessible simply by writing `response`, as shown in the code example above.)
+Make sure to put the Cookie strategy high enough in your strategies array
+(the first entry?) so it does not get overriden by some other strategy.
+
+Constructor takes array of allowed device types ("whitelist") that your
+application supports. This is a countermeasure to users tampering with cookies. When
+the device type read from cookie is not whitelisted, the strategy passes the detection
+process to other strategies.
+
+### Writing Your Own Strategy
+
+It's super-easy. A valid Mobvious strategy is any object that responds to this method:
+
+        def get_device_type(request)
+          # some code here
+        end
+
+The request parameter is an object of type Rack::Request. The method must return either:
+
+*   **a symbol** denoting the device type detected (strategy was successful), or
+*   **nil** denoting that strategy was unsuccessful and detection process should continue
+    with other strategies (or return the implicit device type).
+
+
+Optionally, you can also implement this method:
+
+        def response_callback(request, response)
+          # some code here
+        end
+
+It gets called after a response is returned from the application and you can tweak the
+response here if you want. The parameters are instances of Rack::Request
+and Rack::Response, respectively. The method is not expected to return anything special.
+
+---
+
+***Everyone goes with the defaults anyway*** ![cereal guy](https://github.com/engina/9gagtension/raw/master/rages/cereal-guy.jpg)

data/lib/mobvious.rb

@@ -40,4 +40,11 @@ module Mobvious
       matching_strategies
     end
   end
+
+
+  module Strategies
+    autoload :Cookie,    'mobvious/strategies/cookie'
+    autoload :MobileESP, 'mobvious/strategies/mobileesp'
+    autoload :URL,       'mobvious/strategies/url'
+  end
 end

data/lib/mobvious/strategies/mobileesp.rb

@@ -4,7 +4,7 @@ module Mobvious
   module Strategies
     # Mobvious device detection strategy that uses user-agent sniffing provided by
     # the MobileESP library.
-    class Mobileesp
+    class MobileESP
       # Detection procedure that classifies mobile phones as `:mobile` and anything
       # else as `:desktop`.
       DEVICE_TYPES_MOBILE_DESKTOP = lambda {|mobileesp|
@@ -23,7 +23,7 @@ module Mobvious
       # Creates a new instance of MobileESP strategy.
       #
       # @param detection_procedure
-      #   A lambda function that gets one parameter (`MobileESP::UserAgentInfo` instance)
+      #   A lambda function that gets one parameter (`MobileESPConverted::UserAgentInfo` instance)
       #   and returns device type symbol or nil.
       def initialize(detection_procedure = DEVICE_TYPES_MOBILE_DESKTOP)
         @detection_procedure = detection_procedure

data/lib/mobvious/strategies/url.rb

@@ -11,7 +11,7 @@ module Mobvious
       #   A hash containing regular expressions mapped to symbols. The regular expression
       #   is evaluated against the whole URL of the request (including `http://`). If matching,
       #   the corresponding symbol is returned as the device type.
-      def initialize(rules = MOBILE_PATH_RULE)
+      def initialize(rules = MOBILE_PATH_RULES)
         @rules = rules
       end
 

data/lib/mobvious/version.rb

@@ -1,3 +1,3 @@
 module Mobvious
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/mobvious/mobvious_spec.rb

@@ -8,7 +8,7 @@ describe Mobvious do
       require 'mobvious/strategies/mobileesp'
       @cookie = Mobvious::Strategies::Cookie.new [:mobile, :desktop]
       @cookie2 = Mobvious::Strategies::Cookie.new [:mobile, :desktop]
-      @mobileesp = Mobvious::Strategies::Mobileesp.new
+      @mobileesp = Mobvious::Strategies::MobileESP.new
       Mobvious.config.strategies = [
         @cookie,
         @cookie2,
@@ -23,7 +23,7 @@ describe Mobvious do
     end
 
     it "gets the right strategy by class name" do
-      Mobvious.strategy('Mobileesp').must_equal @mobileesp
+      Mobvious.strategy('MobileESP').must_equal @mobileesp
     end
 
     it "gets an array of strategies if there is more with the same name" do

data/spec/mobvious/strategies/cookie_spec.rb

@@ -1,5 +1,4 @@
 require_relative '../../spec_helper'
-require 'mobvious/strategies/cookie'
 
 module Mobvious::Strategies
 class CookieSpec < MiniTest::Spec

data/spec/mobvious/strategies/mobileesp_spec.rb

@@ -1,12 +1,11 @@
 require_relative '../../spec_helper'
-require 'mobvious/strategies/mobileesp'
 
 module Mobvious::Strategies
-  class MobileespSpec < MiniTest::Spec
-  describe Mobileesp do
+  class MobileESPSpec < MiniTest::Spec
+  describe MobileESP do
     describe "using mobile_desktop strategy" do
       before do
-        @strategy = Mobvious::Strategies::Mobileesp.new
+        @strategy = Mobvious::Strategies::MobileESP.new
         @request = mock 'request'
         @env = mock 'env'
 
@@ -32,8 +31,8 @@ module Mobvious::Strategies
 
     describe "using mobile_tablet_desktop strategy" do
       before do
-        @strategy = Mobvious::Strategies::Mobileesp.new(
-          Mobvious::Strategies::Mobileesp::DEVICE_TYPES_MOBILE_TABLET_DESKTOP)
+        @strategy = Mobvious::Strategies::MobileESP.new(
+          Mobvious::Strategies::MobileESP::DEVICE_TYPES_MOBILE_TABLET_DESKTOP)
         @request = mock 'request'
         @env = mock 'env'
 

data/spec/mobvious/strategies/url_spec.rb

@@ -1,5 +1,4 @@
 require_relative '../../spec_helper'
-require 'mobvious/strategies/url'
 
 module Mobvious::Strategies
 class URLSpec < MiniTest::Spec
@@ -14,7 +13,7 @@ class URLSpec < MiniTest::Spec
         'PATH_INFO' => '/some_path'
       })
       @request = Rack::Request.new(@env)
-      @strategy = URL.new(URL::MOBILE_PATH_RULES)
+      @strategy = URL.new
     end
 
     it "returns the right device type when matching rule found" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobvious
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &13559960 !ruby/object:Gem::Requirement
+  requirement: &16340920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *13559960
+  version_requirements: *16340920
 - !ruby/object:Gem::Dependency
   name: mobileesp_converted
-  requirement: &13559160 !ruby/object:Gem::Requirement
+  requirement: &16340180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *13559160
+  version_requirements: *16340180
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &13558600 !ruby/object:Gem::Requirement
+  requirement: &16339620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13558600
+  version_requirements: *16339620
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &13557860 !ruby/object:Gem::Requirement
+  requirement: &16338520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13557860
+  version_requirements: *16338520
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &13556780 !ruby/object:Gem::Requirement
+  requirement: &16337520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13556780
+  version_requirements: *16337520
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &13555880 !ruby/object:Gem::Requirement
+  requirement: &16336960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13555880
+  version_requirements: *16336960
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &13555380 !ruby/object:Gem::Requirement
+  requirement: &16336240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13555380
+  version_requirements: *16336240
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &13554440 !ruby/object:Gem::Requirement
+  requirement: &16335020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13554440
+  version_requirements: *16335020
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &13642280 !ruby/object:Gem::Requirement
+  requirement: &16423360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13642280
+  version_requirements: *16423360
 - !ruby/object:Gem::Dependency
   name: libnotify
-  requirement: &13641840 !ruby/object:Gem::Requirement
+  requirement: &16422940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13641840
+  version_requirements: *16422940
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &13641400 !ruby/object:Gem::Requirement
+  requirement: &16422460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13641400
+  version_requirements: *16422460
 description: Rack middleware for choosing a version of an interface to render for
   given request
 email:
@@ -144,6 +144,8 @@ files:
 - .yardopts
 - Gemfile
 - Guardfile
+- LICENSE
+- README.md
 - Rakefile
 - lib/mobvious.rb
 - lib/mobvious/config.rb
@@ -173,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2708548775781943004
+      hash: -1726316769951614505
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -182,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2708548775781943004
+      hash: -1726316769951614505
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11