Added 'encode' option to repo.write, added more tests. Tweaked jscsrc. Resolves #251.

Author: Ændrew Rininsland

.jscsrc

@@ -38,7 +38,7 @@
    "disallowYodaConditions": true,
    "maximumLineLength": 120,
    "requireBlocksOnNewline": true,
-   "requireCamelCaseOrUpperCaseIdentifiers": true,
+   "requireCamelCaseOrUpperCaseIdentifiers": false,
    "requireCapitalizedComments": {
       "allExcept": [
          "exported",

README.md

@@ -133,7 +133,8 @@ You can also provide an optional object literal, (`options` in the example below
 ```js
 var options = {
   author: {name: 'Author Name', email: 'author@example.com'},
-  committer: {name: 'Committer Name', email: 'committer@example.com'}
+  committer: {name: 'Committer Name', email: 'committer@example.com'},
+  encode: true // Whether to base64 encode the file. (default: true)
 }
 repo.write('master', 'path/to/file', 'YOUR_NEW_CONTENTS', 'YOUR_COMMIT_MESSAGE', options, function(err) {});
 ```

github.js

@@ -413,44 +413,49 @@
 
          this.listPulls = function(options, cb) {
             options = options || {};
-            var url = repoPath + "/pulls";
+            var url = repoPath + '/pulls';
             var params = [];
 
             if (typeof options === 'string') {
-                // backward compatibility
-                params.push('state=' + options);
-            }
-            else {
-                if (options.state) {
-                    params.push("state=" + encodeURIComponent(options.state));
-                }
-                if (options.head) {
-                    params.push("head=" + encodeURIComponent(options.head));
-                }
-                if (options.base) {
-                    params.push("base=" + encodeURIComponent(options.base));
-                }
-                if (options.sort) {
-                    params.push("sort=" + encodeURIComponent(options.sort));
-                }
-                if (options.direction) {
-                     params.push("direction=" + encodeURIComponent(options.direction));
-                }
-                if (options.page) {
-                     params.push("page=" + options.page);
-                }
-                if (options.per_page) {
-                     params.push("per_page=" + options.per_page);
-                }
+               // Backward compatibility
+               params.push('state=' + options);
+            } else {
+               if (options.state) {
+                  params.push('state=' + encodeURIComponent(options.state));
+               }
+
+               if (options.head) {
+                  params.push('head=' + encodeURIComponent(options.head));
+               }
+
+               if (options.base) {
+                  params.push('base=' + encodeURIComponent(options.base));
+               }
+
+               if (options.sort) {
+                  params.push('sort=' + encodeURIComponent(options.sort));
+               }
+
+               if (options.direction) {
+                  params.push('direction=' + encodeURIComponent(options.direction));
+               }
+
+               if (options.page) {
+                  params.push('page=' + options.page);
+               }
+
+               if (options.per_page) {
+                  params.push('per_page=' + options.per_page);
+               }
             }
 
             if (params.length > 0) {
-                url += "?" + params.join("&");
+               url += '?' + params.join('&');
             }
 
             _request('GET', url, null, function(err, pulls, xhr) {
-                if (err) return cb(err);
-                cb(null, pulls, xhr);
+               if (err) return cb(err);
+               cb(null, pulls, xhr);
             });
          };
 
@@ -536,7 +541,7 @@
                };
             } else {
                content = {
-                  content: b64encode(String.fromCharCode.apply(null, new Uint8Array(content))),
+                  content: b64encode(content),
                   encoding: 'base64'
                };
             }
@@ -552,7 +557,7 @@
 
          this.updateTree = function(baseTree, path, blob, cb) {
             var data = {
-               base_tree: baseTree, // jscs:ignore requireCamelCaseOrUpperCaseIdentifiers
+               base_tree: baseTree,
                tree: [
             {
                path: path,
@@ -797,7 +802,7 @@
             that.getSha(branch, encodeURI(path), function(err, sha) {
                var writeOptions = {
                   message: message,
-                  content: b64encode(content),
+                  content: typeof options.encode === 'undefined' || options.encode ? b64encode(content) : content,
                   branch: branch,
                   committer: options && options.committer ? options.committer : undefined,
                   author: options && options.author ? options.author : undefined
@@ -957,7 +962,7 @@
          };
 
          this.comment = function(issue, comment, cb) {
-            _request('POST', issue.comments_url, { // jscs:ignore requireCamelCaseOrUpperCaseIdentifiers
+            _request('POST', issue.comments_url, {
                body: comment
             }, function(err, res) {
                cb(err, res);

gulpfile.js

@@ -50,23 +50,28 @@ function runTests (singleRun, done) {
    var reporters = ['mocha'];
    var preprocessors = {};
 
-   var pathSrcJs = [
+   var files = [
      path.join(__dirname, 'github.js'),
-     path.join(__dirname, 'test/*.js'),
-     path.join(__dirname, 'test/user.json')
+     path.join(__dirname, 'test/*.js')
    ];
 
    if (singleRun) {
-      pathSrcJs.forEach(function(path) {
+      files.forEach(function(path) {
          preprocessors[path] = ['coverage'];
       });
       reporters.push('coverage');
-
-      preprocessors['test/user.json'] = ['json_fixtures'];
    }
 
+   files.push(path.join(__dirname, 'test/user.json'));
+   files.push({
+      pattern: path.join(__dirname, 'test/gh.png'),
+      watched: false,
+      included: false
+   });
+   preprocessors['test/user.json'] = ['json_fixtures'];
+
    var localConfig = {
-      files: pathSrcJs,
+      files: files,
       configFile: path.join(__dirname, './karma.conf.js'),
       singleRun: singleRun,
       autoWatch: !singleRun,

karma.conf.js

@@ -12,7 +12,7 @@ module.exports = function(config) {
 
       frameworks: ['mocha', 'chai'],
 
-      browsers: ['PhantomJS'],
+      browsers: ['PhantomJS2'],
 
       coverageReporter: {
          reporters: [

package.json

@@ -25,7 +25,7 @@
     "karma-json-fixtures-preprocessor": "0.0.5",
     "karma-mocha": "^0.2.0",
     "karma-mocha-reporter": "^1.1.1",
-    "karma-phantomjs-launcher": "^0.2.1",
+    "karma-phantomjs2-launcher": "^0.3.2",
     "mocha": "^2.3.3",
     "phantomjs": "^1.9.18"
   },

test/test.repo.js

@@ -1,8 +1,8 @@
 'use strict';
 
-var github, repo, user, testUser, timeout;
+var github, repo, user, testUser, timeout, imageB64, imageBlob;
 
-if (typeof window === 'undefined') {
+if (typeof window === 'undefined') { // We're in NodeJS
    // Module dependencies
    var chai = require('chai');
    var Github = require('../');
@@ -14,9 +14,32 @@ if (typeof window === 'undefined') {
 
    // Long timeouts for Mocha.
    timeout = 60000;
-} else {
-   // Short timeouts for Karma!
+
+   var fs = require('fs');
+   var path = require('path');
+
+   imageBlob = fs.readFileSync(path.join(__dirname, 'gh.png')); // This is a Buffer().
+   imageB64 = imageBlob.toString('base64');
+} else { // We're in the browser
+   // Shorter timeouts for Karma!
    timeout = 12000;
+
+   var xhr = new XMLHttpRequest();
+
+   xhr.responseType = 'blob';
+   xhr.open('GET', 'base/test/gh.png');
+   xhr.onload = function() {
+      var reader = new FileReader();
+
+      reader.onloadend = function() {
+         imageB64 = btoa(reader.result);
+         imageBlob = reader.result;
+      };
+
+      reader.readAsBinaryString(xhr.response);
+   };
+
+   xhr.send();
 }
 
 describe('Github.Repository', function() {
@@ -216,13 +239,13 @@ describe('Creating new Github.Repository', function() {
          sort: 'updated',
          direction: 'desc',
          page: 1,
-         per_page: 100
+         per_page: 10
       };
 
       repo.listPulls(options, function(err, pull_list) {
          should.not.exist(err);
          pull_list.should.be.instanceof(Array);
-         pull_list.should.have.length(100);
+         pull_list.should.have.length(10);
          should.exist(pull_list[0].title);
          should.exist(pull_list[0].body);
          should.exist(pull_list[0].url);
@@ -300,6 +323,7 @@ describe('Creating new Github.Repository', function() {
       repo.write('master', 'TEST_unicode.md', '\u2014', 'Long dash unicode', function(err) {
          should.not.exist(err);
 
+         if (err) console.log(err);
          repo.read('master', 'TEST_unicode.md', function(err, obj) {
             should.not.exist(err);
             obj.should.equal('\u2014');
@@ -334,6 +358,27 @@ describe('Creating new Github.Repository', function() {
          });
       });
    });
+
+   it('should be able to write an image to the repo', function(done) {
+      repo.write('master', 'TEST_image.png', imageB64, 'Image test', {
+         encode: false
+      }, function(err) {
+         if (err) console.log(err);
+         should.not.exist(err);
+         done();
+      });
+   });
+
+   it('should be able to write a blob to the repo', function(done) {
+      repo.postBlob('String test', function(err) { // Test strings
+         should.not.exist(err);
+
+         repo.postBlob(imageBlob, function(err) { // Test non-strings
+            should.not.exist(err);
+            done();
+         });
+      });
+   });
 });
 
 describe('deleting a Github.Repository', function() {