plotlyrb 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: a3294977f017a389f97c281ab13cc93b95878248
-  data.tar.gz: 60eee1cf956a7b94135cbcd5670dedb237239075
-SHA512: 
-  metadata.gz: c259c1f081ecad6cd832f66bf73b3745bcaeea56bab362d4af2f9b4ab5cb17399682c21b180501bda4d391ad5d0a060f16d3d7b82836819037f65ad79dd6387f
-  data.tar.gz: b645541f67a799b2e8810a8934dc083aa352d58c50116a0a7a62854c811d8921015bbd5512cda32e4014e242b466b5fbe891de93ef49876da91749b9fe908431
+---
+SHA1:
+  metadata.gz: bbae35cc7f8a221bfc10e1aa0871f4c69c67de9b
+  data.tar.gz: e4bc1e4abf9805be288eacc211047449460d6267
+SHA512:
+  metadata.gz: 30250a5b1591d455506f78e5dc98e5c8f210dbc1bb4ca92d7e890727c7672155505593df790c065111f2c43531ca493e683a96d5d9da0e42f485364cd576aec1
+  data.tar.gz: 1cf7735bd3af867c2cc80dd2044feff6593123e258c65113b06a28e1fdcd8b449771e1b35f70bcdd441c7e2cf4180e935cf935ef401863d61596d3abc394c85e

data/README.md

@@ -31,22 +31,37 @@ Or install it yourself as:
 ```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',
-  :mode => 'markers',
-}
+# NOTE: data argument must be an array of traces
+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',
+    :mode => 'markers',
+    :name => 'Andrew M'
+  },
+  {
+    :x => ['2013-10-04 22:23:00', '2013-11-04 22:23:00', '2013-12-04 22:23:00'],
+    :y => [3, 4, 9],
+    :type => 'scatter'
+    :name => 'Andrew N'
+  }
+]
 
 layout = {
   :xaxis => { :title => 'times' },
-  :yaxis => { :title => 'bigfoot sightings', :range => [0, 7] },
+  :yaxis => { :title => 'pokemon caught', :range => [0, 7] },
+}
+
+plot_spec = {
+  :figure => {:data => data},
+  :layout => layout,
+  :format => :svg
 }
 
 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)
+plotly.plot_image(plot_spec, '/path/to/plot.svg')
 ```
 
 ## TODO

data/lib/plotlyrb/grid.rb

@@ -9,12 +9,11 @@ module Plotlyrb
       @https.use_ssl = true
     end
 
-    # data is a hash that mirrors the format of the data hash in the API
+    # data is a hash that mirrors the format of the hash in the API
     # https://api.plot.ly/v2/grids#create
-    def create(data)
-      payload = {:data => data}.to_json
+    def create(grid_spec)
       request = Net::HTTP::Post.new(ApiV2::GRIDS.path, @headers)
-      request.body = payload
+      request.body = grid_spec.to_json
       Response.from_http_response(@https.request(request))
     end
   end

data/lib/plotlyrb/plot.rb

@@ -14,20 +14,32 @@ module Plotlyrb
     # 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 = {})
+    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 = data.map { |d| self.class.replace_column_names_with_uids(grid_response_body, d) }
+        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 = { :figure => { :data => payload_data, :layout => layout } }.to_json
+        payload = self.class.replace_data_in_spec(plot_spec, payload_data)
         request = Net::HTTP::Post.new(ApiV2::PLOTS.path, @headers)
-        request.body = payload
+        request.body = payload.to_json
         Response.from_http_response(@https.request(request))
       end
     end
 
+    def self.replace_data_in_spec(spec, new_data)
+      new_figure = spec[:figure].merge({:data => new_data})
+      spec.merge({:figure => new_figure})
+    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)

data/lib/plotlyrb/plot_image.rb

@@ -12,14 +12,18 @@ module Plotlyrb
       @https.use_ssl = true
     end
 
-    def plot_image(data, image_path, image_type, layout = {})
-      raise "image_type #{image_type} not supported" unless VALID_IMAGE_FORMATS.include?(image_type)
-      payload = { :figure => { :data => data, :layout => layout }, :format => image_type.to_s }.to_json
+    def plot_image(plot_image_spec, image_path)
+      raise 'No :format key in spec' unless plot_image_spec.has_key?(:format)
+      raise 'No :figure key in spec' unless plot_image_spec.has_key?(:figure)
+      raise ':data key not found at {:figure => {:data => ...}}' unless plot_image_spec[:figure].has_key?(:data)
+
+      image_format = plot_image_spec[:format]
+      raise "Image format #{image_format} not supported" unless VALID_IMAGE_FORMATS.include?(image_format.to_sym)
+
       request = Net::HTTP::Post.new(ApiV2::IMAGES.path, @headers)
-      request.body = payload
+      request.body = plot_image_spec.to_json
       response = @https.request(request)
-      image_path_with_ext = "#{image_path}"
-      IO.binwrite(image_path_with_ext, response.body)
+      IO.binwrite(image_path, response.body)
     end
   end
-end
+end

data/lib/plotlyrb/version.rb

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

data/plotlyrb.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end

metadata

@@ -1,48 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: plotlyrb
-version: !ruby/object:Gem::Version 
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Veitch Lister Consulting
 autorequire: 
 bindir: exe
 cert_chain: []
-
-date: 2016-10-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2016-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.11"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: "10.0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: Trying to complete a complete API based on the Python Library https://github.com/plotly/plotly.py/tree/master/plotly/plotly
-email: 
+email:
 - developers@veitchlister.com.au
 executables: []
-
-extensions: 
+extensions:
 - ext/mkrf_conf.rb
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .ruby-version
+files:
+- ".gitignore"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -62,32 +67,28 @@ files:
 - lib/plotlyrb/version.rb
 - plotlyrb.gemspec
 homepage: https://github.com/vlc/plotlyrb
-licenses: 
+licenses:
 - MIT
-metadata: 
-  allowed_push_host: "TODO: Set to 'http://mygemserver.com'"
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.16
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper around the Plotly RESTful API.
 test_files: []
-
-has_rdoc: