ldbws 1.0.0

data/doc/js/searcher.js

@@ -0,0 +1,229 @@
+Searcher = function(data) {
+  this.data = data;
+  this.handlers = [];
+}
+
+Searcher.prototype = new function() {
+  // search is performed in chunks of 1000 for non-blocking user input
+  var CHUNK_SIZE = 1000;
+  // do not try to find more than 100 results
+  var MAX_RESULTS = 100;
+  var huid = 1;
+  var suid = 1;
+  var runs = 0;
+
+  this.find = function(query) {
+    var queries = splitQuery(query);
+    var regexps = buildRegexps(queries);
+    var highlighters = buildHilighters(queries);
+    var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
+    var _this = this;
+
+    this.currentSuid = state.n;
+
+    if (!query) return;
+
+    var run = function() {
+      // stop current search thread if new search started
+      if (state.n != _this.currentSuid) return;
+
+      var results =
+        performSearch(_this.data, regexps, queries, highlighters, state);
+      var hasMore = (state.limit > 0 && state.pass < 4);
+
+      triggerResults.call(_this, results, !hasMore);
+      if (hasMore) {
+        setTimeout(run, 2);
+      }
+      runs++;
+    };
+    runs = 0;
+
+    // start search thread
+    run();
+  }
+
+  /*  ----- Events ------  */
+  this.ready = function(fn) {
+    fn.huid = huid;
+    this.handlers.push(fn);
+  }
+
+  /*  ----- Utilities ------  */
+  function splitQuery(query) {
+    return query.split(/(\s+|::?|\(\)?)/).filter(function(string) {
+      return string.match(/\S/);
+    });
+  }
+
+  function buildRegexps(queries) {
+    return queries.map(function(query) {
+      return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
+    });
+  }
+
+  function buildHilighters(queries) {
+    return queries.map(function(query) {
+      return query.split('').map(function(l, i) {
+        return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
+      }).join('');
+    });
+  }
+
+  // function longMatchRegexp(index, longIndex, regexps) {
+  //     for (var i = regexps.length - 1; i >= 0; i--){
+  //         if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
+  //     };
+  //     return true;
+  // }
+
+
+  /*  ----- Mathchers ------  */
+
+  /*
+   * This record matches if the index starts with queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassBeginning(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the longIndex starts with queries[0] and the
+   * longIndex matches all of the regexps
+   */
+  function matchPassLongIndex(index, longIndex, queries, regexps) {
+    if (longIndex.indexOf(queries[0]) != 0) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if the index contains queries[0] and the record
+   * matches all of the regexps
+   */
+  function matchPassContains(index, longIndex, queries, regexps) {
+    if (index.indexOf(queries[0]) == -1) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+  /*
+   * This record matches if regexps[0] matches the index and the record
+   * matches all of the regexps
+   */
+  function matchPassRegexp(index, longIndex, queries, regexps) {
+    if (!index.match(regexps[0])) return false;
+    for (var i=1, l = regexps.length; i < l; i++) {
+      if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
+        return false;
+    };
+    return true;
+  }
+
+
+  /*  ----- Highlighters ------  */
+  function highlightRegexp(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    for (var i=0, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function hltSubstring(string, pos, length) {
+    return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
+  }
+
+  function highlightQuery(info, queries, regexps, highlighters) {
+    var result = createResult(info);
+    var pos = 0;
+    var lcTitle = result.title.toLowerCase();
+
+    pos = lcTitle.indexOf(queries[0]);
+    if (pos != -1) {
+      result.title = hltSubstring(result.title, pos, queries[0].length);
+    }
+
+    result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
+    for (var i=1, l = regexps.length; i < l; i++) {
+      result.title = result.title.replace(regexps[i], highlighters[i]);
+      result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
+    };
+    return result;
+  }
+
+  function createResult(info) {
+    var result = {};
+    result.title = info[0];
+    result.namespace = info[1];
+    result.path = info[2];
+    result.params = info[3];
+    result.snippet = info[4];
+    result.badge = info[6];
+    return result;
+  }
+
+  /*  ----- Searching ------  */
+  function performSearch(data, regexps, queries, highlighters, state) {
+    var searchIndex = data.searchIndex;
+    var longSearchIndex = data.longSearchIndex;
+    var info = data.info;
+    var result = [];
+    var i = state.from;
+    var l = searchIndex.length;
+    var togo = CHUNK_SIZE;
+    var matchFunc, hltFunc;
+
+    while (state.pass < 4 && state.limit > 0 && togo > 0) {
+      if (state.pass == 0) {
+        matchFunc = matchPassBeginning;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 1) {
+        matchFunc = matchPassLongIndex;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 2) {
+        matchFunc = matchPassContains;
+        hltFunc = highlightQuery;
+      } else if (state.pass == 3) {
+        matchFunc = matchPassRegexp;
+        hltFunc = highlightRegexp;
+      }
+
+      for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
+        if (info[i].n == state.n) continue;
+        if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
+          info[i].n = state.n;
+          result.push(hltFunc(info[i], queries, regexps, highlighters));
+          state.limit--;
+        }
+      };
+      if (searchIndex.length <= i) {
+        state.pass++;
+        i = state.from = 0;
+      } else {
+        state.from = i;
+      }
+    }
+    return result;
+  }
+
+  function triggerResults(results, isLast) {
+    this.handlers.forEach(function(fn) {
+      fn.call(this, results, isLast)
+    });
+  }
+}
+

data/doc/table_of_contents.html

@@ -0,0 +1,299 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>Table of Contents - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" class="table-of-contents">
+<main role="main">
+<h1 class="class">Table of Contents - RDoc Documentation</h1>
+
+<h2 id="pages">Pages</h2>
+<ul>
+  <li class="file">
+    <a href="LICENSE.html">LICENSE</a>
+  </li>
+  <li class="file">
+    <a href="README_md.html">README</a>
+
+    <ul>
+      <li><a href="README_md.html#label-ldbws-ruby">ldbws-ruby</a>
+      <li><a href="README_md.html#label-HOWTO">HOWTO</a>
+      <li><a href="README_md.html#label-A+note+about+rate+limiting">A note about rate limiting</a>
+      <li><a href="README_md.html#label-Caveats">Caveats</a>
+    </ul>
+  </li>
+</ul>
+
+<h2 id="classes">Classes and Modules</h2>
+<ul>
+  <li class="module">
+    <a href="Ldbws.html">Ldbws</a>
+  </li>
+  <li class="module">
+    <a href="Ldbws/Request.html">Ldbws::Request</a>
+  </li>
+  <li class="class">
+    <a href="Ldbws/Request/GetDeparturesBoard.html">Ldbws::Request::GetDeparturesBoard</a>
+
+    <ul>
+      <li><a href="Ldbws/Request/GetDeparturesBoard.html#label-Parameters">Parameters</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/Request/GetDeparturesBoardWithDetails.html">Ldbws::Request::GetDeparturesBoardWithDetails</a>
+
+    <ul>
+      <li><a href="Ldbws/Request/GetDeparturesBoardWithDetails.html#label-Parameters">Parameters</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/Request/GetServiceDetails.html">Ldbws::Request::GetServiceDetails</a>
+
+    <ul>
+      <li><a href="Ldbws/Request/GetServiceDetails.html#label-Parameters">Parameters</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/Request/GetStationBoard.html">Ldbws::Request::GetStationBoard</a>
+
+    <ul>
+      <li><a href="Ldbws/Request/GetStationBoard.html#label-Parameters">Parameters</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/Request/GetStationBoardWithDetails.html">Ldbws::Request::GetStationBoardWithDetails</a>
+
+    <ul>
+      <li><a href="Ldbws/Request/GetStationBoardWithDetails.html#label-Parameters">Parameters</a>
+    </ul>
+  </li>
+  <li class="module">
+    <a href="Ldbws/ResponseTypes.html">Ldbws::ResponseTypes</a>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/BaseStationBoard.html">Ldbws::ResponseTypes::BaseStationBoard</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/BaseStationBoard.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/CallingPoint.html">Ldbws::ResponseTypes::CallingPoint</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/CallingPoint.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/Coach.html">Ldbws::ResponseTypes::Coach</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/Coach.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/DepartureItem.html">Ldbws::ResponseTypes::DepartureItem</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/DepartureItem.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/DepartureItemWithDetails.html">Ldbws::ResponseTypes::DepartureItemWithDetails</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/DepartureItemWithDetails.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/DeparturesBoard.html">Ldbws::ResponseTypes::DeparturesBoard</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/DeparturesBoard.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/DeparturesBoardWithDetails.html">Ldbws::ResponseTypes::DeparturesBoardWithDetails</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/DeparturesBoardWithDetails.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/Formation.html">Ldbws::ResponseTypes::Formation</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/Formation.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/LoadingCategory.html">Ldbws::ResponseTypes::LoadingCategory</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/LoadingCategory.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/Location.html">Ldbws::ResponseTypes::Location</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/Location.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/ServiceDetails.html">Ldbws::ResponseTypes::ServiceDetails</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/ServiceDetails.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/ServiceItem.html">Ldbws::ResponseTypes::ServiceItem</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/ServiceItem.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/ServiceItemWithCallingPoints.html">Ldbws::ResponseTypes::ServiceItemWithCallingPoints</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/ServiceItemWithCallingPoints.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/StationBoard.html">Ldbws::ResponseTypes::StationBoard</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/StationBoard.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/StationBoardWithDetails.html">Ldbws::ResponseTypes::StationBoardWithDetails</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/StationBoardWithDetails.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/ResponseTypes/ToiletAvailability.html">Ldbws::ResponseTypes::ToiletAvailability</a>
+
+    <ul>
+      <li><a href="Ldbws/ResponseTypes/ToiletAvailability.html#label-Properties">Properties</a>
+    </ul>
+  </li>
+  <li class="class">
+    <a href="Ldbws/Service.html">Ldbws::Service</a>
+
+    <ul>
+      <li><a href="Ldbws/Service.html#label-Usage+example">Usage example</a>
+      <li><a href="Ldbws/Service.html#label-Side+note">Side note</a>
+    </ul>
+  </li>
+</ul>
+
+<h2 id="methods">Methods</h2>
+<ul>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-c-new">::new</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws.html#method-c-service">::service</a>
+    &mdash;
+    <span class="container">Ldbws</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_arr_board_with_details">#get_arr_board_with_details</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_arr_dep_board_with_details">#get_arr_dep_board_with_details</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_arrival_board">#get_arrival_board</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_arrival_board_with_details">#get_arrival_board_with_details</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_arrival_departure_board">#get_arrival_departure_board</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_arrival_departure_board_with_details">#get_arrival_departure_board_with_details</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_dep_board_with_details">#get_dep_board_with_details</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_departure_board">#get_departure_board</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_departure_board_with_details">#get_departure_board_with_details</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_fastest_departures_with_details">#get_fastest_departures_with_details</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_next_departures">#get_next_departures</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_next_departures_with_details">#get_next_departures_with_details</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+
+  <li class="method">
+    <a href="Ldbws/Service.html#method-i-get_service_details">#get_service_details</a>
+    &mdash;
+    <span class="container">Ldbws::Service</span>
+</ul>
+</main>
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.5.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+

data/ldbws.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "ldbws/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ldbws"
+  spec.summary = "Interface to the Network Rail OpenLDBS web service"
+  spec.license = "MIT"
+
+  spec.authors = "Jon Pearse"
+  spec.email = "hello@jonpearse.net"
+  spec.homepage = "https://github.com/jonpearse/ldbws-ruby"
+
+  spec.version = Ldbws::VERSION
+  spec.files = `git ls-files`.split($\)
+
+  spec.add_dependency "dry-schema", "~> 1.13"
+  spec.add_dependency "faraday", "~> 2.7"
+  spec.add_dependency "nokogiri", "~> 1.14"
+
+  spec.add_development_dependency "rdoc", "~> 6.5.0"
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "rufo", "~> 0.13.0"
+end

data/lib/ldbws/request/base.rb

@@ -0,0 +1,69 @@
+require "dry-schema"
+require "nokogiri"
+
+require "ldbws/utils"
+
+# This module defines specific request types that map 1:1 with corresponding types in the LDBWS service schema. Sadly
+# these are not especially well-documented.
+module Ldbws::Request # :nodoc:
+  # Common schema types for use when validating.
+  module Types # :nodoc:
+    include Dry.Types()
+
+    # A CRS code (eg ‘WAT’ for London Waterloo). These are not exhaustively validated.
+    Crs = String.constrained(size: 3)
+
+    # A specific type used when filtering by CRS.
+    FilterType = String.enum("to", "from")
+  end
+
+  # \Base request type used whem querying LDBWS: provides basic functionality that can be overridden on a per-subclass
+  # basis.
+  class Base # :nodoc:
+    # Creates a Request object given the specified arguments. This performs validation accordng to the request’s schema,
+    # and throws ParamValidationError on failure.
+    #
+    # === Parameters
+    #
+    # args:: a {Hash} cotaining the request’s parameters
+    def initialize(args)
+      params = self.class::SCHEMA.(args)
+      raise ParamValidationError.new(params.errors) if params.errors.any?
+
+      @params = params.to_h
+    end
+
+    # Builds a SOAP request corresponding to the current request.
+    #
+    # === Parameters
+    # xml:: the {Nokogiri Builder}[rdoc-ref:Nokogiri::XML::Builder] object to append XML to.
+    def to_soap(xml)
+      Ldbws::Utils.deep_to_soap(xml, to_soap_params)
+    end
+
+    # Parses the returned SOAP response and converts it into the corresponding {response type}[rdoc-ref:ResponseTypes],
+    # defined in `RESULT_TYPE`.
+    #
+    # === Parameters
+    # xml:: the {XML node}[rdoc-ref:Nokogiri::XML::Node] that should contain the response to this request.
+    def from_soap(xml)
+      result_node = xml.xpath(self.class::RESULT_XPATH).first
+      raise "Oh no" unless result_node
+
+      self.class::RESULT_TYPE.from_xml(result_node)
+    end
+
+    protected
+
+    # Converts the inbound request parameters into something that can be serialised to SOAP, allow per-subclass to
+    # provide specific functionality.
+    #
+    # :yield: a [Hash] of parameters for serialisation to SOAP.
+    def to_soap_params
+      @params
+    end
+  end
+
+  # Represents an error that occurs when request parameters cannot be validated.
+  class ParamValidationError < RuntimeError; end # :nodoc:
+end

data/lib/ldbws/request/get_departures_board.rb

@@ -0,0 +1,54 @@
+require "ldbws/request/base"
+
+require "ldbws/response_types/departures_board"
+
+module Ldbws::Request
+  # Requests a departure board for a station, filtered by departures to one or many other stations. Corresponds to
+  # +GetDeparturesBoardRequest+ in the LDBWS schema.
+  #
+  # === Parameters
+  # crs:: the CRS code of the station you wish to get departures for (required).
+  # filter_list:: a list of CRS codes to filter departures (required).
+  # time_offset:: the offset from the current time—in minutes—to return departure information (optional).
+  # time_window:: how far into the future—relative to +:time_offset+—to return service information for (optional).
+  class GetDeparturesBoard < Base
+    # :nodoc:
+    SCHEMA = Dry::Schema.Params do
+      required(:crs).filled(Types::Crs)
+      required(:filter_list).array(Types::Crs, min_size?: 1)
+      optional(:time_offset).filled(:integer)
+      optional(:time_window).filled(:integer)
+    end
+
+    # :nodoc:
+    RESULT_XPATH = "DeparturesBoard"
+
+    # :nodoc:
+    RESULT_TYPE = Ldbws::ResponseTypes::DeparturesBoard
+
+    # :nodoc:
+    def to_soap_params
+      @params.tap do |params|
+        params[:crs].upcase!
+        params[:filter_list].map! do |value|
+          { crs: value.upcase }
+        end
+      end
+    end
+  end
+
+  # Requests a departure board for a statuion, filtered by departures to one or more other stations. This returns more
+  # information than GetDepartureBoard.
+  #
+  # This corresponds to +GetDeparturesBoardWithDetailsRequest+ in the LDBWS schema.
+  #
+  # === Parameters
+  # crs:: the CRS code of the station you wish to get departures for (required).
+  # filter_list:: a list of CRS codes to filter departures (required).
+  # time_offset:: the offset from the current time—in minutes—to return departure information (optional).
+  # time_window:: how far into the future—relative to +:time_offset+—to return service information for (optional).
+  class GetDeparturesBoardWithDetails < GetDeparturesBoard
+    # :nodoc:
+    RESULT_TYPE = Ldbws::ResponseTypes::DeparturesBoardWithDetails
+  end
+end