address-geoservices - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

index.js

@@ -6,6 +6,9 @@ 'use strict';
 
-var apiKey, version;
+var yuriKey = ''
+  , texVersion = '4.01'
+  , texKey;
 
 var funcs = {
   normalize: function(addressObj, cb) {
+    if (!texKey) { throw new Error('No API key provided'); }
     var endpoint = 'https://geoservices.tamu.edu/Services/AddressNormalization/WebService/v04_01/HTTP/default.aspx';
@@ -16,4 +19,4 @@
       qs: {
-        version: version,
-        apiKey: apiKey,
+        version: texVersion,
+        apiKey: texKey,
         nonParsedStreetAddress: addressObj.street,
@@ -49,3 +52,3 @@ nonParsedCity: addressObj.city,
         AddressLine2: line2,
-        UserKey: ''
+        UserKey: yuriKey
       }
@@ -69,16 +72,12 @@ }, function(err, incomingMessage, response) {
     });
+  },
+  initTex: function(_texKey, _texVersion) {
+    texKey = _texKey;
+    texVersion = _texVersion;
+  },
+  initYaddress: function(_yuriKey) {
+    yuriKey = _yuriKey;
   }
 };
 
-module.exports = function(_apiKey, _version) {
-  if (!_apiKey) {
-    throw new Error('apiKey is required');
-  }
-  if (!_version) {
-    version = '4.01';
-  } else {
-    version = _version;
-  }
-  apiKey = _apiKey;
-  return funcs;
-};
+module.exports = funcs;

package.json

 {
   "name": "address-geoservices",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Interacts with geoservices apis to help with managing addresses",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,1 +0,62 @@
-TODO: Write readme
+#address-geoservices
+
+A collection of wrappers around tools that help you normalize and verify physical addresses.
+
+###Installation
+
+    npm install --save address-geoservices
+
+###Usage
+
+There are two separate services provided by `address-geoservices` - normalization and correction.
+
+####Normalization
+
+Normalization is the process of converting the parts of an address to standard abbreviations (`road` and `Rd` to `rd.`, for instance).  It is useful to conform to USPS standards as well as effectively detecting duplicates in one's data corpus.
+
+`address-geoservices` uses the [Texas A&M Geoservices API](http://geoservices.tamu.edu/) to normalize addresses.  This requires an API keyy.  The `.initTex` function allows you to provide both a key and the desired version.  Version is optional, and will default to `4.01` if not provided.
+
+    var geoservices = require('address-geoservices');
+
+    geoservices.initTex('myApiKey', 'desiredAPIVersion');
+
+Once you've called `initTex`, you can use `.normalize` to normalize a given address.  `normalize` expects two arguments.  One, an object with the following properties:
+
+ - street
+ - city
+ - state
+ - zip
+
+and a callback, which will be called with `err` or the returned, normalized address:
+
+    geoservices.normalize({
+      street: '2301 Westside Drive',
+      city: 'Rochester',
+      state: 'New York',
+      zip: '14624'
+    }, function(err, address) {
+      if (err) { console.error(err); }
+
+      console.log(addresses);
+    });
+
+####Validation
+
+On the other hand, addresses can be mistyped.  `address-geoservices` provides a service to do this as well, using the [YAddress API](http://www.yurisw.com/YAddress.aspx).  YAddress has a similar way:
+
+    var geoservices = require('address-geoservices');
+
+    geoservices.initYaddress('myApiKey');
+
+`validate` expects two arguments, an object like the one in `normalize`, and a callback:
+
+    geoservices.validate({
+      street: '2301 Westside Drive',
+      city: 'Rochester',
+      state: 'New York',
+      zip: '14624'
+    }, function(err, address) {
+      if (err) { console.error(err); }
+
+      console.log(addresses);
+    });

No alert changes

Improved metrics

Total package byte prevSize

4720

increased by85.83%

Number of lines in readme file

62

increased by6100%

Worsened metrics

Lines of code

68

decreased by-1.45%

No dependency changes