london-bike-hire-cli 1.3.0

data/lib/london_bike_hire_cli/feed_parser.rb

@@ -0,0 +1,76 @@
+require 'nokogiri'
+require 'open-uri'
+
+module LondonBikeHireCli
+  class FeedParser
+    TFL_FEED_URL = 'http://www.tfl.gov.uk/tfl/syndication/feeds/cycle-hire/livecyclehireupdates.xml'.freeze
+
+    def fetch
+      params = { 'User-Agent' => 'Mozilla/5.0 (Windows NT 5.1; rv:31.0) Gecko/20100101 Firefox/31.0' }
+      stations_doc = Nokogiri::XML(open(TFL_FEED_URL, params))
+
+      parse_xml(stations_doc)
+    end
+
+    private
+
+    attr_writer :stations
+
+    def parse_xml(xml_doc)
+      stations = {}
+
+      xml_doc.root.elements.each do |node|
+        station = parse_station(node)
+        station_id = station[:id].to_i
+        stations[station_id] = Station.new(station) unless station_id == 0
+      end
+      stations[:last_update] = parse_feed_time(xml_doc)
+
+      stations
+    end
+
+    def parse_feed_time(xml_doc)
+      Time.at xml_doc.root['lastUpdate'].to_i / 1000
+    end
+
+    # <stations lastUpdate="1407153481506" version="2.0">
+    #   <station>
+    #     <id>1</id>
+    #     <name>River Street , Clerkenwell</name>
+    #     <terminalName>001023</terminalName>
+    #     <lat>51.52916347</lat>
+    #     <long>-0.109970527</long>
+    #     <installed>true</installed>
+    #     <locked>false</locked>
+    #     <installDate>1278947280000</installDate>
+    #     <removalDate/>
+    #     <temporary>false</temporary>
+    #     <nbBikes>8</nbBikes>
+    #     <nbEmptyDocks>11</nbEmptyDocks>
+    #     <nbDocks>19</nbDocks>
+    #   </station>
+    #   ...
+    # </stations>
+
+    def parse_station(xml_node)
+      station = {}
+
+      xml_node.elements.each do |node|
+        station[:id] = node.text.to_i if node.node_name.eql? 'id'
+        station[:name] = node.text if node.node_name.eql? 'name'
+        station[:docks_free] = node.text.to_i if node.node_name.eql? 'nbEmptyDocks'
+        station[:docks_total] = node.text.to_i if node.node_name.eql? 'nbDocks'
+        station[:bikes] = node.text.to_i if node.node_name.eql? 'nbBikes'
+        station[:lat] = node.text.to_f if node.node_name.eql? 'lat'
+        station[:long] = node.text.to_f if node.node_name.eql? 'long'
+        station[:temporary] = parse_bool(node.text) if node.node_name.eql? 'temporary'
+      end
+
+      station
+    end
+
+    def parse_bool(value)
+      value == 'true'
+    end
+  end
+end

data/lib/london_bike_hire_cli/geocoding_adapter.rb

@@ -0,0 +1,27 @@
+require 'geocoder'
+
+module LondonBikeHireCli
+  class GeocodingAdapter
+    def geocode(search_term)
+      prepare_results Geocoder.search(search_term)
+    end
+
+    private
+
+    def prepare_results(results)
+      unless results && results.any?
+        return {}
+      end
+
+      first_result_coords = results.first.coordinates
+      result(first_result_coords)
+    end
+
+    def result(coordinates)
+      {
+        lat: coordinates[0],
+        long: coordinates[1]
+      }
+    end
+  end
+end

data/lib/london_bike_hire_cli/query_response.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+
+module LondonBikeHireCli
+  class QueryResponse
+    extend Forwardable
+
+    def_delegators :results, :[], :each, :map, :first, :size
+
+    def initialize(last_update: Time.now, results: [])
+      @last_update = last_update
+      @results = results
+    end
+
+    def time_of_feed
+      last_update.strftime('%Y-%m-%d %H:%M:%S')
+    end
+
+    private
+
+    attr_reader :results, :last_update
+  end
+end

data/lib/london_bike_hire_cli/spatial_search.rb

@@ -0,0 +1,20 @@
+require 'kdtree'
+
+module LondonBikeHireCli
+  class SpatialSearch
+    def initialize(datasource)
+      @stations = Kdtree.new(datasource)
+    end
+
+    # Public: Return the IDs of the nearest n stations
+    # point - a 2d point; { lat: x.x, long: x.x }
+    # limit - The maximum number of results
+    def nearest(point, limit = DEFAULT_SEARCH_LIMIT)
+      stations.nearestk(point[:lat], point[:long], limit)
+    end
+
+    private
+
+    attr_reader :stations
+  end
+end

data/lib/london_bike_hire_cli/station.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+
+module LondonBikeHireCli
+  class Station < OpenStruct
+    def map_link
+      "https://www.google.co.uk/maps/preview/@#{lat},#{long},17z"
+    end
+
+    def position
+      {
+        lat: lat,
+        long: long
+      }
+    end
+  end
+end

data/lib/london_bike_hire_cli/station_adapter.rb

@@ -0,0 +1,19 @@
+module LondonBikeHireCli
+  class StationAdapter
+    def initialize(stations)
+      @stations = stations
+    end
+
+    # Public: Produce array of station triples
+    # E.g. [51.50810309, -0.12602103, 2]
+    # As used by kdtree
+    #
+    def to_triples
+      stations.map { |station| [station.lat, station.long, station.id] }
+    end
+
+    private
+
+    attr_reader :stations
+  end
+end

data/lib/london_bike_hire_cli/station_repository.rb

@@ -0,0 +1,51 @@
+module LondonBikeHireCli
+  class StationRepository
+    class StationNotFound < StandardError; end
+
+    def initialize(datasource)
+      @datasource = datasource
+    end
+
+    def all
+      return_query_obj(stations.values)
+    end
+
+    def find_by_id(*station_ids)
+      if station_ids.size == 1
+        matched_stations = stations[station_ids.first]
+      else
+        matched_stations = stations.values_at(*station_ids)
+      end
+
+      fail StationNotFound unless matched_stations
+
+      return_query_obj(matched_stations)
+    end
+
+    def find_by_name(station_name)
+      search_term = normalize_search_term(station_name)
+      results = stations.select { |_id, station| station.name.downcase.include?(search_term) }
+      return_query_obj(results.values)
+    end
+
+    private
+
+    attr_reader :datasource, :last_update
+
+    def normalize_search_term(input)
+      input.downcase
+    end
+
+    def return_query_obj(results)
+      QueryResponse.new(last_update: last_update, results: Array(results))
+    end
+
+    def stations
+      @stations ||= begin
+        results = datasource.fetch
+        @last_update = results.delete(:last_update)
+        results
+      end
+    end
+  end
+end

data/lib/london_bike_hire_cli/version.rb

@@ -0,0 +1,3 @@
+module LondonBikeHireCli
+  VERSION = '1.3.0'
+end

data/london-bike-hire-cli.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'london_bike_hire_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'london-bike-hire-cli'
+  spec.version       = LondonBikeHireCli::VERSION
+  spec.authors       = ['Rob Murray']
+  spec.email         = ['robmurray17@gmail.com']
+  spec.summary       = %q(A command line interface to London's Bike Hire API.)
+  spec.description   = %q(Find information about London's Bike Hire stations from command line interface.)
+  spec.homepage      = 'https://github.com/rob-murray/london-bike-hire-cli'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard', '~> 2.6'
+  spec.add_development_dependency 'guard-rspec', '~> 4.3'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+
+  spec.add_dependency 'commander', '~> 4.2'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_dependency 'kdtree', '~> 0.3'
+  spec.add_dependency 'geocoder', '~> 1.2'
+end

data/spec/controller_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+RSpec.describe LondonBikeHireCli::Controller do
+  let(:repository) { double }
+  let(:renderer) { double.as_null_object }
+  subject { described_class.new(repository: repository, renderer: renderer) }
+
+  describe '#all' do
+    it 'should request stations from repository' do
+      expect(repository).to receive(:all)
+
+      subject.all
+    end
+  end
+
+  describe '#find_by_id' do
+    it 'should request station from repository' do
+      expect(repository).to receive(:find_by_id).with(1)
+
+      subject.find_by_id(1)
+    end
+
+    context 'given a string argument' do
+      it 'should request station from repository' do
+        expect(repository).to receive(:find_by_id).with(1)
+
+        subject.find_by_id('1')
+      end
+    end
+
+    context 'given repository raising not found error' do
+      it 'does not raise_error' do
+        allow(repository).to receive(:find_by_id).and_raise(LondonBikeHireCli::StationRepository::StationNotFound)
+
+        expect do
+          subject.find_by_id(1)
+        end.not_to raise_error
+      end
+    end
+  end
+
+  describe '#where' do
+    context 'given a request with name parameter' do
+      it 'should request stations from repository' do
+        expect(repository).to receive(:find_by_name).with('kings')
+
+        subject.where(params: { name: 'kings' })
+      end
+
+      context 'given repository raising not found error' do
+        it 'does not raise_error' do
+          allow(repository).to receive(:find_by_name).and_raise(LondonBikeHireCli::StationRepository::StationNotFound)
+
+          expect do
+            subject.where(params: { name: 'kings' })
+          end.not_to raise_error
+        end
+      end
+    end
+  end
+
+  describe '#nearest' do
+    let(:stations) { TestDatasource.new.fetch.values }
+    let(:spatial_search) { double.as_null_object }
+    let(:geocoder) { double.as_null_object }
+    let(:geocoded_point) { { lat: 51.5309584, long: -0.1215387 } }
+
+    context 'given two nearest params' do
+      let(:params) do
+        { search_term: 'foo', id: 99 }
+      end
+
+      it 'does not process request' do
+        expect(repository).not_to receive(:all)
+
+        subject.nearest(params: params)
+      end
+    end
+
+    context 'given a request with search_term parameter' do
+      let(:search_term) { 'N19AE' }
+      before do
+        allow(repository).to receive(:all).and_return(stations)
+        allow(repository).to receive(:find_by_id).and_return(double.as_null_object)
+        allow(geocoder).to receive(:geocode).and_return(geocoded_point)
+        allow(spatial_search).to receive(:nearest).and_return([1])
+
+        subject.geocoder = geocoder
+        subject.spatial_service = spatial_search
+      end
+
+      it 'geocodes search_term via service' do
+        expect(geocoder).to receive(:geocode).with(search_term).and_return(geocoded_point)
+
+        subject.nearest(params: { search_term: search_term })
+      end
+
+      it 'requests all stations from repository' do
+        expect(repository).to receive(:all).and_return(stations)
+
+        subject.nearest(params: { search_term: search_term })
+      end
+
+      it 'passes all stations to spatial search' do
+        subject.spatial_service = nil
+        expect(LondonBikeHireCli::SpatialSearch).to receive(:new).and_return(spatial_search)
+
+        subject.nearest(params: { search_term: search_term })
+      end
+
+      it 'requests nearest ids from geocoded point' do
+        expect(spatial_search).to receive(:nearest).and_return([1])
+
+        subject.nearest(params: { search_term: search_term })
+      end
+
+      it 'retreives stations matched by search' do
+        expect(repository).to receive(:find_by_id).with(1)
+
+        subject.nearest(params: { search_term: search_term })
+      end
+
+      context 'with invalid search' do
+        let(:search_term) { '!' }
+        before do
+          allow(geocoder).to receive(:geocode).and_return(nil)
+        end
+
+        it 'does not request stations from repository' do
+          expect(repository).not_to receive(:all)
+        end
+      end
+    end
+
+    context 'given a request with id parameter' do
+      let(:search_id) { 1 }
+      before do
+        allow(repository).to receive(:all).and_return(stations)
+        allow(repository).to receive(:find_by_id).and_return(double.as_null_object)
+        allow(spatial_search).to receive(:nearest).and_return([1, 2])
+
+        subject.geocoder = geocoder
+        subject.spatial_service = spatial_search
+      end
+
+      it 'requests station from repository' do
+        expect(repository).to receive(:find_by_id).with(search_id)
+
+        subject.nearest(params: { id: search_id })
+      end
+
+      it 'requests all stations from repository' do
+        expect(repository).to receive(:all).and_return(stations)
+
+        subject.nearest(params: { id: search_id })
+      end
+
+      it 'passes all stations to spatial search' do
+        subject.spatial_service = nil
+        expect(LondonBikeHireCli::SpatialSearch).to receive(:new).and_return(spatial_search)
+
+        subject.nearest(params: { id: search_id })
+      end
+
+      it 'requests nearest ids from geocoded point' do
+        expect(spatial_search).to receive(:nearest).and_return([1])
+
+        subject.nearest(params: { id: search_id })
+      end
+
+      it 'retreives stations matched by search' do
+        expect(repository).to receive(:find_by_id).with(1)
+
+        subject.nearest(params: { id: search_id })
+      end
+
+      context 'with invalid search' do
+        let(:search_id) { 999 }
+
+        it 'does not request stations from repository' do
+          expect(repository).not_to receive(:all)
+        end
+      end
+    end
+  end
+end