neverland 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+script: bundle exec rspec spec
+before_script:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"

data/README.md

@@ -0,0 +1,39 @@
+# Neverland
+
+[![Build Status](https://secure.travis-ci.org/mhoran/neverland.png)](http://travis-ci.org/mhoran/neverland)
+
+Neverland takes the pain out of testing HTML5 geolocation within your Rails
+app.  For more on HTML5 geolocation, check out [the
+spec](http://dev.w3.org/geo/api/spec-source.html).
+
+## Getting Started
+
+To install, add the following to your Gemfile:
+
+```ruby
+gem 'neverland'
+```
+
+In your test environment initializer, add the Neverland middleware:
+
+```ruby
+Dummy::Application.configure do
+  # ...
+
+  config.middleware.use Neverland::Middleware
+end
+```
+
+By default, Neverland will mock the result of
+navigator.geolocation.getCurrentLocation to latitude 42.31283, longitude
+-71.114287.  This can be overridden by sending the parameters
+`neverland[:latitude]` and `neverland[:longitude]`.  Error states can also be
+triggered by setting `neverland[:error_code]`.
+
+## Caveats
+
+* The implementation naievely overrides the browser's geolocation
+  implementation by inserting a JavaScript tag into the response).
+
+* The middleware will treat the response body as HTML.  If you're using XHTML,
+  this could cause issues.

data/lib/neverland.rb

@@ -1,6 +1,8 @@
 require "neverland/version"
 require 'neverland/middleware'
 require 'neverland/engine'
+require 'neverland/parameter_extractor'
+require 'neverland/script_injector'
 
 module Neverland
 end

data/lib/neverland/middleware.rb

@@ -7,34 +7,11 @@ module Neverland
     end
 
     def call(env)
-      cookies = Rack::Request.new(env).cookies
-      latitude = cookies['mock_latitude']
-      longitude = cookies['mock_longitude']
+      params = ParameterExtractor.extract(env)
 
       status, headers, response = @app.call(env)
 
-      case response
-      when ActionDispatch::Response
-        document = Nokogiri::HTML(response.body)
-        head = document.at('head')
-
-        script = Nokogiri::XML::Node.new('script', document)
-        script['type'] = 'text/javascript'
-        script['src'] = '/javascripts/neverland.js'
-        head << script
-
-        if latitude.present? && longitude.present?
-          script = Nokogiri::XML::Node.new('script', document)
-          script['type'] = 'text/javascript'
-          script.inner_html = <<-SCRIPT
-            Neverland.setLatitude(#{latitude})
-            Neverland.setLongitude(#{longitude})
-          SCRIPT
-          head << script
-        end
-
-        response.body = document.to_s
-      end
+      response = ScriptInjector.inject(response, params)
 
       [status, headers, response]
     end

data/lib/neverland/parameter_extractor.rb

@@ -0,0 +1,47 @@
+module Neverland
+  class ParameterExtractor
+    def self.extract(env)
+      new(env).extract
+    end
+
+    def initialize(env)
+      @request = Rack::Request.new(env)
+    end
+
+    def extract
+      Parameters.new(latitude, longitude, error_code)
+    end
+
+    private
+
+    def params
+      @request.params
+    end
+
+    def neverland_params
+      params['neverland'] || {}
+    end
+
+    def latitude
+      neverland_params['latitude']
+    end
+
+    def longitude
+      neverland_params['longitude']
+    end
+
+    def error_code
+      neverland_params['error_code']
+    end
+  end
+
+  class Parameters
+    attr_reader :latitude, :longitude, :error_code
+
+    def initialize(latitude = nil, longitude = nil, error_code = nil)
+      @latitude = latitude
+      @longitude = longitude
+      @error_code = error_code
+    end
+  end
+end

data/lib/neverland/script_injector.rb

@@ -0,0 +1,69 @@
+module Neverland
+  class ScriptInjector
+    def self.inject(response, params)
+      new(response).inject(params)
+    end
+
+    def initialize(response)
+      case response
+      when ActionDispatch::Response
+        @injector = ActionDispatchScriptInjector.new(response)
+      else
+        @injector = NullScriptInjector.new(response)
+      end
+    end
+
+    def inject(params)
+      @injector.inject(params)
+    end
+  end
+
+  class ActionDispatchScriptInjector
+    def initialize(response)
+      @response = response
+      @document = Nokogiri::HTML(@response.body)
+      @head = @document.at('head')
+    end
+
+    def inject(params)
+      if @head
+        inject_script(:src => '/javascripts/neverland.js')
+
+        if params.error_code
+          inject_script(:body => <<SCRIPT)
+Neverland.setError(#{params.error_code})
+SCRIPT
+        elsif params.latitude && params.longitude
+          inject_script(:body => <<SCRIPT)
+Neverland.setLatitude(#{params.latitude})
+Neverland.setLongitude(#{params.longitude})
+SCRIPT
+        end
+
+        @response.body = @document.to_s
+      end
+
+      @response
+    end
+
+    private
+
+    def inject_script(opts = {})
+      script = Nokogiri::XML::Node.new('script', @document)
+      script['type'] = 'text/javascript'
+      script['src'] = opts[:src] if opts[:src]
+      script.inner_html = opts[:body] if opts[:body]
+      @head << script
+    end
+  end
+
+  class NullScriptInjector
+    def initialize(response)
+      @response = response
+    end
+
+    def inject(_)
+      @response
+    end
+  end
+end

data/lib/neverland/version.rb

@@ -1,3 +1,3 @@
 module Neverland
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/public/javascripts/neverland.js

@@ -1,24 +1,50 @@
 // http://dev.w3.org/geo/api/spec-source.html
 
 navigator.geolocation.getCurrentPosition = function(success, error) {
-  success({coords: Neverland.getCoords(), timestamp: Date.now()});
+  Neverland.getCoords(function(position) {
+    success(position)
+  }, function(positionError) {
+    error(positionError)
+  })
 }
 
-var Neverland = new function() {
-  var _latitude = 42.31283;
-  var _longitude = -71.114287;
+var Neverland = (function() {
+  var _latitude = 42.31283,
+      _longitude = -71.114287,
+      _positionError
+
+  var PositionError = function(code) {
+    this.PERMISSION_DENIED = 1
+    this.POSITION_UNAVAILABLE = 2
+    this.TIMEOUT = 3
+    this.code = code
+    this.message = null
+    Object.freeze(this)
+  }
+
+  var Coordinates = function() {
+    this.latitude = _latitude,
+    this.longitude = _longitude,
+    this.altitude = null,
+    this.accuracy = 33,
+    this.altitudeAccuracy = null,
+    this.heading = null,
+    this.speed = null
+    Object.freeze(this)
+  }
+
+  var Position = function() {
+    this.coords = new Coordinates()
+    this.timestamp = Date.now()
+    Object.freeze(this)
+  }
 
   return {
-    getCoords: function () {
-      return {
-        latitude: _latitude,
-        longitude: _longitude,
-        altitude: null,
-        accuracy: 33,
-        altitudeAccuracy: null,
-        heading: null,
-        speed: null
-      };
+    getCoords: function (success, error) {
+      if (_positionError)
+        error(_positionError)
+      else
+        success(new Position())
     },
 
     setLatitude: function(latitude) {
@@ -27,6 +53,10 @@ var Neverland = new function() {
 
     setLongitude: function(longitude) {
       _longitude = longitude;
+    },
+
+    setError: function(code) {
+      _positionError = new PositionError(code);
     }
   }
-}
+})()

data/spec/dummy/app/controllers/decapitated_controller.rb

@@ -0,0 +1,3 @@
+class DecapitatedController < ApplicationController
+  layout 'decapitated'
+end

data/spec/dummy/app/views/decapitated/index.html.erb

@@ -0,0 +1 @@
+

data/spec/dummy/app/views/layouts/decapitated.html.erb

@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/test/index.html.erb

@@ -1,9 +1,19 @@
-<div>Latitude: <span id="latitude"></span></div>
-<div>Longitude: <span id="longitude"><span></div>
+<div id="success">
+  Latitude: <span id="latitude"></span><br>
+  Longitude: <span id="longitude"></span>
+</div>
+
+<div id="error"></div>
 
 <%= javascript_tag do %>
-  navigator.geolocation.getCurrentPosition(function(success) {
-    $('#latitude').text(success.coords.latitude);
-    $('#longitude').text(success.coords.longitude);
+  navigator.geolocation.getCurrentPosition(function(position) {
+    $('#latitude').text(position.coords.latitude)
+    $('#longitude').text(position.coords.longitude)
+  }, function(positionError) {
+    switch(positionError.code) {
+      case positionError.PERMISSION_DENIED:
+        $('#error').text('Permission Denied')
+        $('#success').hide()
+    }
   });
 <% end %>

data/spec/dummy/config/routes.rb

@@ -1,3 +1,4 @@
 Dummy::Application.routes.draw do
   root :to => 'test#index'
+  match '/decapitated' => 'decapitated#index'
 end

data/spec/neverland/parameter_extractor_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+module Neverland
+  describe ParameterExtractor do
+    describe '.extract' do
+      let(:latitude) { '42.31283' }
+      let(:longitude) { '-71.114287' }
+      let(:error_code) { '3' }
+      let(:params) { { :neverland => { :latitude => latitude, :longitude => longitude, :error_code => error_code } } }
+      let(:env) { Rack::MockRequest.env_for('/bananas', :params => params) }
+
+      it 'should return the provided latitude' do
+        ParameterExtractor.extract(env).latitude.should == latitude
+      end
+
+      it 'should return the provided longitude' do
+        ParameterExtractor.extract(env).longitude.should == longitude
+      end
+
+      it 'should return the provided error code' do
+        ParameterExtractor.extract(env).error_code.should == error_code
+      end
+    end
+  end
+end

data/spec/neverland/script_injector_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Neverland
+  describe ScriptInjector do
+    describe '.inject' do
+      context 'with an ActionDispatch::Response' do
+        let(:parameters) { Parameters.new }
+        let(:response) { ActionDispatch::Response.new(200, {}, ['<html><head></head></html>']) }
+
+        it 'should insert the mock JavaScript into the head' do
+          injected_response = ScriptInjector.inject(response, parameters)
+          Nokogiri::HTML(injected_response.body).css('head script[src="/javascripts/neverland.js"]').should_not be_empty
+        end
+      end
+
+      context 'with a Rack::Response' do
+        let(:parameters) { Parameters.new }
+        let(:response) { Rack::Response.new(['<html><head></head></html>'], 200, {}) }
+
+        it 'should not insert the mock JavaScript into the head' do
+          injected_response = ScriptInjector.inject(response, parameters)
+          Nokogiri::HTML(injected_response.body.first).css('head script[src="/javascripts/neverland.js"]').should be_empty
+        end
+      end
+    end
+  end
+end

data/spec/requests/neverland_spec.rb

@@ -1,6 +1,24 @@
 require 'spec_helper'
 
 describe 'neverland' do
+  it "should not insert the mock JavaScript on an unsuccessful response" do
+    lambda { visit '/nonexistent' }.should raise_error(ActionController::RoutingError)
+
+    page.should_not have_selector('head script[src="/javascripts/neverland.js"]')
+  end
+
+  it "should not raise an error if the response has no head" do
+    lambda { visit '/decapitated' }.should_not raise_error
+
+    page.should_not have_selector('head script[src="/javascripts/neverland.js"]')
+  end
+
+  it 'should not insert the mock JavaScript if the response has no head' do
+    visit '/decapitated'
+
+    page.should_not have_selector('head script[src="/javascripts/neverland.js"]')
+  end
+
   it 'should insert the mock JavaScript on a successful response' do
     visit '/'
 
@@ -16,23 +34,17 @@ describe 'neverland' do
   end
 
   it 'should mock the provided coordinates on a successful response', :js => true do
-    visit '/'
-    cookie 'mock_latitude', '37.2630556'
-    cookie 'mock_longitude', '-115.7930198'
-
-    visit '/'
+    latitude = '37.2630556'
+    longitude = '-115.7930198'
+    visit root_path(:neverland => {:latitude => latitude, :longitude => longitude})
 
-    find('#latitude').should have_content('37.2630556')
-    find('#longitude').should have_content('-115.7930198')
+    find('#latitude').should have_content(latitude)
+    find('#longitude').should have_content(longitude)
   end
 
-  it "should not mock on an error response" do
-    lambda { visit '/nonexistent' }.should raise_error(ActionController::RoutingError)
+  it 'should display Permission Denied when the location request is denied', :js => true do
+    visit root_path(:neverland => {:error_code => 1})
 
-    page.should_not have_selector('head script[src="/javascripts/neverland.js"]')
+    find('#error').should have_content('Permission Denied')
   end
 end
-
-def cookie(name, value)
-  Capybara.current_session.driver.browser.manage.add_cookie(:name => name, :value => value)
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neverland
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-24 00:00:00.000000000 Z
+date: 2012-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &16437000 !ruby/object:Gem::Requirement
+  requirement: &9117980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *16437000
+  version_requirements: *9117980
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &16436500 !ruby/object:Gem::Requirement
+  requirement: &9117340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16436500
+  version_requirements: *9117340
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &16435920 !ruby/object:Gem::Requirement
+  requirement: &9116640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16435920
+  version_requirements: *9116640
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &16435360 !ruby/object:Gem::Requirement
+  requirement: &9116000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16435360
+  version_requirements: *9116000
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &16434720 !ruby/object:Gem::Requirement
+  requirement: &9115500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16434720
+  version_requirements: *9115500
 description: Ever need to test geolocation in your Rails app?  This gem makes it easy.
 email:
 - matthew.horan@livestream.com
@@ -75,12 +75,16 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/neverland.rb
 - lib/neverland/engine.rb
 - lib/neverland/middleware.rb
+- lib/neverland/parameter_extractor.rb
+- lib/neverland/script_injector.rb
 - lib/neverland/version.rb
 - neverland.gemspec
 - public/javascripts/neverland.js
@@ -89,9 +93,12 @@ files:
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/decapitated_controller.rb
 - spec/dummy/app/controllers/test_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/views/decapitated/index.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/app/views/layouts/decapitated.html.erb
 - spec/dummy/app/views/test/index.html.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
@@ -106,6 +113,8 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/dummy/script/rails
+- spec/neverland/parameter_extractor_spec.rb
+- spec/neverland/script_injector_spec.rb
 - spec/requests/neverland_spec.rb
 - spec/spec_helper.rb
 homepage: ''