ObjectApi.js

/**
 * Copyright 2010 Ajax.org B.V.
 *
 * This product includes software developed by
 * Ajax.org B.V. (http://www.ajax.org/).
 *
 * Author: Fabian Jaokbs <fabian@ajax.org>
 */

"use strict";

var util = require("util");
var AbstractApi = require("./AbstractApi").AbstractApi;

var ObjectApi = exports.ObjectApi = function(api) {
    this.$api = api;
};

util.inherits(ObjectApi, AbstractApi);

(function() {

    /**
     * Get a listing of the root tree of a project by the username, repo, and tree SHA
     * http://develop.github.com/p/object.html#trees
     *
     * @param {String} username          the username
     * @param {String} repo              the repo
     * @param {String} treeSha           the tree sha
     */
    this.showTree = function(username, repo, treeSha, callback)
    {
        this.$api.get(
            'tree/show/' + encodeURI(username) + "/" + encodeURI(repo) + "/" + encodeURI(treeSha),
            null, null,
            this.$createListener(callback, "tree")
        );
    };

    /**
     * Lists the data blobs of a tree by tree SHA
     * http://develop.github.com/p/object.html#blobs
     *
     * @param {String} username          the username
     * @param {String} repo              the repo
     * @param {String} treeSha           the tree sha
     * @param {String} path              the path
     */
    this.listBlobs = function(username, repo, treeSha, callback)
    {
        this.$api.get(
            'blob/all/' + encodeURI(username) + "/" + encodeURI(repo) + "/" + encodeURI(treeSha),
            null, null,
            this.$createListener(callback, "blobs")
        );
    };

    /**
     * Get the data about a blob by tree SHA and file path.
     * http://develop.github.com/p/object.html#blobs
     *
     * @param {String} username          the username
     * @param {String} repo              the repo
     * @param {String} treeSha           the tree sha
     * @param {String} path              the path
     */
    this.showBlob = function(username, repo, treeSha, path, callback)
    {
        this.$api.get(
            'blob/show/' + encodeURI(username) + "/" + encodeURI(repo) + "/" + encodeURI(treeSha) + "/" + encodeURI(path),
            null, null,
            this.$createListener(callback, "blob")
        );
    };

    /**
     * Returns the raw text content of the object.
     * http://develop.github.com/p/object.html#raw_git_data
     *
     * @param {String} username          the username
     * @param {String} repo              the repo
     * @param {String} objectSha         the object sha can be either a blob SHA1, a tree SHA1 or a commit SHA1
     */
    this.getRawData = function(username, repo, objectSha, callback)
    {
        this.$api.get(
            'blob/show/' + encodeURI(username) + "/" + encodeURI(repo) + "/" + encodeURI(objectSha),
            null, {format: "text"},
            this.$createListener(callback)
        );
    };

}).call(ObjectApi.prototype);