Added Repository#listBranches, and refined overall API.

michael · michael · commit c45743e8d494 · 2012-05-09T02:11:36.000-03:00
diff --git a/github.js b/github.js
@@ -1,4 +1,4 @@
-// Github.js 0.1.2
+// Github.js 0.2.0
 // (c) 2012 Michael Aufreiter, Development Seed
 // Github.js is freely distributable under the MIT license.
 // For all details and documentation:
@@ -7,16 +7,13 @@
 (function() {
   var Github;
   var API_URL = 'https://api.github.com';
-  
-  // Github API
-  // -------
 
   Github = window.Github = function(options) {
     var username = options.username;
     var password = options.password;
 
     // Util
-    // -------
+    // =======
 
     function _request(method, path, data, cb) {
       $.ajax({
@@ -32,56 +29,71 @@
     }
 
     // USER API
-    // -------
+    // =======
 
-    Github.User = function(options) {
-      this.username = options.username;
-      var userPath = "/users/" + options.username;
+    Github.User = function() {
       this.repos = function(cb) {
-        _request("GET", userPath + "/repos?type=all", null, function(err, res) {
+        _request("GET", "/user/repos?type=all", null, function(err, res) {
           cb(err, res);
         });
       }
     };
 
 
     // Repository API
-    // -------
+    // =======
 
     Github.Repository = function(options) {
       var repo = options.name;
       var branch = options.branch;
+      var user = options.user;
       
       var that = this;
-      var repoPath = "/repos/" + username + "/" + repo;
+      var repoPath = "/repos/" + user + "/" + repo;
+
+      // Get a particular reference
+      // -------
 
-      // Get latest commit from master
-      function getLatestCommit(cb) {
-        _request("GET", repoPath + "/git/refs/heads/" + branch, null, function(err, res) {
+      this.getRef = function(ref, cb) {
+        _request("GET", repoPath + "/git/refs/heads/" + ref, null, function(err, res) {
           if (err) return cb(err);
           cb(null, res.object.sha);
         });
-      }
+      };
+
+      // List all branches of a repository
+      // -------
+
+      this.listBranches = function(cb) {
+        _request("GET", repoPath + "/git/refs/heads", null, function(err, heads) {
+          if (err) return cb(err);
+          cb(null, _.map(heads, function(head) { return _.last(head.ref.split('/')); }));
+        });
+      };
 
       // Retrieve the contents of a blob
-      function getBlob(sha, cb) {
+      // -------
+
+      this.getBlob = function(sha, cb) {
         _request("GET", repoPath + "/git/blobs/" + sha, null, function(err, res) {
           cb(err, res);
         });
-      }
+      };
 
       // Retrieve the tree a commit points to
+      // -------
 
-      function getTree(commit, cb) {
+      this.getTree = function(commit, cb) {
         _request("GET", repoPath + "/git/trees/"+commit, null, function(err, res) {
           if (err) return cb(err);
           cb(null, res.sha);
         });
-      }
+      };
 
       // Post a new blob object, getting a blob SHA back
+      // -------
 
-      function postBlob(content, cb) {
+      this.postBlob = function(content, cb) {
         var data = {
           "content": content,
           "encoding": "utf-8"
@@ -90,12 +102,13 @@
           if (err) return cb(err);
           cb(null, res.sha);
         });
-      }
+      };
 
       // Post a new tree object having a file path pointer replaced
       // with a new blob SHA getting a tree SHA back
+      // -------
 
-      function postTree(baseTree, path, blob, cb) {
+      this.postTree = function(baseTree, path, blob, cb) {
         var data = {
           "base_tree": baseTree,
           "tree": [
@@ -107,16 +120,17 @@
             }
           ]
         };
-        _request("POST",  repoPath + "/git/trees", data, function(err, res) {
+        _request("POST", repoPath + "/git/trees", data, function(err, res) {
           if (err) return cb(err);
           cb(null, res.sha);
         });
       };
 
       // Create a new commit object with the current commit SHA as the parent
       // and the new tree SHA, getting a commit SHA back
+      // -------
 
-      function createCommit(parent, tree, message, cb) {
+      this.commit = function(parent, tree, message, cb) {
         var data = {
           "message": message,
           "author": {
@@ -132,17 +146,16 @@
           if (err) return cb(err);
           cb(null, res.sha);
         });
-      }
+      };
 
       // Update the reference of your head to point to the new commit SHA
+      // -------
 
-      function updateHead(commit, cb) {
-        _request("PATCH", repoPath + "/git/refs/heads/" + branch, { "sha": commit }, function(err, res) {
+      this.updateHead = function(head, commit, cb) {
+        _request("PATCH", repoPath + "/git/refs/heads/" + head, { "sha": commit }, function(err, res) {
           cb(err);
         });
-      }
-
-
+      };
 
       // Show repository information
       // -------
@@ -153,10 +166,10 @@
         });
       };
 
-      // List all files
+      // List all files of a branch
       // -------
 
-      this.list = function(cb) {
+      this.list = function(branch, cb) {
         _request("GET", repoPath + "/git/trees/" + branch + "?recursive=1", null, function(err, res) {
           cb(err, res ? res.tree : null);
         });
@@ -166,15 +179,15 @@
       // Read file at given path
       // -------
 
-      this.read = function(path, cb) {
-        that.list(function(err, tree) {
+      this.read = function(branch, path, cb) {
+        that.list(branch, function(err, tree) {
           var file = _.select(tree, function(file) {
             return file.path === path;
           })[0];
 
           if (!file) return cb("not found", null);
 
-          getBlob(file.sha, function(err, blob) {
+          that.getBlob(file.sha, function(err, blob) {
             function decode(blob) {
               if (blob.content) {
                 var data = blob.encoding == 'base64' ?
@@ -192,26 +205,16 @@
         });
       };
 
-      // List all commits
-      // -------
-
-      this.list_commits = function (cb) {
-        _request("GET", repoPath + "/commits", null, function(err, res) {
-          if (err) return cb(err);
-          cb(null, res);
-        });
-      };
-
-      // Write file contents on a given path
+      // Write file contents to a given branch and path
       // -------
 
-      this.write = function(path, content, message, cb) {
-        getLatestCommit(function(err, latestCommit) {
-          getTree(latestCommit, function(err, tree) {
-            postBlob(content, function(err, blob) {
-              postTree(tree, path, blob, function(err, tree) {
-                createCommit(latestCommit, tree, message, function(err, commit) {
-                  updateHead(commit, function(err) {
+      this.write = function(branch, path, content, message, cb) {
+        that.getRef(branch, function(err, latestCommit) {
+          that.getTree(latestCommit, function(err, tree) {
+            that.postBlob(content, function(err, blob) {
+              that.postTree(tree, path, blob, function(err, tree) {
+                that.commit(latestCommit, tree, message, function(err, commit) {
+                  that.updateHead(branch, commit, function(err) {
                     cb(err);
                   });
                 });
@@ -225,12 +228,12 @@
     // Top Level API
     // -------
 
-    this.getRepo = function(repo, branch) {
-      return new Github.Repository({name: repo, branch: branch || "master"});
+    this.getRepo = function(user, repo, branch) {
+      return new Github.Repository({user: user, name: repo, branch: branch || "master"});
     };
 
-    this.getUser = function(user) {
-      return new Github.User({username: user});
+    this.getUser = function() {
+      return new Github.User();
     };
   };
 }).call(this);
