pla 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3629b76b8d19bb0c152b3f9b9d3989fd00704137
+  data.tar.gz: 06f52a128ea81c4081ede4de27cfaea19ea78d0a
+SHA512:
+  metadata.gz: 5ca799e12bd9bc71863da627edd45b81add14739f925aff6b6fc40da8dd2bf0f6eb37a0cea8e9fbe0e7933aa38b2014fd3323c7f95fab77ac00836ef5050e788
+  data.tar.gz: 32004155e0342b737968776277565b8949920887045955d24d06325c80e26f7765d46078441853ad2f4fb0b076fa34036d7b4aaae8c4ce2f420f59a234cf6e6c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'nokogiri'
+gem 'iso_country_codes'
+gem 'rake'
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 jspc
+
+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,33 @@
+PLA
+==
+
+The PLA is the Port of London Authority. It handles ships and shipping into and around the Thames and stuff for London.
+
+It provides ship movement details at it's [website](https://www.pla.co.uk/Port-Trade/Ship-movements/Ship-movements). Unfortunately the information it produces is just awful. There is no good way to handle the order in which comes (it appears to do some kind of ORDER BY on the vessel name field), for instance. Nor anyway to filter the data.
+
+Thus I have written a scraper which will provide hashes of each entry.
+
+This may be then used for filtering or searching or ordering as is fit.
+
+Install
+--
+
+`gem install pla`
+
+Usage
+--
+
+```ruby
+require 'pla'
+
+arrivals = PLA.arrivals
+departures = PLA.departures
+
+puts arrivals
+puts departures
+```
+
+Licence
+--
+
+MIT

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pla"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pla/arrivals.rb

@@ -0,0 +1,7 @@
+require 'pla/movements'
+
+class PLA
+  class Arrivals < Movements
+    set_url 'https://www.pla.co.uk/Port-Trade/Ship-movements/Ship-movements?flag=5'
+  end
+end

data/lib/pla/departures.rb

@@ -0,0 +1,7 @@
+require 'pla/movements'
+
+class PLA
+  class Departures < Movements
+    set_url 'https://www.pla.co.uk/Port-Trade/Ship-movements/Ship-movements?flag=6'
+  end
+end

data/lib/pla/movement.rb

@@ -0,0 +1,73 @@
+require 'iso_country_codes'
+
+require 'pla/ship'
+
+class PLA
+  class Movement
+    def initialize record
+      # Take a movement record from records and do stuff with it
+      @record = record
+    end
+
+    def to_h
+      normalise_timestamp!
+      normalise_ship!
+      normalise_country!
+      normalise_fields!
+
+      @record
+    end
+
+    def normalise_timestamp!
+      # The record format from pla has a 'date' field as dd/mm and a time as 'hhmm'
+      # We'd prefer a combined timestamp in a standard format
+
+      date = @record.delete :date
+      time = @record.delete :time
+      now = DateTime.now
+
+      year = now.year
+      day,month = date.split('/')
+      hour = time[0..1]
+      minute = time[2..3]
+
+      date = gen_date year, month, day, hour, minute
+      if now > date
+        date = gen_date year+1, month, day, hour, minute
+      end
+
+      @record['timestamp'] = date.to_s
+    end
+
+    def normalise_ship!
+      name = @record.delete(:'vessel name')
+      @record['vessel'] = PLA::Ship.new(name).to_h
+    end
+
+    def normalise_country!
+      country_code = @record.delete(:nationality)
+      begin
+        country = IsoCountryCodes.find(country_code).name
+      rescue IsoCountryCodes::UnknownCodeError
+        country = country_code
+      end
+
+      @record[:country] = country
+    end
+
+    def normalise_fields!
+      @record.delete(:at)
+    end
+
+    def gen_date year, month, day, hour, minute
+      # Because the pla doesn't provide a year we run the risk of providing
+      # a date in the past if the data wraps around the end of the year.
+      #
+      # The pla doesn't, luckily, have data years in advance or this'd be proper
+      # fucked
+      DateTime.new(year.to_i, month.to_i, day.to_i, hour.to_i, minute.to_i, 0)
+    end
+
+
+  end
+end

data/lib/pla/movements.rb

@@ -0,0 +1,64 @@
+require 'time'
+require 'nokogiri'
+require 'open-uri'
+
+require 'pla/movement'
+
+class PLA
+  class Movements
+    class << self
+      attr_accessor :url
+      def set_url u
+        @url = u
+      end
+    end
+
+    attr_reader :records, :headers
+
+    def initialize
+      @url = self.class.url
+      @root = 'div.newsMainArea table tr td table tr'  # It gets worse
+
+      @records = []
+      @ships = get_ships_data
+
+      set_headers
+      set_records
+
+      @records
+    end
+
+    def get_ships_data
+      Nokogiri::HTML(open(@url)).css(@root)
+    end
+
+    def set_headers
+      @headers = normalize_and_map(@ships.first.css('th'))
+      @headers[-1] = 'Notes'  # pla returns this as empty. We infer it means notes, though usually it says 'Pilot required'
+    end
+
+    def set_records
+      @ships[1..-1].each do |t|
+        record = {}
+        fields = normalize_and_map(t.css('td'))
+        fields.each_with_index do |f,i|
+          record[ @headers[i].to_sym ] = f
+        end
+
+        movement = PLA::Movement.new(record)
+        @records << movement.to_h
+      end
+    end
+
+    private
+    def normalize_and_map elem
+      # This is a mess- the pla website wraps a date with non-breaking spaces
+      # and some other stuff with normal whitespace. We don't want this because
+      # it is a mess. Thus we convert nbsp chars (ord 160) with spaces (ord 32)
+      # and then allow strip to tidy the rest up.
+
+      nbsp = Nokogiri::HTML("&nbsp;").text
+      elem.map{|c| c.text.gsub(nbsp, ' ').strip.downcase}
+    end
+  end
+end

data/lib/pla/ship.rb

@@ -0,0 +1,14 @@
+class PLA
+  class Ship
+    def initialize ship
+      @name = ship
+    end
+
+    def to_h
+      {
+        name: @name,
+        google: "https://www.google.co.uk/search?q=site:vesselfinder.com #{@name}"
+      }
+    end
+  end
+end

data/lib/pla.rb

@@ -0,0 +1,12 @@
+require 'pla/arrivals'
+require 'pla/departures'
+
+class PLA
+  def self.arrivals
+    PLA::Arrivals.new.records
+  end
+
+  def self.departures
+    PLA::Departures.new.records
+  end
+end

data/pla.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "pla"
+  spec.version       = '0.1.0'
+  spec.authors       = ["jspc"]
+  spec.email         = ["james@zero-internet.org.uk"]
+
+  spec.summary       = 'Scrape and interact with the Port of London Authority Movements list'
+  spec.homepage      = 'https://github.com/jspc/pla'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "iso_country_codes", "0.7.5"
+  spec.add_dependency "nokogiri", "~> 1.6"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: pla
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jspc
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: iso_country_codes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email:
+- james@zero-internet.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pla.rb
+- lib/pla/arrivals.rb
+- lib/pla/departures.rb
+- lib/pla/movement.rb
+- lib/pla/movements.rb
+- lib/pla/ship.rb
+- pla.gemspec
+homepage: https://github.com/jspc/pla
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Scrape and interact with the Port of London Authority Movements list
+test_files: []