ac-geoip 3.0.0 → 3.0.3

package/.github/workflows/node.js.yml

@@ -0,0 +1,36 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        redis-version: [6]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Start Redis
+      uses: supercharge/redis-github-action@1.4.0
+      with:
+        redis-version: ${{ matrix.redis-version }}    
+    
+    - run: yarn install
+    - run: yarn run test

package/.ncurc.js

@@ -0,0 +1,7 @@
+// List packages for minor updates
+const minorUpdatePackages = ['chai']
+module.exports = {
+  target: packageName => {
+    return minorUpdatePackages.includes(packageName) ? 'minor' : 'latest'
+  }
+}

package/CHANGELOG.md

@@ -1,3 +1,48 @@
+<a name="3.0.3"></a>
+
+## [3.0.3](https://github.com/admiralcloud/ac-geoip/compare/v3.0.2..v3.0.3) (2024-07-06 12:44:21)
+
+
+### Bug Fix
+
+* **App:** Package updates | MP | [89c90ffb42fbc601449bff5c58d866bcdb11a28c](https://github.com/admiralcloud/ac-geoip/commit/89c90ffb42fbc601449bff5c58d866bcdb11a28c)    
+Replaced ip with ac-ip  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+<a name="3.0.2"></a>
+
+## [3.0.2](https://github.com/admiralcloud/ac-geoip/compare/v3.0.1..v3.0.2) (2024-02-26 07:45:31)
+
+
+### Bug Fix
+
+* **App:** Package updates | MP | [e6ab5710fa897109578b6f640fabde9773b3cc56](https://github.com/admiralcloud/ac-geoip/commit/e6ab5710fa897109578b6f640fabde9773b3cc56)    
+Package updates  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+<a name="3.0.1"></a>
+
+## [3.0.1](https://github.com/admiralcloud/ac-geoip/compare/v3.0.0..v3.0.1) (2023-07-26 06:14:56)
+
+
+### Bug Fix
+
+* **App:** Make cacheTime for NodeCache configurable | MP | [89a63cbf3ae6e1bbcc277bd1cd45348c314c9080](https://github.com/admiralcloud/ac-geoip/commit/89a63cbf3ae6e1bbcc277bd1cd45348c314c9080)    
+Make cacheTime for NodeCache configurable. It still defaults to 7 days.  
+Related issues: [/issues#undefined](https://github.com//issues/undefined)
+### Documentation
+
+* **App:** Added status badge from Github aciton | MP | [1b71085160da67310dc568e981625a3ca5a2efa0](https://github.com/admiralcloud/ac-geoip/commit/1b71085160da67310dc568e981625a3ca5a2efa0)    
+Added status badge from Github action  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Chores
+
+* **App:** Updated packages | MP | [49d773010e3cb55ccdf0c6de6f9a9e8af17974fa](https://github.com/admiralcloud/ac-geoip/commit/49d773010e3cb55ccdf0c6de6f9a9e8af17974fa)    
+Updated packages  
+Related issues: [/issues#undefined](https://github.com//issues/undefined)
+### Chores
+
+* **App:** Added Github action for automated testing | MP | [2302e4a9c71c67ba2caa2ce89fa03e1a1a0c1459](https://github.com/admiralcloud/ac-geoip/commit/2302e4a9c71c67ba2caa2ce89fa03e1a1a0c1459)    
+Added Github action for automated testing  
+Related issues: [undefined/undefined#master](undefined/browse/master)
 <a name="3.0.0"></a>
  
 # [3.0.0](https://github.com/admiralcloud/ac-geoip/compare/v2.0.0..v3.0.0) (2022-12-18 08:36:22)

package/README.md

@@ -5,6 +5,8 @@ GEOIP web service requires an account at Maxmind.
 
 You can also use the Geolite2 database from Maxmind: https://dev.maxmind.com/geoip/geoip2/geolite2/
 
+[![Node.js CI](https://github.com/AdmiralCloud/ac-geoip/actions/workflows/node.js.yml/badge.svg)](https://github.com/AdmiralCloud/ac-geoip/actions/workflows/node.js.yml)
+
 ## Usage
 
 ### Using Webservice

package/index.js

@@ -1,12 +1,11 @@
 const _ = require('lodash')
-const ipPackage = require('ip')
+const ipPackage = require('ac-ip')
 const fs = require('fs')
 
 const WebServiceClient = require('@maxmind/geoip2-node').WebServiceClient
 const Reader = require('@maxmind/geoip2-node').Reader
 
 const NodeCache = require("node-cache")
-const geoCache = new NodeCache({ stdTTL: 7 * 86400, checkperiod: 3600 })
 
 const acgeoip = () => {
 
@@ -50,6 +49,11 @@ const acgeoip = () => {
         geoip.geolite.reader = geoipReader
       })
     }
+
+    if (!_.has(params, 'redis')) {
+      geoip.geoCache = new NodeCache({ stdTTL: _.get(geoip, 'cacheTime'), checkperiod: 3600 })
+    }
+
   }
 
   const lookupLocal = async (params) => {
@@ -60,7 +64,7 @@ const acgeoip = () => {
     }
 
     const ip = _.get(params, 'ip')
-    if (ipPackage.isPrivate(ip)) return
+    if (ipPackage.isPrivateIP(ip)) return
 
     const mapping = _.get(params, 'mapping', geoip.mapping)
     const debug = _.get(params, 'debug')
@@ -151,7 +155,7 @@ const acgeoip = () => {
       throw Error(message)
     }
     const ip = _.get(params, 'ip')
-    if (ipPackage.isPrivate(ip)) {
+    if (ipPackage.isPrivateIP(ip)) {
       return
     }
 
@@ -222,13 +226,13 @@ const acgeoip = () => {
     const geoipResponse = _.get(params, 'geoipResponse')
     const ip = _.get(params, 'ip')
     const storageKey = _.get(geoip, 'environment') + ':geoip:' + ip
-    geoCache.set(storageKey, geoipResponse)
+    geoip.geoCache.set(storageKey, geoipResponse)
   }
 
   const getFromMemory = (params) => {
     const ip = _.get(params, 'ip')
     const storageKey = _.get(geoip, 'environment') + ':geoip:' + ip
-    return geoCache.get(storageKey)
+    return geoip.geoCache.get(storageKey)
   }
 
   const checkRedis = async (params) => {

package/package.json

@@ -3,24 +3,27 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-geoip",
-  "version": "3.0.0",
+  "version": "3.0.3",
   "dependencies": {
-    "@maxmind/geoip2-node": "^3.5.0",
-    "ip": "^1.1.8",
+    "@maxmind/geoip2-node": "^5.0.0",
+    "ac-ip": "^4.0.0",
     "lodash": "^4.17.21",
     "node-cache": "^5.1.2"
   },
   "devDependencies": {
-    "ac-semantic-release": "^0.3.4",
-    "chai": "^4.3.7",
-    "eslint": "^8.30.0",
-    "ioredis": "^5.2.4",
-    "mocha": "^10.2.0"
+    "ac-semantic-release": "^0.4.2",
+    "chai": "^4.4.1",
+    "eslint": "^9.6.0",
+    "ioredis": "^5.4.1",
+    "mocha": "^10.6.0"
   },
   "scripts": {
     "test": "./node_modules/.bin/mocha --bail --exit --slow 1000 ./test/test.js || :"
   },
   "engines": {
-    "node": ">=16.0"
+    "node": ">=18.0"
+  },
+  "resolutions": {
+    "mocha/chokidar/braces": "^3.0.3"
   }
 }