server-side-google-maps 0.0.3 → 0.0.4

data/README.md

@@ -20,12 +20,17 @@ Then, to use within Ruby:
     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.points              # Array 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
 
+    # We can also find elevations along a path
+    path = Path.new([ [ 45.5086700, -73.5536800 ], [ 45.4119000, -75.6984600 ] ]) # a straight line
+    path.elevations(20) # Array of equidistant altitudes, in metres, along the path
+    # Paths may only be up to around 230 points long, to comply with Google's URL length limit.
+
 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.

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

@@ -4,6 +4,7 @@ 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/path'
 require 'server-side-google-maps/route'
 require 'server-side-google-maps/server'
 

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

@@ -0,0 +1,34 @@
+module ServerSideGoogleMaps
+  class Path
+    def self.get_elevations(params)
+      server = Server.new
+      server.get('/maps/api/elevation', {:sensor => false}.merge(params))
+    end
+
+    def initialize(points)
+      raise ArgumentError.new('path must be an Enumerable') unless Enumerable === points
+      raise ArgumentError.new('path must have one or more points') unless points.length > 0
+      i = 0
+      @points = points.collect do |pt|
+        raise ArgumentError.new("path element #{i} must be a [latitude, longitude] Array") unless pt.length == 2
+        pt.dup
+      end
+    end
+
+    # Returns an Array of n equidistant altitudes (in metres) along this path
+    def elevations(n)
+      results = self.class.get_elevations(:path => "enc:#{encoded_path}", :samples => n)
+      results['results'].collect { |r| r['elevation'].to_f }
+    end
+
+    private
+
+    def encoded_path
+      @encoded_path ||= ::GoogleMapsPolyline::Encoder.new(StringIO.new).encode_points(points_1e5).string
+    end
+
+    def points_1e5
+      @points.map { |latitude, longitude| [ (latitude * 1e5).to_i, (longitude * 1e5).to_i ] }
+    end
+  end
+end

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

@@ -1,3 +1,3 @@
 module ServerSideGoogleMaps
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/files/path1-get_elevations-result.txt

@@ -0,0 +1,124 @@
+{
+  "status": "OK",
+  "results": [ {
+    "location": {
+      "lat": 45.5086700,
+      "lng": -73.5536800
+    },
+    "elevation": 15.3455887
+  }, {
+    "location": {
+      "lat": 45.4185028,
+      "lng": -73.8696901
+    },
+    "elevation": 20.8894730
+  }, {
+    "location": {
+      "lat": 45.3274670,
+      "lng": -74.1846876
+    },
+    "elevation": 44.8820000
+  }, {
+    "location": {
+      "lat": 45.2355682,
+      "lng": -74.4986695
+    },
+    "elevation": 59.5912666
+  }, {
+    "location": {
+      "lat": 45.1428119,
+      "lng": -74.8116328
+    },
+    "elevation": 85.9591980
+  }, {
+    "location": {
+      "lat": 45.0492036,
+      "lng": -75.1235748
+    },
+    "elevation": 90.0000000
+  }, {
+    "location": {
+      "lat": 44.9547490,
+      "lng": -75.4344927
+    },
+    "elevation": 75.8659973
+  }, {
+    "location": {
+      "lat": 44.8594535,
+      "lng": -75.7443843
+    },
+    "elevation": 112.5547333
+  }, {
+    "location": {
+      "lat": 44.7633228,
+      "lng": -76.0532474
+    },
+    "elevation": 138.2833099
+  }, {
+    "location": {
+      "lat": 44.6663624,
+      "lng": -76.3610798
+    },
+    "elevation": 128.3775635
+  }, {
+    "location": {
+      "lat": 44.5685778,
+      "lng": -76.6678798
+    },
+    "elevation": 182.8619995
+  }, {
+    "location": {
+      "lat": 44.4699747,
+      "lng": -76.9736456
+    },
+    "elevation": 155.4394684
+  }, {
+    "location": {
+      "lat": 44.3705587,
+      "lng": -77.2783759
+    },
+    "elevation": 158.1198730
+  }, {
+    "location": {
+      "lat": 44.2703352,
+      "lng": -77.5820692
+    },
+    "elevation": 122.1667023
+  }, {
+    "location": {
+      "lat": 44.1693099,
+      "lng": -77.8847244
+    },
+    "elevation": 154.1021423
+  }, {
+    "location": {
+      "lat": 44.0674883,
+      "lng": -78.1863405
+    },
+    "elevation": 284.4921570
+  }, {
+    "location": {
+      "lat": 43.9648759,
+      "lng": -78.4869167
+    },
+    "elevation": 151.9664764
+  }, {
+    "location": {
+      "lat": 43.8614784,
+      "lng": -78.7864523
+    },
+    "elevation": 70.7919540
+  }, {
+    "location": {
+      "lat": 43.7573013,
+      "lng": -79.0849468
+    },
+    "elevation": 38.9590378
+  }, {
+    "location": {
+      "lat": 43.6523500,
+      "lng": -79.3824000
+    },
+    "elevation": 89.6621323
+  } ]
+}

data/spec/path_spec.rb

@@ -0,0 +1,58 @@
+require 'spec'
+
+module ServerSideGoogleMaps
+  describe(Path) do
+    describe('#get_elevations') do
+      it('should use the proper URL') do
+        Server.should_receive(:get).with('/maps/api/elevation/json', :query => { :sensor => false, :path => 'abcd', :samples => 20})
+        Path.get_elevations(:path => 'abcd', :samples => 20)
+      end
+    end
+
+    describe('#initialize') do
+      it('should not allow a 0-point path') do
+        expect { Path.new([]) }.to(raise_exception(ArgumentError))
+      end
+
+      it('should allow a 1-point path') do
+        pt = [ 45.5086700, -73.5536800 ]
+        Path.new([pt])
+      end
+    end
+
+    context('with a mocked #get_elevations') do
+      class Parser < HTTParty::Parser
+        public_class_method(:new)
+      end
+
+      before(:each) do
+        Path.stub(:get_elevations) do |params|
+          basename = 'path1-get_elevations-result.txt'
+          data = File.read("#{File.dirname(__FILE__)}/files/#{basename}")
+          parser = Parser.new(data, :json)
+          parser.parse
+        end
+      end
+
+      describe('#elevations') do
+        it('should pass an encoded :path and :samples to #get_elevations') do
+          Path.should_receive(:get_elevations).with(:path => 'enc:elwtGn}|_M~piJnlqb@', :samples => 20)
+          pt1 = [ 45.50867, -73.55368 ]
+          pt2 = [ 43.65235, -79.38240 ]
+          path = Path.new([pt1, pt2])
+          path.elevations(20)
+        end
+
+        it('should return the proper elevations') do
+          pt1 = [ 45.50867, -73.55368 ]
+          pt2 = [ 43.65235, -79.38240 ]
+          path = Path.new([pt1, pt2])
+          elevations = path.elevations(20)
+          elevations.length.should == 20 # the 20 is from the stub file, not the above argument
+          elevations[0].should == 15.3455887
+          elevations[19].should == 89.6621323
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: server-side-google-maps
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Adam Hooper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-26 00:00:00 -04:00
+date: 2011-05-01 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -76,6 +76,7 @@ files:
 - lib/server-side-google-maps.rb
 - lib/server-side-google-maps/directions.rb
 - lib/server-side-google-maps/geo_math.rb
+- lib/server-side-google-maps/path.rb
 - lib/server-side-google-maps/route.rb
 - lib/server-side-google-maps/server.rb
 - lib/server-side-google-maps/version.rb
@@ -86,6 +87,8 @@ files:
 - spec/files/directions-Montreal,QC-to-Ottawa,ON-without-overview-polyline.txt
 - spec/files/directions-Montreal,QC-to-Ottawa,ON.txt
 - spec/files/directions-Ottawa,ON-to-Toronto,ON.txt
+- spec/files/path1-get_elevations-result.txt
+- spec/path_spec.rb
 - spec/route_spec.rb
 - spec/spec.rb
 has_rdoc: true