cloudmersive-validate-api-client 2.1.4 → 2.2.0

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 (72) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -4
  3. data/docs/BotCheckResponse.md +8 -0
  4. data/docs/DomainApi.md +275 -0
  5. data/docs/IPAddressApi.md +110 -0
  6. data/docs/IPIntelligenceResponse.md +16 -0
  7. data/docs/PhishingCheckRequest.md +8 -0
  8. data/docs/PhishingCheckResponse.md +9 -0
  9. data/docs/SqlInjectionCheckBatchRequest.md +9 -0
  10. data/docs/SqlInjectionCheckBatchResponse.md +8 -0
  11. data/docs/SqlInjectionCheckRequestItem.md +8 -0
  12. data/docs/SqlInjectionDetectionResult.md +10 -0
  13. data/docs/TextInputApi.md +233 -1
  14. data/docs/UrlSafetyCheckRequestFull.md +8 -0
  15. data/docs/UrlSafetyCheckResponseFull.md +9 -0
  16. data/docs/UrlSsrfRequestBatch.md +8 -0
  17. data/docs/UrlSsrfRequestFull.md +9 -0
  18. data/docs/UrlSsrfResponseBatch.md +8 -0
  19. data/docs/UrlSsrfResponseFull.md +9 -0
  20. data/docs/ValidateUrlResponseSyntaxOnly.md +1 -0
  21. data/docs/XxeDetectionBatchRequest.md +8 -0
  22. data/docs/XxeDetectionBatchResponse.md +8 -0
  23. data/docs/XxeDetectionRequestItem.md +11 -0
  24. data/docs/XxeDetectionResult.md +9 -0
  25. data/lib/cloudmersive-validate-api-client.rb +18 -0
  26. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +270 -0
  27. data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +108 -0
  28. data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +230 -2
  29. data/lib/cloudmersive-validate-api-client/models/bot_check_response.rb +186 -0
  30. data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +1 -1
  31. data/lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb +266 -0
  32. data/lib/cloudmersive-validate-api-client/models/phishing_check_request.rb +186 -0
  33. data/lib/cloudmersive-validate-api-client/models/phishing_check_response.rb +196 -0
  34. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_request.rb +198 -0
  35. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_response.rb +188 -0
  36. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_request_item.rb +186 -0
  37. data/lib/cloudmersive-validate-api-client/models/sql_injection_detection_result.rb +206 -0
  38. data/lib/cloudmersive-validate-api-client/models/url_safety_check_request_full.rb +186 -0
  39. data/lib/cloudmersive-validate-api-client/models/url_safety_check_response_full.rb +196 -0
  40. data/lib/cloudmersive-validate-api-client/models/url_ssrf_request_batch.rb +188 -0
  41. data/lib/cloudmersive-validate-api-client/models/url_ssrf_request_full.rb +198 -0
  42. data/lib/cloudmersive-validate-api-client/models/url_ssrf_response_batch.rb +188 -0
  43. data/lib/cloudmersive-validate-api-client/models/url_ssrf_response_full.rb +196 -0
  44. data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +14 -4
  45. data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_request.rb +188 -0
  46. data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_response.rb +188 -0
  47. data/lib/cloudmersive-validate-api-client/models/xxe_detection_request_item.rb +220 -0
  48. data/lib/cloudmersive-validate-api-client/models/xxe_detection_result.rb +196 -0
  49. data/lib/cloudmersive-validate-api-client/version.rb +1 -1
  50. data/spec/api/domain_api_spec.rb +60 -0
  51. data/spec/api/ip_address_api_spec.rb +24 -0
  52. data/spec/api/text_input_api_spec.rb +53 -1
  53. data/spec/models/bot_check_response_spec.rb +41 -0
  54. data/spec/models/ip_intelligence_response_spec.rb +89 -0
  55. data/spec/models/phishing_check_request_spec.rb +41 -0
  56. data/spec/models/phishing_check_response_spec.rb +47 -0
  57. data/spec/models/sql_injection_check_batch_request_spec.rb +47 -0
  58. data/spec/models/sql_injection_check_batch_response_spec.rb +41 -0
  59. data/spec/models/sql_injection_check_request_item_spec.rb +41 -0
  60. data/spec/models/sql_injection_detection_result_spec.rb +53 -0
  61. data/spec/models/url_safety_check_request_full_spec.rb +41 -0
  62. data/spec/models/url_safety_check_response_full_spec.rb +47 -0
  63. data/spec/models/url_ssrf_request_batch_spec.rb +41 -0
  64. data/spec/models/url_ssrf_request_full_spec.rb +47 -0
  65. data/spec/models/url_ssrf_response_batch_spec.rb +41 -0
  66. data/spec/models/url_ssrf_response_full_spec.rb +47 -0
  67. data/spec/models/validate_url_response_syntax_only_spec.rb +6 -0
  68. data/spec/models/xxe_detection_batch_request_spec.rb +41 -0
  69. data/spec/models/xxe_detection_batch_response_spec.rb +41 -0
  70. data/spec/models/xxe_detection_request_item_spec.rb +59 -0
  71. data/spec/models/xxe_detection_result_spec.rb +47 -0
  72. metadata +56 -2
@@ -0,0 +1,266 @@
1
+ =begin
2
+ #validateapi
3
+
4
+ #The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveValidateApiClient
16
+ # IP address intelligence result
17
+ class IPIntelligenceResponse
18
+ # True if the IP address is a known bot, otherwise false
19
+ attr_accessor :is_bot
20
+
21
+ # True if the IP address is a known Tor exit node, otherwise false
22
+ attr_accessor :is_tor_node
23
+
24
+ # True if the IP address is a known threat IP, otherwise false
25
+ attr_accessor :is_threat
26
+
27
+ # True if the IP address is in the European Union, otherwise false
28
+ attr_accessor :is_eu
29
+
30
+ # Returns the location of the IP address
31
+ attr_accessor :location
32
+
33
+ # ISO 4217 currency code for the IP address location
34
+ attr_accessor :currency_code
35
+
36
+ # Name of the currency in English
37
+ attr_accessor :currency_name
38
+
39
+ # Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania
40
+ attr_accessor :region_area
41
+
42
+ # Subregion in which the country is located; possible values are None, NorthernEurope, WesternEurope, SouthernEurope, EasternEurope, CentralAmerica, NorthernAmerica, SouthAmerica, EasternAfrica, MiddleAfrica, NorthernAfrica , SouthernAfrica , WesternAfrica , CentralAsia , EasternAsia , SouthernAsia , SouthEasternAsia , WesternAsia , Southern , Middle , AustraliaandNewZealand , Melanesia , Polynesia , Micronesia , Caribbean,
43
+ attr_accessor :subregion_area
44
+
45
+ # Attribute mapping from ruby-style variable name to JSON key.
46
+ def self.attribute_map
47
+ {
48
+ :'is_bot' => :'IsBot',
49
+ :'is_tor_node' => :'IsTorNode',
50
+ :'is_threat' => :'IsThreat',
51
+ :'is_eu' => :'IsEU',
52
+ :'location' => :'Location',
53
+ :'currency_code' => :'CurrencyCode',
54
+ :'currency_name' => :'CurrencyName',
55
+ :'region_area' => :'RegionArea',
56
+ :'subregion_area' => :'SubregionArea'
57
+ }
58
+ end
59
+
60
+ # Attribute type mapping.
61
+ def self.swagger_types
62
+ {
63
+ :'is_bot' => :'BOOLEAN',
64
+ :'is_tor_node' => :'BOOLEAN',
65
+ :'is_threat' => :'BOOLEAN',
66
+ :'is_eu' => :'BOOLEAN',
67
+ :'location' => :'GeolocateResponse',
68
+ :'currency_code' => :'String',
69
+ :'currency_name' => :'String',
70
+ :'region_area' => :'String',
71
+ :'subregion_area' => :'String'
72
+ }
73
+ end
74
+
75
+ # Initializes the object
76
+ # @param [Hash] attributes Model attributes in the form of hash
77
+ def initialize(attributes = {})
78
+ return unless attributes.is_a?(Hash)
79
+
80
+ # convert string to symbol for hash key
81
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
82
+
83
+ if attributes.has_key?(:'IsBot')
84
+ self.is_bot = attributes[:'IsBot']
85
+ end
86
+
87
+ if attributes.has_key?(:'IsTorNode')
88
+ self.is_tor_node = attributes[:'IsTorNode']
89
+ end
90
+
91
+ if attributes.has_key?(:'IsThreat')
92
+ self.is_threat = attributes[:'IsThreat']
93
+ end
94
+
95
+ if attributes.has_key?(:'IsEU')
96
+ self.is_eu = attributes[:'IsEU']
97
+ end
98
+
99
+ if attributes.has_key?(:'Location')
100
+ self.location = attributes[:'Location']
101
+ end
102
+
103
+ if attributes.has_key?(:'CurrencyCode')
104
+ self.currency_code = attributes[:'CurrencyCode']
105
+ end
106
+
107
+ if attributes.has_key?(:'CurrencyName')
108
+ self.currency_name = attributes[:'CurrencyName']
109
+ end
110
+
111
+ if attributes.has_key?(:'RegionArea')
112
+ self.region_area = attributes[:'RegionArea']
113
+ end
114
+
115
+ if attributes.has_key?(:'SubregionArea')
116
+ self.subregion_area = attributes[:'SubregionArea']
117
+ end
118
+ end
119
+
120
+ # Show invalid properties with the reasons. Usually used together with valid?
121
+ # @return Array for valid properties with the reasons
122
+ def list_invalid_properties
123
+ invalid_properties = Array.new
124
+ invalid_properties
125
+ end
126
+
127
+ # Check to see if the all the properties in the model are valid
128
+ # @return true if the model is valid
129
+ def valid?
130
+ true
131
+ end
132
+
133
+ # Checks equality by comparing each attribute.
134
+ # @param [Object] Object to be compared
135
+ def ==(o)
136
+ return true if self.equal?(o)
137
+ self.class == o.class &&
138
+ is_bot == o.is_bot &&
139
+ is_tor_node == o.is_tor_node &&
140
+ is_threat == o.is_threat &&
141
+ is_eu == o.is_eu &&
142
+ location == o.location &&
143
+ currency_code == o.currency_code &&
144
+ currency_name == o.currency_name &&
145
+ region_area == o.region_area &&
146
+ subregion_area == o.subregion_area
147
+ end
148
+
149
+ # @see the `==` method
150
+ # @param [Object] Object to be compared
151
+ def eql?(o)
152
+ self == o
153
+ end
154
+
155
+ # Calculates hash code according to all attributes.
156
+ # @return [Fixnum] Hash code
157
+ def hash
158
+ [is_bot, is_tor_node, is_threat, is_eu, location, currency_code, currency_name, region_area, subregion_area].hash
159
+ end
160
+
161
+ # Builds the object from hash
162
+ # @param [Hash] attributes Model attributes in the form of hash
163
+ # @return [Object] Returns the model itself
164
+ def build_from_hash(attributes)
165
+ return nil unless attributes.is_a?(Hash)
166
+ self.class.swagger_types.each_pair do |key, type|
167
+ if type =~ /\AArray<(.*)>/i
168
+ # check to ensure the input is an array given that the attribute
169
+ # is documented as an array but the input is not
170
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
171
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
172
+ end
173
+ elsif !attributes[self.class.attribute_map[key]].nil?
174
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
175
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
176
+ end
177
+
178
+ self
179
+ end
180
+
181
+ # Deserializes the data based on type
182
+ # @param string type Data type
183
+ # @param string value Value to be deserialized
184
+ # @return [Object] Deserialized data
185
+ def _deserialize(type, value)
186
+ case type.to_sym
187
+ when :DateTime
188
+ DateTime.parse(value)
189
+ when :Date
190
+ Date.parse(value)
191
+ when :String
192
+ value.to_s
193
+ when :Integer
194
+ value.to_i
195
+ when :Float
196
+ value.to_f
197
+ when :BOOLEAN
198
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
199
+ true
200
+ else
201
+ false
202
+ end
203
+ when :Object
204
+ # generic object (usually a Hash), return directly
205
+ value
206
+ when /\AArray<(?<inner_type>.+)>\z/
207
+ inner_type = Regexp.last_match[:inner_type]
208
+ value.map { |v| _deserialize(inner_type, v) }
209
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
210
+ k_type = Regexp.last_match[:k_type]
211
+ v_type = Regexp.last_match[:v_type]
212
+ {}.tap do |hash|
213
+ value.each do |k, v|
214
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
215
+ end
216
+ end
217
+ else # model
218
+ temp_model = CloudmersiveValidateApiClient.const_get(type).new
219
+ temp_model.build_from_hash(value)
220
+ end
221
+ end
222
+
223
+ # Returns the string representation of the object
224
+ # @return [String] String presentation of the object
225
+ def to_s
226
+ to_hash.to_s
227
+ end
228
+
229
+ # to_body is an alias to to_hash (backward compatibility)
230
+ # @return [Hash] Returns the object in the form of hash
231
+ def to_body
232
+ to_hash
233
+ end
234
+
235
+ # Returns the object in the form of hash
236
+ # @return [Hash] Returns the object in the form of hash
237
+ def to_hash
238
+ hash = {}
239
+ self.class.attribute_map.each_pair do |attr, param|
240
+ value = self.send(attr)
241
+ next if value.nil?
242
+ hash[param] = _to_hash(value)
243
+ end
244
+ hash
245
+ end
246
+
247
+ # Outputs non-array value in the form of hash
248
+ # For object, use to_hash. Otherwise, just return the value
249
+ # @param [Object] value Any valid value
250
+ # @return [Hash] Returns the value in the form of hash
251
+ def _to_hash(value)
252
+ if value.is_a?(Array)
253
+ value.compact.map { |v| _to_hash(v) }
254
+ elsif value.is_a?(Hash)
255
+ {}.tap do |hash|
256
+ value.each { |k, v| hash[k] = _to_hash(v) }
257
+ end
258
+ elsif value.respond_to? :to_hash
259
+ value.to_hash
260
+ else
261
+ value
262
+ end
263
+ end
264
+
265
+ end
266
+ end
@@ -0,0 +1,186 @@
1
+ =begin
2
+ #validateapi
3
+
4
+ #The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
5
+
6
+ OpenAPI spec version: v1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.14
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module CloudmersiveValidateApiClient
16
+ # Request to determine if a URL is a Phishing threat
17
+ class PhishingCheckRequest
18
+ # URL to validate
19
+ attr_accessor :url
20
+
21
+ # Attribute mapping from ruby-style variable name to JSON key.
22
+ def self.attribute_map
23
+ {
24
+ :'url' => :'URL'
25
+ }
26
+ end
27
+
28
+ # Attribute type mapping.
29
+ def self.swagger_types
30
+ {
31
+ :'url' => :'String'
32
+ }
33
+ end
34
+
35
+ # Initializes the object
36
+ # @param [Hash] attributes Model attributes in the form of hash
37
+ def initialize(attributes = {})
38
+ return unless attributes.is_a?(Hash)
39
+
40
+ # convert string to symbol for hash key
41
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
42
+
43
+ if attributes.has_key?(:'URL')
44
+ self.url = attributes[:'URL']
45
+ end
46
+ end
47
+
48
+ # Show invalid properties with the reasons. Usually used together with valid?
49
+ # @return Array for valid properties with the reasons
50
+ def list_invalid_properties
51
+ invalid_properties = Array.new
52
+ invalid_properties
53
+ end
54
+
55
+ # Check to see if the all the properties in the model are valid
56
+ # @return true if the model is valid
57
+ def valid?
58
+ true
59
+ end
60
+
61
+ # Checks equality by comparing each attribute.
62
+ # @param [Object] Object to be compared
63
+ def ==(o)
64
+ return true if self.equal?(o)
65
+ self.class == o.class &&
66
+ url == o.url
67
+ end
68
+
69
+ # @see the `==` method
70
+ # @param [Object] Object to be compared
71
+ def eql?(o)
72
+ self == o
73
+ end
74
+
75
+ # Calculates hash code according to all attributes.
76
+ # @return [Fixnum] Hash code
77
+ def hash
78
+ [url].hash
79
+ end
80
+
81
+ # Builds the object from hash
82
+ # @param [Hash] attributes Model attributes in the form of hash
83
+ # @return [Object] Returns the model itself
84
+ def build_from_hash(attributes)
85
+ return nil unless attributes.is_a?(Hash)
86
+ self.class.swagger_types.each_pair do |key, type|
87
+ if type =~ /\AArray<(.*)>/i
88
+ # check to ensure the input is an array given that the attribute
89
+ # is documented as an array but the input is not
90
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
91
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
92
+ end
93
+ elsif !attributes[self.class.attribute_map[key]].nil?
94
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
95
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
96
+ end
97
+
98
+ self
99
+ end
100
+
101
+ # Deserializes the data based on type
102
+ # @param string type Data type
103
+ # @param string value Value to be deserialized
104
+ # @return [Object] Deserialized data
105
+ def _deserialize(type, value)
106
+ case type.to_sym
107
+ when :DateTime
108
+ DateTime.parse(value)
109
+ when :Date
110
+ Date.parse(value)
111
+ when :String
112
+ value.to_s
113
+ when :Integer
114
+ value.to_i
115
+ when :Float
116
+ value.to_f
117
+ when :BOOLEAN
118
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
119
+ true
120
+ else
121
+ false
122
+ end
123
+ when :Object
124
+ # generic object (usually a Hash), return directly
125
+ value
126
+ when /\AArray<(?<inner_type>.+)>\z/
127
+ inner_type = Regexp.last_match[:inner_type]
128
+ value.map { |v| _deserialize(inner_type, v) }
129
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
130
+ k_type = Regexp.last_match[:k_type]
131
+ v_type = Regexp.last_match[:v_type]
132
+ {}.tap do |hash|
133
+ value.each do |k, v|
134
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
135
+ end
136
+ end
137
+ else # model
138
+ temp_model = CloudmersiveValidateApiClient.const_get(type).new
139
+ temp_model.build_from_hash(value)
140
+ end
141
+ end
142
+
143
+ # Returns the string representation of the object
144
+ # @return [String] String presentation of the object
145
+ def to_s
146
+ to_hash.to_s
147
+ end
148
+
149
+ # to_body is an alias to to_hash (backward compatibility)
150
+ # @return [Hash] Returns the object in the form of hash
151
+ def to_body
152
+ to_hash
153
+ end
154
+
155
+ # Returns the object in the form of hash
156
+ # @return [Hash] Returns the object in the form of hash
157
+ def to_hash
158
+ hash = {}
159
+ self.class.attribute_map.each_pair do |attr, param|
160
+ value = self.send(attr)
161
+ next if value.nil?
162
+ hash[param] = _to_hash(value)
163
+ end
164
+ hash
165
+ end
166
+
167
+ # Outputs non-array value in the form of hash
168
+ # For object, use to_hash. Otherwise, just return the value
169
+ # @param [Object] value Any valid value
170
+ # @return [Hash] Returns the value in the form of hash
171
+ def _to_hash(value)
172
+ if value.is_a?(Array)
173
+ value.compact.map { |v| _to_hash(v) }
174
+ elsif value.is_a?(Hash)
175
+ {}.tap do |hash|
176
+ value.each { |k, v| hash[k] = _to_hash(v) }
177
+ end
178
+ elsif value.respond_to? :to_hash
179
+ value.to_hash
180
+ else
181
+ value
182
+ end
183
+ end
184
+
185
+ end
186
+ end