Misc finishing touches

Author: malmaud

REQUIRE

@@ -1,6 +1,6 @@
 julia 0.4
 Requests 0.3.5
 JSON
-PlotlyJS 0.1.0
-Compat 0.7.12
+PlotlyJS 0.2.0
+Compat 0.7.20
 Reexport

src/Plotly.jl

@@ -2,13 +2,15 @@
 
 module Plotly
 using Compat
+using Compat: String
 using Requests
 using JSON
 using Reexport: @reexport
 import Requests: URI, post
 
 @reexport using PlotlyJS
 export post
+export set_credentials_file
 
 include("utils.jl")
 
@@ -33,14 +35,24 @@ openurl(url::URI) = openurl(string(url))
 
 get_plot_endpoint() = "$(get_config().plotly_domain)/clientresp"
 
-
+"""
+Proxy for a plot stored on the Plotly cloud.
+"""
 immutable RemotePlot
     url::URI
 end
 RemotePlot(url) = RemotePlot(URI(url))
 
+"""
+Display a plot stored in the Plotly cloud in a browser window.
+"""
 Base.open(p::RemotePlot) = openurl(p.url)
 
+"""
+Post a local Plotly plot to the Plotly cloud.
+
+Must be signed in first.
+"""
 function post(p::Plot; kwargs...)
     creds = get_credentials()
     endpoint = get_plot_endpoint()
@@ -54,7 +66,6 @@ function post(p::Plot; kwargs...)
     "kwargs" => json(opt)))
 
     r = post(endpoint, data=data)
-    # body=Requests.json(r)
     body = parse_response(r)
     return RemotePlot(URI(body["url"]))
 end
@@ -95,7 +106,11 @@ function style(style_opts, meta_opts=Dict(); meta_kwargs...)
     parse_response(post(endpoint, data=data))
 end
 
+"""
+Transport a plot from the Plotly cloud to a local `Plot` object.
 
+Must be signed in first if the plot is not public.
+"""
 function Base.download(plot::RemotePlot)
     creds = get_credentials()
     username = creds.username
@@ -111,32 +126,12 @@ function Base.download(plot::RemotePlot)
     end
     endpoint = URI(plot.url, path="$path.json")
     response = get(endpoint, headers=options)
-    return JSON.parse(Plot, bytestring(response))
-end
-
-download_plot(url) = download(RemotePlot(url))
-
-function get_required_params(required,opts)
-    # Priority given to user-inputted opts, then currentplot
-    result=Dict()
-    for p in required
-        global currentplot
-        if haskey(opts,p)
-            result[p] = opts[p]
-        elseif isdefined(Plotly,:currentplot)
-            result[p] = getfield(currentplot,symbol(p))
-        else
-            msg = string("Missing required param $(p). ",
-            "Make sure to create a plot first. ",
-            " Please refer to http://plot.ly/api")
-            error(msg)
-        end
-    end
-    result
+    local_plot = JSON.parse(Plot, bytestring(response))
+    return PlotlyJS.SyncPlot(local_plot)
 end
 
 immutable PlotlyError <: Exception
-    msg::UTF8String
+    msg::String
 end
 
 function Base.show(io::IO, err::PlotlyError)

src/utils.jl

@@ -5,22 +5,22 @@ default_endpoints = Dict(
   "api" => "https://api.plot.ly/v2")
 
 type PlotlyCredentials
-    username::ASCIIString
-    api_key::ASCIIString
+    username::String
+    api_key::String
 end
 
 type PlotlyConfig
-    plotly_domain::ASCIIString
-    plotly_api_domain::ASCIIString
+    plotly_domain::String
+    plotly_api_domain::String
 end
 
-function signin(username::ASCIIString, api_key::ASCIIString, endpoints=None)
+function signin(username::String, api_key::String, endpoints=nothing)
 # 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
+    if endpoints != nothing
         try
             base_domain = endpoints["plotly_domain"]
             api_domain = endpoints["plotly_api_domain"]
@@ -34,7 +34,7 @@ end
 function get_credentials()
 # Return the session credentials if defined --> otherwise use .credentials specs
 
-    if !isdefined(Plotly,:plotlycredentials)
+    if !isdefined(Plotly, :plotlycredentials)
 
         creds = get_credentials_file()
 

test/tests.jl

@@ -6,50 +6,13 @@ using Base.Test
 
 Plotly.signin("unittest","tfzz811f5n", Dict("plotly_domain"=>"https://plot.ly","plotly_api_domain"=>"https://api.plot.ly"))
 
-(x0,y0) = [1,2,3], [4,5,6]
-(x1,y1) = [1,2,3], [2,10,12]
-
-response = Plotly.plot([[x0 y0] [x1 y1]], Dict("filename" => "basic_test_plot"))
-@test response["error"] == ""
-
-datastyle = Dict("line"=>Dict("color"=> "rgb(84, 39, 143)", "width"=> 4))
-style_res = Plotly.style(datastyle, Dict("filename" => "basic_test_plot"))
-@test style_res["error"] == ""
-
-layout_res = Plotly.layout(Dict("title"=>"Hello World"), Dict("filename" => "basic_test_plot"))
-@test layout_res["error"] == ""
-
-# just check that these won't raise an error
-trace1 = Plotly.line(sin, Dict("left"=>0, "right"=>10, "step"=>1))
-trace2 = Plotly.histogram(cos, Dict("left"=>0, "right"=>10, "step"=>1))
-trace3 = Plotly.box(abs, Dict("left"=>0, "right"=>10, "step"=>1))
-trace4 = Plotly.scatter(log, Dict("left"=>0, "right"=>10, "step"=>1))
-response = Plotly.plot([trace1, trace2, trace3, trace4], Dict("filename" => "test_plot"))
-@test response["error"] == ""
-
-# and one last check
-response = Plotly.plot([sin, cos, abs, log], Dict("left"=>eps(), "right"=>10, "step"=>1, "filename" => "test_plot"))
-@test response["error"] == ""
-
-#= getFile is broken because the /content endpoint isn't supported anymore?
-figure = Plotly.getFile("5", "chris")
-@test length(figure["data"][1]["x"]) == 501
-@test haskey(figure["layout"], "xaxis")
-
-response = Plotly.plot(figure["data"], Dict("layout"=> figure["layout"], "filename" => "test_get_figure_plot"))
-@test response["error"] == ""
-=#
+# Check for no error
+original_plot = Plotly.plot([scatter(x=[1,2],y=[3,4])])
+remote_plot = post(original_plot)
+downloaded_plot = download(remote_plot)
 
 #test get_plot_endpoint
 endpoints = Dict("plotly_domain"=>"my_plotly_domain", "plotly_api_domain"=>"my_plotly_api_domain")
 Plotly.signin("test_username", "test_api_key", endpoints)
 plot_endpoint = Plotly.get_plot_endpoint()
 @test plot_endpoint == "my_plotly_domain/clientresp"
-
-#test get_content_endpoint
-endpoints = Dict("plotly_domain"=>"my_plotly_domain", "plotly_api_domain"=>"my_plotly_api_domain")
-Plotly.signin("test_username", "test_api_key", endpoints)
-fid = "123_fake"
-owner = "test_owner"
-content_endpoint = Plotly.get_content_endpoint(fid, owner)
-@test content_endpoint == "my_plotly_api_domain/v2/files/test_owner:123_fake/content"