ghcrawler - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "ghcrawler",
-  "version": "0.1.0",
-  "description": "A simple, resilient GitHub API client for bulk retrieval of GitHub resources",
-  "main": "./lib/ghrequestor.js",
+  "version": "0.1.1",
+  "description": "A robust GitHub API crawler that walks a queue of GitHub entities retrieving and storing their contents.",
+  "main": "./lib/crawler.js",
   "bin": {
-    "ghrequestor": "./lib/ghrequestor.js"
+    "ghcrawler": "./lib/crawler.js"
   },
@@ -15,25 +15,22 @@ "scripts": {
     "api",
-    "rate-limit",
-    "retry",
+    "crawler",
     "pagination"
   ],
-  "author": "Jeff McAffer <[e-mail]>",
+  "author": "William Bartholomew <[e-mail]>",
   "license": "MIT",
-  "files": [
-    "index.js",
-    "lib/ghrequestor.js"
-  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/microsoft/ghcrawler.git"
+  },
+  "homepage": "https://github.com/microsoft/ghcrawler#readme",
+  "bugs": {
+    "url": "https://github.com/microsoft/ghcrawler"
+  },
   "dependencies": {
-    "q": "^1.4.1",
-    "requestretry": "^1.12.0"
+    "moment": "2.15.2"
   },
-  "devDependencies": {
-    "chai": "^3.5.0",
-    "grunt": "^1.0.1",
-    "grunt-mocha-test": "^0.13.2",
-    "mocha": "^3.1.2"
-  },
+  "devDependencies": {},
   "jshintConfig": {
     "esversion": "es6"
   }
-}
+}

README.md

@@ -1,17 +0,13 @@
-![Version](https://img.shields.io/npm/v/ghrequestor.svg)
-![License](https://img.shields.io/github/license/Microsoft/ghrequestor.svg)
-![Downloads](https://img.shields.io/npm/dt/ghrequestor.svg)
+![Version](https://img.shields.io/npm/v/ghcrawler.svg)
+![License](https://img.shields.io/github/license/Microsoft/ghcrawler.svg)
+![Downloads](https://img.shields.io/npm/dt/ghcrawler.svg)
 
-# GHRequestor
-A simple, resilient GitHub API client that:
+# GHCrawler
+A robust GitHub API crawler that walks a queue of GitHub entities transitively retrieving and storing their contents. GHCrawler is great for:
 
-* Is great for bulk fetching of resources from the GitHub API.
-* Retries on errors and various forms of rate-limiting.
-* Backs off as you reach your API limit.
-* Automatically fetches all pages of a multi-page resource.
-* Reports comprehensive data on number of pages fetched, retry attempts, and length of delays.
+* Retreiving all GitHub entities related to an org, repo, or user
+* Efficiently storing and the retrieved entities
+* Keeping the stored data up to date when used in conjunction with a GitHub event tracker
 
-GHRequestor is a relatively low-level facility intended for traversing large graphs of GitHub resources.
-Its primary usecase is GHCrawler, an engine that walks subsections of GitHub collecting related resources.
-This not intended to replace great modules like octonode or github.
+GHCrawler focuses on successively retrieving and walking GitHub resources supplied on a queue.  Each resource is fetched, analyzed, stored and plumbed for more resources to fetch. Discovered resources are themselves queued for further processing.  The crawler is careful to not repeatedly fetch the same resource.
 
@@ -18,0 +14,0 @@ # Examples

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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 1 instance in 1 package

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11524

increased by37.75%

Dependency count

1

decreased by-50%

Dev dependency count

0

decreased by-100%

Number of package files

7

increased by75%

Lines of code

203

increased by52.63%

Number of low maintenance alerts

1

decreased by-50%

Number of low quality alerts

2

decreased by-33.33%

Worsened metrics

Number of lines in readme file

24

decreased by-14.29%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedmoment@2.15.2

• + Addedmoment@2.15.2(transitive)

• - Removedq@^1.4.1

• - Removedrequestretry@^1.12.0

• - Removedajv@6.12.6(transitive)

• - Removedasn1@0.2.6(transitive)

• - Removedassert-plus@1.0.0(transitive)

• - Removedasynckit@0.4.0(transitive)

• - Removedaws-sign2@0.7.0(transitive)

• - Removedaws4@1.13.2(transitive)

• - Removedbcrypt-pbkdf@1.0.2(transitive)

• - Removedcaseless@0.12.0(transitive)

• - Removedcombined-stream@1.0.8(transitive)

• - Removedcore-util-is@1.0.2(transitive)

• - Removeddashdash@1.14.1(transitive)

• - Removeddelayed-stream@1.0.0(transitive)

• - Removedecc-jsbn@0.1.2(transitive)

• - Removedextend@3.0.2(transitive)

• - Removedextsprintf@1.3.0(transitive)

• - Removedfast-deep-equal@3.1.3(transitive)

• - Removedfast-json-stable-stringify@2.1.0(transitive)

• - Removedforever-agent@0.6.1(transitive)

• - Removedform-data@2.3.3(transitive)

• - Removedgetpass@0.1.7(transitive)

• - Removedhar-schema@2.0.0(transitive)

• - Removedhar-validator@5.1.5(transitive)

• - Removedhttp-signature@1.2.0(transitive)

• - Removedis-typedarray@1.0.0(transitive)

• - Removedisstream@0.1.2(transitive)

• - Removedjsbn@0.1.1(transitive)

• - Removedjson-schema@0.4.0(transitive)

• - Removedjson-schema-traverse@0.4.1(transitive)

• - Removedjson-stringify-safe@5.0.1(transitive)

• - Removedjsprim@1.4.2(transitive)

• - Removedlodash@4.17.21(transitive)

• - Removedmime-db@1.52.0(transitive)

• - Removedmime-types@2.1.35(transitive)

• - Removedoauth-sign@0.9.0(transitive)

• - Removedperformance-now@2.1.0(transitive)

• - Removedpsl@1.15.0(transitive)

• - Removedpunycode@2.3.1(transitive)

• - Removedq@1.5.1(transitive)

• - Removedqs@6.5.3(transitive)

• - Removedrequest@2.88.2(transitive)

• - Removedrequestretry@1.13.0(transitive)

• - Removedsafe-buffer@5.2.1(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedsshpk@1.18.0(transitive)

• - Removedtough-cookie@2.5.0(transitive)

• - Removedtunnel-agent@0.6.0(transitive)

• - Removedtweetnacl@0.14.5(transitive)

• - Removeduri-js@4.4.1(transitive)

• - Removeduuid@3.4.0(transitive)

• - Removedverror@1.10.0(transitive)

• - Removedwhen@3.7.8(transitive)