Merge pull request #12 from ConnerTechnology/fix_lint_errors

Fix lint errors

Author: thomasconner

.eslintrc.js

@@ -4,33 +4,33 @@ module.exports = {
   env: {
     browser: true,
     es6: true,
-    node: true,
+    node: true
   },
   extends: [
     'airbnb-base',
     'plugin:@typescript-eslint/recommended',
     'prettier/@typescript-eslint',
-    'plugin:prettier/recommended',
+    'plugin:prettier/recommended'
   ],
   parser: '@typescript-eslint/parser',
   parserOptions: {
     project: path.resolve(__dirname, './tsconfig.json')
   },
   plugins: [
-    '@typescript-eslint',
+    '@typescript-eslint'
   ],
   rules: {
-    'lines-between-class-members': 'off',
+    'lines-between-class-members': 'off'
   },
   overrides: [
     {
       files: ['**/*.test.js', '**/*.test.ts'],
       rules: {
         // Import
         'import/no-extraneous-dependencies': 'off'
-      }
+      },
       env: {
-        jest: true,
+        jest: true
       }
     }
   ],

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: Lint and Test
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v1
+      - name: Install Node
+        uses: actions/setup-node@v1
+      - name: Install Dependencies
+        run: npm install
+      - name: Lint
+        run: npm run lint
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v1
+      - name: Install Node
+        uses: actions/setup-node@v1
+      - name: Install Dependencies
+        run: npm install
+      - name: Test
+        run: npm test

.github/workflows/release.yml

@@ -8,10 +8,15 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-      - run: npm install
-      - run: npm run build
-      - uses: mikeal/merge-release@master
+      - name: Checkout Repository
+        uses: actions/checkout@v1
+      - name: Install Node
+        uses: actions/setup-node@v1
+      - name: Install Dependencies
+        run: npm install
+      - name: Build
+        run: npm run build
+      - name: Release
+        uses: mikeal/merge-release@master
         env:
           NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.github/workflows/test.yml

@@ -1,13 +1,12 @@
 {
   "name": "ipdata",
-  "version": "2.0.0-next.2",
+  "version": "2.0.0",
   "description": "JavaScript library to gather information for an ip using https://ipdata.co.",
   "main": "./lib/index.js",
   "scripts": {
     "prebuild": "del lib",
     "build": "tsc",
     "lint": "eslint --fix \"src/**\"",
-    "prepublishOnly": "npm run build",
     "test": "jest"
   },
   "repository": {

package.json

@@ -1,22 +1,48 @@
 import isString from 'lodash/isString';
 import isArray from 'lodash/isArray';
 import isIP from 'is-ip';
-import axios, { AxiosError, AxiosResponse } from 'axios';
+import axios, { AxiosError } from 'axios';
 import urljoin from 'url-join';
 import LRU from 'lru-cache';
 
 const CACHE_MAX = 4096; // max number of items
 const CACHE_MAX_AGE = 1000 * 60 * 60 * 24; // 24 hours
 const cache = new LRU<string, LookupResponse>({ max: CACHE_MAX, maxAge: CACHE_MAX_AGE });
 const DEFAULT_IP = 'DEFAULT_IP';
-const VALID_FIELDS=['ip', 'is_eu', 'city', 'region', 'region_code', 'country_name', 'country_code', 'continent_name', 'continent_code', 'latitude', 'longitude', 'asn', 'organisation', 'postal', 'calling_code', 'flag', 'emoji_flag', 'emoji_unicode', 'carrier', 'languages', 'currency', 'time_zone', 'threat', 'count', 'status'];
+const VALID_FIELDS = [
+  'ip',
+  'is_eu',
+  'city',
+  'region',
+  'region_code',
+  'country_name',
+  'country_code',
+  'continent_name',
+  'continent_code',
+  'latitude',
+  'longitude',
+  'asn',
+  'organisation',
+  'postal',
+  'calling_code',
+  'flag',
+  'emoji_flag',
+  'emoji_unicode',
+  'carrier',
+  'languages',
+  'currency',
+  'time_zone',
+  'threat',
+  'count',
+  'status',
+];
 const BASE_URL = 'https://api.ipdata.co/';
 
-function isValidIP(ip: string) {
+function isValidIP(ip: string): boolean {
   return ip === DEFAULT_IP || isIP(ip);
 }
 
-function isValidSelectField(field: string) {
+function isValidSelectField(field: string): boolean {
   const index = VALID_FIELDS.indexOf(field);
 
   if (index === -1) {
@@ -26,27 +52,27 @@ function isValidSelectField(field: string) {
   return true;
 }
 
-function isValidFields(fields: string[]) {
+function isValidFields(fields: string[]): boolean {
   if (!isArray(fields)) {
     throw new Error('Fields should be an array.');
   }
 
-  for (const field of fields) {
+  fields.forEach(field => {
     const index = VALID_FIELDS.indexOf(field);
     if (index === -1) {
       throw new Error(`${field} is not a valid field.`);
     }
-  }
+  });
 
   return true;
 }
 
-export function clearCache(ip?: string) {
-  if (isValidIP(ip)) {
-    return cache.del(ip);
-  }
-  return cache.reset();
-}
+// export function clearCache(ip?: string): void {
+//   if (isValidIP(ip)) {
+//     return cache.del(ip);
+//   }
+//   return cache.reset();
+// }
 
 export interface LookupResponse {
   ip: string;
@@ -101,15 +127,21 @@ export interface LookupResponse {
 }
 
 export interface BulkLookupResponse {
-  responses: LookupResponse[],
+  responses: LookupResponse[];
   status: number;
 }
 
+// eslint-disable-next-line @typescript-eslint/interface-name-prefix
+interface IPDataParams {
+  'api-key': string;
+  fields?: string;
+}
+
 export default class IPData {
   apiKey?: string;
   useCache?: boolean;
 
-  constructor(apiKey: string, useCache: boolean = true) {
+  constructor(apiKey: string, useCache = true) {
     if (!isString(apiKey)) {
       throw new Error('An API key is required.');
     }
@@ -119,7 +151,7 @@ export default class IPData {
   }
 
   async lookup(ip?: string, selectField?: string, fields?: string[]): Promise<LookupResponse> {
-    const params: any = { 'api-key': this.apiKey };
+    const params: IPDataParams = { 'api-key': this.apiKey };
     let url = ip ? urljoin(BASE_URL, ip) : BASE_URL;
 
     if (ip && !isValidIP(ip)) {
@@ -147,38 +179,37 @@ export default class IPData {
       let data = { ...response.data, status: response.status };
 
       if (selectField) {
-        data = { 'select_field': response.data, status: response.status };
+        data = { [selectField]: response.data, status: response.status };
       }
 
-      if (this.useCache) {
+      if ((!selectField || !fields) && this.useCache) {
         cache.set(ip || DEFAULT_IP, data);
       } else {
         return data;
       }
     } catch (e) {
       const { response } = e as AxiosError;
       if (response) {
-        return { ...response.data, status: response.status }
-      } else {
-        throw e;
+        return { ...response.data, status: response.status };
       }
+      throw e;
     }
 
     return cache.get(ip || DEFAULT_IP);
   }
 
   async bulkLookup(ips: string[], fields?: string[]): Promise<BulkLookupResponse> {
-    const params: any = { 'api-key': this.apiKey };
+    const params: IPDataParams = { 'api-key': this.apiKey };
 
     if (ips.length < 2) {
       throw new Error('Bulk Lookup requires more than 1 IP Address in the payload.');
     }
 
-    for (const ip of ips) {
+    ips.forEach(ip => {
       if (!isValidIP(ip)) {
         throw new Error(`${ip} is an invalid IP address.`);
       }
-    }
+    });
 
     if (fields && isValidFields(fields)) {
       params.fields = fields.join(',');
@@ -191,9 +222,8 @@ export default class IPData {
       const { response } = e as AxiosError;
       if (response) {
         return { ...response.data, status: response.status };
-      } else {
-        throw e;
       }
+      throw e;
     }
   }
 }

src/ipdata.ts

@@ -1,4 +1,4 @@
-import IPData from './ipdata';
+import IPData from '../src/ipdata';
 
 const API_KEY = 'test';
 
@@ -69,10 +69,10 @@ describe('lookup()', () => {
       await expect(ipdata.lookup(null, field)).rejects.toThrowError(`${field} is not a valid field.`);
     });
 
-    it('should return a response with only the field', async () => {
+    it.only('should return a response with only the field', async () => {
       const field = 'is_eu';
       const info = await ipdata.lookup(null, field);
-      expect(info).toHaveProperty('select_field', false);
+      expect(info).toHaveProperty(field, false);
       expect(info).toHaveProperty('status');
     });
   });

src/ipdata.test.ts test/ipdata.test.tssrc/ipdata.test.ts renamed to test/ipdata.test.ts

@@ -13,9 +13,5 @@
   },
   "include": [
     "src/**/*"
-  ],
-  "exclude": [
-    "node_modules",
-    "**/*.test.ts"
   ]
 }