🐳 1.0.0, initial version

metowolf · metowolf · commit cff081681c0e · 2020-07-11T15:57:53.000Z
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,15 @@
+.git
+node_modules
+npm-debug.log
+*.md
+test
+docs
+Dockerfile
+coverage
+LICENSE
+.eslintrc
+.gitignore
+.nvmrc
+
+.env*
+.editorconfig
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,15 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+insert_final_newline = false
+trim_trailing_whitespace = false
diff --git a/.env b/.env
@@ -0,0 +1,2 @@
+HTTP_PORT=3000
+HTTP_HOST=0.0.0.0
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+
+.env.local
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,21 @@
+FROM node:14-alpine
+
+LABEL maintainer="i@i-meto.com"
+
+ENV NODE_ENV=production
+
+EXPOSE 3000
+
+# Run as an unprivileged user.
+RUN addgroup -S webapp && adduser -S -G webapp webapp
+RUN mkdir /app && chown webapp /app
+USER webapp
+
+WORKDIR /app
+ENTRYPOINT ["yarn", "start"]
+
+COPY package.json yarn.lock /app/
+
+RUN yarn
+
+COPY . .
diff --git a/LICENSES b/LICENSES
diff --git a/package.json b/package.json
@@ -0,0 +1,28 @@
+{
+  "name": "docker-ipdb",
+  "version": "1.0.0",
+  "main": "server.js",
+  "repository": "git@github.com:metowolf/docker-ipdb.git",
+  "author": "metowolf <i@i-meto.com>",
+  "license": "MIT",
+  "scripts": {
+    "dev": "nodemon server.js"
+  },
+  "dependencies": {
+    "@ipdb/database": "^2019.7.3",
+    "@ipdb/range": "^0.1.1",
+    "dotenv-flow": "^3.2.0",
+    "ipdb": "^0.3.3",
+    "koa": "^2.13.0",
+    "koa-helmet": "^5.2.0",
+    "koa-pino-logger": "^3.0.0",
+    "koa-router": "^9.1.0",
+    "koa2-cors": "^2.0.6",
+    "pino": "^6.3.2",
+    "pino-pretty": "^4.0.0",
+    "qqwry.ipdb": "^2020.7.5"
+  },
+  "devDependencies": {
+    "nodemon": "^2.0.4"
+  }
+}
diff --git a/server.js b/server.js
@@ -0,0 +1,6 @@
+const config = require('./src/config')
+const { logger } = require('./src/middleware/logger')
+const app = require('./src/app')
+
+app.listen(config.http.port, config.http.host)
+logger.info(`Running on port: ${config.http.port}`)
diff --git a/src/app.js b/src/app.js
@@ -0,0 +1,36 @@
+const cors = require('koa2-cors')
+const helmet = require('koa-helmet')
+const Koa = require('koa')
+const { requestLogger } = require('./middleware/logger')
+const { responseTime, errors } = require('./middleware')
+const { v1 } = require('./services')
+
+const app = new Koa()
+
+// disable console.errors for pino
+app.silent = true
+
+// Error handler
+app.use(errors)
+
+// HTTP header security
+app.use(helmet())
+
+// Enable CORS for all routes
+app.use(cors({
+  origin: '*',
+  allowMethods: ['GET', 'POST', 'PATCH', 'DELETE'],
+  allowHeaders: ['Content-Type', 'Accept'],
+  exposeHeaders: ['x-api-response-time']
+}))
+
+// Set header with API response time
+app.use(responseTime)
+
+// Request logging
+app.use(requestLogger)
+
+// V1 routes
+app.use(v1.routes())
+
+module.exports = app
diff --git a/src/config.js b/src/config.js
@@ -0,0 +1,8 @@
+require('dotenv-flow').config()
+
+module.exports = {
+  http: {
+    port: parseInt(process.env.HTTP_PORT || 3000, 10),
+    host: process.env.HTTP_HOST || 'localhost'
+  }
+}
diff --git a/src/middleware/errors.js b/src/middleware/errors.js
@@ -0,0 +1,19 @@
+/**
+ * Error handler middleware
+ *
+ * @param   {Object}    ctx       Koa context
+ * @param   {function}  next      Koa next function
+ * @returns {void}
+ */
+module.exports = async (ctx, next) => {
+  try {
+    await next()
+  } catch (err) {
+    if (err.kind === 'ObjectId') {
+      err.status = 404
+    } else {
+      ctx.status = err.status || 500
+      ctx.body = err.message
+    }
+  }
+}
diff --git a/src/middleware/index.js b/src/middleware/index.js
@@ -0,0 +1,6 @@
+/**
+ * Export middleware
+ */
+module.exports.errors = require('./errors')
+module.exports.responseTime = require('./response-time')
+module.exports.logger = require('./logger')
diff --git a/src/middleware/logger.js b/src/middleware/logger.js
@@ -0,0 +1,20 @@
+const koaPino = require('koa-pino-logger')
+const pino = require('pino')
+
+const devOpts = {
+  prettyPrint: true
+}
+
+let requestLog
+let logger
+
+if (process.env.NODE_ENV === 'production') {
+  requestLog = koaPino()
+  logger = pino()
+} else {
+  requestLog = koaPino(devOpts)
+  logger = pino(devOpts)
+}
+
+module.exports.requestLogger = requestLog
+module.exports.logger = logger
diff --git a/src/middleware/response-time.js b/src/middleware/response-time.js
@@ -0,0 +1,13 @@
+/**
+ * Return header with response time
+ *
+ * @param   {Object}    ctx   Koa context
+ * @param   {Function}  next  Next middleware
+ * @returns {Promise}
+ */
+module.exports = async (ctx, next) => {
+  const start = Date.now()
+  await next()
+  const ms = Date.now() - start
+  ctx.set('x-api-response-time', `${ms}ms`)
+}
diff --git a/src/services/index.js b/src/services/index.js
@@ -0,0 +1 @@
+module.exports.v1 = require('./v1')
diff --git a/src/services/v1/index.js b/src/services/v1/index.js
@@ -0,0 +1,12 @@
+const Router = require('koa-router')
+const qqwry = require('./qqwry/routes')
+const ipip = require('./ipip/routes')
+
+const v1 = new Router({
+  prefix: '/v1',
+})
+
+v1.use(qqwry.routes())
+v1.use(ipip.routes())
+
+module.exports = v1
diff --git a/src/services/v1/ipip/routes.js b/src/services/v1/ipip/routes.js
@@ -0,0 +1,53 @@
+const Router = require('koa-router')
+const IPDB = require('ipdb')
+const ipdb_range = require('@ipdb/range')
+const ipdb_database = require('@ipdb/database')
+const ipdb = new IPDB(ipdb_database, {
+  patches: [ipdb_range]
+})
+
+const router = new Router({
+  prefix: '/ipip'
+})
+
+// version
+router.get('/version', async (ctx) => {
+  try {
+    const result = {
+      version: ipdb.meta
+    }
+    ctx.status = 200
+    ctx.body = result
+  } catch (error) {
+    ctx.throw(400, error.message)
+  }
+})
+
+// find ip
+router.get('/:ip', async (ctx) => {
+  try {
+    const ip = ctx.params.ip
+    const { code, data, message } = ipdb.find(ip)
+    if (code) {
+      throw new Error(message)
+    }
+    const result = {
+      ip: data.ip,
+      country_name: data.country_name,
+      region_name: data.region_name,
+      city_name: data.city_name,
+      owner_domain: data.owner_domain || '',
+      isp_domain: data.isp_domain || '',
+      range: {
+        from: data.range.from,
+        to: data.range.to
+      }
+    }
+    ctx.status = 200
+    ctx.body = result
+  } catch (error) {
+    ctx.throw(400, error.message)
+  }
+})
+
+module.exports = router
diff --git a/src/services/v1/qqwry/routes.js b/src/services/v1/qqwry/routes.js
@@ -0,0 +1,53 @@
+const Router = require('koa-router')
+const IPDB = require('ipdb')
+const ipdb_range = require('@ipdb/range')
+const qqwry_ipdb = require('qqwry.ipdb')
+const ipdb = new IPDB(qqwry_ipdb, {
+  patches: [ipdb_range]
+})
+
+const router = new Router({
+  prefix: '/qqwry'
+})
+
+// version
+router.get('/version', async (ctx) => {
+  try {
+    const result = {
+      version: ipdb.meta
+    }
+    ctx.status = 200
+    ctx.body = result
+  } catch (error) {
+    ctx.throw(400, error.message)
+  }
+})
+
+// find ip
+router.get('/:ip', async (ctx) => {
+  try {
+    const ip = ctx.params.ip
+    const { code, data, message } = ipdb.find(ip)
+    if (code) {
+      throw new Error(message)
+    }
+    const result = {
+      ip: data.ip,
+      country_name: data.country_name,
+      region_name: data.region_name,
+      city_name: data.city_name,
+      owner_domain: data.owner_domain || '',
+      isp_domain: data.isp_domain || '',
+      range: {
+        from: data.range.from,
+        to: data.range.to
+      }
+    }
+    ctx.status = 200
+    ctx.body = result
+  } catch (error) {
+    ctx.throw(400, error.message)
+  }
+})
+
+module.exports = router
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+HTTP_PORT=3000`
	`2`	`+HTTP_HOST=0.0.0.0`