madisonreed / usps-webtools Goto Github PK

USPS Web Tools API wrapper

JavaScript 97.01% Shell 2.99%

usps-webtools's Introduction

Installation:

npm install usps-webtools

Usage:

Initializing the usps model with usps server url address, and user id.

Example:

const USPS = require('usps-webtools');

const usps = new USPS({
  server: 'http://production.shippingapis.com/ShippingAPI.dll',
  userId: 'USPS User id',
  ttl: 10000 //TTL in milliseconds for request
});

verify(object, callback)

Verify takes two parameters: object and callback.

object: street1, street2, city, state, zip

callback: err, address

Example

usps.verify({
  street1: '322 3rd st.',
  street2: 'Apt 2',
  city: 'San Francisco',
  state: 'CA',
  zip: '94103'
}, function(err, address) {
  console.log(address);
});

zipCodeLookup(object, callback)

zipCodeLookup takes two parameters: object and callback.

object: street1, street2, city, state

callback: err, address

Example

usps.zipCodeLookup({
  street1: '322 3rd st.',
  street2: 'Apt 2',
  city: 'San Francisco',
  state: 'CA'
}, function(err, address) {
  console.log(address);
});

cityStateLookup(object, callback)

cityStateLookup takes two parameters: zipcode and callback.

zipcode: 5 digit zipcode

callback: err, address

Example

usps.cityStateLookup('94107', function(err, result) {
  // result == { city: , state: , zip: }
});

usps-webtools's People

Contributors

Stargazers

Watchers

usps-webtools's Issues

Regarding Pricing

Is the utilization of this API complimentary, or does it entail usage constraints, such as a predefined limit on the number of requests, beyond which access may be restricted, necessitating a subscription or payment for continued usage?

Add timeout

It would be great if we could pass in a timeout parameter because this am I am seeing USPS calls taking forever and i'm not able to timeout the functions currently.

Must call super constructor in derived class before accessing 'this' or returning from derived constructor

I'm having this error when trying to use it in the backend of my site.

international address verification

what about international addresses, such as Canada, can I verify those addresses as well?

Forked

I forked this repo and modernized the code base a bit, adding promises, rewriting in typescript, and some other things. This project seems to be unmaintained, but let me know if you'd rather have PRs. https://github.com/Sparticuz/usps-webtools-promise

Published version on NPM is broken

The latest version on NPM is 0.2.2, and it's crashing.

TypeError: console.eyes is not a function
    at callUSPS (/myDirectory/node_modules/usps-webtools/src/usps.js:210:11)

There is, in fact, a line with console.eyes(). I see that this is no longer in source here on GitHub, but the current version on NPM is no good.

No default jsDelivr CDN file set

This package doesn't have a default file set. You can set it via jsdelivr, browser, or main field in package.json

a

None of the tests are passing

Have specified API key in each test file. Have tried both HTTP production and HTTPS secure endpoints. It would appear that the endpoints have changed as of 1/17 according to USPS website but still no dice after updating.

OSS license

Should add a specific license to the project (and any other OSS projects).

Take a look at the npm repo for example:

they have a LICENSE file
the license is defined in the package json
if GitHub recognizes the license, it will give a specific tab to its meaning (npm's repo does not do this, so i gave a diff example)

Incorrect Example In ReadMe.md

Following looks wrong in ReadMe.md:
cityStateLookup appears to take zip code and yet, an address object is passed in the example.

cityStateLookup(object, callback)
cityStateLookup takes two parameters: zipcode and callback.
zipcode: 5 digit zipcode
callback: err, address
Example:
usps.cityStateLookup({
  street1: '322 3rd st.',
  street2: 'Apt 2',
  city: 'San Francisco',
  state: 'CA'
}, function(err, address) {
  console.log(address);
});

Why does zipCodeLookup take an address object? It appears the cityStateLookup description is mixed up with zipCodeLookup description.

zipCodeLookup(object, callback)
zipCodeLookup takes two parameters: object and callback.
object: street1, street2, city, state
callback: err, address
Example
usps.zipCodeLookup({
  street1: '322 3rd st.',
  street2: 'Apt 2',
  city: 'San Francisco',
  state: 'CA'
}, function(err, address) {
  console.log(address);
});

Major security issues

There are a few major security issues I found with this package that are super easy to fix:

qs needs to be upgraded to above 1.0.0 (1.0.0 and below are affected)
request needs to be upgraded to 2.78.0
hawk needs to be upgraded as well

Is this still maintained?

Trying to use this package and getting this error:

USPS Webtools Error: This Software version is no longer supported.  You must go to the SA web site (www.uspswebtools.com/Shippingassistant) and download the latest version of the Shipping Assistant.

When I go to that URL, it never loads.

Still maintaining/accepting PRs?

Error logging uses a nonstandard method that isn't supported outside of Chrome. (Error.

I'm happy to submit a PR if so.

RateV4 method does not work

Currently the RateV4 method does not work.

madisonreed / usps-webtools Goto Github PK

usps-webtools's Introduction

Installation:

Usage:

verify(object, callback)

zipCodeLookup(object, callback)

cityStateLookup(object, callback)

usps-webtools's People

Contributors

Stargazers

Watchers

Forkers

usps-webtools's Issues

Recommend Projects

Recommend Topics

Recommend Org