npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

simply-oauth

v1.0.1

Published

Fork of node-oauth for interacting with OAuth 1.0, 1.0A, 2 and Echo. Updated to use Async functions rather than callbacks

Downloads

4

Readme

simply-oauth

This is a fork of node-oauth to modernize the API with async functions and ES6+ features.

Original work by Ciaran Jessup: node-oauth

This library provides a simple API for querying OAuth endpoints.

Installation

npm install simply-oauth

Usage

All four request types (GET, POST, PUT, DELETE) follow the same invocation and response flow.
Invoke the desired request type via oauth.[get|post|put|delete].

API Return Behavior

Each method returns a Promise. The promise resolves into an object with three potential keys:
{ error, data, response }

  • error: undefined or Number
    • Undefined if no error, else holds the response status code (404, 500, etc.)
  • data: String
    • data returned from the response
  • response: IncomingMessage

The Promise rejects if it encounters an operational or Node.js error during the request.
3XX - 5XX Response Codes are NOT thrown as errors from the Promise.

OAuth 1.0/A

Creating an OAuth object

const { OAuth } = require('simply-oauth');

const oauth = new OAuth(
    'http://requestUrl.com', // Request Token URL
    'http://accessUrl.com',  // Access Token URL
    'consumerKey',           // Application Consumer Key
    'consumerSecret',        // Application Consumer Secret
    '1.0A',                  // OAuth Version
    null,                    // Authorize Callback
    'HMAC-SHA1'              // Signature Method
);

Sending a GET request

try {
    const { error, data, response } = await oauth.get(
        'http://url.com',
        'oauth_token',
        'oauth_secret'
    );
    if (error) {
        // Handle response error
    }
    const parsedData = JSON.parse(data);
} catch (e) {
    // Handle execution error
}

Sending a POST request

const postData = {
    someKey: 'someValue'
};
try {
    const { error, data, response } = await oauth.post(
        'http://url.com',
        'oauth_token',
        'oauth_secret',
        postData
    );
    if (error) {
        // Handle response error
    }
}
catch (e) {
    // Handle execution error
}

Sending a PUT request

const putData = {
    someKey: 'someValue'
};
try {
    const { error, data, response } = await oauth.put(
        'http://url.com',
        'oauth_token',
        'oauth_secret',
        putData
    );
    if (error) {
        // Handle response error
    }
}
catch (e) {
    // Handle execution error
}

Sending a DELETE request

try {
    const { error, data, response } = await oauth.delete(
        'http://url.com',
        'oauth_token',
        'oauth_secret'
    );
    if (error) {
        // Handle response error
    }
}
catch (e) {
    // Handle execution error
}

POST/PUT Supported Types

This package supports sending the following types of data:

  • String
  • Buffer
  • Object