plotlyrb 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  data.tar.gz: f8ba8954c500971712f3231d3f2d43bac2fed278cfa9de6da45389c25c6c459792ce4ce6260306aff049c0084ee68ab3477559aae97f2c1812930315fc999d03
-  metadata.gz: ebc67494b4c92d19c0df370d67702ad7d58d30a1627da2b811294393a584bdd19a53b9ae277a08ab1c603de759e0d7e24197326c96430f1c4b0975df0d46a0df
+  metadata.gz: c414fe15b1fdae4c2ecfb7bae766660b30f16510cc4b01ea8e0cf564a0febe49ca6730ba8e0d9f0a4e252ab47890a6b3222404976e6966072fbbcef7c35488e2
+  data.tar.gz: 1821bcfae3d5c79b8391a130e6ff8d734deb25b68a34815555b84a4a58b48656d640767dd7845c495f8780d23a2e9290f71e8f79929763b56cf8e7a2f3ddc494
 SHA1: 
-  data.tar.gz: beda0dece41c51bc40bd5561e8b91068b382e2a8
-  metadata.gz: ae8b4c55d6b40d7d43e207c0e43f67f1d0c3e8e3
+  metadata.gz: 1e749d6b08a9882ed571ec50eef29344863cc832
+  data.tar.gz: 180ac6344d89b87b7b63c81cd51cfdb655157bfd

data/README.md

@@ -1,8 +1,8 @@
 # Plotlyrb
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/plotlyrb`. To experiment with that code, run `bin/console` for an interactive prompt.
+Use [plotly](https://plot.ly) to graph your data.
 
-TODO: Delete this and the text above, and describe your gem
+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.
 
 ## Installation
 
@@ -22,7 +22,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+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'
+}
+
+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)
+```
+
+## TODO
+- [ ] Support height and width
+- [ ] Test more plot types
+- [ ] Use data structures/abstractions for plot types, data, etc. ?
 
 ## Development
 
@@ -34,7 +52,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 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.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/plotlyrb/api_v2.rb

@@ -8,16 +8,20 @@ module Plotlyrb
     HOSTNAME = 'api.plot.ly'
     BASE_PATH = 'v2'
     BASE_URI = "#{PROTOCOL}://#{HOSTNAME}/#{BASE_PATH}"
-
     IMAGES = URI.parse("#{BASE_URI}/images")
+    COMMON_HEADERS = {
+      'plotly-client-platform' => "Ruby #{Plotlyrb::VERSION}",
+      'content-type' => 'application/json'
+    }
+
+    def self.plotly
+      Plotly.new(COMMON_HEADERS)
+    end
 
-    def self.headers(username, api_key)
+    def self.auth_plotly(username, api_key)
       encoded_auth = Base64.encode64("#{username}:#{api_key}")
-      {
-        'plotly-client-platform' => "Ruby #{Plotlyrb::VERSION}",
-        'authorization' => "Basic #{encoded_auth}",
-        'content-type' => 'application/json'
-      }
+      headers_hash = COMMON_HEADERS.merge({ 'authorization' => "Basic #{encoded_auth}" })
+      Plotly.new(headers_hash)
     end
   end
 end

data/lib/plotlyrb/plot_image.rb

@@ -6,17 +6,16 @@ module Plotlyrb
 
     VALID_IMAGE_FORMATS = [:png, :svg, :pdf, :eps]
 
-    def initialize(username, api_key, url=ApiV2::IMAGES)
-      @url = url
-      @headers = ApiV2::headers(username, api_key)
-      @https = Net::HTTP.new(url.host, url.port)
+    def initialize(plotly)
+      @plotly = plotly
+      @https = Net::HTTP.new(ApiV2::IMAGES.host, ApiV2::IMAGES.port)
       @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
-      request = Net::HTTP::Post.new(@url.path, @headers)
+      request = Net::HTTP::Post.new(ApiV2::IMAGES.path, @plotly)
       request.body = payload
       response = @https.request(request)
       image_path_with_ext = "#{image_path}"

data/lib/plotlyrb/plotly.rb

@@ -0,0 +1,12 @@
+module Plotlyrb
+  class Plotly
+    def initialize(headers)
+      @headers = headers
+    end
+
+    def plot_image(*args)
+      PlotImage.new(@headers).plot_image(*args)
+    end
+  end
+end
+

data/lib/plotlyrb/version.rb

@@ -1,3 +1,3 @@
 module Plotlyrb
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/plotlyrb.rb

@@ -3,3 +3,4 @@ require 'backports'
 require_relative 'plotlyrb/version'
 require_relative 'plotlyrb/api_v2'
 require_relative 'plotlyrb/plot_image'
+require_relative 'plotlyrb/plotly'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: plotlyrb
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Veitchlister Consulting
@@ -9,7 +9,7 @@ autorequire:
 bindir: exe
 cert_chain: []
 
-date: 2016-01-21 00:00:00 Z
+date: 2016-01-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: backports
@@ -67,6 +67,7 @@ files:
 - lib/plotlyrb.rb
 - lib/plotlyrb/api_v2.rb
 - lib/plotlyrb/plot_image.rb
+- lib/plotlyrb/plotly.rb
 - lib/plotlyrb/version.rb
 - plotlyrb.gemspec
 homepage: https://github.com/vlc/plotlyrb