Merge branch 'master' of https://github.com/plotly/MATLAB-api into histogram_bounds

Author: BRONSOLO

README.md

@@ -1,4 +1,4 @@
-## MATLAB PLOTLY API WRAPPER 2.1.6
+## MATLAB PLOTLY API WRAPPER 2.1.7
 
 ### NUTSHELL:
 

plotly/fig2plotly.m

@@ -25,7 +25,7 @@
 
 % [OUTPUT]:
 
-% p - plotlyfigure object
+% p - plotlyfig object
 
 % [ADDITIONAL RESOURCES]:
 
@@ -50,4 +50,4 @@
 
 %-------------------------------------------------------------------------%
 
-end
+end

plotly/getplotlyfig.m

@@ -15,7 +15,7 @@
 
 % [OUTPUT]:
 
-% p - plotlyfigure object
+% p - plotlyfig object
 
 % [EXAMPLE]:
 

plotly/plotly_aux/plotly_version.m

@@ -1,3 +1,3 @@
 function version = plotly_version()
-    version = '2.1.6';
+    version = '2.1.7';
 end

plotly/plotly_user_aux/saveplotlyconfig.m

@@ -3,6 +3,14 @@ function saveplotlyconfig(plotly_domain,plotly_streaming_domain)
 % Plotly config info are saved as JSON strings
 % in ~/.plotly/.config
 
+% catch missing input arguments
+if nargin < 1 
+    error('plotly:saveconfig', ...
+    ['Incorrect number of inputs. Please save your configuration ', ...
+    'as follows: >> saveplotlyconfig(plotly_domain,', ...
+    '[optional]plotly_streaming_domain)']); 
+end
+
 % if the config file exists, then load it up
 try
     config = loadplotlyconfig();
@@ -37,12 +45,16 @@ function saveplotlyconfig(plotly_domain,plotly_streaming_domain)
         '[email protected] for support.']);
 end
 
+% get user credenitals 
+[username, api_key] = signin; 
 
 switch nargin
     case 1
         config.plotly_domain = plotly_domain;
+        signin(username, api_key, plotly_domain);
     case 2
         config.plotly_domain = plotly_domain;
+        signin(username, api_key, plotly_domain);
         config.plotly_streaming_domain= plotly_streaming_domain;
     otherwise %if neither endpoints are specified, no worries!
 end

plotly/plotly_user_aux/saveplotlycredentials.m

@@ -3,6 +3,14 @@ function saveplotlycredentials(username, api_key, stream_ids)
 % Plotly credentials are saved as JSON strings
 % in ~/.plotly/.credentials
 
+% catch missing input arguments
+if nargin < 2
+    error('plotly:savecredentials', ...
+    ['Incorrect number of inputs. Please save your credentials ', ...
+    'as follows: >> saveplotlycredentials(username, api_key,', ...
+    '[optional]stream_ids)']); 
+end
+
 % if the credentials file exists, then load it up
 try
     creds = loadplotlycredentials();
@@ -45,9 +53,6 @@ function saveplotlycredentials(username, api_key, stream_ids)
         creds.username = username;
         creds.api_key = api_key;
         creds.stream_ids = stream_ids;
-    otherwise %need to specify both the username and api_key
-        error('plotly:savecredentials',...
-        'Please specify your username and api_key');   
 end
 
 creds_string = m2json(creds);
@@ -56,4 +61,7 @@ function saveplotlycredentials(username, api_key, stream_ids)
 fprintf(fileIDCred,'%s',creds_string);
 fclose(fileIDCred);
 
+%signin using newly saved credentials
+signin(username, api_key);
+
 end

plotly/plotlyfig.m

@@ -43,7 +43,7 @@
                     obj.UserData.ApiKey,...
                     obj.UserData.PlotlyDomain] = signin;
             catch
-                errkey = 'plotlyfigureConstructor:notSignedIn';
+                errkey = 'plotlyfigConstructor:notSignedIn';
                 error(errkey, plotlymsg(errkey));
             end
 
@@ -112,7 +112,7 @@
                             updatekey = true;
                         end
                     else
-                        errkey = 'plotlyfigureConstructor:invalidInputs';
+                        errkey = 'plotlyfigConstructor:invalidInputs';
                         error(errkey , plotlymsg(errkey));
                     end
 
@@ -131,7 +131,7 @@
 
                     % check for proper property/value structure
                     if mod(length(parseinit:nargin),2) ~= 0
-                        errkey = 'plotlyfigureConstructor:invalidInputs';
+                        errkey = 'plotlyfigConstructor:invalidInputs';
                         error(errkey , plotlymsg(errkey));
                     end
 
@@ -825,4 +825,4 @@ function delete(obj)
             end
         end
     end
-end
+end

plotly/plotlyfig_aux/helpers/plotlymsg.m

@@ -1,11 +1,11 @@
 function errormsg = plotlymsg(key)
 switch key
-    %--plotlyfigure constructor--%
-    case 'plotlyfigureConstructor:notSignedIn'
-        errormsg = '\nOops! You must be signed in to initialize a plotlyfigure object.\n'; 
-    case 'plotlyfigureConstructor:invalidInputs'
-        errormsg = ['\nOops! It appears that you did not initialize the plotlyfigure object using the\n', ...
-            'required: >>  plotlyfigure(handle [optional],''property'',''value'',...) \n',...
+    %--plotlyfig constructor--%
+    case 'plotlyfigConstructor:notSignedIn'
+        errormsg = '\nOops! You must be signed in to initialize a plotlyfig object.\n'; 
+    case 'plotlyfigConstructor:invalidInputs'
+        errormsg = ['\nOops! It appears that you did not initialize the plotlyfig object using the\n', ...
+            'required: >>  plotlyfig(handle [optional],''property'',''value'',...) \n',...
             'input structure. Please try again or contact [email protected] for any additional help!\n\n'];
         %--saveplotlyfig invocation--%;
     case 'plotlySaveImage:invalidInputs'
@@ -15,4 +15,4 @@
             'Please try again or contact [email protected] for any additional help!\n\n'];
 
 end
-end
+end

plotlysetup.m

@@ -139,7 +139,10 @@ function plotlysetup(username, api_key, varargin)
 
 try %save user credentials
     fprintf('Saving username/api_key credentials ... ');
-    saveplotlycredentials(username,api_key);
+
+    %update: as of v.2.1.7, This also signs in the user
+    saveplotlycredentials(username, api_key);
+
     %worked!
     fprintf('Done\n');
 catch exception %writing credentials file permission problem catch...
@@ -168,13 +171,19 @@ function plotlysetup(username, api_key, varargin)
 
         if strcmp(varargin{n},'stream_ids')
             fprintf('Saving stream_ids credentials ... ');
-            saveplotlycredentials(username,api_key,varargin{n+1});
+
+            %update: as of v.2.1.7, This also signs in the user
+            saveplotlycredentials(username, api_key, varargin{n+1});
+
             %worked!
             fprintf('Done\n');
         end
         if strcmp(varargin{n},'plotly_domain')
             fprintf('Saving plotly_domain configuration ... ');
+
+            %update: as of v.2.1.7, This also signs in the user
             saveplotlyconfig(varargin{n+1});
+
             %worked!
             fprintf('Done\n');
         end
@@ -185,7 +194,10 @@ function plotlysetup(username, api_key, varargin)
             catch
                 config.plotly_domain = '';
             end
+
+            %update: as of v.2.1.7, This also signs in the user
             saveplotlyconfig(config.plotly_domain,varargin{n+1});
+
             %worked!
             fprintf('Done\n');
         end
@@ -195,9 +207,6 @@ function plotlysetup(username, api_key, varargin)
     fprintf(['\n\n' exception.identifier exception.message '\n\n']);
 end
 
-%sign in the user
-signin(username,api_key);
-
 %greet the people!
 fprintf('\nWelcome to Plotly! If you are new to Plotly please enter: >> plotlyhelp to get started!\n\n')
 
@@ -210,7 +219,10 @@ function plotlysetup(username, api_key, varargin)
     'the Plotly folder to your MATLAB path manually by running: \n\n',...
     '>> plotly_path = fullfile(pwd, ''plotly'')\n',...
     '>> addpath(genpath(plotly_path))\n\n',...
-    'Questions? Chuck@plotly'];
-
+    'You can save your credentials by running:\n\n', ...
+    '>>saveplotlycredentials(''your_username'', ''your_api_key'')\n\n',...
+    'You can save your domain configuration by running:\n\n',...
+    '>>saveplotlyconfig(''your_base_domain'')\n\n',...
+    'Questions? Chuck@plotly\n\n'];
 end