Class: Plotlyrb::Plot

Inherits:
Object
  • Object
show all
Defined in:
lib/plotlyrb/plot.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(headers) ⇒ Plot

Returns a new instance of Plot.



7
8
9
10
11
 
# File 'lib/plotlyrb/plot.rb', line 7

def initialize(headers)
  @headers = headers
  @https = Net::HTTP.new(ApiV2::PLOTS.host, ApiV2::PLOTS.port)
  @https.use_ssl = true
end

Class Method Details

.column_uid_from_name(response_body, name) ⇒ Object 



51
52
53
54
55
56
57
58
 
# File 'lib/plotlyrb/plot.rb', line 51

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

.replace_column_names_with_uids(response_body, trace_data) ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/plotlyrb/plot.rb', line 43

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

.replace_data_in_spec(spec, new_data) ⇒ Object 



38
39
40
41
 
# File 'lib/plotlyrb/plot.rb', line 38

def self.replace_data_in_spec(spec, new_data)
  new_figure = spec[:figure].merge({:data => new_data})
  spec.merge({:figure => new_figure})
end

Instance Method Details

#create_from_grid(plot_spec, grid_json) ⇒ Object

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 api.plot.ly/v2/plots#create



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/plotlyrb/plot.rb', line 17

def create_from_grid(plot_spec, grid_json)
  grid_response_body = JSON.parse(grid_json)
  return Response.fail('No :figure key in plot spec') unless plot_spec.has_key?(:figure)
  unless plot_spec[:figure].has_key?(:data)
    return Response.fail('No :data key at {:figure => {:data => ...}} in plot spec')
  end

  begin
    payload_data = plot_spec[:figure][:data].map { |d|
      self.class.replace_column_names_with_uids(grid_response_body, d)
    }
  rescue => e
    return Response.fail(e.to_s)
  else
    payload = self.class.replace_data_in_spec(plot_spec, payload_data)
    request = Net::HTTP::Post.new(ApiV2::PLOTS.path, @headers)
    request.body = payload.to_json
    Response.from_http_response(@https.request(request))
  end
end