tfl_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 072de61d15adb1e4f79ec7e0ab0b3d85d1618fb7
+  data.tar.gz: b06257ef4ec2284db1eb978c5b2372fd7ad38fc2
+SHA512:
+  metadata.gz: cf7b44b929b47a007102911506a007ed293ca585361c6cd697871000e3632c8c8faef938e97e1e5003dde0184dd430a061a37567d9bdf5f3fef16f4dc7af5606
+  data.tar.gz: 72c58429cc1b558c74f77836063000e359c5ea0d50afe83b8dd68dbf04c9753e2d7105b56218cbec2e5cd2a703f3f5f0ae09d004ff0a819025214db8fecb67b0

data/.gitignore

@@ -0,0 +1,37 @@
+# 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

@@ -0,0 +1,29 @@
+language: ruby
+sudo: false
+cache: bundler
+
+rvm:
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+
+before_install:
+  - gem uninstall bundler
+  - gem install bundler --version '~> 1.10'
+
+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/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+
+## v0.1.0  [13-AUG-2015]
+* First Release containing support for the /BikePoint resource.
+
+
+## v0.0.1  [22-JUL-2015]
+* Initial Release containing the barebone project structure.

data/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing to TFL API Client
+
+This project started in order to fill a gap in the current offers for gems 
+that provide a programmatic interface to TFL's API. 
+
+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
+
+[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][] 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][] 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.
+
+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

data/GETTING_STARTED.md

@@ -0,0 +1,161 @@
+# 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
+      ...
+    ]
+```

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tfl_api_client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 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.

data/README.md

@@ -0,0 +1,62 @@
+# Transport for London API Client
+
+This gem aims to provide a simple, programmatic ruby client that allows
+native ruby applications to seamlessly interact with Transport for
+London's live APIs.
+
+[![Build Status](https://travis-ci.org/LukeHackett/tfl_api_client.svg?branch=master)](https://travis-ci.org/LukeHackett/tfl_api_client)
+[![Dependency Status](https://gemnasium.com/LukeHackett/tfl_api_client.svg)](https://gemnasium.com/LukeHackett/tfl_api_client)
+[![Code Climate](https://codeclimate.com/github/LukeHackett/tfl_api_client/badges/gpa.svg)](https://codeclimate.com/github/LukeHackett/tfl_api_client)
+[![Coverage Status](https://coveralls.io/repos/LukeHackett/tfl_api_client/badge.svg?branch=master&service=github)](https://coveralls.io/github/LukeHackett/tfl_api_client?branch=master)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tfl_api_client'
+```
+
+And then install via bundler:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tfl_api_client
+
+
+### Supported Ruby Versions
+
+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.
+
+[getting_started]: GETTING_STARTED.md
+
+
+## Contributing
+
+Check out [CONTRIBUTING.md][contributing] for more information upon 
+contributing.
+
+The TFL API Client gem was originally developed by 
+[Luke Hackett][luke_hackett], and is not an official TFL client.
+
+[contributing]: CONTRIBUTING.md
+[luke_hackett]: http://www.lukehackett.com
+
+
+## License
+
+Transport for London API Client is released under the [MIT License][license].
+
+[licence]: http://www.opensource.org/licenses/MIT
+

data/Rakefile

@@ -0,0 +1,30 @@
+require 'yard'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+
+task default: %w(clean test)
+
+desc "Removes all non-essential project files and folders"
+task :clean do
+  FileUtils.rm_rf 'coverage'
+  FileUtils.rm_rf '.yardoc'
+  FileUtils.rm_rf 'doc'
+end
+
+desc "Runs the project's entire test suite"
+RSpec::Core::RakeTask.new(:test) do |spec|
+  spec.pattern = FileList['spec/*/*.rb']
+end
+
+namespace :test do
+  desc "Runs the project's unit tests"
+  RSpec::Core::RakeTask.new(:unit) do |spec|
+    spec.pattern = FileList['spec/unit/*_spec.rb']
+  end
+
+  desc "Runs the project's integration tests"
+  RSpec::Core::RakeTask.new(:integration) do |spec|
+    spec.pattern = FileList['spec/integration/*_spec.rb']
+  end
+end

data/lib/tfl_api_client/bike_point.rb

@@ -0,0 +1,105 @@
+#
+# Copyright (c) 2015 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 "/BikePoint" API to obtain details
+    # about bike points locations based upon their IDs or by their latitude
+    # and longitude values.
+    #
+    class BikePoint
+
+      # Initialize the BikePoint object and store the reference to Client object
+      #
+      # @param client [Client] the client object
+      #
+      # @return [BikePoint] the BikePoint object
+      #
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns all BikePoint locations known by the TFL service
+      #
+      # @return [Array] An array of hashes containing all BikePoints and their details
+      #
+      def locations
+        @client.get('/BikePoint')
+      end
+
+      # Returns the all details known by the TFL service for the given
+      # BikePoint id.
+      #
+      # @param id [String] the TFL BikePoint id
+      #
+      # @return [hash] A hash containing the details of the given BikePoint
+      #
+      def location(id)
+        @client.get("/BikePoint/#{id}")
+      end
+
+      # Returns all BikePoint locations known by the TFL service within a
+      # particular position or place (a locus).
+      #
+      # @param latitude  [String] the latitude value
+      # @param longitude [String] the longitude value
+      # @param radius    [String] the radius of the area to cover
+      #
+      # @return [Array] An array of hashes containing all BikePoints and their details
+      #
+      def locations_within_locus(latitude, longitude, radius)
+        uri_params = { lat: latitude, lon: longitude, radius: radius }
+        @client.get('/BikePoint', uri_params)
+      end
+
+      # Returns all BikePoint locations known by the TFL service within a the given
+      # box based upon it's defined corner locations.
+      #
+      # @param sw_latitude  [String] the south-west latitude positional value of the bounding box
+      # @param sw_longitude [String] the south-west longitude positional value of the bounding box
+      # @param ne_latitude  [String] the north-east latitude positional value of the bounding box
+      # @param ne_longitude [String] the north-east longitude positional value of the bounding box
+      #
+      # @return [Array] An array of hashes containing all BikePoints and their details
+      #
+      def locations_within_bounding_box(sw_latitude, sw_longitude, ne_latitude, ne_longitude)
+        uri_params = { swLat: sw_latitude, swLon: sw_longitude, neLat: ne_latitude, neLon: ne_longitude }
+        @client.get('/BikePoint', uri_params)
+      end
+
+      # Returns all BikePoint locations known by the TFL service within based upon
+      # the given search query.
+      #
+      # @param query [String] the query term to search for
+      #
+      # @return [Array] An array of hashes containing all BikePoints and their details
+      #
+      def search(query)
+        @client.get('/BikePoint/Search', { query: query })
+      end
+    end
+  end
+end