first commit

lgaticaq · lgaticaq · commit c035f710df79 · 2016-02-29T19:09:14.000-03:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,28 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules
+lib
diff --git a/.node-version b/.node-version
@@ -0,0 +1 @@
+v5
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+node_modules
+src
+.*
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v5
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - "0.12"
+  - "4"
+  - "5"
+notifications:
+  email: false
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Leonardo Gatica
+
+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.
+
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# simple-reverse-geocoder
+
+[![npm version](https://img.shields.io/npm/v/simple-reverse-geocoder.svg?style=flat-square)](https://www.npmjs.com/package/simple-reverse-geocoder)
+[![npm downloads](https://img.shields.io/npm/dm/simple-reverse-geocoder.svg?style=flat-square)](https://www.npmjs.com/package/simple-reverse-geocoder)
+[![dependency Status](https://img.shields.io/david/lgaticaq/simple-reverse-geocoder.svg?style=flat-square)](https://david-dm.org/lgaticaq/simple-reverse-geocoder#info=dependencies)
+[![Build Status](https://img.shields.io/travis/lgaticaq/simple-reverse-geocoder.svg?style=flat-square)](https://travis-ci.org/lgaticaq/simple-reverse-geocoder)
+[![devDependency Status](https://img.shields.io/david/dev/lgaticaq/simple-reverse-geocoder.svg?style=flat-square)](https://david-dm.org/lgaticaq/simple-reverse-geocoder#info=devDependencies)
+[![Join the chat at https://gitter.im/lgaticaq/simple-reverse-geocoder](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg?style=flat-square)](https://gitter.im/lgaticaq/simple-reverse-geocoder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+Get address from a point
+
+## Installation
+
+```bash
+npm i -S simple-reverse-geocoder
+```
+
+## Use
+
+[Try on Tonic](https://tonicdev.com/npm/simple-reverse-geocoder)
+```js
+import meitrack from 'simple-reverse-geocoder'
+
+const rg = require('simple-reverse-geocoder');
+
+const loc = {type: 'Point', coordinates: [-70.5171743, -33.3608387]};
+rg.getAddress(loc).then(console.log); // 'Del Candil 665-701, Lo Barnechea'
+```
diff --git a/example.js b/example.js
@@ -0,0 +1,4 @@
+const rg = require('simple-reverse-geocoder');
+
+const loc = {type: 'Point', coordinates: [-70.5171743, -33.3608387]};
+const address = await rg.getAddress(loc);
diff --git a/package.json b/package.json
@@ -0,0 +1,83 @@
+{
+  "name": "simple-reverse-geocoder",
+  "version": "1.0.0",
+  "description": "Get address from a point",
+  "main": "lib",
+  "scripts": {
+    "prepublish": "npm run build -s",
+    "prebuild": "npm run lint -s && npm run clean -s",
+    "build": "babel src --out-dir lib --source-maps",
+    "lint": "eslint src",
+    "clean": "rimraf lib",
+    "pretest": "npm run build -s",
+    "test": "mocha --compilers js:babel-core/register"
+  },
+  "engines": {
+    "node": ">=0.12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lgaticaq/simple-reverse-geocoder.git"
+  },
+  "keywords": [
+    "reverse",
+    "geocoder"
+  ],
+  "author": "Leonardo Gatica <lgatica@protonmail.com> (https://about.me/lgatica)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/lgaticaq/simple-reverse-geocoder/issues"
+  },
+  "homepage": "https://github.com/lgaticaq/simple-reverse-geocoder#readme",
+  "dependencies": {
+    "bluebird": "^3.3.1",
+    "hiredis": "^0.4.1",
+    "node-geocoder": "^3.7.0",
+    "redis-url": "^1.2.1"
+  },
+  "devDependencies": {
+    "babel-cli": "^6.5.1",
+    "babel-core": "^6.5.2",
+    "babel-preset-es2015": "^6.5.0",
+    "chai": "^3.5.0",
+    "eslint": "1.10.3",
+    "mocha": "^2.4.5",
+    "rimraf": "^2.5.2"
+  },
+  "eslintConfig": {
+    "rules": {
+      "strict": 0,
+      "indent": [
+        2,
+        2
+      ],
+      "quotes": [
+        2,
+        "single"
+      ],
+      "linebreak-style": [
+        2,
+        "unix"
+      ],
+      "semi": [
+        2,
+        "always"
+      ]
+    },
+    "ecmaFeatures": {
+      "modules": true
+    },
+    "env": {
+      "es6": true,
+      "node": true,
+      "mocha": true
+    },
+    "extends": "eslint:recommended"
+  },
+  "babel": {
+    "presets": [
+      "es2015"
+    ]
+  },
+  "tonicExampleFilename": "example.js"
+}
diff --git a/src/index.js b/src/index.js
@@ -0,0 +1,77 @@
+'use strict';
+
+import redisUrl from 'redis-url';
+import nodeGeocoder from 'node-geocoder';
+import Promise from 'bluebird';
+
+let client;
+
+const setCache = (uri) => {
+  try {
+    client = redisUrl.connect(uri);
+    Promise.promisifyAll(Object.getPrototypeOf(client));
+  } catch (err) {
+    throw err;
+  }
+};
+
+const getReverse = (lat, lng) => {
+  return new Promise((resolve, reject) => {
+    const geocoderProvider = 'google';
+    const httpAdapter = 'http';
+    const geocoder = nodeGeocoder(geocoderProvider, httpAdapter);
+    geocoder.reverse({lat: lat, lon: lng}).then(res => {
+      if (res.length === 0) resolve(null);
+      resolve(res[0].formattedAddress.split(',').map(x => x.trim()).slice(0, 2).join(', '));
+    }).catch(reject);
+  });
+};
+
+const getCoordinates = (loc) => {
+  return new Promise((resolve, reject) => {
+    try {
+      const [lng, lat] = loc.coordinates;
+      resolve({lng: lng, lat: lat});
+    } catch (err) {
+      reject(err);
+    }
+  });
+};
+
+const getFromCache = (lat, lng) => {
+  return new Promise((resolve, reject) => {
+    client.getAsync(`geocoder:${lat}:${lng}`).then(resolve).catch(reject);
+  });
+};
+
+const getAddress = (loc) => {
+  return new Promise((resolve, reject) => {
+    getCoordinates(loc).then(({lng, lat}) => {
+      if (client) {
+        getFromCache(lat, lng).then(reply => {
+          if (reply) resolve(reply);
+          getReverse(lat, lng).then(address => {
+            if (!address) resolve(null);
+            client.set(`geocoder:${lat}:${lng}`, address);
+            resolve(address);
+          }).catch(reject);
+        }).catch(reject);
+      } else {
+        getReverse(lat, lng).then(resolve).catch(reject);
+      }
+    }).catch(reject);
+  });
+};
+
+const clearCache = (lat, lng) => {
+  if (client) {
+    client.del(`geocoder:${lat}:${lng}`);
+  }
+};
+
+module.exports = {
+  setCache: setCache,
+  getAddress: getAddress,
+  getFromCache: getFromCache,
+  clearCache: clearCache
+};
diff --git a/test/test.js b/test/test.js
@@ -0,0 +1,34 @@
+'use strict';
+
+import lib from '../lib';
+import {expect} from 'chai';
+
+describe('simple-reverse-geocoder', () => {
+  describe('getAddress', () => {
+    it('should return a valid address', (done) => {
+      const loc = {type: 'Point', coordinates: [-70.5171743, -33.3608387]};
+      lib.setCache();
+      lib.getAddress(loc).then(data => {
+        expect(data).to.eql('Del Candil 665-701, Lo Barnechea');
+        done();
+      }).catch(err => {
+        expect(err).to.be.undefined;
+        done();
+      });
+    });
+
+    it('should return a valid address', (done) => {
+      lib.getFromCache(-33.3608387, -70.5171743).then(reply => {
+        expect(reply).to.eql('Del Candil 665-701, Lo Barnechea');
+        done();
+      }).catch(err => {
+        expect(err).to.be.undefined;
+        done();
+      });
+    });
+  });
+
+  after(() => {
+    lib.clearCache(-33.3608387, -70.5171743);
+  });
+});
