Merge pull request #82 from GIScience/feature/add-snapping-api

Use Snapping endpoint
GIScience · Jul 5, 2024 · 0d235dc · 0d235dc
2 parents e4cd5ac + 2839ae6
commit 0d235dc
Show file tree

Hide file tree

Showing 11 changed files with 226 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,7 @@ This library lets you consume the openrouteservice API in *JavaScript* applicati
 - Geocoding | Reverse Geocoding | Structured Geocoding (powered by Pelias)
 - Isochrones (accessibility)
 - Time-distance matrix
+- Snap (Get the closest point on road network)
 - POIs (points of interest)
 - Elevation (linestring or point)
 - Optimization
@@ -243,6 +244,29 @@ try {
   console.error(await err.response.json())
 }
 ```
+
+### Snap example
+
+```js
+// Add your api_key here
+const Snap = new Openrouteservice.Snap({api_key: "XYZ"})
+
+try {
+  let response = await Snap.calculate({
+    locations: [[8.681495,49.51461],[8.686507,49.41943]],
+    radius: 300,
+    profile: 'driving-car',
+    format: 'json'
+  })
+  // Add your own result handling here
+  console.log("response: ", response)
+
+} catch (err) {
+  console.log("An error occurred: " + err.status)
+  console.error(await err.response.json())
+}
+```
+
 ### Optimization example
 Or consume Optimization API to solve [vehicle routing problems](https://en.wikipedia.org/wiki/Vehicle_routing_problem)
 

diff --git a/dist/ors-js-client.cjs b/dist/ors-js-client.cjs
diff --git a/dist/ors-js-client.cjs.map b/dist/ors-js-client.cjs.map
diff --git a/dist/ors-js-client.js b/dist/ors-js-client.js
diff --git a/dist/ors-js-client.js.map b/dist/ors-js-client.js.map
diff --git a/dist/ors-js-client.umd.cjs b/dist/ors-js-client.umd.cjs
diff --git a/dist/ors-js-client.umd.cjs.map b/dist/ors-js-client.umd.cjs.map
diff --git a/examples/snap.html b/examples/snap.html
@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>ORS-js lib examples</title>
+    <script type="module" src="../dist/ors-js-client.js"></script>
+</head>
+<body>
+<div>
+    <h1>ORS-js lib examples</h1>
+    <section>
+        <h2>Driving car snapping</h2>
+        <div id="driving-car-snap">
+            <script type='module'>
+                import apiKey from './apiKey.js'
+                window.onload = function() {
+                    const node = document.getElementById("driving-car-snap")
+
+                    const Snap = new Openrouteservice.Snap({
+                        api_key: apiKey
+                    })
+
+                    Snap.calculate({
+                        locations: [[8.690958, 49.404662], [8.687868, 49.390139]],
+                        radius: 300,
+                        profile: "driving-car",
+                        format: "json",
+                        api_version: 'v2',
+                    })
+                        .then(function(json) {
+                            // Add your own result handling here
+                            let response = JSON.stringify(json, null, "\t")
+                            console.log(response);
+                            response = response.replace(/(\n)/g, '<br>');
+                            response = response.replace(/(\t)/g, '&nbsp;&nbsp;');
+                            node.innerHTML = "<h3>Response</h3><p>" + response + "</p>";
+                        })
+                        .catch(function(err) {
+                            let response = JSON.stringify(err, null, "\t")
+                            console.error(response);
+                            response = response.replace(/(\n)/g, '<br>');
+                            response = response.replace(/(\t)/g, '&nbsp;&nbsp;');
+                            node.innerHTML = "<h3>Error</h3><p>" + response + "</p>";
+                        })
+                }
+            </script>
+        </div>
+
+    </section>
+</div>
+</body>
+</html>
diff --git a/src/OrsSnap.js b/src/OrsSnap.js
@@ -0,0 +1,16 @@
+import Constants from './constants.js'
+import OrsBase from './OrsBase.js'
+
+class OrsSnap extends OrsBase {
+    constructor(args) {
+        super(args);
+        if (!this.defaultArgs[Constants.propNames.service] && !this.requestArgs[Constants.propNames.service]) {
+            this.defaultArgs[Constants.propNames.service] = 'snap'
+        }
+        if (!args[Constants.propNames.apiVersion]) {
+            this.defaultArgs.api_version = Constants.defaultAPIVersion
+        }
+    }
+}
+
+export default OrsSnap
diff --git a/src/__tests__/OrsSnap.cy.js b/src/__tests__/OrsSnap.cy.js
@@ -0,0 +1,96 @@
+import OrsSnap from '../OrsSnap.js'
+
+const key = Cypress.env('api_key')
+const orsSnap = new OrsSnap({ 'api_key': key })
+
+describe('Snap Test', () => {
+
+    context('construction', () => {
+        it('sets correct service and API version', () => {
+            expect(orsSnap.defaultArgs.service).to.equal('snap')
+            expect(orsSnap.defaultArgs.api_version).to.equal('v2')
+        })
+    })
+
+    context('methods', () => {
+        context('calculate', () => {
+            it('fails without parameters', (done) => {
+                orsSnap.calculate({})
+                    .catch((err) => {
+                        expect(err.status).to.equal(400)
+                        expect(err.message).to.equal('Bad Request')
+                        done()
+                    })
+            })
+
+            it('generates a simple json snap', (done) => {
+                orsSnap.calculate({
+                    locations: [[8.681495,49.51461],[8.686507,49.41943]],
+                    radius: 300,
+                    profile: 'driving-car',
+                    format: 'json'
+                }).then((json) => {
+                    expect(json['locations'].length).to.be.greaterThan(0)
+                    expect(json['locations'][1].location).to.deep.equal([8.686507,49.41943])
+                    expect(json['locations'][1].name).to.be.equal('Werderplatz')
+                    expect(json['locations'][1].snapped_distance).exist
+                    done()
+                })
+            })
+
+            it('snapping point not found for first location', (done) => {
+                orsSnap.calculate({
+                    locations: [[0,0],[8.686507,49.41943]],
+                    radius: 300,
+                    profile: 'driving-car',
+                    format: 'json'
+                }).then((json) => {
+                    expect(json['locations'][0]).to.be.null
+                    expect(json['locations'][1]).to.exist
+                    done()
+                })
+            })
+
+            it('generates a simple geojson snap', (done) => {
+                orsSnap.calculate({
+                    locations: [[8.681495,49.51461],[8.686507,49.41943]],
+                    radius: 300,
+                    profile: 'driving-car',
+                    format: 'geojson'
+                }).then((json) => {
+                    expect(json['features'].length).to.be.greaterThan(0)
+                    expect(json['features'][0].properties.snapped_distance).exist
+                    expect(json['features'][0].properties['source_id']).to.be.equal(0)
+                    done()
+                })
+            })
+
+            it('snapping point not found for first location in geojson', (done) => {
+                orsSnap.calculate({
+                    locations: [[0,0],[8.686507,49.41943]],
+                    radius: 300,
+                    profile: 'driving-car',
+                    format: 'geojson'
+                }).then((geojson) => {
+                    expect(geojson['features'].length).to.be.equal(1)
+                    expect(geojson['features'][0].properties['source_id']).to.be.equal(1)
+                    done()
+                })
+            })
+
+            it('sets customHeaders in request', () => {
+                orsSnap.calculate({
+                    locations: [[8.681495,49.51461],[8.686507,49.41943]],
+                    radius: 300,
+                    profile: 'driving-car',
+                    format: 'json',
+                    customHeaders: {'Accept': 'application/json'}
+                })
+                cy.intercept('GET', 'https://api.openrouteservice.org/snap', (req) => {
+                    expect(req.headers).to.include({'Accept': 'application/json'})
+                })
+            })
+
+        })
+    })
+})
diff --git a/src/index.js b/src/index.js
@@ -5,6 +5,7 @@ import OrsDirections from './OrsDirections.js'
 import OrsPois from './OrsPois.js'
 import OrsElevation from './OrsElevation.js'
 import OrsOptimization from './OrsOptimization.js'
+import OrsSnap from './OrsSnap.js';
 
 const Openrouteservice = {
   Geocode: OrsGeocode,
@@ -13,7 +14,8 @@ const Openrouteservice = {
   Matrix: OrsMatrix,
   Pois: OrsPois,
   Elevation: OrsElevation,
-  Optimization: OrsOptimization
+  Optimization: OrsOptimization,
+  Snap: OrsSnap
 }
 
 // Define Openrouteservice for Node module pattern loaders, including Browserify