github - npm Package Compare versions

Comparing version 5.3.3 to 6.0.0

CHANGELOG.md

 # CHANGELOG
 
+## 6.0.0
+
+Breaking changes:
+  * Move projects to its own section.
+  * Project endpoint url changes.
+  * Several additional breaking endpoint url changes.
+
+Features:
+  * Add installation repository endpoints.
+  * Add fingerprint param to update-authorization endpoint.
+
 ## 5.3.3
@@ -4,0 +15,0 @@

examples/addCollaborator.js

@@ -18,5 +18,5 @@ "use strict";
     repo: "test",
-    collabuser: "first9890"
+    username: "first9890"
 }, function(err, res) {
     console.log(err, res);
 });

examples/getFollowing.js

@@ -16,5 +16,5 @@ "use strict";
 github.users.getFollowingForUser({
-    user: "defunkt"
+    username: "defunkt"
 }, function(err, res) {
     console.log(err, res);
 });

examples/getUserOrgs.js

@@ -22,3 +22,3 @@ "use strict";
 github.orgs.getForUser({
-    owner: "tj",
+    username: "tj",
     per_page: 100
@@ -25,0 +25,0 @@ }, function(err, res) {

package.json

 {
   "name": "github",
-  "version": "5.3.3",
+  "version": "6.0.0",
   "description": "NodeJS wrapper for the GitHub API",
@@ -50,3 +50,3 @@ "author": "Mike de Boer <[e-mail]>",
     "name": "node-github",
-    "version": "5.3.3",
+    "version": "6.0.0",
     "template": {
@@ -53,0 +53,0 @@ "withCompare": true

test/activityTest.js

@@ -147,6 +147,6 @@ /*
 
-    it("should successfully execute GET /users/:owner/events (getEventsForUser)",  function(next) {
+    it("should successfully execute GET /users/:username/events (getEventsForUser)",  function(next) {
         client.activity.getEventsForUser(
             {
-                owner: "String",
+                username: "String",
                 page: "Number",
@@ -163,6 +163,6 @@ per_page: "Number"
 
-    it("should successfully execute GET /users/:owner/events/orgs/:org (getEventsForUserOrg)",  function(next) {
+    it("should successfully execute GET /users/:username/events/orgs/:org (getEventsForUserOrg)",  function(next) {
         client.activity.getEventsForUserOrg(
             {
-                owner: "String",
+                username: "String",
                 org: "String",
@@ -180,6 +180,6 @@ page: "Number",
 
-    it("should successfully execute GET /users/:owner/events/public (getEventsForUserPublic)",  function(next) {
+    it("should successfully execute GET /users/:username/events/public (getEventsForUserPublic)",  function(next) {
         client.activity.getEventsForUserPublic(
             {
-                owner: "String",
+                username: "String",
                 page: "Number",
@@ -196,6 +196,6 @@ per_page: "Number"
 
-    it("should successfully execute GET /users/:owner/received_events (getEventsReceived)",  function(next) {
+    it("should successfully execute GET /users/:username/received_events (getEventsReceived)",  function(next) {
         client.activity.getEventsReceived(
             {
-                owner: "String",
+                username: "String",
                 page: "Number",
@@ -212,6 +212,6 @@ per_page: "Number"
 
-    it("should successfully execute GET /users/:owner/received_events/public (getEventsReceivedPublic)",  function(next) {
+    it("should successfully execute GET /users/:username/received_events/public (getEventsReceivedPublic)",  function(next) {
         client.activity.getEventsReceivedPublic(
             {
-                owner: "String",
+                username: "String",
                 page: "Number",
@@ -321,2 +321,4 @@ per_page: "Number"
             {
+                sort: "String",
+                direction: "String",
                 page: "Number",
@@ -333,6 +335,8 @@ per_page: "Number"
 
-    it("should successfully execute GET /users/:owner/starred (getStarredReposForUser)",  function(next) {
+    it("should successfully execute GET /users/:username/starred (getStarredReposForUser)",  function(next) {
         client.activity.getStarredReposForUser(
             {
-                owner: "String",
+                username: "String",
+                sort: "String",
+                direction: "String",
                 page: "Number",
@@ -363,6 +367,6 @@ per_page: "Number"
 
-    it("should successfully execute GET /users/:owner/subscriptions (getWatchedReposForUser)",  function(next) {
+    it("should successfully execute GET /users/:username/subscriptions (getWatchedReposForUser)",  function(next) {
         client.activity.getWatchedReposForUser(
             {
-                owner: "String",
+                username: "String",
                 page: "Number",
@@ -369,0 +373,0 @@ per_page: "Number"

test/authorizationTest.js

@@ -214,3 +214,4 @@ /*
                 note: "String",
-                note_url: "String"
+                note_url: "String",
+                fingerprint: "String"
             },
@@ -217,0 +218,0 @@ function(err, res) {

test/enterpriseTest.js

@@ -241,6 +241,6 @@ /*
 
-    it("should successfully execute POST /admin/ldap/users/:user/sync (syncLdapForUser)",  function(next) {
+    it("should successfully execute POST /admin/ldap/users/:username/sync (syncLdapForUser)",  function(next) {
         client.enterprise.syncLdapForUser(
             {
-                user: "String"
+                username: "String"
             },
@@ -282,6 +282,6 @@ function(err, res) {
 
-    it("should successfully execute PATCH /admin/ldap/users/:user/mapping (updateLdapForUser)",  function(next) {
+    it("should successfully execute PATCH /admin/ldap/users/:username/mapping (updateLdapForUser)",  function(next) {
         client.enterprise.updateLdapForUser(
             {
-                user: "String",
+                username: "String",
                 ldap_dn: "String"
@@ -288,0 +288,0 @@ },

test/gistsTest.js

@@ -158,5 +158,5 @@ /*
             {
+                since: "Date",
                 page: "Number",
-                per_page: "Number",
-                since: "Date"
+                per_page: "Number"
             },
@@ -211,9 +211,9 @@ function(err, res) {
 
-    it("should successfully execute GET /users/:owner/gists (getForUser)",  function(next) {
+    it("should successfully execute GET /users/:username/gists (getForUser)",  function(next) {
         client.gists.getForUser(
             {
-                owner: "String",
+                username: "String",
+                since: "Date",
                 page: "Number",
-                per_page: "Number",
-                since: "Date"
+                per_page: "Number"
             },
@@ -220,0 +220,0 @@ function(err, res) {

test/integrationsTest.js

@@ -28,7 +28,21 @@ /*
 
+    it("should successfully execute POST /installations/:installation_id/repositories/:repository_id (addRepoToInstallation)",  function(next) {
+        client.integrations.addRepoToInstallation(
+            {
+                installation_id: "String",
+                repository_id: "String"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute POST /installations/:installation_id/access_tokens (createInstallationToken)",  function(next) {
         client.integrations.createInstallationToken(
             {
-                installation_id: "Number",
-                user_id: "Number"
+                installation_id: "String",
+                user_id: "String"
             },
@@ -82,2 +96,16 @@ function(err, res) {
     });
+
+    it("should successfully execute POST /installations/:installation_id/repositories/:repository_id (removeRepoFromInstallation)",  function(next) {
+        client.integrations.removeRepoFromInstallation(
+            {
+                installation_id: "String",
+                repository_id: "String"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
 });

test/issuesTest.js

@@ -343,3 +343,3 @@ /*
 
-    it("should successfully execute GET /repos/:owner/:repo/issues/:number/events (getEvents)",  function(next) {
+    it("should successfully execute GET /repos/:owner/:repo/issues/:issue_number/events (getEvents)",  function(next) {
         client.issues.getEvents(
@@ -349,3 +349,3 @@ {
                 repo: "String",
-                number: "Number",
+                issue_number: "Number",
                 page: "Number",
@@ -378,3 +378,3 @@ per_page: "Number"
 
-    it("should successfully execute GET /repos/:owner/:repo/issues/:number/timeline (getEventsTimeline)",  function(next) {
+    it("should successfully execute GET /repos/:owner/:repo/issues/:issue_number/timeline (getEventsTimeline)",  function(next) {
         client.issues.getEventsTimeline(
@@ -384,3 +384,3 @@ {
                 repo: "String",
-                number: "Number",
+                issue_number: "Number",
                 page: "Number",
@@ -387,0 +387,0 @@ per_page: "Number"

test/migrationsTest.js

@@ -163,3 +163,4 @@ /*
                 owner: "String",
-                name: "String"
+                name: "String",
+                use_lfs: "String"
             },
@@ -209,3 +210,3 @@ function(err, res) {
 
-    it("should successfully execute DELETE /orgs/:org/migrations/:id/repos/:repo/lock (unlockRepoLockedForMigration)",  function(next) {
+    it("should successfully execute DELETE /orgs/:org/migrations/:id/repos/:repo_name/lock (unlockRepoLockedForMigration)",  function(next) {
         client.migrations.unlockRepoLockedForMigration(
@@ -215,3 +216,3 @@ {
                 id: "String",
-                repo: "String"
+                repo_name: "String"
             },
@@ -218,0 +219,0 @@ function(err, res) {

test/orgsTest.js

@@ -28,7 +28,7 @@ /*
 
-    it("should successfully execute PUT /orgs/:org/memberships/:user (addOrganizationMembership)",  function(next) {
-        client.orgs.addOrganizationMembership(
+    it("should successfully execute PUT /orgs/:org/memberships/:username (addOrgMembership)",  function(next) {
+        client.orgs.addOrgMembership(
             {
                 org: "String",
-                user: "String",
+                username: "String",
                 role: "String"
@@ -44,7 +44,7 @@ },
 
-    it("should successfully execute PUT /teams/:id/memberships/:user (addTeamMembership)",  function(next) {
+    it("should successfully execute PUT /teams/:id/memberships/:username (addTeamMembership)",  function(next) {
         client.orgs.addTeamMembership(
             {
                 id: "String",
-                user: "String",
+                username: "String",
                 role: "String"
@@ -76,7 +76,7 @@ },
 
-    it("should successfully execute GET /orgs/:org/members/:owner (checkMembership)",  function(next) {
+    it("should successfully execute GET /orgs/:org/members/:username (checkMembership)",  function(next) {
         client.orgs.checkMembership(
             {
                 org: "String",
-                owner: "String"
+                username: "String"
             },
@@ -91,7 +91,7 @@ function(err, res) {
 
-    it("should successfully execute GET /orgs/:org/public_members/:user (checkPublicMembership)",  function(next) {
+    it("should successfully execute GET /orgs/:org/public_members/:username (checkPublicMembership)",  function(next) {
         client.orgs.checkPublicMembership(
             {
                 org: "String",
-                user: "String"
+                username: "String"
             },
@@ -121,7 +121,7 @@ function(err, res) {
 
-    it("should successfully execute DELETE /orgs/:org/public_members/:user (concealMembership)",  function(next) {
+    it("should successfully execute DELETE /orgs/:org/public_members/:username (concealMembership)",  function(next) {
         client.orgs.concealMembership(
             {
                 org: "String",
-                user: "String"
+                username: "String"
             },
@@ -275,6 +275,6 @@ function(err, res) {
 
-    it("should successfully execute GET /users/:owner/orgs (getForUser)",  function(next) {
+    it("should successfully execute GET /users/:username/orgs (getForUser)",  function(next) {
         client.orgs.getForUser(
             {
-                owner: "String",
+                username: "String",
                 page: "Number",
@@ -337,7 +337,7 @@ per_page: "Number"
 
-    it("should successfully execute GET /orgs/:org/memberships/:user (getOrganizationMembership)",  function(next) {
-        client.orgs.getOrganizationMembership(
+    it("should successfully execute GET /orgs/:org/memberships/:username (getOrgMembership)",  function(next) {
+        client.orgs.getOrgMembership(
             {
                 org: "String",
-                user: "String"
+                username: "String"
             },
@@ -352,15 +352,2 @@ function(err, res) {
 
-    it("should successfully execute GET /user/memberships/orgs (getOrganizationMemberships)",  function(next) {
-        client.orgs.getOrganizationMemberships(
-            {
-                state: "String"
-            },
-            function(err, res) {
-                Assert.equal(err, null);
-                // other assertions go here
-                next();
-            }
-        );
-    });
-
     it("should successfully execute GET /orgs/:org/public_members (getPublicMembers)",  function(next) {
@@ -408,7 +395,7 @@ client.orgs.getPublicMembers(
 
-    it("should successfully execute GET /teams/:id/memberships/:user (getTeamMembership)",  function(next) {
+    it("should successfully execute GET /teams/:id/memberships/:username (getTeamMembership)",  function(next) {
         client.orgs.getTeamMembership(
             {
                 id: "String",
-                user: "String"
+                username: "String"
             },
@@ -467,7 +454,7 @@ function(err, res) {
 
-    it("should successfully execute PUT /orgs/:org/public_members/:user (publicizeMembership)",  function(next) {
+    it("should successfully execute PUT /orgs/:org/public_members/:username (publicizeMembership)",  function(next) {
         client.orgs.publicizeMembership(
             {
                 org: "String",
-                user: "String"
+                username: "String"
             },
@@ -482,7 +469,7 @@ function(err, res) {
 
-    it("should successfully execute DELETE /orgs/:org/members/:user (removeMember)",  function(next) {
+    it("should successfully execute DELETE /orgs/:org/members/:username (removeMember)",  function(next) {
         client.orgs.removeMember(
             {
                 org: "String",
-                user: "String"
+                username: "String"
             },
@@ -497,7 +484,7 @@ function(err, res) {
 
-    it("should successfully execute DELETE /orgs/:org/memberships/:user (removeOrganizationMembership)",  function(next) {
-        client.orgs.removeOrganizationMembership(
+    it("should successfully execute DELETE /orgs/:org/memberships/:username (removeOrgMembership)",  function(next) {
+        client.orgs.removeOrgMembership(
             {
                 org: "String",
-                user: "String"
+                username: "String"
             },
@@ -512,7 +499,7 @@ function(err, res) {
 
-    it("should successfully execute DELETE /teams/:id/memberships/:user (removeTeamMembership)",  function(next) {
+    it("should successfully execute DELETE /teams/:id/memberships/:username (removeTeamMembership)",  function(next) {
         client.orgs.removeTeamMembership(
             {
                 id: "String",
-                user: "String"
+                username: "String"
             },
@@ -519,0 +506,0 @@ function(err, res) {

test/pullRequestsTest.js

@@ -116,3 +116,3 @@ /*
 
-    it("should successfully execute DELETE /repos/:owner/:repo/pulls/comments/:number (deleteComment)",  function(next) {
+    it("should successfully execute DELETE /repos/:owner/:repo/pulls/comments/:id (deleteComment)",  function(next) {
         client.pullRequests.deleteComment(
@@ -122,3 +122,3 @@ {
                 repo: "String",
-                number: "Number"
+                id: "String"
             },
@@ -133,3 +133,3 @@ function(err, res) {
 
-    it("should successfully execute PATCH /repos/:owner/:repo/pulls/comments/:number (editComment)",  function(next) {
+    it("should successfully execute PATCH /repos/:owner/:repo/pulls/comments/:id (editComment)",  function(next) {
         client.pullRequests.editComment(
@@ -139,3 +139,3 @@ {
                 repo: "String",
-                number: "Number",
+                id: "String",
                 body: "String"
@@ -187,3 +187,3 @@ },
 
-    it("should successfully execute GET /repos/:owner/:repo/pulls/comments/:number (getComment)",  function(next) {
+    it("should successfully execute GET /repos/:owner/:repo/pulls/comments/:id (getComment)",  function(next) {
         client.pullRequests.getComment(
@@ -193,3 +193,3 @@ {
                 repo: "String",
-                number: "Number"
+                id: "String"
             },
@@ -301,3 +301,4 @@ function(err, res) {
                 body: "String",
-                state: "String"
+                state: "String",
+                base: "String"
             },
@@ -304,0 +305,0 @@ function(err, res) {

test/usersTest.js

@@ -28,6 +28,6 @@ /*
 
-    it("should successfully execute PATCH /user/repository_invitations/:id (acceptRepoInvite)",  function(next) {
+    it("should successfully execute PATCH /user/repository_invitations/:invitation_id (acceptRepoInvite)",  function(next) {
         client.users.acceptRepoInvite(
             {
-                id: "String"
+                invitation_id: "String"
             },
@@ -55,6 +55,6 @@ function(err, res) {
 
-    it("should successfully execute GET /user/following/:user (checkFollowing)",  function(next) {
+    it("should successfully execute GET /user/following/:username (checkFollowing)",  function(next) {
         client.users.checkFollowing(
             {
-                user: "String"
+                username: "String"
             },
@@ -69,7 +69,7 @@ function(err, res) {
 
-    it("should successfully execute GET /users/:user/following/:other_user (checkIfOneFollowersOther)",  function(next) {
+    it("should successfully execute GET /users/:username/following/:target_user (checkIfOneFollowersOther)",  function(next) {
         client.users.checkIfOneFollowersOther(
             {
-                user: "String",
-                other_user: "String"
+                username: "String",
+                target_user: "String"
             },
@@ -111,6 +111,6 @@ function(err, res) {
 
-    it("should successfully execute DELETE /user/repository_invitations/:id (declineRepoInvite)",  function(next) {
+    it("should successfully execute DELETE /user/repository_invitations/:invitation_id (declineRepoInvite)",  function(next) {
         client.users.declineRepoInvite(
             {
-                id: "String"
+                invitation_id: "String"
             },
@@ -164,6 +164,6 @@ function(err, res) {
 
-    it("should successfully execute DELETE /users/:user/site_admin (demote)",  function(next) {
+    it("should successfully execute DELETE /users/:username/site_admin (demote)",  function(next) {
         client.users.demote(
             {
-                user: "String"
+                username: "String"
             },
@@ -178,4 +178,4 @@ function(err, res) {
 
-    it("should successfully execute PATCH /user/memberships/orgs/:org (editOrganizationMembership)",  function(next) {
-        client.users.editOrganizationMembership(
+    it("should successfully execute PATCH /user/memberships/orgs/:org (editOrgMembership)",  function(next) {
+        client.users.editOrgMembership(
             {
@@ -193,6 +193,6 @@ org: "String",
 
-    it("should successfully execute PUT /user/following/:user (followUser)",  function(next) {
+    it("should successfully execute PUT /user/following/:username (followUser)",  function(next) {
         client.users.followUser(
             {
-                user: "String"
+                username: "String"
             },
@@ -272,6 +272,6 @@ function(err, res) {
 
-    it("should successfully execute GET /users/:user/followers (getFollowersForUser)",  function(next) {
+    it("should successfully execute GET /users/:username/followers (getFollowersForUser)",  function(next) {
         client.users.getFollowersForUser(
             {
-                user: "String",
+                username: "String",
                 page: "Number",
@@ -302,6 +302,6 @@ per_page: "Number"
 
-    it("should successfully execute GET /users/:user/following (getFollowingForUser)",  function(next) {
+    it("should successfully execute GET /users/:username/following (getFollowingForUser)",  function(next) {
         client.users.getFollowingForUser(
             {
-                user: "String",
+                username: "String",
                 page: "Number",
@@ -318,6 +318,6 @@ per_page: "Number"
 
-    it("should successfully execute GET /users/:user (getForUser)",  function(next) {
+    it("should successfully execute GET /users/:username (getForUser)",  function(next) {
         client.users.getForUser(
             {
-                user: "String"
+                username: "String"
             },
@@ -386,6 +386,6 @@ function(err, res) {
 
-    it("should successfully execute GET /users/:user/keys (getKeysForUser)",  function(next) {
+    it("should successfully execute GET /users/:username/keys (getKeysForUser)",  function(next) {
         client.users.getKeysForUser(
             {
-                user: "String",
+                username: "String",
                 page: "Number",
@@ -402,4 +402,4 @@ per_page: "Number"
 
-    it("should successfully execute GET /user/memberships/orgs/:org (getOrganizationMembership)",  function(next) {
-        client.users.getOrganizationMembership(
+    it("should successfully execute GET /user/memberships/orgs/:org (getOrgMembership)",  function(next) {
+        client.users.getOrgMembership(
             {
@@ -416,2 +416,15 @@ org: "String"
 
+    it("should successfully execute GET /user/memberships/orgs (getOrgMemberships)",  function(next) {
+        client.users.getOrgMemberships(
+            {
+                state: "String"
+            },
+            function(err, res) {
+                Assert.equal(err, null);
+                // other assertions go here
+                next();
+            }
+        );
+    });
+
     it("should successfully execute GET /user/orgs (getOrgs)",  function(next) {
@@ -456,6 +469,6 @@ client.users.getOrgs(
 
-    it("should successfully execute PUT /users/:user/site_admin (promote)",  function(next) {
+    it("should successfully execute PUT /users/:username/site_admin (promote)",  function(next) {
         client.users.promote(
             {
-                user: "String"
+                username: "String"
             },
@@ -470,6 +483,6 @@ function(err, res) {
 
-    it("should successfully execute PUT /users/:user/suspended (suspend)",  function(next) {
+    it("should successfully execute PUT /users/:username/suspended (suspend)",  function(next) {
         client.users.suspend(
             {
-                user: "String"
+                username: "String"
             },
@@ -484,6 +497,6 @@ function(err, res) {
 
-    it("should successfully execute DELETE /user/following/:user (unfollowUser)",  function(next) {
+    it("should successfully execute DELETE /user/following/:username (unfollowUser)",  function(next) {
         client.users.unfollowUser(
             {
-                user: "String"
+                username: "String"
             },
@@ -498,6 +511,6 @@ function(err, res) {
 
-    it("should successfully execute DELETE /users/:user/suspended (unsuspend)",  function(next) {
+    it("should successfully execute DELETE /users/:username/suspended (unsuspend)",  function(next) {
         client.users.unsuspend(
             {
-                user: "String"
+                username: "String"
             },
@@ -504,0 +517,0 @@ function(err, res) {

No alert changes

Improved metrics

Total package byte prevSize

1801325

11.88%

Number of package files

63

1.61%

Lines of code

51488

11.9%

No dependency changes