tfl_api_client 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15b64d19d6071515d9a3044f037a9c92963944fa
-  data.tar.gz: 1e050f6d8279ad8820e46c7cbbd2786604f5b51f
+  metadata.gz: bc6e7d11384505488f3b2ade8fd0ac36ac7a84e2
+  data.tar.gz: 9bcb540bebb5f2cbe0854092f159bbc2b571c76e
 SHA512:
-  metadata.gz: 75a83c4d8b8329b5a78c26bf5aaec5c528e2d80e3482d1a1b6a27fa4cc30a15117035bf4edbde9c56864d1f9779d8c79db9d55e4e467319ef2d7f18fd1af6a9e
-  data.tar.gz: 71a74fe9d41007ad72b87373599ef9dad6b6fb85dec345ba124f256b26188d307fe76bc2867657a238a99fd07e414f5a8ab858724daee9e5c4128ed22cf39ef1
+  metadata.gz: e414ce9d93ea823e441aa41d8df35111cbf6d150318b570c29affe677d60c44c2906e286932a4fc06c6e8fb1ab48ac6c881402a75876138ddf119691f406bedd
+  data.tar.gz: ac1fa21410376796d7f3ec91a90f0f21179fcbbb36fde1973c476606a240dffb882b0fa898ff9f1238159c12b1e79e10ce6abad6f5dbaee44d94d39b415ea84c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v0.3.0  [16-FEB-2017]
+* Added support for the /AccidentStats resource.
+* Added support for the /AirQuality resource.
+
+
 ## v0.2.1  [14-FEB-2017]
 * Updated project dependencies to latest versions.
 * Added Ruby 2.4.0 to travis build.

data/LICENSE

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

data/README.md

@@ -116,7 +116,7 @@ and [Factory Girl][factory_girl].
 
 ## License
 
-Copyright (c) 2015 - 2016 Luke Hackett. MIT Licensed, see [LICENSE][license] for details.
+Copyright (c) 2015 - 2017 Luke Hackett. MIT Licensed, see [LICENSE][license] for details.
 
 [license]: LICENSE
 

data/lib/tfl_api_client.rb

@@ -25,6 +25,8 @@
 
 require 'tfl_api_client/version'
 require 'tfl_api_client/client'
+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/exceptions'

data/{spec/support/coverage.rb → lib/tfl_api_client/accident_stats.rb}

@@ -23,14 +23,33 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
-require 'simplecov'
-require 'coveralls'
+module TflApi
+  class Client
+    # This class communicates with the TFL "/AccidentStats" API to obtain
+    # details about Accident Statistics based upon the year the accident
+    # occurred.
+    #
+    class AccidentStats
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-])
+      # Initialize the AccidentStats object and store the reference to Client
+      # object.
+      #
+      # @param client [Client] the client object
+      #
+      # @return [AccidentStats] the AccidentStats object
+      #
+      def initialize(client)
+        @client = client
+      end
 
-SimpleCov.start do
-  add_filter 'spec'
+      # Returns all accident details for accidents occurring in the specified
+      # year.
+      #
+      # @return [Array] An array of hashes containing all Accident Statistics
+      #
+      def details(year)
+        @client.get("/AccidentStats/#{year}")
+      end
+    end
+  end
 end

data/{spec/support/vcr.rb → lib/tfl_api_client/air_quality.rb}

@@ -23,21 +23,32 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
-require 'vcr'
+module TflApi
+  class Client
+    # This class communicates with the TFL "/AirQuality" API to obtain
+    # details about London's Air Quality.
+    #
+    class AirQuality
 
-VCR.configure do |config|
-  config.cassette_library_dir = File.expand_path('../../cassettes', __FILE__)
-  config.hook_into :webmock
-  config.configure_rspec_metadata!
+      # Initialize the AirQuality object and store the reference to Client
+      # object.
+      #
+      # @param client [Client] the client object
+      #
+      # @return [AirQuality] the AirQuality object
+      #
+      def initialize(client)
+        @client = client
+      end
 
-  # Replace the real Application ID and Application Key with some fake data
-  config.before_record do |interaction|
-    interaction.request.uri.gsub!(/app_id=([^&]+)/, 'app_id=TFL_APP_ID')
-    interaction.request.uri.gsub!(/app_key=([^&]+)/, 'app_key=TFL_APP_KEY')
+      # Returns all Air Quality details for the current time period (currently
+      # every hour).
+      #
+      # @return [Hash] A hash containing details upon London's Air Quality
+      #
+      def details
+        @client.get('/AirQuality')
+      end
+    end
   end
-
-  # Prevent VCR from matching on Application ID and Application Key
-  config.default_cassette_options = {
-      match_requests_on: [:method, VCR.request_matchers.uri_without_param(:app_id, :app_key)]
-  }
 end

data/lib/tfl_api_client/bike_point.rb

@@ -23,7 +23,6 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 
-
 module TflApi
   class Client
     # This class communicates with the TFL "/BikePoint" API to obtain details

data/lib/tfl_api_client/client.rb

@@ -96,6 +96,22 @@ module TflApi
       end
     end
 
+    # Creates an instance to the AccidentStats class by passing a reference to self
+    #
+    # @return [TflApi::Client::AccidentStats] An object to AccidentStats subclass
+    #
+    def accident_stats
+      TflApi::Client::AccidentStats.new(self)
+    end
+
+    # Creates an instance to the AirQuality class by passing a reference to self
+    #
+    # @return [TflApi::Client::AirQuality] An object to AirQuality subclass
+    #
+    def air_quality
+      TflApi::Client::AirQuality.new(self)
+    end
+
     # Creates an instance to the BikePoint class by passing a reference to self
     #
     # @return [TflApi::Client::BikePoint] An object to BikePoint subclass

data/lib/tfl_api_client/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tfl_api_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Luke Hackett
@@ -145,45 +145,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- GETTING_STARTED.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - lib/tfl_api_client.rb
+- 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/client.rb
 - lib/tfl_api_client/cycle.rb
 - lib/tfl_api_client/exceptions.rb
 - lib/tfl_api_client/version.rb
-- spec/cassettes/bike_point/authorised_client_location.yml
-- spec/cassettes/bike_point/authorised_client_locations.yml
-- spec/cassettes/bike_point/authorised_client_locations_within_bounding_box.yml
-- spec/cassettes/bike_point/authorised_client_locations_within_locus.yml
-- spec/cassettes/bike_point/authorised_client_search.yml
-- spec/cassettes/bike_point/unauthorised_client_location.yml
-- spec/cassettes/bike_point/unauthorised_client_locations.yml
-- spec/cassettes/bike_point/unauthorised_client_locations_within_bounding_box.yml
-- spec/cassettes/bike_point/unauthorised_client_locations_within_locus.yml
-- spec/cassettes/bike_point/unauthorised_client_search.yml
-- spec/cassettes/cycle/authorised_client_superhighway.yml
-- spec/cassettes/cycle/authorised_client_superhighways.yml
-- spec/cassettes/cycle/unauthorised_client_superhighway.yml
-- spec/cassettes/cycle/unauthorised_client_superhighways.yml
-- spec/integration/bike_point_spec.rb
-- spec/integration/cycle_spec.rb
-- spec/spec_helper.rb
-- spec/support/coverage.rb
-- spec/support/helpers.rb
-- spec/support/vcr.rb
-- spec/unit/bike_point_spec.rb
-- spec/unit/client_spec.rb
-- spec/unit/cycle_spec.rb
-- tfl_api_client.gemspec
 homepage: https://github.com/LukeHackett/tfl_api_client
 licenses:
 - MIT
@@ -208,28 +180,5 @@ rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Transport for London API Client
-test_files:
-- spec/cassettes/bike_point/authorised_client_location.yml
-- spec/cassettes/bike_point/authorised_client_locations.yml
-- spec/cassettes/bike_point/authorised_client_locations_within_bounding_box.yml
-- spec/cassettes/bike_point/authorised_client_locations_within_locus.yml
-- spec/cassettes/bike_point/authorised_client_search.yml
-- spec/cassettes/bike_point/unauthorised_client_location.yml
-- spec/cassettes/bike_point/unauthorised_client_locations.yml
-- spec/cassettes/bike_point/unauthorised_client_locations_within_bounding_box.yml
-- spec/cassettes/bike_point/unauthorised_client_locations_within_locus.yml
-- spec/cassettes/bike_point/unauthorised_client_search.yml
-- spec/cassettes/cycle/authorised_client_superhighway.yml
-- spec/cassettes/cycle/authorised_client_superhighways.yml
-- spec/cassettes/cycle/unauthorised_client_superhighway.yml
-- spec/cassettes/cycle/unauthorised_client_superhighways.yml
-- spec/integration/bike_point_spec.rb
-- spec/integration/cycle_spec.rb
-- spec/spec_helper.rb
-- spec/support/coverage.rb
-- spec/support/helpers.rb
-- spec/support/vcr.rb
-- spec/unit/bike_point_spec.rb
-- spec/unit/client_spec.rb
-- spec/unit/cycle_spec.rb
+test_files: []
 has_rdoc: 

data/.gitignore

@@ -1,37 +0,0 @@
-# Ruby files
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-# Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-# Environment normalisation:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-/.idea/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/.travis.yml

@@ -1,31 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-
-rvm:
-  - 2.4.0
-  - 2.3.0
-  - 2.2.0
-  - 2.1.0
-  - 2.0.0
-
-before_install:
-  - gem uninstall bundler
-  - gem install bundler --version '~> 1.14'
-
-script:
-  - bundle exec rake
-
-env:
-  global:
-    # Application ID
-    - secure: mNYN26/OaEx535SefPMYfR3hYpYbm7GBJcWuSQ+emO22LDF90dFVHzIakmNAvwPG+sMkjKmKdxbQHOW7IVvfQ7wSc7uQ1lKpUVQcbimc+VXdQ/KIhlKVmIu/ZNV3KJW+d+/4PXMIY88tUynfd9CcuG3SyIrpmjQbSyQM0N/EbK0S4dMMfxSr6ryUnRh3X5Jcyl/hnGzeFqQ8ZVSFBVOPgW1Tkn69MemYNCQtkIyHHAUgCgRc96VJMVaKo0Fujs1WHtsjy9fHmhbduDZ/th3Enl7H2YuayYrYxzJwWIFpKNT0eTx8DoQIhtgRDiCyRaAH+lqfmgr/a3UIEG0q7PABDg97n/I9Ie0dtwTGJ1arrRKvQ7l8S4rv0pRSIaSOdUPce5BIqoMmmexIfiCnuQCPzxIjbHVLBXf85XuNhNzlTJDsXGqyekuQxWcV7iTy305jVokgEQETE5s0lX2x2HpFPCBYm/Ig8zF/wII2QRgN4t7eeUxYuGWkJKw6h7ssuB3Zv0KNKZsNeLvCo9l3Z+8TZ6u1uS3ab61eUYY165HBAGUq5PQ7xBuWD25ERcbU+mtPClLwrKdJmR0m5BmUC33ZXXqgje3qfzBhJdwLULPj/j7Hy+SUx4RgFDfIxB0eXa8XUHoMX8V1R4MlUt08LtQej3NCNHUogYf9Jo01lPtte08=
-    # Application Key
-    - secure: epXs5gDgdb/krwvS0gCYVlB2IusKfYHE3pbc90Pd+XqqEHsdqYQ5vpNYFiDjHpazh7xVtW8gL/5UIjSU4AFSjgNphhb83YBmdvWO5z/Zugs/F7llseYCt8QtLkpw8a7ERzsXjnq91zbxiJO4+Vz0DSZRw8nUNiN4wRGmKVIHWPHe/yi3J7GfJ4xZXe2N+yXbXR36DWaGWvjdJDh3S1wSHGe3+HAmZq6e1Xw2a27hwkpUUA4eviCnuV6CfzJl/KVjLEdneBPQ3lhHsLOgZ4ZpoC1uFICyJfRwbWdaaG+J9VQMbmpjaZfpJlV3ObZsIjis6rpVvDaqRnVGOvnlFy6gdCh3Onqm6N9I7s4lVaGKFldciIJwwC/WoMiXZJBMKO3IlmcRHQJVzc1B+lS8ehCUSvtCl6AZ9R2EOYMfiDXp5c4jjZRcVfeqpuGg56twBzFNNu2AN3JLtgwEhGgvWg6176ws2hpYjJxSDtjFZoErfsRP8vl/vzXtnNNx8p1R4Z/eOTO/IKGdW4YI3e1JwszPEegohNpeVWgAGW3SrNeuDmfXJ8j0+SuuTlHcqmBc0fzjz+pEG8/irG2dfCvpVoDKUQhk8NJtvxsXHsVllk5SifwplAWZhFmXom4ID5HDpMpl0sQ7ynIO+5f9/KJAFnhqGlvoXRgQIBmO8/yyOlVeLnY=
-    # Coveralls Repository Token
-    - secure: djKSoF3fahZ0s0SfwZHCGdBA/OU66aNdj0XBhjCz4LkDFn5f9I2TdymY5kMQWnFeyiyQ298cwb0o1FfTZ/jIziI/bU1evLuQk4PTjwiW1P8nKcxK8FBNEhn1CFNyCZHfD4O7DqXsDZwbCgcDg3gQPO1+RL3Te1Ez5ZOsSpXtT4MOXZJ83lBRcN+YSQlaJ/kL/O6R7ipO5iRH92hu6+iZJTL6KaL67maU/06e+Sup/LcdxEfL9l4uPx+KSR4uHgZrnWNS0NIouS9nhaml5wXmdeNQeAzRRthIni1CgKB7z1o/+65aLa+FPwnOk7pBz/xOrWQZMDq2KvCpXg1cdzMQw2ptxSM2YRwDGIoMCMUIoowSacvtNILjwjIZFR3OjYeWBcgw8cTdTqAxDOnUCgjrGGHhKL9Fz/48jbnAs0Lbrdf15YKS8Ro/qi9bOeKEJ51lXmKVd2dy2XmnYzqFModdRza7IpmhjmX2qeNh7u8EEUZJbArxPZZNAuNmWb/j3hHaCwqOxXmeFEtDZNkA/DVQYDbz0yXihq7GcStcUBB23H9PDDyTec05ISC0c6yb17JcHP751t9BIvWlG1F1k7MZAqHmjbhReuCocW6Usk5J6CW8WN/dz/xDgwEhEZn5ElzwUae3G0N1APVFRcxrCJRzSBF2DMpSvc7jotFVE3sg7Kg=
-
-notifications:
-  email:
-    on_success: change
-    on_failure: always

data/.yardopts

@@ -1,4 +0,0 @@
--
-CHANGELOG.md
-GETTING_STARTED.md
-LICENSE

data/GETTING_STARTED.md

@@ -1,231 +0,0 @@
-# Getting Started
-
-TFL API Client has been designed to be as simple as possible to work with.
-
-This Getting Started guide will cover basic usage of the gem, however for a 
-more in depth guide, checkout the [docs][docs].
-
-[docs]: http://www.rubydoc.info/github/LukeHackett/tfl_api_client
-
-
-## BikePoint
-
-The bike point interface interacts with the /BikePoint end point upon the 
-TFL API. This end point will return information regarding the [Santander 
-Cycle hire][cycle_hire] docking stations, including 5 minute real-time bike 
-and docking station status information.
-
-[cycle_hire]: https://tfl.gov.uk/modes/cycling/santander-cycles
-
-
-### Obtain an individual BikePoint  
-
-Information upon an individual BikePoint can be obtained using the `location` 
-method, whilst also passing the ID of the BikePoint.
-
-```ruby
-client = TflApi::Client.new(app_id: YOUR_TFL_APP_ID, app_key: YOUR_TFL_APP_KEY)
-client.bike_point.location
-
-=>  {
-      "id":"BikePoints_10",
-      "url": "https://api-prod5.tfl.gov.uk/Place/BikePoints_10",
-      "commonName": "Park Street, Bankside",
-      "placeType": "BikePoint",
-      "additionalProperties": [],
-      "children":[],
-        "childrenUrls": [],
-      "lat":51.505974,
-      "lon":-0.092754
-    }   
-```
-
-### Obtain all BikePoint locations 
-
-In order to obtain all BikePoint locations and their details the `locations`
-method can be used.
-
-```ruby
-client = TflApi::Client.new(app_id: YOUR_TFL_APP_ID, app_key: YOUR_TFL_APP_KEY)
-client.bike_point.locations
-
-=>  [
-      {
-        "id":"BikePoints_10",
-        "url": "https://api-prod5.tfl.gov.uk/Place/BikePoints_10",
-        "commonName": "Park Street, Bankside",
-        "placeType": "BikePoint",
-        "additionalProperties": [],
-        "children":[],
-        "childrenUrls": [],
-        "lat":51.505974,
-        "lon":-0.092754
-      },
-      ...
-      // Additional Locations
-      ...
-    ]
-```        
-
-
-### Obtain all BikePoint locations within a locus
-
-In order to obtain all BikePoint locations within a given locus the 
-`locations_within_locus` method should be used. In this context, a locus is a 
-particular position given by the longitude and latitude values with an area 
-that is calculated in accordance to the given radius in metres.
-
-```ruby
-client = TflApi::Client.new(app_id: YOUR_TFL_APP_ID, app_key: YOUR_TFL_APP_KEY)
-client.bike_point.locations_within_locus(51.5007292, -0.1246254, 500)
-
-=>  {
-      "centrePoint": [
-        51.5, -0.124
-      ],
-      "places": [
-        {
-          "additionalProperties": [],
-          "children": [],
-          "commonName": "Abingdon Green, Westminster",
-          "distance": 298.0259124357908,
-          "id": "BikePoints_583",
-          "lat": 51.497622,
-          "lon": -0.125978,
-          "placeType": "BikePoint",
-          "url": "https://api-prod6.tfl.gov.uk/Place/BikePoints_583",
-        }
-        ...
-        // Additional Locations
-        ...
-      ]
-    }
-```      
-
-
-### Obtain all BikePoint locations within a bounding box
-
-In order to obtain all BikePoint locations within a given square the 
-`locations_within_bounding_box` method should be used. Each of the coordinate
-pairs are used to draw a bounding box, to which all BikePoint locations within
-the box are returned.
-
-```ruby
-client = TflApi::Client.new(app_id: YOUR_TFL_APP_ID, app_key: YOUR_TFL_APP_KEY)
-client.bike_point.locations_within_bounding_box(51.5138453, -0.0983506, 51.5007292, -0.1246254)
-
-=>  [
-      {
-        "additionalProperties": [],
-        "children": [],
-        "commonName": "Godliman Street, St. Paul's",
-        "id": "BikePoints_48",
-        "lat": 51.512484,
-        "lon": -0.099141,
-        "placeType": "BikePoint",
-        "url": "https://api-prod6.tfl.gov.uk/Place/BikePoints_48"
-      }
-      ...
-      // Additional Locations
-      ...
-    ]
-```
-
-
-### Search for a given BikePoint location
-
-The TFL API supports searching for BikePoint locations and will search within
-the "commonName" field. To search for a given location the `search` method 
-accepts a query String.
-
-```ruby
-client = TflApi::Client.new(app_id: YOUR_TFL_APP_ID, app_key: YOUR_TFL_APP_KEY)
-client.bike_point.search("St. James's")
-
-=>  [
-      {
-        "id": "BikePoints_160",
-        "url": "https: //api-prod6.tfl.gov.uk/Place/BikePoints_160",
-        "commonName": "Waterloo Place, St. James's",
-        "placeType": "BikePoint",
-        "additionalProperties": [],
-        "children": [],
-        "childrenUrls": [],
-        "lat": 51.506633,
-        "lon": -0.131773
-      }
-      ...
-      // Additional Locations
-      ...
-    ]
-```
-
-
-## Cycle Superhighway
-
-The cycle superhighway interface interacts with the /CycleSuperhighway 
-end point upon the TFL API. This end point will return information 
-regarding the [Cycle Superhighways][cycle_superhighways] locations, 
-including coordinates of the route.
-
-[cycle_superhighways]: https://tfl.gov.uk/modes/cycling/routes-and-maps/cycle-superhighways
-
-### Obtain all Cycle Superhighways routes
-
-In order to obtain all Cycle Superhighway routes and their details the 
-`superhighways` method can be used.
-
-```ruby
-client = TflApi::Client.new(app_id: YOUR_TFL_APP_ID, app_key: YOUR_TFL_APP_KEY)
-client.cycle.superhighways
-
-=>  [
-      {
-        'id': 'CS-1',
-        'label': 'CS Route 1',
-        'labelShort': 'CS-1',
-        'segmented': true,
-        'geography': {
-          'type': 'LineString',
-          'coordinates': [],
-          'crs': {
-            'type': 'name',
-            'properties': {
-              'name': 'ABC:1234'
-            }
-          }
-        }
-      }
-      ...
-      // Additional Cycle Superhighways
-      ...
-    ]
-```
-
-### Obtain an individual Cycle Superhighway routes
-
-Information upon an individual Cycle Superhighway can be obtained using
-the `superhighway` method, whilst passing the ID of the Cycle 
-Superhighway route.
-
-```ruby
-client = TflApi::Client.new(app_id: YOUR_TFL_APP_ID, app_key: YOUR_TFL_APP_KEY)
-client.cycle.superhighway('CS-1')
-
-=>  {
-      'id': 'CS-1',
-      'label': 'CS Route 1',
-      'labelShort': 'CS-1',
-      'segmented': true,
-      'geography': {
-        'type': 'LineString',
-        'coordinates': [],
-        'crs': {
-          'type': 'name',
-          'properties': {
-            'name': 'ABC:1234'
-          }
-        }
-      }
-    }
-```