Skip to content

Commit

Permalink
storage: use default method options for File class
Browse files Browse the repository at this point in the history
  • Loading branch information
@stephenplusplus
stephenplusplus committed Nov 24, 2015
1 parent 6449524 commit a95853f
Show file tree
Hide file tree
Showing 2 changed files with 156 additions and 348 deletions.
255 changes: 104 additions & 151 deletions lib/storage/file.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,43 @@ var STORAGE_UPLOAD_BASE_URL = 'https://www.googleapis.com/upload/storage/v1/b';
* var file = myBucket.file('my-file');
*/
function File(bucket, name, options) {
options = options || {};

this.bucket = bucket;
this.storage = bucket.parent;

Object.defineProperty(this, 'name', {
enumerable: true,
value: name
});

var requestQueryObject = {};

if (is.number(options.generation)) {
requestQueryObject.generation = options.generation;
this.generation = options.generation;
}

var methods = {
/**
* Delete the file.
*
* @resource [Objects: delete API Documentation]{@link https://cloud.google.com/storage/docs/json_api/v1/objects/delete}
*
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this
* request.
* @param {object} callback.apiResponse - The full API response.
*
* @example
* file.delete(function(err, apiResponse) {});
*/
delete: {
reqOpts: {
qs: requestQueryObject
}
},

/**
* Check if the file exists.
*
Expand All @@ -126,7 +162,72 @@ function File(bucket, name, options) {
* // file.metadata` has been populated.
* });
*/
get: true
get: true,

/**
* Get the file's metadata.
*
* @resource [Objects: get API Documentation]{@link https://cloud.google.com/storage/docs/json_api/v1/objects/get}
*
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this
* request.
* @param {object} callback.metadata - The File's metadata.
* @param {object} callback.apiResponse - The full API response.
*
* @example
* file.getMetadata(function(err, metadata, apiResponse) {});
*/
getMetadata: {
reqOpts: {
qs: requestQueryObject
}
},

/**
* Merge the given metadata with the current remote file's metadata. This
* will set metadata if it was previously unset or update previously set
* metadata. To unset previously set metadata, set its value to null.
*
* You can set custom key/value pairs in the metadata key of the given
* object, however the other properties outside of this object must adhere
* to the [official API documentation](https://goo.gl/BOnnCK).
*
* See the examples below for more information.
*
* @resource [Objects: patch API Documentation]{@link https://cloud.google.com/storage/docs/json_api/v1/objects/patch}
*
* @param {object} metadata - The metadata you wish to update.
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this
* request.
* @param {object} callback.apiResponse - The full API response.
*
* @example
* file.setMetadata({
* contentType: 'application/x-font-ttf',
* metadata: {
* my: 'custom',
* properties: 'go here'
* }
* }, function(err, apiResponse) {});
*
* // Assuming current metadata = { hello: 'world', unsetMe: 'will do' }
* file.setMetadata({
* metadata: {
* abc: '123', // will be set.
* unsetMe: null, // will be unset (deleted).
* hello: 'goodbye' // will be updated from 'hello' to 'goodbye'.
* }
* }, function(err, apiResponse) {
* // metadata should now be { abc: '123', hello: 'goodbye' }
* });
*/
setMetadata: {
reqOpts: {
qs: requestQueryObject
}
}
};

ServiceObject.call(this, {
Expand All @@ -136,17 +237,6 @@ function File(bucket, name, options) {
methods: methods
});

options = options || {};

this.bucket = bucket;
this.generation = parseInt(options.generation, 10);
this.storage = bucket.parent;

Object.defineProperty(this, 'name', {
enumerable: true,
value: name
});

/**
* Google Cloud Storage uses access control lists (ACLs) to manage object and
* bucket access. ACLs are the mechanism you use to share objects with other
Expand Down Expand Up @@ -282,7 +372,7 @@ File.prototype.copy = function(destination, callback) {
}

var query = {};
if (this.generation) {
if (is.number(this.generation)) {
query.sourceGeneration = this.generation;
}

Expand Down Expand Up @@ -772,41 +862,6 @@ File.prototype.createWriteStream = function(options) {
return stream;
};

/**
* Delete the file.
*
* @resource [Objects: delete API Documentation]{@link https://cloud.google.com/storage/docs/json_api/v1/objects/delete}
*
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request
* @param {object} callback.apiResponse - The full API response.
*
* @example
* file.delete(function(err, apiResponse) {});
*/
File.prototype.delete = function(callback) {
callback = callback || util.noop;

var query = {};

if (this.generation) {
query.generation = this.generation;
}

this.request({
method: 'DELETE',
uri: '',
qs: query
}, function(err, resp) {
if (err) {
callback(err, resp);
return;
}

callback(null, resp);
});
};

/**
* Convenience method to download a file into memory or to a local destination.
*
Expand Down Expand Up @@ -858,43 +913,6 @@ File.prototype.download = function(options, callback) {
}
};

/**
* Get the file's metadata.
*
* @resource [Objects: get API Documentation]{@link https://cloud.google.com/storage/docs/json_api/v1/objects/get}
*
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request
* @param {object} callback.metadata - The File's metadata.
* @param {object} callback.apiResponse - The full API response.
*
* @example
* file.getMetadata(function(err, metadata, apiResponse) {});
*/
File.prototype.getMetadata = function(callback) {
var self = this;

callback = callback || util.noop;

var query = {};
if (this.generation) {
query.generation = this.generation;
}

this.request({
uri: '',
qs: query
}, function(err, resp) {
if (err) {
callback(err, null, resp);
return;
}

self.metadata = resp;
callback(null, self.metadata, resp);
});
};

/**
* Get a signed policy document to allow a user to upload data with a POST
* request.
Expand Down Expand Up @@ -1389,71 +1407,6 @@ File.prototype.move = function(destination, callback) {
});
};

/**
* Merge the given metadata with the current remote file's metadata. This will
* set metadata if it was previously unset or update previously set metadata. To
* unset previously set metadata, set its value to null.
*
* You can set custom key/value pairs in the metadata key of the given object,
* however the other properties outside of this object must adhere to the
* [official API documentation](https://goo.gl/BOnnCK).
*
* See the examples below for more information.
*
* @resource [Objects: patch API Documentation]{@link https://cloud.google.com/storage/docs/json_api/v1/objects/patch}
*
* @param {object} metadata - The metadata you wish to update.
* @param {function=} callback - The callback function.
* @param {?error} callback.err - An error returned while making this request
* @param {object} callback.apiResponse - The full API response.
*
* @example
* file.setMetadata({
* contentType: 'application/x-font-ttf',
* metadata: {
* my: 'custom',
* properties: 'go here'
* }
* }, function(err, apiResponse) {});
*
* // Assuming current metadata = { hello: 'world', unsetMe: 'will do' }
* file.setMetadata({
* metadata: {
* abc: '123', // will be set.
* unsetMe: null, // will be unset (deleted).
* hello: 'goodbye' // will be updated from 'hello' to 'goodbye'.
* }
* }, function(err, apiResponse) {
* // metadata should now be { abc: '123', hello: 'goodbye' }
* });
*/
File.prototype.setMetadata = function(metadata, callback) {
var self = this;

callback = callback || util.noop;

var query = {};
if (this.generation) {
query.generation = this.generation;
}

this.request({
method: 'PATCH',
uri: '',
qs: query,
json: metadata
}, function(err, resp) {
if (err) {
callback(err, resp);
return;
}

self.metadata = resp;

callback(null, resp);
});
};

/**
* This creates a gcs-resumable-upload upload stream.
*
Expand Down Expand Up @@ -1511,7 +1464,7 @@ File.prototype.startSimpleUpload_ = function(dup, metadata) {
})
};

if (this.generation) {
if (is.number(this.generation)) {
reqOpts.qs.ifGenerationMatch = this.generation;
}

Expand Down
Loading

0 comments on commit a95853f

Please sign in to comment.