0.1.0 (#1)

Author: HunterLarco

.gitignore

@@ -0,0 +1,15 @@
+# Mac OS
+.DS_Store
+
+# Ignore Node Modules
+node_modules/
+
+# Logs
+*.log
+npm-debug.log*
+
+# Ignore backup files.
+*~
+
+# Ignore Vim swap files.
+.*.swp

.npmignore

@@ -0,0 +1,22 @@
+# Mac OS
+.DS_Store
+
+# Ignore Node Modules
+node_modules/
+
+# Logs
+*.log
+npm-debug.log*
+
+# Ignore backup files.
+*~
+
+# Ignore Vim swap files.
+.*.swp
+
+# Ignore Examples
+examples/
+
+# Ignore prettier
+.prettierignore
+.prettierrc.json

.prettierignore

@@ -0,0 +1,2 @@
+# Ignore Node Modules
+node_modules/

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "printWidth": 80,
+  "singleQuote": true,
+  "trailingComma": "es5"
+}

README.md

@@ -0,0 +1,87 @@
+# Twitter V2 API for Node.js
+
+An asynchronous client library for the Twitter REST and Streaming [V2 API's](https://developer.twitter.com/en/docs/twitter-api/early-access).
+
+[![NPM](https://nodei.co/npm/twitter-v2.png)](https://nodei.co/npm/twitter-v2/)
+
+```javascript
+const Twitter = require('twitter-v2');
+
+const client = new Twitter({
+  consumer_key: '',
+  consumer_secret: '',
+  access_token_key: '',
+  access_token_secret: '',
+});
+
+const { data } = await client.get('tweets', { ids: '1228393702244134912' });
+console.log(data);
+```
+
+## Installation
+
+`npm install twitter-v2`
+
+## Quick Start
+
+You will need valid Twitter developer credentials in the form of a set of consumer and access tokens/keys. You can get early access V2 keys [here](https://developer.twitter.com/en/apply-for-access).
+
+## For User based authentication:
+
+```javascript
+const client = new Twitter({
+  consumer_key: '',
+  consumer_secret: '',
+  access_token_key: '',
+  access_token_secret: '',
+});
+```
+
+## For App based authentication:
+
+```javascript
+const client = new Twitter({
+  consumer_key: '',
+  consumer_secret: '',
+});
+```
+
+Note - You will not have access to all endpoints while using Application Only authentication, but you will have access to higher API limits.
+
+## REST API
+
+You can make GET and POST requests against the REST API via the convenience methods.
+
+```javascript
+client.get(path, urlParams);
+client.post(path, body, urlParams);
+```
+
+The REST API convenience methods return Promises.
+
+## Streaming API
+
+Use the streaming convenience methods for any stream APIs.
+
+```javascript
+client.stream(path, urlParams);
+```
+
+The Streaming API will return an async iterator with the convenience method `close()`.
+
+```javascript
+const stream = client.stream(path, urlParams);
+
+for await (const { data } of stream) {
+  console.log(data);
+}
+
+stream.close();
+```
+
+## V1.1 API Support
+
+This module does not support previous versions of the Twitter API, however it works well with the following V1.1 modules
+
+[![NPM](https://nodei.co/npm/twitter.png?compact=true)](https://nodei.co/npm/twitter/)
+[![NPM](https://nodei.co/npm/twit.png?compact=true)](https://nodei.co/npm/twit/)

examples/get_tweets.js

@@ -0,0 +1,17 @@
+const Credentials = require('./helpers/credentials.js');
+const Twitter = require('../src/twitter.js');
+
+async function main() {
+  const args = require('minimist')(process.argv.slice(2));
+  const credentials = await Credentials.createFromCLI(args);
+
+  const client = new Twitter(credentials);
+  console.log(await client.get('tweets', { ids: '1228393702244134912' }));
+}
+
+if (require.main === module) {
+  main().catch((error) => {
+    console.error(error);
+    process.exit(1);
+  });
+}

examples/helpers/credentials.js

@@ -0,0 +1,34 @@
+const enquirer = require('enquirer');
+
+async function createFromCLI(args) {
+  const credentials = {
+    consumer_key: args['consumer-key'],
+    consumer_secret: args['consumer-secret'],
+    bearer_token: args['bearer-token'],
+    access_token: args['access-token'],
+    access_token_secret: args['access-token-secret'],
+  };
+
+  const prompts = [];
+  if (!credentials.consumer_key) {
+    prompts.push({
+      type: 'input',
+      name: 'consumer_key',
+      message: `consumer-key:`,
+    });
+  }
+  if (!credentials.consumer_secret) {
+    prompts.push({
+      type: 'input',
+      name: 'consumer_secret',
+      message: `consumer-secret:`,
+    });
+  }
+
+  const promptResults = await enquirer.prompt(prompts);
+  return { ...credentials, ...promptResults };
+}
+
+module.exports = {
+  createFromCLI,
+};

examples/search_tweets.js

@@ -0,0 +1,36 @@
+const Credentials = require('./helpers/credentials.js');
+const Twitter = require('../src/twitter.js');
+
+async function main() {
+  const args = require('minimist')(process.argv.slice(2));
+  const credentials = await Credentials.createFromCLI(args);
+
+  const client = new Twitter(credentials);
+  const { data: tweets, meta } = await client.get('tweets/search/recent', {
+    query: 'url:"https://medium.com" -is:retweet lang:en',
+    max_results: 10,
+    tweet: {
+      fields: [
+        'created_at',
+        'entities',
+        'in_reply_to_user_id',
+        'public_metrics',
+        'referenced_tweets',
+        'source',
+        'author_id',
+      ],
+    },
+  });
+
+  for (const tweet of tweets) {
+    console.log(tweet);
+  }
+  console.log(meta);
+}
+
+if (require.main === module) {
+  main().catch((error) => {
+    console.error(error);
+    process.exit(1);
+  });
+}

examples/stream_tweets.js

@@ -0,0 +1,29 @@
+const Credentials = require('./helpers/credentials.js');
+const Twitter = require('../src/twitter.js');
+
+async function main() {
+  const args = require('minimist')(process.argv.slice(2));
+  const credentials = await Credentials.createFromCLI(args);
+
+  const client = new Twitter(credentials);
+  const stream = client.stream('tweets/sample/stream');
+
+  // Close the stream after 30 seconds
+  setTimeout(() => {
+    stream.close();
+  }, 30 * 1000);
+
+  // Read data from the stream
+  for await (const { data } of stream) {
+    console.log(`${data.id}: ${data.text.replace(/\s/g, ' ')}`);
+  }
+
+  console.log('Stream closed.');
+}
+
+if (require.main === module) {
+  main().catch((error) => {
+    console.error(error);
+    process.exit(1);
+  });
+}

package-lock.json

@@ -0,0 +1,44 @@
+{
+  "name": "twitter-v2",
+  "version": "0.1.0",
+  "description": "An asynchronous client library for the Twitter REST and Streaming V2 API's.",
+  "main": "src/twitter.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HunterLarco/twitter-v2.git"
+  },
+  "keywords": [
+    "twitter",
+    "v2",
+    "api",
+    "stream",
+    "streaming",
+    "rest",
+    "oauth",
+    "twit"
+  ],
+  "author": "Hunter Larco",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/HunterLarco/twitter-v2/issues"
+  },
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "homepage": "https://github.com/HunterLarco/twitter-v2#readme",
+  "devDependencies": {
+    "enquirer": "2.3.6",
+    "minimist": "1.2.5",
+    "prettier": "2.1.1"
+  },
+  "dependencies": {
+    "abort-controller": "3.0.0",
+    "crypto": "1.0.1",
+    "node-fetch": "2.6.0",
+    "oauth-1.0a": "2.2.6",
+    "split": "1.0.1"
+  }
+}