cloudmersive-nlp-api-client 3.0.2 → 3.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +7 -0
- data/README.md +162 -0
- data/Rakefile +8 -0
- data/cloudmersive-nlp-api-client.gemspec +45 -0
- data/docs/AnalyticsApi.md +283 -0
- data/docs/CheckSentenceRequest.md +8 -0
- data/docs/CheckSentenceResponse.md +9 -0
- data/docs/CheckWordRequest.md +8 -0
- data/docs/CheckWordResponse.md +9 -0
- data/docs/CorrectWordInSentence.md +10 -0
- data/docs/Entity.md +9 -0
- data/docs/ExtractEntitiesApi.md +63 -0
- data/docs/ExtractEntitiesRequest.md +8 -0
- data/docs/ExtractEntitiesResponse.md +9 -0
- data/docs/GetWordsRequest.md +8 -0
- data/docs/GetWordsResponse.md +8 -0
- data/docs/HateSpeechAnalysisRequest.md +8 -0
- data/docs/HateSpeechAnalysisResponse.md +10 -0
- data/docs/LanguageDetectionApi.md +63 -0
- data/docs/LanguageDetectionRequest.md +8 -0
- data/docs/LanguageDetectionResponse.md +10 -0
- data/docs/LanguageTranslationApi.md +338 -0
- data/docs/LanguageTranslationRequest.md +8 -0
- data/docs/LanguageTranslationResponse.md +10 -0
- data/docs/ParseApi.md +63 -0
- data/docs/ParseRequest.md +8 -0
- data/docs/ParseResponse.md +8 -0
- data/docs/PosRequest.md +8 -0
- data/docs/PosResponse.md +8 -0
- data/docs/PosSentence.md +8 -0
- data/docs/PosTaggedWord.md +9 -0
- data/docs/PosTaggerApi.md +338 -0
- data/docs/ProfanityAnalysisRequest.md +8 -0
- data/docs/ProfanityAnalysisResponse.md +10 -0
- data/docs/RephraseApi.md +63 -0
- data/docs/RephraseRequest.md +9 -0
- data/docs/RephraseResponse.md +10 -0
- data/docs/RephrasedSentence.md +10 -0
- data/docs/RephrasedSentenceOption.md +9 -0
- data/docs/SegmentationApi.md +118 -0
- data/docs/SentenceSegmentationRequest.md +8 -0
- data/docs/SentenceSegmentationResponse.md +10 -0
- data/docs/SentimentAnalysisRequest.md +8 -0
- data/docs/SentimentAnalysisResponse.md +11 -0
- data/docs/SimilarityAnalysisRequest.md +9 -0
- data/docs/SimilarityAnalysisResponse.md +10 -0
- data/docs/SpellcheckApi.md +118 -0
- data/docs/SubjectivityAnalysisRequest.md +8 -0
- data/docs/SubjectivityAnalysisResponse.md +10 -0
- data/docs/WordPosition.md +11 -0
- data/git_push.sh +55 -0
- data/lib/cloudmersive-nlp-api-client.rb +85 -0
- data/lib/cloudmersive-nlp-api-client/api/analytics_api.rb +293 -0
- data/lib/cloudmersive-nlp-api-client/api/extract_entities_api.rb +77 -0
- data/lib/cloudmersive-nlp-api-client/api/language_detection_api.rb +77 -0
- data/lib/cloudmersive-nlp-api-client/api/language_translation_api.rb +347 -0
- data/lib/cloudmersive-nlp-api-client/api/parse_api.rb +77 -0
- data/lib/cloudmersive-nlp-api-client/api/pos_tagger_api.rb +347 -0
- data/lib/cloudmersive-nlp-api-client/api/rephrase_api.rb +77 -0
- data/lib/cloudmersive-nlp-api-client/api/segmentation_api.rb +131 -0
- data/lib/cloudmersive-nlp-api-client/api/spellcheck_api.rb +131 -0
- data/lib/cloudmersive-nlp-api-client/api_client.rb +391 -0
- data/lib/cloudmersive-nlp-api-client/api_error.rb +38 -0
- data/lib/cloudmersive-nlp-api-client/configuration.rb +209 -0
- data/lib/cloudmersive-nlp-api-client/models/check_sentence_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/check_sentence_response.rb +198 -0
- data/lib/cloudmersive-nlp-api-client/models/check_word_request.rb +184 -0
- data/lib/cloudmersive-nlp-api-client/models/check_word_response.rb +198 -0
- data/lib/cloudmersive-nlp-api-client/models/correct_word_in_sentence.rb +208 -0
- data/lib/cloudmersive-nlp-api-client/models/entity.rb +193 -0
- data/lib/cloudmersive-nlp-api-client/models/extract_entities_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/extract_entities_response.rb +197 -0
- data/lib/cloudmersive-nlp-api-client/models/get_words_request.rb +184 -0
- data/lib/cloudmersive-nlp-api-client/models/get_words_response.rb +188 -0
- data/lib/cloudmersive-nlp-api-client/models/hate_speech_analysis_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/hate_speech_analysis_response.rb +206 -0
- data/lib/cloudmersive-nlp-api-client/models/language_detection_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/language_detection_response.rb +206 -0
- data/lib/cloudmersive-nlp-api-client/models/language_translation_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/language_translation_response.rb +206 -0
- data/lib/cloudmersive-nlp-api-client/models/parse_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/parse_response.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/pos_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/pos_response.rb +188 -0
- data/lib/cloudmersive-nlp-api-client/models/pos_sentence.rb +188 -0
- data/lib/cloudmersive-nlp-api-client/models/pos_tagged_word.rb +196 -0
- data/lib/cloudmersive-nlp-api-client/models/profanity_analysis_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/profanity_analysis_response.rb +206 -0
- data/lib/cloudmersive-nlp-api-client/models/rephrase_request.rb +196 -0
- data/lib/cloudmersive-nlp-api-client/models/rephrase_response.rb +208 -0
- data/lib/cloudmersive-nlp-api-client/models/rephrased_sentence.rb +208 -0
- data/lib/cloudmersive-nlp-api-client/models/rephrased_sentence_option.rb +196 -0
- data/lib/cloudmersive-nlp-api-client/models/sentence_segmentation_request.rb +184 -0
- data/lib/cloudmersive-nlp-api-client/models/sentence_segmentation_response.rb +204 -0
- data/lib/cloudmersive-nlp-api-client/models/sentiment_analysis_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/sentiment_analysis_response.rb +216 -0
- data/lib/cloudmersive-nlp-api-client/models/similarity_analysis_request.rb +196 -0
- data/lib/cloudmersive-nlp-api-client/models/similarity_analysis_response.rb +206 -0
- data/lib/cloudmersive-nlp-api-client/models/subjectivity_analysis_request.rb +186 -0
- data/lib/cloudmersive-nlp-api-client/models/subjectivity_analysis_response.rb +206 -0
- data/lib/cloudmersive-nlp-api-client/models/word_position.rb +215 -0
- data/lib/cloudmersive-nlp-api-client/version.rb +15 -0
- data/spec/api/analytics_api_spec.rb +95 -0
- data/spec/api/extract_entities_api_spec.rb +47 -0
- data/spec/api/language_detection_api_spec.rb +47 -0
- data/spec/api/language_translation_api_spec.rb +107 -0
- data/spec/api/parse_api_spec.rb +47 -0
- data/spec/api/pos_tagger_api_spec.rb +107 -0
- data/spec/api/rephrase_api_spec.rb +47 -0
- data/spec/api/segmentation_api_spec.rb +59 -0
- data/spec/api/spellcheck_api_spec.rb +59 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/check_sentence_request_spec.rb +41 -0
- data/spec/models/check_sentence_response_spec.rb +47 -0
- data/spec/models/check_word_request_spec.rb +41 -0
- data/spec/models/check_word_response_spec.rb +47 -0
- data/spec/models/correct_word_in_sentence_spec.rb +53 -0
- data/spec/models/entity_spec.rb +47 -0
- data/spec/models/extract_entities_request_spec.rb +41 -0
- data/spec/models/extract_entities_response_spec.rb +47 -0
- data/spec/models/get_words_request_spec.rb +41 -0
- data/spec/models/get_words_response_spec.rb +41 -0
- data/spec/models/hate_speech_analysis_request_spec.rb +41 -0
- data/spec/models/hate_speech_analysis_response_spec.rb +53 -0
- data/spec/models/language_detection_request_spec.rb +41 -0
- data/spec/models/language_detection_response_spec.rb +53 -0
- data/spec/models/language_translation_request_spec.rb +41 -0
- data/spec/models/language_translation_response_spec.rb +53 -0
- data/spec/models/parse_request_spec.rb +41 -0
- data/spec/models/parse_response_spec.rb +41 -0
- data/spec/models/pos_request_spec.rb +41 -0
- data/spec/models/pos_response_spec.rb +41 -0
- data/spec/models/pos_sentence_spec.rb +41 -0
- data/spec/models/pos_tagged_word_spec.rb +47 -0
- data/spec/models/profanity_analysis_request_spec.rb +41 -0
- data/spec/models/profanity_analysis_response_spec.rb +53 -0
- data/spec/models/rephrase_request_spec.rb +47 -0
- data/spec/models/rephrase_response_spec.rb +53 -0
- data/spec/models/rephrased_sentence_option_spec.rb +47 -0
- data/spec/models/rephrased_sentence_spec.rb +53 -0
- data/spec/models/sentence_segmentation_request_spec.rb +41 -0
- data/spec/models/sentence_segmentation_response_spec.rb +53 -0
- data/spec/models/sentiment_analysis_request_spec.rb +41 -0
- data/spec/models/sentiment_analysis_response_spec.rb +59 -0
- data/spec/models/similarity_analysis_request_spec.rb +47 -0
- data/spec/models/similarity_analysis_response_spec.rb +53 -0
- data/spec/models/subjectivity_analysis_request_spec.rb +41 -0
- data/spec/models/subjectivity_analysis_response_spec.rb +53 -0
- data/spec/models/word_position_spec.rb +59 -0
- data/spec/spec_helper.rb +111 -0
- metadata +154 -3
@@ -0,0 +1,131 @@
|
|
1
|
+
=begin
|
2
|
+
#nlpapiv2
|
3
|
+
|
4
|
+
#The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
|
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 'uri'
|
14
|
+
|
15
|
+
module CloudmersiveNlpApiClient
|
16
|
+
class SpellcheckApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Check if sentence is spelled correctly
|
23
|
+
# Checks whether the sentence is spelled correctly and returns the result as JSON
|
24
|
+
# @param value Input sentence
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [CheckSentenceResponse]
|
27
|
+
def spellcheck_check_sentence(value, opts = {})
|
28
|
+
data, _status_code, _headers = spellcheck_check_sentence_with_http_info(value, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Check if sentence is spelled correctly
|
33
|
+
# Checks whether the sentence is spelled correctly and returns the result as JSON
|
34
|
+
# @param value Input sentence
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(CheckSentenceResponse, Fixnum, Hash)>] CheckSentenceResponse data, response status code and response headers
|
37
|
+
def spellcheck_check_sentence_with_http_info(value, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: SpellcheckApi.spellcheck_check_sentence ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'value' is set
|
42
|
+
if @api_client.config.client_side_validation && value.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'value' when calling SpellcheckApi.spellcheck_check_sentence"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/nlp-v2/spellcheck/check/sentence'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
# HTTP header 'Content-Type'
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
57
|
+
|
58
|
+
# form parameters
|
59
|
+
form_params = {}
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = @api_client.object_to_http_body(value)
|
63
|
+
auth_names = ['Apikey']
|
64
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
65
|
+
:header_params => header_params,
|
66
|
+
:query_params => query_params,
|
67
|
+
:form_params => form_params,
|
68
|
+
:body => post_body,
|
69
|
+
:auth_names => auth_names,
|
70
|
+
:return_type => 'CheckSentenceResponse')
|
71
|
+
if @api_client.config.debugging
|
72
|
+
@api_client.config.logger.debug "API called: SpellcheckApi#spellcheck_check_sentence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
73
|
+
end
|
74
|
+
return data, status_code, headers
|
75
|
+
end
|
76
|
+
# Find spelling corrections
|
77
|
+
# Find spelling correction suggestions and return result as JSON
|
78
|
+
# @param value Input string
|
79
|
+
# @param [Hash] opts the optional parameters
|
80
|
+
# @return [CheckWordResponse]
|
81
|
+
def spellcheck_correct_json(value, opts = {})
|
82
|
+
data, _status_code, _headers = spellcheck_correct_json_with_http_info(value, opts)
|
83
|
+
data
|
84
|
+
end
|
85
|
+
|
86
|
+
# Find spelling corrections
|
87
|
+
# Find spelling correction suggestions and return result as JSON
|
88
|
+
# @param value Input string
|
89
|
+
# @param [Hash] opts the optional parameters
|
90
|
+
# @return [Array<(CheckWordResponse, Fixnum, Hash)>] CheckWordResponse data, response status code and response headers
|
91
|
+
def spellcheck_correct_json_with_http_info(value, opts = {})
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug 'Calling API: SpellcheckApi.spellcheck_correct_json ...'
|
94
|
+
end
|
95
|
+
# verify the required parameter 'value' is set
|
96
|
+
if @api_client.config.client_side_validation && value.nil?
|
97
|
+
fail ArgumentError, "Missing the required parameter 'value' when calling SpellcheckApi.spellcheck_correct_json"
|
98
|
+
end
|
99
|
+
# resource path
|
100
|
+
local_var_path = '/nlp-v2/spellcheck/check/word'
|
101
|
+
|
102
|
+
# query parameters
|
103
|
+
query_params = {}
|
104
|
+
|
105
|
+
# header parameters
|
106
|
+
header_params = {}
|
107
|
+
# HTTP header 'Accept' (if needed)
|
108
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
109
|
+
# HTTP header 'Content-Type'
|
110
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
|
111
|
+
|
112
|
+
# form parameters
|
113
|
+
form_params = {}
|
114
|
+
|
115
|
+
# http body (model)
|
116
|
+
post_body = @api_client.object_to_http_body(value)
|
117
|
+
auth_names = ['Apikey']
|
118
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
119
|
+
:header_params => header_params,
|
120
|
+
:query_params => query_params,
|
121
|
+
:form_params => form_params,
|
122
|
+
:body => post_body,
|
123
|
+
:auth_names => auth_names,
|
124
|
+
:return_type => 'CheckWordResponse')
|
125
|
+
if @api_client.config.debugging
|
126
|
+
@api_client.config.logger.debug "API called: SpellcheckApi#spellcheck_correct_json\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
127
|
+
end
|
128
|
+
return data, status_code, headers
|
129
|
+
end
|
130
|
+
end
|
131
|
+
end
|
@@ -0,0 +1,391 @@
|
|
1
|
+
=begin
|
2
|
+
#nlpapiv2
|
3
|
+
|
4
|
+
#The powerful Natural Language Processing APIs (v2) let you perform part of speech tagging, entity identification, sentence parsing, and much more to help you understand the meaning of unstructured text.
|
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
|
+
require 'json'
|
15
|
+
require 'logger'
|
16
|
+
require 'tempfile'
|
17
|
+
require 'typhoeus'
|
18
|
+
require 'uri'
|
19
|
+
|
20
|
+
module CloudmersiveNlpApiClient
|
21
|
+
class ApiClient
|
22
|
+
# The Configuration object holding settings to be used in the API client.
|
23
|
+
attr_accessor :config
|
24
|
+
|
25
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
26
|
+
#
|
27
|
+
# @return [Hash]
|
28
|
+
attr_accessor :default_headers
|
29
|
+
|
30
|
+
# Initializes the ApiClient
|
31
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
32
|
+
def initialize(config = Configuration.default)
|
33
|
+
@config = config
|
34
|
+
@user_agent = "Swagger-Codegen/#{VERSION}/ruby"
|
35
|
+
@default_headers = {
|
36
|
+
'Content-Type' => 'application/json',
|
37
|
+
'User-Agent' => @user_agent
|
38
|
+
}
|
39
|
+
end
|
40
|
+
|
41
|
+
def self.default
|
42
|
+
@@default ||= ApiClient.new
|
43
|
+
end
|
44
|
+
|
45
|
+
# Call an API with given options.
|
46
|
+
#
|
47
|
+
# @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
|
48
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
49
|
+
def call_api(http_method, path, opts = {})
|
50
|
+
request = build_request(http_method, path, opts)
|
51
|
+
response = request.run
|
52
|
+
|
53
|
+
if @config.debugging
|
54
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
55
|
+
end
|
56
|
+
|
57
|
+
unless response.success?
|
58
|
+
if response.timed_out?
|
59
|
+
fail ApiError.new('Connection timed out')
|
60
|
+
elsif response.code == 0
|
61
|
+
# Errors from libcurl will be made visible here
|
62
|
+
fail ApiError.new(:code => 0,
|
63
|
+
:message => response.return_message)
|
64
|
+
else
|
65
|
+
fail ApiError.new(:code => response.code,
|
66
|
+
:response_headers => response.headers,
|
67
|
+
:response_body => response.body),
|
68
|
+
response.status_message
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
if opts[:return_type]
|
73
|
+
data = deserialize(response, opts[:return_type])
|
74
|
+
else
|
75
|
+
data = nil
|
76
|
+
end
|
77
|
+
return data, response.code, response.headers
|
78
|
+
end
|
79
|
+
|
80
|
+
# Builds the HTTP request
|
81
|
+
#
|
82
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
83
|
+
# @param [String] path URL path (e.g. /account/new)
|
84
|
+
# @option opts [Hash] :header_params Header parameters
|
85
|
+
# @option opts [Hash] :query_params Query parameters
|
86
|
+
# @option opts [Hash] :form_params Query parameters
|
87
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
88
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
89
|
+
def build_request(http_method, path, opts = {})
|
90
|
+
url = build_request_url(path)
|
91
|
+
http_method = http_method.to_sym.downcase
|
92
|
+
|
93
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
94
|
+
query_params = opts[:query_params] || {}
|
95
|
+
form_params = opts[:form_params] || {}
|
96
|
+
|
97
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
98
|
+
|
99
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
100
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
101
|
+
|
102
|
+
req_opts = {
|
103
|
+
:method => http_method,
|
104
|
+
:headers => header_params,
|
105
|
+
:params => query_params,
|
106
|
+
:params_encoding => @config.params_encoding,
|
107
|
+
:timeout => @config.timeout,
|
108
|
+
:ssl_verifypeer => @config.verify_ssl,
|
109
|
+
:ssl_verifyhost => _verify_ssl_host,
|
110
|
+
:sslcert => @config.cert_file,
|
111
|
+
:sslkey => @config.key_file,
|
112
|
+
:verbose => @config.debugging
|
113
|
+
}
|
114
|
+
|
115
|
+
req_opts.merge!(multipart: true) if header_params['Content-Type'].start_with? "multipart/"
|
116
|
+
|
117
|
+
# set custom cert, if provided
|
118
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
119
|
+
|
120
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
121
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
122
|
+
req_opts.update :body => req_body
|
123
|
+
if @config.debugging
|
124
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
125
|
+
end
|
126
|
+
end
|
127
|
+
|
128
|
+
request = Typhoeus::Request.new(url, req_opts)
|
129
|
+
download_file(request) if opts[:return_type] == 'File'
|
130
|
+
request
|
131
|
+
end
|
132
|
+
|
133
|
+
# Check if the given MIME is a JSON MIME.
|
134
|
+
# JSON MIME examples:
|
135
|
+
# application/json
|
136
|
+
# application/json; charset=UTF8
|
137
|
+
# APPLICATION/JSON
|
138
|
+
# */*
|
139
|
+
# @param [String] mime MIME
|
140
|
+
# @return [Boolean] True if the MIME is application/json
|
141
|
+
def json_mime?(mime)
|
142
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
143
|
+
end
|
144
|
+
|
145
|
+
# Deserialize the response to the given return type.
|
146
|
+
#
|
147
|
+
# @param [Response] response HTTP response
|
148
|
+
# @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
|
149
|
+
def deserialize(response, return_type)
|
150
|
+
body = response.body
|
151
|
+
|
152
|
+
# handle file downloading - return the File instance processed in request callbacks
|
153
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
154
|
+
return @tempfile if return_type == 'File'
|
155
|
+
|
156
|
+
return nil if body.nil? || body.empty?
|
157
|
+
|
158
|
+
# return response body directly for String return type
|
159
|
+
return body if return_type == 'String'
|
160
|
+
|
161
|
+
# ensuring a default content type
|
162
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
163
|
+
|
164
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
165
|
+
|
166
|
+
begin
|
167
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
168
|
+
rescue JSON::ParserError => e
|
169
|
+
if %w(String Date DateTime).include?(return_type)
|
170
|
+
data = body
|
171
|
+
else
|
172
|
+
raise e
|
173
|
+
end
|
174
|
+
end
|
175
|
+
|
176
|
+
convert_to_type data, return_type
|
177
|
+
end
|
178
|
+
|
179
|
+
# Convert data to the given return type.
|
180
|
+
# @param [Object] data Data to be converted
|
181
|
+
# @param [String] return_type Return type
|
182
|
+
# @return [Mixed] Data in a particular type
|
183
|
+
def convert_to_type(data, return_type)
|
184
|
+
return nil if data.nil?
|
185
|
+
case return_type
|
186
|
+
when 'String'
|
187
|
+
data.to_s
|
188
|
+
when 'Integer'
|
189
|
+
data.to_i
|
190
|
+
when 'Float'
|
191
|
+
data.to_f
|
192
|
+
when 'BOOLEAN'
|
193
|
+
data == true
|
194
|
+
when 'DateTime'
|
195
|
+
# parse date time (expecting ISO 8601 format)
|
196
|
+
DateTime.parse data
|
197
|
+
when 'Date'
|
198
|
+
# parse date time (expecting ISO 8601 format)
|
199
|
+
Date.parse data
|
200
|
+
when 'Object'
|
201
|
+
# generic object (usually a Hash), return directly
|
202
|
+
data
|
203
|
+
when /\AArray<(.+)>\z/
|
204
|
+
# e.g. Array<Pet>
|
205
|
+
sub_type = $1
|
206
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
207
|
+
when /\AHash\<String, (.+)\>\z/
|
208
|
+
# e.g. Hash<String, Integer>
|
209
|
+
sub_type = $1
|
210
|
+
{}.tap do |hash|
|
211
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
212
|
+
end
|
213
|
+
else
|
214
|
+
# models, e.g. Pet
|
215
|
+
CloudmersiveNlpApiClient.const_get(return_type).new.tap do |model|
|
216
|
+
model.build_from_hash data
|
217
|
+
end
|
218
|
+
end
|
219
|
+
end
|
220
|
+
|
221
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
222
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
223
|
+
# The response body is written to the file in chunks in order to handle files which
|
224
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
225
|
+
# process can use.
|
226
|
+
#
|
227
|
+
# @see Configuration#temp_folder_path
|
228
|
+
def download_file(request)
|
229
|
+
tempfile = nil
|
230
|
+
encoding = nil
|
231
|
+
request.on_headers do |response|
|
232
|
+
content_disposition = response.headers['Content-Disposition']
|
233
|
+
if content_disposition && content_disposition =~ /filename=/i
|
234
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
235
|
+
prefix = sanitize_filename(filename)
|
236
|
+
else
|
237
|
+
prefix = 'download-'
|
238
|
+
end
|
239
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
240
|
+
encoding = response.body.encoding
|
241
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
242
|
+
@tempfile = tempfile
|
243
|
+
end
|
244
|
+
request.on_body do |chunk|
|
245
|
+
chunk.force_encoding(encoding)
|
246
|
+
tempfile.write(chunk)
|
247
|
+
end
|
248
|
+
request.on_complete do |response|
|
249
|
+
tempfile.close
|
250
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
251
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
252
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
253
|
+
"explicitly with `tempfile.delete`"
|
254
|
+
end
|
255
|
+
end
|
256
|
+
|
257
|
+
# Sanitize filename by removing path.
|
258
|
+
# e.g. ../../sun.gif becomes sun.gif
|
259
|
+
#
|
260
|
+
# @param [String] filename the filename to be sanitized
|
261
|
+
# @return [String] the sanitized filename
|
262
|
+
def sanitize_filename(filename)
|
263
|
+
filename.gsub(/.*[\/\\]/, '')
|
264
|
+
end
|
265
|
+
|
266
|
+
def build_request_url(path)
|
267
|
+
# Add leading and trailing slashes to path
|
268
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
269
|
+
URI.encode(@config.base_url + path)
|
270
|
+
end
|
271
|
+
|
272
|
+
# Builds the HTTP request body
|
273
|
+
#
|
274
|
+
# @param [Hash] header_params Header parameters
|
275
|
+
# @param [Hash] form_params Query parameters
|
276
|
+
# @param [Object] body HTTP body (JSON/XML)
|
277
|
+
# @return [String] HTTP body data in the form of string
|
278
|
+
def build_request_body(header_params, form_params, body)
|
279
|
+
# http form
|
280
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
281
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
282
|
+
data = {}
|
283
|
+
form_params.each do |key, value|
|
284
|
+
case value
|
285
|
+
when ::File, ::Array, nil
|
286
|
+
# let typhoeus handle File, Array and nil parameters
|
287
|
+
data[key] = value
|
288
|
+
else
|
289
|
+
data[key] = value.to_s
|
290
|
+
end
|
291
|
+
end
|
292
|
+
elsif body
|
293
|
+
data = body.is_a?(String) ? body : body.to_json
|
294
|
+
else
|
295
|
+
data = nil
|
296
|
+
end
|
297
|
+
data
|
298
|
+
end
|
299
|
+
|
300
|
+
# Update hearder and query params based on authentication settings.
|
301
|
+
#
|
302
|
+
# @param [Hash] header_params Header parameters
|
303
|
+
# @param [Hash] query_params Query parameters
|
304
|
+
# @param [String] auth_names Authentication scheme name
|
305
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
306
|
+
Array(auth_names).each do |auth_name|
|
307
|
+
auth_setting = @config.auth_settings[auth_name]
|
308
|
+
next unless auth_setting
|
309
|
+
case auth_setting[:in]
|
310
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
311
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
312
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
313
|
+
end
|
314
|
+
end
|
315
|
+
end
|
316
|
+
|
317
|
+
# Sets user agent in HTTP header
|
318
|
+
#
|
319
|
+
# @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
|
320
|
+
def user_agent=(user_agent)
|
321
|
+
@user_agent = user_agent
|
322
|
+
@default_headers['User-Agent'] = @user_agent
|
323
|
+
end
|
324
|
+
|
325
|
+
# Return Accept header based on an array of accepts provided.
|
326
|
+
# @param [Array] accepts array for Accept
|
327
|
+
# @return [String] the Accept header (e.g. application/json)
|
328
|
+
def select_header_accept(accepts)
|
329
|
+
return nil if accepts.nil? || accepts.empty?
|
330
|
+
# use JSON when present, otherwise use all of the provided
|
331
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
332
|
+
json_accept || accepts.join(',')
|
333
|
+
end
|
334
|
+
|
335
|
+
# Return Content-Type header based on an array of content types provided.
|
336
|
+
# @param [Array] content_types array for Content-Type
|
337
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
338
|
+
def select_header_content_type(content_types)
|
339
|
+
# use application/json by default
|
340
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
341
|
+
# use JSON when present, otherwise use the first one
|
342
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
343
|
+
json_content_type || content_types.first
|
344
|
+
end
|
345
|
+
|
346
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
347
|
+
# @param [Object] model object to be converted into JSON string
|
348
|
+
# @return [String] JSON string representation of the object
|
349
|
+
def object_to_http_body(model)
|
350
|
+
return model if model.nil? || model.is_a?(String)
|
351
|
+
local_body = nil
|
352
|
+
if model.is_a?(Array)
|
353
|
+
local_body = model.map { |m| object_to_hash(m) }
|
354
|
+
else
|
355
|
+
local_body = object_to_hash(model)
|
356
|
+
end
|
357
|
+
local_body.to_json
|
358
|
+
end
|
359
|
+
|
360
|
+
# Convert object(non-array) to hash.
|
361
|
+
# @param [Object] obj object to be converted into JSON string
|
362
|
+
# @return [String] JSON string representation of the object
|
363
|
+
def object_to_hash(obj)
|
364
|
+
if obj.respond_to?(:to_hash)
|
365
|
+
obj.to_hash
|
366
|
+
else
|
367
|
+
obj
|
368
|
+
end
|
369
|
+
end
|
370
|
+
|
371
|
+
# Build parameter value according to the given collection format.
|
372
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
373
|
+
def build_collection_param(param, collection_format)
|
374
|
+
case collection_format
|
375
|
+
when :csv
|
376
|
+
param.join(',')
|
377
|
+
when :ssv
|
378
|
+
param.join(' ')
|
379
|
+
when :tsv
|
380
|
+
param.join("\t")
|
381
|
+
when :pipes
|
382
|
+
param.join('|')
|
383
|
+
when :multi
|
384
|
+
# return the array directly as typhoeus will handle it as expected
|
385
|
+
param
|
386
|
+
else
|
387
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
388
|
+
end
|
389
|
+
end
|
390
|
+
end
|
391
|
+
end
|