tfl_api_client 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc6e7d11384505488f3b2ade8fd0ac36ac7a84e2
-  data.tar.gz: 9bcb540bebb5f2cbe0854092f159bbc2b571c76e
+  metadata.gz: deb99ecef39b8759c52cdaa5e774800efc2dde1b
+  data.tar.gz: c1c9adf6bf722e5281ea6f80d920ee4edefa38dc
 SHA512:
-  metadata.gz: e414ce9d93ea823e441aa41d8df35111cbf6d150318b570c29affe677d60c44c2906e286932a4fc06c6e8fb1ab48ac6c881402a75876138ddf119691f406bedd
-  data.tar.gz: ac1fa21410376796d7f3ec91a90f0f21179fcbbb36fde1973c476606a240dffb882b0fa898ff9f1238159c12b1e79e10ce6abad6f5dbaee44d94d39b415ea84c
+  metadata.gz: 521acedbe9583749c68f84f4754fa159bc1fe7ec7ab1faab21d1c2f7b11e048ff4f03c8fa84a95d9b9cee62e2300e494bfbfc80e2269dc05ae840670d2e23048
+  data.tar.gz: ef54b73f0b5f1ae27ae0f3bb67b3a706aa539f1c76c86471c4ba675b5ec2c5e5b7efc38d782ae112ef02a709e75f6c40157586f7ebaeee7e3576d13d09e2b894

data/README.md

@@ -31,20 +31,37 @@ Or install it yourself as:
 
 The TFL API Client supports Ruby 2.0.0 or higher. 
 
-Ruby 1.9.3 is currently not supported, but will be supported in future 
-iterations of the gem.
-
 
 ## Usage
 
-Checkout the [Getting Started][getting_started] guide.
+TFL API Client has been designed to be as simple as possible to work with.
+
+To use the TFL API, developers should [register][tfl_registration] for a set
+of API credentials (an Application ID and Application Key).
+
+Once valid API credentials have been obtained, you will need to pass the 
+Application ID and Application Key upon initialisation of the client:
+
+```ruby
+@client = TflApi::Client.new(app_id: TFL_APP_ID, app_key: TFL_APP_KEY)
+````
+
+In addition to the above mandatory parameters, a number of optional parameters
+can be passed:
+
+| Option       | Default Value          | Description                                         |
+| ------------ | ---------------------- | --------------------------------------------------- |
+| host         | https://api.tfl.gov.uk | TFL API's host url                                  |
+| logger       | a new Logger instance  | Logger object to log into                           |
+| log_level    | INFO                   | The log level to logging at                         |
+| log_location | STDOUT                 | Location to send all logs (can be a file or STDOUT) |
 
-[getting_started]: GETTING_STARTED.md
+[registration]: https://api-portal.tfl.gov.uk
 
 
 ## Changelog
 
-See [CHANGELOG][changelog] for a list of changes.
+See the [CHANGELOG][changelog] for a list of changes.
 
 [changelog]: CHANGELOG.md
 

data/lib/tfl_api_client/cabwise.rb

@@ -0,0 +1,59 @@
+#
+# 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 "/Cabwise" API to obtain
+    # details about taxis and minicabs contact information.
+    #
+    class Cabwise
+
+      # Initialize the Cabwise object and store the reference to Client object
+      #
+      # @param client [Client] the client object
+      #
+      # @return [Cabwise] the Cabwise object
+      #
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns all contact information for taxis and minicabs known by the TFL
+      # service within based upon the given search query.
+      #
+      # @param latitude  [String] the latitude value
+      # @param longitude [String] the longitude value
+      # @param params    [String] Additional search query values
+      #
+      # @return [Hash] A hash of operator information
+      #
+      def search(latitude, longitude, params={})
+        @client.get('/Cabwise/search', params.merge({ lat: latitude, lon: longitude }))
+      end
+
+    end
+  end
+end

data/lib/tfl_api_client/client.rb

@@ -128,6 +128,14 @@ module TflApi
       TflApi::Client::Cycle.new(self)
     end
 
+    # Creates an instance to the Cabwise class by passing a reference to self
+    #
+    # @return [TflApi::Client::Cabwise] An object to Cabwise subclass
+    #
+    def cabwise
+      TflApi::Client::Cabwise.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/version.rb

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

data/lib/tfl_api_client.rb

@@ -29,6 +29,7 @@ require 'tfl_api_client/accident_stats'
 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/exceptions'
 
 module TflApi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tfl_api_client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Luke Hackett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.8
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -114,28 +114,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: 0.8.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: 0.8.20
 description: |2
       This gem aims to provide a simple, programmatic ruby client that allows
       native ruby applications to seamlessly interact with the Transport for
@@ -152,6 +152,7 @@ files:
 - lib/tfl_api_client/accident_stats.rb
 - lib/tfl_api_client/air_quality.rb
 - lib/tfl_api_client/bike_point.rb
+- lib/tfl_api_client/cabwise.rb
 - lib/tfl_api_client/client.rb
 - lib/tfl_api_client/cycle.rb
 - lib/tfl_api_client/exceptions.rb
@@ -181,4 +182,3 @@ signing_key:
 specification_version: 4
 summary: Transport for London API Client
 test_files: []
-has_rdoc: