tfl_api_client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 072de61d15adb1e4f79ec7e0ab0b3d85d1618fb7
-  data.tar.gz: b06257ef4ec2284db1eb978c5b2372fd7ad38fc2
+  metadata.gz: 6a675ef39a4ee3a74f9c640099cb3666e4dd4488
+  data.tar.gz: 59fbcc3f97451689780750c39d4b68d9aa751f80
 SHA512:
-  metadata.gz: cf7b44b929b47a007102911506a007ed293ca585361c6cd697871000e3632c8c8faef938e97e1e5003dde0184dd430a061a37567d9bdf5f3fef16f4dc7af5606
-  data.tar.gz: 72c58429cc1b558c74f77836063000e359c5ea0d50afe83b8dd68dbf04c9753e2d7105b56218cbec2e5cd2a703f3f5f0ae09d004ff0a819025214db8fecb67b0
+  metadata.gz: 18b34c5215adbabf9285ff46cf65f856d54cf4dd70945a4ad0981b9619db5c6cff276f80b6d254d1a830415ff8395be8dbe1b8e39f4e705eee69077e6369eac5
+  data.tar.gz: 1b9a663cf16a4d5d4044240d54da7238b6955b6c716a42edbf58e77bb91d3aeee1cf8f8b8229665a19deeb8d503920a1a192170edbf4a3fd42edc62566d34334

data/.travis.yml

@@ -3,13 +3,14 @@ sudo: false
 cache: bundler
 
 rvm:
+  - 2.3.0
   - 2.2.0
   - 2.1.0
   - 2.0.0
 
 before_install:
   - gem uninstall bundler
-  - gem install bundler --version '~> 1.10'
+  - gem install bundler --version '~> 1.11'
 
 script:
   - bundle exec rake

data/.yardopts

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

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## v0.2.0  [17-APR-2016]
+* Added support for the /CycleSuperhighway resource.
+
 
 ## v0.1.0  [13-AUG-2015]
 * First Release containing support for the /BikePoint resource.

data/GETTING_STARTED.md

@@ -20,7 +20,7 @@ and docking station status information.
 
 ### Obtain an individual BikePoint  
 
-Information upon an individual BikePoint can be obtained using the location 
+Information upon an individual BikePoint can be obtained using the `location` 
 method, whilst also passing the ID of the BikePoint.
 
 ```ruby
@@ -159,3 +159,73 @@ client.bike_point.search("St. James's")
       ...
     ]
 ```
+
+
+## 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'
+          }
+        }
+      }
+    }
+```

data/LICENSE

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

data/README.md

@@ -42,21 +42,81 @@ Checkout the [Getting Started][getting_started] guide.
 [getting_started]: GETTING_STARTED.md
 
 
+## Changelog
+
+See [CHANGELOG][changelog] for a list of changes.
+
+[changelog]: CHANGELOG.md
+
+
 ## Contributing
 
-Check out [CONTRIBUTING.md][contributing] for more information upon 
-contributing.
+This project started in order to fill a gap in the current offers for 
+gems that provide a programmatic interface to TFL's API. 
+
+The TFL API Client gem was originally developed by [Luke Hackett][luke_hackett], 
+and is not an official TFL client.
 
-The TFL API Client gem was originally developed by 
-[Luke Hackett][luke_hackett], and is not an official TFL client.
+In the spirit of [free software][free-sw], **everyone** is encouraged to 
+help improve this project.
+
+Here are some ways in which *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs][issues]
+* by suggesting [new features][issues]
+* by writing or editing documentation
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by refactoring code
+* by reviewing code
 
-[contributing]: CONTRIBUTING.md
 [luke_hackett]: http://www.lukehackett.com
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+[issues]: https://github.com/LukeHackett/tfl_api_client/issues
+
+### Submitting an Issue
+
+I utilise the [GitHub issue tracking][issues] to track bugs and features.
+Before submitting a bug report or feature request, check to make sure it
+hasn't already been submitted.
+
+When submitting a bug report, please include a [Gist][gist] that includes
+a stack trace and any details that may be necessary to reproduce the bug,
+including your gem version, Ruby version, and operating system. 
+
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+### Submitting a Pull Request
+
+1. [Fork][fork] the [repository][repo].
+2. [Create a feature branch][branch] using the [gitflow][gitflow] naming convention e.g. `feature/my-new-feature`.
+3. Implement your feature or bug fix.
+4. Add, commit, and push your changes.
+5. [Submit a pull request][pr].
+
+[repo]: https://github.com/LukeHackett/tfl_api_client/tree/master
+[fork]: https://help.github.com/articles/fork-a-repo/
+[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[pr]: https://help.github.com/articles/using-pull-requests/
+[gitflow]: http://danielkummer.github.io/git-flow-cheatsheet/#features
+
+### Notes
+
+* Please add tests if you changed code - contributions without tests won't be accepted.
+* Please don't update the Gem version.
+
+The contributing guidelines was inspired by [Middleman-Heroku][middleman] 
+and [Factory Girl][factory_girl]. 
+
+[middleman]: https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md
+[factory_girl]: https://github.com/thoughtbot/factory_girl/blob/master/CONTRIBUTING.md
 
 
 ## License
 
-Transport for London API Client is released under the [MIT License][license].
+Copyright (c) 2015 - 2016 Luke Hackett. MIT Licensed, see [LICENSE][license] for details.
 
-[licence]: http://www.opensource.org/licenses/MIT
+[license]: LICENSE
 

data/Rakefile

@@ -28,3 +28,9 @@ namespace :test do
     spec.pattern = FileList['spec/integration/*_spec.rb']
   end
 end
+
+desc "Generates the project's YARD documentation"
+YARD::Rake::YardocTask.new do |task|
+  task.files = ['lib/**/*.rb']
+  task.options = ['-yardopts .yardopts']
+end

data/lib/tfl_api_client.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 Luke Hackett
+# Copyright (c) 2015 - 2016 Luke Hackett
 #
 # MIT License
 #
@@ -26,6 +26,7 @@
 require 'tfl_api_client/version'
 require 'tfl_api_client/client'
 require 'tfl_api_client/bike_point'
+require 'tfl_api_client/cycle'
 require 'tfl_api_client/exceptions'
 
 module TflApi

data/lib/tfl_api_client/bike_point.rb

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

data/lib/tfl_api_client/client.rb

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

@@ -0,0 +1,66 @@
+#
+# Copyright (c) 2015 - 2016 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 "/CycleSuperhighway" API to obtain
+    # details about the cycle superhighways based upon their IDs.
+    #
+    class Cycle
+
+      # Initialize the Cycle object and store the reference to Client object
+      #
+      # @param client [Client] the client object
+      #
+      # @return [Cycle] the Cycle object
+      #
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns all Cycle Superhighway locations known by the TFL service
+      #
+      # @return [Array] An array of hashes containing all Cycle Superhighways
+      #                 and their details
+      #
+      def superhighways
+        @client.get('/CycleSuperhighway')
+      end
+
+      # Returns the all details known by the TFL service for the given
+      # Cycle Superhighway id.
+      #
+      # @param id [String] the TFL Cycle Superhighway id
+      #
+      # @return [hash] A hash containing the details of the given Cycle Superhighway
+      #
+      def superhighway(id)
+        @client.get("/CycleSuperhighway/#{id}")
+      end
+
+    end
+  end
+end

data/lib/tfl_api_client/exceptions.rb

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

data/lib/tfl_api_client/version.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2015 Luke Hackett
+# Copyright (c) 2015 - 2016 Luke Hackett
 #
 # MIT License
 #
@@ -24,5 +24,5 @@
 #
 
 module TflApi
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/cassettes/cycle/authorised_client_superhighway.yml

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.tfl.gov.uk/CycleSuperhighway/RMP-006?app_id=TFL_APP_ID&app_key=TFL_APP_KEY
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - api.tfl.gov.uk
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type
+      Access-Control-Allow-Methods:
+      - GET,POST,PUT,DELETE,OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Age:
+      - '0'
+      Api-Entity-Payload:
+      - CycleSuperhighway, CycleSuperhighway
+      Cache-Control:
+      - public, must-revalidate, max-age=150, s-maxage=300
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 17 Apr 2016 17:00:44 GMT
+      Server:
+      - Microsoft-IIS/8.5
+      Via:
+      - 1.1 varnish
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Backend:
+      - api
+      X-Backend-Url:
+      - "/CycleSuperhighway/RMP-006"
+      X-Banning:
+      - ''
+      X-Cache:
+      - MISS
+      X-Cacheable:
+      - Yes. Cacheable
+      X-Hash-Url:
+      - "/cyclesuperhighway/rmp-006"
+      X-Ttl:
+      - '300.000'
+      X-Ttl-Rule:
+      - '0'
+      X-Varnish:
+      - 10.73.2.250
+      - '1504412933'
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: ASCII-8BIT
+      string: '{"$id":"1","$type":"Tfl.Api.Presentation.Entities.CycleSuperhighway,
+        Tfl.Api.Presentation.Entities","id":"RMP-006","label":"CS North South - Elephant
+        & Castle to Greville Street","labelShort":"CSNS","geography":{"type":"LineString","coordinates":[[-0.1016,51.49514],[-0.10168,51.49517],[-0.10182,51.49523],[-0.1023,51.49543],[-0.1026,51.49551],[-0.10293,51.4956],[-0.10318,51.49567],[-0.10366,51.49581],[-0.1047297,51.4961447],[-0.1052686,51.4963158],[-0.1058087,51.4965074],[-0.1063538,51.4967403],[-0.1075906,51.4974068],[-0.1068546,51.4976099],[-0.106493,51.4977209],[-0.1061314,51.4978586],[-0.1048004,51.4985484],[-0.1049138,51.4985766],[-0.1049933,51.4986046],[-0.1050337,51.4986272],[-0.105075,51.4986576],[-0.1051059,51.498691],[-0.1051122,51.498705],[-0.1051152,51.498717],[-0.1051141,51.4987296],[-0.1051147,51.4987399],[-0.105112,51.4987473],[-0.1051109,51.4987546],[-0.1051068,51.4987606],[-0.1051063,51.4987652],[-0.1051032,51.4987709],[-0.1051016,51.4987788],[-0.1050984,51.4987818],[-0.1050988,51.4987868],[-0.1050948,51.498792],[-0.1050789,51.4988094],[-0.1050608,51.4988267],[-0.1050373,51.4988457],[-0.1050094,51.4988654],[-0.1049672,51.4988837],[-0.1049192,51.498903],[-0.1048709,51.4989147],[-0.1048106,51.4989234],[-0.10473,51.49892],[-0.10473,51.49903],[-0.10472,51.49932],[-0.1046946,51.499902],[-0.1046846,51.500171],[-0.1046757,51.5003957],[-0.10468,51.50046],[-0.10469,51.50054],[-0.1046943,51.5006183],[-0.1046934,51.5007113],[-0.1046882,51.500814],[-0.10468,51.501],[-0.1046732,51.5012487],[-0.1046579,51.501506],[-0.10465,51.50157],[-0.10463,51.50166],[-0.10461,51.50176],[-0.10461,51.50177],[-0.1046,51.50193],[-0.1046145,51.5021054],[-0.1046246,51.502225],[-0.1046157,51.5025123],[-0.10462,51.5026],[-0.1046127,51.5028394],[-0.104603,51.5031284],[-0.1045911,51.5034178],[-0.1045848,51.503708],[-0.1045848,51.5037463],[-0.1045654,51.504093],[-0.1045457,51.5043787],[-0.10454,51.50454],[-0.1045348,51.5046237],[-0.10453,51.5047],[-0.10453,51.50481],[-0.10452,51.50519],[-0.1045152,51.5054073],[-0.10449,51.5059],[-0.10448,51.5061],[-0.1044843,51.506284],[-0.10449,51.5067],[-0.104492,51.506764],[-0.1044679,51.5069422],[-0.1044437,51.5072042],[-0.1044236,51.5075781],[-0.1044015,51.508086],[-0.1044194,51.5083727],[-0.1044208,51.5084321],[-0.1044183,51.508482],[-0.1044205,51.5085461],[-0.1044012,51.5092205],[-0.1043847,51.5098347],[-0.1043558,51.5105147],[-0.1043694,51.5107926],[-0.1043715,51.5108413],[-0.1043801,51.5108907],[-0.1043851,51.5109507],[-0.1044023,51.5110507],[-0.1044359,51.5112147],[-0.104413,51.5113835],[-0.1041943,51.5117906],[-0.1041979,51.5120463],[-0.1042172,51.5121869],[-0.1042302,51.5122616],[-0.1042452,51.5123462],[-0.1042573,51.5124494],[-0.1042638,51.5124967],[-0.1042652,51.5125547],[-0.1042695,51.5126026],[-0.104268,51.5126507],[-0.1042666,51.5126933],[-0.1042664,51.5127056],[-0.1042699,51.5127296],[-0.1042731,51.5127507],[-0.1042735,51.5127711],[-0.1042738,51.5127897],[-0.1042754,51.5128111],[-0.1042789,51.5128454],[-0.10428,51.51293],[-0.1042879,51.5130073],[-0.10429,51.51307],[-0.10429,51.51315],[-0.10429,51.5132],[-0.1042873,51.513243],[-0.1042889,51.513289],[-0.10429,51.51335],[-0.10429,51.51342],[-0.1042966,51.5134637],[-0.1043,51.51349],[-0.10431,51.51357],[-0.10432,51.51368],[-0.1043254,51.513713],[-0.10433,51.51375],[-0.10434,51.5138],[-0.104363,51.5139217],[-0.1043896,51.5140245],[-0.1044206,51.5141591],[-0.1044815,51.5144837],[-0.1045349,51.5147302],[-0.1045813,51.514942],[-0.1045942,51.5149957],[-0.1046014,51.515032],[-0.10461,51.51506],[-0.10462,51.5151341],[-0.10464,51.51527],[-0.1046764,51.5154187],[-0.104715,51.5155704],[-0.10477,51.51581],[-0.1048097,51.5159961],[-0.10484,51.51618],[-0.1048862,51.5163883],[-0.10493,51.5166],[-0.1049659,51.5167654],[-0.1050011,51.5169557],[-0.10501,51.517],[-0.1050286,51.5170724],[-0.10506,51.51721],[-0.1050991,51.5173857],[-0.10515,51.51757],[-0.1051732,51.5176573],[-0.1051925,51.5177223],[-0.1052188,51.5178431],[-0.10528,51.51812],[-0.10533,51.518355],[-0.1053364,51.5183983],[-0.10534,51.51844],[-0.1053446,51.518545],[-0.10535,51.51861],[-0.1053564,51.5186703],[-0.10537,51.51873],[-0.1053897,51.5188074],[-0.1054071,51.5189274],[-0.1054506,51.5190838],[-0.105526,51.5193523],[-0.1056585,51.5197776]],"crs":{"type":"name","properties":{"name":"EPSG:4326"}}},"segmented":true,"modified":"2016-04-15T16:51:31.177"}'
+    http_version: 
+  recorded_at: Sun, 17 Apr 2016 17:00:43 GMT
+recorded_with: VCR 3.0.1