tca_client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (181) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +862 -0
  4. data/Rakefile +8 -0
  5. data/docs/AddGroupAttachmentRequest.md +8 -0
  6. data/docs/AddGroupAttachmentResponse.md +7 -0
  7. data/docs/AggregateGroup.md +12 -0
  8. data/docs/AuthorMetadataOverride.md +8 -0
  9. data/docs/EULAApi.md +241 -0
  10. data/docs/Error.md +8 -0
  11. data/docs/Eula.md +9 -0
  12. data/docs/EulaAcceptListItem.md +10 -0
  13. data/docs/EulaAcceptRequest.md +10 -0
  14. data/docs/EulaVersion.md +11 -0
  15. data/docs/FeaturesApi.md +61 -0
  16. data/docs/FeaturesEnabled.md +10 -0
  17. data/docs/FeaturesGenerationSettings.md +8 -0
  18. data/docs/FeaturesSimilarity.md +9 -0
  19. data/docs/FeaturesSimilarityViewSettings.md +19 -0
  20. data/docs/FeaturesTenant.md +7 -0
  21. data/docs/FeaturesViewerModes.md +8 -0
  22. data/docs/Group.md +9 -0
  23. data/docs/GroupAttachmentResponse.md +10 -0
  24. data/docs/GroupContext.md +9 -0
  25. data/docs/GroupsApi.md +472 -0
  26. data/docs/IndexApi.md +119 -0
  27. data/docs/IndexStateSettings.md +7 -0
  28. data/docs/IndexingSettings.md +7 -0
  29. data/docs/InlineResponse200.md +7 -0
  30. data/docs/PdfStatusResponse.md +7 -0
  31. data/docs/RateLimitError.md +8 -0
  32. data/docs/RequestPdfResponse.md +7 -0
  33. data/docs/Sidebar.md +7 -0
  34. data/docs/SimilarityApi.md +351 -0
  35. data/docs/SimilarityGenerationSettings.md +10 -0
  36. data/docs/SimilarityMetadata.md +16 -0
  37. data/docs/SimilarityMetadataTopMatches.md +13 -0
  38. data/docs/SimilarityPutRequest.md +9 -0
  39. data/docs/SimilarityScoreData.md +10 -0
  40. data/docs/SimilaritySettings.md +9 -0
  41. data/docs/SimilaritySettingsModes.md +8 -0
  42. data/docs/SimilaritySettingsViewSettings.md +7 -0
  43. data/docs/SimilarityViewSettings.md +19 -0
  44. data/docs/SimilarityViewerUrlResponse.md +7 -0
  45. data/docs/SimilarityViewerUrlSettings.md +14 -0
  46. data/docs/SimpleSubmissionResponse.md +6 -0
  47. data/docs/Submission.md +6 -0
  48. data/docs/SubmissionApi.md +296 -0
  49. data/docs/SubmissionBase.md +15 -0
  50. data/docs/SubmissionBaseMetadata.md +12 -0
  51. data/docs/SubmissionSizeError.md +8 -0
  52. data/docs/SuccessMessage.md +7 -0
  53. data/docs/Users.md +10 -0
  54. data/docs/ViewerPermissions.md +11 -0
  55. data/docs/Webhook.md +10 -0
  56. data/docs/WebhookApi.md +286 -0
  57. data/docs/WebhookBase.md +10 -0
  58. data/docs/WebhookPathRequest.md +8 -0
  59. data/docs/WebhookWithSecret.md +10 -0
  60. data/git_push.sh +55 -0
  61. data/lib/tca_client/api/eula_api.rb +312 -0
  62. data/lib/tca_client/api/features_api.rb +82 -0
  63. data/lib/tca_client/api/groups_api.rb +627 -0
  64. data/lib/tca_client/api/index_api.rb +156 -0
  65. data/lib/tca_client/api/similarity_api.rb +456 -0
  66. data/lib/tca_client/api/submission_api.rb +387 -0
  67. data/lib/tca_client/api/webhook_api.rb +364 -0
  68. data/lib/tca_client/api_client.rb +388 -0
  69. data/lib/tca_client/api_error.rb +57 -0
  70. data/lib/tca_client/configuration.rb +205 -0
  71. data/lib/tca_client/models/add_group_attachment_request.rb +220 -0
  72. data/lib/tca_client/models/add_group_attachment_response.rb +208 -0
  73. data/lib/tca_client/models/aggregate_group.rb +299 -0
  74. data/lib/tca_client/models/author_metadata_override.rb +217 -0
  75. data/lib/tca_client/models/error.rb +218 -0
  76. data/lib/tca_client/models/eula.rb +228 -0
  77. data/lib/tca_client/models/eula_accept_list_item.rb +237 -0
  78. data/lib/tca_client/models/eula_accept_request.rb +237 -0
  79. data/lib/tca_client/models/eula_version.rb +272 -0
  80. data/lib/tca_client/models/features_enabled.rb +257 -0
  81. data/lib/tca_client/models/features_generation_settings.rb +240 -0
  82. data/lib/tca_client/models/features_similarity.rb +224 -0
  83. data/lib/tca_client/models/features_similarity_view_settings.rb +327 -0
  84. data/lib/tca_client/models/features_tenant.rb +207 -0
  85. data/lib/tca_client/models/features_viewer_modes.rb +215 -0
  86. data/lib/tca_client/models/group.rb +259 -0
  87. data/lib/tca_client/models/group_attachment_response.rb +272 -0
  88. data/lib/tca_client/models/group_context.rb +227 -0
  89. data/lib/tca_client/models/index_state_settings.rb +207 -0
  90. data/lib/tca_client/models/indexing_settings.rb +207 -0
  91. data/lib/tca_client/models/inline_response_200.rb +208 -0
  92. data/lib/tca_client/models/pdf_status_response.rb +241 -0
  93. data/lib/tca_client/models/rate_limit_error.rb +221 -0
  94. data/lib/tca_client/models/request_pdf_response.rb +207 -0
  95. data/lib/tca_client/models/sidebar.rb +241 -0
  96. data/lib/tca_client/models/similarity_generation_settings.rb +280 -0
  97. data/lib/tca_client/models/similarity_metadata.rb +340 -0
  98. data/lib/tca_client/models/similarity_metadata_top_matches.rb +267 -0
  99. data/lib/tca_client/models/similarity_put_request.rb +229 -0
  100. data/lib/tca_client/models/similarity_score_data.rb +245 -0
  101. data/lib/tca_client/models/similarity_settings.rb +259 -0
  102. data/lib/tca_client/models/similarity_settings_modes.rb +217 -0
  103. data/lib/tca_client/models/similarity_settings_view_settings.rb +207 -0
  104. data/lib/tca_client/models/similarity_view_settings.rb +327 -0
  105. data/lib/tca_client/models/similarity_viewer_url_response.rb +207 -0
  106. data/lib/tca_client/models/similarity_viewer_url_settings.rb +306 -0
  107. data/lib/tca_client/models/simple_submission_response.rb +197 -0
  108. data/lib/tca_client/models/submission.rb +197 -0
  109. data/lib/tca_client/models/submission_base.rb +332 -0
  110. data/lib/tca_client/models/submission_base_metadata.rb +256 -0
  111. data/lib/tca_client/models/submission_size_error.rb +221 -0
  112. data/lib/tca_client/models/success_message.rb +208 -0
  113. data/lib/tca_client/models/users.rb +234 -0
  114. data/lib/tca_client/models/viewer_permissions.rb +247 -0
  115. data/lib/tca_client/models/webhook.rb +271 -0
  116. data/lib/tca_client/models/webhook_base.rb +271 -0
  117. data/lib/tca_client/models/webhook_path_request.rb +246 -0
  118. data/lib/tca_client/models/webhook_with_secret.rb +271 -0
  119. data/lib/tca_client/version.rb +14 -0
  120. data/lib/tca_client.rb +93 -0
  121. data/spec/api/eula_api_spec.rb +90 -0
  122. data/spec/api/features_api_spec.rb +46 -0
  123. data/spec/api/groups_api_spec.rb +147 -0
  124. data/spec/api/index_api_spec.rb +60 -0
  125. data/spec/api/similarity_api_spec.rb +116 -0
  126. data/spec/api/submission_api_spec.rb +103 -0
  127. data/spec/api/webhook_api_spec.rb +99 -0
  128. data/spec/api_client_spec.rb +225 -0
  129. data/spec/base_object_spec.rb +109 -0
  130. data/spec/configuration_spec.rb +41 -0
  131. data/spec/models/add_group_attachment_request_spec.rb +46 -0
  132. data/spec/models/add_group_attachment_response_spec.rb +40 -0
  133. data/spec/models/aggregate_group_spec.rb +78 -0
  134. data/spec/models/author_metadata_override_spec.rb +46 -0
  135. data/spec/models/error_spec.rb +46 -0
  136. data/spec/models/eula_accept_list_item_spec.rb +58 -0
  137. data/spec/models/eula_accept_request_spec.rb +58 -0
  138. data/spec/models/eula_spec.rb +52 -0
  139. data/spec/models/eula_version_spec.rb +68 -0
  140. data/spec/models/features_enabled_spec.rb +62 -0
  141. data/spec/models/features_generation_settings_spec.rb +50 -0
  142. data/spec/models/features_similarity_spec.rb +52 -0
  143. data/spec/models/features_similarity_view_settings_spec.rb +112 -0
  144. data/spec/models/features_tenant_spec.rb +40 -0
  145. data/spec/models/features_viewer_modes_spec.rb +46 -0
  146. data/spec/models/group_attachment_response_spec.rb +62 -0
  147. data/spec/models/group_context_spec.rb +52 -0
  148. data/spec/models/group_spec.rb +56 -0
  149. data/spec/models/index_state_settings_spec.rb +40 -0
  150. data/spec/models/indexing_settings_spec.rb +40 -0
  151. data/spec/models/inline_response_200_spec.rb +40 -0
  152. data/spec/models/pdf_status_response_spec.rb +44 -0
  153. data/spec/models/rate_limit_error_spec.rb +46 -0
  154. data/spec/models/request_pdf_response_spec.rb +40 -0
  155. data/spec/models/sidebar_spec.rb +44 -0
  156. data/spec/models/similarity_generation_settings_spec.rb +66 -0
  157. data/spec/models/similarity_metadata_spec.rb +94 -0
  158. data/spec/models/similarity_metadata_top_matches_spec.rb +76 -0
  159. data/spec/models/similarity_put_request_spec.rb +52 -0
  160. data/spec/models/similarity_score_data_spec.rb +58 -0
  161. data/spec/models/similarity_settings_modes_spec.rb +46 -0
  162. data/spec/models/similarity_settings_spec.rb +56 -0
  163. data/spec/models/similarity_settings_view_settings_spec.rb +40 -0
  164. data/spec/models/similarity_view_settings_spec.rb +112 -0
  165. data/spec/models/similarity_viewer_url_response_spec.rb +40 -0
  166. data/spec/models/similarity_viewer_url_settings_spec.rb +86 -0
  167. data/spec/models/simple_submission_response_spec.rb +34 -0
  168. data/spec/models/submission_base_metadata_spec.rb +70 -0
  169. data/spec/models/submission_base_spec.rb +96 -0
  170. data/spec/models/submission_size_error_spec.rb +46 -0
  171. data/spec/models/submission_spec.rb +34 -0
  172. data/spec/models/success_message_spec.rb +40 -0
  173. data/spec/models/users_spec.rb +58 -0
  174. data/spec/models/viewer_permissions_spec.rb +64 -0
  175. data/spec/models/webhook_base_spec.rb +62 -0
  176. data/spec/models/webhook_path_request_spec.rb +50 -0
  177. data/spec/models/webhook_spec.rb +62 -0
  178. data/spec/models/webhook_with_secret_spec.rb +62 -0
  179. data/spec/spec_helper.rb +110 -0
  180. data/tca_client.gemspec +38 -0
  181. metadata +365 -0
@@ -0,0 +1,110 @@
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
+ # load the gem
13
+ require 'tca_client'
14
+
15
+ # The following was generated by the `rspec --init` command. Conventionally, all
16
+ # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
17
+ # The generated `.rspec` file contains `--require spec_helper` which will cause
18
+ # this file to always be loaded, without a need to explicitly require it in any
19
+ # files.
20
+ #
21
+ # Given that it is always loaded, you are encouraged to keep this file as
22
+ # light-weight as possible. Requiring heavyweight dependencies from this file
23
+ # will add to the boot time of your test suite on EVERY test run, even for an
24
+ # individual file that may not need all of that loaded. Instead, consider making
25
+ # a separate helper file that requires the additional dependencies and performs
26
+ # the additional setup, and require it from the spec files that actually need
27
+ # it.
28
+ #
29
+ # The `.rspec` file also contains a few flags that are not defaults but that
30
+ # users commonly want.
31
+ #
32
+ # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
33
+ RSpec.configure do |config|
34
+ # rspec-expectations config goes here. You can use an alternate
35
+ # assertion/expectation library such as wrong or the stdlib/minitest
36
+ # assertions if you prefer.
37
+ config.expect_with :rspec do |expectations|
38
+ # This option will default to `true` in RSpec 4. It makes the `description`
39
+ # and `failure_message` of custom matchers include text for helper methods
40
+ # defined using `chain`, e.g.:
41
+ # be_bigger_than(2).and_smaller_than(4).description
42
+ # # => "be bigger than 2 and smaller than 4"
43
+ # ...rather than:
44
+ # # => "be bigger than 2"
45
+ expectations.include_chain_clauses_in_custom_matcher_descriptions = true
46
+ end
47
+
48
+ # rspec-mocks config goes here. You can use an alternate test double
49
+ # library (such as bogus or mocha) by changing the `mock_with` option here.
50
+ config.mock_with :rspec do |mocks|
51
+ # Prevents you from mocking or stubbing a method that does not exist on
52
+ # a real object. This is generally recommended, and will default to
53
+ # `true` in RSpec 4.
54
+ mocks.verify_partial_doubles = true
55
+ end
56
+
57
+ # The settings below are suggested to provide a good initial experience
58
+ # with RSpec, but feel free to customize to your heart's content.
59
+ =begin
60
+ # These two settings work together to allow you to limit a spec run
61
+ # to individual examples or groups you care about by tagging them with
62
+ # `:focus` metadata. When nothing is tagged with `:focus`, all examples
63
+ # get run.
64
+ config.filter_run :focus
65
+ config.run_all_when_everything_filtered = true
66
+
67
+ # Allows RSpec to persist some state between runs in order to support
68
+ # the `--only-failures` and `--next-failure` CLI options. We recommend
69
+ # you configure your source control system to ignore this file.
70
+ config.example_status_persistence_file_path = "spec/examples.txt"
71
+
72
+ # Limits the available syntax to the non-monkey patched syntax that is
73
+ # recommended. For more details, see:
74
+ # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
75
+ # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
76
+ # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
77
+ config.disable_monkey_patching!
78
+
79
+ # This setting enables warnings. It's recommended, but in some cases may
80
+ # be too noisy due to issues in dependencies.
81
+ config.warnings = true
82
+
83
+ # Many RSpec users commonly either run the entire suite or an individual
84
+ # file, and it's useful to allow more verbose output when running an
85
+ # individual spec file.
86
+ if config.files_to_run.one?
87
+ # Use the documentation formatter for detailed output,
88
+ # unless a formatter has already been configured
89
+ # (e.g. via a command-line flag).
90
+ config.default_formatter = 'doc'
91
+ end
92
+
93
+ # Print the 10 slowest examples and example groups at the
94
+ # end of the spec run, to help surface which specs are running
95
+ # particularly slow.
96
+ config.profile_examples = 10
97
+
98
+ # Run specs in random order to surface order dependencies. If you find an
99
+ # order dependency and want to debug it, you can fix the order by providing
100
+ # the seed, which is printed after each run.
101
+ # --seed 1234
102
+ config.order = :random
103
+
104
+ # Seed global randomization in this process using the `--seed` CLI option.
105
+ # Setting this allows you to use `--seed` to deterministically reproduce
106
+ # test failures related to randomization by passing the same `--seed` value
107
+ # as the one that triggered the failure.
108
+ Kernel.srand config.seed
109
+ =end
110
+ end
@@ -0,0 +1,38 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ =begin
4
+ #Turnitin Core API
5
+
6
+ #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
7
+
8
+ OpenAPI spec version: 1.0.249
9
+
10
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
11
+ Swagger Codegen version: 3.0.35
12
+ =end
13
+
14
+ $:.push File.expand_path("../lib", __FILE__)
15
+ require "tca_client/version"
16
+
17
+ Gem::Specification.new do |s|
18
+ s.name = "tca_client"
19
+ s.version = TCAClient::VERSION
20
+ s.platform = Gem::Platform::RUBY
21
+ s.authors = ["Swagger-Codegen"]
22
+ s.email = [""]
23
+ s.homepage = "https://github.com/swagger-api/swagger-codegen"
24
+ s.summary = "Turnitin Core API Ruby Gem"
25
+ s.description = "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 "
26
+ s.license = "Unlicense"
27
+ s.required_ruby_version = ">= 1.9"
28
+
29
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
30
+ s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
31
+
32
+ s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
33
+
34
+ s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
35
+ s.test_files = `find spec/*`.split("\n")
36
+ s.executables = []
37
+ s.require_paths = ["lib"]
38
+ end
metadata ADDED
@@ -0,0 +1,365 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: tca_client
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Swagger-Codegen
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-11-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: typhoeus
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.0'
20
+ - - ">="
21
+ - !ruby/object:Gem::Version
22
+ version: 1.0.1
23
+ type: :runtime
24
+ prerelease: false
25
+ version_requirements: !ruby/object:Gem::Requirement
26
+ requirements:
27
+ - - "~>"
28
+ - !ruby/object:Gem::Version
29
+ version: '1.0'
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 1.0.1
33
+ - !ruby/object:Gem::Dependency
34
+ name: json
35
+ requirement: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '2.1'
40
+ - - ">="
41
+ - !ruby/object:Gem::Version
42
+ version: 2.1.0
43
+ type: :runtime
44
+ prerelease: false
45
+ version_requirements: !ruby/object:Gem::Requirement
46
+ requirements:
47
+ - - "~>"
48
+ - !ruby/object:Gem::Version
49
+ version: '2.1'
50
+ - - ">="
51
+ - !ruby/object:Gem::Version
52
+ version: 2.1.0
53
+ - !ruby/object:Gem::Dependency
54
+ name: rspec
55
+ requirement: !ruby/object:Gem::Requirement
56
+ requirements:
57
+ - - "~>"
58
+ - !ruby/object:Gem::Version
59
+ version: '3.6'
60
+ - - ">="
61
+ - !ruby/object:Gem::Version
62
+ version: 3.6.0
63
+ type: :development
64
+ prerelease: false
65
+ version_requirements: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - "~>"
68
+ - !ruby/object:Gem::Version
69
+ version: '3.6'
70
+ - - ">="
71
+ - !ruby/object:Gem::Version
72
+ version: 3.6.0
73
+ description: 'Turnitin Core API (TCA) provides direct API access to the core functionality
74
+ provided by Turnitin. TCA supports file submission, similarity report generation,
75
+ group management, and visualization of report matches via Cloud Viewer or PDF download.
76
+ Below is the full flow to successfully set up an integration scope, an API Key,
77
+ and make calls to TCA. Integration Scope and API Key management is done via the
78
+ Admin Console UI by logging in as an admin user. For more details, go to our [developer
79
+ portal documentation page](https://developers.turnitin.com/docs). ## Integration
80
+ Scope and API Key Management TCA API calls must provide an API Key for authentication,
81
+ so you must first have at least one integration scope associated with at least one
82
+ API Key to use TCA. ### Admin Console UI First, login to Admin Console UI as an
83
+ *Admin* user with permission to create Integration Scopes, under a tenant that is
84
+ licensed to use the TCA product Integration Scopes (you can create a new one, or
85
+ add keys to existing) * Click `Integrations` in the side bar --> `+ Add Integration`
86
+ at top the top of the page --> Enter a name --> `Add` Button API Keys * Click
87
+ `Integrations` in the side bar --> `Create API Key` Button next to a given Integration
88
+ Scope --> Enter a name --> click `Create and View button` * Copy/Save the key
89
+ manually or click save to clipboard button to copy it (this is the only time it
90
+ will show) ## TCA Flow * Register a webhook * Create a submission * Upload
91
+ a file for the submission * Wait for the submission upload to process *
92
+ If you registered a webhook, a callback will be sent to it when upload is complete *
93
+ The status of the *submission* will also update to `COMPLETE` * Request a Similarity
94
+ Report * Wait for similarity report to process * If you registered a webhook,
95
+ a callback will be sent to it when report is complete * The status of the *report*
96
+ will also be updated to `COMPLETE` * Request a URL with parameters to view the
97
+ Similarity Report '
98
+ email:
99
+ - ''
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - Gemfile
105
+ - README.md
106
+ - Rakefile
107
+ - docs/AddGroupAttachmentRequest.md
108
+ - docs/AddGroupAttachmentResponse.md
109
+ - docs/AggregateGroup.md
110
+ - docs/AuthorMetadataOverride.md
111
+ - docs/EULAApi.md
112
+ - docs/Error.md
113
+ - docs/Eula.md
114
+ - docs/EulaAcceptListItem.md
115
+ - docs/EulaAcceptRequest.md
116
+ - docs/EulaVersion.md
117
+ - docs/FeaturesApi.md
118
+ - docs/FeaturesEnabled.md
119
+ - docs/FeaturesGenerationSettings.md
120
+ - docs/FeaturesSimilarity.md
121
+ - docs/FeaturesSimilarityViewSettings.md
122
+ - docs/FeaturesTenant.md
123
+ - docs/FeaturesViewerModes.md
124
+ - docs/Group.md
125
+ - docs/GroupAttachmentResponse.md
126
+ - docs/GroupContext.md
127
+ - docs/GroupsApi.md
128
+ - docs/IndexApi.md
129
+ - docs/IndexStateSettings.md
130
+ - docs/IndexingSettings.md
131
+ - docs/InlineResponse200.md
132
+ - docs/PdfStatusResponse.md
133
+ - docs/RateLimitError.md
134
+ - docs/RequestPdfResponse.md
135
+ - docs/Sidebar.md
136
+ - docs/SimilarityApi.md
137
+ - docs/SimilarityGenerationSettings.md
138
+ - docs/SimilarityMetadata.md
139
+ - docs/SimilarityMetadataTopMatches.md
140
+ - docs/SimilarityPutRequest.md
141
+ - docs/SimilarityScoreData.md
142
+ - docs/SimilaritySettings.md
143
+ - docs/SimilaritySettingsModes.md
144
+ - docs/SimilaritySettingsViewSettings.md
145
+ - docs/SimilarityViewSettings.md
146
+ - docs/SimilarityViewerUrlResponse.md
147
+ - docs/SimilarityViewerUrlSettings.md
148
+ - docs/SimpleSubmissionResponse.md
149
+ - docs/Submission.md
150
+ - docs/SubmissionApi.md
151
+ - docs/SubmissionBase.md
152
+ - docs/SubmissionBaseMetadata.md
153
+ - docs/SubmissionSizeError.md
154
+ - docs/SuccessMessage.md
155
+ - docs/Users.md
156
+ - docs/ViewerPermissions.md
157
+ - docs/Webhook.md
158
+ - docs/WebhookApi.md
159
+ - docs/WebhookBase.md
160
+ - docs/WebhookPathRequest.md
161
+ - docs/WebhookWithSecret.md
162
+ - git_push.sh
163
+ - lib/tca_client.rb
164
+ - lib/tca_client/api/eula_api.rb
165
+ - lib/tca_client/api/features_api.rb
166
+ - lib/tca_client/api/groups_api.rb
167
+ - lib/tca_client/api/index_api.rb
168
+ - lib/tca_client/api/similarity_api.rb
169
+ - lib/tca_client/api/submission_api.rb
170
+ - lib/tca_client/api/webhook_api.rb
171
+ - lib/tca_client/api_client.rb
172
+ - lib/tca_client/api_error.rb
173
+ - lib/tca_client/configuration.rb
174
+ - lib/tca_client/models/add_group_attachment_request.rb
175
+ - lib/tca_client/models/add_group_attachment_response.rb
176
+ - lib/tca_client/models/aggregate_group.rb
177
+ - lib/tca_client/models/author_metadata_override.rb
178
+ - lib/tca_client/models/error.rb
179
+ - lib/tca_client/models/eula.rb
180
+ - lib/tca_client/models/eula_accept_list_item.rb
181
+ - lib/tca_client/models/eula_accept_request.rb
182
+ - lib/tca_client/models/eula_version.rb
183
+ - lib/tca_client/models/features_enabled.rb
184
+ - lib/tca_client/models/features_generation_settings.rb
185
+ - lib/tca_client/models/features_similarity.rb
186
+ - lib/tca_client/models/features_similarity_view_settings.rb
187
+ - lib/tca_client/models/features_tenant.rb
188
+ - lib/tca_client/models/features_viewer_modes.rb
189
+ - lib/tca_client/models/group.rb
190
+ - lib/tca_client/models/group_attachment_response.rb
191
+ - lib/tca_client/models/group_context.rb
192
+ - lib/tca_client/models/index_state_settings.rb
193
+ - lib/tca_client/models/indexing_settings.rb
194
+ - lib/tca_client/models/inline_response_200.rb
195
+ - lib/tca_client/models/pdf_status_response.rb
196
+ - lib/tca_client/models/rate_limit_error.rb
197
+ - lib/tca_client/models/request_pdf_response.rb
198
+ - lib/tca_client/models/sidebar.rb
199
+ - lib/tca_client/models/similarity_generation_settings.rb
200
+ - lib/tca_client/models/similarity_metadata.rb
201
+ - lib/tca_client/models/similarity_metadata_top_matches.rb
202
+ - lib/tca_client/models/similarity_put_request.rb
203
+ - lib/tca_client/models/similarity_score_data.rb
204
+ - lib/tca_client/models/similarity_settings.rb
205
+ - lib/tca_client/models/similarity_settings_modes.rb
206
+ - lib/tca_client/models/similarity_settings_view_settings.rb
207
+ - lib/tca_client/models/similarity_view_settings.rb
208
+ - lib/tca_client/models/similarity_viewer_url_response.rb
209
+ - lib/tca_client/models/similarity_viewer_url_settings.rb
210
+ - lib/tca_client/models/simple_submission_response.rb
211
+ - lib/tca_client/models/submission.rb
212
+ - lib/tca_client/models/submission_base.rb
213
+ - lib/tca_client/models/submission_base_metadata.rb
214
+ - lib/tca_client/models/submission_size_error.rb
215
+ - lib/tca_client/models/success_message.rb
216
+ - lib/tca_client/models/users.rb
217
+ - lib/tca_client/models/viewer_permissions.rb
218
+ - lib/tca_client/models/webhook.rb
219
+ - lib/tca_client/models/webhook_base.rb
220
+ - lib/tca_client/models/webhook_path_request.rb
221
+ - lib/tca_client/models/webhook_with_secret.rb
222
+ - lib/tca_client/version.rb
223
+ - spec/api/eula_api_spec.rb
224
+ - spec/api/features_api_spec.rb
225
+ - spec/api/groups_api_spec.rb
226
+ - spec/api/index_api_spec.rb
227
+ - spec/api/similarity_api_spec.rb
228
+ - spec/api/submission_api_spec.rb
229
+ - spec/api/webhook_api_spec.rb
230
+ - spec/api_client_spec.rb
231
+ - spec/base_object_spec.rb
232
+ - spec/configuration_spec.rb
233
+ - spec/models/add_group_attachment_request_spec.rb
234
+ - spec/models/add_group_attachment_response_spec.rb
235
+ - spec/models/aggregate_group_spec.rb
236
+ - spec/models/author_metadata_override_spec.rb
237
+ - spec/models/error_spec.rb
238
+ - spec/models/eula_accept_list_item_spec.rb
239
+ - spec/models/eula_accept_request_spec.rb
240
+ - spec/models/eula_spec.rb
241
+ - spec/models/eula_version_spec.rb
242
+ - spec/models/features_enabled_spec.rb
243
+ - spec/models/features_generation_settings_spec.rb
244
+ - spec/models/features_similarity_spec.rb
245
+ - spec/models/features_similarity_view_settings_spec.rb
246
+ - spec/models/features_tenant_spec.rb
247
+ - spec/models/features_viewer_modes_spec.rb
248
+ - spec/models/group_attachment_response_spec.rb
249
+ - spec/models/group_context_spec.rb
250
+ - spec/models/group_spec.rb
251
+ - spec/models/index_state_settings_spec.rb
252
+ - spec/models/indexing_settings_spec.rb
253
+ - spec/models/inline_response_200_spec.rb
254
+ - spec/models/pdf_status_response_spec.rb
255
+ - spec/models/rate_limit_error_spec.rb
256
+ - spec/models/request_pdf_response_spec.rb
257
+ - spec/models/sidebar_spec.rb
258
+ - spec/models/similarity_generation_settings_spec.rb
259
+ - spec/models/similarity_metadata_spec.rb
260
+ - spec/models/similarity_metadata_top_matches_spec.rb
261
+ - spec/models/similarity_put_request_spec.rb
262
+ - spec/models/similarity_score_data_spec.rb
263
+ - spec/models/similarity_settings_modes_spec.rb
264
+ - spec/models/similarity_settings_spec.rb
265
+ - spec/models/similarity_settings_view_settings_spec.rb
266
+ - spec/models/similarity_view_settings_spec.rb
267
+ - spec/models/similarity_viewer_url_response_spec.rb
268
+ - spec/models/similarity_viewer_url_settings_spec.rb
269
+ - spec/models/simple_submission_response_spec.rb
270
+ - spec/models/submission_base_metadata_spec.rb
271
+ - spec/models/submission_base_spec.rb
272
+ - spec/models/submission_size_error_spec.rb
273
+ - spec/models/submission_spec.rb
274
+ - spec/models/success_message_spec.rb
275
+ - spec/models/users_spec.rb
276
+ - spec/models/viewer_permissions_spec.rb
277
+ - spec/models/webhook_base_spec.rb
278
+ - spec/models/webhook_path_request_spec.rb
279
+ - spec/models/webhook_spec.rb
280
+ - spec/models/webhook_with_secret_spec.rb
281
+ - spec/spec_helper.rb
282
+ - tca_client.gemspec
283
+ homepage: https://github.com/swagger-api/swagger-codegen
284
+ licenses:
285
+ - Unlicense
286
+ metadata: {}
287
+ post_install_message:
288
+ rdoc_options: []
289
+ require_paths:
290
+ - lib
291
+ required_ruby_version: !ruby/object:Gem::Requirement
292
+ requirements:
293
+ - - ">="
294
+ - !ruby/object:Gem::Version
295
+ version: '1.9'
296
+ required_rubygems_version: !ruby/object:Gem::Requirement
297
+ requirements:
298
+ - - ">="
299
+ - !ruby/object:Gem::Version
300
+ version: '0'
301
+ requirements: []
302
+ rubygems_version: 3.3.7
303
+ signing_key:
304
+ specification_version: 4
305
+ summary: Turnitin Core API Ruby Gem
306
+ test_files:
307
+ - spec/api/submission_api_spec.rb
308
+ - spec/api/groups_api_spec.rb
309
+ - spec/api/webhook_api_spec.rb
310
+ - spec/api/features_api_spec.rb
311
+ - spec/api/eula_api_spec.rb
312
+ - spec/api/similarity_api_spec.rb
313
+ - spec/api/index_api_spec.rb
314
+ - spec/api_client_spec.rb
315
+ - spec/base_object_spec.rb
316
+ - spec/configuration_spec.rb
317
+ - spec/models/error_spec.rb
318
+ - spec/models/eula_accept_request_spec.rb
319
+ - spec/models/webhook_spec.rb
320
+ - spec/models/features_similarity_spec.rb
321
+ - spec/models/index_state_settings_spec.rb
322
+ - spec/models/webhook_base_spec.rb
323
+ - spec/models/similarity_view_settings_spec.rb
324
+ - spec/models/group_attachment_response_spec.rb
325
+ - spec/models/eula_spec.rb
326
+ - spec/models/viewer_permissions_spec.rb
327
+ - spec/models/sidebar_spec.rb
328
+ - spec/models/similarity_settings_modes_spec.rb
329
+ - spec/models/webhook_with_secret_spec.rb
330
+ - spec/models/eula_version_spec.rb
331
+ - spec/models/similarity_score_data_spec.rb
332
+ - spec/models/simple_submission_response_spec.rb
333
+ - spec/models/features_tenant_spec.rb
334
+ - spec/models/eula_accept_list_item_spec.rb
335
+ - spec/models/features_viewer_modes_spec.rb
336
+ - spec/models/features_similarity_view_settings_spec.rb
337
+ - spec/models/similarity_settings_view_settings_spec.rb
338
+ - spec/models/indexing_settings_spec.rb
339
+ - spec/models/similarity_settings_spec.rb
340
+ - spec/models/group_context_spec.rb
341
+ - spec/models/submission_spec.rb
342
+ - spec/models/pdf_status_response_spec.rb
343
+ - spec/models/submission_size_error_spec.rb
344
+ - spec/models/inline_response_200_spec.rb
345
+ - spec/models/similarity_put_request_spec.rb
346
+ - spec/models/group_spec.rb
347
+ - spec/models/similarity_metadata_top_matches_spec.rb
348
+ - spec/models/submission_base_spec.rb
349
+ - spec/models/add_group_attachment_request_spec.rb
350
+ - spec/models/success_message_spec.rb
351
+ - spec/models/aggregate_group_spec.rb
352
+ - spec/models/similarity_metadata_spec.rb
353
+ - spec/models/users_spec.rb
354
+ - spec/models/features_generation_settings_spec.rb
355
+ - spec/models/rate_limit_error_spec.rb
356
+ - spec/models/similarity_generation_settings_spec.rb
357
+ - spec/models/author_metadata_override_spec.rb
358
+ - spec/models/webhook_path_request_spec.rb
359
+ - spec/models/features_enabled_spec.rb
360
+ - spec/models/similarity_viewer_url_settings_spec.rb
361
+ - spec/models/request_pdf_response_spec.rb
362
+ - spec/models/submission_base_metadata_spec.rb
363
+ - spec/models/similarity_viewer_url_response_spec.rb
364
+ - spec/models/add_group_attachment_response_spec.rb
365
+ - spec/spec_helper.rb