plotlyrb 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 770ad612218a702db6da97964e0b08c5227291e5
-  data.tar.gz: 571aa03563f0b459f969a9f20c5e189144894639
+  metadata.gz: a3294977f017a389f97c281ab13cc93b95878248
+  data.tar.gz: 60eee1cf956a7b94135cbcd5670dedb237239075
 SHA512: 
-  metadata.gz: 2016eea005ced2e9f7139ba2f5491d607e873a02332792a750a3f95da9c3aee8290cfaf967b396594444b67e6325461ccec9f5ea325b9d34134cf65fe6bff4e3
-  data.tar.gz: e1ee27d011635f697977b7e6cfbc47e7ebedfe528530150eb7f224f553ee269845bd479503d5f67968374dde76a5ab3bb09c321707d84fc82c9594ed683d0847
+  metadata.gz: c259c1f081ecad6cd832f66bf73b3745bcaeea56bab362d4af2f9b4ab5cb17399682c21b180501bda4d391ad5d0a060f16d3d7b82836819037f65ad79dd6387f
+  data.tar.gz: b645541f67a799b2e8810a8934dc083aa352d58c50116a0a7a62854c811d8921015bbd5512cda32e4014e242b466b5fbe891de93ef49876da91749b9fe908431

data/README.md

@@ -2,7 +2,13 @@
 
 Use [plotly](https://plot.ly) to graph your data.
 
-Currently only supports `plot_image`, which uses the REST API to generate an image for your plot. See [the python reference](https://plot.ly/python/reference/) for details on what you can plot.
+Currently only supports `plot_image`, `create_grid`, and `create_plot_from_grid`.
+
+ - `plot_image` generates an image for your plot
+ - `create_grid` creates grid data accessible through the web interface
+ - `create_plot_from_grid` creates a plot based on the JSON representation of a grid
+
+See [the python reference](https://plot.ly/python/reference/) for details on what you can plot.
 
 ## Installation
 
@@ -23,18 +29,24 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+require 'plotlyrb'
+
 data = {
   :x => ['2013-10-04 22:23:00', '2013-11-04 22:23:00', '2013-12-04 22:23:00'],
   :y => [1, 3, 6],
-  :type => 'scatter'
+  :type => 'scatter',
+  :mode => 'markers',
 }
 
-layout = { :xaxis => { :title => 'times' },
-           :yaxis => { :title => 'bigfoot sightings', :range => [0, 7] },
+layout = {
+  :xaxis => { :title => 'times' },
+  :yaxis => { :title => 'bigfoot sightings', :range => [0, 7] },
 }
 
-plotly = Plotlyrb::PlotImage.new('my-plotly-username', 'my-plotly-api-key')
-plotly.plot_image(data, 'plot.png', :png, layout)
+plotly = Plotlyrb::ApiV2.auth_plotly('username', 'super secret API key')
+
+# NOTE: data argument must be an array of traces
+plotly.plot_image([data], '/path/to/plot.svg', :svg, layout)
 ```
 
 ## TODO

data/Rakefile

@@ -3,6 +3,6 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/*test*.rb']
+  t.test_files = FileList['test/**/*test*.rb']
   t.verbose = true
 end

data/lib/plotlyrb/api_v2.rb

@@ -8,7 +8,14 @@ module Plotlyrb
     HOSTNAME = 'api.plot.ly'
     BASE_PATH = 'v2'
     BASE_URI = "#{PROTOCOL}://#{HOSTNAME}/#{BASE_PATH}"
-    IMAGES = URI.parse("#{BASE_URI}/images")
+
+    def self.mk_endpoint(path)
+      URI.parse("#{BASE_URI}/#{path}")
+    end
+    IMAGES = mk_endpoint('images')
+    GRIDS = mk_endpoint('grids')
+    PLOTS = mk_endpoint('plots')
+
     COMMON_HEADERS = {
       'plotly-client-platform' => "Ruby #{Plotlyrb::VERSION}",
       'content-type' => 'application/json'
@@ -24,4 +31,4 @@ module Plotlyrb
       Plotly.new(headers_hash)
     end
   end
-end
+end

data/lib/plotlyrb/grid.rb

@@ -0,0 +1,21 @@
+require 'net/https'
+require 'json'
+
+module Plotlyrb
+  class Grid
+    def initialize(headers)
+      @headers = headers
+      @https = Net::HTTP.new(ApiV2::GRIDS.host, ApiV2::GRIDS.port)
+      @https.use_ssl = true
+    end
+
+    # data is a hash that mirrors the format of the data hash in the API
+    # https://api.plot.ly/v2/grids#create
+    def create(data)
+      payload = {:data => data}.to_json
+      request = Net::HTTP::Post.new(ApiV2::GRIDS.path, @headers)
+      request.body = payload
+      Response.from_http_response(@https.request(request))
+    end
+  end
+end

data/lib/plotlyrb/plot.rb

@@ -0,0 +1,48 @@
+require 'net/https'
+require 'json'
+
+module Plotlyrb
+  class Plot
+
+    def initialize(headers)
+      @headers = headers
+      @https = Net::HTTP.new(ApiV2::PLOTS.host, ApiV2::PLOTS.port)
+      @https.use_ssl = true
+    end
+
+    # Takes a list of data hashes (each element is a trace?), response from grid creation, x and y
+    # column names (must appear in grid), and a layout. Extracts the column references from the
+    # grid response to populate the xsrc # and ysrc fields in data.
+    # See https://api.plot.ly/v2/plots#create
+    def create_from_grid(data, grid_json, layout = {})
+      grid_response_body = JSON.parse(grid_json)
+      begin
+        payload_data = data.map { |d| self.class.replace_column_names_with_uids(grid_response_body, d) }
+      rescue => e
+        return Response.fail(e.to_s)
+      else
+        payload = { :figure => { :data => payload_data, :layout => layout } }.to_json
+        request = Net::HTTP::Post.new(ApiV2::PLOTS.path, @headers)
+        request.body = payload
+        Response.from_http_response(@https.request(request))
+      end
+    end
+
+    def self.replace_column_names_with_uids(response_body, trace_data)
+      raise('No :xsrc key in trace data') unless trace_data.has_key?(:xsrc)
+      raise('No :ysrc key in trace data') unless trace_data.has_key?(:ysrc)
+      x_uid = column_uid_from_name(response_body, trace_data[:xsrc])
+      y_uid = column_uid_from_name(response_body, trace_data[:ysrc])
+      trace_data.merge({:xsrc => x_uid, :ysrc => y_uid})
+    end
+
+    def self.column_uid_from_name(response_body, name)
+      fid = response_body.fetch('file').fetch('fid')
+      cols = response_body.fetch('file').fetch('cols')
+      maybe_col = cols.select { |c| c.fetch('name') == name.to_s}
+      raise("Unable to find column named '#{name.to_s}' in response") if maybe_col.size != 1
+      uid = maybe_col.first.fetch('uid')
+      "#{fid}:#{uid}"
+    end
+  end
+end

data/lib/plotlyrb/plotly.rb

@@ -7,6 +7,14 @@ module Plotlyrb
     def plot_image(*args)
       PlotImage.new(@headers).plot_image(*args)
     end
+
+    def create_grid(*args)
+      Grid.new(@headers).create(*args)
+    end
+
+    def create_plot_from_grid(*args)
+      Plot.new(@headers).create_from_grid(*args)
+    end
   end
 end
 

data/lib/plotlyrb/response.rb

@@ -0,0 +1,38 @@
+module Plotlyrb
+  class Response < Struct.new(:success, :body, :msg, :errors)
+    def self.from_http_response(rsp)
+      case rsp.code
+      when '200'
+        new(true, rsp.body, '200 - OK', [])
+      when '201'
+        new(true, rsp.body, '201 - CREATED', [])
+      when '400'
+        new(false, rsp.body, '400 - BAD REQUEST', get_errors(rsp.body))
+      when '404'
+        new(false, rsp.body, '404 - NOT FOUND', ['Appears we got an endpoint wrong'])
+      else
+        new(false, rsp.body, "#{rsp.code} - UNHANDLED", ['Unhandled error'])
+      end
+    end
+
+    def self.fail(msg)
+      new(false, '', msg, [msg])
+    end
+
+    # s is a Net::HTTP::Response body we expect to contain JSON map with a list of errors
+    def self.get_errors(s)
+      msg_key = 'message'
+      h = JSON.parse(s)
+      es = h['errors']
+      if es.nil? || !es.is_a?(Array) || !all_have_key?(es, msg_key)
+        return ['Failed to parse plotly error response - check raw body']
+      end
+
+      es.map { |e| e.fetch(msg_key) }
+    end
+
+    def self.all_have_key?(hs, key)
+      hs.all? { |h| h.has_key?(key) }
+    end
+  end
+end

data/lib/plotlyrb/version.rb

@@ -1,3 +1,3 @@
 module Plotlyrb
-  VERSION = '0.1.5'
+  VERSION = '0.2.0'
 end

data/lib/plotlyrb.rb

@@ -2,5 +2,8 @@ require 'backports' if RUBY_VERSION < '1.9.3'
 
 require_relative 'plotlyrb/version'
 require_relative 'plotlyrb/api_v2'
+require_relative 'plotlyrb/response'
 require_relative 'plotlyrb/plot_image'
+require_relative 'plotlyrb/grid'
+require_relative 'plotlyrb/plot'
 require_relative 'plotlyrb/plotly'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: plotlyrb
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors: 
 - Veitch Lister Consulting
@@ -9,7 +9,7 @@ autorequire:
 bindir: exe
 cert_chain: []
 
-date: 2016-01-25 00:00:00 Z
+date: 2016-10-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -54,8 +54,11 @@ files:
 - ext/mkrf_conf.rb
 - lib/plotlyrb.rb
 - lib/plotlyrb/api_v2.rb
+- lib/plotlyrb/grid.rb
+- lib/plotlyrb/plot.rb
 - lib/plotlyrb/plot_image.rb
 - lib/plotlyrb/plotly.rb
+- lib/plotlyrb/response.rb
 - lib/plotlyrb/version.rb
 - plotlyrb.gemspec
 homepage: https://github.com/vlc/plotlyrb