london-bike-hire-cli 1.3.0 → 1.3.1

data/lib/london_bike_hire_cli.rb

@@ -1,15 +1,20 @@
+module LondonBikeHireCli
+  DEFAULT_SEARCH_LIMIT = 5
+end
+
 require_relative 'london_bike_hire_cli/application'
 require_relative 'london_bike_hire_cli/basic_renderer'
 require_relative 'london_bike_hire_cli/controller'
 require_relative 'london_bike_hire_cli/feed_parser'
 require_relative 'london_bike_hire_cli/geocoding_adapter'
 require_relative 'london_bike_hire_cli/query_response'
-require_relative 'london_bike_hire_cli/spatial_search'
 require_relative 'london_bike_hire_cli/station'
-require_relative 'london_bike_hire_cli/station_adapter'
-require_relative 'london_bike_hire_cli/station_repository'
+require_relative 'london_bike_hire_cli/repository/repo'
+require_relative 'london_bike_hire_cli/repository/in_memory_store_adapter'
+require_relative 'london_bike_hire_cli/repository/station_store'
+require_relative 'london_bike_hire_cli/repository/station_repo'
+require_relative 'london_bike_hire_cli/repository/spatial_search_adapter'
+require_relative 'london_bike_hire_cli/queries/stations_by_name'
+require_relative 'london_bike_hire_cli/queries/stations_near'
+require_relative 'london_bike_hire_cli/station_not_found_error'
 require_relative 'london_bike_hire_cli/version'
-
-module LondonBikeHireCli
-  DEFAULT_SEARCH_LIMIT = 5
-end

data/london-bike-hire-cli.gemspec

@@ -8,10 +8,11 @@ Gem::Specification.new do |spec|
   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.summary       = "A command line interface to London's Bike Hire API."
+  spec.description   = "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.required_ruby_version = '>= 2.0.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/spec/controller_spec.rb

@@ -15,14 +15,14 @@ RSpec.describe LondonBikeHireCli::Controller do
 
   describe '#find_by_id' do
     it 'should request station from repository' do
-      expect(repository).to receive(:find_by_id).with(1)
+      expect(repository).to receive(:find).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)
+        expect(repository).to receive(:find).with(1)
 
         subject.find_by_id('1')
       end
@@ -30,7 +30,7 @@ RSpec.describe LondonBikeHireCli::Controller do
 
     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)
+        allow(repository).to receive(:find).and_raise(LondonBikeHireCli::StationNotFoundError)
 
         expect do
           subject.find_by_id(1)
@@ -41,15 +41,18 @@ RSpec.describe LondonBikeHireCli::Controller do
 
   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')
+      it 'should request stations from repository with query' do
+        expect(repository).to receive(:query) do |arg|
+          expect(arg.search_term).to eq('kings')
+        end
 
         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)
+          # TODO: change this
+          allow(repository).to receive(:query).and_raise(LondonBikeHireCli::StationNotFoundError)
 
           expect do
             subject.where(params: { name: 'kings' })
@@ -60,8 +63,6 @@ RSpec.describe LondonBikeHireCli::Controller do
   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 } }
 
@@ -71,7 +72,7 @@ RSpec.describe LondonBikeHireCli::Controller do
       end
 
       it 'does not process request' do
-        expect(repository).not_to receive(:all)
+        expect(repository).not_to receive(:query)
 
         subject.nearest(params: params)
       end
@@ -80,13 +81,11 @@ RSpec.describe LondonBikeHireCli::Controller do
     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(repository).to receive(:find).and_return(double.as_null_object)
         allow(geocoder).to receive(:geocode).and_return(geocoded_point)
-        allow(spatial_search).to receive(:nearest).and_return([1])
+        allow(repository).to receive(:query)
 
         subject.geocoder = geocoder
-        subject.spatial_service = spatial_search
       end
 
       it 'geocodes search_term via service' do
@@ -95,27 +94,12 @@ RSpec.describe LondonBikeHireCli::Controller do
         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)
+      it 'requests stations from repository by query' do
+        expect(repository).to receive(:query) do |arg|
+          expect(arg.lat).to eq(geocoded_point[:lat])
+          expect(arg.long).to eq(geocoded_point[:long])
+          expect(arg.limit).to eq(LondonBikeHireCli::DEFAULT_SEARCH_LIMIT)
+        end
 
         subject.nearest(params: { search_term: search_term })
       end
@@ -127,49 +111,33 @@ RSpec.describe LondonBikeHireCli::Controller do
         end
 
         it 'does not request stations from repository' do
-          expect(repository).not_to receive(:all)
+          expect(repository).not_to receive(:query)
         end
       end
     end
 
     context 'given a request with id parameter' do
       let(:search_id) { 1 }
+      let(:station) { double('Station', id: 1, position: geocoded_point) }
       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])
+        allow(repository).to receive(:find).and_return(station)
+        allow(repository).to receive(:query)
 
         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)
+        expect(repository).to receive(:find).with(search_id)
 
         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)
+      it 'requests stations from repository by query' do
+        expect(repository).to receive(:query) do |arg|
+          expect(arg.lat).to eq(geocoded_point[:lat])
+          expect(arg.long).to eq(geocoded_point[:long])
+          expect(arg.limit).to eq(LondonBikeHireCli::DEFAULT_SEARCH_LIMIT)
+        end
 
         subject.nearest(params: { id: search_id })
       end

data/spec/feed_parser_spec.rb

@@ -8,35 +8,33 @@ RSpec.describe LondonBikeHireCli::FeedParser do
       expect(subject.fetch).not_to be_nil
     end
 
-    it 'parses expected number of Bike Stations' do
-      results = subject.fetch
-      expect(results.keys.count).to eq(747 + 1)
+    it 'returns query response' do
+      expect(subject.fetch).to be_instance_of(LondonBikeHireCli::QueryResponse)
     end
 
-    it 'has the feed update time' do
+    it 'parses expected number of Bike Stations' do
       results = subject.fetch
-      expect(results).to have_key(:last_update)
+      expect(results.size).to eq(747)
     end
 
-    it 'has integer for all Stations' do
+    it 'has returns array of Stations' do
       results = subject.fetch
-      results.delete(:last_update)
 
-      expect(results.keys).to all(be_an(Integer))
+      # TODO fix the enumerator thing
+      expect(results.map { |s| s }).to all(be_an(LondonBikeHireCli::Station))
     end
 
     it 'has integer for all Station IDs' do
       results = subject.fetch
-      results.delete(:last_update)
-      stations = results.values
-      ids = stations.map(&:id)
+      ids = results.map(&:id)
 
       expect(ids).to all(be_an(Integer))
     end
 
     it 'has parsed date time from feed update time' do
       results = subject.fetch
-      expect(results[:last_update]).to eq(Time.new(2014, 8, 10, 10, 56, 01, '+01:00'))
+      expected_time = Time.new(2014, 8, 10, 10, 56, 01, '+01:00')
+      expect(results.last_update).to eq(expected_time)
     end
   end
 end

data/spec/station_repo_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+RSpec.describe LondonBikeHireCli::Repository::StationRepo do
+  let(:test_datasource) { TestDatasource.new }
+  let(:adapter) { LondonBikeHireCli::Repository::StationStore.new(test_datasource.fetch) }
+  before do
+    LondonBikeHireCli::Repository::Repo.register(adapter)
+  end
+  subject { described_class.new }
+
+  describe '#all' do
+    context 'given feed_parser returns dataset' do
+      it 'should return expected number of results' do
+        results = subject.all
+
+        expect(results.size).to eq(2)
+      end
+    end
+  end
+
+  describe '#find' do
+    context 'given feed_parser returns dataset' do
+      it 'should return expected number of results' do
+        result = subject.find(1)
+
+        expect(result).to be
+      end
+
+      it 'should return expected result' do
+        result = subject.find(1)
+
+        expect(result.name).to eq('test-station-1')
+      end
+
+      context 'given a request for an id that does not exist' do
+        it 'should raise error' do
+          expect do
+            subject.find(99)
+          end.to raise_error
+        end
+      end
+
+      context 'given a request for more than one id' do
+        xit 'should return expected number of results' do
+          results = subject.find(1, 2)
+
+          expect(results.size).to eq(2)
+        end
+      end
+    end
+  end
+
+  describe '#query' do
+    describe 'for stations by name' do
+      let(:query) { LondonBikeHireCli::Queries::StationsByName.new('test-station-1') }
+
+      context 'given feed_parser returns dataset' do
+        it 'should return expected number of results' do
+          results = subject.query(query)
+
+          expect(results.size).to eq(1)
+        end
+
+        it 'should return expected result' do
+          result = subject.query(query).first
+
+          expect(result.name).to eq('test-station-1')
+        end
+
+        context 'given a request for an id that does not exist' do
+          let(:query) { LondonBikeHireCli::Queries::StationsByName.new('foo') }
+
+          it 'should not raise error' do
+            expect do
+              subject.query(query)
+            end.not_to raise_error
+          end
+
+          it 'should return empty array' do
+            expect(subject.query(query).size).to eq(0)
+          end
+        end
+      end
+    end
+
+    describe 'for stations near location' do
+      let(:point) { { lat: 51.50810309, long: -0.12602103 } }
+      let(:query) { LondonBikeHireCli::Queries::StationsNear.new(point[:lat], point[:long], 5) }
+
+      context 'given feed_parser returns dataset' do
+        it 'should return expected number of results' do
+          results = subject.query(query)
+
+          expect(results.size).to eq(2)
+        end
+
+        it 'should return expected result' do
+          result = subject.query(query).first
+
+          expect(result.name).to eq('test-station-2')
+        end
+      end
+    end
+  end
+
+  describe 'integration tests', vcr: { cassette_name: 'feed_xml' } do
+    let(:test_datasource) { LondonBikeHireCli::FeedParser.new }
+
+    describe '#find' do
+      it 'should return expected number of results' do
+        result = subject.find(777)
+
+        expect(result).to be
+      end
+
+      it 'should return expected result' do
+        result = subject.find(777)
+
+        expect(result.name).to eq('Limburg Road, Clapham Common')
+      end
+    end
+
+    describe '#query' do
+      let(:query) { LondonBikeHireCli::Queries::StationsByName.new('kings') }
+
+      it 'should return expected number of results' do
+        results = subject.query(query)
+
+        expect(results.size).to eq(3)
+      end
+
+      it 'should return expected result' do
+        results = subject.query(query)
+        actual_ids = results.map(&:id)
+
+        expect(actual_ids).to include(283, 439, 594)
+      end
+    end
+
+    describe '#all' do
+      it 'should return expected number of results' do
+        results = subject.all
+
+        expect(results.size).to eq(747)
+      end
+    end
+  end
+end

data/spec/support/test_datasource.rb

@@ -1,7 +1,13 @@
 class TestDatasource
   def fetch
+    stations.values
+  end
+
+  private
+
+  def stations
     {
-      1 => TestStation.new(
+      1 => LondonBikeHireCli::Station.new(
                   id: 1,
                   name: 'test-station-1',
                   docks_total: 30,
@@ -9,7 +15,7 @@ class TestDatasource
                   lat: 51.53005939,
                   long: -0.120973687
       ),
-      2 => TestStation.new(
+      2 => LondonBikeHireCli::Station.new(
                   id: 2,
                   name: 'test-station-2',
                   docks_total: 30,
@@ -19,6 +25,4 @@ class TestDatasource
       )
     }
   end
-
-  TestStation = OpenStruct
 end

data/test.rb

@@ -2,5 +2,6 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup
 require 'london_bike_hire_cli'
+require 'byebug'
 
 LondonBikeHireCli::Application.new.run

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: london-bike-hire-cli
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Rob Murray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -243,15 +243,23 @@ files:
 - lib/london_bike_hire_cli.rb
 - lib/london_bike_hire_cli/application.rb
 - lib/london_bike_hire_cli/basic_renderer.rb
+- lib/london_bike_hire_cli/color_helper.rb
 - lib/london_bike_hire_cli/controller.rb
 - lib/london_bike_hire_cli/feed_parser.rb
 - lib/london_bike_hire_cli/geocoding_adapter.rb
+- lib/london_bike_hire_cli/queries/stations_by_name.rb
+- lib/london_bike_hire_cli/queries/stations_near.rb
 - lib/london_bike_hire_cli/query_response.rb
-- lib/london_bike_hire_cli/spatial_search.rb
+- lib/london_bike_hire_cli/repository/in_memory_store_adapter.rb
+- lib/london_bike_hire_cli/repository/repo.rb
+- lib/london_bike_hire_cli/repository/spatial_search_adapter.rb
+- lib/london_bike_hire_cli/repository/station_repo.rb
+- lib/london_bike_hire_cli/repository/station_store.rb
 - lib/london_bike_hire_cli/station.rb
-- lib/london_bike_hire_cli/station_adapter.rb
-- lib/london_bike_hire_cli/station_repository.rb
+- lib/london_bike_hire_cli/station_not_found_error.rb
 - lib/london_bike_hire_cli/version.rb
+- lib/london_bike_hire_cli/views/error.erb
+- lib/london_bike_hire_cli/views/stations.erb
 - london-bike-hire-cli.gemspec
 - spec/controller_spec.rb
 - spec/feed_parser_spec.rb
@@ -259,10 +267,8 @@ files:
 - spec/fixtures/n19ae_geocode.yml
 - spec/fixtures/no_results_geocode.yml
 - spec/geocoding_adapter_spec.rb
-- spec/spatial_search_spec.rb
 - spec/spec_helper.rb
-- spec/station_adapter_spec.rb
-- spec/station_respository_spec.rb
+- spec/station_repo_spec.rb
 - spec/station_spec.rb
 - spec/support/test_datasource.rb
 - spec/support/vcr.rb
@@ -279,7 +285,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -287,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A command line interface to London's Bike Hire API.
@@ -298,10 +304,8 @@ test_files:
 - spec/fixtures/n19ae_geocode.yml
 - spec/fixtures/no_results_geocode.yml
 - spec/geocoding_adapter_spec.rb
-- spec/spatial_search_spec.rb
 - spec/spec_helper.rb
-- spec/station_adapter_spec.rb
-- spec/station_respository_spec.rb
+- spec/station_repo_spec.rb
 - spec/station_spec.rb
 - spec/support/test_datasource.rb
 - spec/support/vcr.rb

data/lib/london_bike_hire_cli/spatial_search.rb

@@ -1,20 +0,0 @@
-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_adapter.rb

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

@@ -1,51 +0,0 @@
-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/spec/spatial_search_spec.rb

@@ -1,27 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe LondonBikeHireCli::SpatialSearch do
-  let(:point_1) { [51.53005939, -0.120973687, 1] }
-  let(:point_2) { [51.50810309, -0.12602103, 2] }
-  let(:datasource) { [point_1, point_2] }
-  subject { described_class.new(datasource) }
-
-  describe '#nearest' do
-    context 'with datasource' do
-      let(:request) { { lat: 51.5309, long: -0.1215 } }
-      it 'returns results ordered by distance' do
-        results = subject.nearest(request)
-
-        expect(results).to eq([1, 2])
-      end
-
-      context 'given a limit request' do
-        it 'returns correct number of results' do
-          results = subject.nearest(request, 1)
-
-          expect(results.size).to eq(1)
-        end
-      end
-    end
-  end
-end