tower_bridge_lifts 1.0.0

data/lib/tower_bridge_lifts/server.rb

@@ -0,0 +1,36 @@
+require 'sinatra/base'
+
+module TowerBridgeLifts
+    class Server < Sinatra::Base
+
+      helpers Helpers
+      enable :logging
+      set    :public_folder, 'web'
+    
+      tblifts = Base.new
+      view    = View.new
+
+      get '/' do
+        tblifts.fetch if tblifts.expired?
+        @tblifts = tblifts
+        @view = view
+        erb :index, views: settings.public_folder
+      end
+
+
+      get '/api/v1/:command' do
+        content_type :json
+        command = params['command']
+        options = Rack::Utils.parse_query(request.query_string)
+        options = Hash[ options.map{|k,v| [k.to_sym, (Integer(v) rescue v)]} ]
+
+        if Base::ALLOWED_COMMANDS.include?(command)
+          tblifts.fetch if tblifts.expired?
+          view.render(tblifts, command, options, :json)
+        else 
+          error 404, 'oops'
+        end
+      end
+
+    end
+end

data/lib/tower_bridge_lifts/templates/lifts.erb

@@ -0,0 +1,21 @@
+<table class=tblifts>
+  <thead>
+    <tr>
+      <th>Date</th>                    
+      <th>Day</th>
+      <th>Time</th>
+      <th>Dir</th>
+      <th>Vessel</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% result.each do |lift| %>
+    <tr>
+      <td><%= lift.date %>
+      <td><%= lift.weekday %>
+      <td><%= lift.time %>
+      <td><%= lift.dir %>
+      <td><%= lift.vessel %>
+    </tr>    
+  <% end %>
+</table>

data/lib/tower_bridge_lifts/templates/lifts_compact.erb

@@ -0,0 +1,17 @@
+<table class=tblifts>
+  <thead>
+    <tr>
+      <th>Date</th>                    
+      <th>Day</th>
+      <th>Time</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% result.each do |lift| %>
+    <tr>
+      <td><%= lift.date %>
+      <td><%= lift.weekday %>
+      <td><%= lift.time %>
+    </tr>    
+  <% end %>
+</table>

data/lib/tower_bridge_lifts/templates/lifts_group.erb

@@ -0,0 +1,23 @@
+<table class=tblifts>
+  <thead>
+    <tr>
+      <th>Time</th>
+      <th>Dir</th>
+      <th>Vessel</th>
+    </tr>
+  </thead>
+  <tbody> 
+    <% result.each do |date, lifts| %>
+    <tr>
+      <td colspan=3><%= date %></td>
+    </tr>
+    <% lifts.each do |lift|%>
+    <tr>
+      <td><%= lift.time %></td>
+      <td><%= lift.dir %></td>
+      <td><%= lift.vessel %></td>
+    </tr>
+    <% end %>
+    <% end %>
+  </tbody>
+</table>

data/lib/tower_bridge_lifts/templates/lifts_group_compact.erb

@@ -0,0 +1,20 @@
+<table class=tblifts>
+  <thead>
+    <tr>
+      <th>Date</th>                    
+      <th>Day</th>                    
+      <th><%= result.values.map(&:count).reduce(:+) %></th>
+      <th>Times</th>
+    </tr>
+  </thead>
+  <tbody> 
+    <% result.each do |date, lifts| %>
+    <tr>
+      <td><%= lifts.first.date %></td>
+      <td><%= lifts.first.weekday %></td>
+      <td><%= lifts.count %></td>
+      <td><%= lifts.map(&:time).join('&nbsp'*3) %>
+    </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/tower_bridge_lifts/templates/status.erb

@@ -0,0 +1,9 @@
+<table class=tblifts>
+  <tbody>
+    <% result.each do |field,value| %>
+    <tr>
+      <td><%= field %>
+      <td><%= value %>
+    </tr>    
+  <% end %>
+</table>

data/lib/tower_bridge_lifts/version.rb

@@ -0,0 +1,4 @@
+
+module TowerBridgeLifts
+    VERSION = "1.0.0"
+end

data/lib/tower_bridge_lifts/views.rb

@@ -0,0 +1,114 @@
+
+require 'json'
+require 'erb'
+
+module TowerBridgeLifts
+
+  class View ## Keeping them here instead of separate files
+
+    def render(object, command, options, format)
+      result = object.error || (options.empty? ? object.send(command) : object.send(command, options))
+      view_name = case
+        when object.error                 then 'error'
+        when result.nil? || result == []  then 'empty'
+        when command == 'lifts'           then ( [:lifts] + ([:group, :compact] & options.keys) ).join('_')
+        when true                         then command
+      end
+      self.send(view_name, result, format)
+    end
+  
+  private
+
+
+    def error(result, format)
+      result.to_s
+    end 
+
+    def empty(result, format)
+      msg = 'no lifts scheduled'
+      case format
+        when :txt  then "#{msg}\n"
+        when :json then [msg].to_json
+        when :html then msg
+      end
+    end
+
+    def status(result, format)
+      case format
+        when :txt  then result.map{|k,v| "#{k}: #{v}" }.join("\n")
+        when :json then Hash[result.map{|k,v| [k, v.respond_to?(:to_h) ? v.to_h : v] }].to_json
+        when :html then template(result, 'status.erb')
+      end
+    end
+
+    def time(result, format)
+      case format
+        when :txt  then result
+        when :json then [result].to_json
+        when :html then result
+      end      
+    end
+
+    def next_lift(result, format)
+      case format
+        when :txt  then result
+        when :json then result.to_h.to_json
+        when :html then result
+      end
+    end
+
+    def bascules(result, format)
+      case format
+        when :txt  then result
+        when :json then [result].to_json
+        when :html then result
+      end
+    end
+
+    def traffic(result, format)
+      case format
+        when :txt  then result
+        when :json then [result].to_json
+        when :html then result
+      end
+    end
+
+    def lifts(result, format)
+      case format
+        when :txt  then result.map{ |lift| lift.to_s }.join("\n")
+        when :json then result.map{ |lift| lift.to_h }.to_json
+        when :html then template(result, 'lifts.erb')
+      end 
+    end
+
+    def lifts_compact(result, format)
+      case format
+        when :txt  then result.map{ |lift| lift.date_weekday_time }.join("\n") 
+        when :json then result.map{ |lift| lift.to_h }.to_json
+        when :html then template(result, 'lifts_compact.erb')
+      end
+    end
+
+
+    def lifts_group(result, format)
+      case format
+        when :txt  then result.map{ |k,v| [k] + (v.map{|lift| [[lift.time, lift.dir, lift.vessel].join(' ')] }) + [''] }.join("\n")
+        when :json then Hash[ result.map{|date, lifts| [date, lifts.map(&:to_h)]} ].to_json
+        when :html then template(result, 'lifts_group.erb')
+      end
+    end
+
+    def lifts_group_compact(result, format)
+      case format
+        when :html then template(result, 'lifts_group_compact.erb')
+        else
+          result.map{ |k,v| ([k] + ["[#{v.count}]"] + (v.map{|lift| lift.time})).join(' ') }.join("\n")
+        end
+    end
+
+    def template(result, name)
+      ERB.new(File.read(File.join(__dir__, 'templates', name))).result(binding)
+    end
+
+  end
+end

data/reload

@@ -0,0 +1,4 @@
+#/bin/sh
+gem uninstall tower_bridge_lifts
+gem build tower_bridge_lifts.gemspec
+gem install tower_bridge_lifts-1.0.0.gem

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+ENV['RACK_ENV'] = 'test'
+require 'tower_bridge_lifts'

data/spec/tower_bridge_lifts_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe TowerBridgeLifts do
+  it 'gem has a version number' do
+    expect(TowerBridgeLifts::VERSION).not_to be nil
+  end
+end
+  
+
+describe TowerBridgeLifts::Base do
+  subject(:tbl) { described_class.new }
+
+  it 'instantiates' do
+    expect(tbl).to be_instance_of(described_class)
+    expect(tbl.updated).not_to be_nil
+  end
+
+  it 'has lifts if no errors' do 
+    if tbl.error.nil?
+      expect(tbl.lifts.map).to all(be_a(TowerBridgeLifts::Lift))
+    end
+  end
+
+  it 'has one lift' do
+    lift = TowerBridgeLifts::Lift.new(timestamp: Time.now, vessel: "Vessel Name", direction: :up_river)
+    tbl.lifts = [lift]
+    expect(tbl.lifts.count).to eq(1) 
+  end
+
+end
+
+

data/tower_bridge_lifts.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tower_bridge_lifts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tower_bridge_lifts"
+  spec.version       = TowerBridgeLifts::VERSION
+  spec.authors       = ["Andre Parmeggiani"]
+  spec.email         = ["aaparmeggiani@gmail.com"]
+
+  spec.summary       = "Tower Bridge lift times"
+  spec.description   = "Provides lift times information, parsed from TowerBridge.org.uk"
+  spec.homepage      = "https://github.com/aaparmeggiani/tower_bridge_lifts"
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_dependency 'sinatra', '~> 1.4'
+  spec.add_dependency 'tzinfo', '~> 1.2'
+
+end
+

data/web/apidoc.html

@@ -0,0 +1,87 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8">
+  <title>Tower Bridge Lifts - API</title>
+  <link href='css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
+  <link href='css/reset.css' media='print' rel='stylesheet' type='text/css'/>
+  <link href='css/print.css' media='print' rel='stylesheet' type='text/css'/>
+
+  <script src='lib/object-assign-pollyfill.js' type='text/javascript'></script>
+  <script src='lib/jquery-1.8.0.min.js' type='text/javascript'></script>
+  <script src='lib/jquery.slideto.min.js' type='text/javascript'></script>
+  <script src='lib/jquery.wiggle.min.js' type='text/javascript'></script>
+  <script src='lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
+  <script src='lib/handlebars-4.0.5.js' type='text/javascript'></script>
+  <script src='lib/lodash.min.js' type='text/javascript'></script>
+  <script src='lib/backbone-min.js' type='text/javascript'></script>
+  <script src='swagger-ui.js' type='text/javascript'></script>
+  <script src='lib/highlight.9.1.0.pack.js' type='text/javascript'></script>
+  <script src='lib/highlight.9.1.0.pack_extended.js' type='text/javascript'></script>
+  <script src='lib/jsoneditor.min.js' type='text/javascript'></script>
+  <script src='lib/marked.js' type='text/javascript'></script>
+  <script src='lib/swagger-oauth.js' type='text/javascript'></script>
+
+
+  <script type="text/javascript">
+    $(function () {
+
+      hljs.configure({
+        highlightSizeThreshold: 5000
+      });
+
+
+      window.swaggerUi = new SwaggerUi({
+        url: "/apidoc.yaml",
+        dom_id: "swagger-ui-container",
+        supportedSubmitMethods: ['get', 'post', 'put', 'delete', 'patch'],
+        onComplete: function(swaggerApi, swaggerUi){
+          if(typeof initOAuth == "function") {
+            initOAuth({
+              clientId: "your-client-id",
+              clientSecret: "your-client-secret-if-required",
+              realm: "your-realms",
+              appName: "your-app-name",
+              scopeSeparator: " ",
+              additionalQueryStringParams: {}
+            });
+          }
+
+        },
+        onFailure: function(data) {
+          log("Unable to Load SwaggerUI");
+        },
+        docExpansion: "list",
+        jsonEditor: false,
+        defaultModelRendering: 'schema',
+        showRequestHeaders: false
+      });
+
+      window.swaggerUi.load();
+
+      function log() {
+        if ('console' in window) {
+          console.log.apply(console, arguments);
+        }
+      }
+  });
+  </script>
+</head>
+
+<body class="swagger-section">
+
+  <div class="swagger-ui-wrap">
+    <div id='header'>
+      <div id="api_selector">
+      <a href="/">home</a> |
+      <a href="/apidoc.html">api</a> |
+      <a href="https://github.com/aaparmeggiani/tower_bridge_lifts">github</a>
+      </div>
+    </div>  
+    <div id="swagger-ui-container"></div>
+  </div>
+
+</body>
+</html>

data/web/apidoc.yaml

@@ -0,0 +1,163 @@
+---
+swagger: '2.0'
+info:
+  version: 1.0.0
+  title: Tower Bridge Lifts - API
+  description: |
+
+    Provides lift times information, parsed from [towerbridge.org.uk](http://towerbridge.org.uk/lift-times)  
+    For more info, please visit the project's [github](https://github.com/aaparmeggiani/tower_bridge_lifts) page.
+
+# host:tower-bridge-lifts.herokuapp.com
+basePath: /api/v1
+schemes:
+  - http
+produces:
+  - application/json
+
+paths:
+
+  /status:
+    get:
+      summary: bridge status
+      description: Returns the status of the bridge.
+      responses:
+        200:
+          description: successful operation
+          schema: 
+            $ref: '#/definitions/Status'
+
+  /time:
+    get:
+      summary: current time 
+      description: Current local time in London
+      responses:
+        200: 
+          description: successful operation
+          schema:
+            type: string
+
+  /lifts:  
+    get:
+      summary: all scheduled lifts
+      description: Return all scheduled lifts filtered by the parameters
+      parameters:
+        - name: date
+          in: query
+          description: DD-MM-YY | today | tomorrow
+          type: string
+          format: date
+        - name: count
+          in: query
+          description: Number of lifts to return. 
+          type: integer
+          minimum: 0
+          maximum: 1000
+        - name: group
+          in: query
+          description: unique times grouped by date 
+          type: boolean          
+        - name: compact
+          in: query
+          description: unique times grouped by date 
+          type: boolean
+  
+      responses:
+        200:
+          description: successful operation
+          schema: 
+            title: Lifts
+            type: array
+            items:
+              $ref: '#/definitions/Lift'
+
+  /next_lift:
+    get:
+      summary: the next lift
+      description: Returns the next lift only.
+      responses:
+        200:
+          description: successful operation 
+          schema:
+            $ref: '#/definitions/Lift'
+
+  /bascules:
+    get:
+      summary: bascules position
+      description: Current bascules position [ down | moving_up | up | moving_down ]
+      responses:
+        200:
+          description: successful operation
+          schema:
+            type: string
+            enum:
+              - down
+              - moving_up
+              - up
+              - moving_down
+    
+
+
+  /traffic:
+    get:
+      summary: traffic on the bridge
+      description: Current road/foot traffic on the bridge [ allowed |  blocked ]
+      responses:
+        200: 
+          description: successful operation
+          schema:
+            type: string
+            enum:
+              - allowed
+              - blocked
+
+
+              
+definitions:
+  Lift:
+    type: object
+    properties:
+      timestamp: 
+        type: string
+        example: 2016-01-01T01:02:03
+      vessel:
+        type: string
+        example: Vessel Name
+      direction:
+        type: string
+        enum:
+          - up_river
+          - down_river
+  Status:
+    type: object
+    properties:
+      time:
+        type: string
+        description: local time
+        example: 2016-01-01 01:02:03
+      lifts_count: 
+        type: number
+        description: Number of scheduled lifts
+        example: 12
+      next_lift:
+        type: object
+        description: The next lift details
+        $ref: '#/definitions/Lift'
+      bascules:
+        type: string
+        description: Current bascules position
+        enum:
+          - down
+          - moving_up
+          - up
+          - moving_down
+      traffic:
+        type: string
+        description: Current traffic on the bridge
+        enum:
+          - allowed
+          - blocked
+      updated:
+        type: string
+        description: When this info was last updated
+        example: 2016-01-01 01:02:03