visualization-js-api 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e38750da598cf4f65280cfe24eac7fa2966d37b884dcc8b3b37f67abb9ef7add
-  data.tar.gz: c4028c4416d5fe6eda70d4310101a568aea3efee18e0f65a87d8a1afc8ef3051
+  metadata.gz: 62fe85c2762d2ad52d6a052a990a023b391e8d398a0f438eb8fa3e657ff35361
+  data.tar.gz: e00eebd77df38e6e894e7c7261f5df84544ec06bd60efb03740d6348a91c7801
 SHA512:
-  metadata.gz: 7212754bd149d72ff7762599d327ffb3ab313bb3aed75f5650e83395841e71c9bee537a57e2f9eb75f0271200f2a34f883d996cb975b66e8d2dea1509fa3fef7
-  data.tar.gz: 4edfc540c7cf22b15638cb6c0e3c60c5aa2b522efe8ec3af6d78fcb7b1e3f5ac5ecc22affe6562356bed7e12fc9ec34cdb825201cc1ab654fea935d5360bd84a
+  metadata.gz: 5cfddf24dde554eb2a55254d1bc7a38b697be90dd368c233468fb3d1a47f8884c97a8b106ab390cfd483afe24a8f317d25cd94a4ae45a1eb40e95af122339d3c
+  data.tar.gz: abe26e704a65c5c24e5d54c870da07fcd0dcde3c70074b496db7cb109d61596951bd8291b5c7e2d55e94448e2a7b96ff93962a8059671e9ffee00f8e53f8b9bb

data/README.md

@@ -6,9 +6,9 @@ Generates server side renderings of D3 visualizations for a nodejs backend
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 0.0.1
-- Package version: 0.0.2
-- Build date: 2020-01-29T17:31:36.625+01:00
+- API version: 0.1.0
+- Package version: 0.1.0
+- Build date: 2020-07-16T22:06:32.894+02:00
 - Build package: class io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -24,15 +24,15 @@ gem build visualization-js-api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./visualization-js-api-0.0.2.gem
+gem install ./visualization-js-api-0.1.0.gem
 ```
-(for development, run `gem install --dev ./visualization-js-api-0.0.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./visualization-js-api-0.1.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'visualization-js-api', '~> 0.0.2'
+    gem 'visualization-js-api', '~> 0.1.0'
 
 ### Install from Git
 
@@ -57,7 +57,7 @@ require 'visualization-js-api'
 
 api_instance = VisualizationJsApi::DefaultApi.new
 
-graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | graph definition object
+graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | The graph definition object
 
 
 begin
@@ -88,5 +88,8 @@ Class | Method | HTTP request | Description
 
 ## Documentation for Authorization
 
- All endpoints do not require authorization.
+
+### auth
+
+- **Type**: HTTP basic authentication
 

data/docs/DefaultApi.md

@@ -22,7 +22,7 @@ require 'visualization-js-api'
 
 api_instance = VisualizationJsApi::DefaultApi.new
 
-graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | graph definition object
+graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | The graph definition object
 
 
 begin
@@ -37,7 +37,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **graph_definition** | [**GraphDefinition**](GraphDefinition.md)| graph definition object | 
+ **graph_definition** | [**GraphDefinition**](GraphDefinition.md)| The graph definition object | 
 
 ### Return type
 
@@ -59,7 +59,7 @@ No authorization required
 
 
 
-Creates a user
+Renders a graph in SVG format
 
 ### Example
 ```ruby
@@ -68,7 +68,7 @@ require 'visualization-js-api'
 
 api_instance = VisualizationJsApi::DefaultApi.new
 
-graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | graph definition object
+graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | The graph definition object
 
 
 begin
@@ -83,7 +83,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **graph_definition** | [**GraphDefinition**](GraphDefinition.md)| graph definition object | 
+ **graph_definition** | [**GraphDefinition**](GraphDefinition.md)| The graph definition object | 
 
 ### Return type
 

data/docs/GraphDefinitionGraph.md

@@ -3,13 +3,13 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**chart** | **Object** |  | 
-**title** | **Object** |  | [optional] 
-**subtitle** | **Object** |  | [optional] 
-**plot_options** | **Object** |  | [optional] 
-**x_axis** | **Object** |  | [optional] 
-**y_axis** | **Object** |  | 
-**colors** | **Array<String>** |  | [optional] 
-**series** | **Object** |  | [optional] 
+**chart** | **Object** | The name of the chart to render | 
+**title** | **Object** | The title of the graph | [optional] 
+**subtitle** | **Object** | The subtitle of the graph | [optional] 
+**plot_options** | **Object** | A graph can have multiple extra options, these can be defined here | [optional] 
+**x_axis** | **Object** | The properties for the xAxis of the graph | [optional] 
+**y_axis** | **Object** | The properties for the yAxis of the graph | 
+**colors** | **Array<String>** | The colors to use in the graph | [optional] 
+**series** | **Object** | The actual data in the graph | [optional] 
 
 

data/lib/visualization-js-api.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/lib/visualization-js-api/api/default_api.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -33,7 +33,7 @@ module VisualizationJsApi
 
     # 
     # Renders a graph in PNG format
-    # @param graph_definition graph definition object
+    # @param graph_definition The graph definition object
     # @param [Hash] opts the optional parameters
     # @return [String]
     def render_png_post(graph_definition, opts = {})
@@ -43,7 +43,7 @@ module VisualizationJsApi
 
     # 
     # Renders a graph in PNG format
-    # @param graph_definition graph definition object
+    # @param graph_definition The graph definition object
     # @param [Hash] opts the optional parameters
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def render_png_post_with_http_info(graph_definition, opts = {})
@@ -89,8 +89,8 @@ module VisualizationJsApi
     end
 
     # 
-    # Creates a user
-    # @param graph_definition graph definition object
+    # Renders a graph in SVG format
+    # @param graph_definition The graph definition object
     # @param [Hash] opts the optional parameters
     # @return [String]
     def render_svg_post(graph_definition, opts = {})
@@ -99,8 +99,8 @@ module VisualizationJsApi
     end
 
     # 
-    # Creates a user
-    # @param graph_definition graph definition object
+    # Renders a graph in SVG format
+    # @param graph_definition The graph definition object
     # @param [Hash] opts the optional parameters
     # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
     def render_svg_post_with_http_info(graph_definition, opts = {})

data/lib/visualization-js-api/api_client.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -97,6 +97,7 @@ module VisualizationJsApi
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 
+      update_params_for_auth! header_params, query_params, opts[:auth_names]
 
       # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
       _verify_ssl_host = @config.verify_ssl_host ? 2 : 0

data/lib/visualization-js-api/api_error.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/lib/visualization-js-api/configuration.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -201,6 +201,13 @@ module VisualizationJsApi
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
+        'auth' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
       }
     end
   end

data/lib/visualization-js-api/models/graph_definition.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/lib/visualization-js-api/models/graph_definition_graph.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,22 +24,30 @@ limitations under the License.
 require 'date'
 
 module VisualizationJsApi
-
+  # The definition of the graph. This graph contains the main properties needed for rendering a graph.
   class GraphDefinitionGraph
+    # The name of the chart to render
     attr_accessor :chart
 
+    # The title of the graph
     attr_accessor :title
 
+    # The subtitle of the graph
     attr_accessor :subtitle
 
+    # A graph can have multiple extra options, these can be defined here
     attr_accessor :plot_options
 
+    # The properties for the xAxis of the graph
     attr_accessor :x_axis
 
+    # The properties for the yAxis of the graph
     attr_accessor :y_axis
 
+    # The colors to use in the graph
     attr_accessor :colors
 
+    # The actual data in the graph
     attr_accessor :series
 
 

data/lib/visualization-js-api/models/graph_definition_graph_options.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/lib/visualization-js-api/version.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,5 +22,5 @@ limitations under the License.
 =end
 
 module VisualizationJsApi
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/api/default_api_spec.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -46,7 +46,7 @@ describe 'DefaultApi' do
   # unit tests for render_png_post
   # 
   # Renders a graph in PNG format
-  # @param graph_definition graph definition object
+  # @param graph_definition The graph definition object
   # @param [Hash] opts the optional parameters
   # @return [String]
   describe 'render_png_post test' do
@@ -57,8 +57,8 @@ describe 'DefaultApi' do
 
   # unit tests for render_svg_post
   # 
-  # Creates a user
-  # @param graph_definition graph definition object
+  # Renders a graph in SVG format
+  # @param graph_definition The graph definition object
   # @param [Hash] opts the optional parameters
   # @return [String]
   describe 'render_svg_post test' do

data/spec/api_client_spec.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/spec/configuration_spec.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/spec/models/graph_definition_graph_options_spec.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/spec/models/graph_definition_graph_spec.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/spec/models/graph_definition_spec.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/spec/spec_helper.rb

@@ -3,8 +3,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/visualization-js-api.gemspec

@@ -5,8 +5,8 @@
 
 #Generates server side renderings of D3 visualizations for a nodejs backend
 
-OpenAPI spec version: 0.0.1
-
+OpenAPI spec version: 0.1.0
+Contact: info@researchable.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,14 +31,14 @@ Gem::Specification.new do |s|
   s.version     = VisualizationJsApi::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Researchable"]
-  s.email       = ["info@researchable.nl"]
+  s.email       = ["support@researchable.nl"]
   s.homepage    = "https://researchable.nl"
-  s.summary     = "Visualization API Ruby Gem"
+  s.summary     = "This gem provides the interaction with the backend service for rendering graphs."
   s.description = "Generates server side renderings of D3 visualizations for a nodejs backend"
-  s.license     = "Apache 2.0"
+  s.license     = "MIT"
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
-  
+
 
   s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
   s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: visualization-js-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Researchable
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -172,7 +172,7 @@ dependencies:
         version: 0.2.11
 description: Generates server side renderings of D3 visualizations for a nodejs backend
 email:
-- info@researchable.nl
+- support@researchable.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -203,7 +203,7 @@ files:
 - visualization-js-api.gemspec
 homepage: https://researchable.nl
 licenses:
-- Apache 2.0
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -220,10 +220,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: Visualization API Ruby Gem
+summary: This gem provides the interaction with the backend service for rendering
+  graphs.
 test_files:
 - spec/api/default_api_spec.rb
 - spec/api_client_spec.rb