journey_planner 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51a282441331e412fef3cbffcfed99de9f63fe0b
-  data.tar.gz: 42a5108e049ebf722d04a904ff86deb0c921e713
+  metadata.gz: aa804b245593378c53df6576d5b6b4b8c157ae2b
+  data.tar.gz: 5f1df6f9c52b9abbb26221c2b86b8e2ef97b7a6d
 SHA512:
-  metadata.gz: a3a320688af4b416ba283a2f157ec39df814feb3ee585956449595fdeb33344450e8a333baf0d8e01088a6cc7f9bd46ecb54142a6072cd2caf2264a6de08a6ed
-  data.tar.gz: b12769f311da7a5a7f833af05512b2cc154ee54e17784c491100aee989ed8fa36bd2be9a2a7737063ea0f5775ae9a1b7c92d8e19ad3736a09051557d7e64a22d
+  metadata.gz: 4464c10376d4848348d8316640b1faa563b579aeca9c14a8559142203e0a308fb2174add2efc8191ba78070366df157d219c712c7fc71faa7f7cb310122be618
+  data.tar.gz: 95208206d05bb3bb6561057201943dd25420c772e068dbdeac1f44b278d0158d6b5bfc46d4935fb1ef66a0e2857d728ededc517180c4faa7dba1d0c8bb3eee95

data/README.md

@@ -34,14 +34,121 @@ journeys = client.get_journeys from: "old street underground station", to: "oxfo
 
 ```
 
-Methods you can play with:
+### Methods you can play with:
+
+The `instructions` method returns a hash of instructions, with the keys as departure and arrival times, and the values as arrays of verbal instructions.
 
 ```ruby
 journeys.first.instructions
-# => ["Northern line to Euston / Northern line towards Edgware, or High Barnet", "Victoria line to Oxford Circus / Victoria line towards Brixton"]
+# {"Sep 5 2014 16:21 - Sep 5 2014 16:27"=>["Northern line to Euston / Northern line towards Edgware, Mill Hill East, or High Barnet"], 
+# "Sep 5 2014 16:32 - Sep 5 2014 16:35"=>["Victoria line to Oxford Circus / Victoria line towards Brixton"]} 
+```
+
+### Integrating with Google Maps
+
+Setting up a simple Sinatra app:
+
+```ruby
+
+require 'sinatra'
+require 'sinatra/json'
+require 'journey_planner'
+
+get '/' do 
+	erb :index
+end
+
+get '/maps' do 
+	client = TFLJourneyPlanner::Client.new(app_id: ENV["TFL_ID"], app_key: ENV["TFL_KEY"])
+	journeys = client.get_journeys from: "old street underground station", to: "oxford circus underground station"
+	json journeys.first.map_path
+end
+
+```
+
+Your HTML and Javascript (assuming JQuery, the Google Maps API, and GMapsJS have already been linked)
+
+```html
+<div id="map" style="height: 500px; width: 500px"></div>
+```
+
+```javascript
+	$(document).ready(function(){
+
+		$.get('/maps', function(coordinates){
+
+			var map = new GMaps({
+	  			div: '#map',
+	  			lat: coordinates[0][0],
+	  			lng: coordinates[0][1]
+
+			});
+
+			map.drawPolyline({
+			  path: coordinates,
+			  strokeColor: '#131540',
+			  strokeOpacity: 0.6,
+			  strokeWeight: 6
+			});
+		})
+
+	})
 ```
 
+On launching your app, you should find that GMaps has created a polyline from the TFL Journey Planner path coordinates.
+
+![Image1](https://raw.githubusercontent.com/jpatel531/journey_planner_gem/master/screenshots/jp_gmaps_ex.jpg)
+
+###Search Options
+
+```ruby
+client.get_journeys
+
+from: #=> 	Origin of the journey (if in coordinate format then must be "longitude,latitude")
+
+to: #=> Destination of the journey (if in coordinate format then must be "longitude,latitude")
+
+via: #=> Travel through (if in coordinate format then must be "longitude,latidude")
+
+national_search: #=> Does the journey cover stops outside London? eg. "nationalSearch=true". Set to false by default
+
+date: #=> The date must be in yyyyMMdd format
+
+time: #=> The time must be in HHmm format
+
+time_is: #=> Does the time given relate to arrival or leaving time? Possible options: "departing" | "arriving". Set to Departing by default
+
+journey_preference: #=> The journey preference eg possible options: "leastinterchange" | "leasttime" | "leastwalking"
+
+mode: #=> The mode must be a comma separated list of modes. eg possible options: "public-bus,overground,train,tube,coach,dlr,cablecar,tram,river,walking,cycle"
+
+accessibility_preference: #=> The accessibility preference must be a comma separated list eg. "noSolidStairs,noEscalators,noElevators,stepFreeToVehicle,stepFreeToPlatform"
+
+from_name: #=> From name is the location name associated with a from coordinate
 
+to_name: #=> To name is the label location associated with a to coordinate
+
+via_name: #=> Via name is the location name associated with a via coordinate
+
+max_transfer_minutes: #=> The max walking time in minutes for transfer eg. "120"
+
+min_transfer_minutes: #=> The max walking time in minutes for journeys eg. "120"
+
+walking_speed: #=> The walking speed. eg possible options: "slow" | "average" | "fast"
+
+cycle_preference: #=> The cycle preference. eg possible options: "allTheWay" | "leaveAtStation" | "takeOnTransport" | "cycleHire"
+
+adjustment: #=> Time adjustment command. eg possible options: "TripFirst" | "TripLast"
+
+bike_proficiency: #=> A comma separated list of cycling proficiency levels. eg possible options: "easy,moderate,fast"
+
+alternative_cycle: #=> Set to True to generate an additional journey consisting of cycling only, if possible. Default value is false. eg. alternative_cycle: true
+
+alternative_walking: #=> Set to true to generate an additional journey consisting of walking only, if possible. Default value is false. eg. alternative_walking: true
+
+apply_html_markup: #=> Flag to determine whether certain text (e.g. walking instructions) should be output with HTML tags or not.
+
+```
 
 ## Contributing
 

data/lib/journey.rb

@@ -1,16 +1,22 @@
+require_relative 'time_helpers'
+
 module TFLJourneyPlanner
 
 	class Journey < RecursiveOpenStruct
+
+		include TimeHelpers
+
+
 		def instructions
 			array = []
 			legs.each do |leg|
 				if leg.instruction.steps.any?
-					leg.instruction.steps.each {|step| array << step.description}
+					leg.instruction.steps.each {|step| array << [ "#{prettify leg.departure_time} - #{prettify leg.arrival_time}", step.description]}
 				else
-					array << leg.instruction.summary + " / " + leg.instruction.detailed
+					array << ["#{prettify leg.departure_time} - #{prettify leg.arrival_time}", leg.instruction.summary + " / " + leg.instruction.detailed]
 				end
 			end
-			return array
+			array.inject(Hash.new{ |h,k| h[k]=[] }){ |h,(k,v)| h[k] << v; h }
 		end
 
 		def map_path

data/lib/journey_planner/version.rb

@@ -1,3 +1,3 @@
 module TFLJourneyPlanner
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/time_helpers.rb

@@ -0,0 +1,11 @@
+require 'time'
+
+module TimeHelpers
+
+	def prettify time
+		t = Time.parse time
+		t.strftime("%b%e %Y %H:%M")
+	end
+
+
+end

data/spec/journey_spec.rb

@@ -7,12 +7,8 @@ describe TFLJourneyPlanner::Journey do
 
 	it "should return an array of instructions" do 
 		VCR.use_cassette "hello", record: :none do 
-			array = ["Continue along Fruen Road for 143 metres (2 minutes, 8 seconds).", 
-				"Turn right on to Bedfont Lane, continue for 172 metres (2 minutes, 33 seconds).",
-				"H25 bus to Bedfont Library / H25 bus towards Hatton Cross",
-				 "Continue along Staines Road for 64 metres (0 minutes, 57 seconds).",
-				 "Turn left on to Grovestile Waye, continue for 95 metres (1 minute, 21 seconds)."]
-			expect(journeys[0].instructions).to eq array
+			hash = {"Sep 3 2014 16:58 - Sep 3 2014 17:03"=>["Continue along Fruen Road for 143 metres (2 minutes, 8 seconds).", "Turn right on to Bedfont Lane, continue for 172 metres (2 minutes, 33 seconds)."], "Sep 3 2014 17:03 - Sep 3 2014 17:06"=>["H25 bus to Bedfont Library / H25 bus towards Hatton Cross"], "Sep 3 2014 17:06 - Sep 3 2014 17:09"=>["Continue along Staines Road for 64 metres (0 minutes, 57 seconds).", "Turn left on to Grovestile Waye, continue for 95 metres (1 minute, 21 seconds)."]}	
+			expect(journeys[0].instructions).to eq hash
 		end
 	end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: journey_planner
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - jpatel531
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,6 +56,8 @@ files:
 - lib/journey_planner/version.rb
 - lib/results.rb
 - lib/rubify_keys.rb
+- lib/time_helpers.rb
+- screenshots/jp_gmaps_ex.jpg
 - spec/client_spec.rb
 - spec/fixtures/tfl_jp_casettes/hello.yml
 - spec/journey_spec.rb