twenty 0.2.0 → 0.3.0

package/README.md

@@ -1,82 +1,6 @@
-# Twenty
+# Twenty CLI
 
-## What is it?
-Twenty is a small package to help you get location (city/region and lat/lon coordinates) and ISP data from an IP address or URL. Other utilities are provided, like a method that provides the approximate distance between two IP addresses. All of this can also be done by specifying the FQDN, like "stackabuse.com" or "google.com".
+The new command-line interface for [Twenty](https://twenty.com) is coming soon.
 
-For location data, the [ipinfo.io](http://ipinfo.io/) REST service is used.
-
-Twenty was created in conjunction with [this article](http://stackabuse.com/how-to-create-a-node-js-cli-application/).
-
-## Installation
-Twenty can be installed as a project dependency or global CLI tool:
-
-```bash
-$ [sudo] npm install twenty [-g]
-```
-
-## Usage
-There are two ways to use this package: through the command line or by within your code.
-
-### Command Line
-```bash
-$ twenty [command] [ip | url] [-j]
-```
-
-Twenty takes an optional IP (or URL) address as an argument. If one isn't given, then your own IP address is used. If you're using the `distance` command, then you must provide at least one IP/URL, and optionally two.
-
-The `-j` flag will print out all of the IP location info JSON format.
-
-```bash
-$ twenty stackabuse.com -j
-{
-    "ip": "54.173.122.231",
-    "hostname": "ec2-54-173-122-231.compute-1.amazonaws.com",
-    "city": "Ashburn",
-    "region": "Virginia",
-    "country": "US",
-    "loc": "39.0437,-77.4875",
-    "org": "AS14618 Amazon.com, Inc.",
-    "postal": "20147"
-}
-```
-
-### In Your Code
-Twenty can also be used programmatically. Currently, the functions provided are `info()` and `distance()`.
-
-- `info()`: Provides you with all the IP info as a JavaScript object
-- `distance()`: Calculates the distance between two IPs/URLs in kilometers
-
-#### Example Code
-
-```javascript
-var twenty = require('twenty');
-
-twenty.info('8.8.8.8', function(err, data) {
-    console.log('Google\'s DNS server is located at:', data.loc);
-});
-
-twenty.distance('8.8.8.8', '54.173.122.231', function(err, distance) {
-    console.log('Distance between Google\'s DNS and stackabuse.com server (km):', distance);
-});
-```
-
-## Note
-Since Twenty uses the ipinfo.io REST service for getting location information, you'll need to be aware of your usage. The daily limit for free usage is 1,000 requests per day. Check the [ipinfo.io](http://ipinfo.io/about) About page for more information.
-
-## Why 'Twenty'?
-The name 'Twenty' came from the phrase "What's your 20?", which came from the police [10-code](https://en.wikipedia.org/wiki/Ten-code) "10-20", which means "identify your position" or "where are you?".
-
-## Copyright & License
-Copyright (c) 2016 Scott Robinson
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+This package does not provide an executable yet. For the currently available CLI,
+use [twenty-sdk](https://www.npmjs.com/package/twenty-sdk).

package/package.json

@@ -1,28 +1,15 @@
 {
   "name": "twenty",
-  "version": "0.2.0",
-  "description": "Locates the city/region of a given IP address",
-  "main": "index.js",
+  "version": "0.3.0",
+  "description": "The new command-line interface for Twenty is coming soon.",
+  "homepage": "https://twenty.com",
   "repository": {
     "type": "git",
-    "url": "https://github.com/scottwrobinson/twentyjs.git"
+    "url": "git+https://github.com/twentyhq/twenty.git",
+    "directory": "packages/twenty-cli"
   },
-  "keywords": [
-    "cli",
-    "location",
-    "ipinfo",
-    "tools"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "bugs": {
+    "url": "https://github.com/twentyhq/twenty/issues"
   },
-  "author": "Scott Robinson <s.w.robinson@gmail.com> (http://stackabuse.com)",
-  "license": "MIT",
-  "dependencies": {
-    "request": "^2.67.0",
-    "yargs": "^4.2.0"
-  },
-  "bin": {
-    "twenty": "./bin/twenty"
-  }
-}
+  "license": "AGPL-3.0"
+}

package/.npmignore

@@ -1,2 +0,0 @@
-node_modules/
-todo.txt

package/bin/twenty

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-require('../index').cli();

package/index.js

@@ -1,118 +0,0 @@
-var dns = require('dns');
-var request = require('request');
-
-var ipRegexStr = '(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.' +
-                 '(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.' +
-                 '(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.' +
-                 '(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)';
-var ipRegex = new RegExp(ipRegexStr);
-
-var toRad = function(num) {
-    return num * (Math.PI / 180);
-};
-
-var getIpInfo = function(server, callback) {
-    var ipinfo = function(p, cb) {
-        request('http://ipinfo.io/' + p, function(err, response, body) {
-            var json;
-            try {
-                json = JSON.parse(body);
-            } catch(error) {
-                return cb(error, null);
-            }
-            cb(err, json);
-        });
-    };
-
-    if (!server) {
-        return ipinfo('json', callback);
-    } else if (!server.match(ipRegex)) {
-        return dns.lookup(server, function(err, data) {
-            ipinfo(data, callback);
-        });
-    } else {
-        return ipinfo(server, callback);
-    }
-};
-
-var ipDistance = function(lat1, lon1, lat2, lon2) {
-    // Earth radius in km
-    var r = 6371;
-
-    var dLat = toRad(lat2 - lat1);
-    var dLon = toRad(lon2 - lon1);
-    lat1 = toRad(lat1);
-    lat2 = toRad(lat2);
-
-    var a = Math.sin(dLat / 2.0) * Math.sin(dLat / 2.0) + 
-        Math.sin(dLon / 2.0) * Math.sin(dLon / 2.0) * Math.cos(lat1) * Math.cos(lat2);
-    var c = 2.0 * Math.atan2(Math.sqrt(a), Math.sqrt(1.0 - a));
-    return r * c;
-};
-
-var findDistance = function(ip1, ip2, callback) {
-    var lat1, lon1, lat2, lon2;
-
-    getIpInfo(ip1, function(err, data1) {
-        var coords1 = data1.loc.split(',');
-        lat1 = Number(coords1[0]);
-        lon1 = Number(coords1[1]);
-        getIpInfo(ip2, function(err, data2) {
-            var coords2 = data2.loc.split(',');
-            lat2 = Number(coords2[0]);
-            lon2 = Number(coords2[1]);
-
-            var dist = ipDistance(lat1, lon1, lat2, lon2);
-            callback(null, dist);
-        });
-    });
-};
-
-var cli = function() {
-    var yargs = require('yargs')
-        .usage('Usage: $0 [command] [options]')
-        .command('distance <loc1> [loc2]', 'Compute the approx. distance between IPs/URLs')
-        .option('json', {
-            alias: 'j',
-            describe: 'Return data as json',
-        })
-        .example('$0', 'Get location info for your IP address')
-        .example('$0 -j', 'Get location info for your IP as json')
-        .example('$0 distance 8.8.8.8', 'Get distance from your IP to given IP')
-        .example('$0 distance stackabuse.com google.com', 'Get the distance between two given URLs')
-        .help('help')
-        .alias('h', 'help')
-        .epilog('Copyright 2016 Scott Robinson');
-
-    var argv = yargs.argv;
-
-    if (argv.loc1) {
-        findDistance(argv.loc1, argv.loc2, function(err, distance) {
-            console.log(String(distance.toFixed(2)) + ' km');
-        });
-    } else if (argv.json) {
-        getIpInfo(argv._[0], function(err, data) {
-            console.log(JSON.stringify(data, null, 4));
-        });
-    } else {
-        getIpInfo(argv._[0], function(err, data) {
-            if (err) {
-                console.log('Error:', err.message);
-                return;
-            }
-
-            console.log('IP:', data.ip);
-            console.log('Hostname:', data.hostname || '-');
-            console.log('City:', data.city || '-');
-            console.log('Region:', data.region || '-');
-            console.log('Postal:', data.postal || '-');
-            console.log('Country:', data.country || '-');
-            console.log('Coordinates:', data.loc || '-');
-            console.log('ISP:', data.org || '-');
-        });
-    }
-};
-
-exports.info = getIpInfo;
-exports.distance = findDistance;
-exports.cli = cli;