rack-geo 0.1.0

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+*.gemspec
+*.log
+*.pid
+*.sqlite3
+*.tmproj
+.DS_Store
+log/*
+pkg/*

data/HISTORY.rdoc

@@ -0,0 +1,3 @@
+=== Version 0.1.0 (git)
+
+Initial release of Rack::Geo middleware.

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright © 2010 Square, Inc.
+
+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.rdoc

@@ -0,0 +1,21 @@
+= Rack::Geo
+
+Rack middleware for parsing and serializing IETF draft {Geo-Position}[http://tools.ietf.org/html/draft-daviel-http-geo-header-05] HTTP headers.
+
+== Prerequisites
+
+* {Rack}[http://rack.rubyforge.org/]
+
+== Testing
+
+Testing requires the RSpec gem:
+
+* {Rspec}[http://rspec.info/]
+
+To test, run:
+  `rake`
+
+== License
+
+Copyright © 2010 Square, Inc.
+See LICENSE.txt in this directory.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+require File.join(File.dirname(__FILE__), 'lib', 'rack', 'geo', 'version')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.version = Rack::Geo::VERSION::STRING
+    gemspec.name = "rack-geo"
+    gemspec.summary = "Rack middleware for Geo-Position HTTP headers"
+    gemspec.description = "Parse and serialize geospatial HTTP headers."
+    gemspec.email = "github@squareup.com"
+    gemspec.homepage = "http://github.com/square/rack-geo"
+    gemspec.authors = [
+      "Randy Reddig",
+      "Cameron Walters",
+      "Paul McKellar",
+    ]
+    gemspec.extra_rdoc_files = [
+      'README.rdoc',
+      'HISTORY.rdoc',
+      'LICENSE.txt',
+    ]
+    gemspec.add_dependency              "rack",         ">=1.0.0"
+    gemspec.add_development_dependency  "rack-test",    ">=0.5.3"
+    gemspec.add_development_dependency  "rspec",        ">=1.3.0"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ["--options", "spec/spec.opts"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+  t.rcov = ENV["RCOV"]
+  t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/}
+  t.verbose = true
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+
+desc "Remove trailing whitespace"
+task :whitespace do
+  sh %{find . -name '*.rb' -exec sed -i '' 's/ *$//g' {} \\;}
+end

data/lib/rack-geo.rb

@@ -0,0 +1 @@
+require 'rack/geo'

data/lib/rack/geo.rb

@@ -0,0 +1,94 @@
+require 'rack/geo/version'
+
+module Rack
+  class Geo
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      position = Position.new(env["HTTP_GEO_POSITION"] || env["HTTP_X_GEO_POSITION"])
+      env["geo.position"] = position if position.valid?
+      @app.call(env)
+    end
+
+    class Position
+      attr_accessor :latitude, :longitude, :altitude, :uncertainty, :heading, :speed
+
+      def initialize(value=nil)
+        parse! value
+      end
+
+      MATCH_LLA = /\A([+-]?[0-9\.]+);([+-]?[0-9\.]+)(?:;([+-]?[0-9\.]+))?/.freeze
+      MATCH_EPU = /\sepu=([0-9\.]+)(?:\s|\z)/i.freeze
+      MATCH_HDN = /\shdn=([0-9\.]+)(?:\s|\z)/i.freeze
+      MATCH_SPD = /\sspd=([0-9\.]+)(?:\s|\z)/i.freeze
+
+      # Parse Geo-Position header:
+      # http://tools.ietf.org/html/draft-daviel-http-geo-header-05
+      def parse!(value)
+        reset!
+        value = value.to_s.strip
+
+        if lla = MATCH_LLA.match(value)
+          @latitude = lla[1].to_f
+          @longitude = lla[2].to_f
+          @altitude = lla[3].to_f if lla[3]
+        end
+
+        if epu = MATCH_EPU.match(value)
+          @uncertainty = epu[1].to_f
+        end
+
+        if hdn = MATCH_HDN.match(value)
+          @heading = hdn[1].to_f
+        end
+
+        if spd = MATCH_SPD.match(value)
+          @speed = spd[1].to_f
+        end
+
+        nil
+      end
+
+      def valid?
+        (!latitude.nil? && latitude.respond_to?(:to_f) && (-90..90).include?(latitude.to_f)) &&
+        (!longitude.nil? && longitude.respond_to?(:to_f) && (-180..180).include?(longitude.to_f)) &&
+        (altitude.nil? || altitude.respond_to?(:to_f)) &&
+        (uncertainty.nil? || uncertainty.respond_to?(:to_f) && uncertainty.to_f >= 0) &&
+        (heading.nil? || heading.respond_to?(:to_f) && (0..360).include?(heading.to_f)) &&
+        (speed.nil? || speed.respond_to?(:to_f) && speed.to_f >= 0)
+      end
+
+      def attributes
+        {
+          :latitude => latitude,
+          :longitude => longitude,
+          :altitude => altitude,
+          :uncertainty => uncertainty,
+          :heading => heading,
+          :speed => speed,
+        }
+      end
+
+      def to_http_header
+        value = "%f;%f" % [latitude.to_f, longitude.to_f]
+        value += ";%f" % altitude.to_f if altitude
+        value += " epu=%f" % uncertainty.to_f if uncertainty
+        value += " hdn=%f" % heading.to_f if heading
+        value += " spd=%f" % speed.to_f if speed
+        value
+      end
+
+      def self.from_http_header(value)
+        self.new(value)
+      end
+
+      private
+
+      def reset!
+        @latitude = @longitude = @altitude = @uncertainty = @heading = @speed = nil
+      end
+    end
+  end
+end

data/lib/rack/geo/version.rb

@@ -0,0 +1,11 @@
+module Rack
+  class Geo
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 1
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/spec/rack/geo_spec.rb

@@ -0,0 +1,258 @@
+require 'spec_helper'
+
+describe Rack::Geo do
+  def setup_request(header_name="HTTP_GEO_POSITION")
+    @request = Rack::MockRequest.env_for("/", header_name => @coords, :lint => true, :fatal => true)
+  end
+
+  before :each do
+    @latitude, @longitude, @uncertainty = 37.0625, -95.677068, 100
+    @coords = "#{@latitude};#{@longitude} epu=#{@uncertainty}"
+    @app = lambda { |env| [200, {"Content-Type" => "text/plain"}, [""]] }
+  end
+
+  ["HTTP_GEO_POSITION", "HTTP_X_GEO_POSITION"].each do |header_name|
+    describe "with invalid geo position header '#{header_name}'" do
+      before :each do
+        setup_request(header_name)
+        Rack::Geo::Position.stub!(:new).and_return(mock(Rack::Geo::Position, :valid? => false))
+        @status, @headers, @response = described_class.new(@app).call(@request)
+      end
+
+      it "does not assign a Rack::Geo::Position instance to env['geo.position']" do
+        @request['geo.position'].should be_nil
+      end
+    end
+
+    describe "with valid geo position header '#{header_name}: #{@coords}'" do
+      before :each do
+        setup_request(header_name)
+        @status, @headers, @response = described_class.new(@app).call(@request)
+      end
+
+      it "assigns a Rack::Geo::Position instance to env['geo.position']" do
+        @request['geo.position'].should be_an_instance_of(Rack::Geo::Position)
+      end
+
+      it "the Rack::Geo::Position instance should reflect the header value" do
+        @request['geo.position'].latitude.should == @latitude
+        @request['geo.position'].longitude.should == @longitude
+        @request['geo.position'].uncertainty.should == @uncertainty
+      end
+    end
+  end
+end
+
+
+describe Rack::Geo::Position do
+
+  ZEROES = %w[0 -0 +0 0.0 -0.0 +0.0]
+  LATITUDES = %w[-90 -45 0 45 +45 90 +90]
+  LONGITUDES = %w[-180 -90 -45 0 45 +45 90 +90 180 +180]
+  ALTITUDES = %w[-85.5 -34 0 15 1337 8848 23300.0 +23300.0]
+  UNCERTAINTIES = %w[0 0.0 0.00 1.25 32.1 455 600.123]
+  HEADINGS = %w[0 0.0 0.00 1.25 32.1 180 359.123 360]
+  SPEEDS = %w[0 0.0 0.00 1.25 32.1 999 9999.99 12345.6456]
+
+  describe "#new" do
+    it "creates an instance of #{described_class}" do
+      instance = described_class.new
+      instance.should be_an_instance_of(described_class)
+    end
+
+    it "calls #parse!" do
+      class GeoPositionParseTest < described_class
+        def parse!(arg)
+          @parsed = arg
+        end
+      end
+
+      instance = GeoPositionParseTest.new "TEST"
+      instance.instance_variable_get(:@parsed).should == "TEST"
+    end
+  end
+
+  describe "#from_http_header" do
+    it "creates an instance of #{described_class}" do
+      instance = described_class.from_http_header nil
+      instance.should be_an_instance_of(described_class)
+    end
+
+    it "calls #new with supplied argument" do
+      described_class.should_receive(:new).with("TEST")
+      described_class.from_http_header "TEST"
+    end
+  end
+
+  describe "instance method" do
+    before :each do
+      @instance = described_class.new
+    end
+
+    describe "#attributes" do
+      it "returns a hash" do
+        @instance.attributes.should be_an_instance_of(Hash)
+      end
+
+      it "returns a hash containing specific keys" do
+        h = @instance.attributes
+        [:latitude, :longitude, :altitude, :uncertainty, :heading, :speed].each do |key|
+          h.should have_key(key)
+        end
+      end
+    end
+
+    describe "#parse!" do
+      it "nil sets all attributes to nil" do
+        @instance.parse! nil
+        @instance.latitude.should == nil
+        @instance.longitude.should == nil
+        @instance.altitude.should == nil
+        @instance.uncertainty.should == nil
+        @instance.heading.should == nil
+        @instance.speed.should == nil
+      end
+
+      it "\"0;0\" parses latitude and longitude" do
+        @instance.parse! "0;0"
+        @instance.latitude.should == 0.0
+        @instance.longitude.should == 0.0
+        @instance.altitude.should == nil
+        @instance.uncertainty.should == nil
+        @instance.heading.should == nil
+        @instance.speed.should == nil
+      end
+
+      it "\"0;0;0\" parses latitude, longitude and altitude" do
+        @instance.parse! "0;0;0"
+        @instance.latitude.should == 0.0
+        @instance.longitude.should == 0.0
+        @instance.altitude.should == 0.0
+        @instance.uncertainty.should == nil
+        @instance.heading.should == nil
+        @instance.speed.should == nil
+      end
+
+      ZEROES.each do |latitude|
+        ZEROES.each do |longitude|
+          value = "#{latitude};#{longitude}"
+          it "\"#{value}\" should return a new instance with latitude == 0 and longitude == 0" do
+            @instance.parse! value
+            @instance.latitude.should == 0.0
+            @instance.longitude.should == 0.0
+          end
+        end
+      end
+
+      LATITUDES.each do |latitude|
+        LONGITUDES.each do |longitude|
+          value = "#{latitude};#{longitude}"
+          latitude_f = latitude.to_f
+          longitude_f = longitude.to_f
+          it "#{value} should return a new instance with latitude == #{latitude_f} and longitude == #{longitude_f}" do
+            @instance.parse! value
+            @instance.latitude.should == latitude_f
+            @instance.longitude.should == longitude_f
+          end
+        end
+      end
+
+      LATITUDES.each do |latitude|
+        LONGITUDES.each do |longitude|
+          ALTITUDES.each do |altitude|
+            value = "#{latitude};#{longitude};#{altitude}"
+            latitude_f = latitude.to_f
+            longitude_f = longitude.to_f
+            altitude_f = altitude.to_f
+            it "#{value} should return a new instance with latitude == #{latitude_f}, longitude == #{longitude_f} and altitude == #{altitude_f}" do
+              @instance.parse! value
+              @instance.latitude.should == latitude_f
+              @instance.longitude.should == longitude_f
+              @instance.altitude.should == altitude_f
+            end
+          end
+        end
+      end
+
+      UNCERTAINTIES.each do |uncertainty|
+        value = "0;0;0 epu=#{uncertainty}"
+        uncertainty_f = uncertainty.to_f
+        it "\"#{value}\" should return a new instance with uncertainty = #{uncertainty_f}" do
+          @instance.parse! value
+          @instance.uncertainty.should == uncertainty_f
+        end
+      end
+
+      HEADINGS.each do |heading|
+        value = "0;0;0 hdn=#{heading}"
+        heading_f = heading.to_f
+        it "\"#{value}\" should return a new instance with heading = #{heading_f}" do
+          @instance.parse! value
+          @instance.heading.should == heading_f
+        end
+      end
+
+      SPEEDS.each do |speed|
+        value = "0;0;0 spd=#{speed}"
+        speed_f = speed.to_f
+        it "\"#{value}\" should return a new instance with speed = #{speed_f}" do
+          @instance.parse! value
+          @instance.speed.should == speed_f
+        end
+      end
+    end
+
+    describe "#valid?" do
+      before :each do
+        @instance = described_class.new "0;0;0 epu=0 hdn=0 spd=0"
+        @instance.should be_valid
+      end
+
+      it "returns false for instances initialized with no arguments" do
+        described_class.new.should_not be_valid
+      end
+
+      [nil, false, [], {}, -91, 90.0001, "-90.0001", "91"].each do |latitude|
+        it "returns false when latitude = #{latitude.inspect}" do
+          @instance.latitude = latitude
+          @instance.should_not be_valid
+        end
+      end
+
+      [nil, false, [], {}, -181, 180.0001, "-180.0001", "181"].each do |longitude|
+        it "returns false when longitude = #{longitude.inspect}" do
+          @instance.longitude = longitude
+          @instance.should_not be_valid
+        end
+      end
+
+      [false, [], {}].each do |altitude|
+        it "returns false when altitude = #{altitude.inspect}" do
+          @instance.altitude = altitude
+          @instance.should_not be_valid
+        end
+      end
+
+      [false, [], {}, -1, -0.0001, "-0.0001"].each do |uncertainty|
+        it "returns false when uncertainty = #{uncertainty.inspect}" do
+          @instance.uncertainty = uncertainty
+          @instance.should_not be_valid
+        end
+      end
+
+      [false, [], {}, -1, -0.0001, 360.01, 361, "-0.0001", "360.01", "361"].each do |heading|
+        it "returns false when heading = #{heading.inspect}" do
+          @instance.heading = heading
+          @instance.should_not be_valid
+        end
+      end
+
+      [false, [], {}, -1, -0.0001, "-0.0001"].each do |speed|
+        it "returns false when speed = #{speed.inspect}" do
+          @instance.speed = speed
+          @instance.should_not be_valid
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'rack-geo'
+require 'spec/expectations'
+require 'rack/test'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: rack-geo
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Randy Reddig
+- Cameron Walters
+- Paul McKellar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: Parse and serialize geospatial HTTP headers.
+email: github@squareup.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- HISTORY.rdoc
+- LICENSE.txt
+- README.rdoc
+files: 
+- .gitignore
+- HISTORY.rdoc
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/rack-geo.rb
+- lib/rack/geo.rb
+- lib/rack/geo/version.rb
+- spec/rack/geo_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/square/rack-geo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rack middleware for Geo-Position HTTP headers
+test_files: 
+- spec/rack/geo_spec.rb
+- spec/spec_helper.rb