Skip to content

Enable to pass an object to createBlob #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dudaerich wants to merge 1 commit into
base: master
Choose a base branch
from
+22 −3
Open

Enable to pass an object to createBlob #464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Enable to pass an object to createBlob 
createBlob automatically encodes string parameter
by Utf8 library. In some cases the string value
can be already encoded in Utf8 so the encoding
should be skipped.

This commit enables to pass object containing
the content and encoding items. This object is
directly sent to Github. Users have better control
about what is actually sending.

closes #463
  • Loading branch information
@dudaerich
dudaerich committed Apr 9, 2019
commit 24f9c28bfbc3bcc63509ca37a909600776ce95f6
15 changes: 12 additions & 3 deletions lib/Repository.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ class Repository extends Requestable {
/**
* Create a blob
* @see https://developer.github.com/v3/git/blobs/#create-a-blob
* @param {(string|Buffer|Blob)} content - the content to add to the repository
* @param {(string|Buffer|Blob|Object)} content - the content to add to the repository
* @param {Requestable.callback} cb - will receive the details of the created blob
* @return {Promise} - the promise for the http request
*/
Expand All @@ -258,7 +258,7 @@ class Repository extends Requestable {

/**
* Get the object that represents the provided content
* @param {string|Buffer|Blob} content - the content to send to the server
* @param {string|Buffer|Blob|Object} content - the content to send to the server
* @return {Object} the representation of `content` for the GitHub API
*/
_getContentObject(content) {
Expand All @@ -283,9 +283,18 @@ class Repository extends Requestable {
encoding: 'base64',
};

} else if (typeof content === 'object') {
log('content is an object');

if (typeof content.content !== 'string') {
throw new Error('The object must contain content item of type string.');
}

return content;

} else { // eslint-disable-line
log(`Not sure what this content is: ${typeof content}, ${JSON.stringify(content)}`);
throw new Error('Unknown content passed to postBlob. Must be string or Buffer (node) or Blob (web)');
throw new Error('Unknown content passed to postBlob. Must be string or Buffer (node) or Blob (web) or Object');
}
}

Expand Down
10 changes: 10 additions & 0 deletions test/repository.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,16 @@ describe('Repository', function() {
remoteRepo.createBlob(imageBlob, assertSuccessful(done));
});

it('should read the same unicode string blob as it was written', function(done) {
let content = 'The temperature is 25°C'
remoteRepo.createBlob({content: content, encoding: 'utf-8'}, assertSuccessful(done, function(_, resp) {
remoteRepo.getBlob(resp.sha, assertSuccessful(done, function(_, returnedContent) {
expect(returnedContent).to.be(content);
done();
}));
}));
});

it('should star the repo', function(done) {
remoteRepo.star(assertSuccessful(done, function() {
remoteRepo.isStarred(assertSuccessful(done));
Expand Down