server-side-google-maps 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/AUTHORS

@@ -0,0 +1 @@
+Adam Hooper <adam@adamhooper.com>

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'rspec'
+gem 'httparty'
+gem 'nayutaya-googlemaps-polyline', '0.0.1', :require => 'googlemaps_polyline'
+
+# Specify your gem's dependencies in server-side-google-maps.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,3 @@
+All software in this repository is public-domain. It was made so by
+Adam Hooper, <adam@adamhooper.com>. Upon request he can provide it to you
+under any reasonable alternate license: GPL, MPL, MIT, anything.

data/README.md

@@ -0,0 +1,48 @@
+# Server-Side Google Maps: map data from Google, for your server
+
+Make requests for direction from Google's servers, and receive them in a
+Ruby-usable object.
+
+## Installation and usage
+
+To install:
+
+    sudo gem install server-side-google-maps
+
+Then, to use within Ruby:
+
+    directions = Directions.new('Montreal, QC', 'Ottawa, ON', :mode => :driving)
+    # Origin and destination accept [lat,lon] coordinates as well as strings
+    # :mode => :driving is the default. Others are :bicycling and :walking
+
+    directions.status              # 'OK'
+    directions.origin_address      # 'Montreal, QC, Canada'
+    directions.origin_point        # [ 45.5086700, -73.5536800 ]
+    directions.destination_address # 'Ottawa, ON, Canada'
+    directions.destination_point   # [ 45.4119000, -75.6984600 ]
+    directions.points              # List of [lat,lon] coordinates of route
+    directions.distance            # 199901 (metres)
+
+    route = Route.new(['Montreal, QC', 'Ottawa, ON', 'Toronto, ON'], :mode => :bicycling)
+    # All the same methods apply to route as to directions
+
+One final `:mode` is `:direct`, which calculates `points` and estimates
+`distance` without querying Google. To ensure Google isn't queried, input
+the origin and destination as latitude/longitude coordinates.
+
+## Limitations
+
+As per the Google Maps API license agreement, the data returned from the
+Google Maps API must be used only for display on a Google Map.
+
+I'll write that again: Google Maps data is for Google Maps only! You may not
+do any extra calculating and processing, unless the results of those extra
+calculations are displayed on a Google Map.
+
+There are also query limits on each Google API, on the order of a few thousand
+queries each day. Design your software accordingly. (Cache heavily and don't
+query excessively.)
+
+## Development
+
+Each feature and issue must have a spec. Please write specs if you can.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby1.8
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('server-side-google-maps', 'autospec')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby1.8
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('server-side-google-maps', 'htmldiff')

data/bin/httparty

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby1.8
+#
+# This file was generated by Bundler.
+#
+# The application 'httparty' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('server-side-google-maps', 'httparty')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby1.8
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('server-side-google-maps', 'ldiff')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby1.8
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('server-side-google-maps', 'rspec')

data/lib/server-side-google-maps.rb

@@ -0,0 +1,11 @@
+Bundler.setup
+Bundler.require
+
+require 'server-side-google-maps/version'
+require 'server-side-google-maps/directions'
+require 'server-side-google-maps/geo_math'
+require 'server-side-google-maps/route'
+require 'server-side-google-maps/server'
+
+module ServerSideGoogleMaps
+end

data/lib/server-side-google-maps/directions.rb

@@ -0,0 +1,137 @@
+module ServerSideGoogleMaps
+  class Directions
+    LATLNG_STRING_REGEXP = /(-?\d+(\.?\d+)?),(-?\d+(\.?\d+)?)/
+
+    def self.get(params)
+      server = Server.new
+      server.get('/maps/api/directions', {:sensor => false}.merge(params))
+    end
+
+    # Initializes directions
+    #
+    # Parameters:
+    # origin: string or [lat,lng] of the first point
+    # destination: string or [lat,lng] of the last point
+    # params:
+    #   :mode: :driving, :bicycling and :walking will be passed to Google Maps.
+    #          Another option, :direct, will avoid in-between points and calculate
+    #          the distance using the Haversine formula. Defaults to :driving.
+    #   :find_shortcuts: [ {:factor => Float, :mode => :a_mode}, ... ]
+    #                    For each list item (in the order given), determines if
+    #                    using given :mode will cut the distance to less than
+    #                    :factor and if so, chooses it. For example, if :mode is
+    #                    :bicycling and there's a huge detour because of a missing
+    #                    bike lane, pass { :factor => 0.5, :mode => :driving }
+    #                    and if a shortcut cuts the distance in half that route
+    #                    will be chosen instead.
+    def initialize(origin, destination, params = {})
+      @origin = origin
+      @destination = destination
+      params = params.dup
+      find_shortcuts = params.delete(:find_shortcuts) || []
+      raise ArgumentError.new(':find_shortcuts must be an Array') unless Array === find_shortcuts
+      @direct = params[:mode] == :direct
+      params[:mode] = :driving if params[:mode] == :direct || params[:mode].nil?
+
+      origin = origin.join(',') if Array === origin
+      destination = destination.join(',') if Array === destination
+
+      unless @direct && origin_point_without_server && destination_point_without_server
+        @data = self.class.get(params.merge(:origin => origin, :destination => destination))
+      end
+
+      if !@direct
+        find_shortcuts.each do |try_shortcut|
+          factor = try_shortcut[:factor]
+          mode = try_shortcut[:mode]
+
+          other = Directions.new(origin, destination, params.merge(:mode => mode))
+          if other.distance.to_f / distance < factor
+            @points = other.points
+            @distance = other.distance
+          end
+        end
+      end
+    end
+
+    def origin_input
+      @origin
+    end
+
+    def destination_input
+      @destination
+    end
+
+    def origin_address
+      leg['start_address']
+    end
+
+    def destination_address
+      leg['end_address']
+    end
+
+    def origin_point
+      @origin_point ||= origin_point_without_server || [ leg['start_location']['lat'], leg['start_location']['lng'] ]
+    end
+
+    def destination_point
+      @destination_point ||= destination_point_without_server || [ leg['end_location']['lat'], leg['end_location']['lng'] ]
+    end
+
+    def status
+      @data['status']
+    end
+
+    def points
+      @points ||= calculate_points
+    end
+
+    def distance
+      @distance ||= calculate_distance
+    end
+
+    private
+
+    def origin_point_without_server
+      calculate_point_without_server_or_nil(origin_input)
+    end
+
+    def destination_point_without_server
+      calculate_point_without_server_or_nil(destination_input)
+    end
+
+    def calculate_point_without_server_or_nil(input)
+      return input if Array === input
+      m = LATLNG_STRING_REGEXP.match(input)
+      return [ m[1].to_f, m[3].to_f ] if m
+    end
+
+    def route
+      @data['routes'].first
+    end
+
+    def leg
+      route['legs'].first
+    end
+
+    def points_and_levels
+      @points_and_levels ||= calculate_points_and_levels
+    end
+
+    def calculate_points_and_levels
+      polyline = route['overview_polyline']
+      ::GoogleMapsPolyline.decode_polyline(polyline['points'], polyline['levels'])
+    end
+
+    def calculate_points
+      return [ origin_point, destination_point ] if @direct
+      points = points_and_levels.map { |lat,lng,level| [lat,lng] }
+      points
+    end
+
+    def calculate_distance
+      return GeoMath.latlng_distance(*points) if @direct
+      leg['distance']['value']
+    end
+  end
+end

data/lib/server-side-google-maps/geo_math.rb

@@ -0,0 +1,24 @@
+module ServerSideGoogleMaps
+  module GeoMath
+    RADIUS_OF_EARTH = 6367000 # metres
+
+    # Returns the distance (in m) between two [lat,lng] points with the Haversine formula
+    def self.latlng_distance(pt1, pt2)
+      lat1 = pt1[0] * Math::PI / 180
+      lon1 = pt1[1] * Math::PI / 180
+      lat2 = pt2[0] * Math::PI / 180
+      lon2 = pt2[1] * Math::PI / 180
+      dlon = lon2 - lon1
+      dlat = lat2 - lat1
+      a = Math.sin(dlat/2)**2 + Math.cos(lat1) * Math.cos(lat2) * Math.sin(dlon/2)**2
+      c = 2 * Math.asin(min(1.0, Math.sqrt(a)))
+      (RADIUS_OF_EARTH * c).to_i
+    end
+
+    private
+
+    def self.min(f1, f2)
+      f1 < f2 ? f1 : f2
+    end
+  end
+end

data/lib/server-side-google-maps/route.rb

@@ -0,0 +1,53 @@
+module ServerSideGoogleMaps
+  class Route
+    def initialize(points, params = {})
+      raise ArgumentError if points.length < 2
+
+      @directionses = points[0..-2].zip(points[1..-1]).map do |origin, destination|
+        Directions.new(origin, destination, params)
+      end
+    end
+
+    def origin_input
+      @directionses.first.origin_input
+    end
+
+    def destination_input
+      @directionses.last.destination_input
+    end
+
+    def origin_address
+      @directionses.first.origin_address
+    end
+
+    def destination_address
+      @directionses.last.destination_address
+    end
+
+    def origin_point
+      @directionses.first.origin_point
+    end
+
+    def destination_point
+      @directionses.last.destination_point
+    end
+
+    def points
+      @points ||= calculate_points
+    end
+
+    def distance
+      @distance ||= @directionses.map{|d| d.distance}.inject(:+)
+    end
+
+    private
+
+    def calculate_points
+      pointses = @directionses.map { |d| d.points }
+
+      first = pointses.shift
+
+      first + pointses.map{ |p| p[1..-1] }.flatten(1)
+    end
+  end
+end

data/lib/server-side-google-maps/server.rb

@@ -0,0 +1,13 @@
+require 'httparty'
+
+module ServerSideGoogleMaps
+  class Server
+    include HTTParty
+    base_uri('http://maps.googleapis.com')
+
+    def get(path, params)
+      options = { :query => params }
+      self.class.get("#{path}/json", options)
+    end
+  end
+end

data/lib/server-side-google-maps/version.rb

@@ -0,0 +1,3 @@
+module ServerSideGoogleMaps
+  VERSION = "0.0.1"
+end

data/server-side-google-maps.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "server-side-google-maps/version"
+
+Gem::Specification.new do |s|
+  s.name        = "server-side-google-maps"
+  s.version     = ServerSideGoogleMaps::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Adam Hooper"]
+  s.email       = ["adam@adamhooper.com"]
+  s.homepage    = "http://github.com/adamh/server-side-google-maps"
+  s.summary     = %q{Performs calculations with Google Maps}
+  s.description = %q{Servers can use Google Maps, too. This library helps fetch and parse data through the Google Maps v3 API. Stick to the terms of usage, though, and don't use the data Google gives you on anything other than a Google map.}
+
+  s.add_dependency('httparty')
+  s.add_dependency('nayutaya-googlemaps-polyline', '0.0.1')
+
+  s.rubyforge_project = "server-side-google-maps"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end