Merge pull request #4979 from ibi-group/car-hailing-uber

Uber ride hailing

Author: leonardehrenfried

doc-templates/RideHailing.md

@@ -0,0 +1,17 @@
+# Ride hailing services
+
+This sandbox feature allows you to use ride hailing services like Uber.
+
+## Contact Info
+
+- Leonard Ehrenfried, [[email protected]](mailto:[email protected])
+
+## Configuration
+
+In order enable this feature, add a new section `rideHailingServices` in `router-config.json`.
+
+The supported ride-hailing providers are listed below.
+
+### Uber
+
+<!-- INSERT: uber-car-hailing -->

docs/RouteRequest.md

@@ -587,7 +587,7 @@ The unit is cost unit per second of time difference.
 
 **Since version:** `2.1` ∙ **Type:** `enum map of duration` ∙ **Cardinality:** `Optional`   
 **Path:** /routingDefaults   
-**Enum keys:** `not-set` | `walk` | `bike` | `bike-to-park` | `bike-rental` | `scooter-rental` | `car` | `car-to-park` | `car-pickup` | `car-rental` | `flexible`
+**Enum keys:** `not-set` | `walk` | `bike` | `bike-to-park` | `bike-rental` | `scooter-rental` | `car` | `car-to-park` | `car-pickup` | `car-rental` | `car-hailing` | `flexible`
 
 Limit access/egress per street mode.
 
@@ -599,7 +599,7 @@ done because some street modes searches are much more resource intensive than ot
 
 **Since version:** `2.2` ∙ **Type:** `enum map of duration` ∙ **Cardinality:** `Optional`   
 **Path:** /routingDefaults   
-**Enum keys:** `not-set` | `walk` | `bike` | `bike-to-park` | `bike-rental` | `scooter-rental` | `car` | `car-to-park` | `car-pickup` | `car-rental` | `flexible`
+**Enum keys:** `not-set` | `walk` | `bike` | `bike-to-park` | `bike-rental` | `scooter-rental` | `car` | `car-to-park` | `car-pickup` | `car-rental` | `car-hailing` | `flexible`
 
 Limit direct route duration per street mode.
 

docs/RouterConfiguration.md

@@ -35,8 +35,9 @@ A full list of them can be found in the [RouteRequest](RouteRequest.md).
 |-------------------------------------------------------------------------------------------|:---------------------:|---------------------------------------------------------------------------------------------------|:----------:|---------------|:-----:|
 | [configVersion](#configVersion)                                                           |        `string`       | Deployment version of the *router-config.json*.                                                   | *Optional* |               |  2.1  |
 | [requestLogFile](#requestLogFile)                                                         |        `string`       | The path of the log file for the requests.                                                        | *Optional* |               |  2.0  |
-| [streetRoutingTimeout](#streetRoutingTimeout)                                             |       `duration`      | The maximum time a street routing request is allowed to take before returning a timeout.          | *Optional* | `"PT5S"`      |   na  |
+| [streetRoutingTimeout](#streetRoutingTimeout)                                             |       `duration`      | The maximum time a street routing request is allowed to take before returning a timeout.          | *Optional* | `"PT5S"`      |  2.2  |
 | [flex](sandbox/Flex.md)                                                                   |        `object`       | Configuration for flex routing.                                                                   | *Optional* |               |  2.1  |
+| [rideHailingServices](sandbox/RideHailing.md)                                             |       `object[]`      | Configuration for interfaces to external ride hailing services like Uber.                         | *Optional* |               |  2.3  |
 | [routingDefaults](RouteRequest.md)                                                        |        `object`       | The default parameters for the routing query.                                                     | *Optional* |               |  2.0  |
 | timetableUpdates                                                                          |        `object`       | Global configuration for timetable updaters.                                                      | *Optional* |               |  2.2  |
 | [transit](#transit)                                                                       |        `object`       | Configuration for transit searches with RAPTOR.                                                   | *Optional* |               |   na  |
@@ -54,7 +55,7 @@ A full list of them can be found in the [RouteRequest](RouteRequest.md).
 |    [pagingSearchWindowAdjustments](#transit_pagingSearchWindowAdjustments)                |      `duration[]`     | The provided array of durations is used to increase the search-window for the next/previous page. | *Optional* |               |   na  |
 |    [stopTransferCost](#transit_stopTransferCost)                                          | `enum map of integer` | Use this to set a stop transfer cost for the given transfer priority                              | *Optional* |               |  2.0  |
 |    [transferCacheRequests](#transit_transferCacheRequests)                                |       `object[]`      | Routing requests to use for pre-filling the stop-to-stop transfer cache.                          | *Optional* |               |  2.3  |
-| transmodelApi                                                                             |        `object`       | Configuration for the Transmodel GraphQL API.                                                     | *Optional* |               |   na  |
+| transmodelApi                                                                             |        `object`       | Configuration for the Transmodel GraphQL API.                                                     | *Optional* |               |  2.1  |
 |    [hideFeedId](#transmodelApi_hideFeedId)                                                |       `boolean`       | Hide the FeedId in all API output, and add it to input.                                           | *Optional* | `false`       |   na  |
 |    [tracingHeaderTags](#transmodelApi_tracingHeaderTags)                                  |       `string[]`      | Used to group requests when monitoring OTP.                                                       | *Optional* |               |   na  |
 | [updaters](UpdaterConfig.md)                                                              |       `object[]`      | Configuration for the updaters that import various types of data into OTP.                        | *Optional* |               |  1.5  |
@@ -127,7 +128,7 @@ number of transit vehicles used in that itinerary.
 
 <h3 id="streetRoutingTimeout">streetRoutingTimeout</h3>
 
-**Since version:** `na` ∙ **Type:** `duration` ∙ **Cardinality:** `Optional` ∙ **Default value:** `"PT5S"`   
+**Since version:** `2.2` ∙ **Type:** `duration` ∙ **Cardinality:** `Optional` ∙ **Default value:** `"PT5S"`   
 **Path:** / 
 
 The maximum time a street routing request is allowed to take before returning a timeout.
@@ -703,6 +704,14 @@ HTTP headers to add to the request. Any header key, value can be inserted.
         "timeout" : 300000
       }
     }
+  ],
+  "rideHailingServices" : [
+    {
+      "type" : "uber-car-hailing",
+      "clientId" : "secret-id",
+      "clientSecret" : "very-secret",
+      "wheelchairAccessibleRideType" : "car"
+    }
   ]
 }
 ```

docs/SandboxExtension.md

@@ -29,6 +29,7 @@ nearby stops generated by routing via OSM data.
 - [Travel Time (Isochrone & Surface) API](sandbox/TravelTime.md) - Travel Time API
 - [IBI accessibility score](sandbox/IBIAccessibilityScore.md) - IBI accessibility score
 - [Fares](sandbox/Fares.md) - Fare calculation
+- [Ride hailing](sandbox/RideHailing.md) - Ride hailing services like Uber
 
 
 ## Terminology

docs/examples/ibi/portland/otp-config.json

@@ -0,0 +1,6 @@
+{
+  "otpFeatures" : {
+    "SandboxAPILegacyGraphQLApi": true,
+    "VehicleToStopHeuristics": true
+  }
+}

docs/examples/ibi/portland/router-config.json

@@ -12,7 +12,7 @@
     "geoidElevation": true
   },
   "transit": {
-    "maxNumberOfTransfers" : 4
+    "maxNumberOfTransfers": 4
   },
   "updaters": [
     {
@@ -56,5 +56,13 @@
       "sourceType": "gbfs",
       "url": "https://gbfs.spin.pm/api/gbfs/v2/portland"
     }
+  ],
+  "rideHailingServices": [
+    {
+      "type": "uber-car-hailing",
+      "clientId": "${UBER_CLIENT_ID}",
+      "clientSecret": "${UBER_CLIENT_SECRET}",
+      "wheelchairAccessibleRideType": "970ed376-bd33-4ad1-81c5-d2928a347a06"
+    }
   ]
 }

docs/sandbox/RideHailing.md

@@ -0,0 +1,44 @@
+# Ride hailing services
+
+This sandbox feature allows you to use ride hailing services like Uber.
+
+## Contact Info
+
+- Leonard Ehrenfried, [[email protected]](mailto:[email protected])
+
+## Configuration
+
+In order enable this feature, add a new section `rideHailingServices` in `router-config.json`.
+
+The supported ride-hailing providers are listed below.
+
+### Uber
+
+<!-- uber-car-hailing BEGIN -->
+<!-- NOTE! This section is auto-generated. Do not change, change doc in code instead. -->
+
+| Config Parameter             |   Type   | Summary                                                  |  Req./Opt. | Default Value | Since |
+|------------------------------|:--------:|----------------------------------------------------------|:----------:|---------------|:-----:|
+| type = "uber-car-hailing"    |  `enum`  | The type of the service.                                 | *Required* |               |  2.3  |
+| clientId                     | `string` | OAuth client id to access the API.                       | *Required* |               |  2.3  |
+| clientSecret                 | `string` | OAuth client secret to access the API.                   | *Required* |               |  2.3  |
+| wheelchairAccessibleRideType | `string` | The id of the requested wheelchair accessible ride type. | *Required* |               |  2.3  |
+
+
+##### Example configuration
+
+```JSON
+// router-config.json
+{
+  "rideHailingServices" : [
+    {
+      "type" : "uber-car-hailing",
+      "clientId" : "secret-id",
+      "clientSecret" : "very-secret",
+      "wheelchairAccessibleRideType" : "car"
+    }
+  ]
+}
+```
+
+<!-- uber-car-hailing END -->

mkdocs.yml

@@ -105,3 +105,4 @@ nav:
     - Travel Time Isochrones: 'sandbox/TravelTime.md'
     - IBI Accessibility Score: 'sandbox/IBIAccessibilityScore.md'
     - Fares: 'sandbox/Fares.md'
+    - Ride Hailing: 'sandbox/RideHailing.md'

pom.xml

@@ -311,7 +311,6 @@
                     </argLine>
                     <!-- Jenkins needs XML test reports to determine whether the build is stable. -->
                     <disableXmlReport>true</disableXmlReport>
-                    <trimStackTrace>false</trimStackTrace>
                 </configuration>
             </plugin>
             <!-- code coverage report -->

src/client/js/otp/config.js

@@ -350,5 +350,6 @@ otp.config.modes = {
     "FLEX_ACCESS,FLEX_EGRESS,TRANSIT" : _tr('Transit with flex access and egress'),
     //TRANSLATORS: Travel by: mode of transport (Used in selection in Travel Options widgets)
     "FLEX_DIRECT"              : _tr('Direct flex search'),
-    "CARPOOL,WALK"             : _tr("Carpool")
+    "CARPOOL,WALK"             : _tr("Carpool"),
+    "CAR_HAIL,TRANSIT,WALK"    : _tr("Car hailing and transit")
 };