cloudmersive-convert-api-client 1.6.7 → 1.6.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +27 -6
  3. data/docs/ConvertDataApi.md +2 -2
  4. data/docs/ConvertWebApi.md +50 -50
  5. data/docs/CreateZipArchiveRequest.md +9 -0
  6. data/docs/EditTextApi.md +232 -12
  7. data/docs/FindRegexMatch.md +12 -0
  8. data/docs/FindStringMatch.md +10 -0
  9. data/docs/FindStringRegexRequest.md +10 -0
  10. data/docs/FindStringRegexResponse.md +10 -0
  11. data/docs/FindStringSimpleRequest.md +9 -0
  12. data/docs/FindStringSimpleResponse.md +10 -0
  13. data/docs/ReplaceStringRegexRequest.md +10 -0
  14. data/docs/ReplaceStringRegexResponse.md +9 -0
  15. data/docs/ReplaceStringSimpleRequest.md +10 -0
  16. data/docs/ReplaceStringSimpleResponse.md +9 -0
  17. data/docs/ZipArchiveApi.md +167 -0
  18. data/docs/ZipDirectory.md +10 -0
  19. data/docs/ZipExtractResponse.md +10 -0
  20. data/docs/ZipFile.md +9 -0
  21. data/lib/cloudmersive-convert-api-client.rb +15 -0
  22. data/lib/cloudmersive-convert-api-client/api/convert_data_api.rb +2 -2
  23. data/lib/cloudmersive-convert-api-client/api/convert_web_api.rb +61 -61
  24. data/lib/cloudmersive-convert-api-client/api/edit_text_api.rb +232 -12
  25. data/lib/cloudmersive-convert-api-client/api/zip_archive_api.rb +181 -0
  26. data/lib/cloudmersive-convert-api-client/models/create_zip_archive_request.rb +203 -0
  27. data/lib/cloudmersive-convert-api-client/models/find_regex_match.rb +231 -0
  28. data/lib/cloudmersive-convert-api-client/models/find_string_match.rb +209 -0
  29. data/lib/cloudmersive-convert-api-client/models/find_string_regex_request.rb +209 -0
  30. data/lib/cloudmersive-convert-api-client/models/find_string_regex_response.rb +211 -0
  31. data/lib/cloudmersive-convert-api-client/models/find_string_simple_request.rb +199 -0
  32. data/lib/cloudmersive-convert-api-client/models/find_string_simple_response.rb +211 -0
  33. data/lib/cloudmersive-convert-api-client/models/replace_string_regex_request.rb +209 -0
  34. data/lib/cloudmersive-convert-api-client/models/replace_string_regex_response.rb +199 -0
  35. data/lib/cloudmersive-convert-api-client/models/replace_string_simple_request.rb +209 -0
  36. data/lib/cloudmersive-convert-api-client/models/replace_string_simple_response.rb +199 -0
  37. data/lib/cloudmersive-convert-api-client/models/zip_directory.rb +213 -0
  38. data/lib/cloudmersive-convert-api-client/models/zip_extract_response.rb +213 -0
  39. data/lib/cloudmersive-convert-api-client/models/zip_file.rb +215 -0
  40. data/lib/cloudmersive-convert-api-client/version.rb +1 -1
  41. data/spec/api/convert_data_api_spec.rb +1 -1
  42. data/spec/api/convert_web_api_spec.rb +13 -13
  43. data/spec/api/edit_text_api_spec.rb +54 -6
  44. data/spec/api/zip_archive_api_spec.rb +70 -0
  45. data/spec/models/create_zip_archive_request_spec.rb +48 -0
  46. data/spec/models/find_regex_match_spec.rb +66 -0
  47. data/spec/models/find_string_match_spec.rb +54 -0
  48. data/spec/models/find_string_regex_request_spec.rb +54 -0
  49. data/spec/models/find_string_regex_response_spec.rb +54 -0
  50. data/spec/models/find_string_simple_request_spec.rb +48 -0
  51. data/spec/models/find_string_simple_response_spec.rb +54 -0
  52. data/spec/models/replace_string_regex_request_spec.rb +54 -0
  53. data/spec/models/replace_string_regex_response_spec.rb +48 -0
  54. data/spec/models/replace_string_simple_request_spec.rb +54 -0
  55. data/spec/models/replace_string_simple_response_spec.rb +48 -0
  56. data/spec/models/zip_directory_spec.rb +54 -0
  57. data/spec/models/zip_extract_response_spec.rb +54 -0
  58. data/spec/models/zip_file_spec.rb +48 -0
  59. metadata +47 -2
@@ -0,0 +1,213 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveConvertApiClient
16
+ # Result of performing a zip extract operation
17
+ class ZipExtractResponse
18
+ # True if the operation was successful, false otherwise
19
+ attr_accessor :successful
20
+
21
+ # Top-level files in the root directory fo the zip file
22
+ attr_accessor :files_in_zip
23
+
24
+ # Top-level directories in the root directory of the zip; directories can contain sub-directories and files
25
+ attr_accessor :directories_in_zip
26
+
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'successful' => :'Successful',
32
+ :'files_in_zip' => :'FilesInZip',
33
+ :'directories_in_zip' => :'DirectoriesInZip'
34
+ }
35
+ end
36
+
37
+ # Attribute type mapping.
38
+ def self.swagger_types
39
+ {
40
+ :'successful' => :'BOOLEAN',
41
+ :'files_in_zip' => :'Array<ZipFile>',
42
+ :'directories_in_zip' => :'Array<ZipDirectory>'
43
+ }
44
+ end
45
+
46
+ # Initializes the object
47
+ # @param [Hash] attributes Model attributes in the form of hash
48
+ def initialize(attributes = {})
49
+ return unless attributes.is_a?(Hash)
50
+
51
+ # convert string to symbol for hash key
52
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
53
+
54
+ if attributes.has_key?(:'Successful')
55
+ self.successful = attributes[:'Successful']
56
+ end
57
+
58
+ if attributes.has_key?(:'FilesInZip')
59
+ if (value = attributes[:'FilesInZip']).is_a?(Array)
60
+ self.files_in_zip = value
61
+ end
62
+ end
63
+
64
+ if attributes.has_key?(:'DirectoriesInZip')
65
+ if (value = attributes[:'DirectoriesInZip']).is_a?(Array)
66
+ self.directories_in_zip = value
67
+ end
68
+ end
69
+
70
+ end
71
+
72
+ # Show invalid properties with the reasons. Usually used together with valid?
73
+ # @return Array for valid properties with the reasons
74
+ def list_invalid_properties
75
+ invalid_properties = Array.new
76
+ return invalid_properties
77
+ end
78
+
79
+ # Check to see if the all the properties in the model are valid
80
+ # @return true if the model is valid
81
+ def valid?
82
+ return true
83
+ end
84
+
85
+ # Checks equality by comparing each attribute.
86
+ # @param [Object] Object to be compared
87
+ def ==(o)
88
+ return true if self.equal?(o)
89
+ self.class == o.class &&
90
+ successful == o.successful &&
91
+ files_in_zip == o.files_in_zip &&
92
+ directories_in_zip == o.directories_in_zip
93
+ end
94
+
95
+ # @see the `==` method
96
+ # @param [Object] Object to be compared
97
+ def eql?(o)
98
+ self == o
99
+ end
100
+
101
+ # Calculates hash code according to all attributes.
102
+ # @return [Fixnum] Hash code
103
+ def hash
104
+ [successful, files_in_zip, directories_in_zip].hash
105
+ end
106
+
107
+ # Builds the object from hash
108
+ # @param [Hash] attributes Model attributes in the form of hash
109
+ # @return [Object] Returns the model itself
110
+ def build_from_hash(attributes)
111
+ return nil unless attributes.is_a?(Hash)
112
+ self.class.swagger_types.each_pair do |key, type|
113
+ if type =~ /\AArray<(.*)>/i
114
+ # check to ensure the input is an array given that the the attribute
115
+ # is documented as an array but the input is not
116
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
117
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
118
+ end
119
+ elsif !attributes[self.class.attribute_map[key]].nil?
120
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
121
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
122
+ end
123
+
124
+ self
125
+ end
126
+
127
+ # Deserializes the data based on type
128
+ # @param string type Data type
129
+ # @param string value Value to be deserialized
130
+ # @return [Object] Deserialized data
131
+ def _deserialize(type, value)
132
+ case type.to_sym
133
+ when :DateTime
134
+ DateTime.parse(value)
135
+ when :Date
136
+ Date.parse(value)
137
+ when :String
138
+ value.to_s
139
+ when :Integer
140
+ value.to_i
141
+ when :Float
142
+ value.to_f
143
+ when :BOOLEAN
144
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
145
+ true
146
+ else
147
+ false
148
+ end
149
+ when :Object
150
+ # generic object (usually a Hash), return directly
151
+ value
152
+ when /\AArray<(?<inner_type>.+)>\z/
153
+ inner_type = Regexp.last_match[:inner_type]
154
+ value.map { |v| _deserialize(inner_type, v) }
155
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
156
+ k_type = Regexp.last_match[:k_type]
157
+ v_type = Regexp.last_match[:v_type]
158
+ {}.tap do |hash|
159
+ value.each do |k, v|
160
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
161
+ end
162
+ end
163
+ else # model
164
+ temp_model = CloudmersiveConvertApiClient.const_get(type).new
165
+ temp_model.build_from_hash(value)
166
+ end
167
+ end
168
+
169
+ # Returns the string representation of the object
170
+ # @return [String] String presentation of the object
171
+ def to_s
172
+ to_hash.to_s
173
+ end
174
+
175
+ # to_body is an alias to to_hash (backward compatibility)
176
+ # @return [Hash] Returns the object in the form of hash
177
+ def to_body
178
+ to_hash
179
+ end
180
+
181
+ # Returns the object in the form of hash
182
+ # @return [Hash] Returns the object in the form of hash
183
+ def to_hash
184
+ hash = {}
185
+ self.class.attribute_map.each_pair do |attr, param|
186
+ value = self.send(attr)
187
+ next if value.nil?
188
+ hash[param] = _to_hash(value)
189
+ end
190
+ hash
191
+ end
192
+
193
+ # Outputs non-array value in the form of hash
194
+ # For object, use to_hash. Otherwise, just return the value
195
+ # @param [Object] value Any valid value
196
+ # @return [Hash] Returns the value in the form of hash
197
+ def _to_hash(value)
198
+ if value.is_a?(Array)
199
+ value.compact.map{ |v| _to_hash(v) }
200
+ elsif value.is_a?(Hash)
201
+ {}.tap do |hash|
202
+ value.each { |k, v| hash[k] = _to_hash(v) }
203
+ end
204
+ elsif value.respond_to? :to_hash
205
+ value.to_hash
206
+ else
207
+ value
208
+ end
209
+ end
210
+
211
+ end
212
+
213
+ end
@@ -0,0 +1,215 @@
1
+ =begin
2
+ #convertapi
3
+
4
+ #Convert API lets you effortlessly convert file formats and types.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveConvertApiClient
16
+ # Representation of a file in a zip file
17
+ class ZipFile
18
+ # Name of this file
19
+ attr_accessor :file_name
20
+
21
+ # Contents of this file
22
+ attr_accessor :file_contents
23
+
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+ :'file_name' => :'FileName',
29
+ :'file_contents' => :'FileContents'
30
+ }
31
+ end
32
+
33
+ # Attribute type mapping.
34
+ def self.swagger_types
35
+ {
36
+ :'file_name' => :'String',
37
+ :'file_contents' => :'String'
38
+ }
39
+ end
40
+
41
+ # Initializes the object
42
+ # @param [Hash] attributes Model attributes in the form of hash
43
+ def initialize(attributes = {})
44
+ return unless attributes.is_a?(Hash)
45
+
46
+ # convert string to symbol for hash key
47
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
48
+
49
+ if attributes.has_key?(:'FileName')
50
+ self.file_name = attributes[:'FileName']
51
+ end
52
+
53
+ if attributes.has_key?(:'FileContents')
54
+ self.file_contents = attributes[:'FileContents']
55
+ end
56
+
57
+ end
58
+
59
+ # Show invalid properties with the reasons. Usually used together with valid?
60
+ # @return Array for valid properties with the reasons
61
+ def list_invalid_properties
62
+ invalid_properties = Array.new
63
+ if !@file_contents.nil? && @file_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
64
+ invalid_properties.push("invalid value for 'file_contents', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.")
65
+ end
66
+
67
+ return invalid_properties
68
+ end
69
+
70
+ # Check to see if the all the properties in the model are valid
71
+ # @return true if the model is valid
72
+ def valid?
73
+ return false if !@file_contents.nil? && @file_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
74
+ return true
75
+ end
76
+
77
+ # Custom attribute writer method with validation
78
+ # @param [Object] file_contents Value to be assigned
79
+ def file_contents=(file_contents)
80
+
81
+ if !file_contents.nil? && file_contents !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
82
+ fail ArgumentError, "invalid value for 'file_contents', must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/."
83
+ end
84
+
85
+ @file_contents = file_contents
86
+ end
87
+
88
+ # Checks equality by comparing each attribute.
89
+ # @param [Object] Object to be compared
90
+ def ==(o)
91
+ return true if self.equal?(o)
92
+ self.class == o.class &&
93
+ file_name == o.file_name &&
94
+ file_contents == o.file_contents
95
+ end
96
+
97
+ # @see the `==` method
98
+ # @param [Object] Object to be compared
99
+ def eql?(o)
100
+ self == o
101
+ end
102
+
103
+ # Calculates hash code according to all attributes.
104
+ # @return [Fixnum] Hash code
105
+ def hash
106
+ [file_name, file_contents].hash
107
+ end
108
+
109
+ # Builds the object from hash
110
+ # @param [Hash] attributes Model attributes in the form of hash
111
+ # @return [Object] Returns the model itself
112
+ def build_from_hash(attributes)
113
+ return nil unless attributes.is_a?(Hash)
114
+ self.class.swagger_types.each_pair do |key, type|
115
+ if type =~ /\AArray<(.*)>/i
116
+ # check to ensure the input is an array given that the the attribute
117
+ # is documented as an array but the input is not
118
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
119
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
120
+ end
121
+ elsif !attributes[self.class.attribute_map[key]].nil?
122
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
123
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
124
+ end
125
+
126
+ self
127
+ end
128
+
129
+ # Deserializes the data based on type
130
+ # @param string type Data type
131
+ # @param string value Value to be deserialized
132
+ # @return [Object] Deserialized data
133
+ def _deserialize(type, value)
134
+ case type.to_sym
135
+ when :DateTime
136
+ DateTime.parse(value)
137
+ when :Date
138
+ Date.parse(value)
139
+ when :String
140
+ value.to_s
141
+ when :Integer
142
+ value.to_i
143
+ when :Float
144
+ value.to_f
145
+ when :BOOLEAN
146
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
147
+ true
148
+ else
149
+ false
150
+ end
151
+ when :Object
152
+ # generic object (usually a Hash), return directly
153
+ value
154
+ when /\AArray<(?<inner_type>.+)>\z/
155
+ inner_type = Regexp.last_match[:inner_type]
156
+ value.map { |v| _deserialize(inner_type, v) }
157
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
158
+ k_type = Regexp.last_match[:k_type]
159
+ v_type = Regexp.last_match[:v_type]
160
+ {}.tap do |hash|
161
+ value.each do |k, v|
162
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
163
+ end
164
+ end
165
+ else # model
166
+ temp_model = CloudmersiveConvertApiClient.const_get(type).new
167
+ temp_model.build_from_hash(value)
168
+ end
169
+ end
170
+
171
+ # Returns the string representation of the object
172
+ # @return [String] String presentation of the object
173
+ def to_s
174
+ to_hash.to_s
175
+ end
176
+
177
+ # to_body is an alias to to_hash (backward compatibility)
178
+ # @return [Hash] Returns the object in the form of hash
179
+ def to_body
180
+ to_hash
181
+ end
182
+
183
+ # Returns the object in the form of hash
184
+ # @return [Hash] Returns the object in the form of hash
185
+ def to_hash
186
+ hash = {}
187
+ self.class.attribute_map.each_pair do |attr, param|
188
+ value = self.send(attr)
189
+ next if value.nil?
190
+ hash[param] = _to_hash(value)
191
+ end
192
+ hash
193
+ end
194
+
195
+ # Outputs non-array value in the form of hash
196
+ # For object, use to_hash. Otherwise, just return the value
197
+ # @param [Object] value Any valid value
198
+ # @return [Hash] Returns the value in the form of hash
199
+ def _to_hash(value)
200
+ if value.is_a?(Array)
201
+ value.compact.map{ |v| _to_hash(v) }
202
+ elsif value.is_a?(Hash)
203
+ {}.tap do |hash|
204
+ value.each { |k, v| hash[k] = _to_hash(v) }
205
+ end
206
+ elsif value.respond_to? :to_hash
207
+ value.to_hash
208
+ else
209
+ value
210
+ end
211
+ end
212
+
213
+ end
214
+
215
+ end
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.1
11
11
  =end
12
12
 
13
13
  module CloudmersiveConvertApiClient
14
- VERSION = "1.6.7"
14
+ VERSION = "1.6.8"
15
15
  end
@@ -47,7 +47,7 @@ describe 'ConvertDataApi' do
47
47
  # unit tests for convert_data_json_to_xml
48
48
  # Convert JSON to XML conversion
49
49
  # Convert a JSON object into XML
50
- # @param json_object
50
+ # @param json_object Input JSON to convert to XML
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @return [String]
53
53
  describe 'convert_data_json_to_xml test' do
@@ -69,24 +69,12 @@ describe 'ConvertWebApi' do
69
69
  end
70
70
 
71
71
  # unit tests for convert_web_html_to_txt
72
- # Convert website URL page to text (txt)
73
- # Converts a website URL page into text (txt); extracts text from HTML
74
- # @param input HTML to Text request parameters
75
- # @param [Hash] opts the optional parameters
76
- # @return [UrlToTextResponse]
77
- describe 'convert_web_html_to_txt test' do
78
- it "should work" do
79
- # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
- end
81
- end
82
-
83
- # unit tests for convert_web_html_to_txt_0
84
72
  # Convert HTML string to text (txt)
85
73
  # Converts an HTML string input into text (txt); extracts text from HTML
86
74
  # @param input HTML to Text request parameters
87
75
  # @param [Hash] opts the optional parameters
88
76
  # @return [HtmlToTextResponse]
89
- describe 'convert_web_html_to_txt_0 test' do
77
+ describe 'convert_web_html_to_txt test' do
90
78
  it "should work" do
91
79
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
92
80
  end
@@ -128,4 +116,16 @@ describe 'ConvertWebApi' do
128
116
  end
129
117
  end
130
118
 
119
+ # unit tests for convert_web_url_to_txt
120
+ # Convert website URL page to text (txt)
121
+ # Converts a website URL page into text (txt); extracts text from HTML
122
+ # @param input HTML to Text request parameters
123
+ # @param [Hash] opts the optional parameters
124
+ # @return [UrlToTextResponse]
125
+ describe 'convert_web_url_to_txt test' do
126
+ it "should work" do
127
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
128
+ end
129
+ end
130
+
131
131
  end