google_map_directions 0.0.2 → 1.0.0

data/README.md

@@ -1,6 +1,7 @@
-# GoogleMapDirections
+# Google Map Directions
 
-TODO: Write a gem description
+A wrapper gem for the google directions API.
+https://developers.google.com/maps/documentation/directions/
 
 ## Installation
 
@@ -18,8 +19,63 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Currently, this gem only pulls a single route from the google directions api. The ability to search through multiple routes will be added at a later date.
 
+Setup:
+```Ruby
+  directions = GoogleMapDirections::Directions.new('Soda Hall Berkeley CA', 'Foothill Berkeley CA')
+```
+You can check the status code to see if the request to the API was sucessful.
+```Ruby
+  directions.status
+```
+If you want to parse the data yourself, you can grab the ruby representation of the JSON object
+```Ruby
+  directions.json
+```
+There is a lot of basic information you can just get from the Directions object
+```Ruby
+  directions.distance_as_string
+  directions.distance_in_meters
+
+  directions.destination_coordinates
+  directions.origin_coordinates   
+
+  #The two coordinates methods return hashes that contain the latitude and longitude
+  directions.destination_coordinates["lat"]
+  directions.destination_coordinates["lng"]  
+
+
+  directions.origin_address
+  directions.destination_address
+  directions.duration_as_string
+  directions.duration_in_seconds
+```
+The steps of the route can be pulled from the step method
+```Ruby
+  directions.path_length
+  #Returns the number of steps in the routes
+  step1 = directions.step(0)
+  #Returns the first step of the path  
+  
+  step1.distance_as_string
+  step1.distance_in_meters
+  step1.duration_as_string
+  step1.duration_in_seconds
+
+
+  step1.end_location
+  step1.start_location
+
+  #The two coordinates methods return hashes that contain the latitude and longitude
+  step1.end_location["lat"]
+  step1.end_location["lng"]  
+
+  step1.number
+  step1.HTML_instructions
+```
+
+Let me know of any bugs/additional features wanted.
 ## Contributing
 
 1. Fork it

data/lib/google_map_directions/{path.rb → step.rb}

@@ -1,5 +1,5 @@
 module GoogleMapDirections
-  class Path
+  class Step
     attr_reader :distance, :duration, :end_location, :start_location, :number, :HTML_instructions
 
     def initialize(distance, duration, end_location, start_location, number, html_instructions)
@@ -10,5 +10,19 @@ module GoogleMapDirections
       @number = number
       @HTML_instructions = html_instructions
     end
+
+    def distance_as_string
+      return @distance["text"]
+    end
+    def distance_in_meters
+      return @distance["value"]
+    end
+    def duration_as_string
+      return @duration["text"]
+    end
+    def duration_in_seconds
+      return @duration["value"]
+    end
   end
+
 end

data/lib/google_map_directions/version.rb

@@ -1,3 +1,3 @@
 module GoogleMapDirections
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/lib/google_map_directions.rb

@@ -1,24 +1,26 @@
 require "google_map_directions/version"
-require "google_map_directions/path"
+require "google_map_directions/step"
 require "open-uri"
 require "json"
 
 module GoogleMapDirections
   class Directions
-
-    attr_accessor :origin, :destination, :sensor
-    attr_reader :json
+    attr_accessor :origin, :destination, :sensor, :json, :paths
     @@base_google_url = 'http://maps.googleapis.com/maps/api/directions/json?'
 
-    def initialize(origin, destination, sensor = false)      
-      @origin = origin.gsub(/\s/,'+')
-      @destination = destination.gsub(/\s/,'+')
-      @sensor = sensor.to_s
-      url = "#{@@base_google_url}&origin=#{@origin}&destination=#{@destination}&sensor=#{@sensor}"
+    def initialize(origin, destination, sensor=false)      
+      @origin = origin
+      @destination = destination
+      @sensor = sensor
+      url = "#{@@base_google_url}&origin=#{@origin.gsub(/\s/,'+')}&destination=#{@destination.gsub(/\s/,'+')}&sensor=#{@sensor.to_s}"
       @json = JSON.parse(open(url).read)
-      @legs = (status_check ? @json["routes"][0]["legs"][0] : nil)
-      @paths = nil
-      set_up_paths
+      if status_check
+        @legs = @json["routes"][0]["legs"][0]
+        set_up_paths
+      else
+        @legs = nil
+        @path = nil
+      end
     end
 
     def status
@@ -26,55 +28,58 @@ module GoogleMapDirections
     end 
 
     def distance_as_string
-      if status_check then return @legs["distance"]["text"] else return nil end
+      return @legs["distance"]["text"] unless !status_check
     end
 
     def distance_in_meters
-      if status_check then return @legs["distance"]["value"] else return nil end
+      return @legs["distance"]["value"] unless !status_check
     end
 
     def destination_coordinates
-      if status_check then return @legs['end_location'] else return nil end
+      return @legs['end_location'] unless !status_check
     end
 
     def origin_address
-      if status_check then return @legs['start_address'] else return nil end
+      return @legs['start_address'] unless !status_check
     end
 
     def destination_address
-      if status_check then return @legs['end_address'] else return nil end
+      return @legs['end_address'] unless !status_check
     end
 
     def origin_coordinates
-      if status_check then return @legs['start_location'] else return nil end
+      return @legs['start_location'] unless !status_check
     end
 
 
     def duration_as_string
-      if status_check then return @legs['duration']['text'] else return nil end    
+      return @legs['duration']['text'] unless !status_check    
+    end
+
+    def duration_in_seconds
+      return @legs['duration']["value"] unless !status_check   
     end
 
-    def duration_in_minutes
-      if status_check then return @legs['duration']["value"] else return nil end   
+    def path_length
+      return @path.length unless !status_check
     end
 
+    def step(number)
+      return @path[number] unless !status_check
+    end
+
+
     private
     def status_check
-      if status != 'OK'
-        return false
-      else
-        return true
-      end
+      status == 'OK'
     end
 
     def set_up_paths
-      if status_check
-        @path = Array.new(@legs["steps"].length)
-        count = 0
-        @legs["steps"].each do |segment|
-          @path[count] = GoogleMapDirections::Path.new(segment["distance"], segment["duration"], segment["end_location"], segment["start_location"], count, segment["html_instructions"])
-          count = count + 1
-        end
+      @path = Array.new(@legs["steps"].length)
+      count = 0
+      @legs["steps"].each do |segment|
+        @path[count] = GoogleMapDirections::Step.new(segment["distance"], segment["duration"], segment["end_location"], segment["start_location"], count, segment["html_instructions"])
+        count = count + 1
       end
     end
   end

data/spec/direction_spec.rb

@@ -13,6 +13,10 @@ describe GoogleMapDirections do
     it 'should have success code of OK' do
       @test.status.should == 'OK'
     end
+    it 'should return a json object representing the reply from the api' do
+      @test.json.should_not == nil
+    end
+
   end
 
   describe "possible bad statuses" do
@@ -62,7 +66,7 @@ describe GoogleMapDirections do
       @happy_path.duration_as_string.should == "55 mins"
     end
     it 'should correctly give the duration of the trip in minutes' do 
-      @happy_path.duration_in_minutes.should == 3322
+      @happy_path.duration_in_seconds.should == 3322
     end
     it 'should correctly give distances as a string for a bad reply' do
       @sad_path.distance_as_string.should == nil
@@ -87,11 +91,7 @@ describe GoogleMapDirections do
       @sad_path.duration_as_string.should == nil
     end
     it 'should correctly give the duration of the trip in minutes for a bad reply' do 
-      @sad_path.duration_in_minutes.should == nil
-    end
+      @sad_path.duration_in_seconds.should == nil
+    end    
   end
-
-
-
-
 end

data/spec/step_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+describe GoogleMapDirections do
+  describe "directions object should have a series of paths" do
+    before(:all) do
+      @test = GoogleMapDirections::Directions.new('Soda Hall Berkeley CA', 'Foothill Berkeley CA')
+    end
+
+    it "should have a certain number of steps in the route" do
+      @test.path_length.should == 4
+    end
+
+    it "should be able to return a step of a route" do
+      @test.step(0).class.should == GoogleMapDirections::Step
+    end
+  end
+
+  describe "path object should have information about the route" do
+    before(:all) do
+      @test = GoogleMapDirections::Directions.new('Soda Hall Berkeley CA', 'Foothill Berkeley CA').step(0)
+    end
+
+    it "should give the distance of the step as a string" do
+      @test.distance_as_string.should == "167 ft"
+    end
+
+    it "should give the duration of the step in seconds" do
+      @test.duration_in_seconds.should == 5
+    end
+    it "should give the distance of the step as a value" do
+      @test.distance_as_string.should == "167 ft"
+    end
+
+    it "should give the duration of the step as a vlue" do
+      @test.distance_in_meters.should == 51
+    end
+
+    it "should give the end_location of the step" do
+      @test.end_location.should == {"lat"=>37.87533519999999, "lng"=>-122.2583139}
+    end
+
+    it "should give the start_location of the step" do
+      @test.start_location.should == {"lat"=>37.8757857, "lng"=>-122.2584081}
+    end
+
+    it "should give the number of the step" do
+      @test.number.should == 0
+    end
+
+    it "should give the HTML_instructions of the step" do
+      @test.HTML_instructions.should == "Head <b>south</b> on <b>Le Roy Ave</b> toward <b>Hearst Ave</b>"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google_map_directions
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-30 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,10 +74,11 @@ files:
 - Rakefile
 - google_map_directions.gemspec
 - lib/google_map_directions.rb
-- lib/google_map_directions/path.rb
+- lib/google_map_directions/step.rb
 - lib/google_map_directions/version.rb
 - spec/direction_spec.rb
 - spec/spec_helper.rb
+- spec/step_spec.rb
 - test/google_map_directions/google_map_direction_test.rb
 - test/helper.rb
 homepage: https://github.com/chrishsu2312/google-map-directions
@@ -108,5 +109,6 @@ summary: I'll update this once I have some working code.
 test_files:
 - spec/direction_spec.rb
 - spec/spec_helper.rb
+- spec/step_spec.rb
 - test/google_map_directions/google_map_direction_test.rb
 - test/helper.rb