Skip to content

Commit

Permalink
Merge pull request #11 from fvdm/develop
Browse files Browse the repository at this point in the history
v1.7.2
  • Loading branch information
fvdm committed Dec 4, 2015
2 parents 43fb01e + 74980e5 commit 860b8b8
Show file tree
Hide file tree
Showing 6 changed files with 329 additions and 140 deletions.
158 changes: 158 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
{
"ecmaFeatures": {
"modules": true
},

"env": {
"node": true
},

"rules": {
"array-bracket-spacing": [2, "never"],
"brace-style": [2, "1tbs", {
"allowSingleLine": true
}],
"camelcase": [2, {
"properties": "never"
}],
"comma-spacing": [2, {
"before": false,
"after": true
}],
"comma-style": [2, "last"],
"comma-dangle": [2, "never"],
"complexity": [1, 8],
"computed-property-spacing": [2, "never"],
"consistent-return": 1,
"curly": [2, "all"],
"default-case": 2,
"dot-notation": [1, {
"allowKeywords": true
}],
"dot-location": [2, "property"],
"eol-last": 2,
"eqeqeq": 2,
"func-style": 0,
"guard-for-in": 0,
"handle-callback-err": [2, "^(e|er|err|error)[0-9]{1,2}?$"],
"indent": [2, 2],
"key-spacing": [2, {
"beforeColon": false,
"afterColon": true
}],
"lines-around-comment": [2, {
"beforeBlockComment": true,
"afterBlockComment": true,
"beforeLineComment": true,
"afterLineComment": false,
"allowBlockStart": true,
"allowBlockEnd": false
}],
"linebreak-style": [2, "unix"],
"max-nested-callbacks": [1, 3],
"new-cap": 0,
"newline-after-var": [2, "always"],
"no-alert": 2,
"no-caller": 2,
"no-catch-shadow": 2,
"no-delete-var": 2,
"no-div-regex": 2,
"no-duplicate-case": 2,
"no-else-return": 2,
"no-empty": 2,
"no-empty-character-class": 2,
"no-eval": 2,
"no-extend-native": 2,
"no-extra-semi": 2,
"no-fallthrough": 2,
"no-floating-decimal": 2,
"no-func-assign": 2,
"no-implied-eval": 2,
"no-inline-comments": 2,
"no-invalid-regexp": 2,
"no-label-var": 2,
"no-labels": 2,
"no-lone-blocks": 2,
"no-lonely-if": 2,
"no-mixed-requires": 0,
"no-mixed-spaces-and-tabs": 2,
"no-multi-spaces": 2,
"no-multi-str": 2,
"no-multiple-empty-lines": [2, {
"max": 2
}],
"no-native-reassign": 2,
"no-nested-ternary": 2,
"no-new-func": 2,
"no-new-object": 2,
"no-new-wrappers": 2,
"no-octal-escape": 2,
"no-octal": 2,
"no-path-concat": 2,
"no-param-reassign": 0,
"no-process-env": 0,
"no-proto": 2,
"no-redeclare": 2,
"no-reserved-keys": 0,
"no-return-assign": [2, "always"],
"no-self-compare": 2,
"no-sequences": 2,
"no-shadow": 2,
"no-shadow-restricted-names": 2,
"no-spaced-func": 0,
"no-sparse-arrays": 1,
"no-sync": 1,
"no-ternary": 0,
"no-throw-literal": 2,
"no-trailing-spaces": 2,
"no-undef": 2,
"no-undef-init": 2,
"no-undefined": 2,
"no-underscore-dangle": 2,
"no-unexpected-multiline": 2,
"no-unneeded-ternary": 2,
"no-unreachable": 2,
"no-unused-vars": 1,
"no-use-before-define": 2,
"no-useless-concat": 2,
"no-warning-comments": 1,
"no-with": 2,
"no-wrap-func": 0,
"object-curly-spacing": [2, "always", {
"objectsInObjects": false,
"arraysInObjects": false
}],
"one-var": [2, "never"],
"operator-assignment": [2, "always"],
"operator-linebreak": [2, "none", {
"overrides": {
"+": "after"
}
}],
"padded-blocks": [2, "never"],
"quote-props": [2, "consistent"],
"quotes": [2, "single", "avoid-escape"],
"radix": 2,
"semi": 2,
"semi-spacing": [2, {
"before": false,
"after": true
}],
"space-after-keywords": [2, "always"],
"space-before-blocks": [2, "always"],
"space-before-function-paren": [2, "always"],
"space-in-parens": [2, "never"],
"space-infix-ops": 2,
"space-return-throw-case": 2,
"space-unary-ops": [2, {
"words": true,
"nonwords": false
}],
"spaced-comment": [2, "always"],
"use-isnan": 2,
"valid-typeof": 2,
"vars-on-top": 2,
"wrap-regex": 0,
"yoda": [2, "never"]
}
}
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
sudo: false
language: node_js
node_js:
- 'iojs-2'
- 'iojs-1'
- '5'
- '4'
- '0.12'
- '0.10'
- '0.8'
54 changes: 11 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ Unofficial Node.js module for the Maxmind GeoIP2 Web Services.

[![Build Status](https://travis-ci.org/fvdm/nodejs-geoip2ws.svg?branch=master)](https://travis-ci.org/fvdm/nodejs-geoip2ws)

* [Node.js](https://nodejs.org/)
* [Maxmind GeoIP2 Web Services](https://www.maxmind.com/en/geoip2-precision-services)
* [API documentation](http://dev.maxmind.com/geoip/geoip2/web-services/)
* [Development](https://github.com/fvdm/nodejs-geoip2ws/wiki)


Usage
-----
Expand All @@ -20,16 +25,17 @@ require ('geoip2ws') (userId, licenseKey) (ip, callback);
#### Multiple calls, same account

```js
var geo = require ('geoip2ws') (userId, licenseKey);
geo (ip1, callback);
geo (ip2, callback);
var geoip2ws = require ('geoip2ws') (userId, licenseKey);
geoip2ws (ip1, callback);
geoip2ws (ip2, callback);
```

#### Mix products (or accounts)

```js
var insights = new require ('geoip2ws') (userId, licenseKey, 'insights');
var country = new require ('geoip2ws') (userId, licenseKey, 'country');
var geoip2ws = require ('geoip2ws');
var insights = new geoip2ws (userId, licenseKey, 'insights');
var country = new geoip2ws (userId, licenseKey, 'country');

// precise lookup, higher cost
insights (ip, callback);
Expand Down Expand Up @@ -121,44 +127,6 @@ API error | API error occured | `err.code` and `err
API errors: <http://dev.maxmind.com/geoip/geoip2/web-services/#Errors>


Development
-----------

The source code repository has two main branches: `master` and `develop`.
The `master` is exactly the same as the latest release on [npm](https://www.npmjs.com/package/geoip2ws),
while `develop` is where all development happens and other branches and Pull Requests are merged into.

When you intent to submit a Pull Request, please code against the `develop` branch.


* Branch status: Travis CI [![Travis CI](https://travis-ci.org/fvdm/nodejs-geoip2ws.svg?branch=develop)](https://travis-ci.org/fvdm/nodejs-geoip2ws)
* Branch status: Circle CI [![Circle CI](https://circleci.com/gh/fvdm/nodejs-geoip2ws/tree/develop.svg?style=svg)](https://circleci.com/gh/fvdm/nodejs-geoip2ws/tree/develop)
* [Source code](https://github.com/fvdm/nodejs-geoip2ws)
* [Contribution Guide](https://guides.github.com/activities/contributing-to-open-source/#contributing)


### Testing

You can test your code with `npm test` in the source path or simply create a PR and see what happens.

* With account the API endpoint is at `https://geoip.maxmind.com`: credits count, real data.
* Without account the API endpoint is at `https://frankl.in`: no credits, no logs, fake data.


#### Test configuration

variable | description | default
------------------|-------------------------------|----------------------------------------
GEOIP2WS_USERID | Account user ID | *null*
GEOIP2WS_LICENCE | Account license key | *null*
GEOIP2WS_SERVICE | `country`, `city`, `insights` | city
GEOIP2WS_TIMEOUT | Wait time out in ms | 5000
GEOIP2WS_ENDPOINT | API endpoint, i.e. http proxy | `https://geoip.maxmind.com/geoip/v2.1/`


Example: `GEOIP2WS_TIMEOUT=30000 npm test`


Unlicense
---------

Expand Down
Loading

0 comments on commit 860b8b8

Please sign in to comment.