chirp-rest - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

package.json

 {
   "name": "chirp-rest",
-  "version": "0.0.0",
-  "description": "chirp-rest ==========",
+  "version": "0.0.1",
+  "description": "twitter rest apis in nodejs",
   "main": "index.js",
@@ -24,3 +24,14 @@ "scripts": {
   },
-  "homepage": "https://github.com/ddo/chirp-rest"
+  "homepage": "https://github.com/ddo/chirp-rest",
+  "dependencies": {
+    "debug": "^0.8.1",
+    "oauth-1.0a": "^0.1.0",
+    "request": "^2.36.0"
+  },
+  "devDependencies": {
+    "chai": "^1.9.1",
+    "coveralls": "^2.10.0",
+    "istanbul": "^0.2.10",
+    "mocha": "^1.19.0"
+  }
 }

README.md

@@ -1,2 +0,89 @@
-chirp-rest
-==========
+chirp-rest [![Build Status](https://travis-ci.org/ddo/chirp-rest.svg)](https://travis-ci.org/ddo/chirp-rest)
+==============
+
+> twitter rest apis in nodejs
+
+[![NPM version](https://badge.fury.io/js/chirp-rest.png)](http://badge.fury.io/js/chirp-rest)
+[![Dependency Status](https://david-dm.org/ddo/chirp-rest.png?theme=shields.io)](https://david-dm.org/ddo/chirp-rest)
+
+[![Coverage Status](https://coveralls.io/repos/ddo/chirp-rest/badge.png?branch=master)](https://coveralls.io/r/ddo/chirp-rest?branch=master)
+[![Code Climate](https://codeclimate.com/github/ddo/chirp-rest.png)](https://codeclimate.com/github/ddo/chirp-rest)
+
+## Installation
+
+```
+npm i chirp-rest --save
+```
+
+## Usage
+
+```js
+var ChirpRest = require('./');
+
+var twitter = new ChirpRest({
+    consumer: {
+        public: 'xxxxx',
+        secret: 'xxxxx'
+    },
+    token: {
+        public: 'xxxxx'
+        secret: 'xxxxx'
+    }
+});
+
+//get user timeline
+twitter.get('https://api.twitter.com/1.1/statuses/user_timeline.json', function(err, res, body) {
+    //body -> tweets
+});
+```
+
+## [Example](/example.js)
+
+* get user timeline
+
+```js
+twitter.get('https://api.twitter.com/1.1/statuses/user_timeline.json', function(err, res, body) {
+    //body -> tweets
+});
+```
+
+* get user timeline limit 5
+
+```js
+twitter.get('https://api.twitter.com/1.1/statuses/user_timeline.json', {
+    count: 5
+}, function(err, res, body) {
+    //body -> tweets
+});
+```
+
+* get user timeline
+
+```js
+twitter.get('https://api.twitter.com/1.1/statuses/user_timeline.json', function(err, res, body) {
+    //body -> tweets
+});
+```
+
+* post new status
+
+```js
+twitter.post('https://api.twitter.com/1.1/statuses/update.json', {
+    status: 'chirp chirp'
+}, function(err, res, body) {
+    //body -> tweet data
+});
+```
+
+https://dev.twitter.com/docs/api/1.1
+
+## API
+
+* ``.get(url, parameters, callback)``
+* ``.post(url, parameters, callback)``
+
+## Option
+
+* ``url``:``String`` Twitter api endpoint
+* ``parameters``: ``Object`` Twitter api parameters ``optional``
+* ``callback``

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 4 instances in 1 package

Fixed alerts

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11611

increased by618.95%

Number of package files

9

increased by200%

Lines of code

204

increased byInfinity%

Number of lines in readme file

90

increased by2900%

Worsened metrics

Dependency count

3

increased byInfinity%

Dev dependency count

4

increased byInfinity%

Number of low supply chain risk alerts

8

increased byInfinity%

Dependency changes

• + Addeddebug@^0.8.1

• + Addedoauth-1.0a@^0.1.0

• + Addedrequest@^2.36.0

• + Addedajv@6.12.6(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@1.0.0(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaws-sign2@0.7.0(transitive)

• + Addedaws4@1.13.0(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedcaseless@0.12.0(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedcore-util-is@1.0.2(transitive)

• + Addedcrypto-js@3.1.8(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddebug@0.8.1(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedforever-agent@0.6.1(transitive)

• + Addedform-data@2.3.3(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedhar-schema@2.0.0(transitive)

• + Addedhar-validator@5.1.5(transitive)

• + Addedhttp-signature@1.2.0(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedoauth-1.0a@0.1.1(transitive)

• + Addedoauth-sign@0.9.0(transitive)

• + Addedperformance-now@2.1.0(transitive)

• + Addedpsl@1.9.0(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedqs@6.5.3(transitive)

• + Addedrequest@2.88.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedtough-cookie@2.5.0(transitive)

• + Addedtunnel-agent@0.6.0(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedverror@1.10.0(transitive)