tfl_api_client 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2df78d3542369083dd156f9abc8e5ef88771e690
-  data.tar.gz: 7fcedd056b1b6d294dc8eab63b5a518fa5f6108a
+  metadata.gz: d635aab374d02a5db6034aa5fe70a1304ee226e7
+  data.tar.gz: bda385133a306071f14bce1b41873fd7ffc73816
 SHA512:
-  metadata.gz: f4ee5f0764e016b88ab6a41f091473bd841dc2691b774e1199ec3ef185c862c7cb4c5b1def163a859321d020923a9d92fb2ac3cd506f01c6c41d6bc28bb0a5cc
-  data.tar.gz: '08fabde513a3ea107ee8a3eec8555f3cb7d614689702ca661a64765f3ef9aa2d6583e7f0adaebbc795085c93d4d645d8bdef0b7d5f20a43c0d6c86d203c1307f'
+  metadata.gz: ae52ceb724c21a99e526808c6453cd627257708019b6b82c0b14a2855c6f5c1665338650f48c8fc1755540a5c2ccbc81fde6225dd1b2ec1a2b490e2bbf0aab31
+  data.tar.gz: 399007e96aeb0eb3d84eff84af220a0430987591ead676ca3867bb945f7c0eef895167ebf889958253cb6abd7d9bc65bc7aff4e8f7e376802649755819c50deb

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## v0.5.0  [13-MAY-2017]
+* Added support for the /Journey resource.
+
+
+## v0.4.0  [18-APR-2017]
+* Added support for the /Cabwise resource.
+
+
 ## v0.3.0  [16-FEB-2017]
 * Added support for the /AccidentStats resource.
 * Added support for the /AirQuality resource.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 - 2017 Luke Hackett
+Copyright (c) 2015 - 2018 Luke Hackett
 
 MIT License
 

data/README.md

@@ -56,8 +56,10 @@ can be passed:
 | log_level    | INFO                   | The log level to logging at                         |
 | log_location | STDOUT                 | Location to send all logs (can be a file or STDOUT) |
 
-[registration]: https://api-portal.tfl.gov.uk
+Full documentation can be found on the project's [ruby docs][ruby_docs].
 
+[tfl_registration]: https://api-portal.tfl.gov.uk/signup
+[ruby_docs]: http://www.rubydoc.info/github/LukeHackett/tfl_api_client
 
 ## Changelog
 
@@ -133,7 +135,7 @@ and [Factory Girl][factory_girl].
 
 ## License
 
-Copyright (c) 2015 - 2017 Luke Hackett. MIT Licensed, see [LICENSE][license] for details.
+Copyright (c) 2015 - 2018 Luke Hackett. MIT Licensed, see [LICENSE][license] for details.
 
 [license]: LICENSE
 

data/lib/tfl_api_client/accident_stats.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #

data/lib/tfl_api_client/air_quality.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #

data/lib/tfl_api_client/bike_point.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #

data/lib/tfl_api_client/cabwise.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #

data/lib/tfl_api_client/client.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #
@@ -144,6 +144,14 @@ module TflApi
       TflApi::Client::Journey.new(self)
     end
 
+    # Creates an instance to the Mode class by passing a reference to self
+    #
+    # @return [TflApi::Client::Mode] An object to Mode subclass
+    #
+    def mode
+      TflApi::Client::Mode.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

data/lib/tfl_api_client/cycle.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #

data/lib/tfl_api_client/exceptions.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #

data/lib/tfl_api_client/journey.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #

data/lib/tfl_api_client/mode.rb

@@ -0,0 +1,64 @@
+#
+# Copyright (c) 2015 - 2018 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 Mode
+
+      # Initialize the Mode object and store the reference to Client object
+      #
+      # @param client [Client] the client object
+      #
+      # @return [Mode] the Mode object
+      #
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns the service type active for a mode.
+      #
+      # @return [Array] An array of service types that are active for a mode
+      #
+      def active_service_types
+        @client.get('/Mode/ActiveServiceTypes')
+      end
+
+      # Returns the next arrival predictions for all stops of a given mode
+      #
+      # @param mode [String] A mode name e.g. tube, dlr
+      # @param count [Integer] Number of arrivals to return for each stop
+      #
+      # @return [Array] An array of arrival predictions for all stops of a given mode
+      #
+      def next_arrival(mode, count = -1)
+        @client.get("/Mode/#{mode}/Arrivals", { count: count })
+      end
+
+    end
+  end
+end

data/lib/tfl_api_client/version.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #
@@ -24,5 +24,5 @@
 #
 
 module TflApi
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/lib/tfl_api_client.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 - 2017 Luke Hackett
+# Copyright (c) 2015 - 2018 Luke Hackett
 #
 # MIT License
 #
@@ -31,6 +31,7 @@ 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/mode'
 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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Luke Hackett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-13 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -86,56 +86,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.20
+        version: 0.8.21
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.20
+        version: 0.8.21
 description: |2
       This gem aims to provide a simple, programmatic ruby client that allows
       native ruby applications to seamlessly interact with the Transport for
@@ -157,6 +157,7 @@ files:
 - lib/tfl_api_client/cycle.rb
 - lib/tfl_api_client/exceptions.rb
 - lib/tfl_api_client/journey.rb
+- lib/tfl_api_client/mode.rb
 - lib/tfl_api_client/version.rb
 homepage: https://github.com/LukeHackett/tfl_api_client
 licenses:
@@ -178,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Transport for London API Client