london_transport 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 758b678ef66589263b8018b8428f8fe63b9ebd31
-  data.tar.gz: 999355165b3879bbec74d62e4079c88adfbeba10
+  metadata.gz: 65927a591dda8b00be0debfb9216c221d4999009
+  data.tar.gz: ee05e0b6a95c602c0750203dab236f1e75448eed
 SHA512:
-  metadata.gz: e5b4683598d905c5b5680f4db58b9b56c77ae511e52906d963a2a19b680d1161c3d804ec01766b0d0b824ab068088ef32ffa8939af5290e0f2f17a94c85f1396
-  data.tar.gz: 883de11c265ac84cb2375c7007d098dec6ef836f99bec0e3cb04c2adf8dc3b898edcafbeb04e7e89db1eb4072603b2fdc5c060dd1ebbeb7c26419643d0d8b39f
+  metadata.gz: 4dcf1599316ab19241f9139dbedf24558f36a719bee8c4d2cc9997b58b484a369460c1732f3e45abfea7ddfe590f3b14ab81f1610f2c403fc566759789df42e9
+  data.tar.gz: c22f17cdc61ef84054643a4532eb5d13c05695e8291957ded16d9a5726f02a871360057695a26c2f369a651284be1d8b24bbc4c144b3197d1fe422707d81481c

data/README.md

@@ -0,0 +1,39 @@
+# London Transport
+A TFL API consumer to turn the TFL API into useful, easy to parse data
+
+## Installation
+Add `gem 'london_transport'` to your gem file `bundle install`
+
+Set the TFL app key and id with:
+
+```ruby
+LondonTransport.app_key = 'your-app-key'
+LondonTransport.app_id = 'your-app-id'
+```
+
+## Usage
+Find the nearest tube stations from a long/lat value:
+
+```ruby
+transport = LondonTransport::Tube.new(longitude: -0.1440493, latitude: 51.5152117)
+```
+
+`transport.stations` will then return an array of the nearest 3 tube stations and their distances (in metres) to this point, within 500m
+
+```ruby
+[
+    [0] {
+        "Oxford Circus Underground Station" => 147.70533261648208
+    },
+    [1] {
+        "Bond Street Underground Station" => 403.48258984823457
+    }
+]
+```
+
+To set the size of the radius, just add radius to the initialisation attributes (radius is in metres):
+`transport = LondonTransport::Tube.new(longitude: -0.1440493, latitude: 51.5152117, radius: 600)`
+
+To return more than 3 stations, simply add the number you want as an argument on the stations method:
+`transport.stations(20)`
+

data/lib/london_transport/base.rb

@@ -0,0 +1,39 @@
+class LondonTransport::Base
+
+  API_ENDPOINT = "https://api.tfl.gov.uk/StopPoint"
+  STOP_TYPES = []
+  MODES = []
+
+  def initialize(longitude:, latitude:, radius: 500)
+    @longitude = longitude
+    @latitude = latitude
+    @radius = radius
+  end
+
+  def stations(limit = 3)
+    distances = []
+    nearest['stopPoints'][0..limit - 1].each do |station|
+      distances << { station['commonName'] => station['distance'] }
+    end
+
+    distances
+  end
+
+  private
+  def api_endpoint
+    URI("#{API_ENDPOINT}?lat=#{@latitude}&lon=#{@longitude}&stopTypes=#{stop_types}&radius=#{@radius}&useStopPointHierarchy=True&returnLines=True&modes=#{modes}&app_id=#{LondonTransport.app_id}&app_key=#{LondonTransport.app_key}")
+  end
+
+  def stop_types
+    @stop_types ||= self.class::STOP_TYPES.join(',')
+  end
+
+  def modes
+    @modes ||= self.class::MODES.join(',')
+  end
+
+  def nearest
+    Oj.load(Net::HTTP.get(api_endpoint))
+  end
+
+end

data/lib/london_transport/bus.rb

@@ -0,0 +1,10 @@
+class LondonTransport::Bus < LondonTransport::Base
+  STOP_TYPES = [
+    "NaptanPublicBusCoachTram",
+    "NaptanBusCoachStation"
+  ]
+
+  MODES = [
+    'bus'
+  ]
+end

data/lib/london_transport/train.rb

@@ -0,0 +1,11 @@
+class LondonTransport::Train < LondonTransport::Base
+  STOP_TYPES = [
+    "NaptanRailStation"
+  ]
+
+  MODES = [
+    'overground',
+    'national-rail',
+    'tflrail'
+  ]
+end

data/lib/london_transport/tube.rb

@@ -0,0 +1,9 @@
+class LondonTransport::Tube < LondonTransport::Base
+  STOP_TYPES = [
+    "NaptanMetroStation"
+  ]
+
+  MODES = [
+    'tube'
+  ]
+end

data/lib/london_transport/version.rb

@@ -0,0 +1,3 @@
+module LondonTransport
+  VERSION = '0.0.3'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: london_transport
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Edwin Wills
@@ -72,7 +72,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/london_transport.rb
+- lib/london_transport/base.rb
+- lib/london_transport/bus.rb
+- lib/london_transport/train.rb
+- lib/london_transport/tube.rb
+- lib/london_transport/version.rb
 homepage: http://rubygems.org/gems/london_transport
 licenses:
 - MIT