Aircraft endpoint

endpoints/aircraft/documentation.md

@@ -0,0 +1,13 @@
+# Icelandic Aircraft Registry
+
+Source: [The Icelandic Transport Authority](https://www.samgongustofa.is/flug/loftfor/loftfaraskra/)
+
+- GET [/aircraft](https://apis.is/aircraft)
+
+Search the Icelandic aircraft registry
+
+| Parameters        | Description                                                           | Example                                                                                    |
+|-------------------|-----------------------------------------------------------------------|-----------------|
+| Search (required) | Aircraft identification, registration number, type, owner or operator | [TF-AAC](https://apis.is/aircraft?search=TF-AAC), [1073](https://apis.is/ship?search=1073) |
+
+---

endpoints/aircraft/index.js

@@ -0,0 +1,85 @@
+/* eslint-disable no-undef */
+/* eslint-disable no-restricted-globals */
+/* eslint-disable prefer-promise-reject-errors */
+const request = require('request')
+const $ = require('cheerio')
+const h = require('apis-helpers')
+const app = require('../../server')
+
+const lookupAircraft = searchStr => new Promise((resolve, reject) => {
+  // Encode searchString so that Icelandic characters will work
+  const searchString = encodeURIComponent(searchStr)
+  const url = `https://www.samgongustofa.is/flug/loftfor/loftfaraskra?aq=${searchString}`
+  request.get({
+    headers: { 'User-Agent': h.browser() },
+    url,
+  }, (error, response, body) => {
+    if (error || response.statusCode !== 200) {
+      reject('www.samgongustofa.is refuses to respond or give back data')
+    }
+
+    const data = $(body)
+    const fieldList = []
+    data.find('.vehicleinfo ul').each((index, element) => {
+      const fields = []
+      $(element).find('li').each((i, el) => {
+        let val
+        if (i < 7) {
+          val = $(el).find('span').text()
+        } else {
+          // i === 7 contains info about aircraft owner
+          // i === 8 contains info about aircraft operator
+          // We'll parse these fields separately
+
+          const text = $(el).find('span').text()
+          const info = text.split(/\s{3,}/g)
+
+          val = {
+            name: info[1],
+            address: info[2],
+            locality: info[3],
+            country: info[4],
+          }
+        }
+
+        fields.push(val)
+      })
+
+      if (fields.length > 0) {
+        fieldList.push(fields)
+      }
+    })
+
+    if (fieldList.length > 0 && fieldList[0].length > 0) {
+      resolve(fieldList.map((fields) => {
+        return {
+          id: fields[0],
+          registrationNumber: parseInt(fields[1], 10),
+          type: fields[2],
+          buildYear: parseInt(fields[3], 10),
+          serialNumber: parseInt(fields[4], 10),
+          maxWeight: parseInt(fields[5], 10),
+          passengers: parseInt(fields[6], 10),
+          owner: fields[7],
+          operator: fields[8],
+        }
+      }))
+    } else {
+      reject(`No aircraft found with the query ${searchStr}`)
+    }
+  })
+})
+
+app.get('/aircraft', (req, res) => {
+  const search = req.query.search || ''
+
+  if (!search) {
+    return res.status(431).json({ error: 'Please provide a valid search string to lookup' })
+  }
+
+  lookupAircraft(search)
+    .then(aircraft => res.cache().json({ results: aircraft }))
+    .catch(error => res.status(500).json({ error }))
+})
+
+module.exports = lookupAircraft

endpoints/aircraft/tests/integration_test.js

@@ -0,0 +1,34 @@
+/* eslint-disable import/extensions */
+const assert = require('assert')
+const request = require('request')
+const helpers = require('../../../lib/test_helpers.js')
+
+describe('aircraft', () => {
+  it('should return an array of objects containing correct fields', (done) => {
+    const fieldsToCheckFor = [
+      'id',
+      'registrationNumber',
+      'type',
+      'buildYear',
+      'serialNumber',
+      'maxWeight',
+      'passengers',
+      'owner',
+      'operator',
+    ]
+    const params = helpers.testRequestParams('/aircraft', { search: '100' })
+    const resultHandler = helpers.testRequestHandlerForFields(done, fieldsToCheckFor)
+    request.get(params, resultHandler)
+  })
+  it('should return a 404 when an aircraft is not found', (done) => {
+    const params = helpers.testRequestParams('/aircraft', { search: 'loftur' })
+    request.get(params, (error, response, body) => {
+      if (error) {
+        return done(error)
+      }
+      const json = JSON.parse(body)
+      assert.equal(json.error, 'No aircraft found with the query \'loftur\'')
+      done()
+    })
+  })
+})