tapyrus-api-client 0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +68 -0
- data/README.md +183 -0
- data/Rakefile +10 -0
- data/docs/AddTimestampRequest.md +20 -0
- data/docs/AddressApi.md +142 -0
- data/docs/CreateUserRequest.md +24 -0
- data/docs/GetAddressesResponse.md +20 -0
- data/docs/GetTokensResponse.md +20 -0
- data/docs/IssueTokenRequest.md +20 -0
- data/docs/PaymentApi.md +76 -0
- data/docs/PaymentRequest.md +22 -0
- data/docs/PaymentResponse.md +18 -0
- data/docs/ReissueTokenRequest.md +18 -0
- data/docs/TimestampApi.md +139 -0
- data/docs/TokenApi.md +355 -0
- data/docs/TokenResponse.md +20 -0
- data/docs/TransferTokenRequest.md +20 -0
- data/docs/UserApi.md +140 -0
- data/docs/UserinfoResponse.md +22 -0
- data/docs/UserinfoResponseBalances.md +18 -0
- data/git_push.sh +58 -0
- data/lib/tapyrus-api-client.rb +56 -0
- data/lib/tapyrus-api-client/api/address_api.rb +142 -0
- data/lib/tapyrus-api-client/api/payment_api.rb +83 -0
- data/lib/tapyrus-api-client/api/timestamp_api.rb +138 -0
- data/lib/tapyrus-api-client/api/token_api.rb +345 -0
- data/lib/tapyrus-api-client/api/user_api.rb +145 -0
- data/lib/tapyrus-api-client/api_client.rb +389 -0
- data/lib/tapyrus-api-client/api_error.rb +57 -0
- data/lib/tapyrus-api-client/configuration.rb +270 -0
- data/lib/tapyrus-api-client/models/add_timestamp_request.rb +232 -0
- data/lib/tapyrus-api-client/models/create_user_request.rb +269 -0
- data/lib/tapyrus-api-client/models/get_addresses_response.rb +229 -0
- data/lib/tapyrus-api-client/models/get_tokens_response.rb +227 -0
- data/lib/tapyrus-api-client/models/issue_token_request.rb +232 -0
- data/lib/tapyrus-api-client/models/payment_request.rb +246 -0
- data/lib/tapyrus-api-client/models/payment_response.rb +218 -0
- data/lib/tapyrus-api-client/models/reissue_token_request.rb +223 -0
- data/lib/tapyrus-api-client/models/token_response.rb +227 -0
- data/lib/tapyrus-api-client/models/transfer_token_request.rb +232 -0
- data/lib/tapyrus-api-client/models/userinfo_response.rb +238 -0
- data/lib/tapyrus-api-client/models/userinfo_response_balances.rb +218 -0
- data/lib/tapyrus-api-client/version.rb +15 -0
- data/spec/api/address_api_spec.rb +59 -0
- data/spec/api/payment_api_spec.rb +47 -0
- data/spec/api/timestamp_api_spec.rb +58 -0
- data/spec/api/token_api_spec.rb +98 -0
- data/spec/api/user_api_spec.rb +59 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/add_timestamp_request_spec.rb +40 -0
- data/spec/models/create_user_request_spec.rb +52 -0
- data/spec/models/get_addresses_response_spec.rb +40 -0
- data/spec/models/get_tokens_response_spec.rb +40 -0
- data/spec/models/issue_token_request_spec.rb +40 -0
- data/spec/models/payment_request_spec.rb +46 -0
- data/spec/models/payment_response_spec.rb +34 -0
- data/spec/models/reissue_token_request_spec.rb +34 -0
- data/spec/models/token_response_spec.rb +40 -0
- data/spec/models/transfer_token_request_spec.rb +40 -0
- data/spec/models/userinfo_response_balances_spec.rb +34 -0
- data/spec/models/userinfo_response_spec.rb +46 -0
- data/spec/spec_helper.rb +111 -0
- data/tapyrus-api-client.gemspec +38 -0
- metadata +192 -0
@@ -0,0 +1,145 @@
|
|
1
|
+
=begin
|
2
|
+
#Tapyrus API
|
3
|
+
|
4
|
+
## イントロダクション これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。 現在以下のユースケースをサポートしています。これは今後も拡張されていくことを予定しています。 * Payment: TPC(Tapyrus Coin) の送金 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 Tapyrus ブロックチェーンについては以下の情報を参照してください。 * [Chaintope のブロックチェーンプロトコル](https://www.chaintope.com/chaintope-blockchain-protocol/) * [chaintope/tapyrus-core - github](https://github.com/chaintope/tapyrus-core) ## Tapyrus API の利用法 Tapyrus API は REST API として提供されています。利用を開始するためには、Tapyrus API の `エンドポイント` に対して、 `認証` 済みの トークンを使いアクセスする必要があります。また、認証されたユーザはそれぞれが自身のウォレットを Tapyrus API 内部に持つことになります。 ウォレットではそのユーザの TPC やトークンといったアセットを管理するための鍵が管理され、アセットの移動などで利用されます。 ### Tapyrus API のエンドポイント エンドポイントは以下のフォーマットで作成され、 chaintope より提供されます。 `ap-01.tapyrus.chaintope.com` 例えば [testnet](https://testnet-explorer.tapyrus.dev.chaintope.com/blocks) では以下のようになります。 `testnet-api.tapyrus.chaintope.com` testnet は誰でも利用可能な動作の確認用のネットワークであり、予告なくリセットされる可能性があります。 利用に必要な TPC は [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) から取得できます。 * [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) ### OpenID Connect を使った認証 Tapyrus API では [OpenID Connect](https://openid.net/connect/) を使った認証をサポートします。この認証を利用するためには、 以下のステップを踏みます。 1. 利用する OpenID Provider(OP) を選択する 公開された OP から選択する方法と、自身で OP を構築する方法があります。独自のユーザデータベースがあり、そのユーザに Tapyrus API を利用させる場合は後者の自身で OP を構築する方法を選択することになります。 2. OAuth 2.0 Client Credential を入手する 多くの公開された OP では、アプリケーションを登録して Client Credential を入手する必要があります。手順は利用する OP に従ってください。 3. Access Token と ID Token を入手する OpenID Connect に沿った認証を行い、 token エンドポイントから ID Token を入手します。 4. Tapyrus API ユーザを作成する 入手した Access Token と ID Token を Tapyrus API の [createUser API](https://doc.api.tapyrus.chaintope.com/#operation/createUser) へ送り、 Tapyrus API のユーザを作成します。 コード例を後述の Getting Started ドキュメントで解説していますので、そちらを参照してください。 ## Tapyrus API ユーザとウォレットについて 認証により得たアクセストークンを使い、Tapyrus API ユーザを1つ作成する必要があります。 Tapyrus API の内部では、このユーザ1つにつき1つのウォレットが作成されます。 ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されており、同時にそれらのカギに紐づくアセットも管理されます。 そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 # Getting Started Getting Started ドキュメントでは実際のコード例を交えながらより具体的な Tapyrus API の利用法を解説しています。 * [Getting Started - [Javascript] Tapyrus API を利用するウェブアプリケーションの開発を学ぶ](https://github.com/chaintope/tapyrus-api-client-examples/tree/main/javascript/GettingStarted-ja.md)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.2.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module TapyrusApiClient
|
16
|
+
class UserApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# ユーザを作成します。
|
23
|
+
# OpenID Connect を使った認証で得た id_token と access_token を Tapyrus API へ登録しユーザを作成します。すでにユーザが存在する場合は認証情報を更新します。
|
24
|
+
# @param create_user_request [CreateUserRequest]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [nil]
|
27
|
+
def create_user(create_user_request, opts = {})
|
28
|
+
create_user_with_http_info(create_user_request, opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# ユーザを作成します。
|
33
|
+
# OpenID Connect を使った認証で得た id_token と access_token を Tapyrus API へ登録しユーザを作成します。すでにユーザが存在する場合は認証情報を更新します。
|
34
|
+
# @param create_user_request [CreateUserRequest]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
37
|
+
def create_user_with_http_info(create_user_request, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: UserApi.create_user ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'create_user_request' is set
|
42
|
+
if @api_client.config.client_side_validation && create_user_request.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'create_user_request' when calling UserApi.create_user"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/users'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Content-Type'
|
54
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
55
|
+
|
56
|
+
# form parameters
|
57
|
+
form_params = opts[:form_params] || {}
|
58
|
+
|
59
|
+
# http body (model)
|
60
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_user_request)
|
61
|
+
|
62
|
+
# return_type
|
63
|
+
return_type = opts[:debug_return_type]
|
64
|
+
|
65
|
+
# auth_names
|
66
|
+
auth_names = opts[:debug_auth_names] || []
|
67
|
+
|
68
|
+
new_options = opts.merge(
|
69
|
+
:operation => :"UserApi.create_user",
|
70
|
+
:header_params => header_params,
|
71
|
+
:query_params => query_params,
|
72
|
+
:form_params => form_params,
|
73
|
+
:body => post_body,
|
74
|
+
:auth_names => auth_names,
|
75
|
+
:return_type => return_type
|
76
|
+
)
|
77
|
+
|
78
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
79
|
+
if @api_client.config.debugging
|
80
|
+
@api_client.config.logger.debug "API called: UserApi#create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
81
|
+
end
|
82
|
+
return data, status_code, headers
|
83
|
+
end
|
84
|
+
|
85
|
+
# ユーザの情報を返します。
|
86
|
+
# ユーザの`id`,`balance`, `address`の情報を返します。
|
87
|
+
# @param [Hash] opts the optional parameters
|
88
|
+
# @option opts [Boolean] :confirmation_only オプションで`confirmation_only`を設定でき、`true`の場合ブロックチェーン上で承認済みのtpc・トークンのみを取得し、`false`の場合未承認のtpc・トークンも含めて取得します。デフォルトは`true`です。
|
89
|
+
# @return [UserinfoResponse]
|
90
|
+
def get_user_info(opts = {})
|
91
|
+
data, _status_code, _headers = get_user_info_with_http_info(opts)
|
92
|
+
data
|
93
|
+
end
|
94
|
+
|
95
|
+
# ユーザの情報を返します。
|
96
|
+
# ユーザの`id`,`balance`, `address`の情報を返します。
|
97
|
+
# @param [Hash] opts the optional parameters
|
98
|
+
# @option opts [Boolean] :confirmation_only オプションで`confirmation_only`を設定でき、`true`の場合ブロックチェーン上で承認済みのtpc・トークンのみを取得し、`false`の場合未承認のtpc・トークンも含めて取得します。デフォルトは`true`です。
|
99
|
+
# @return [Array<(UserinfoResponse, Integer, Hash)>] UserinfoResponse data, response status code and response headers
|
100
|
+
def get_user_info_with_http_info(opts = {})
|
101
|
+
if @api_client.config.debugging
|
102
|
+
@api_client.config.logger.debug 'Calling API: UserApi.get_user_info ...'
|
103
|
+
end
|
104
|
+
# resource path
|
105
|
+
local_var_path = '/userinfo'
|
106
|
+
|
107
|
+
# query parameters
|
108
|
+
query_params = opts[:query_params] || {}
|
109
|
+
query_params[:'confirmation_only'] = opts[:'confirmation_only'] if !opts[:'confirmation_only'].nil?
|
110
|
+
|
111
|
+
# header parameters
|
112
|
+
header_params = opts[:header_params] || {}
|
113
|
+
# HTTP header 'Accept' (if needed)
|
114
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
115
|
+
|
116
|
+
# form parameters
|
117
|
+
form_params = opts[:form_params] || {}
|
118
|
+
|
119
|
+
# http body (model)
|
120
|
+
post_body = opts[:debug_body]
|
121
|
+
|
122
|
+
# return_type
|
123
|
+
return_type = opts[:debug_return_type] || 'UserinfoResponse'
|
124
|
+
|
125
|
+
# auth_names
|
126
|
+
auth_names = opts[:debug_auth_names] || []
|
127
|
+
|
128
|
+
new_options = opts.merge(
|
129
|
+
:operation => :"UserApi.get_user_info",
|
130
|
+
:header_params => header_params,
|
131
|
+
:query_params => query_params,
|
132
|
+
:form_params => form_params,
|
133
|
+
:body => post_body,
|
134
|
+
:auth_names => auth_names,
|
135
|
+
:return_type => return_type
|
136
|
+
)
|
137
|
+
|
138
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
139
|
+
if @api_client.config.debugging
|
140
|
+
@api_client.config.logger.debug "API called: UserApi#get_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
141
|
+
end
|
142
|
+
return data, status_code, headers
|
143
|
+
end
|
144
|
+
end
|
145
|
+
end
|
@@ -0,0 +1,389 @@
|
|
1
|
+
=begin
|
2
|
+
#Tapyrus API
|
3
|
+
|
4
|
+
## イントロダクション これは chaintope 社が開発するブロックチェーン Tapyrus を使ったブロックチェーンに関係する機能を簡単に利用するための REST API です。 現在以下のユースケースをサポートしています。これは今後も拡張されていくことを予定しています。 * Payment: TPC(Tapyrus Coin) の送金 * Timestamp: 任意のデータをタイムスタンプとしてブロックチェーンに記録 * Token: 新しいトークンの発行、送金、焼却。NFTも利用可能 Tapyrus ブロックチェーンについては以下の情報を参照してください。 * [Chaintope のブロックチェーンプロトコル](https://www.chaintope.com/chaintope-blockchain-protocol/) * [chaintope/tapyrus-core - github](https://github.com/chaintope/tapyrus-core) ## Tapyrus API の利用法 Tapyrus API は REST API として提供されています。利用を開始するためには、Tapyrus API の `エンドポイント` に対して、 `認証` 済みの トークンを使いアクセスする必要があります。また、認証されたユーザはそれぞれが自身のウォレットを Tapyrus API 内部に持つことになります。 ウォレットではそのユーザの TPC やトークンといったアセットを管理するための鍵が管理され、アセットの移動などで利用されます。 ### Tapyrus API のエンドポイント エンドポイントは以下のフォーマットで作成され、 chaintope より提供されます。 `ap-01.tapyrus.chaintope.com` 例えば [testnet](https://testnet-explorer.tapyrus.dev.chaintope.com/blocks) では以下のようになります。 `testnet-api.tapyrus.chaintope.com` testnet は誰でも利用可能な動作の確認用のネットワークであり、予告なくリセットされる可能性があります。 利用に必要な TPC は [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) から取得できます。 * [faucet](https://testnet-faucet.tapyrus.dev.chaintope.com) ### OpenID Connect を使った認証 Tapyrus API では [OpenID Connect](https://openid.net/connect/) を使った認証をサポートします。この認証を利用するためには、 以下のステップを踏みます。 1. 利用する OpenID Provider(OP) を選択する 公開された OP から選択する方法と、自身で OP を構築する方法があります。独自のユーザデータベースがあり、そのユーザに Tapyrus API を利用させる場合は後者の自身で OP を構築する方法を選択することになります。 2. OAuth 2.0 Client Credential を入手する 多くの公開された OP では、アプリケーションを登録して Client Credential を入手する必要があります。手順は利用する OP に従ってください。 3. Access Token と ID Token を入手する OpenID Connect に沿った認証を行い、 token エンドポイントから ID Token を入手します。 4. Tapyrus API ユーザを作成する 入手した Access Token と ID Token を Tapyrus API の [createUser API](https://doc.api.tapyrus.chaintope.com/#operation/createUser) へ送り、 Tapyrus API のユーザを作成します。 コード例を後述の Getting Started ドキュメントで解説していますので、そちらを参照してください。 ## Tapyrus API ユーザとウォレットについて 認証により得たアクセストークンを使い、Tapyrus API ユーザを1つ作成する必要があります。 Tapyrus API の内部では、このユーザ1つにつき1つのウォレットが作成されます。 ウォレットではアセットの受け取りや、送付に必要な公開鍵と秘密鍵のペアが管理されており、同時にそれらのカギに紐づくアセットも管理されます。 そのため、認証を行ったユーザごとに独立したアセットの管理が可能になります。 # Getting Started Getting Started ドキュメントでは実際のコード例を交えながらより具体的な Tapyrus API の利用法を解説しています。 * [Getting Started - [Javascript] Tapyrus API を利用するウェブアプリケーションの開発を学ぶ](https://github.com/chaintope/tapyrus-api-client-examples/tree/main/javascript/GettingStarted-ja.md)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.2.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'json'
|
15
|
+
require 'logger'
|
16
|
+
require 'tempfile'
|
17
|
+
require 'time'
|
18
|
+
require 'typhoeus'
|
19
|
+
|
20
|
+
module TapyrusApiClient
|
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, Integer, 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, opts)
|
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
|
+
|
98
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
99
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
100
|
+
|
101
|
+
req_opts = {
|
102
|
+
:method => http_method,
|
103
|
+
:headers => header_params,
|
104
|
+
:params => query_params,
|
105
|
+
:params_encoding => @config.params_encoding,
|
106
|
+
:timeout => @config.timeout,
|
107
|
+
:ssl_verifypeer => @config.verify_ssl,
|
108
|
+
:ssl_verifyhost => _verify_ssl_host,
|
109
|
+
:sslcert => @config.cert_file,
|
110
|
+
:sslkey => @config.key_file,
|
111
|
+
:verbose => @config.debugging
|
112
|
+
}
|
113
|
+
|
114
|
+
# set custom cert, if provided
|
115
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
116
|
+
|
117
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
118
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
119
|
+
req_opts.update :body => req_body
|
120
|
+
if @config.debugging
|
121
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
122
|
+
end
|
123
|
+
end
|
124
|
+
|
125
|
+
request = Typhoeus::Request.new(url, req_opts)
|
126
|
+
download_file(request) if opts[:return_type] == 'File'
|
127
|
+
request
|
128
|
+
end
|
129
|
+
|
130
|
+
# Builds the HTTP request body
|
131
|
+
#
|
132
|
+
# @param [Hash] header_params Header parameters
|
133
|
+
# @param [Hash] form_params Query parameters
|
134
|
+
# @param [Object] body HTTP body (JSON/XML)
|
135
|
+
# @return [String] HTTP body data in the form of string
|
136
|
+
def build_request_body(header_params, form_params, body)
|
137
|
+
# http form
|
138
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
139
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
140
|
+
data = {}
|
141
|
+
form_params.each do |key, value|
|
142
|
+
case value
|
143
|
+
when ::File, ::Array, nil
|
144
|
+
# let typhoeus handle File, Array and nil parameters
|
145
|
+
data[key] = value
|
146
|
+
else
|
147
|
+
data[key] = value.to_s
|
148
|
+
end
|
149
|
+
end
|
150
|
+
elsif body
|
151
|
+
data = body.is_a?(String) ? body : body.to_json
|
152
|
+
else
|
153
|
+
data = nil
|
154
|
+
end
|
155
|
+
data
|
156
|
+
end
|
157
|
+
|
158
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
159
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
160
|
+
# The response body is written to the file in chunks in order to handle files which
|
161
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
162
|
+
# process can use.
|
163
|
+
#
|
164
|
+
# @see Configuration#temp_folder_path
|
165
|
+
def download_file(request)
|
166
|
+
tempfile = nil
|
167
|
+
encoding = nil
|
168
|
+
request.on_headers do |response|
|
169
|
+
content_disposition = response.headers['Content-Disposition']
|
170
|
+
if content_disposition && content_disposition =~ /filename=/i
|
171
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
172
|
+
prefix = sanitize_filename(filename)
|
173
|
+
else
|
174
|
+
prefix = 'download-'
|
175
|
+
end
|
176
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
177
|
+
encoding = response.body.encoding
|
178
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
179
|
+
@tempfile = tempfile
|
180
|
+
end
|
181
|
+
request.on_body do |chunk|
|
182
|
+
chunk.force_encoding(encoding)
|
183
|
+
tempfile.write(chunk)
|
184
|
+
end
|
185
|
+
request.on_complete do |response|
|
186
|
+
if tempfile
|
187
|
+
tempfile.close
|
188
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
189
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
190
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
191
|
+
"explicitly with `tempfile.delete`"
|
192
|
+
end
|
193
|
+
end
|
194
|
+
end
|
195
|
+
|
196
|
+
# Check if the given MIME is a JSON MIME.
|
197
|
+
# JSON MIME examples:
|
198
|
+
# application/json
|
199
|
+
# application/json; charset=UTF8
|
200
|
+
# APPLICATION/JSON
|
201
|
+
# */*
|
202
|
+
# @param [String] mime MIME
|
203
|
+
# @return [Boolean] True if the MIME is application/json
|
204
|
+
def json_mime?(mime)
|
205
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
206
|
+
end
|
207
|
+
|
208
|
+
# Deserialize the response to the given return type.
|
209
|
+
#
|
210
|
+
# @param [Response] response HTTP response
|
211
|
+
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
212
|
+
def deserialize(response, return_type)
|
213
|
+
body = response.body
|
214
|
+
|
215
|
+
# handle file downloading - return the File instance processed in request callbacks
|
216
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
217
|
+
return @tempfile if return_type == 'File'
|
218
|
+
|
219
|
+
return nil if body.nil? || body.empty?
|
220
|
+
|
221
|
+
# return response body directly for String return type
|
222
|
+
return body if return_type == 'String'
|
223
|
+
|
224
|
+
# ensuring a default content type
|
225
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
226
|
+
|
227
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
228
|
+
|
229
|
+
begin
|
230
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
231
|
+
rescue JSON::ParserError => e
|
232
|
+
if %w(String Date Time).include?(return_type)
|
233
|
+
data = body
|
234
|
+
else
|
235
|
+
raise e
|
236
|
+
end
|
237
|
+
end
|
238
|
+
|
239
|
+
convert_to_type data, return_type
|
240
|
+
end
|
241
|
+
|
242
|
+
# Convert data to the given return type.
|
243
|
+
# @param [Object] data Data to be converted
|
244
|
+
# @param [String] return_type Return type
|
245
|
+
# @return [Mixed] Data in a particular type
|
246
|
+
def convert_to_type(data, return_type)
|
247
|
+
return nil if data.nil?
|
248
|
+
case return_type
|
249
|
+
when 'String'
|
250
|
+
data.to_s
|
251
|
+
when 'Integer'
|
252
|
+
data.to_i
|
253
|
+
when 'Float'
|
254
|
+
data.to_f
|
255
|
+
when 'Boolean'
|
256
|
+
data == true
|
257
|
+
when 'Time'
|
258
|
+
# parse date time (expecting ISO 8601 format)
|
259
|
+
Time.parse data
|
260
|
+
when 'Date'
|
261
|
+
# parse date time (expecting ISO 8601 format)
|
262
|
+
Date.parse data
|
263
|
+
when 'Object'
|
264
|
+
# generic object (usually a Hash), return directly
|
265
|
+
data
|
266
|
+
when /\AArray<(.+)>\z/
|
267
|
+
# e.g. Array<Pet>
|
268
|
+
sub_type = $1
|
269
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
270
|
+
when /\AHash\<String, (.+)\>\z/
|
271
|
+
# e.g. Hash<String, Integer>
|
272
|
+
sub_type = $1
|
273
|
+
{}.tap do |hash|
|
274
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
275
|
+
end
|
276
|
+
else
|
277
|
+
# models (e.g. Pet) or oneOf
|
278
|
+
klass = TapyrusApiClient.const_get(return_type)
|
279
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
|
280
|
+
end
|
281
|
+
end
|
282
|
+
|
283
|
+
# Sanitize filename by removing path.
|
284
|
+
# e.g. ../../sun.gif becomes sun.gif
|
285
|
+
#
|
286
|
+
# @param [String] filename the filename to be sanitized
|
287
|
+
# @return [String] the sanitized filename
|
288
|
+
def sanitize_filename(filename)
|
289
|
+
filename.gsub(/.*[\/\\]/, '')
|
290
|
+
end
|
291
|
+
|
292
|
+
def build_request_url(path, opts = {})
|
293
|
+
# Add leading and trailing slashes to path
|
294
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
295
|
+
@config.base_url(opts[:operation]) + path
|
296
|
+
end
|
297
|
+
|
298
|
+
# Update hearder and query params based on authentication settings.
|
299
|
+
#
|
300
|
+
# @param [Hash] header_params Header parameters
|
301
|
+
# @param [Hash] query_params Query parameters
|
302
|
+
# @param [String] auth_names Authentication scheme name
|
303
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
304
|
+
Array(auth_names).each do |auth_name|
|
305
|
+
auth_setting = @config.auth_settings[auth_name]
|
306
|
+
next unless auth_setting
|
307
|
+
case auth_setting[:in]
|
308
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
309
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
310
|
+
else fail ArgumentError, 'Authentication token must be in `query` or `header`'
|
311
|
+
end
|
312
|
+
end
|
313
|
+
end
|
314
|
+
|
315
|
+
# Sets user agent in HTTP header
|
316
|
+
#
|
317
|
+
# @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
|
318
|
+
def user_agent=(user_agent)
|
319
|
+
@user_agent = user_agent
|
320
|
+
@default_headers['User-Agent'] = @user_agent
|
321
|
+
end
|
322
|
+
|
323
|
+
# Return Accept header based on an array of accepts provided.
|
324
|
+
# @param [Array] accepts array for Accept
|
325
|
+
# @return [String] the Accept header (e.g. application/json)
|
326
|
+
def select_header_accept(accepts)
|
327
|
+
return nil if accepts.nil? || accepts.empty?
|
328
|
+
# use JSON when present, otherwise use all of the provided
|
329
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
330
|
+
json_accept || accepts.join(',')
|
331
|
+
end
|
332
|
+
|
333
|
+
# Return Content-Type header based on an array of content types provided.
|
334
|
+
# @param [Array] content_types array for Content-Type
|
335
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
336
|
+
def select_header_content_type(content_types)
|
337
|
+
# use application/json by default
|
338
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
339
|
+
# use JSON when present, otherwise use the first one
|
340
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
341
|
+
json_content_type || content_types.first
|
342
|
+
end
|
343
|
+
|
344
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
345
|
+
# @param [Object] model object to be converted into JSON string
|
346
|
+
# @return [String] JSON string representation of the object
|
347
|
+
def object_to_http_body(model)
|
348
|
+
return model if model.nil? || model.is_a?(String)
|
349
|
+
local_body = nil
|
350
|
+
if model.is_a?(Array)
|
351
|
+
local_body = model.map { |m| object_to_hash(m) }
|
352
|
+
else
|
353
|
+
local_body = object_to_hash(model)
|
354
|
+
end
|
355
|
+
local_body.to_json
|
356
|
+
end
|
357
|
+
|
358
|
+
# Convert object(non-array) to hash.
|
359
|
+
# @param [Object] obj object to be converted into JSON string
|
360
|
+
# @return [String] JSON string representation of the object
|
361
|
+
def object_to_hash(obj)
|
362
|
+
if obj.respond_to?(:to_hash)
|
363
|
+
obj.to_hash
|
364
|
+
else
|
365
|
+
obj
|
366
|
+
end
|
367
|
+
end
|
368
|
+
|
369
|
+
# Build parameter value according to the given collection format.
|
370
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
371
|
+
def build_collection_param(param, collection_format)
|
372
|
+
case collection_format
|
373
|
+
when :csv
|
374
|
+
param.join(',')
|
375
|
+
when :ssv
|
376
|
+
param.join(' ')
|
377
|
+
when :tsv
|
378
|
+
param.join("\t")
|
379
|
+
when :pipes
|
380
|
+
param.join('|')
|
381
|
+
when :multi
|
382
|
+
# return the array directly as typhoeus will handle it as expected
|
383
|
+
param
|
384
|
+
else
|
385
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
386
|
+
end
|
387
|
+
end
|
388
|
+
end
|
389
|
+
end
|