tca_client 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 +9 -0
- data/README.md +862 -0
- data/Rakefile +8 -0
- data/docs/AddGroupAttachmentRequest.md +8 -0
- data/docs/AddGroupAttachmentResponse.md +7 -0
- data/docs/AggregateGroup.md +12 -0
- data/docs/AuthorMetadataOverride.md +8 -0
- data/docs/EULAApi.md +241 -0
- data/docs/Error.md +8 -0
- data/docs/Eula.md +9 -0
- data/docs/EulaAcceptListItem.md +10 -0
- data/docs/EulaAcceptRequest.md +10 -0
- data/docs/EulaVersion.md +11 -0
- data/docs/FeaturesApi.md +61 -0
- data/docs/FeaturesEnabled.md +10 -0
- data/docs/FeaturesGenerationSettings.md +8 -0
- data/docs/FeaturesSimilarity.md +9 -0
- data/docs/FeaturesSimilarityViewSettings.md +19 -0
- data/docs/FeaturesTenant.md +7 -0
- data/docs/FeaturesViewerModes.md +8 -0
- data/docs/Group.md +9 -0
- data/docs/GroupAttachmentResponse.md +10 -0
- data/docs/GroupContext.md +9 -0
- data/docs/GroupsApi.md +472 -0
- data/docs/IndexApi.md +119 -0
- data/docs/IndexStateSettings.md +7 -0
- data/docs/IndexingSettings.md +7 -0
- data/docs/InlineResponse200.md +7 -0
- data/docs/PdfStatusResponse.md +7 -0
- data/docs/RateLimitError.md +8 -0
- data/docs/RequestPdfResponse.md +7 -0
- data/docs/Sidebar.md +7 -0
- data/docs/SimilarityApi.md +351 -0
- data/docs/SimilarityGenerationSettings.md +10 -0
- data/docs/SimilarityMetadata.md +16 -0
- data/docs/SimilarityMetadataTopMatches.md +13 -0
- data/docs/SimilarityPutRequest.md +9 -0
- data/docs/SimilarityScoreData.md +10 -0
- data/docs/SimilaritySettings.md +9 -0
- data/docs/SimilaritySettingsModes.md +8 -0
- data/docs/SimilaritySettingsViewSettings.md +7 -0
- data/docs/SimilarityViewSettings.md +19 -0
- data/docs/SimilarityViewerUrlResponse.md +7 -0
- data/docs/SimilarityViewerUrlSettings.md +14 -0
- data/docs/SimpleSubmissionResponse.md +6 -0
- data/docs/Submission.md +6 -0
- data/docs/SubmissionApi.md +296 -0
- data/docs/SubmissionBase.md +15 -0
- data/docs/SubmissionBaseMetadata.md +12 -0
- data/docs/SubmissionSizeError.md +8 -0
- data/docs/SuccessMessage.md +7 -0
- data/docs/Users.md +10 -0
- data/docs/ViewerPermissions.md +11 -0
- data/docs/Webhook.md +10 -0
- data/docs/WebhookApi.md +286 -0
- data/docs/WebhookBase.md +10 -0
- data/docs/WebhookPathRequest.md +8 -0
- data/docs/WebhookWithSecret.md +10 -0
- data/git_push.sh +55 -0
- data/lib/tca_client/api/eula_api.rb +312 -0
- data/lib/tca_client/api/features_api.rb +82 -0
- data/lib/tca_client/api/groups_api.rb +627 -0
- data/lib/tca_client/api/index_api.rb +156 -0
- data/lib/tca_client/api/similarity_api.rb +456 -0
- data/lib/tca_client/api/submission_api.rb +387 -0
- data/lib/tca_client/api/webhook_api.rb +364 -0
- data/lib/tca_client/api_client.rb +388 -0
- data/lib/tca_client/api_error.rb +57 -0
- data/lib/tca_client/configuration.rb +205 -0
- data/lib/tca_client/models/add_group_attachment_request.rb +220 -0
- data/lib/tca_client/models/add_group_attachment_response.rb +208 -0
- data/lib/tca_client/models/aggregate_group.rb +299 -0
- data/lib/tca_client/models/author_metadata_override.rb +217 -0
- data/lib/tca_client/models/error.rb +218 -0
- data/lib/tca_client/models/eula.rb +228 -0
- data/lib/tca_client/models/eula_accept_list_item.rb +237 -0
- data/lib/tca_client/models/eula_accept_request.rb +237 -0
- data/lib/tca_client/models/eula_version.rb +272 -0
- data/lib/tca_client/models/features_enabled.rb +257 -0
- data/lib/tca_client/models/features_generation_settings.rb +240 -0
- data/lib/tca_client/models/features_similarity.rb +224 -0
- data/lib/tca_client/models/features_similarity_view_settings.rb +327 -0
- data/lib/tca_client/models/features_tenant.rb +207 -0
- data/lib/tca_client/models/features_viewer_modes.rb +215 -0
- data/lib/tca_client/models/group.rb +259 -0
- data/lib/tca_client/models/group_attachment_response.rb +272 -0
- data/lib/tca_client/models/group_context.rb +227 -0
- data/lib/tca_client/models/index_state_settings.rb +207 -0
- data/lib/tca_client/models/indexing_settings.rb +207 -0
- data/lib/tca_client/models/inline_response_200.rb +208 -0
- data/lib/tca_client/models/pdf_status_response.rb +241 -0
- data/lib/tca_client/models/rate_limit_error.rb +221 -0
- data/lib/tca_client/models/request_pdf_response.rb +207 -0
- data/lib/tca_client/models/sidebar.rb +241 -0
- data/lib/tca_client/models/similarity_generation_settings.rb +280 -0
- data/lib/tca_client/models/similarity_metadata.rb +340 -0
- data/lib/tca_client/models/similarity_metadata_top_matches.rb +267 -0
- data/lib/tca_client/models/similarity_put_request.rb +229 -0
- data/lib/tca_client/models/similarity_score_data.rb +245 -0
- data/lib/tca_client/models/similarity_settings.rb +259 -0
- data/lib/tca_client/models/similarity_settings_modes.rb +217 -0
- data/lib/tca_client/models/similarity_settings_view_settings.rb +207 -0
- data/lib/tca_client/models/similarity_view_settings.rb +327 -0
- data/lib/tca_client/models/similarity_viewer_url_response.rb +207 -0
- data/lib/tca_client/models/similarity_viewer_url_settings.rb +306 -0
- data/lib/tca_client/models/simple_submission_response.rb +197 -0
- data/lib/tca_client/models/submission.rb +197 -0
- data/lib/tca_client/models/submission_base.rb +332 -0
- data/lib/tca_client/models/submission_base_metadata.rb +256 -0
- data/lib/tca_client/models/submission_size_error.rb +221 -0
- data/lib/tca_client/models/success_message.rb +208 -0
- data/lib/tca_client/models/users.rb +234 -0
- data/lib/tca_client/models/viewer_permissions.rb +247 -0
- data/lib/tca_client/models/webhook.rb +271 -0
- data/lib/tca_client/models/webhook_base.rb +271 -0
- data/lib/tca_client/models/webhook_path_request.rb +246 -0
- data/lib/tca_client/models/webhook_with_secret.rb +271 -0
- data/lib/tca_client/version.rb +14 -0
- data/lib/tca_client.rb +93 -0
- data/spec/api/eula_api_spec.rb +90 -0
- data/spec/api/features_api_spec.rb +46 -0
- data/spec/api/groups_api_spec.rb +147 -0
- data/spec/api/index_api_spec.rb +60 -0
- data/spec/api/similarity_api_spec.rb +116 -0
- data/spec/api/submission_api_spec.rb +103 -0
- data/spec/api/webhook_api_spec.rb +99 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/add_group_attachment_request_spec.rb +46 -0
- data/spec/models/add_group_attachment_response_spec.rb +40 -0
- data/spec/models/aggregate_group_spec.rb +78 -0
- data/spec/models/author_metadata_override_spec.rb +46 -0
- data/spec/models/error_spec.rb +46 -0
- data/spec/models/eula_accept_list_item_spec.rb +58 -0
- data/spec/models/eula_accept_request_spec.rb +58 -0
- data/spec/models/eula_spec.rb +52 -0
- data/spec/models/eula_version_spec.rb +68 -0
- data/spec/models/features_enabled_spec.rb +62 -0
- data/spec/models/features_generation_settings_spec.rb +50 -0
- data/spec/models/features_similarity_spec.rb +52 -0
- data/spec/models/features_similarity_view_settings_spec.rb +112 -0
- data/spec/models/features_tenant_spec.rb +40 -0
- data/spec/models/features_viewer_modes_spec.rb +46 -0
- data/spec/models/group_attachment_response_spec.rb +62 -0
- data/spec/models/group_context_spec.rb +52 -0
- data/spec/models/group_spec.rb +56 -0
- data/spec/models/index_state_settings_spec.rb +40 -0
- data/spec/models/indexing_settings_spec.rb +40 -0
- data/spec/models/inline_response_200_spec.rb +40 -0
- data/spec/models/pdf_status_response_spec.rb +44 -0
- data/spec/models/rate_limit_error_spec.rb +46 -0
- data/spec/models/request_pdf_response_spec.rb +40 -0
- data/spec/models/sidebar_spec.rb +44 -0
- data/spec/models/similarity_generation_settings_spec.rb +66 -0
- data/spec/models/similarity_metadata_spec.rb +94 -0
- data/spec/models/similarity_metadata_top_matches_spec.rb +76 -0
- data/spec/models/similarity_put_request_spec.rb +52 -0
- data/spec/models/similarity_score_data_spec.rb +58 -0
- data/spec/models/similarity_settings_modes_spec.rb +46 -0
- data/spec/models/similarity_settings_spec.rb +56 -0
- data/spec/models/similarity_settings_view_settings_spec.rb +40 -0
- data/spec/models/similarity_view_settings_spec.rb +112 -0
- data/spec/models/similarity_viewer_url_response_spec.rb +40 -0
- data/spec/models/similarity_viewer_url_settings_spec.rb +86 -0
- data/spec/models/simple_submission_response_spec.rb +34 -0
- data/spec/models/submission_base_metadata_spec.rb +70 -0
- data/spec/models/submission_base_spec.rb +96 -0
- data/spec/models/submission_size_error_spec.rb +46 -0
- data/spec/models/submission_spec.rb +34 -0
- data/spec/models/success_message_spec.rb +40 -0
- data/spec/models/users_spec.rb +58 -0
- data/spec/models/viewer_permissions_spec.rb +64 -0
- data/spec/models/webhook_base_spec.rb +62 -0
- data/spec/models/webhook_path_request_spec.rb +50 -0
- data/spec/models/webhook_spec.rb +62 -0
- data/spec/models/webhook_with_secret_spec.rb +62 -0
- data/spec/spec_helper.rb +110 -0
- data/tca_client.gemspec +38 -0
- metadata +365 -0
@@ -0,0 +1,388 @@
|
|
1
|
+
=begin
|
2
|
+
#Turnitin Core API
|
3
|
+
|
4
|
+
#Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button API Keys * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope --> Enter a name --> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the *submission* will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the *report* will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.249
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.35
|
10
|
+
=end
|
11
|
+
|
12
|
+
require 'date'
|
13
|
+
require 'json'
|
14
|
+
require 'logger'
|
15
|
+
require 'tempfile'
|
16
|
+
require 'typhoeus'
|
17
|
+
require 'uri'
|
18
|
+
|
19
|
+
module TCAClient
|
20
|
+
class ApiClient
|
21
|
+
# The Configuration object holding settings to be used in the API client.
|
22
|
+
attr_accessor :config
|
23
|
+
|
24
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
25
|
+
#
|
26
|
+
# @return [Hash]
|
27
|
+
attr_accessor :default_headers
|
28
|
+
|
29
|
+
# Initializes the ApiClient
|
30
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
31
|
+
def initialize(config = Configuration.default)
|
32
|
+
@config = config
|
33
|
+
@user_agent = "Swagger-Codegen/#{VERSION}/ruby"
|
34
|
+
@default_headers = {
|
35
|
+
'Content-Type' => 'application/json',
|
36
|
+
'User-Agent' => @user_agent
|
37
|
+
}
|
38
|
+
end
|
39
|
+
|
40
|
+
def self.default
|
41
|
+
@@default ||= ApiClient.new
|
42
|
+
end
|
43
|
+
|
44
|
+
# Call an API with given options.
|
45
|
+
#
|
46
|
+
# @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
|
47
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
48
|
+
def call_api(http_method, path, opts = {})
|
49
|
+
request = build_request(http_method, path, opts)
|
50
|
+
response = request.run
|
51
|
+
|
52
|
+
if @config.debugging
|
53
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
54
|
+
end
|
55
|
+
|
56
|
+
unless response.success?
|
57
|
+
if response.timed_out?
|
58
|
+
fail ApiError.new('Connection timed out')
|
59
|
+
elsif response.code == 0
|
60
|
+
# Errors from libcurl will be made visible here
|
61
|
+
fail ApiError.new(:code => 0,
|
62
|
+
:message => response.return_message)
|
63
|
+
else
|
64
|
+
fail ApiError.new(:code => response.code,
|
65
|
+
:response_headers => response.headers,
|
66
|
+
:response_body => response.body),
|
67
|
+
response.status_message
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
if opts[:return_type]
|
72
|
+
data = deserialize(response, opts[:return_type])
|
73
|
+
else
|
74
|
+
data = nil
|
75
|
+
end
|
76
|
+
return data, response.code, response.headers
|
77
|
+
end
|
78
|
+
|
79
|
+
# Builds the HTTP request
|
80
|
+
#
|
81
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
82
|
+
# @param [String] path URL path (e.g. /account/new)
|
83
|
+
# @option opts [Hash] :header_params Header parameters
|
84
|
+
# @option opts [Hash] :query_params Query parameters
|
85
|
+
# @option opts [Hash] :form_params Query parameters
|
86
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
87
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
88
|
+
def build_request(http_method, path, opts = {})
|
89
|
+
url = build_request_url(path)
|
90
|
+
http_method = http_method.to_sym.downcase
|
91
|
+
|
92
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
93
|
+
query_params = opts[:query_params] || {}
|
94
|
+
form_params = opts[:form_params] || {}
|
95
|
+
|
96
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
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
|
+
# Check if the given MIME is a JSON MIME.
|
159
|
+
# JSON MIME examples:
|
160
|
+
# application/json
|
161
|
+
# application/json; charset=UTF8
|
162
|
+
# APPLICATION/JSON
|
163
|
+
# */*
|
164
|
+
# @param [String] mime MIME
|
165
|
+
# @return [Boolean] True if the MIME is application/json
|
166
|
+
def json_mime?(mime)
|
167
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
168
|
+
end
|
169
|
+
|
170
|
+
# Deserialize the response to the given return type.
|
171
|
+
#
|
172
|
+
# @param [Response] response HTTP response
|
173
|
+
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
174
|
+
def deserialize(response, return_type)
|
175
|
+
body = response.body
|
176
|
+
|
177
|
+
# handle file downloading - return the File instance processed in request callbacks
|
178
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
179
|
+
return @tempfile if return_type == 'File'
|
180
|
+
|
181
|
+
return nil if body.nil? || body.empty?
|
182
|
+
|
183
|
+
# return response body directly for String return type
|
184
|
+
return body if return_type == 'String'
|
185
|
+
|
186
|
+
# ensuring a default content type
|
187
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
188
|
+
|
189
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
190
|
+
|
191
|
+
begin
|
192
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
193
|
+
rescue JSON::ParserError => e
|
194
|
+
if %w(String Date DateTime).include?(return_type)
|
195
|
+
data = body
|
196
|
+
else
|
197
|
+
raise e
|
198
|
+
end
|
199
|
+
end
|
200
|
+
|
201
|
+
convert_to_type data, return_type
|
202
|
+
end
|
203
|
+
|
204
|
+
# Convert data to the given return type.
|
205
|
+
# @param [Object] data Data to be converted
|
206
|
+
# @param [String] return_type Return type
|
207
|
+
# @return [Mixed] Data in a particular type
|
208
|
+
def convert_to_type(data, return_type)
|
209
|
+
return nil if data.nil?
|
210
|
+
case return_type
|
211
|
+
when 'String'
|
212
|
+
data.to_s
|
213
|
+
when 'Integer'
|
214
|
+
data.to_i
|
215
|
+
when 'Float'
|
216
|
+
data.to_f
|
217
|
+
when 'Boolean'
|
218
|
+
data == true
|
219
|
+
when 'DateTime'
|
220
|
+
# parse date time (expecting ISO 8601 format)
|
221
|
+
DateTime.parse data
|
222
|
+
when 'Date'
|
223
|
+
# parse date time (expecting ISO 8601 format)
|
224
|
+
Date.parse data
|
225
|
+
when 'Object'
|
226
|
+
# generic object (usually a Hash), return directly
|
227
|
+
data
|
228
|
+
when /\AArray<(.+)>\z/
|
229
|
+
# e.g. Array<Pet>
|
230
|
+
sub_type = $1
|
231
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
232
|
+
when /\AHash\<String, (.+)\>\z/
|
233
|
+
# e.g. Hash<String, Integer>
|
234
|
+
sub_type = $1
|
235
|
+
{}.tap do |hash|
|
236
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
237
|
+
end
|
238
|
+
else
|
239
|
+
# models, e.g. Pet
|
240
|
+
TCAClient.const_get(return_type).build_from_hash(data)
|
241
|
+
end
|
242
|
+
end
|
243
|
+
|
244
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
245
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
246
|
+
# The response body is written to the file in chunks in order to handle files which
|
247
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
248
|
+
# process can use.
|
249
|
+
#
|
250
|
+
# @see Configuration#temp_folder_path
|
251
|
+
def download_file(request)
|
252
|
+
tempfile = nil
|
253
|
+
encoding = nil
|
254
|
+
request.on_headers do |response|
|
255
|
+
content_disposition = response.headers['Content-Disposition']
|
256
|
+
if content_disposition && content_disposition =~ /filename=/i
|
257
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
258
|
+
prefix = sanitize_filename(filename)
|
259
|
+
else
|
260
|
+
prefix = 'download-'
|
261
|
+
end
|
262
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
263
|
+
encoding = response.body.encoding
|
264
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
265
|
+
@tempfile = tempfile
|
266
|
+
end
|
267
|
+
request.on_body do |chunk|
|
268
|
+
chunk.force_encoding(encoding)
|
269
|
+
tempfile.write(chunk)
|
270
|
+
end
|
271
|
+
request.on_complete do |response|
|
272
|
+
if tempfile
|
273
|
+
tempfile.close
|
274
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
275
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
276
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
277
|
+
"explicitly with `tempfile.delete`"
|
278
|
+
end
|
279
|
+
end
|
280
|
+
end
|
281
|
+
|
282
|
+
# Sanitize filename by removing path.
|
283
|
+
# e.g. ../../sun.gif becomes sun.gif
|
284
|
+
#
|
285
|
+
# @param [String] filename the filename to be sanitized
|
286
|
+
# @return [String] the sanitized filename
|
287
|
+
def sanitize_filename(filename)
|
288
|
+
filename.gsub(/.*[\/\\]/, '')
|
289
|
+
end
|
290
|
+
|
291
|
+
def build_request_url(path)
|
292
|
+
# Add leading and trailing slashes to path
|
293
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
294
|
+
@config.base_url + path
|
295
|
+
end
|
296
|
+
|
297
|
+
# Update hearder and query params based on authentication settings.
|
298
|
+
#
|
299
|
+
# @param [Hash] header_params Header parameters
|
300
|
+
# @param [Hash] query_params Query parameters
|
301
|
+
# @param [String] auth_names Authentication scheme name
|
302
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
303
|
+
Array(auth_names).each do |auth_name|
|
304
|
+
auth_setting = @config.auth_settings[auth_name]
|
305
|
+
next unless auth_setting
|
306
|
+
case auth_setting[:in]
|
307
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
308
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
309
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
310
|
+
end
|
311
|
+
end
|
312
|
+
end
|
313
|
+
|
314
|
+
# Sets user agent in HTTP header
|
315
|
+
#
|
316
|
+
# @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
|
317
|
+
def user_agent=(user_agent)
|
318
|
+
@user_agent = user_agent
|
319
|
+
@default_headers['User-Agent'] = @user_agent
|
320
|
+
end
|
321
|
+
|
322
|
+
# Return Accept header based on an array of accepts provided.
|
323
|
+
# @param [Array] accepts array for Accept
|
324
|
+
# @return [String] the Accept header (e.g. application/json)
|
325
|
+
def select_header_accept(accepts)
|
326
|
+
return nil if accepts.nil? || accepts.empty?
|
327
|
+
# use JSON when present, otherwise use all of the provided
|
328
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
329
|
+
json_accept || accepts.join(',')
|
330
|
+
end
|
331
|
+
|
332
|
+
# Return Content-Type header based on an array of content types provided.
|
333
|
+
# @param [Array] content_types array for Content-Type
|
334
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
335
|
+
def select_header_content_type(content_types)
|
336
|
+
# use application/json by default
|
337
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
338
|
+
# use JSON when present, otherwise use the first one
|
339
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
340
|
+
json_content_type || content_types.first
|
341
|
+
end
|
342
|
+
|
343
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
344
|
+
# @param [Object] model object to be converted into JSON string
|
345
|
+
# @return [String] JSON string representation of the object
|
346
|
+
def object_to_http_body(model)
|
347
|
+
return model if model.nil? || model.is_a?(String)
|
348
|
+
local_body = nil
|
349
|
+
if model.is_a?(Array)
|
350
|
+
local_body = model.map { |m| object_to_hash(m) }
|
351
|
+
else
|
352
|
+
local_body = object_to_hash(model)
|
353
|
+
end
|
354
|
+
local_body.to_json
|
355
|
+
end
|
356
|
+
|
357
|
+
# Convert object(non-array) to hash.
|
358
|
+
# @param [Object] obj object to be converted into JSON string
|
359
|
+
# @return [String] JSON string representation of the object
|
360
|
+
def object_to_hash(obj)
|
361
|
+
if obj.respond_to?(:to_hash)
|
362
|
+
obj.to_hash
|
363
|
+
else
|
364
|
+
obj
|
365
|
+
end
|
366
|
+
end
|
367
|
+
|
368
|
+
# Build parameter value according to the given collection format.
|
369
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
370
|
+
def build_collection_param(param, collection_format)
|
371
|
+
case collection_format
|
372
|
+
when :csv
|
373
|
+
param.join(',')
|
374
|
+
when :ssv
|
375
|
+
param.join(' ')
|
376
|
+
when :tsv
|
377
|
+
param.join("\t")
|
378
|
+
when :pipes
|
379
|
+
param.join('|')
|
380
|
+
when :multi
|
381
|
+
# return the array directly as typhoeus will handle it as expected
|
382
|
+
param
|
383
|
+
else
|
384
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
385
|
+
end
|
386
|
+
end
|
387
|
+
end
|
388
|
+
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
=begin
|
2
|
+
#Turnitin Core API
|
3
|
+
|
4
|
+
#Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button API Keys * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope --> Enter a name --> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the *submission* will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the *report* will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.249
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.35
|
10
|
+
=end
|
11
|
+
|
12
|
+
module TCAClient
|
13
|
+
class ApiError < StandardError
|
14
|
+
attr_reader :code, :response_headers, :response_body
|
15
|
+
|
16
|
+
# Usage examples:
|
17
|
+
# ApiError.new
|
18
|
+
# ApiError.new("message")
|
19
|
+
# ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
|
20
|
+
# ApiError.new(:code => 404, :message => "Not Found")
|
21
|
+
def initialize(arg = nil)
|
22
|
+
if arg.is_a? Hash
|
23
|
+
if arg.key?(:message) || arg.key?('message')
|
24
|
+
super(arg[:message] || arg['message'])
|
25
|
+
else
|
26
|
+
super arg
|
27
|
+
end
|
28
|
+
|
29
|
+
arg.each do |k, v|
|
30
|
+
instance_variable_set "@#{k}", v
|
31
|
+
end
|
32
|
+
else
|
33
|
+
super arg
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
# Override to_s to display a friendly error message
|
38
|
+
def to_s
|
39
|
+
message
|
40
|
+
end
|
41
|
+
|
42
|
+
def message
|
43
|
+
if @message.nil?
|
44
|
+
msg = "Error message: the server returns an error"
|
45
|
+
else
|
46
|
+
msg = @message
|
47
|
+
end
|
48
|
+
|
49
|
+
msg += "\nHTTP status code: #{code}" if code
|
50
|
+
msg += "\nResponse headers: #{response_headers}" if response_headers
|
51
|
+
msg += "\nResponse body: #{response_body}" if response_body
|
52
|
+
|
53
|
+
msg
|
54
|
+
end
|
55
|
+
|
56
|
+
end
|
57
|
+
end
|
@@ -0,0 +1,205 @@
|
|
1
|
+
=begin
|
2
|
+
#Turnitin Core API
|
3
|
+
|
4
|
+
#Turnitin Core API (TCA) provides direct API access to the core functionality provided by Turnitin. TCA supports file submission, similarity report generation, group management, and visualization of report matches via Cloud Viewer or PDF download. Below is the full flow to successfully set up an integration scope, an API Key, and make calls to TCA. Integration Scope and API Key management is done via the Admin Console UI by logging in as an admin user. For more details, go to our [developer portal documentation page](https://developers.turnitin.com/docs). ## Integration Scope and API Key Management TCA API calls must provide an API Key for authentication, so you must first have at least one integration scope associated with at least one API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an *Admin* user with permission to create Integration Scopes, under a tenant that is licensed to use the TCA product Integration Scopes (you can create a new one, or add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration` at top the top of the page --> Enter a name --> `Add` Button API Keys * Click `Integrations` in the side bar --> `Create API Key` Button next to a given Integration Scope --> Enter a name --> click `Create and View button` * Copy/Save the key manually or click save to clipboard button to copy it (this is the only time it will show) ## TCA Flow * Register a webhook * Create a submission * Upload a file for the submission * Wait for the submission upload to process * If you registered a webhook, a callback will be sent to it when upload is complete * The status of the *submission* will also update to `COMPLETE` * Request a Similarity Report * Wait for similarity report to process * If you registered a webhook, a callback will be sent to it when report is complete * The status of the *report* will also be updated to `COMPLETE` * Request a URL with parameters to view the Similarity Report
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.249
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 3.0.35
|
10
|
+
=end
|
11
|
+
|
12
|
+
module TCAClient
|
13
|
+
class Configuration
|
14
|
+
# Defines url scheme
|
15
|
+
attr_accessor :scheme
|
16
|
+
|
17
|
+
# Defines url host
|
18
|
+
attr_accessor :host
|
19
|
+
|
20
|
+
# Defines url base path
|
21
|
+
attr_accessor :base_path
|
22
|
+
|
23
|
+
# Defines API keys used with API Key authentications.
|
24
|
+
#
|
25
|
+
# @return [Hash] key: parameter name, value: parameter value (API key)
|
26
|
+
#
|
27
|
+
# @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
|
28
|
+
# config.api_key['api_key'] = 'xxx'
|
29
|
+
attr_accessor :api_key
|
30
|
+
|
31
|
+
# Defines API key prefixes used with API Key authentications.
|
32
|
+
#
|
33
|
+
# @return [Hash] key: parameter name, value: API key prefix
|
34
|
+
#
|
35
|
+
# @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
|
36
|
+
# config.api_key_prefix['api_key'] = 'Token'
|
37
|
+
attr_accessor :api_key_prefix
|
38
|
+
|
39
|
+
# Defines the username used with HTTP basic authentication.
|
40
|
+
#
|
41
|
+
# @return [String]
|
42
|
+
attr_accessor :username
|
43
|
+
|
44
|
+
# Defines the password used with HTTP basic authentication.
|
45
|
+
#
|
46
|
+
# @return [String]
|
47
|
+
attr_accessor :password
|
48
|
+
|
49
|
+
# Defines the access token (Bearer) used with OAuth2.
|
50
|
+
attr_accessor :access_token
|
51
|
+
|
52
|
+
# Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
|
53
|
+
# details will be logged with `logger.debug` (see the `logger` attribute).
|
54
|
+
# Default to false.
|
55
|
+
#
|
56
|
+
# @return [true, false]
|
57
|
+
attr_accessor :debugging
|
58
|
+
|
59
|
+
# Defines the logger used for debugging.
|
60
|
+
# Default to `Rails.logger` (when in Rails) or logging to STDOUT.
|
61
|
+
#
|
62
|
+
# @return [#debug]
|
63
|
+
attr_accessor :logger
|
64
|
+
|
65
|
+
# Defines the temporary folder to store downloaded files
|
66
|
+
# (for API endpoints that have file response).
|
67
|
+
# Default to use `Tempfile`.
|
68
|
+
#
|
69
|
+
# @return [String]
|
70
|
+
attr_accessor :temp_folder_path
|
71
|
+
|
72
|
+
# The time limit for HTTP request in seconds.
|
73
|
+
# Default to 0 (never times out).
|
74
|
+
attr_accessor :timeout
|
75
|
+
|
76
|
+
# Set this to false to skip client side validation in the operation.
|
77
|
+
# Default to true.
|
78
|
+
# @return [true, false]
|
79
|
+
attr_accessor :client_side_validation
|
80
|
+
|
81
|
+
### TLS/SSL setting
|
82
|
+
# Set this to false to skip verifying SSL certificate when calling API from https server.
|
83
|
+
# Default to true.
|
84
|
+
#
|
85
|
+
# @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
|
86
|
+
#
|
87
|
+
# @return [true, false]
|
88
|
+
attr_accessor :verify_ssl
|
89
|
+
|
90
|
+
### TLS/SSL setting
|
91
|
+
# Set this to false to skip verifying SSL host name
|
92
|
+
# Default to true.
|
93
|
+
#
|
94
|
+
# @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
|
95
|
+
#
|
96
|
+
# @return [true, false]
|
97
|
+
attr_accessor :verify_ssl_host
|
98
|
+
|
99
|
+
### TLS/SSL setting
|
100
|
+
# Set this to customize the certificate file to verify the peer.
|
101
|
+
#
|
102
|
+
# @return [String] the path to the certificate file
|
103
|
+
#
|
104
|
+
# @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
|
105
|
+
# https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
|
106
|
+
attr_accessor :ssl_ca_cert
|
107
|
+
|
108
|
+
### TLS/SSL setting
|
109
|
+
# Client certificate file (for client certificate)
|
110
|
+
attr_accessor :cert_file
|
111
|
+
|
112
|
+
### TLS/SSL setting
|
113
|
+
# Client private key file (for client certificate)
|
114
|
+
attr_accessor :key_file
|
115
|
+
|
116
|
+
# Set this to customize parameters encoding of array parameter with multi collectionFormat.
|
117
|
+
# Default to nil.
|
118
|
+
#
|
119
|
+
# @see The params_encoding option of Ethon. Related source code:
|
120
|
+
# https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
|
121
|
+
attr_accessor :params_encoding
|
122
|
+
|
123
|
+
attr_accessor :inject_format
|
124
|
+
|
125
|
+
attr_accessor :force_ending_format
|
126
|
+
|
127
|
+
def initialize
|
128
|
+
@scheme = 'https'
|
129
|
+
@host = '{tenantName}.{hostName}'
|
130
|
+
@base_path = 'https://{tenantName}.{hostName}/api/v1'
|
131
|
+
@api_key = {}
|
132
|
+
@api_key_prefix = {}
|
133
|
+
@timeout = 0
|
134
|
+
@client_side_validation = true
|
135
|
+
@verify_ssl = true
|
136
|
+
@verify_ssl_host = true
|
137
|
+
@params_encoding = nil
|
138
|
+
@cert_file = nil
|
139
|
+
@key_file = nil
|
140
|
+
@debugging = false
|
141
|
+
@inject_format = false
|
142
|
+
@force_ending_format = false
|
143
|
+
@logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
|
144
|
+
|
145
|
+
yield(self) if block_given?
|
146
|
+
end
|
147
|
+
|
148
|
+
# The default Configuration object.
|
149
|
+
def self.default
|
150
|
+
@@default ||= Configuration.new
|
151
|
+
end
|
152
|
+
|
153
|
+
def configure
|
154
|
+
yield(self) if block_given?
|
155
|
+
end
|
156
|
+
|
157
|
+
def scheme=(scheme)
|
158
|
+
# remove :// from scheme
|
159
|
+
@scheme = scheme.sub(/:\/\//, '')
|
160
|
+
end
|
161
|
+
|
162
|
+
def host=(host)
|
163
|
+
# remove http(s):// and anything after a slash
|
164
|
+
@host = host.sub(/https?:\/\//, '').split('/').first
|
165
|
+
end
|
166
|
+
|
167
|
+
def base_path=(base_path)
|
168
|
+
# Add leading and trailing slashes to base_path
|
169
|
+
@base_path = "/#{base_path}".gsub(/\/+/, '/')
|
170
|
+
@base_path = '' if @base_path == '/'
|
171
|
+
end
|
172
|
+
|
173
|
+
def base_url
|
174
|
+
"#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
|
175
|
+
end
|
176
|
+
|
177
|
+
# Gets API key (with prefix if set).
|
178
|
+
# @param [String] param_name the parameter name of API key auth
|
179
|
+
def api_key_with_prefix(param_name)
|
180
|
+
if @api_key_prefix[param_name]
|
181
|
+
"#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
|
182
|
+
else
|
183
|
+
@api_key[param_name]
|
184
|
+
end
|
185
|
+
end
|
186
|
+
|
187
|
+
# Gets Basic Auth token string
|
188
|
+
def basic_auth_token
|
189
|
+
'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
|
190
|
+
end
|
191
|
+
|
192
|
+
# Returns Auth Settings hash for api client.
|
193
|
+
def auth_settings
|
194
|
+
{
|
195
|
+
'api_key' =>
|
196
|
+
{
|
197
|
+
type: 'api_key',
|
198
|
+
in: 'header',
|
199
|
+
key: 'Authorization',
|
200
|
+
value: api_key_with_prefix('Authorization')
|
201
|
+
},
|
202
|
+
}
|
203
|
+
end
|
204
|
+
end
|
205
|
+
end
|