plotlyrb 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: 69fce8f04f3e15a1b0bb3faa1985852b7fdfd405
-  data.tar.gz: 3b9800b3c6f095e9f559f74f65dba68b9a1ea28a
-SHA512:
-  metadata.gz: c1afaeb391e70b9be780ec0bbee8b432336b1bb871a57135ef2f736a2f2658434ba4d6fea7f06739e52648025ae68818aab33c22e23af27bd09fb043232f4515
-  data.tar.gz: 71c1d9938ac978d4704452d5d73b643a35616d2cdd15c1deb34e03364b3c7879a155537eb15d1073bed5065b29af3c0687cb944d464e83db2ce2c409267b217e
+--- 
+SHA512: 
+  metadata.gz: 800dc5d4e276d7267da72d1ce0b0be54ae07961c0d00c885c9108aee834d62c834037ced8018c2d11c899ca20bac1d1212261d99b566c91e190651c814309afc
+  data.tar.gz: b6915dbeb3231e5743083e004c4dae19ca3ecb95208fba9e30e079234dab1de06336c5aaaa1a9fd2c9720ff305b0d8b2906ee1b2a2aff0e62a373d1b76a45d24
+SHA1: 
+  metadata.gz: d551fc4bd00bacd85645dad7d3487e375fbe6684
+  data.tar.gz: 12ab89f47031615e1d241dbc5aa48a5674746b5b

data/README.md

@@ -43,19 +43,18 @@ data = [
   {
     :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'
+    :type => 'scatter',
     :name => 'Andrew N'
   }
 ]
 
 layout = {
   :xaxis => { :title => 'times' },
-  :yaxis => { :title => 'pokemon caught', :range => [0, 7] },
+  :yaxis => { :title => 'pokemon caught', :range => [0, 10] },
 }
 
 plot_spec = {
-  :figure => {:data => data},
-  :layout => layout,
+  :figure => {:data => data, :layout => layout},
   :format => :svg
 }
 
@@ -75,6 +74,12 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+If `bundle exec rake release` hangs after pushing changes and tags, you may need to kill it and authenticate against rubygems.org before trying again. First, make sure you have a rubygems account and have been added as an owner of the gem. Then you may authenticate from the command line by doing the following (sourced from [stack overflow](http://stackoverflow.com/a/20284960/510722) of course)
+
+```bash
+curl -u <rubygems-handle> https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plotlyrb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/plotlyrb/plot_image.rb

@@ -22,8 +22,66 @@ module Plotlyrb
 
       request = Net::HTTP::Post.new(ApiV2::IMAGES.path, @headers)
       request.body = plot_image_spec.to_json
-      response = @https.request(request)
-      IO.binwrite(image_path, response.body)
+      response = Response.from_http_response(@https.request(request))
+      IO.binwrite(image_path, response.body) if response.success
+      response
+    end
+
+    SpecPath = Struct.new(:spec, :path)
+    AsyncJobResult = Struct.new(:success, :message, :spec_path)
+
+    class AsyncJob < Struct.new(:thread, :spec_path, :start_time, :timeout)
+      def self.from_spec_path(pi, spec_path, timeout)
+        thread = Thread.new { pi.plot_image(spec_path.spec, spec_path.path) }
+        new(thread, spec_path, Time.new, timeout)
+      end
+
+      def join
+        now = Time.new
+        join_wait = (self.timeout - (now - self.start_time)).to_i + 1
+
+        def fail(msg)
+          AsyncJobResult.new(false, msg, spec_path)
+        end
+
+        # Joining should bubble any exceptions, so catch them and report the failure as an error
+        begin
+          if thread.join(join_wait).nil?
+            thread.exit
+            return fail("thread didn't finish within timeout (#{timeout}s)")
+          end
+
+          response = thread.value
+          unless response.success
+            return fail("Plotly returned error response: #{response}")
+          end
+
+          unless File.exist?(spec_path.path)
+            return fail("Output file (#{spec_path.path}) not found")
+          end
+        rescue => e
+          return fail(e.message)
+        end
+
+        AsyncJobResult.new(true, '', spec_path)
+      end
+    end
+
+    # Given an array of SpecPaths, run each plot_image request in a separate thread, wait timeout
+    # for each, then return AsyncJobResults for any inputs that failed after the given number of
+    # retries
+    def self.plot_images(headers, spec_paths, timeout, retries)
+      raise 'Retries must be an integer >= 0' unless (retries.class == Fixnum && retries >= 0)
+      return [] if spec_paths.empty?
+
+      input_results = spec_paths.map { |sp| AsyncJobResult.new(false, 'not run yet', sp) }
+      (0..retries).to_a.inject(input_results) { |ajrs, _|
+        # While you might be tempted to fuse these map calls, we want all the jobs to get started
+        # before we start joining them, so don't do that.
+        rs = ajrs.map { |ajr| AsyncJob.from_spec_path(PlotImage.new(headers), ajr.spec_path, timeout) }.
+                  map(&:join).
+                  reject(&:success)
+      }
     end
   end
 end

data/lib/plotlyrb/plotly.rb

@@ -8,6 +8,10 @@ module Plotlyrb
       PlotImage.new(@headers).plot_image(*args)
     end
 
+    def plot_images(*args)
+      PlotImage.plot_images(@headers, *args)
+    end
+
     def create_grid(*args)
       Grid.new(@headers).create(*args)
     end

data/lib/plotlyrb/response.rb

@@ -34,5 +34,9 @@ module Plotlyrb
     def self.all_have_key?(hs, key)
       hs.all? { |h| h.has_key?(key) }
     end
+
+    def to_s
+      "#{success ? 'Succeeded' : 'Failed'}: #{msg}"
+    end
   end
 end

data/lib/plotlyrb/version.rb

@@ -1,3 +1,3 @@
 module Plotlyrb
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/plotlyrb.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["developers@veitchlister.com.au"]
 
   spec.summary       = %q{A Ruby wrapper around the Plotly RESTful API.}
-  spec.description   = %q{Trying to complete a complete API based on the Python Library https://github.com/plotly/plotly.py/tree/master/plotly/plotly}
+  spec.description   = %q{Plotly features added as needed. Uses Python Library as a reference https://github.com/plotly/plotly.py/tree/master/plotly/plotly}
   spec.homepage      = "https://github.com/vlc/plotlyrb"
   spec.license       = "MIT"
 

metadata

@@ -1,53 +1,48 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: plotlyrb
-version: !ruby/object:Gem::Version
-  version: 1.0.1
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
 platform: ruby
-authors:
+authors: 
 - Veitch Lister Consulting
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2017-03-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
   prerelease: false
-  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'
+  requirement: &id001 !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
-  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:
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "10.0"
+  type: :development
+  version_requirements: *id002
+description: Plotly features added as needed. Uses Python Library as a reference https://github.com/plotly/plotly.py/tree/master/plotly/plotly
+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
@@ -67,28 +62,31 @@ files:
 - lib/plotlyrb/version.rb
 - plotlyrb.gemspec
 homepage: https://github.com/vlc/plotlyrb
-licenses:
+licenses: 
 - MIT
-metadata:
+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.4.6
+rubygems_version: 2.0.17
 signing_key: 
 specification_version: 4
 summary: A Ruby wrapper around the Plotly RESTful API.
 test_files: []
+