tower_bridge_lifts 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b539efb659f1637b3e60c99c07e35b1e9fc0c70
+  data.tar.gz: 9eb11ff0612123417622b655a6ef4e1ee90721c4
+SHA512:
+  metadata.gz: a25aa0e328e6d4775778e01a2533a3c74369db2b32385e2856c6d3f132ba9868463babbe8b3723c91fc9a87b39a6b5e782f305f8969baa771c097db2dafa6291
+  data.tar.gz: 0e71ad2fd65f61e0d98d6bdb20d0372e69c252efb7ac3f616cec59f574e7524245b1dfa3430e4016860c71e98577b6902c14f08dfd79064f9a83017f4072e71d

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,107 @@
+# Tower Bridge Lifts
+
+Provides lift times information, parsed from TowerBridge.org.uk
+
+[missing_demo_link](http://www.github.com)
+
+
+## Description
+This repo was born as I couldn't find an API to access bridge info to another side project and didn't hear back from the official website mantainers.
+It parses data from the official page (http://www.towerbridge.org.uk/lift-times) and makes it available in other formats. 
+
+Bascule and traffic information are inferred from the lift times and might not correspond to reality. 
+(Please ping me if you'd like to collaborate and improve them using computer vision on this live stream
+http://www.ustream.tv/towerbridge  ;-)
+
+
+## Installation
+
+Add it to your application's Gemfile:
+
+```ruby
+gem 'tower_bridge_lifts'
+```
+
+and..
+
+    $ bundle
+
+OR from the command line:
+
+    $ gem install tower_bridge_lifts
+
+## Usage
+
+### IRB or inside your own application:
+
+```ruby
+require 'tower_bridge_lifts'
+
+bridge = TowerBridgeLifts::Base.new
+puts bridge.status
+puts bridge.time
+puts bridge.lifts
+puts bridge.next_lift
+puts bridge.updated
+
+```
+### Command line wrapper: 
+
+```
+$ tblifts --help
+
+Tower Bridge Lifts - provides lift times information, parsed from towerbridge.org.uk
+
+Usage:
+ tblifts [COMMAND] [OPTIONS]
+
+Commands:
+     <none> | lifts      shows all scheduled lifts
+     next | next_lift    shows the next lift only
+     bascules            shows the bascules position
+     time                shows local time (London)
+     traffic             shows traffic status accross the bridge
+     status              shows all above
+     server              serves an api in server mode
+
+Options:
+    -d, --date=date                  filter by date (DD-MM-YY | today | tomorrow)
+    -c, --compact                    shows compact
+    -g, --group                      group lifts by date
+    -l, --lines=num                  lines to display
+
+    -p, --port=port                  sets the port on server mode
+
+    -h, --help                       displays help
+    -v, --version                    displays version
+
+For more info, please visit http://github.com/aaparmeggiani/tower_bridge_lifts
+
+$ tblifts --date=today
+01-Jan-16 Sun 08:00 ⬆︎ A Vessel
+01-Jan-16 Sun 13:00 ⬇︎ Another Vessel
+
+$tblifts --group --lines=2
+01-Jan-16 Sun [2] 08:00 13:00 
+02-Jan-16 Mon [4] 08:00 08:30 12:00 15:00 15:00
+```
+### Server mode: 
+
+tblifts can also operate as a daemon, serving json through RESTful http requests.
+
+```
+$ tblifts server -p 3000
+<tblifts listening on port 3000>
+
+$ curl http://localhost:3000/api/v1/status 
+<json answer>
+```
+API docs + sandbox can be found [here_missing_link](http://github.com). 
+
+## Contributing
+
+Bug reports and pull requests are welcome through this repo.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+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)

data/bin/tblifts

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

data/lib/tower_bridge_lifts.rb

@@ -0,0 +1,13 @@
+
+module TowerBridgeLifts
+    DEBUG = false
+end
+
+require "tower_bridge_lifts/version"
+require "tower_bridge_lifts/base"
+require "tower_bridge_lifts/lift"
+require "tower_bridge_lifts/views"
+require "tower_bridge_lifts/helpers"
+require "tower_bridge_lifts/application"
+require "tower_bridge_lifts/server"
+

data/lib/tower_bridge_lifts/application.rb

@@ -0,0 +1,80 @@
+
+require 'optparse'
+
+module TowerBridgeLifts
+  class Application
+
+    def run
+        options = {}
+        parser = OptionParser.new do |opt|
+        opt.banner = ""
+        opt.separator "Tower Bridge Lifts - provides lift times information, parsed from towerbridge.org.uk"
+        opt.separator ""
+        opt.separator "Usage:"
+        opt.separator " tblifts [COMMAND] [OPTIONS]"
+        opt.separator ""
+        opt.separator "Commands:"
+        opt.separator "     <none> | lifts      shows all scheduled lifts"
+        opt.separator "     next | next_lift    shows the next lift only"
+        opt.separator "     bascules            shows the bascules position"
+        opt.separator "     time                shows local time (London)"
+        opt.separator "     traffic             shows traffic status accross the bridge"
+        opt.separator "     status              shows all above"
+        opt.separator "     server              serves an api in server mode"
+        opt.separator ""
+        opt.separator "Options:"
+
+        opt.on('-d', '--date=date'  , 'filter by date (DD-MM-YY | today | tomorrow)') do |date|
+          date = Time.now.strftime('%d-%m-%y') if date == 'today'
+          date = (Time.now + 24*60*60).strftime('%d-%m-%y') if date == 'tomorrow' 
+          options[:date] = date 
+        end
+        opt.on('-c', '--compact'    , 'shows compact') {options[:compact] = true}
+        opt.on('-g', '--group'      , 'group lifts by date') {options[:group] = true}
+        opt.on('-l', '--lines=num'  , 'lines to display') {|num| options[:count] = num.to_i }
+        opt.separator ""
+        opt.on('-p', '--port=port'  , 'sets the port on server mode') {|port| options[:port] = port.to_i}
+        opt.separator ""
+        opt.on('-h', '--help'       , 'displays help') { puts opt; exit }
+        opt.on('-v', '--version'    , 'displays version') { puts TowerBridgeLifts::VERSION; exit }
+        opt.separator ""
+        opt.separator "For more info, please visit http://github.com/aaparmeggiani/tower_bridge_lifts"
+        opt.separator "" 
+        end
+
+        begin
+          parser.parse!
+        rescue OptionParser::InvalidOption, OptionParser::MissingArgument 
+          puts "#{$!.to_s.capitalize}\n"                                                           
+          exit                                              
+        end 
+
+        if DEBUG
+          puts "command: #{command}"
+          puts "options: #{options}"
+          puts "----"
+        end
+
+        command = case ARGV[0]
+          when nil    then 'lifts'
+          when 'next' then 'next_lift'
+          else ARGV[0]
+        end
+
+        options = {} unless ['lifts', 'server'].include?(command)
+
+        unless Base::ALLOWED_COMMANDS.include?(command)
+          puts "Unknown Command: #{command}"
+          exit
+        end
+
+        if command == 'server'
+          Server.run!(port: options[:port])
+        else
+          puts View.new.render(Base.new, command, options, :txt)
+        end
+
+    end
+  end  
+end
+

data/lib/tower_bridge_lifts/base.rb

@@ -0,0 +1,118 @@
+
+require 'open-uri'
+require 'nokogiri'
+require 'tzinfo'
+
+module TowerBridgeLifts
+  class Base
+    attr_accessor :error, :updated
+    attr_accessor :lifts if ENV['RACK_ENV'] == 'test'
+
+    LIFTS_URL         =   'http://www.towerbridge.org.uk/lift-times/'
+    ALLOWED_COMMANDS  =   %w(lifts next_lift bascules time traffic status server)
+    EXPIRE_TIME       =   60 * 15 
+
+                      # Lift timings (seconds)
+    T_CLEAR_UP   = 60 # time to clear the bridge after the traffic is stopped
+    T_MOVE_UP    = 60 # time to move the bascules up
+    T_UP         = 60 # time the bridge stays open
+    T_MOVE_DOWN  = 60 # time to move the bascules down
+    T_CLEAR_DOWN = 60 # time to clear the bridge before traffic is allowed
+    T_FULL_LIFT  = T_CLEAR_UP + T_MOVE_UP + T_UP + T_MOVE_DOWN + T_CLEAR_DOWN
+    
+    def initialize
+      @tz      = TZInfo::Timezone.get('Europe/London')
+      @lifts   = []
+      @error   = nil
+      @updated = nil
+      fetch
+    end
+
+    def fetch
+      error = nil
+      page = Nokogiri::HTML(open(LIFTS_URL))
+      page.css(('table tbody tr')).each do |line|  
+        td = line.css('td').map{|td| td.text()}  
+        @lifts << Lift.new(
+          timestamp: Time.parse("#{td[1]} #{year?(td[1])} #{td[2]}"),
+          vessel:    td[3],
+          direction: { "Up river" => :up_river, "Down river" => :down_river }[td[4]]
+        )
+      end
+      rescue
+        error = "Unable to fetch data: #{$!}"
+      ensure
+        @error = error
+        @updated = Time.now
+    end
+
+    def expired?
+      Time.now > ( @updated + EXPIRE_TIME)
+    end
+
+    def status
+      { 
+        time:         time,
+        lifts_count:  @lifts.count,
+        next_lift:    next_lift, 
+        bascules:     bascules,
+        traffic:      traffic,
+        updated:      @updated,
+      }
+    end
+
+    def time
+      @tz.now
+    end
+
+    def next_lift
+      return if @lifts.empty?
+      @lifts.find{ |lift| (lift.timestamp + T_FULL_LIFT) >= time }
+    end
+    
+    def bascules
+      return :down unless next_lift
+      t_start = next_lift.timestamp
+      t_end   = t_start + T_FULL_LIFT
+      t_now   = time
+      case 
+        when t_now < t_start + T_CLEAR_UP                                    then :down
+        when t_now >= t_end - T_CLEAR_DOWN                                   then :down
+        when t_now >= t_end - T_CLEAR_DOWN - T_MOVE_DOWN                     then :moving_down 
+        when t_now >= t_end - T_CLEAR_DOWN - T_MOVE_DOWN - T_UP              then :up
+        when t_now >= t_end - T_CLEAR_DOWN - T_MOVE_DOWN - T_UP - T_MOVE_UP  then :moving_up
+      end
+    end
+
+    def traffic
+      return :allowed unless next_lift
+      ( time < self.next_lift.timestamp ) ? :allowed : :blocked 
+    end
+
+    def lifts(options=nil)
+      collection = @lifts
+      return collection if collection.empty? || !options
+      collection = collection.select{|lift| lift.timestamp.strftime('%d-%m-%y') == options[:date] } if options[:date]
+      collection = collection[0...options[:count]] if options[:count]
+      collection = collection.group_by{|lift| lift.date_weekday} if options[:group]
+      collection
+    end
+
+    private
+
+    def year?(str)
+        date = Time.parse(str)
+        now  = time   
+        month_i(date) >= month_i(now) ? year_i(now) : (year_i(now) + 1) 
+    end
+
+    def month_i(ts)
+        ts.strftime('%m').to_i
+    end
+
+    def year_i(ts)
+        ts.strftime('%Y').to_i
+    end
+
+  end
+end

data/lib/tower_bridge_lifts/helpers.rb

@@ -0,0 +1,24 @@
+
+module Helpers
+
+    def table_status
+      @view.render(@tblifts, 'status', {}, :html)
+    end
+
+    def table_lifts
+      @view.render(@tblifts, 'lifts', {}, :html)
+    end
+
+    def table_lifts_compact
+      @view.render(@tblifts, 'lifts', {compact: true}, :html)
+    end
+    
+    def table_lifts_group
+      @view.render(@tblifts, 'lifts', {group: true}, :html)
+    end
+      
+    def table_lifts_group_compact
+      @view.render(@tblifts, 'lifts', {group: true, compact: true}, :html)
+    end
+    
+end

data/lib/tower_bridge_lifts/lift.rb

@@ -0,0 +1,49 @@
+
+module TowerBridgeLifts
+  class Lift
+    attr_accessor :timestamp, :vessel, :direction
+
+    def initialize(timestamp: nil, vessel: nil, direction: nil )
+        raise "Hey!!" if timestamp.nil? 
+        @timestamp, @vessel, @direction = timestamp, vessel, direction
+    end
+
+    def to_s
+      [ date_weekday_time, dir, vessel ].join(' ') 
+    end
+
+    def to_h
+      Hash[ instance_variables.map{|v| [v[1..-1].to_sym, instance_variable_get(v)]} ]
+    end
+
+    def empty?
+      false
+    end
+
+    ### Decorators
+    def date
+      timestamp.strftime('%d-%b-%y')
+    end
+
+    def weekday
+      timestamp.strftime('%a')
+    end
+
+    def time
+      timestamp.strftime('%H:%M') 
+    end
+
+    def date_weekday
+      [date, weekday].join(' ')
+    end
+
+    def date_weekday_time
+      [date, weekday, time].join(' ')
+    end
+
+    def dir
+      { :up_river => "⬆︎", :down_river => "⬇︎" }[@direction]
+    end
+
+  end
+end