Merge pull request #19 from plotly/image_streams

alexander-daniel · alexander-daniel · commit 28243e794fb4 · 2015-02-04T10:11:24.000-05:00
getImage() now returns imageStream
diff --git a/README.md b/README.md
@@ -183,7 +183,7 @@ plotly.getFigure('fileOwner', 'fileId', function (err, figure) {
 `callback(err, imageData)`  
 
 `err` is an Error Object
-`imageData` is a `base64`-encoded string
+`imageStream` is a Stream of base-64 encoded imageData
 
 ```javascript
 var plotly = require('plotly')('username','apiKey');
@@ -203,8 +203,11 @@ var imgOpts = {
     height: 500
 };
 
-plotly.getImage(figure, imgOpts, function (error, imageData) {
-    fs.writeFile('1.png', imageData, 'base64');
+plotly.getImage(figure, imgOpts, function (error, imageStream) {
+    if (error) return console.log (error);
+
+    var fileStream = fs.createWriteStream('1.png');
+    imageStream.pipe(fileStream);
 });
 ```
 
@@ -222,8 +225,11 @@ plotly.getFigure('fileOwner', 'fileId', function (err, figure) {
 		height: 500
 	};
 
-	plotly.getImage(figure, imgOpts, function (error, imageData) {
-		fs.writeFile('1.png', imageData, 'base64');
-	});
+    plotly.getImage(figure, imgOpts, function (error, imageStream) {
+        if (error) return console.log (error);
+
+        var fileStream = fs.createWriteStream('2.png');
+        imageStream.pipe(fileStream);
+    });
 });
 ```
diff --git a/examples/saving_image.js b/examples/saving_image.js
@@ -1,7 +1,7 @@
 'use strict';
 
 var fs = require('fs');
-var plotly = require('../.')('your_username','api_key');
+var plotly = require('../.')('your_username','your_apikey');
 
 var trace1 = {
   x: [1, 2, 3, 4],
@@ -25,6 +25,9 @@ var imgOpts = {
     height: 500
 };
 
-plotly.getImage(figure, imgOpts, function (error, imageData) {
-    fs.writeFile('1.png', imageData, 'base64');
+plotly.getImage(figure, imgOpts, function (error, imageStream) {
+    if (error) return console.log (error);
+
+    var fileStream = fs.createWriteStream('1.png');
+    imageStream.pipe(fileStream);
 });
diff --git a/index.js b/index.js
@@ -25,7 +25,7 @@ function Plotly(username,apiKey) {
         this.port = 443;
     }
         this.streamHost = '';
-        this.version='1.0.1';
+        this.version='1.0.2';
         this.platform='nodejs';
         this.origin='plot';
 }
@@ -209,15 +209,13 @@ Plotly.prototype.getImage = function (figure, opts, callback) {
     };
 
     function handleResponse(res) {
-        parseRes(res, function (err, body) {
-            if (res.statusCode !== 200) {
-                var error = new Error('Bad response status code ' + res.statusCode);
-                error.msg = body;
-                return callback(error, null);
-            }
-            var imageData = JSON.parse(body).payload;
-            callback(null, imageData);
-        });
+        if (res.statusCode !== 200) {
+            var error = new Error('Bad response status code ' + res.statusCode);
+            error.msg = res.body;
+            return callback(error, null);
+        }
+
+        callback(null, res);
     }
 
     var req = https.request(options, handleResponse);
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "plotly",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Simple node.js wrapper for the plot.ly API",
   "main": "index.js",
   "devDependencies": {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "plotly",`
`3`		`- "version": "1.0.1",`
	`3`	`+ "version": "1.0.2",`
`4`	`4`	`"description": "Simple node.js wrapper for the plot.ly API",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"devDependencies": {`