aspose_slides_cloud 20.4.0 → 20.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (177) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +61 -61
  3. data/TestData/ChartTest.pptx +0 -0
  4. data/TestData/Sections.pptx +0 -0
  5. data/TestData/TemplatingCVDataWithBase64.xml +22 -22
  6. data/lib/aspose_slides_cloud.rb +212 -205
  7. data/lib/aspose_slides_cloud/api/slides_api.rb +10979 -7974
  8. data/lib/aspose_slides_cloud/api/slides_api_requests.rb +4146 -3099
  9. data/lib/aspose_slides_cloud/api_client.rb +432 -429
  10. data/lib/aspose_slides_cloud/models/add_layout_slide.rb +244 -261
  11. data/lib/aspose_slides_cloud/models/add_master_slide.rb +259 -276
  12. data/lib/aspose_slides_cloud/models/add_shape.rb +239 -256
  13. data/lib/aspose_slides_cloud/models/add_slide.rb +269 -286
  14. data/lib/aspose_slides_cloud/models/api_info.rb +217 -205
  15. data/lib/aspose_slides_cloud/models/arrow_head_properties.rb +285 -273
  16. data/lib/aspose_slides_cloud/models/audio_frame.rb +359 -573
  17. data/lib/aspose_slides_cloud/models/axes.rb +237 -225
  18. data/lib/aspose_slides_cloud/models/axis.rb +699 -687
  19. data/lib/aspose_slides_cloud/models/base64_input_file.rb +230 -256
  20. data/lib/aspose_slides_cloud/models/blur_effect.rb +227 -215
  21. data/lib/aspose_slides_cloud/models/box_and_whisker_series.rb +299 -0
  22. data/lib/aspose_slides_cloud/models/bubble_chart_data_point.rb +212 -230
  23. data/lib/aspose_slides_cloud/models/bubble_series.rb +248 -428
  24. data/lib/aspose_slides_cloud/models/chart.rb +365 -553
  25. data/lib/aspose_slides_cloud/models/chart_category.rb +271 -0
  26. data/lib/aspose_slides_cloud/models/chart_title.rb +222 -210
  27. data/lib/aspose_slides_cloud/models/chart_wall.rb +281 -269
  28. data/lib/aspose_slides_cloud/models/color_scheme.rb +317 -327
  29. data/lib/aspose_slides_cloud/models/common_slide_view_properties.rb +217 -0
  30. data/lib/aspose_slides_cloud/models/connector.rb +275 -487
  31. data/lib/aspose_slides_cloud/models/custom_dash_pattern.rb +209 -197
  32. data/lib/aspose_slides_cloud/models/{resource_uri_element.rb → data_point.rb} +197 -195
  33. data/lib/aspose_slides_cloud/models/disc_usage.rb +227 -215
  34. data/lib/aspose_slides_cloud/models/document.rb +257 -267
  35. data/lib/aspose_slides_cloud/models/document_properties.rb +209 -219
  36. data/lib/aspose_slides_cloud/models/document_property.rb +232 -242
  37. data/lib/aspose_slides_cloud/models/document_replace_result.rb +218 -282
  38. data/lib/aspose_slides_cloud/models/effect.rb +424 -412
  39. data/lib/aspose_slides_cloud/models/effect_format.rb +277 -265
  40. data/lib/aspose_slides_cloud/models/entity_exists.rb +212 -0
  41. data/lib/aspose_slides_cloud/models/error.rb +237 -225
  42. data/lib/aspose_slides_cloud/models/error_details.rb +222 -210
  43. data/lib/aspose_slides_cloud/models/export_format.rb +60 -59
  44. data/lib/aspose_slides_cloud/models/export_options.rb +216 -194
  45. data/lib/aspose_slides_cloud/models/file_version.rb +225 -270
  46. data/lib/aspose_slides_cloud/models/file_versions.rb +209 -197
  47. data/lib/aspose_slides_cloud/models/files_list.rb +209 -197
  48. data/lib/aspose_slides_cloud/models/files_upload_result.rb +221 -209
  49. data/lib/aspose_slides_cloud/models/fill_format.rb +240 -228
  50. data/lib/aspose_slides_cloud/models/fill_overlay_effect.rb +246 -234
  51. data/lib/aspose_slides_cloud/models/font_scheme.rb +227 -237
  52. data/lib/aspose_slides_cloud/models/font_set.rb +227 -215
  53. data/lib/aspose_slides_cloud/models/format_scheme.rb +245 -255
  54. data/lib/aspose_slides_cloud/models/geometry_shape.rb +260 -439
  55. data/lib/aspose_slides_cloud/models/glow_effect.rb +222 -210
  56. data/lib/aspose_slides_cloud/models/gradient_fill.rb +342 -359
  57. data/lib/aspose_slides_cloud/models/gradient_fill_stop.rb +222 -210
  58. data/lib/aspose_slides_cloud/models/graphical_object.rb +234 -422
  59. data/lib/aspose_slides_cloud/models/group_shape.rb +234 -422
  60. data/lib/aspose_slides_cloud/models/header_footer.rb +247 -0
  61. data/lib/aspose_slides_cloud/models/html_export_options.rb +421 -420
  62. data/lib/aspose_slides_cloud/models/i_shape_export_options.rb +197 -195
  63. data/lib/aspose_slides_cloud/models/image.rb +237 -247
  64. data/lib/aspose_slides_cloud/models/image_export_format.rb +43 -43
  65. data/lib/aspose_slides_cloud/models/image_export_options.rb +299 -298
  66. data/lib/aspose_slides_cloud/models/images.rb +209 -219
  67. data/lib/aspose_slides_cloud/models/inner_shadow_effect.rb +252 -240
  68. data/lib/aspose_slides_cloud/models/input.rb +227 -215
  69. data/lib/aspose_slides_cloud/models/input_file.rb +250 -238
  70. data/lib/aspose_slides_cloud/models/interactive_sequence.rb +224 -212
  71. data/lib/aspose_slides_cloud/models/layout_slide.rb +278 -288
  72. data/lib/aspose_slides_cloud/models/layout_slides.rb +209 -219
  73. data/lib/aspose_slides_cloud/models/legend.rb +321 -309
  74. data/lib/aspose_slides_cloud/models/line_format.rb +389 -377
  75. data/lib/aspose_slides_cloud/models/master_slide.rb +231 -241
  76. data/lib/aspose_slides_cloud/models/master_slides.rb +209 -219
  77. data/lib/aspose_slides_cloud/models/merge.rb +231 -248
  78. data/lib/aspose_slides_cloud/models/merging_source.rb +219 -207
  79. data/lib/aspose_slides_cloud/models/no_fill.rb +219 -236
  80. data/lib/aspose_slides_cloud/models/normal_view_restored_properties.rb +217 -0
  81. data/lib/aspose_slides_cloud/models/notes_slide.rb +217 -227
  82. data/lib/aspose_slides_cloud/models/notes_slide_export_format.rb +43 -43
  83. data/lib/aspose_slides_cloud/models/notes_slide_header_footer.rb +267 -0
  84. data/lib/aspose_slides_cloud/models/object_exist.rb +227 -215
  85. data/lib/aspose_slides_cloud/models/ole_object_frame.rb +259 -447
  86. data/lib/aspose_slides_cloud/models/one_value_chart_data_point.rb +210 -200
  87. data/lib/aspose_slides_cloud/models/one_value_series.rb +248 -428
  88. data/lib/aspose_slides_cloud/models/ordered_merge_request.rb +209 -197
  89. data/lib/aspose_slides_cloud/models/outer_shadow_effect.rb +252 -240
  90. data/lib/aspose_slides_cloud/models/output_file.rb +240 -228
  91. data/lib/aspose_slides_cloud/models/paragraph.rb +517 -527
  92. data/lib/aspose_slides_cloud/models/paragraphs.rb +209 -219
  93. data/lib/aspose_slides_cloud/models/path_input_file.rb +240 -266
  94. data/lib/aspose_slides_cloud/models/path_output_file.rb +239 -256
  95. data/lib/aspose_slides_cloud/models/pattern_fill.rb +266 -283
  96. data/lib/aspose_slides_cloud/models/pdf_export_options.rb +547 -519
  97. data/lib/aspose_slides_cloud/models/picture_fill.rb +351 -368
  98. data/lib/aspose_slides_cloud/models/picture_frame.rb +245 -459
  99. data/lib/aspose_slides_cloud/models/pipeline.rb +219 -207
  100. data/lib/aspose_slides_cloud/models/placeholder.rb +325 -335
  101. data/lib/aspose_slides_cloud/models/placeholders.rb +209 -219
  102. data/lib/aspose_slides_cloud/models/plot_area.rb +311 -299
  103. data/lib/aspose_slides_cloud/models/portion.rb +589 -599
  104. data/lib/aspose_slides_cloud/models/portions.rb +209 -219
  105. data/lib/aspose_slides_cloud/models/pptx_export_options.rb +247 -246
  106. data/lib/aspose_slides_cloud/models/presentation_to_merge.rb +229 -217
  107. data/lib/aspose_slides_cloud/models/presentations_merge_request.rb +221 -209
  108. data/lib/aspose_slides_cloud/models/preset_shadow_effect.rb +286 -274
  109. data/lib/aspose_slides_cloud/models/reflection_effect.rb +441 -429
  110. data/lib/aspose_slides_cloud/models/remove_shape.rb +229 -246
  111. data/lib/aspose_slides_cloud/models/remove_slide.rb +234 -251
  112. data/lib/aspose_slides_cloud/models/reorder_slide.rb +249 -266
  113. data/lib/aspose_slides_cloud/models/replace_text.rb +269 -286
  114. data/lib/aspose_slides_cloud/models/request_input_file.rb +235 -261
  115. data/lib/aspose_slides_cloud/models/reset_slide.rb +234 -251
  116. data/lib/aspose_slides_cloud/models/resource_base.rb +219 -207
  117. data/lib/aspose_slides_cloud/models/resource_uri.rb +237 -225
  118. data/lib/aspose_slides_cloud/models/response_output_file.rb +219 -236
  119. data/lib/aspose_slides_cloud/models/save.rb +266 -283
  120. data/lib/aspose_slides_cloud/models/save_shape.rb +276 -293
  121. data/lib/aspose_slides_cloud/models/save_slide.rb +301 -318
  122. data/lib/aspose_slides_cloud/models/scale_type.rb +41 -41
  123. data/lib/aspose_slides_cloud/models/scatter_chart_data_point.rb +225 -215
  124. data/lib/aspose_slides_cloud/models/scatter_series.rb +248 -428
  125. data/lib/aspose_slides_cloud/models/section.rb +234 -0
  126. data/lib/aspose_slides_cloud/models/sections.rb +209 -0
  127. data/lib/aspose_slides_cloud/models/series.rb +422 -389
  128. data/lib/aspose_slides_cloud/models/series_marker.rb +281 -269
  129. data/lib/aspose_slides_cloud/models/shape.rb +255 -467
  130. data/lib/aspose_slides_cloud/models/shape_base.rb +375 -406
  131. data/lib/aspose_slides_cloud/models/shape_export_format.rb +44 -44
  132. data/lib/aspose_slides_cloud/models/shape_image_export_options.rb +286 -274
  133. data/lib/aspose_slides_cloud/models/shape_thumbnail_bounds.rb +41 -41
  134. data/lib/aspose_slides_cloud/models/shapes.rb +209 -219
  135. data/lib/aspose_slides_cloud/models/size_type.rb +55 -55
  136. data/lib/aspose_slides_cloud/models/slide.rb +322 -332
  137. data/lib/aspose_slides_cloud/models/slide_animation.rb +221 -231
  138. data/lib/aspose_slides_cloud/models/slide_background.rb +266 -276
  139. data/lib/aspose_slides_cloud/models/slide_comment.rb +239 -227
  140. data/lib/aspose_slides_cloud/models/slide_comments.rb +209 -219
  141. data/lib/aspose_slides_cloud/models/slide_export_format.rb +59 -58
  142. data/lib/aspose_slides_cloud/models/slide_replace_result.rb +223 -347
  143. data/lib/aspose_slides_cloud/models/slides.rb +209 -219
  144. data/lib/aspose_slides_cloud/models/smart_art.rb +342 -530
  145. data/lib/aspose_slides_cloud/models/smart_art_node.rb +293 -281
  146. data/lib/aspose_slides_cloud/models/smart_art_shape.rb +235 -422
  147. data/lib/aspose_slides_cloud/models/soft_edge_effect.rb +212 -200
  148. data/lib/aspose_slides_cloud/models/solid_fill.rb +229 -246
  149. data/lib/aspose_slides_cloud/models/split_document_result.rb +209 -219
  150. data/lib/aspose_slides_cloud/models/storage_exist.rb +212 -200
  151. data/lib/aspose_slides_cloud/models/storage_file.rb +257 -245
  152. data/lib/aspose_slides_cloud/models/svg_export_options.rb +379 -378
  153. data/lib/aspose_slides_cloud/models/swf_export_options.rb +529 -528
  154. data/lib/aspose_slides_cloud/models/table.rb +350 -538
  155. data/lib/aspose_slides_cloud/models/table_cell.rb +403 -391
  156. data/lib/aspose_slides_cloud/models/table_column.rb +212 -200
  157. data/lib/aspose_slides_cloud/models/table_row.rb +239 -227
  158. data/lib/aspose_slides_cloud/models/task.rb +240 -228
  159. data/lib/aspose_slides_cloud/models/text_item.rb +217 -205
  160. data/lib/aspose_slides_cloud/models/text_items.rb +209 -219
  161. data/lib/aspose_slides_cloud/models/theme.rb +237 -247
  162. data/lib/aspose_slides_cloud/models/tiff_export_options.rb +423 -422
  163. data/lib/aspose_slides_cloud/models/update_background.rb +241 -258
  164. data/lib/aspose_slides_cloud/models/update_shape.rb +239 -256
  165. data/lib/aspose_slides_cloud/models/video_frame.rb +329 -543
  166. data/lib/aspose_slides_cloud/models/view_properties.rb +357 -0
  167. data/lib/aspose_slides_cloud/models/waterfall_chart_data_point.rb +206 -0
  168. data/lib/aspose_slides_cloud/models/waterfall_series.rb +247 -0
  169. data/lib/aspose_slides_cloud/models/xps_export_options.rb +243 -242
  170. data/lib/aspose_slides_cloud/type_registry.rb +320 -0
  171. data/lib/aspose_slides_cloud/version.rb +25 -25
  172. data/spec/api/slides_api_spec.rb +35926 -24406
  173. data/spec/extra/extra_spec.rb +235 -101
  174. data/spec/spec_utils.rb +183 -176
  175. data/testConfig.json +7 -7
  176. data/testRules.json +472 -340
  177. metadata +18 -3
@@ -1,429 +1,432 @@
1
- =begin
2
- Copyright (c) 2019 Aspose Pty Ltd
3
-
4
- Permission is hereby granted, free of charge, to any person obtaining a copy
5
- of this software and associated documentation files (the "Software"), to deal
6
- in the Software without restriction, including without limitation the rights
7
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
- copies of the Software, and to permit persons to whom the Software is
9
- furnished to do so, subject to the following conditions:
10
-
11
- The above copyright notice and this permission notice shall be included in all
12
- copies or substantial portions of the Software.
13
-
14
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
- SOFTWARE.
21
- =end
22
-
23
- require 'date'
24
- require 'json'
25
- require 'logger'
26
- require 'tempfile'
27
- require 'faraday'
28
- require 'uri'
29
-
30
- module AsposeSlidesCloud
31
- class ApiClient
32
- # The Configuration object holding settings to be used in the API client.
33
- attr_accessor :config
34
-
35
- # Defines the headers to be used in HTTP requests of all API calls by default.
36
- #
37
- # @return [Hash]
38
- attr_accessor :default_headers
39
-
40
- # Initializes the ApiClient
41
- # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
42
- def initialize(config = Configuration.default)
43
- @config = config
44
- end
45
-
46
- def self.default
47
- @@default ||= ApiClient.new
48
- end
49
-
50
- # Call an API with given options.
51
- #
52
- # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
53
- # the data deserialized from response body (could be nil), response status code and response headers.
54
- def call_api(http_method, path, opts = {})
55
- response = call_api_method(http_method, path, opts)
56
- if @config.debugging
57
- @config.logger.debug "HTTP response\nHeaders: #{response.headers}\nStatus: #{response.status}\nBody: #{response.body}\n"
58
- end
59
-
60
- if response.status == 401 and @config.access_token
61
- @config.access_token = nil
62
- return repeat_call_api(http_method, path, opts)
63
- end
64
-
65
- return process_response(response, opts)
66
- end
67
-
68
- # Call an API with given options.
69
- #
70
- # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
71
- # the data deserialized from response body (could be nil), response status code and response headers.
72
- def repeat_call_api(http_method, path, opts = {})
73
- response = call_api_method(http_method, path, opts)
74
- if @config.debugging
75
- @config.logger.debug "HTTP response\nHeaders: #{response.headers}\nStatus: #{response.status}\nBody: #{response.body}\n"
76
- end
77
-
78
- return process_response(response, opts)
79
- end
80
-
81
- # Call an API with given options.
82
- #
83
- # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
84
- # the data deserialized from response body (could be nil), response status code and response headers.
85
- def process_response(response, opts)
86
- unless response.success?
87
- if response.status == 0
88
- # Errors from libcurl will be made visible here
89
- fail ApiError.new(:code => 0,
90
- :message => response.return_message)
91
- else
92
- fail ApiError.new(:code => response.status,
93
- :response_headers => response.headers,
94
- :response_body => response.body),
95
- response.reason_phrase
96
- end
97
- end
98
-
99
- if opts[:return_type]
100
- data = deserialize(response, opts[:return_type])
101
- else
102
- data = nil
103
- end
104
-
105
- return data, response.status, response.headers
106
- end
107
-
108
- # Call an API with given options.
109
- #
110
- # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
111
- # the data deserialized from response body (could be nil), response status code and response headers.
112
- def call_api_method(http_method, path, opts = {})
113
- connection = Faraday.new(:url => @config.base_path)
114
- case http_method
115
- when :GET
116
- response = connection.get do |req|
117
- build_request(req, http_method, path, opts)
118
- end
119
- when :POST
120
- response = connection.post do |req|
121
- build_request(req, http_method, path, opts)
122
- end
123
- when :PUT
124
- response = connection.put do |req|
125
- build_request(req, http_method, path, opts)
126
- end
127
- when :DELETE
128
- response = connection.delete do |req|
129
- build_request(req, http_method, path, opts)
130
- end
131
- end
132
- response
133
- end
134
-
135
- # Builds the HTTP request
136
- #
137
- # @param [String] http_method HTTP method/verb (e.g. POST)
138
- # @param [String] path URL path (e.g. /account/new)
139
- # @option opts [Hash] :header_params Header parameters
140
- # @option opts [Hash] :query_params Query parameters
141
- # @option opts [Hash] :form_params Query parameters
142
- # @option opts [Object] :body HTTP body (JSON/XML)
143
- # @return [Typhoeus::Request] A Typhoeus Request
144
- def build_request(req, http_method, path, opts = {})
145
- opts[:query_params].each_key do |key|
146
- if opts[:query_params][key].kind_of?(Array)
147
- opts[:query_params][key] = opts[:query_params][key].join[","]
148
- end
149
- end
150
- req.url path.sub(/^\/+/, '')
151
- req.headers = opts[:header_params]
152
- req.params = opts[:query_params]
153
- form_params = opts[:form_params] || {}
154
- req.body = build_request_body(req.headers, form_params, opts[:body], opts[:files])
155
- set_headers(req.headers)
156
- if @config.debugging
157
- @config.logger.debug "HTTP request\nMethod: #{req.method}\nPath: #{req.path}\nParams: #{req.params}\nHeaders: #{req.headers}\nBody: #{req.body}\n"
158
- end
159
- end
160
-
161
- def set_headers(headers)
162
- headers['x-aspose-client'] = 'ruby sdk'
163
- headers['x-aspose-version'] = AsposeSlidesCloud::VERSION
164
- if @config.timeout > 0
165
- headers['x-aspose-timeout'] = @config.timeout
166
- end
167
- @config.custom_headers.each do |key, value|
168
- headers[key] = value
169
- end
170
- set_auth_header(headers)
171
- end
172
-
173
- def set_auth_header(headers)
174
- unless @config.access_token
175
- auth_token_response = Faraday.post(
176
- @config.auth_base_url + '/connect/token',
177
- { :grant_type => 'client_credentials', 'client_id' => @config.app_sid, 'client_secret' => @config.app_key })
178
-
179
- unless auth_token_response.success?
180
- if auth_token_response.status == 0
181
- # Errors from libcurl will be made visible here
182
- fail ApiError.new(:code => 0,
183
- :message => auth_token_response.return_message)
184
- else
185
- fail ApiError.new(:code => 401,
186
- :response_headers => auth_token_response.headers,
187
- :response_body => auth_token_response.body),
188
- "unauthorized"
189
- end
190
- end
191
- @config.access_token = JSON.parse("[#{auth_token_response.body}]", :symbolize_names => true)[0][:access_token]
192
- end
193
- headers['Authorization'] = 'Bearer ' + @config.access_token
194
- end
195
-
196
- # Check if the given MIME is a JSON MIME.
197
- # JSON MIME examples:
198
- # application/json
199
- # application/json; charset=UTF8
200
- # APPLICATION/JSON
201
- # */*
202
- # @param [String] mime MIME
203
- # @return [Boolean] True if the MIME is application/json
204
- def json_mime?(mime)
205
- (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
206
- end
207
-
208
- # Deserialize the response to the given return type.
209
- #
210
- # @param [Response] response HTTP response
211
- # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
212
- def deserialize(response, return_type)
213
- body = response.body
214
-
215
- # handle file downloading - return the File instance processed in request callbacks
216
- # note that response body is empty when the file is written in chunks in request on_body callback
217
-
218
- return nil if body.nil? || body.empty?
219
-
220
- # return response body directly for String return type
221
- return body if return_type == 'String' or return_type == 'File'
222
-
223
- # ensuring a default content type
224
- content_type = response.headers['Content-Type'] || 'application/json'
225
-
226
- fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
227
-
228
- begin
229
- data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
230
- rescue JSON::ParserError => e
231
- if %w(String Date DateTime).include?(return_type)
232
- data = body
233
- else
234
- raise e
235
- end
236
- end
237
-
238
- convert_to_type data, return_type
239
- end
240
-
241
- # Convert data to the given return type.
242
- # @param [Object] data Data to be converted
243
- # @param [String] return_type Return type
244
- # @return [Mixed] Data in a particular type
245
- def convert_to_type(data, return_type)
246
- return nil if data.nil?
247
- case return_type
248
- when 'String'
249
- data.to_s
250
- when 'Integer'
251
- data.to_i
252
- when 'Float'
253
- data.to_f
254
- when 'BOOLEAN'
255
- data == true
256
- when 'DateTime'
257
- # parse date time (expecting ISO 8601 format)
258
- DateTime.parse data
259
- when 'Date'
260
- # parse date time (expecting ISO 8601 format)
261
- Date.parse data
262
- when 'Object'
263
- # generic object (usually a Hash), return directly
264
- data
265
- when /\AArray<(.+)>\z/
266
- # e.g. Array<Pet>
267
- sub_type = $1
268
- data.map { |item| convert_to_type(item, sub_type) }
269
- when /\AHash\<String, (.+)\>\z/
270
- # e.g. Hash<String, Integer>
271
- sub_type = $1
272
- {}.tap do |hash|
273
- data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
274
- end
275
- else
276
- # models, e.g. Pet
277
- AsposeSlidesCloud.const_get(return_type).new.tap do |model|
278
- model.build_from_hash data
279
- end
280
- end
281
- end
282
-
283
- # Builds the HTTP request body
284
- #
285
- # @param [Hash] header_params Header parameters
286
- # @param [Hash] form_params Query parameters
287
- # @param [Object] body HTTP body (JSON/XML)
288
- # @return [String] HTTP body data in the form of string
289
- def build_request_body(header_params, form_params, body, files)
290
- if files and files.length > 0
291
- boundary = "7d70fb31-0eb9-4846-9ea8-933dfb69d8f1"
292
- header_params['Content-Type'] = "multipart/form-data; boundary=#{boundary}"
293
- data = ""
294
- if body
295
- put_multipart!(data, boundary, 0, body)
296
- end
297
- files.each_with_index do |val, index|
298
- put_multipart!(data, boundary, index + 1, val)
299
- end
300
- data << "\r\n--#{boundary}--\r\n"
301
- data
302
- else
303
- header_params['Content-Type'] = 'text/json'
304
- if body
305
- data = body.is_a?(String) ? body : body.to_json
306
- else
307
- data = nil
308
- end
309
- end
310
- data
311
- end
312
-
313
- # Builds the HTTP request body
314
- #
315
- # @param [Hash] header_params Header parameters
316
- # @param [Hash] form_params Query parameters
317
- # @param [Object] body HTTP body (JSON/XML)
318
- # @return [String] HTTP body data in the form of string
319
- def put_multipart!(data, boundary, part_index, part_data)
320
- data << "\r\n--#{boundary}\r\n"
321
- if part_index > 0
322
- data << "Content-Disposition: form-data; name=\"file#{part_index}\";filename=\"null\"\r\n"
323
- data << "Content-Type: application/octet-stream\r\n"
324
- elsif
325
- data << "Content-Disposition: form-data; name=\"data\"\r\n"
326
- data << "Content-Type: text/json\r\n"
327
- end
328
- data << "Content-Length: #{part_data.length}\r\n"
329
- data << "\r\n"
330
- data << part_data
331
- end
332
-
333
- # Update hearder and query params based on authentication settings.
334
- #
335
- # @param [Hash] header_params Header parameters
336
- # @param [Hash] query_params Query parameters
337
- # @param [String] auth_names Authentication scheme name
338
- def update_params_for_auth!(header_params, query_params, auth_names)
339
- Array(auth_names).each do |auth_name|
340
- auth_setting = @config.auth_settings[auth_name]
341
- next unless auth_setting
342
- case auth_setting[:in]
343
- when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
344
- when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
345
- else fail ArgumentError, 'Authentication token must be in `query` of `header`'
346
- end
347
- end
348
- end
349
-
350
- # Return Accept header based on an array of accepts provided.
351
- # @param [Array] accepts array for Accept
352
- # @return [String] the Accept header (e.g. application/json)
353
- def select_header_accept(accepts)
354
- return nil if accepts.nil? || accepts.empty?
355
- # use JSON when present, otherwise use all of the provided
356
- json_accept = accepts.find { |s| json_mime?(s) }
357
- json_accept || accepts.join(',')
358
- end
359
-
360
- # Return Content-Type header based on an array of content types provided.
361
- # @param [Array] content_types array for Content-Type
362
- # @return [String] the Content-Type header (e.g. application/json)
363
- def select_header_content_type(content_types)
364
- # use application/json by default
365
- return 'application/json' if content_types.nil? || content_types.empty?
366
- # use JSON when present, otherwise use the first one
367
- json_content_type = content_types.find { |s| json_mime?(s) }
368
- json_content_type || content_types.first
369
- end
370
-
371
- # Convert object (array, hash, object, etc) to JSON string.
372
- # @param [Object] model object to be converted into JSON string
373
- # @return [String] JSON string representation of the object
374
- def object_to_http_body(model)
375
- return model if model.nil? || model.is_a?(String)
376
- local_body = nil
377
- if model.is_a?(Array)
378
- local_body = model.map { |m| object_to_hash(m) }
379
- else
380
- local_body = object_to_hash(model)
381
- end
382
- local_body.to_json
383
- end
384
-
385
- # Convert object(non-array) to hash.
386
- # @param [Object] obj object to be converted into JSON string
387
- # @return [String] JSON string representation of the object
388
- def object_to_hash(obj)
389
- if obj.respond_to?(:to_hash)
390
- obj.to_hash
391
- else
392
- obj
393
- end
394
- end
395
-
396
- # Convert object(non-array) to hash.
397
- # @param [Object] obj object to be converted into JSON string
398
- # @return [String] JSON string representation of the object
399
- def replace_path_parameter(path, name, value)
400
- if value == nil
401
- value = ""
402
- end
403
- if value.to_s != ""
404
- value = "/" + value.to_s
405
- end
406
- path.sub('/{' + name + '}', URI::encode(value))
407
- end
408
-
409
- # Build parameter value according to the given collection format.
410
- # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
411
- def build_collection_param(param, collection_format)
412
- case collection_format
413
- when :csv
414
- param.join(',')
415
- when :ssv
416
- param.join(' ')
417
- when :tsv
418
- param.join("\t")
419
- when :pipes
420
- param.join('|')
421
- when :multi
422
- # return the array directly as typhoeus will handle it as expected
423
- param
424
- else
425
- fail "unknown collection format: #{collection_format.inspect}"
426
- end
427
- end
428
- end
429
- end
1
+ =begin
2
+ Copyright (c) 2019 Aspose Pty Ltd
3
+
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy
5
+ of this software and associated documentation files (the "Software"), to deal
6
+ in the Software without restriction, including without limitation the rights
7
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the Software is
9
+ furnished to do so, subject to the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be included in all
12
+ copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20
+ SOFTWARE.
21
+ =end
22
+
23
+ require 'date'
24
+ require 'json'
25
+ require 'logger'
26
+ require 'tempfile'
27
+ require 'faraday'
28
+ require 'uri'
29
+
30
+ module AsposeSlidesCloud
31
+ class ApiClient
32
+ # The Configuration object holding settings to be used in the API client.
33
+ attr_accessor :config
34
+
35
+ # Defines the headers to be used in HTTP requests of all API calls by default.
36
+ #
37
+ # @return [Hash]
38
+ attr_accessor :default_headers
39
+
40
+ # Initializes the ApiClient
41
+ # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
42
+ def initialize(config = Configuration.default)
43
+ @config = config
44
+ end
45
+
46
+ def self.default
47
+ @@default ||= ApiClient.new
48
+ end
49
+
50
+ # Call an API with given options.
51
+ #
52
+ # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
53
+ # the data deserialized from response body (could be nil), response status code and response headers.
54
+ def call_api(http_method, path, opts = {})
55
+ response = call_api_method(http_method, path, opts)
56
+ if @config.debugging
57
+ @config.logger.debug "HTTP response\nHeaders: #{response.headers}\nStatus: #{response.status}\nBody: #{response.body}\n"
58
+ end
59
+
60
+ if (response.status == 401 || (response.status == 500 && response.body.length == 0)) and @config.access_token
61
+ @config.access_token = nil
62
+ return repeat_call_api(http_method, path, opts)
63
+ end
64
+
65
+ return process_response(response, opts)
66
+ end
67
+
68
+ # Call an API with given options.
69
+ #
70
+ # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
71
+ # the data deserialized from response body (could be nil), response status code and response headers.
72
+ def repeat_call_api(http_method, path, opts = {})
73
+ response = call_api_method(http_method, path, opts)
74
+ if @config.debugging
75
+ @config.logger.debug "HTTP response\nHeaders: #{response.headers}\nStatus: #{response.status}\nBody: #{response.body}\n"
76
+ end
77
+
78
+ return process_response(response, opts)
79
+ end
80
+
81
+ # Call an API with given options.
82
+ #
83
+ # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
84
+ # the data deserialized from response body (could be nil), response status code and response headers.
85
+ def process_response(response, opts)
86
+ unless response.success?
87
+ if response.status == 0
88
+ # Errors from libcurl will be made visible here
89
+ fail ApiError.new(:code => 0,
90
+ :message => response.return_message)
91
+ else
92
+ fail ApiError.new(:code => response.status,
93
+ :response_headers => response.headers,
94
+ :response_body => response.body),
95
+ response.reason_phrase
96
+ end
97
+ end
98
+
99
+ if opts[:return_type]
100
+ data = deserialize(response, opts[:return_type])
101
+ else
102
+ data = nil
103
+ end
104
+
105
+ return data, response.status, response.headers
106
+ end
107
+
108
+ # Call an API with given options.
109
+ #
110
+ # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
111
+ # the data deserialized from response body (could be nil), response status code and response headers.
112
+ def call_api_method(http_method, path, opts = {})
113
+ connection = Faraday.new(:url => @config.base_path)
114
+ case http_method
115
+ when :GET
116
+ response = connection.get do |req|
117
+ build_request(req, http_method, path, opts)
118
+ end
119
+ when :POST
120
+ response = connection.post do |req|
121
+ build_request(req, http_method, path, opts)
122
+ end
123
+ when :PUT
124
+ response = connection.put do |req|
125
+ build_request(req, http_method, path, opts)
126
+ end
127
+ when :DELETE
128
+ response = connection.delete do |req|
129
+ build_request(req, http_method, path, opts)
130
+ end
131
+ end
132
+ response
133
+ end
134
+
135
+ # Builds the HTTP request
136
+ #
137
+ # @param [String] http_method HTTP method/verb (e.g. POST)
138
+ # @param [String] path URL path (e.g. /account/new)
139
+ # @option opts [Hash] :header_params Header parameters
140
+ # @option opts [Hash] :query_params Query parameters
141
+ # @option opts [Hash] :form_params Query parameters
142
+ # @option opts [Object] :body HTTP body (JSON/XML)
143
+ # @return [Typhoeus::Request] A Typhoeus Request
144
+ def build_request(req, http_method, path, opts = {})
145
+ opts[:query_params].each_key do |key|
146
+ if opts[:query_params][key].kind_of?(Array)
147
+ opts[:query_params][key] = opts[:query_params][key].join[","]
148
+ end
149
+ end
150
+ req.options.timeout = 200
151
+ req.url path.sub(/^\/+/, '')
152
+ req.headers = opts[:header_params]
153
+ req.params = opts[:query_params]
154
+ form_params = opts[:form_params] || {}
155
+ req.body = build_request_body(req.headers, form_params, opts[:body], opts[:files])
156
+ set_headers(req.headers)
157
+ if @config.debugging
158
+ @config.logger.debug "HTTP request\nMethod: #{req.method}\nPath: #{req.path}\nParams: #{req.params}\nHeaders: #{req.headers}\nBody: #{req.body}\n"
159
+ end
160
+ end
161
+
162
+ def set_headers(headers)
163
+ headers['x-aspose-client'] = "ruby sdk v#{AsposeSlidesCloud::VERSION}"
164
+ if @config.timeout > 0
165
+ headers['x-aspose-timeout'] = @config.timeout.to_s
166
+ end
167
+ @config.custom_headers.each do |key, value|
168
+ headers[key] = value
169
+ end
170
+ set_auth_header(headers)
171
+ end
172
+
173
+ def set_auth_header(headers)
174
+ unless @config.access_token
175
+ auth_token_response = Faraday.post(
176
+ @config.auth_base_url + '/connect/token',
177
+ { :grant_type => 'client_credentials', 'client_id' => @config.app_sid, 'client_secret' => @config.app_key })
178
+
179
+ unless auth_token_response.success?
180
+ if auth_token_response.status == 0
181
+ # Errors from libcurl will be made visible here
182
+ fail ApiError.new(:code => 0,
183
+ :message => auth_token_response.return_message)
184
+ else
185
+ fail ApiError.new(:code => 401,
186
+ :response_headers => auth_token_response.headers,
187
+ :response_body => auth_token_response.body),
188
+ "unauthorized"
189
+ end
190
+ end
191
+ @config.access_token = JSON.parse("[#{auth_token_response.body}]", :symbolize_names => true)[0][:access_token]
192
+ end
193
+ headers['Authorization'] = 'Bearer ' + @config.access_token
194
+ end
195
+
196
+ # Check if the given MIME is a JSON MIME.
197
+ # JSON MIME examples:
198
+ # application/json
199
+ # application/json; charset=UTF8
200
+ # APPLICATION/JSON
201
+ # */*
202
+ # @param [String] mime MIME
203
+ # @return [Boolean] True if the MIME is application/json
204
+ def json_mime?(mime)
205
+ (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
206
+ end
207
+
208
+ # Deserialize the response to the given return type.
209
+ #
210
+ # @param [Response] response HTTP response
211
+ # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
212
+ def deserialize(response, return_type)
213
+ body = response.body
214
+
215
+ # handle file downloading - return the File instance processed in request callbacks
216
+ # note that response body is empty when the file is written in chunks in request on_body callback
217
+
218
+ return nil if body.nil? || body.empty?
219
+
220
+ # return response body directly for String return type
221
+ return body if return_type == 'String' or return_type == 'File'
222
+
223
+ # ensuring a default content type
224
+ content_type = response.headers['Content-Type'] || 'application/json'
225
+
226
+ fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
227
+
228
+ begin
229
+ data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
230
+ rescue JSON::ParserError => e
231
+ if %w(String Date DateTime).include?(return_type)
232
+ data = body
233
+ else
234
+ raise e
235
+ end
236
+ end
237
+
238
+ convert_to_type data, return_type
239
+ end
240
+
241
+ # Convert data to the given return type.
242
+ # @param [Object] data Data to be converted
243
+ # @param [String] return_type Return type
244
+ # @return [Mixed] Data in a particular type
245
+ def convert_to_type(data, return_type)
246
+ return nil if data.nil?
247
+ case return_type
248
+ when 'String'
249
+ data.to_s
250
+ when 'Integer'
251
+ data.to_i
252
+ when 'Float'
253
+ data.to_f
254
+ when 'BOOLEAN'
255
+ data == true
256
+ when 'DateTime'
257
+ # parse date time (expecting ISO 8601 format)
258
+ DateTime.parse data
259
+ when 'Date'
260
+ # parse date time (expecting ISO 8601 format)
261
+ Date.parse data
262
+ when 'Object'
263
+ # generic object (usually a Hash), return directly
264
+ data
265
+ when /\AArray<(.+)>\z/
266
+ # e.g. Array<Pet>
267
+ sub_type = $1
268
+ data.map { |item| convert_to_type(item, sub_type) }
269
+ when /\AHash\<String, (.+)\>\z/
270
+ # e.g. Hash<String, Integer>
271
+ sub_type = $1
272
+ {}.tap do |hash|
273
+ data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
274
+ end
275
+ else
276
+ type = AsposeSlidesCloud::TypeRegistry.get_type(return_type, data)
277
+ if !type
278
+ type = return_type
279
+ end
280
+ AsposeSlidesCloud.const_get(type).new.tap do |model|
281
+ model.build_from_hash data
282
+ end
283
+ end
284
+ end
285
+
286
+ # Builds the HTTP request body
287
+ #
288
+ # @param [Hash] header_params Header parameters
289
+ # @param [Hash] form_params Query parameters
290
+ # @param [Object] body HTTP body (JSON/XML)
291
+ # @return [String] HTTP body data in the form of string
292
+ def build_request_body(header_params, form_params, body, files)
293
+ if files and files.length > 0
294
+ boundary = "7d70fb31-0eb9-4846-9ea8-933dfb69d8f1"
295
+ header_params['Content-Type'] = "multipart/form-data; boundary=#{boundary}"
296
+ data = ""
297
+ if body
298
+ put_multipart!(data, boundary, 0, body)
299
+ end
300
+ files.each_with_index do |val, index|
301
+ put_multipart!(data, boundary, index + 1, val)
302
+ end
303
+ data << "\r\n--#{boundary}--\r\n"
304
+ data
305
+ else
306
+ header_params['Content-Type'] = 'text/json'
307
+ if body
308
+ data = body.is_a?(String) ? body : body.to_json
309
+ else
310
+ data = nil
311
+ end
312
+ end
313
+ data
314
+ end
315
+
316
+ # Builds the HTTP request body
317
+ #
318
+ # @param [Hash] header_params Header parameters
319
+ # @param [Hash] form_params Query parameters
320
+ # @param [Object] body HTTP body (JSON/XML)
321
+ # @return [String] HTTP body data in the form of string
322
+ def put_multipart!(data, boundary, part_index, part_data)
323
+ data << "\r\n--#{boundary}\r\n"
324
+ if part_index > 0
325
+ data << "Content-Disposition: form-data; name=\"file#{part_index}\";filename=\"null\"\r\n"
326
+ data << "Content-Type: application/octet-stream\r\n"
327
+ elsif
328
+ data << "Content-Disposition: form-data; name=\"data\"\r\n"
329
+ data << "Content-Type: text/json\r\n"
330
+ end
331
+ data << "Content-Length: #{part_data.length}\r\n"
332
+ data << "\r\n"
333
+ data << part_data
334
+ end
335
+
336
+ # Update hearder and query params based on authentication settings.
337
+ #
338
+ # @param [Hash] header_params Header parameters
339
+ # @param [Hash] query_params Query parameters
340
+ # @param [String] auth_names Authentication scheme name
341
+ def update_params_for_auth!(header_params, query_params, auth_names)
342
+ Array(auth_names).each do |auth_name|
343
+ auth_setting = @config.auth_settings[auth_name]
344
+ next unless auth_setting
345
+ case auth_setting[:in]
346
+ when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
347
+ when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
348
+ else fail ArgumentError, 'Authentication token must be in `query` of `header`'
349
+ end
350
+ end
351
+ end
352
+
353
+ # Return Accept header based on an array of accepts provided.
354
+ # @param [Array] accepts array for Accept
355
+ # @return [String] the Accept header (e.g. application/json)
356
+ def select_header_accept(accepts)
357
+ return nil if accepts.nil? || accepts.empty?
358
+ # use JSON when present, otherwise use all of the provided
359
+ json_accept = accepts.find { |s| json_mime?(s) }
360
+ json_accept || accepts.join(',')
361
+ end
362
+
363
+ # Return Content-Type header based on an array of content types provided.
364
+ # @param [Array] content_types array for Content-Type
365
+ # @return [String] the Content-Type header (e.g. application/json)
366
+ def select_header_content_type(content_types)
367
+ # use application/json by default
368
+ return 'application/json' if content_types.nil? || content_types.empty?
369
+ # use JSON when present, otherwise use the first one
370
+ json_content_type = content_types.find { |s| json_mime?(s) }
371
+ json_content_type || content_types.first
372
+ end
373
+
374
+ # Convert object (array, hash, object, etc) to JSON string.
375
+ # @param [Object] model object to be converted into JSON string
376
+ # @return [String] JSON string representation of the object
377
+ def object_to_http_body(model)
378
+ return model if model.nil? || model.is_a?(String)
379
+ local_body = nil
380
+ if model.is_a?(Array)
381
+ local_body = model.map { |m| object_to_hash(m) }
382
+ else
383
+ local_body = object_to_hash(model)
384
+ end
385
+ local_body.to_json
386
+ end
387
+
388
+ # Convert object(non-array) to hash.
389
+ # @param [Object] obj object to be converted into JSON string
390
+ # @return [String] JSON string representation of the object
391
+ def object_to_hash(obj)
392
+ if obj.respond_to?(:to_hash)
393
+ obj.to_hash
394
+ else
395
+ obj
396
+ end
397
+ end
398
+
399
+ # Convert object(non-array) to hash.
400
+ # @param [Object] obj object to be converted into JSON string
401
+ # @return [String] JSON string representation of the object
402
+ def replace_path_parameter(path, name, value)
403
+ if value == nil
404
+ value = ""
405
+ end
406
+ if value.to_s != ""
407
+ value = "/" + value.to_s
408
+ end
409
+ path.sub('/{' + name + '}', URI::encode(value))
410
+ end
411
+
412
+ # Build parameter value according to the given collection format.
413
+ # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
414
+ def build_collection_param(param, collection_format)
415
+ case collection_format
416
+ when :csv
417
+ param.join(',')
418
+ when :ssv
419
+ param.join(' ')
420
+ when :tsv
421
+ param.join("\t")
422
+ when :pipes
423
+ param.join('|')
424
+ when :multi
425
+ # return the array directly as typhoeus will handle it as expected
426
+ param
427
+ else
428
+ fail "unknown collection format: #{collection_format.inspect}"
429
+ end
430
+ end
431
+ end
432
+ end