tfl_api_client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: deb99ecef39b8759c52cdaa5e774800efc2dde1b
-  data.tar.gz: c1c9adf6bf722e5281ea6f80d920ee4edefa38dc
+  metadata.gz: 2df78d3542369083dd156f9abc8e5ef88771e690
+  data.tar.gz: 7fcedd056b1b6d294dc8eab63b5a518fa5f6108a
 SHA512:
-  metadata.gz: 521acedbe9583749c68f84f4754fa159bc1fe7ec7ab1faab21d1c2f7b11e048ff4f03c8fa84a95d9b9cee62e2300e494bfbfc80e2269dc05ae840670d2e23048
-  data.tar.gz: ef54b73f0b5f1ae27ae0f3bb67b3a706aa539f1c76c86471c4ba675b5ec2c5e5b7efc38d782ae112ef02a709e75f6c40157586f7ebaeee7e3576d13d09e2b894
+  metadata.gz: f4ee5f0764e016b88ab6a41f091473bd841dc2691b774e1199ec3ef185c862c7cb4c5b1def163a859321d020923a9d92fb2ac3cd506f01c6c41d6bc28bb0a5cc
+  data.tar.gz: '08fabde513a3ea107ee8a3eec8555f3cb7d614689702ca661a64765f3ef9aa2d6583e7f0adaebbc795085c93d4d645d8bdef0b7d5f20a43c0d6c86d203c1307f'

data/lib/tfl_api_client/client.rb

@@ -136,6 +136,14 @@ module TflApi
       TflApi::Client::Cabwise.new(self)
     end
 
+    # Creates an instance to the Journey class by passing a reference to self
+    #
+    # @return [TflApi::Client::Journey] An object to Journey subclass
+    #
+    def journey
+      TflApi::Client::Journey.new(self)
+    end
+
     # Performs a HTTP GET request to the api, based upon the given URI resource
     # and any additional HTTP query parameters. This method will automatically
     # inject the mandatory application id and application key HTTP query
@@ -216,7 +224,7 @@ module TflApi
     def format_request_uri(path, params)
       params.merge!({app_id: app_id, app_key: app_key})
       params_string = URI.encode_www_form(params)
-      URI::HTTPS.build(host: host.host, path: path, query: params_string)
+      URI::HTTPS.build(host: host.host, path: URI.escape(path), query: params_string)
     end
 
     # Parses the given response body as JSON, and returns a hash representation of the

data/lib/tfl_api_client/journey.rb

@@ -0,0 +1,65 @@
+#
+# Copyright (c) 2015 - 2017 Luke Hackett
+#
+# 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.
+#
+
+module TflApi
+  class Client
+    # This class communicates with the TFL "/Journey" API to obtain
+    # details about taxis and minicabs contact information.
+    #
+    class Journey
+
+      # Initialize the Journey object and store the reference to Client object
+      #
+      # @param client [Client] the client object
+      #
+      # @return [Journey] the Journey object
+      #
+      def initialize(client)
+        @client = client
+      end
+
+      # Gets a list of all of the available journey planner modes.
+      #
+      # @return [Array] An array of all available journey planner modes
+      #
+      def modes
+        @client.get('/Journey/Meta/Modes')
+      end
+
+      # Perform a Journey Planner search from the parameters specified in
+      # simple types.
+      #
+      # @param from [String] the origin of the journey
+      # @param to   [String] the destination of the journey
+      #
+      # @return [Hash] A hash of planner journey results
+      #
+      def planner(from, to, params={})
+        @client.get("/Journey/JourneyResults/#{from}/to/#{to}", params)
+      end
+
+    end
+  end
+end

data/lib/tfl_api_client/version.rb

@@ -24,5 +24,5 @@
 #
 
 module TflApi
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/tfl_api_client.rb

@@ -30,6 +30,7 @@ require 'tfl_api_client/air_quality'
 require 'tfl_api_client/bike_point'
 require 'tfl_api_client/cycle'
 require 'tfl_api_client/cabwise'
+require 'tfl_api_client/journey'
 require 'tfl_api_client/exceptions'
 
 module TflApi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tfl_api_client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Luke Hackett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,7 @@ files:
 - lib/tfl_api_client/client.rb
 - lib/tfl_api_client/cycle.rb
 - lib/tfl_api_client/exceptions.rb
+- lib/tfl_api_client/journey.rb
 - lib/tfl_api_client/version.rb
 homepage: https://github.com/LukeHackett/tfl_api_client
 licenses: