journey_planner 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0f7f3371e9706ca00177cc47807103d28419b28
+  data.tar.gz: ae47cf3fc692af55909a29b2c6f4f0ad59d9026d
+SHA512:
+  metadata.gz: 6e0856d2adb600449bef9f25febbb838c0ed9d3a8078b60573a733c30f5b2077c17ce8387a655109cc17c7ee22a164a8808d283d9e877d8ee4abedee5e8fcc19
+  data.tar.gz: e556715914fce4c00a15fef9e9158868db0f5351ff308652b7408f0216b64a4778b695b5b866f211518230308157097f8ff75bf9562168afa675aa8bc552dd8a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format doc
+--require spec_helper

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tfl_jp.gemspec
+gemspec
+
+gem 'httparty'
+gem 'recursive-open-struct'
+gem 'active-support'
+
+group :test do 
+	gem 'webmock'
+	gem 'vcr'
+	gem 'turn'
+	gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jpatel531
+
+MIT License
+
+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.md

@@ -0,0 +1,31 @@
+# Unofficial TFL Journey Planner Gem
+
+A Ruby-wrapper for the TFL Journey Planner API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'journey_planner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install journey_planner
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/tfl_jp/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/journey.rb

@@ -0,0 +1,18 @@
+module TFLJourneyPlanner
+
+	class Journey < RecursiveOpenStruct
+		def instructions
+			array = []
+			legs.each do |leg|
+				if leg.instruction.steps.any?
+					leg.instruction.steps.each {|step| array << step.description}
+				else
+					array << leg.instruction.summary + " / " + leg.instruction.detailed
+				end
+			end
+			return array
+		end
+
+	end
+
+end

data/lib/journey_planner/version.rb

@@ -0,0 +1,3 @@
+module TFLJourneyPlanner
+  VERSION = "0.0.5"
+end

data/lib/journey_planner.rb

@@ -0,0 +1,27 @@
+require "tfl_jp/version"
+require "httparty"
+require 'json'
+require 'ostruct'
+require 'recursive-open-struct'
+require_relative 'results'
+require_relative 'journey'
+
+
+module TFLJourneyPlanner
+  
+	class Client
+
+		include HTTParty
+		include TFLJourneyPlanner::Results
+
+		attr_reader :app_key, :app_id
+
+		def initialize(options)
+			@app_key = options[:app_key]
+			@app_id = options[:app_id]
+		end
+
+	end
+
+
+end

data/lib/results.rb

@@ -0,0 +1,66 @@
+require_relative 'rubify_keys'
+
+module TFLJourneyPlanner
+
+	module Results
+
+		include HTTParty
+
+		BASE_URI = 'http://api.tfl.gov.uk/Journey/JourneyResults/%7Bfrom%7D/to/%7Bto%7D/via/%7Bvia%7D'
+
+		format :json
+
+
+		def get_journeys(options)
+			from = options[:from].gsub(" ", "+")
+			to = options[:to].gsub(" ", "+")
+			via = options[:via]
+			national_search = options[:national_search] || false
+			time_is = options[:time_is] || "Departing"
+			journey_preference = options[:journey_preference]
+			mode = options[:mode]
+			from_name = options[:from_name]
+			to_name = options[:to_name]
+			via_name = options[:via_name]
+			max_transfer_minutes = options[:max_transfer_minutes]
+			max_walking_minutes = options[:max_walking_minutes]
+			cycle_preference = options[:cycle_preference]
+			adjustment = options[:adjustment]
+			alternative_cycle = options[:alternative_cycle] || false
+			alternative_walking = options[:alternative_walking] || true
+			apply_html_markup = options[:apply_html_markup] || false
+
+			results = self.class.get(BASE_URI, query: 
+				{app_key: app_key, 
+				app_id: app_id, 
+				from: from, 
+				to: to, 
+				via: via, 
+				nationalSearch: national_search, 
+				timeIs: time_is,
+				journeyPreference: journey_preference,
+				mode: mode,
+				fromName: from_name,
+				toName: to_name,
+				viaName: via_name,
+				maxTransferMinutes: max_transfer_minutes,
+				maxWalkingMinutes: max_walking_minutes,
+				cyclePreference: cycle_preference,
+				adjustment: adjustment,
+				alternativeCycle: alternative_cycle, 
+				alternativeWalking: alternative_walking, 
+				applyHtmlMarkup: apply_html_markup}).rubyify_keys!
+			process_journeys_from results
+		end
+
+		def process_journeys_from results
+			array = []
+			results["journeys"].each do |journey|
+				array << TFLJourneyPlanner::Journey.new(journey, recurse_over_arrays: true)
+			end
+			return array
+		end
+
+	end
+
+end

data/lib/rubify_keys.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/string'
+
+class Hash
+
+  def rubyify_keys!
+    keys.each{|k|
+      v = delete(k)
+      new_key = k.to_s.underscore
+      self[new_key] = v
+      v.rubyify_keys! if v.is_a?(Hash)
+      v.each{|p| p.rubyify_keys! if p.is_a?(Hash)} if v.is_a?(Array)
+    }
+    self
+  end
+
+end

data/spec/client_spec.rb

@@ -0,0 +1,15 @@
+require_relative 'spec_helper'
+
+describe TFLJourneyPlanner::Client do 
+
+	it 'has to be initialized with an app id and app key' do 
+		expect{TFLJourneyPlanner::Client.new}.to raise_error(ArgumentError)
+	end
+
+	it 'has an app key and app id' do
+		client = TFLJourneyPlanner::Client.new(app_id: ENV["TFL_ID"], app_key: ENV["TFL_KEY"])
+		expect(client.app_key).to eq ENV["TFL_KEY"]
+		expect(client.app_id).to eq ENV["TFL_ID"]
+	end
+
+end