tubeline 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8602b8e17f8e9c65d86a294c114209c8297edd4b
+  data.tar.gz: eb5d69ef644537c210424dc3c225745979ccd060
+SHA512:
+  metadata.gz: be6a730224fb665a7d34fdbb1dd8da67512e25bc5a8e0790fed4532570a492fda4f9082ec9583726ae23502e78b3fb02101abacc1146d44d30272bb6f8b46c62
+  data.tar.gz: 6445df07f63a622a8716f9ed775ddf582e91e199875ebc6297393e7da5119a3ae03482e4511405e2a189cd2c0f0097146281af38507cce01f4aaceec5866bfc3

data/LICENSE

@@ -0,0 +1,2 @@
+code: public domain
+data: check with TFL - http://www.tfl.gov.uk/businessandpartners/syndication/default.aspx

data/README.md

@@ -0,0 +1,55 @@
+# tubeline
+## A super-simple method of accessing the tube status API
+
+```ruby
+
+pp Tubeline.status
+
+{:bakerloo=>
+  {:name=>"Bakerloo",
+   :line_id=>1,
+   :active=>true,
+   :technical=>"DisruptedService",
+   :description=>"Part Closure",
+   :explanation=>
+    "No service Stonebridge Park to Harrow & Wealdstone due to planned engineering work. GOOD SERVICE on the rest of the line. Rail Replacement bus service in operation. "},
+ :central=>
+  {:name=>"Central",
+   :line_id=>2,
+   :active=>true,
+   :technical=>"GoodService",
+   :description=>"Good Service",
+   :explanation=>""},
+ :circle=>
+  {:name=>"Circle",
+   :line_id=>7,
+   :active=>true,
+   :technical=>"GoodService",
+   :description=>"Good Service",
+   :explanation=>""},
+ :district=>
+  {:name=>"District",
+   :line_id=>9,
+   :active=>true,
+   :technical=>"DisruptedService",
+   :description=>"Part Closure",
+   :explanation=>
+    "No service between Turnham Green and Ealing Broadway due to planned engineering work. GOOD SERVICE on the rest of the line."},
+ :hammersmith_and_city=>
+  {:name=>"Hammersmith and City",
+   :line_id=>8,
+   :active=>true,
+   :technical=>"GoodService",
+   :description=>"Good Service",
+   :explanation=>""}
+...
+}
+
+```
+
+### is it finished?
+
+No, this library is under development, and breaking changes is a very real possibility. The features I need:
+
+* caching - every thirty seconds, with a cache key to assist invalidation.
+* branch line status - northern, overground and dlr all have complex lines, so an overall status isn't always relevant.

data/Rakefile

@@ -0,0 +1,174 @@
+# Rakegem - from https://github.com/mojombo/rakegem
+# released under the following license:
+#
+# The MIT License
+#
+# Copyright (c) Tom Preston-Werner
+#
+# 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.
+
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/lib/tubeline.rb

@@ -0,0 +1,30 @@
+require "nokogiri"
+require "net/http"
+
+module Tubeline
+  VERSION = "0.1"
+  STATUS_ENDPOINT = "http://cloud.tfl.gov.uk/TrackerNet/LineStatus"
+
+  def self.status
+    doc = Nokogiri::XML.parse fetch_xml
+
+    doc.css("LineStatus").inject(Hash.new) do |hash, line_status|
+      status = Hash[line_status.css("Status").first.attributes.map{|k, v| [k, v.to_s] }]
+      line = Hash[line_status.css("Line").first.attributes.map{|k, v| [k, v.to_s]}]
+      line_status = Hash[line_status.attributes.map{|k, v| [k, v.to_s] }]
+
+      hash.update(line["Name"].gsub(/\W/, "_").downcase.to_sym => {
+        name: line["Name"],
+        line_id: line["ID"].to_i,
+        active: status["IsActive"] == "true",
+        technical: status["CssClass"],
+        description: status["Description"],
+        explanation: line_status["StatusDetails"]
+      })
+    end
+  end
+
+  def self.fetch_xml
+    Net::HTTP.get URI.parse STATUS_ENDPOINT
+  end
+end

data/test/fixtures/response.xml

@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="utf-8"?>
+<ArrayOfLineStatus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://webservices.lul.co.uk/">
+  <LineStatus ID="0" StatusDetails="No service Stonebridge Park to Harrow &amp; Wealdstone due to planned engineering work. GOOD SERVICE on the rest of the line. Rail Replacement bus service in operation. ">
+    <BranchDisruptions>
+      <BranchDisruption>
+        <StationTo ID="100" Name="Harrow &amp; Wealdstone" />
+        <StationFrom ID="223" Name="Stonebridge Park" />
+      </BranchDisruption>
+    </BranchDisruptions>
+    <Line ID="1" Name="Bakerloo" />
+    <Status ID="PC" CssClass="DisruptedService" Description="Part Closure" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="1" StatusDetails="">
+    <BranchDisruptions />
+    <Line ID="2" Name="Central" />
+    <Status ID="GS" CssClass="GoodService" Description="Good Service" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="10" StatusDetails="">
+    <BranchDisruptions />
+    <Line ID="7" Name="Circle" />
+    <Status ID="GS" CssClass="GoodService" Description="Good Service" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="2" StatusDetails="No service between Turnham Green and Ealing Broadway due to planned engineering work. GOOD SERVICE on the rest of the line.">
+    <BranchDisruptions>
+      <BranchDisruption>
+        <StationTo ID="61" Name="Ealing Broadway" />
+        <StationFrom ID="238" Name="Turnham Green" />
+      </BranchDisruption>
+    </BranchDisruptions>
+    <Line ID="9" Name="District" />
+    <Status ID="PC" CssClass="DisruptedService" Description="Part Closure" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="8" StatusDetails="">
+    <BranchDisruptions />
+    <Line ID="8" Name="Hammersmith and City" />
+    <Status ID="GS" CssClass="GoodService" Description="Good Service" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="4" StatusDetails="">
+    <BranchDisruptions />
+    <Line ID="4" Name="Jubilee" />
+    <Status ID="GS" CssClass="GoodService" Description="Good Service" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="9" StatusDetails="">
+    <BranchDisruptions />
+    <Line ID="11" Name="Metropolitan" />
+    <Status ID="GS" CssClass="GoodService" Description="Good Service" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="5" StatusDetails="">
+    <BranchDisruptions />
+    <Line ID="5" Name="Northern" />
+    <Status ID="GS" CssClass="GoodService" Description="Good Service" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="6" StatusDetails="No service between Hammersmith and Uxbridge / Osterley due to planned engineering work. A rail replacement bus service operates. GOOD SERVICE on the rest of the line.">
+    <BranchDisruptions>
+      <BranchDisruption>
+        <StationTo ID="170" Name="Osterley" />
+        <StationFrom ID="95" Name="Hammersmith" />
+      </BranchDisruption>
+      <BranchDisruption>
+        <StationTo ID="244" Name="Uxbridge" />
+        <StationFrom ID="95" Name="Hammersmith" />
+      </BranchDisruption>
+    </BranchDisruptions>
+    <Line ID="6" Name="Piccadilly" />
+    <Status ID="PC" CssClass="DisruptedService" Description="Part Closure" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="7" StatusDetails="">
+    <BranchDisruptions />
+    <Line ID="3" Name="Victoria" />
+    <Status ID="GS" CssClass="GoodService" Description="Good Service" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="11" StatusDetails="Train service resumes at 06.15hrs Monday.">
+    <BranchDisruptions />
+    <Line ID="12" Name="Waterloo and City" />
+    <Status ID="CS" CssClass="DisruptedService" Description="Planned Closure" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="82" StatusDetails="No service between Clapham Junction and Willesden Junction, no service between New Cross Gate and Crystal Palace / West Croydon. &#xA;No service between Queens Park and Watford Junction due to planned engineering work. GOOD SERVICE on all other routes. Tickets will be accepted on London Underground and London Buses via any reasonable route.">
+    <BranchDisruptions>
+      <BranchDisruption>
+        <StationTo ID="365" Name="Watford Junction" />
+        <StationFrom ID="183" Name="Queen's Park" />
+      </BranchDisruption>
+      <BranchDisruption>
+        <StationTo ID="269" Name="Willesden Junction" />
+        <StationFrom ID="302" Name="Clapham Junction" />
+      </BranchDisruption>
+      <BranchDisruption>
+        <StationTo ID="305" Name="Crystal Palace" />
+        <StationFrom ID="155" Name="New Cross Gate" />
+      </BranchDisruption>
+      <BranchDisruption>
+        <StationTo ID="366" Name="West Croydon" />
+        <StationFrom ID="155" Name="New Cross Gate" />
+      </BranchDisruption>
+    </BranchDisruptions>
+    <Line ID="82" Name="Overground" />
+    <Status ID="PC" CssClass="DisruptedService" Description="Part Closure" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+  <LineStatus ID="81" StatusDetails="No service Bow Church to Stratford due to planned engineering work. GOOD SERVICE on the rest of the line. Rail Replacement bus service in operation Stratford, Pudding Mill Lane, Bow Church.&#xA;London Underground will accept valid tickets via any reasonable route.">
+    <BranchDisruptions>
+      <BranchDisruption>
+        <StationTo ID="224" Name="Stratford" />
+        <StationFrom ID="293" Name="Bow Church" />
+      </BranchDisruption>
+    </BranchDisruptions>
+    <Line ID="81" Name="DLR" />
+    <Status ID="PC" CssClass="DisruptedService" Description="Part Closure" IsActive="true">
+      <StatusType ID="1" Description="Line" />
+    </Status>
+  </LineStatus>
+</ArrayOfLineStatus>

data/test/tubeline_test.rb

@@ -0,0 +1,14 @@
+require "tubeline"
+require "minitest/autorun"
+
+module Tubeline
+  def self.fetch_xml
+    File.read(File.join(File.dirname(__FILE__), "fixtures", "response.xml"))
+  end
+end
+
+class TubelineTest < MiniTest::Unit::TestCase
+  def test_parsing
+    assert_equal Tubeline.status[:central][:technical], "GoodService"
+  end
+end

data/tubeline.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.name              = 'tubeline'
+  s.version           = '0.1'
+  s.date              = '2013-11-17'
+
+  s.summary     = "London Underground status API"
+  s.description = "A ruby library for interacting with the London Underground Tube status API"
+
+  s.authors  = ["Luke Carpenter"]
+  s.email    = 'luke@ghostworks.io'
+  s.homepage = 'https://ghostworks.github.io/tubeline'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_dependency('nokogiri')
+
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.md
+    Rakefile
+    lib/tubeline.rb
+    test/fixtures/response.xml
+    test/tubeline_test.rb
+    tubeline.gemspec
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: tubeline
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Luke Carpenter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby library for interacting with the London Underground Tube status
+  API
+email: luke@ghostworks.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/tubeline.rb
+- test/fixtures/response.xml
+- test/tubeline_test.rb
+- tubeline.gemspec
+homepage: https://ghostworks.github.io/tubeline
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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.0.3
+signing_key: 
+specification_version: 2
+summary: London Underground status API
+test_files: []
+has_rdoc: