london-bike-hire-cli 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a31585a5f453c569a80dc06e07b7c2ff6fbda20f
+  data.tar.gz: 94dab876d1d9638e36f5d8415246ef0b70dcad0d
+SHA512:
+  metadata.gz: d7b7c87317e34fc58ccbb8e867ffa553662245f07e6c26f2680dfbbc0d471a7db7106d099fd9a7b1ca08206bf3d0c934195874ef7bf59fe2f89d11eae9ddf241
+  data.tar.gz: d954e6c03befdd669094c432ef7a5c1131104f4d88b8526a329c8f6b98dd6ccae1cfcf1c556ecb4453203a77143a14206b6f3bfc0dd3b2016a0963aa676cd400

data/.gitignore

@@ -0,0 +1,35 @@
+*.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/
+/lib/bundler/man/
+/vendor/
+
+# 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/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+addons:
+   code_climate:
+     repo_token: a69242268fba4d9eb660619cd6ed8669ca8c9ae4b55311660b8af822e9187178

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', cmd: 'rspec --color --format doc'  do
+  # watch /lib/ files
+  watch(%r{^lib/(.+)\.rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+)\.rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Robert Murray
+
+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,144 @@
+## London Bike Hire CLI
+
+#### A simple command line interface to London's Bike Hire API.
+
+[![Build Status](https://travis-ci.org/rob-murray/london-bike-hire-cli.svg?branch=master)](https://travis-ci.org/rob-murray/london-bike-hire-cli)
+[![Code Climate](https://codeclimate.com/github/rob-murray/london-bike-hire-cli.png)](https://codeclimate.com/github/rob-murray/london-bike-hire-cli)
+[![Coverage Status](https://coveralls.io/repos/rob-murray/london-bike-hire-cli/badge.png)](https://coveralls.io/r/rob-murray/london-bike-hire-cli)
+[![Dependency Status](https://gemnasium.com/rob-murray/ferver.svg)](https://gemnasium.com/rob-murray/london-bike-hire-cli)
+[![Gem Version](https://badge.fury.io/rb/london-bike-hire-cli.svg)](http://badge.fury.io/rb/london-bike-hire-cli)
+[![Haz Commitz Status](http://haz-commitz.herokuapp.com/repos/rob-murray/london-bike-hire-cli.svg)](http://haz-commitz.herokuapp.com/repos/rob-murray/london-bike-hire-cli)
+
+
+### Description
+
+This gem provides a command line interface to find information about London's Bike Hire stations, it allows you to find stations by name or their ID and retrieve information about the status of a station.
+
+![Boris](boris-on-a-bike_med.jpg?raw=true "Boris Johnson on a bike")
+
+Here's the spec for **London Bike Hire CLI**:
+
+* Find all stations
+* Find nearest station
+* Find by ID
+* Find by by name
+* Display status of stations
+
+
+### Getting started
+
+Using **london-bike-hire-cli** could not be simpler - just install the **london-bike-hire-cli** gem.
+
+```bash
+$ gem install london-bike-hire-cli
+```
+
+
+### Usage
+
+You can run **london-bike-hire-cli** from the command line with just the `lbh` command.
+
+##### Command line help
+
+For a list of arguments just use the `-h` switch.
+
+```bash
+$ lbh -h
+````
+
+##### List all bike stations
+
+List all however-many-hundred bike stations there are. With pagination.
+
+```bash
+$ lbh all
+````
+
+##### Find the nearest bike station
+
+Find a the nearest bike station to the specified type below. This will return five stations.
+
+Available types:
+
+* `search` - Most search terms; such as placename, postcode
+* `id` - An ID of another bike station
+
+```bash
+$ lbh near --{type} {search_value}
+
+# Near by search term
+$ lbh near --search N19AE
+$ lbh near --search 'waterloo station'
+
+# Near another bike station id
+$ lbh near --id 123
+```
+
+**Note:** Don't forget to wrap search term in quotes if it contains spaces.
+
+##### Show status of a bike station by id
+
+Find a Bike station by it's Tfl station ID. This will return one station.
+
+```bash
+$ lbh find --id {id}
+$ lbh find --id 439
+````
+
+##### Find all bike stations by name
+
+Search all bike stations' name attribute for the search value. This will return zero or more results.
+
+```bash
+$ lbh where --{attribute} {search_value}
+$ lbh where --name kings
+````
+
+##### Results
+
+```bash
+$ lbh find --id 439
+>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+Feed updated: 2014-08-12 08:45:01
+>>> Dock
+Id: 439
+Name: Killick Street, Kings Cross
+Lat: 51.5338
+Long: -0.118677
+Temporary: false
+Bikes: 4
+Docks_free: 18
+Docks_total: 22
+Link to map: https://www.google.co.uk/maps/preview/@51.5338,-0.118677,17z
+>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+```
+
+### Contributing
+
+1. Fork it ( https://github.com/rob-murray/london-bike-hire-cli/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+#### Development
+
+Install dependancies
+
+```bash
+$ bundle install --no-deployment
+```
+
+Run test script as entry point to application
+
+```bash
+$ ruby test.rb find --id 439
+```
+
+
+### License
+
+This project is available for use under the MIT software license.
+See LICENSE
+
+The above image is copyright 2015 Getty Images - Getty Images for Santander.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task default: :spec
+task test: :spec
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run application locally from source'
+task :run, [:arg1, :arg2] do |_t, _args|
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+  require 'london-bike-hire-cli'
+
+  LondonBikeHireCli::Application.new.run
+end

data/bin/lbh

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'london_bike_hire_cli'
+
+LondonBikeHireCli::Application.new.run

data/lib/london_bike_hire_cli.rb

@@ -0,0 +1,15 @@
+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/version'
+
+module LondonBikeHireCli
+  DEFAULT_SEARCH_LIMIT = 5
+end

data/lib/london_bike_hire_cli/application.rb

@@ -0,0 +1,71 @@
+require 'commander'
+
+module LondonBikeHireCli
+  class Application
+    include Commander::Methods
+
+    def run
+      program :name, 'London Bike Hire CLI'
+      program :version, LondonBikeHireCli::VERSION
+      program :description, 'A command line interface to the London Bike Hire API.'
+
+      command :find do |c|
+        c.option '--id ID', Integer, 'The Bike station ID'
+        c.syntax = 'find --id {id}'
+        c.description = 'Find by id. The id is the idenitifier given by TFL to each Bike Station.'
+        c.action do |_args, options|
+          controller.find_by_id(options.id)
+        end
+      end
+
+      command :where do |c|
+        c.option '--name NAME', String, 'The name attribute to search'
+        c.syntax = 'where --name {name}'
+        c.description = 'Search all stations by name, include road name or area.'
+        c.action do |_args, options|
+          enable_paging
+
+          controller.where(params: { name: options.name })
+        end
+      end
+
+      command :near do |c|
+        search_opt_message = 'Search term to base search around, can be a placename or postcode.'
+        id_opt_message = 'Search for stations near another station by its ID'
+        description = 'Search for the nearest stations to a point, either from a search term or bike station id.'
+
+        c.option '--search SEARCH_TERM', String, search_opt_message
+        c.option '--id ID', Integer, id_opt_message
+        c.syntax = 'near --search {search_term} --id {id}'
+        c.description = description
+        c.action do |_args, options|
+          enable_paging
+
+          controller.nearest(params: { search_term: options.search, id: options.id })
+        end
+      end
+
+      command :all do |c|
+        c.syntax = 'all'
+        c.description = 'List all stations.'
+        c.action do |_args, _options|
+          enable_paging
+
+          controller.all
+        end
+      end
+
+      run!
+    end
+
+    private
+
+    def controller
+      @controller ||= Controller.new(repository: station_repository)
+    end
+
+    def station_repository
+      @station_repository ||= StationRepository.new(FeedParser.new)
+    end
+  end
+end

data/lib/london_bike_hire_cli/basic_renderer.rb

@@ -0,0 +1,38 @@
+module LondonBikeHireCli
+  class BasicRenderer
+    def initialize(output = STDOUT)
+      @output = output
+    end
+
+    def render(context)
+      output.print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
+      output.print "Feed updated: #{context.time_of_feed}\n"
+
+      context.each do |station|
+        render_station(station)
+      end
+
+      output.print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
+    end
+
+    def render_error(context)
+      output.print ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
+      output.print "Ooops, something went wrong with the query.\n"
+      output.print "The query #{context[:query].inspect}\n"
+      output.print "resulted in error: #{context[:error]}\n"
+      output.print "Try again?\n"
+    end
+
+    private
+
+    attr_reader :output
+
+    def render_station(station)
+      output.print ">>> Dock\n"
+      station.each_pair.each do |attr_name, attr_value|
+        output.print "#{attr_name.capitalize}: #{attr_value}\n"
+      end
+      output.print "Link to map: #{station.map_link}\n"
+    end
+  end
+end

data/lib/london_bike_hire_cli/controller.rb

@@ -0,0 +1,82 @@
+module LondonBikeHireCli
+  class Controller
+    attr_accessor :geocoder, :spatial_service
+
+    def initialize(repository: nil, renderer: default_renderer)
+      @repository = repository
+      @renderer = renderer
+      @geocoder = GeocodingAdapter.new
+    end
+
+    def all
+      results = repository.all
+      renderer.render(results)
+    end
+
+    def find_by_id(id)
+      results = repository.find_by_id(id.to_i)
+      renderer.render(results)
+
+    rescue StationRepository::StationNotFound => e
+      renderer.render_error(query: "find_by_id: #{id}", error: e)
+    end
+
+    def where(params: {})
+      results = repository.find_by_name(params[:name])
+      renderer.render(results)
+
+    rescue StationRepository::StationNotFound => e
+      renderer.render_error(query: "where: #{params}", error: e)
+    end
+
+    def nearest(params: {})
+      unless params[:search_term].nil? ^ params[:id].nil?
+        error = 'Please use either `search_term` or `id` not both.'
+        renderer.render_error(query: "nearest: #{params}", error: error)
+        return
+      end
+
+      if search_term = params[:search_term]
+        geocoded_point = geocoder.geocode(search_term)
+      end
+
+      if search_term = params[:id]
+        begin
+          stations = repository.find_by_id(search_term.to_i)
+        rescue StationRepository::StationNotFound => e
+          renderer.render_error(query: "where: #{params}", error: e)
+          return
+        end
+
+        geocoded_point = stations.first.position
+      end
+
+      unless geocoded_point
+        error = 'Unable to Geocode location.'
+        renderer.render_error(query: "nearest: #{params}", error: error)
+        return
+      end
+
+      init_spatial_service(repository.all)
+      nearest_ids = spatial_service.nearest(geocoded_point)
+
+      results = repository.find_by_id(*nearest_ids)
+      renderer.render(results)
+    end
+
+    private
+
+    attr_reader :repository, :renderer
+
+    def default_renderer
+      BasicRenderer.new
+    end
+
+    def init_spatial_service(all_stations)
+      @spatial_service ||= begin
+        datasource = StationAdapter.new(all_stations).to_triples
+        SpatialSearch.new(datasource)
+      end
+    end
+  end
+end