Merge pull request #9 from plotly/cred_config_dev

Cred config dev

Author: BRONSOLO

README.md

@@ -31,6 +31,26 @@ julia> Plotly.signin("username","your api key")
 PlotlyAccount("username","your api key")
 ```
 
+Note: you may also specify your session endpoints using signin as follows: 
+
+```julia
+julia> Plotly.signin("username","your api key",{"plotly_domain"=> "your_plotly_base_endpoint", "plotly_domain"=> "your_plotly_api_endpoint"})
+```
+
+## Saving your credentials
+```julia
+julia> Plotly.set_credentials_file({"username"=>"your_user_name","api_key"=>"your_api_key"})
+```
+
+Note: your credentials will be saved within /YOUR_HOME_DIR/.plotly/.credentials
+
+## Saving your endpoint configuration
+```julia
+julia> Plotly.set_config_file({"plotly_domain"=> "your_plotly_base_endpoint", "plotly_domain"=> "your_plotly_api_endpoint"})
+```
+
+Note: your configuration will be saved within /YOUR_HOME_DIR/.plotly/.config
+
 ## Plot && Open in browser
 ```julia
 julia> Plotly.openurl(Plotly.plot(["z"=>rand(6,6)],["style"=>["type"=>"heatmap"]]))

src/Plotly.jl

@@ -2,10 +2,8 @@ module Plotly
 using HTTPClient.HTTPC
 using JSON
 
-type PlotlyAccount
-    username::String
-    api_key::String
-end
+include("plot.jl")
+include("utils.jl")
 
 type CurrentPlot
     filename::String
@@ -30,47 +28,33 @@ default_opts = {
 "platform" => "Julia",
 "version" => "0.2"}
 
-function signup(username::String, email::String)
-    r = post("http://plot.ly/apimkacct",
-    merge(default_opts,
-    {"un" => username,
-    "email" => email}))
-    if r.http_code == 200
-        results = JSON.parse(bytestring(r.body))
-        for flag in ["error","warning","message"]
-            if haskey(results, flag) && results[flag] != ""
-                println(results[flag])
-            end
-        end
-        if haskey(results,"tmp_pw")
-            println("Success! Check your email to activate your account.")
-            results
-        end
-    end
+function get_plot_endpoint()
+    config = get_config()
+    plot_endpoint = "clientresp"
+    return joinpath(config.plotly_domain, plot_endpoint)
 end
 
-function signin(username::String, api_key::String)
-    global plotlyaccount
-    plotlyaccount = PlotlyAccount(username,api_key)
+function get_content_endpoint(file_id::String, owner::String)
+    config = get_config()
+    content_endpoint = "files/$owner:$file_id/content"
+    return joinpath(config.plotly_api_domain, content_endpoint)
 end
 
 function plot(data::Array,options=Dict())
-    global plotlyaccount
-    if !isdefined(Plotly,:plotlyaccount)
-        println("Please 'signin(username, api_key)' before proceeding. See http://plot.ly/API for help!")
-        return
-    end
+    creds = get_credentials()
+    endpoint = get_plot_endpoint()
     opt = merge(default_options,options)
-    r = post("http://plot.ly/clientresp",
+    r = post(endpoint,
              merge(default_opts,
                    {
-                    "un" => plotlyaccount.username,
-                    "key" => plotlyaccount.api_key,
+                    "un" => creds.username,
+                    "key" => creds.api_key,
                     "args" => json(data),
                     "kwargs" => json(opt)
                     })
              )
     body=JSON.parse(bytestring(r.body))
+
     if r.http_code != 200
         error(["r.http_code"])
     elseif body["error"] != ""
@@ -82,68 +66,59 @@ function plot(data::Array,options=Dict())
     end
 end
 
-include("plot.jl")
-
 function layout(layout_opts::Dict,meta_opts=Dict())
-    global plotlyaccount
-    if !isdefined(Plotly,:plotlyaccount)
-        println("Please 'signin(username, api_key)' before proceeding. See http://plot.ly/API for help!")
-        return
-    end
+    creds = get_credentials()
+    endpoint = get_plot_endpoint()
 
     merge!(meta_opts,get_required_params(["filename","fileopt"],meta_opts))
 
-    r = post("http://plot.ly/clientresp",
+    r = post(endpoint,
     merge(default_opts,
-    {"un" => plotlyaccount.username,
-    "key" => plotlyaccount.api_key,
+    {"un" => creds.username,
+    "key" => creds.api_key,
     "args" => json(layout_opts),
     "origin" => "layout",
     "kwargs" => json(meta_opts)}))
     __parseresponse(r)
 end
 
 function style(style_opts,meta_opts=Dict())
-    global plotlyaccount
-    if !isdefined(Plotly,:plotlyaccount)
-        println("Please 'signin(username, api_key)' before proceeding. See http://plot.ly/API for help!")
-        return
-    end
+    creds = get_credentials()
+    endpoint = get_plot_endpoint()
 
     merge!(meta_opts,get_required_params(["filename","fileopt"],meta_opts))
 
-    r = post("http://plot.ly/clientresp",
+    r = post(endpoint,
     merge(default_opts,
-    {"un" => plotlyaccount.username,
-    "key" => plotlyaccount.api_key,
+    {"un" => creds.username,
+    "key" => creds.api_key,
     "args" => json([style_opts]),
     "origin" => "style",
     "kwargs" => json(meta_opts)}))
     __parseresponse(r)
 end
 
 
-function getFile(file_id::String, file_owner=None)
-  global plotlyaccount
+function getFile(file_id::String, owner=None)
+  creds = get_credentials()
+  username = creds.username
+  api_key = creds.api_key
 
-  user = plotlyaccount.username
-  apikey = plotlyaccount.api_key
-
-  if (file_owner == None)
-    file_owner = user
+  if (owner == None)
+    owner = username
   end
 
-  url = "https://api.plot.ly/v2/files/$file_owner:$file_id/content"
+  endpoint = get_content_endpoint(file_id, owner)
   lib_version = string(default_opts["platform"], " ", default_opts["version"])
 
-  auth = string("Basic ", base64("$user:$apikey"))
+  auth = string("Basic ", base64("$username:$api_key"))
 
   options = RequestOptions(headers=[
                                     ("Authorization", auth),
                                     ("Plotly-Client-Platform", lib_version)
                                     ])
 
-  r = get(url, options)
+  r = get(endpoint, options)
 
   __parseresponse(r)
 
@@ -266,19 +241,12 @@ function get_template(format_type::String)
     end
 end
 
-function help(func_name::String)
-    print("hihi")
-end
 function help()
     println("Please enter the name of the funtion you'd like help with")
     println("Options include:")
     println("\t Plotly.help(\"plot\") OR Plotly.help(:plot)")
     println("\t Plotly.help(\"layout\") OR Plotly.help(:layout)")
     println("\t Plotly.help(\"style\") OR Plotly.help(:style)")
 end
-function help(func_name::Symbol)
-    print("hihi")
-end
-
 
 end

src/utils.jl

@@ -0,0 +1,187 @@
+using JSON
+
+default_endpoints = {
+"base" => "https://plot.ly",
+"api" => "https://api.plot.ly/v2"}
+
+type PlotlyCredentials
+    username::String
+    api_key::String
+end
+
+type PlotlyConfig
+    plotly_domain::String
+    plotly_api_domain::String
+end
+
+function signin(username::String, api_key::String, endpoints=None)
+# Define session credentials/endpoint configuration, where endpoint is a Dict
+
+    global plotlycredentials = PlotlyCredentials(username, api_key)
+
+    # if endpoints are specified both the base and api domains must be specified
+    if endpoints != None
+        try
+            base_domain = endpoints["plotly_domain"]
+            api_domain = endpoints["plotly_api_domain"]
+            global plotlyconfig = PlotlyConfig(base_domain, api_domain)
+        catch
+            error("You must specify both the base and api endpoints.")
+        end
+    end
+end
+
+function get_credentials()
+# Return the session credentials if defined --> otherwise use .credentials specs
+
+    if !isdefined(Plotly,:plotlycredentials)
+
+        creds = get_credentials_file()
+
+        try
+            username = creds["username"]
+            api_key = creds["api_key"]
+
+            global plotlycredentials = PlotlyCredentials(username, api_key)
+
+        catch
+            error("Please 'signin(username, api_key)' before proceeding. See
+            http://plot.ly/API for help!")
+        end
+    end
+
+    # will persist for the remainder of the session
+    return plotlycredentials
+end
+
+function get_config()
+# Return the session configuration if defined --> otherwise use .config specs
+
+    if !isdefined(Plotly,:plotlyconfig)
+
+        config = get_config_file()
+
+        if isempty(config)
+            base_domain = default_endpoints["base"]
+            api_domain = default_endpoints["api"]
+        else
+            base_domain = get(config, "plotly_domain", default_endpoints["base"])
+            api_domain = get(config, "plotly_api_domain", default_endpoints["api"])
+        end
+
+        global plotlyconfig = PlotlyConfig(base_domain, api_domain)
+
+    end
+
+    # will persist for the remainder of the session
+    return plotlyconfig
+end
+
+function set_credentials_file(input_creds::Dict)
+# Save Plotly endpoint configuration as JSON key-value pairs in
+# userhome/.plotly/.credentials. This includes username and api_key.
+
+    # plotly credentials file
+    userhome = homedir()
+    plotly_credentials_folder = joinpath(userhome, ".plotly")
+    plotly_credentials_file = joinpath(plotly_credentials_folder, ".credentials")
+
+    #check to see if dir/file exists --> if not, create it
+    try
+        mkdir(plotly_credentials_folder)
+    catch err
+        isa(err, SystemError) || rethrow(err)
+    end
+
+    prev_creds = get_credentials_file()
+
+    #merge input creds with prev creds
+    if !isempty(prev_creds)
+        creds = merge(prev_creds, input_creds)
+    else
+        creds = input_creds
+    end
+
+    #write the json strings to the cred file
+    creds_file = open(plotly_credentials_file, "w")
+    write(creds_file, JSON.json(creds))
+    close(creds_file)
+end
+
+function set_config_file(input_config::Dict)
+# Save Plotly endpoint configuration as JSON key-value pairs in
+# userhome/.plotly/.config. This includes the plotly_domain, and plotly_api_domain.
+
+    # plotly configuration file
+    userhome = homedir()
+    plotly_config_folder = joinpath(userhome, ".plotly")
+    plotly_config_file = joinpath(plotly_config_folder, ".config")
+
+    #check to see if dir/file exists --> if not create it
+    try
+        mkdir(plotly_config_folder)
+    catch err
+        isa(err, SystemError) || rethrow(err)
+    end
+
+    prev_config = get_config_file()
+
+    #merge input config with prev config
+    if !isempty(prev_config)
+        config = merge(prev_config, input_config)
+    else
+        config = input_config
+    end
+
+    #write the json strings to the config file
+    config_file = open(plotly_config_file, "w")
+    write(config_file, JSON.json(config))
+    close(config_file)
+end
+
+function get_credentials_file()
+# Load user credentials as a Dict
+
+    # plotly credentials file
+    userhome = homedir()
+    plotly_credentials_folder = joinpath(userhome, ".plotly")
+    plotly_credentials_file = joinpath(plotly_credentials_folder, ".credentials")
+
+    if !isfile(plotly_credentials_file)
+        creds = {}
+    else
+        creds_file = open(plotly_credentials_file)
+        creds = JSON.parse(creds_file)
+
+        if creds == nothing
+            creds = {}
+        end
+
+    end
+
+    return creds
+
+end
+
+function get_config_file()
+# Load endpoint configuration as a Dict
+
+    # plotly configuration file
+    userhome = homedir()
+    plotly_config_folder = joinpath(userhome, ".plotly")
+    plotly_config_file = joinpath(plotly_config_folder, ".config")
+
+    if !isfile(plotly_config_file)
+        config = {}
+    else
+        config_file = open(plotly_config_file)
+        config = JSON.parse(config_file)
+
+        if config == nothing
+            config = {}
+        end
+
+    end
+
+    return config
+end