approveapi_swagger 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +79 -0
- data/README.md +105 -0
- data/Rakefile +10 -0
- data/approveapi_swagger.gemspec +45 -0
- data/docs/AnswerMetadata.md +10 -0
- data/docs/ApproveApi.md +162 -0
- data/docs/CreatePromptRequest.md +14 -0
- data/docs/Error.md +8 -0
- data/docs/Prompt.md +11 -0
- data/docs/PromptAnswer.md +10 -0
- data/docs/PromptMetadata.md +12 -0
- data/docs/PromptStatus.md +8 -0
- data/git_push.sh +55 -0
- data/lib/approveapi_swagger.rb +47 -0
- data/lib/approveapi_swagger/api/approve_api.rb +187 -0
- data/lib/approveapi_swagger/api_client.rb +387 -0
- data/lib/approveapi_swagger/api_error.rb +38 -0
- data/lib/approveapi_swagger/configuration.rb +251 -0
- data/lib/approveapi_swagger/models/answer_metadata.rb +209 -0
- data/lib/approveapi_swagger/models/create_prompt_request.rb +261 -0
- data/lib/approveapi_swagger/models/error.rb +197 -0
- data/lib/approveapi_swagger/models/prompt.rb +230 -0
- data/lib/approveapi_swagger/models/prompt_answer.rb +221 -0
- data/lib/approveapi_swagger/models/prompt_metadata.rb +232 -0
- data/lib/approveapi_swagger/models/prompt_status.rb +197 -0
- data/lib/approveapi_swagger/version.rb +15 -0
- data/pkg/approveapi_swagger-1.0.0.gem +0 -0
- data/spec/api/approve_api_spec.rb +72 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/answer_metadata_spec.rb +53 -0
- data/spec/models/create_prompt_request_spec.rb +77 -0
- data/spec/models/error_spec.rb +41 -0
- data/spec/models/prompt_answer_spec.rb +53 -0
- data/spec/models/prompt_metadata_spec.rb +65 -0
- data/spec/models/prompt_spec.rb +59 -0
- data/spec/models/prompt_status_spec.rb +41 -0
- data/spec/spec_helper.rb +111 -0
- metadata +274 -0
data/docs/Error.md
ADDED
data/docs/Prompt.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# ApproveAPISwagger::Prompt
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**answer** | [**PromptAnswer**](PromptAnswer.md) | | [optional]
|
7
|
+
**sent_at** | **Float** | The unix timestamp when this prompt was sent. |
|
8
|
+
**id** | **String** | A unique id for this prompt. |
|
9
|
+
**metadata** | [**PromptMetadata**](PromptMetadata.md) | | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# ApproveAPISwagger::PromptAnswer
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**time** | **Float** | The unix timestamp when the user answered the prompt. |
|
7
|
+
**result** | **BOOLEAN** | The user's answer to whether or not they approve this prompt. |
|
8
|
+
**metadata** | [**AnswerMetadata**](AnswerMetadata.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# ApproveAPISwagger::PromptMetadata
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**time** | **String** | The date/time of the action. | [optional]
|
7
|
+
**operating_system** | **String** | The operating system initiating the action, i.e. Mac OS X. | [optional]
|
8
|
+
**ip_address** | **String** | The IP address of the computer initiating the action. | [optional]
|
9
|
+
**location** | **String** | The physical location, like Oakland, CA, of the action. | [optional]
|
10
|
+
**browser** | **String** | The web browser initiating the action, i.e. Chrome. | [optional]
|
11
|
+
|
12
|
+
|
data/git_push.sh
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
#!/bin/sh
|
2
|
+
#
|
3
|
+
# Generated by: https://openapi-generator.tech
|
4
|
+
#
|
5
|
+
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
|
6
|
+
#
|
7
|
+
# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
|
8
|
+
|
9
|
+
git_user_id=$1
|
10
|
+
git_repo_id=$2
|
11
|
+
release_note=$3
|
12
|
+
|
13
|
+
if [ "$git_user_id" = "" ]; then
|
14
|
+
git_user_id="GIT_USER_ID"
|
15
|
+
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
16
|
+
fi
|
17
|
+
|
18
|
+
if [ "$git_repo_id" = "" ]; then
|
19
|
+
git_repo_id="GIT_REPO_ID"
|
20
|
+
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
21
|
+
fi
|
22
|
+
|
23
|
+
if [ "$release_note" = "" ]; then
|
24
|
+
release_note="Minor update"
|
25
|
+
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
26
|
+
fi
|
27
|
+
|
28
|
+
# Initialize the local directory as a Git repository
|
29
|
+
git init
|
30
|
+
|
31
|
+
# Adds the files in the local repository and stages them for commit.
|
32
|
+
git add .
|
33
|
+
|
34
|
+
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
35
|
+
git commit -m "$release_note"
|
36
|
+
|
37
|
+
# Sets the new remote
|
38
|
+
git_remote=`git remote`
|
39
|
+
if [ "$git_remote" = "" ]; then # git remote not defined
|
40
|
+
|
41
|
+
if [ "$GIT_TOKEN" = "" ]; then
|
42
|
+
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
|
43
|
+
git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
|
44
|
+
else
|
45
|
+
git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
|
46
|
+
fi
|
47
|
+
|
48
|
+
fi
|
49
|
+
|
50
|
+
git pull origin master
|
51
|
+
|
52
|
+
# Pushes (Forces) the changes in the local repository up to the remote repository
|
53
|
+
echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
|
54
|
+
git push origin master 2>&1 | grep -v 'To https'
|
55
|
+
|
@@ -0,0 +1,47 @@
|
|
1
|
+
=begin
|
2
|
+
#ApproveAPISwagger
|
3
|
+
|
4
|
+
#The simple API to request a user's approval on anything via email + sms.
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
Contact: dev@approveapi.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.0.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
# Common files
|
14
|
+
require 'approveapi_swagger/api_client'
|
15
|
+
require 'approveapi_swagger/api_error'
|
16
|
+
require 'approveapi_swagger/version'
|
17
|
+
require 'approveapi_swagger/configuration'
|
18
|
+
|
19
|
+
# Models
|
20
|
+
require 'approveapi_swagger/models/answer_metadata'
|
21
|
+
require 'approveapi_swagger/models/create_prompt_request'
|
22
|
+
require 'approveapi_swagger/models/error'
|
23
|
+
require 'approveapi_swagger/models/prompt'
|
24
|
+
require 'approveapi_swagger/models/prompt_answer'
|
25
|
+
require 'approveapi_swagger/models/prompt_metadata'
|
26
|
+
require 'approveapi_swagger/models/prompt_status'
|
27
|
+
|
28
|
+
# APIs
|
29
|
+
require 'approveapi_swagger/api/approve_api'
|
30
|
+
|
31
|
+
module ApproveAPISwagger
|
32
|
+
class << self
|
33
|
+
# Customize default settings for the SDK using block.
|
34
|
+
# ApproveAPISwagger.configure do |config|
|
35
|
+
# config.username = "xxx"
|
36
|
+
# config.password = "xxx"
|
37
|
+
# end
|
38
|
+
# If no block given, return the default Configuration object.
|
39
|
+
def configure
|
40
|
+
if block_given?
|
41
|
+
yield(Configuration.default)
|
42
|
+
else
|
43
|
+
Configuration.default
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
@@ -0,0 +1,187 @@
|
|
1
|
+
=begin
|
2
|
+
#ApproveAPISwagger
|
3
|
+
|
4
|
+
#The simple API to request a user's approval on anything via email + sms.
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
Contact: dev@approveapi.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.0.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module ApproveAPISwagger
|
16
|
+
class ApproveApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Sending a prompt
|
23
|
+
# Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).
|
24
|
+
# @param create_prompt_request
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [Prompt]
|
27
|
+
def create_prompt(create_prompt_request, opts = {})
|
28
|
+
data, _status_code, _headers = create_prompt_with_http_info(create_prompt_request, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Sending a prompt
|
33
|
+
# Creates a prompt and pushes it to the user (sends via email, sms, or other supported protocols).
|
34
|
+
# @param create_prompt_request
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(Prompt, Fixnum, Hash)>] Prompt data, response status code and response headers
|
37
|
+
def create_prompt_with_http_info(create_prompt_request, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: ApproveApi.create_prompt ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'create_prompt_request' is set
|
42
|
+
if @api_client.config.client_side_validation && create_prompt_request.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'create_prompt_request' when calling ApproveApi.create_prompt"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/prompt'
|
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'])
|
57
|
+
|
58
|
+
# form parameters
|
59
|
+
form_params = {}
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = @api_client.object_to_http_body(create_prompt_request)
|
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 => 'Prompt')
|
71
|
+
if @api_client.config.debugging
|
72
|
+
@api_client.config.logger.debug "API called: ApproveApi#create_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
73
|
+
end
|
74
|
+
return data, status_code, headers
|
75
|
+
end
|
76
|
+
|
77
|
+
# Retrieve a prompt
|
78
|
+
# Retrieve the prompt object with the given ID.
|
79
|
+
# @param id The identifier for a pending or completed prompt. This is returned when you create a prompt.
|
80
|
+
# @param [Hash] opts the optional parameters
|
81
|
+
# @option opts [BOOLEAN] :long_poll If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.
|
82
|
+
# @return [Prompt]
|
83
|
+
def get_prompt(id, opts = {})
|
84
|
+
data, _status_code, _headers = get_prompt_with_http_info(id, opts)
|
85
|
+
data
|
86
|
+
end
|
87
|
+
|
88
|
+
# Retrieve a prompt
|
89
|
+
# Retrieve the prompt object with the given ID.
|
90
|
+
# @param id The identifier for a pending or completed prompt. This is returned when you create a prompt.
|
91
|
+
# @param [Hash] opts the optional parameters
|
92
|
+
# @option opts [BOOLEAN] :long_poll If true, the request waits (long-polls) until the user responds to the prompt or more than 10 minutes pass. Defaults to false.
|
93
|
+
# @return [Array<(Prompt, Fixnum, Hash)>] Prompt data, response status code and response headers
|
94
|
+
def get_prompt_with_http_info(id, opts = {})
|
95
|
+
if @api_client.config.debugging
|
96
|
+
@api_client.config.logger.debug 'Calling API: ApproveApi.get_prompt ...'
|
97
|
+
end
|
98
|
+
# verify the required parameter 'id' is set
|
99
|
+
if @api_client.config.client_side_validation && id.nil?
|
100
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ApproveApi.get_prompt"
|
101
|
+
end
|
102
|
+
# resource path
|
103
|
+
local_var_path = '/prompt/{id}'.sub('{' + 'id' + '}', id.to_s)
|
104
|
+
|
105
|
+
# query parameters
|
106
|
+
query_params = {}
|
107
|
+
query_params[:'long_poll'] = opts[:'long_poll'] if !opts[:'long_poll'].nil?
|
108
|
+
|
109
|
+
# header parameters
|
110
|
+
header_params = {}
|
111
|
+
# HTTP header 'Accept' (if needed)
|
112
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
113
|
+
|
114
|
+
# form parameters
|
115
|
+
form_params = {}
|
116
|
+
|
117
|
+
# http body (model)
|
118
|
+
post_body = nil
|
119
|
+
auth_names = ['apiKey']
|
120
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
121
|
+
:header_params => header_params,
|
122
|
+
:query_params => query_params,
|
123
|
+
:form_params => form_params,
|
124
|
+
:body => post_body,
|
125
|
+
:auth_names => auth_names,
|
126
|
+
:return_type => 'Prompt')
|
127
|
+
if @api_client.config.debugging
|
128
|
+
@api_client.config.logger.debug "API called: ApproveApi#get_prompt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
129
|
+
end
|
130
|
+
return data, status_code, headers
|
131
|
+
end
|
132
|
+
|
133
|
+
# Check prompt status
|
134
|
+
# Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials.
|
135
|
+
# @param id The prompt identifier.
|
136
|
+
# @param [Hash] opts the optional parameters
|
137
|
+
# @return [PromptStatus]
|
138
|
+
def get_prompt_status(id, opts = {})
|
139
|
+
data, _status_code, _headers = get_prompt_status_with_http_info(id, opts)
|
140
|
+
data
|
141
|
+
end
|
142
|
+
|
143
|
+
# Check prompt status
|
144
|
+
# Returns whether a prompt has been completed by the user. This request does not require authentication, and so can be used client-side without sharing API credentials.
|
145
|
+
# @param id The prompt identifier.
|
146
|
+
# @param [Hash] opts the optional parameters
|
147
|
+
# @return [Array<(PromptStatus, Fixnum, Hash)>] PromptStatus data, response status code and response headers
|
148
|
+
def get_prompt_status_with_http_info(id, opts = {})
|
149
|
+
if @api_client.config.debugging
|
150
|
+
@api_client.config.logger.debug 'Calling API: ApproveApi.get_prompt_status ...'
|
151
|
+
end
|
152
|
+
# verify the required parameter 'id' is set
|
153
|
+
if @api_client.config.client_side_validation && id.nil?
|
154
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ApproveApi.get_prompt_status"
|
155
|
+
end
|
156
|
+
# resource path
|
157
|
+
local_var_path = '/prompt/{id}/status'.sub('{' + 'id' + '}', id.to_s)
|
158
|
+
|
159
|
+
# query parameters
|
160
|
+
query_params = {}
|
161
|
+
|
162
|
+
# header parameters
|
163
|
+
header_params = {}
|
164
|
+
# HTTP header 'Accept' (if needed)
|
165
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
166
|
+
|
167
|
+
# form parameters
|
168
|
+
form_params = {}
|
169
|
+
|
170
|
+
# http body (model)
|
171
|
+
post_body = nil
|
172
|
+
auth_names = []
|
173
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
174
|
+
:header_params => header_params,
|
175
|
+
:query_params => query_params,
|
176
|
+
:form_params => form_params,
|
177
|
+
:body => post_body,
|
178
|
+
:auth_names => auth_names,
|
179
|
+
:return_type => 'PromptStatus')
|
180
|
+
if @api_client.config.debugging
|
181
|
+
@api_client.config.logger.debug "API called: ApproveApi#get_prompt_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
182
|
+
end
|
183
|
+
return data, status_code, headers
|
184
|
+
end
|
185
|
+
|
186
|
+
end
|
187
|
+
end
|
@@ -0,0 +1,387 @@
|
|
1
|
+
=begin
|
2
|
+
#ApproveAPISwagger
|
3
|
+
|
4
|
+
#The simple API to request a user's approval on anything via email + sms.
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
Contact: dev@approveapi.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.0.0-SNAPSHOT
|
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 ApproveAPISwagger
|
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 = "OpenAPI-Generator/#{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
|
+
# set custom cert, if provided
|
116
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
117
|
+
|
118
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
119
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
120
|
+
req_opts.update :body => req_body
|
121
|
+
if @config.debugging
|
122
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
request = Typhoeus::Request.new(url, req_opts)
|
127
|
+
download_file(request) if opts[:return_type] == 'File'
|
128
|
+
request
|
129
|
+
end
|
130
|
+
|
131
|
+
# Check if the given MIME is a JSON MIME.
|
132
|
+
# JSON MIME examples:
|
133
|
+
# application/json
|
134
|
+
# application/json; charset=UTF8
|
135
|
+
# APPLICATION/JSON
|
136
|
+
# */*
|
137
|
+
# @param [String] mime MIME
|
138
|
+
# @return [Boolean] True if the MIME is application/json
|
139
|
+
def json_mime?(mime)
|
140
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
141
|
+
end
|
142
|
+
|
143
|
+
# Deserialize the response to the given return type.
|
144
|
+
#
|
145
|
+
# @param [Response] response HTTP response
|
146
|
+
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
147
|
+
def deserialize(response, return_type)
|
148
|
+
body = response.body
|
149
|
+
|
150
|
+
# handle file downloading - return the File instance processed in request callbacks
|
151
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
152
|
+
return @tempfile if return_type == 'File'
|
153
|
+
|
154
|
+
return nil if body.nil? || body.empty?
|
155
|
+
|
156
|
+
# return response body directly for String return type
|
157
|
+
return body if return_type == 'String'
|
158
|
+
|
159
|
+
# ensuring a default content type
|
160
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
161
|
+
|
162
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
163
|
+
|
164
|
+
begin
|
165
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
166
|
+
rescue JSON::ParserError => e
|
167
|
+
if %w(String Date DateTime).include?(return_type)
|
168
|
+
data = body
|
169
|
+
else
|
170
|
+
raise e
|
171
|
+
end
|
172
|
+
end
|
173
|
+
|
174
|
+
convert_to_type data, return_type
|
175
|
+
end
|
176
|
+
|
177
|
+
# Convert data to the given return type.
|
178
|
+
# @param [Object] data Data to be converted
|
179
|
+
# @param [String] return_type Return type
|
180
|
+
# @return [Mixed] Data in a particular type
|
181
|
+
def convert_to_type(data, return_type)
|
182
|
+
return nil if data.nil?
|
183
|
+
case return_type
|
184
|
+
when 'String'
|
185
|
+
data.to_s
|
186
|
+
when 'Integer'
|
187
|
+
data.to_i
|
188
|
+
when 'Float'
|
189
|
+
data.to_f
|
190
|
+
when 'BOOLEAN'
|
191
|
+
data == true
|
192
|
+
when 'DateTime'
|
193
|
+
# parse date time (expecting ISO 8601 format)
|
194
|
+
DateTime.parse data
|
195
|
+
when 'Date'
|
196
|
+
# parse date time (expecting ISO 8601 format)
|
197
|
+
Date.parse data
|
198
|
+
when 'Object'
|
199
|
+
# generic object (usually a Hash), return directly
|
200
|
+
data
|
201
|
+
when /\AArray<(.+)>\z/
|
202
|
+
# e.g. Array<Pet>
|
203
|
+
sub_type = $1
|
204
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
205
|
+
when /\AHash\<String, (.+)\>\z/
|
206
|
+
# e.g. Hash<String, Integer>
|
207
|
+
sub_type = $1
|
208
|
+
{}.tap do |hash|
|
209
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
210
|
+
end
|
211
|
+
else
|
212
|
+
# models, e.g. Pet
|
213
|
+
ApproveAPISwagger.const_get(return_type).build_from_hash(data)
|
214
|
+
end
|
215
|
+
end
|
216
|
+
|
217
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
218
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
219
|
+
# The response body is written to the file in chunks in order to handle files which
|
220
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
221
|
+
# process can use.
|
222
|
+
#
|
223
|
+
# @see Configuration#temp_folder_path
|
224
|
+
def download_file(request)
|
225
|
+
tempfile = nil
|
226
|
+
encoding = nil
|
227
|
+
request.on_headers do |response|
|
228
|
+
content_disposition = response.headers['Content-Disposition']
|
229
|
+
if content_disposition && content_disposition =~ /filename=/i
|
230
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
231
|
+
prefix = sanitize_filename(filename)
|
232
|
+
else
|
233
|
+
prefix = 'download-'
|
234
|
+
end
|
235
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
236
|
+
encoding = response.body.encoding
|
237
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
238
|
+
@tempfile = tempfile
|
239
|
+
end
|
240
|
+
request.on_body do |chunk|
|
241
|
+
chunk.force_encoding(encoding)
|
242
|
+
tempfile.write(chunk)
|
243
|
+
end
|
244
|
+
request.on_complete do |response|
|
245
|
+
tempfile.close if tempfile
|
246
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
247
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
248
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
249
|
+
"explicitly with `tempfile.delete`"
|
250
|
+
end
|
251
|
+
end
|
252
|
+
|
253
|
+
# Sanitize filename by removing path.
|
254
|
+
# e.g. ../../sun.gif becomes sun.gif
|
255
|
+
#
|
256
|
+
# @param [String] filename the filename to be sanitized
|
257
|
+
# @return [String] the sanitized filename
|
258
|
+
def sanitize_filename(filename)
|
259
|
+
filename.gsub(/.*[\/\\]/, '')
|
260
|
+
end
|
261
|
+
|
262
|
+
def build_request_url(path)
|
263
|
+
# Add leading and trailing slashes to path
|
264
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
265
|
+
URI.encode(@config.base_url + path)
|
266
|
+
end
|
267
|
+
|
268
|
+
# Builds the HTTP request body
|
269
|
+
#
|
270
|
+
# @param [Hash] header_params Header parameters
|
271
|
+
# @param [Hash] form_params Query parameters
|
272
|
+
# @param [Object] body HTTP body (JSON/XML)
|
273
|
+
# @return [String] HTTP body data in the form of string
|
274
|
+
def build_request_body(header_params, form_params, body)
|
275
|
+
# http form
|
276
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
277
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
278
|
+
data = {}
|
279
|
+
form_params.each do |key, value|
|
280
|
+
case value
|
281
|
+
when ::File, ::Array, nil
|
282
|
+
# let typhoeus handle File, Array and nil parameters
|
283
|
+
data[key] = value
|
284
|
+
else
|
285
|
+
data[key] = value.to_s
|
286
|
+
end
|
287
|
+
end
|
288
|
+
elsif body
|
289
|
+
data = body.is_a?(String) ? body : body.to_json
|
290
|
+
else
|
291
|
+
data = nil
|
292
|
+
end
|
293
|
+
data
|
294
|
+
end
|
295
|
+
|
296
|
+
# Update hearder and query params based on authentication settings.
|
297
|
+
#
|
298
|
+
# @param [Hash] header_params Header parameters
|
299
|
+
# @param [Hash] query_params Query parameters
|
300
|
+
# @param [String] auth_names Authentication scheme name
|
301
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
302
|
+
Array(auth_names).each do |auth_name|
|
303
|
+
auth_setting = @config.auth_settings[auth_name]
|
304
|
+
next unless auth_setting
|
305
|
+
case auth_setting[:in]
|
306
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
307
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
308
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
309
|
+
end
|
310
|
+
end
|
311
|
+
end
|
312
|
+
|
313
|
+
# Sets user agent in HTTP header
|
314
|
+
#
|
315
|
+
# @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
|
316
|
+
def user_agent=(user_agent)
|
317
|
+
@user_agent = user_agent
|
318
|
+
@default_headers['User-Agent'] = @user_agent
|
319
|
+
end
|
320
|
+
|
321
|
+
# Return Accept header based on an array of accepts provided.
|
322
|
+
# @param [Array] accepts array for Accept
|
323
|
+
# @return [String] the Accept header (e.g. application/json)
|
324
|
+
def select_header_accept(accepts)
|
325
|
+
return nil if accepts.nil? || accepts.empty?
|
326
|
+
# use JSON when present, otherwise use all of the provided
|
327
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
328
|
+
json_accept || accepts.join(',')
|
329
|
+
end
|
330
|
+
|
331
|
+
# Return Content-Type header based on an array of content types provided.
|
332
|
+
# @param [Array] content_types array for Content-Type
|
333
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
334
|
+
def select_header_content_type(content_types)
|
335
|
+
# use application/json by default
|
336
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
337
|
+
# use JSON when present, otherwise use the first one
|
338
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
339
|
+
json_content_type || content_types.first
|
340
|
+
end
|
341
|
+
|
342
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
343
|
+
# @param [Object] model object to be converted into JSON string
|
344
|
+
# @return [String] JSON string representation of the object
|
345
|
+
def object_to_http_body(model)
|
346
|
+
return model if model.nil? || model.is_a?(String)
|
347
|
+
local_body = nil
|
348
|
+
if model.is_a?(Array)
|
349
|
+
local_body = model.map { |m| object_to_hash(m) }
|
350
|
+
else
|
351
|
+
local_body = object_to_hash(model)
|
352
|
+
end
|
353
|
+
local_body.to_json
|
354
|
+
end
|
355
|
+
|
356
|
+
# Convert object(non-array) to hash.
|
357
|
+
# @param [Object] obj object to be converted into JSON string
|
358
|
+
# @return [String] JSON string representation of the object
|
359
|
+
def object_to_hash(obj)
|
360
|
+
if obj.respond_to?(:to_hash)
|
361
|
+
obj.to_hash
|
362
|
+
else
|
363
|
+
obj
|
364
|
+
end
|
365
|
+
end
|
366
|
+
|
367
|
+
# Build parameter value according to the given collection format.
|
368
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
369
|
+
def build_collection_param(param, collection_format)
|
370
|
+
case collection_format
|
371
|
+
when :csv
|
372
|
+
param.join(',')
|
373
|
+
when :ssv
|
374
|
+
param.join(' ')
|
375
|
+
when :tsv
|
376
|
+
param.join("\t")
|
377
|
+
when :pipes
|
378
|
+
param.join('|')
|
379
|
+
when :multi
|
380
|
+
# return the array directly as typhoeus will handle it as expected
|
381
|
+
param
|
382
|
+
else
|
383
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
384
|
+
end
|
385
|
+
end
|
386
|
+
end
|
387
|
+
end
|