visualization-js-api 0.0.2 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e38750da598cf4f65280cfe24eac7fa2966d37b884dcc8b3b37f67abb9ef7add
4
- data.tar.gz: c4028c4416d5fe6eda70d4310101a568aea3efee18e0f65a87d8a1afc8ef3051
3
+ metadata.gz: 62fe85c2762d2ad52d6a052a990a023b391e8d398a0f438eb8fa3e657ff35361
4
+ data.tar.gz: e00eebd77df38e6e894e7c7261f5df84544ec06bd60efb03740d6348a91c7801
5
5
  SHA512:
6
- metadata.gz: 7212754bd149d72ff7762599d327ffb3ab313bb3aed75f5650e83395841e71c9bee537a57e2f9eb75f0271200f2a34f883d996cb975b66e8d2dea1509fa3fef7
7
- data.tar.gz: 4edfc540c7cf22b15638cb6c0e3c60c5aa2b522efe8ec3af6d78fcb7b1e3f5ac5ecc22affe6562356bed7e12fc9ec34cdb825201cc1ab654fea935d5360bd84a
6
+ metadata.gz: 5cfddf24dde554eb2a55254d1bc7a38b697be90dd368c233468fb3d1a47f8884c97a8b106ab390cfd483afe24a8f317d25cd94a4ae45a1eb40e95af122339d3c
7
+ data.tar.gz: abe26e704a65c5c24e5d54c870da07fcd0dcde3c70074b496db7cb109d61596951bd8291b5c7e2d55e94448e2a7b96ff93962a8059671e9ffee00f8e53f8b9bb
data/README.md CHANGED
@@ -6,9 +6,9 @@ Generates server side renderings of D3 visualizations for a nodejs backend
6
6
 
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
- - API version: 0.0.1
10
- - Package version: 0.0.2
11
- - Build date: 2020-01-29T17:31:36.625+01:00
9
+ - API version: 0.1.0
10
+ - Package version: 0.1.0
11
+ - Build date: 2020-07-16T22:06:32.894+02:00
12
12
  - Build package: class io.swagger.codegen.languages.RubyClientCodegen
13
13
 
14
14
  ## Installation
@@ -24,15 +24,15 @@ gem build visualization-js-api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./visualization-js-api-0.0.2.gem
27
+ gem install ./visualization-js-api-0.1.0.gem
28
28
  ```
29
- (for development, run `gem install --dev ./visualization-js-api-0.0.2.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./visualization-js-api-0.1.0.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'visualization-js-api', '~> 0.0.2'
35
+ gem 'visualization-js-api', '~> 0.1.0'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -57,7 +57,7 @@ require 'visualization-js-api'
57
57
 
58
58
  api_instance = VisualizationJsApi::DefaultApi.new
59
59
 
60
- graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | graph definition object
60
+ graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | The graph definition object
61
61
 
62
62
 
63
63
  begin
@@ -88,5 +88,8 @@ Class | Method | HTTP request | Description
88
88
 
89
89
  ## Documentation for Authorization
90
90
 
91
- All endpoints do not require authorization.
91
+
92
+ ### auth
93
+
94
+ - **Type**: HTTP basic authentication
92
95
 
@@ -22,7 +22,7 @@ require 'visualization-js-api'
22
22
 
23
23
  api_instance = VisualizationJsApi::DefaultApi.new
24
24
 
25
- graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | graph definition object
25
+ graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | The graph definition object
26
26
 
27
27
 
28
28
  begin
@@ -37,7 +37,7 @@ end
37
37
 
38
38
  Name | Type | Description | Notes
39
39
  ------------- | ------------- | ------------- | -------------
40
- **graph_definition** | [**GraphDefinition**](GraphDefinition.md)| graph definition object |
40
+ **graph_definition** | [**GraphDefinition**](GraphDefinition.md)| The graph definition object |
41
41
 
42
42
  ### Return type
43
43
 
@@ -59,7 +59,7 @@ No authorization required
59
59
 
60
60
 
61
61
 
62
- Creates a user
62
+ Renders a graph in SVG format
63
63
 
64
64
  ### Example
65
65
  ```ruby
@@ -68,7 +68,7 @@ require 'visualization-js-api'
68
68
 
69
69
  api_instance = VisualizationJsApi::DefaultApi.new
70
70
 
71
- graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | graph definition object
71
+ graph_definition = VisualizationJsApi::GraphDefinition.new # GraphDefinition | The graph definition object
72
72
 
73
73
 
74
74
  begin
@@ -83,7 +83,7 @@ end
83
83
 
84
84
  Name | Type | Description | Notes
85
85
  ------------- | ------------- | ------------- | -------------
86
- **graph_definition** | [**GraphDefinition**](GraphDefinition.md)| graph definition object |
86
+ **graph_definition** | [**GraphDefinition**](GraphDefinition.md)| The graph definition object |
87
87
 
88
88
  ### Return type
89
89
 
@@ -3,13 +3,13 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **chart** | **Object** | |
7
- **title** | **Object** | | [optional]
8
- **subtitle** | **Object** | | [optional]
9
- **plot_options** | **Object** | | [optional]
10
- **x_axis** | **Object** | | [optional]
11
- **y_axis** | **Object** | |
12
- **colors** | **Array<String>** | | [optional]
13
- **series** | **Object** | | [optional]
6
+ **chart** | **Object** | The name of the chart to render |
7
+ **title** | **Object** | The title of the graph | [optional]
8
+ **subtitle** | **Object** | The subtitle of the graph | [optional]
9
+ **plot_options** | **Object** | A graph can have multiple extra options, these can be defined here | [optional]
10
+ **x_axis** | **Object** | The properties for the xAxis of the graph | [optional]
11
+ **y_axis** | **Object** | The properties for the yAxis of the graph |
12
+ **colors** | **Array<String>** | The colors to use in the graph | [optional]
13
+ **series** | **Object** | The actual data in the graph | [optional]
14
14
 
15
15
 
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -33,7 +33,7 @@ module VisualizationJsApi
33
33
 
34
34
  #
35
35
  # Renders a graph in PNG format
36
- # @param graph_definition graph definition object
36
+ # @param graph_definition The graph definition object
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [String]
39
39
  def render_png_post(graph_definition, opts = {})
@@ -43,7 +43,7 @@ module VisualizationJsApi
43
43
 
44
44
  #
45
45
  # Renders a graph in PNG format
46
- # @param graph_definition graph definition object
46
+ # @param graph_definition The graph definition object
47
47
  # @param [Hash] opts the optional parameters
48
48
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
49
49
  def render_png_post_with_http_info(graph_definition, opts = {})
@@ -89,8 +89,8 @@ module VisualizationJsApi
89
89
  end
90
90
 
91
91
  #
92
- # Creates a user
93
- # @param graph_definition graph definition object
92
+ # Renders a graph in SVG format
93
+ # @param graph_definition The graph definition object
94
94
  # @param [Hash] opts the optional parameters
95
95
  # @return [String]
96
96
  def render_svg_post(graph_definition, opts = {})
@@ -99,8 +99,8 @@ module VisualizationJsApi
99
99
  end
100
100
 
101
101
  #
102
- # Creates a user
103
- # @param graph_definition graph definition object
102
+ # Renders a graph in SVG format
103
+ # @param graph_definition The graph definition object
104
104
  # @param [Hash] opts the optional parameters
105
105
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
106
106
  def render_svg_post_with_http_info(graph_definition, opts = {})
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -97,6 +97,7 @@ module VisualizationJsApi
97
97
  query_params = opts[:query_params] || {}
98
98
  form_params = opts[:form_params] || {}
99
99
 
100
+ update_params_for_auth! header_params, query_params, opts[:auth_names]
100
101
 
101
102
  # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
102
103
  _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -201,6 +201,13 @@ module VisualizationJsApi
201
201
  # Returns Auth Settings hash for api client.
202
202
  def auth_settings
203
203
  {
204
+ 'auth' =>
205
+ {
206
+ type: 'basic',
207
+ in: 'header',
208
+ key: 'Authorization',
209
+ value: basic_auth_token
210
+ },
204
211
  }
205
212
  end
206
213
  end
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,22 +24,30 @@ limitations under the License.
24
24
  require 'date'
25
25
 
26
26
  module VisualizationJsApi
27
-
27
+ # The definition of the graph. This graph contains the main properties needed for rendering a graph.
28
28
  class GraphDefinitionGraph
29
+ # The name of the chart to render
29
30
  attr_accessor :chart
30
31
 
32
+ # The title of the graph
31
33
  attr_accessor :title
32
34
 
35
+ # The subtitle of the graph
33
36
  attr_accessor :subtitle
34
37
 
38
+ # A graph can have multiple extra options, these can be defined here
35
39
  attr_accessor :plot_options
36
40
 
41
+ # The properties for the xAxis of the graph
37
42
  attr_accessor :x_axis
38
43
 
44
+ # The properties for the yAxis of the graph
39
45
  attr_accessor :y_axis
40
46
 
47
+ # The colors to use in the graph
41
48
  attr_accessor :colors
42
49
 
50
+ # The actual data in the graph
43
51
  attr_accessor :series
44
52
 
45
53
 
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,5 +22,5 @@ limitations under the License.
22
22
  =end
23
23
 
24
24
  module VisualizationJsApi
25
- VERSION = "0.0.2"
25
+ VERSION = "0.1.0"
26
26
  end
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -46,7 +46,7 @@ describe 'DefaultApi' do
46
46
  # unit tests for render_png_post
47
47
  #
48
48
  # Renders a graph in PNG format
49
- # @param graph_definition graph definition object
49
+ # @param graph_definition The graph definition object
50
50
  # @param [Hash] opts the optional parameters
51
51
  # @return [String]
52
52
  describe 'render_png_post test' do
@@ -57,8 +57,8 @@ describe 'DefaultApi' do
57
57
 
58
58
  # unit tests for render_svg_post
59
59
  #
60
- # Creates a user
61
- # @param graph_definition graph definition object
60
+ # Renders a graph in SVG format
61
+ # @param graph_definition The graph definition object
62
62
  # @param [Hash] opts the optional parameters
63
63
  # @return [String]
64
64
  describe 'render_svg_post test' do
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -3,8 +3,8 @@
3
3
 
4
4
  #Generates server side renderings of D3 visualizations for a nodejs backend
5
5
 
6
- OpenAPI spec version: 0.0.1
7
-
6
+ OpenAPI spec version: 0.1.0
7
+ Contact: info@researchable.nl
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
 
10
10
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -5,8 +5,8 @@
5
5
 
6
6
  #Generates server side renderings of D3 visualizations for a nodejs backend
7
7
 
8
- OpenAPI spec version: 0.0.1
9
-
8
+ OpenAPI spec version: 0.1.0
9
+ Contact: info@researchable.nl
10
10
  Generated by: https://github.com/swagger-api/swagger-codegen.git
11
11
 
12
12
  Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,14 +31,14 @@ Gem::Specification.new do |s|
31
31
  s.version = VisualizationJsApi::VERSION
32
32
  s.platform = Gem::Platform::RUBY
33
33
  s.authors = ["Researchable"]
34
- s.email = ["info@researchable.nl"]
34
+ s.email = ["support@researchable.nl"]
35
35
  s.homepage = "https://researchable.nl"
36
- s.summary = "Visualization API Ruby Gem"
36
+ s.summary = "This gem provides the interaction with the backend service for rendering graphs."
37
37
  s.description = "Generates server side renderings of D3 visualizations for a nodejs backend"
38
- s.license = "Apache 2.0"
38
+ s.license = "MIT"
39
39
 
40
40
  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
41
-
41
+
42
42
 
43
43
  s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
44
44
  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: visualization-js-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Researchable
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-01-29 00:00:00.000000000 Z
11
+ date: 2020-07-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -172,7 +172,7 @@ dependencies:
172
172
  version: 0.2.11
173
173
  description: Generates server side renderings of D3 visualizations for a nodejs backend
174
174
  email:
175
- - info@researchable.nl
175
+ - support@researchable.nl
176
176
  executables: []
177
177
  extensions: []
178
178
  extra_rdoc_files: []
@@ -203,7 +203,7 @@ files:
203
203
  - visualization-js-api.gemspec
204
204
  homepage: https://researchable.nl
205
205
  licenses:
206
- - Apache 2.0
206
+ - MIT
207
207
  metadata: {}
208
208
  post_install_message:
209
209
  rdoc_options: []
@@ -220,10 +220,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
220
220
  - !ruby/object:Gem::Version
221
221
  version: '0'
222
222
  requirements: []
223
- rubygems_version: 3.0.6
223
+ rubygems_version: 3.0.8
224
224
  signing_key:
225
225
  specification_version: 4
226
- summary: Visualization API Ruby Gem
226
+ summary: This gem provides the interaction with the backend service for rendering
227
+ graphs.
227
228
  test_files:
228
229
  - spec/api/default_api_spec.rb
229
230
  - spec/api_client_spec.rb