phrase 0.4.33 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile +6 -0
- data/LICENSE +17 -18
- data/README.md +712 -220
- data/Rakefile +7 -4
- data/docs/Account.md +25 -0
- data/docs/AccountDetails.md +27 -0
- data/docs/AccountDetails1.md +17 -0
- data/docs/AccountsApi.md +136 -0
- data/docs/AffectedCount.md +17 -0
- data/docs/AffectedResources.md +17 -0
- data/docs/Authorization.md +31 -0
- data/docs/AuthorizationCreateParameters.md +21 -0
- data/docs/AuthorizationUpdateParameters.md +21 -0
- data/docs/AuthorizationWithToken.md +33 -0
- data/docs/AuthorizationWithToken1.md +17 -0
- data/docs/AuthorizationsApi.md +325 -0
- data/docs/BitbucketSync.md +27 -0
- data/docs/BitbucketSyncApi.md +200 -0
- data/docs/BitbucketSyncExportParameters.md +17 -0
- data/docs/BitbucketSyncExportResponse.md +17 -0
- data/docs/BitbucketSyncImportParameters.md +17 -0
- data/docs/BlacklistedKey.md +23 -0
- data/docs/BlacklistedKeyCreateParameters.md +17 -0
- data/docs/BlacklistedKeyUpdateParameters.md +17 -0
- data/docs/BlacklistedKeysApi.md +335 -0
- data/docs/Branch.md +29 -0
- data/docs/BranchCreateParameters.md +17 -0
- data/docs/BranchMergeParameters.md +17 -0
- data/docs/BranchUpdateParameters.md +17 -0
- data/docs/BranchesApi.md +465 -0
- data/docs/Comment.md +25 -0
- data/docs/CommentCreateParameters.md +19 -0
- data/docs/CommentMarkReadParameters.md +17 -0
- data/docs/CommentUpdateParameters.md +19 -0
- data/docs/CommentsApi.md +555 -0
- data/docs/Distribution.md +29 -0
- data/docs/DistributionCreateParameters.md +29 -0
- data/docs/DistributionPreview.md +29 -0
- data/docs/DistributionUpdateParameters.md +29 -0
- data/docs/DistributionsApi.md +335 -0
- data/docs/Format.md +35 -0
- data/docs/FormatsApi.md +69 -0
- data/docs/GitLabSyncApi.md +470 -0
- data/docs/GitlabSync.md +37 -0
- data/docs/GitlabSyncExport.md +19 -0
- data/docs/GitlabSyncExportParameters.md +17 -0
- data/docs/GitlabSyncHistory.md +25 -0
- data/docs/GitlabSyncImportParameters.md +17 -0
- data/docs/Glossary.md +25 -0
- data/docs/GlossaryApi.md +335 -0
- data/docs/GlossaryCreateParameters.md +21 -0
- data/docs/GlossaryTerm.md +31 -0
- data/docs/GlossaryTermCreateParameters.md +23 -0
- data/docs/GlossaryTermTranslation.md +25 -0
- data/docs/GlossaryTermTranslationCreateParameters.md +19 -0
- data/docs/GlossaryTermTranslationUpdateParameters.md +19 -0
- data/docs/GlossaryTermTranslationsApi.md +215 -0
- data/docs/GlossaryTermUpdateParameters.md +23 -0
- data/docs/GlossaryTermsApi.md +345 -0
- data/docs/GlossaryUpdateParameters.md +21 -0
- data/docs/Invitation.md +35 -0
- data/docs/InvitationCreateParameters.md +25 -0
- data/docs/InvitationUpdateParameters.md +23 -0
- data/docs/InvitationsApi.md +400 -0
- data/docs/Job.md +29 -0
- data/docs/JobCompleteParameters.md +17 -0
- data/docs/JobCreateParameters.md +27 -0
- data/docs/JobDetails.md +37 -0
- data/docs/JobDetails1.md +23 -0
- data/docs/JobKeysCreateParameters.md +19 -0
- data/docs/JobLocale.md +23 -0
- data/docs/JobLocaleCompleteParameters.md +17 -0
- data/docs/JobLocaleReopenParameters.md +17 -0
- data/docs/JobLocaleUpdateParameters.md +21 -0
- data/docs/JobLocalesApi.md +489 -0
- data/docs/JobLocalesCreateParameters.md +21 -0
- data/docs/JobPreview.md +21 -0
- data/docs/JobReopenParameters.md +17 -0
- data/docs/JobStartParameters.md +17 -0
- data/docs/JobUpdateParameters.md +23 -0
- data/docs/JobsApi.md +683 -0
- data/docs/KeyCreateParameters.md +45 -0
- data/docs/KeyPreview.md +21 -0
- data/docs/KeyUpdateParameters.md +45 -0
- data/docs/KeysApi.md +617 -0
- data/docs/KeysSearchParameters.md +25 -0
- data/docs/KeysTagParameters.md +23 -0
- data/docs/KeysUntagParameters.md +23 -0
- data/docs/Locale.md +35 -0
- data/docs/LocaleCreateParameters.md +35 -0
- data/docs/LocaleDetails.md +37 -0
- data/docs/LocaleDetails1.md +17 -0
- data/docs/LocalePreview.md +21 -0
- data/docs/LocaleStatistics.md +29 -0
- data/docs/LocaleUpdateParameters.md +35 -0
- data/docs/LocalesApi.md +433 -0
- data/docs/Member.md +25 -0
- data/docs/MemberUpdateParameters.md +23 -0
- data/docs/MembersApi.md +271 -0
- data/docs/OrderConfirmParameters.md +17 -0
- data/docs/OrderCreateParameters.md +43 -0
- data/docs/OrdersApi.md +341 -0
- data/docs/Project.md +29 -0
- data/docs/ProjectCreateParameters.md +27 -0
- data/docs/ProjectDetails.md +33 -0
- data/docs/ProjectDetails1.md +19 -0
- data/docs/ProjectLocales.md +27 -0
- data/docs/ProjectLocales1.md +17 -0
- data/docs/ProjectShort.md +25 -0
- data/docs/ProjectUpdateParameters.md +27 -0
- data/docs/ProjectsApi.md +325 -0
- data/docs/Release.md +37 -0
- data/docs/ReleaseCreateParameters.md +21 -0
- data/docs/ReleasePreview.md +37 -0
- data/docs/ReleaseUpdateParameters.md +21 -0
- data/docs/ReleasesApi.md +412 -0
- data/docs/Screenshot.md +29 -0
- data/docs/ScreenshotCreateParameters.md +21 -0
- data/docs/ScreenshotMarker.md +27 -0
- data/docs/ScreenshotMarkerCreateParameters.md +19 -0
- data/docs/ScreenshotMarkerUpdateParameters.md +19 -0
- data/docs/ScreenshotMarkersApi.md +341 -0
- data/docs/ScreenshotUpdateParameters.md +21 -0
- data/docs/ScreenshotsApi.md +335 -0
- data/docs/Space.md +27 -0
- data/docs/SpaceCreateParameters.md +17 -0
- data/docs/SpaceUpdateParameters.md +17 -0
- data/docs/SpacesApi.md +536 -0
- data/docs/SpacesProjectsCreateParameters.md +17 -0
- data/docs/StyleGuidesApi.md +335 -0
- data/docs/Styleguide.md +23 -0
- data/docs/StyleguideCreateParameters.md +41 -0
- data/docs/StyleguideDetails.md +49 -0
- data/docs/StyleguideDetails1.md +41 -0
- data/docs/StyleguidePreview.md +19 -0
- data/docs/StyleguideUpdateParameters.md +41 -0
- data/docs/Tag.md +23 -0
- data/docs/TagCreateParameters.md +19 -0
- data/docs/TagWithStats.md +25 -0
- data/docs/TagWithStats1.md +17 -0
- data/docs/TagWithStats1Statistics.md +23 -0
- data/docs/TagWithStats1Statistics1.md +19 -0
- data/docs/TagsApi.md +274 -0
- data/docs/Translation.md +37 -0
- data/docs/TranslationCreateParameters.md +31 -0
- data/docs/TranslationDetails.md +41 -0
- data/docs/TranslationDetails1.md +19 -0
- data/docs/TranslationExcludeParameters.md +17 -0
- data/docs/TranslationIncludeParameters.md +17 -0
- data/docs/TranslationKey.md +33 -0
- data/docs/TranslationKeyDetails.md +51 -0
- data/docs/TranslationKeyDetails1.md +33 -0
- data/docs/TranslationOrder.md +49 -0
- data/docs/TranslationReviewParameters.md +17 -0
- data/docs/TranslationUnverifyParameters.md +17 -0
- data/docs/TranslationUpdateParameters.md +27 -0
- data/docs/TranslationVerifyParameters.md +17 -0
- data/docs/TranslationVersion.md +31 -0
- data/docs/TranslationVersionWithUser.md +33 -0
- data/docs/TranslationVersionWithUser1.md +17 -0
- data/docs/TranslationsApi.md +1164 -0
- data/docs/TranslationsExcludeParameters.md +23 -0
- data/docs/TranslationsIncludeParameters.md +23 -0
- data/docs/TranslationsReviewParameters.md +19 -0
- data/docs/TranslationsSearchParameters.md +23 -0
- data/docs/TranslationsUnverifyParameters.md +23 -0
- data/docs/TranslationsVerifyParameters.md +23 -0
- data/docs/Upload.md +31 -0
- data/docs/UploadCreateParameters.md +45 -0
- data/docs/UploadSummary.md +31 -0
- data/docs/UploadsApi.md +232 -0
- data/docs/User.md +29 -0
- data/docs/UserPreview.md +21 -0
- data/docs/UsersApi.md +69 -0
- data/docs/VersionsHistoryApi.md +148 -0
- data/docs/Webhook.md +29 -0
- data/docs/WebhookCreateParameters.md +23 -0
- data/docs/WebhookUpdateParameters.md +23 -0
- data/docs/WebhooksApi.md +399 -0
- data/git_push.sh +58 -0
- data/lib/phrase.rb +197 -55
- data/lib/phrase/api/accounts_api.rb +142 -0
- data/lib/phrase/api/authorizations_api.rb +346 -0
- data/lib/phrase/api/bitbucket_sync_api.rb +219 -0
- data/lib/phrase/api/blacklisted_keys_api.rb +376 -0
- data/lib/phrase/api/branches_api.rb +524 -0
- data/lib/phrase/api/comments_api.rb +657 -0
- data/lib/phrase/api/distributions_api.rb +376 -0
- data/lib/phrase/api/formats_api.rb +70 -0
- data/lib/phrase/api/git_lab_sync_api.rb +510 -0
- data/lib/phrase/api/glossary_api.rb +376 -0
- data/lib/phrase/api/glossary_term_translations_api.rb +268 -0
- data/lib/phrase/api/glossary_terms_api.rb +406 -0
- data/lib/phrase/api/invitations_api.rb +448 -0
- data/lib/phrase/api/job_locales_api.rb +587 -0
- data/lib/phrase/api/jobs_api.rb +790 -0
- data/lib/phrase/api/keys_api.rb +700 -0
- data/lib/phrase/api/locales_api.rb +497 -0
- data/lib/phrase/api/members_api.rb +304 -0
- data/lib/phrase/api/orders_api.rb +385 -0
- data/lib/phrase/api/projects_api.rb +346 -0
- data/lib/phrase/api/releases_api.rb +484 -0
- data/lib/phrase/api/screenshot_markers_api.rb +394 -0
- data/lib/phrase/api/screenshots_api.rb +376 -0
- data/lib/phrase/api/spaces_api.rb +608 -0
- data/lib/phrase/api/style_guides_api.rb +376 -0
- data/lib/phrase/api/tags_api.rb +305 -0
- data/lib/phrase/api/translations_api.rb +1351 -0
- data/lib/phrase/api/uploads_api.rb +265 -0
- data/lib/phrase/api/users_api.rb +70 -0
- data/lib/phrase/api/versions_history_api.rb +172 -0
- data/lib/phrase/api/webhooks_api.rb +446 -0
- data/lib/phrase/api_client.rb +376 -0
- data/lib/phrase/api_error.rb +45 -0
- data/lib/phrase/configuration.rb +243 -0
- data/lib/phrase/models/account.rb +230 -0
- data/lib/phrase/models/account_details.rb +247 -0
- data/lib/phrase/models/account_details1.rb +194 -0
- data/lib/phrase/models/affected_count.rb +194 -0
- data/lib/phrase/models/affected_resources.rb +194 -0
- data/lib/phrase/models/authorization.rb +259 -0
- data/lib/phrase/models/authorization_create_parameters.rb +217 -0
- data/lib/phrase/models/authorization_update_parameters.rb +217 -0
- data/lib/phrase/models/authorization_with_token.rb +276 -0
- data/lib/phrase/models/authorization_with_token1.rb +194 -0
- data/lib/phrase/models/bitbucket_sync.rb +241 -0
- data/lib/phrase/models/bitbucket_sync_export_parameters.rb +195 -0
- data/lib/phrase/models/bitbucket_sync_export_response.rb +194 -0
- data/lib/phrase/models/bitbucket_sync_import_parameters.rb +195 -0
- data/lib/phrase/models/blacklisted_key.rb +221 -0
- data/lib/phrase/models/blacklisted_key_create_parameters.rb +195 -0
- data/lib/phrase/models/blacklisted_key_update_parameters.rb +195 -0
- data/lib/phrase/models/branch.rb +248 -0
- data/lib/phrase/models/branch_create_parameters.rb +195 -0
- data/lib/phrase/models/branch_merge_parameters.rb +195 -0
- data/lib/phrase/models/branch_update_parameters.rb +195 -0
- data/lib/phrase/models/comment.rb +230 -0
- data/lib/phrase/models/comment_create_parameters.rb +205 -0
- data/lib/phrase/models/comment_mark_read_parameters.rb +195 -0
- data/lib/phrase/models/comment_update_parameters.rb +205 -0
- data/lib/phrase/models/distribution.rb +252 -0
- data/lib/phrase/models/distribution_create_parameters.rb +259 -0
- data/lib/phrase/models/distribution_preview.rb +250 -0
- data/lib/phrase/models/distribution_update_parameters.rb +259 -0
- data/lib/phrase/models/format.rb +275 -0
- data/lib/phrase/models/gitlab_sync.rb +284 -0
- data/lib/phrase/models/gitlab_sync_export.rb +203 -0
- data/lib/phrase/models/gitlab_sync_export_parameters.rb +195 -0
- data/lib/phrase/models/gitlab_sync_history.rb +232 -0
- data/lib/phrase/models/gitlab_sync_import_parameters.rb +195 -0
- data/lib/phrase/models/glossary.rb +232 -0
- data/lib/phrase/models/glossary_create_parameters.rb +217 -0
- data/lib/phrase/models/glossary_term.rb +259 -0
- data/lib/phrase/models/glossary_term_create_parameters.rb +225 -0
- data/lib/phrase/models/glossary_term_translation.rb +230 -0
- data/lib/phrase/models/glossary_term_translation_create_parameters.rb +205 -0
- data/lib/phrase/models/glossary_term_translation_update_parameters.rb +205 -0
- data/lib/phrase/models/glossary_term_update_parameters.rb +225 -0
- data/lib/phrase/models/glossary_update_parameters.rb +217 -0
- data/lib/phrase/models/invitation.rb +279 -0
- data/lib/phrase/models/invitation_create_parameters.rb +237 -0
- data/lib/phrase/models/invitation_update_parameters.rb +227 -0
- data/lib/phrase/models/job.rb +248 -0
- data/lib/phrase/models/job_complete_parameters.rb +195 -0
- data/lib/phrase/models/job_create_parameters.rb +249 -0
- data/lib/phrase/models/job_details.rb +296 -0
- data/lib/phrase/models/job_details1.rb +225 -0
- data/lib/phrase/models/job_keys_create_parameters.rb +207 -0
- data/lib/phrase/models/job_locale.rb +223 -0
- data/lib/phrase/models/job_locale_complete_parameters.rb +195 -0
- data/lib/phrase/models/job_locale_reopen_parameters.rb +195 -0
- data/lib/phrase/models/job_locale_update_parameters.rb +217 -0
- data/lib/phrase/models/job_locales_create_parameters.rb +217 -0
- data/lib/phrase/models/job_preview.rb +212 -0
- data/lib/phrase/models/job_reopen_parameters.rb +195 -0
- data/lib/phrase/models/job_start_parameters.rb +195 -0
- data/lib/phrase/models/job_update_parameters.rb +225 -0
- data/lib/phrase/models/key_create_parameters.rb +335 -0
- data/lib/phrase/models/key_preview.rb +212 -0
- data/lib/phrase/models/key_update_parameters.rb +335 -0
- data/lib/phrase/models/keys_search_parameters.rb +235 -0
- data/lib/phrase/models/keys_tag_parameters.rb +225 -0
- data/lib/phrase/models/keys_untag_parameters.rb +225 -0
- data/lib/phrase/models/locale.rb +277 -0
- data/lib/phrase/models/locale_create_parameters.rb +285 -0
- data/lib/phrase/models/locale_details.rb +294 -0
- data/lib/phrase/models/locale_details1.rb +194 -0
- data/lib/phrase/models/locale_preview.rb +212 -0
- data/lib/phrase/models/locale_statistics.rb +248 -0
- data/lib/phrase/models/locale_update_parameters.rb +285 -0
- data/lib/phrase/models/member.rb +232 -0
- data/lib/phrase/models/member_update_parameters.rb +227 -0
- data/lib/phrase/models/order_confirm_parameters.rb +195 -0
- data/lib/phrase/models/order_create_parameters.rb +327 -0
- data/lib/phrase/models/project.rb +248 -0
- data/lib/phrase/models/project_create_parameters.rb +245 -0
- data/lib/phrase/models/project_details.rb +274 -0
- data/lib/phrase/models/project_details1.rb +203 -0
- data/lib/phrase/models/project_locales.rb +249 -0
- data/lib/phrase/models/project_locales1.rb +196 -0
- data/lib/phrase/models/project_short.rb +230 -0
- data/lib/phrase/models/project_update_parameters.rb +245 -0
- data/lib/phrase/models/release.rb +290 -0
- data/lib/phrase/models/release_create_parameters.rb +217 -0
- data/lib/phrase/models/release_preview.rb +290 -0
- data/lib/phrase/models/release_update_parameters.rb +217 -0
- data/lib/phrase/models/screenshot.rb +248 -0
- data/lib/phrase/models/screenshot_create_parameters.rb +215 -0
- data/lib/phrase/models/screenshot_marker.rb +239 -0
- data/lib/phrase/models/screenshot_marker_create_parameters.rb +205 -0
- data/lib/phrase/models/screenshot_marker_update_parameters.rb +205 -0
- data/lib/phrase/models/screenshot_update_parameters.rb +215 -0
- data/lib/phrase/models/space.rb +241 -0
- data/lib/phrase/models/space_create_parameters.rb +195 -0
- data/lib/phrase/models/space_update_parameters.rb +195 -0
- data/lib/phrase/models/spaces_projects_create_parameters.rb +195 -0
- data/lib/phrase/models/styleguide.rb +221 -0
- data/lib/phrase/models/styleguide_create_parameters.rb +315 -0
- data/lib/phrase/models/styleguide_details.rb +346 -0
- data/lib/phrase/models/styleguide_details1.rb +302 -0
- data/lib/phrase/models/styleguide_preview.rb +203 -0
- data/lib/phrase/models/styleguide_update_parameters.rb +315 -0
- data/lib/phrase/models/tag.rb +221 -0
- data/lib/phrase/models/tag_create_parameters.rb +205 -0
- data/lib/phrase/models/tag_with_stats.rb +240 -0
- data/lib/phrase/models/tag_with_stats1.rb +196 -0
- data/lib/phrase/models/tag_with_stats1_statistics.rb +221 -0
- data/lib/phrase/models/tag_with_stats1_statistics1.rb +203 -0
- data/lib/phrase/models/translation.rb +286 -0
- data/lib/phrase/models/translation_create_parameters.rb +265 -0
- data/lib/phrase/models/translation_details.rb +312 -0
- data/lib/phrase/models/translation_details1.rb +203 -0
- data/lib/phrase/models/translation_exclude_parameters.rb +195 -0
- data/lib/phrase/models/translation_include_parameters.rb +195 -0
- data/lib/phrase/models/translation_key.rb +268 -0
- data/lib/phrase/models/translation_key_details.rb +357 -0
- data/lib/phrase/models/translation_key_details1.rb +266 -0
- data/lib/phrase/models/translation_order.rb +340 -0
- data/lib/phrase/models/translation_review_parameters.rb +195 -0
- data/lib/phrase/models/translation_unverify_parameters.rb +195 -0
- data/lib/phrase/models/translation_update_parameters.rb +245 -0
- data/lib/phrase/models/translation_verify_parameters.rb +195 -0
- data/lib/phrase/models/translation_version.rb +257 -0
- data/lib/phrase/models/translation_version_with_user.rb +274 -0
- data/lib/phrase/models/translation_version_with_user1.rb +194 -0
- data/lib/phrase/models/translations_exclude_parameters.rb +225 -0
- data/lib/phrase/models/translations_include_parameters.rb +225 -0
- data/lib/phrase/models/translations_review_parameters.rb +205 -0
- data/lib/phrase/models/translations_search_parameters.rb +225 -0
- data/lib/phrase/models/translations_unverify_parameters.rb +225 -0
- data/lib/phrase/models/translations_verify_parameters.rb +225 -0
- data/lib/phrase/models/upload.rb +257 -0
- data/lib/phrase/models/upload_create_parameters.rb +339 -0
- data/lib/phrase/models/upload_summary.rb +257 -0
- data/lib/phrase/models/user.rb +248 -0
- data/lib/phrase/models/user_preview.rb +212 -0
- data/lib/phrase/models/webhook.rb +250 -0
- data/lib/phrase/models/webhook_create_parameters.rb +225 -0
- data/lib/phrase/models/webhook_update_parameters.rb +225 -0
- data/lib/phrase/response.rb +41 -0
- data/lib/phrase/version.rb +1 -1
- data/phrase.gemspec +27 -27
- data/spec/api/accounts_api_spec.rb +50 -0
- data/spec/api/authorizations_api_spec.rb +90 -0
- data/spec/api/bitbucket_sync_api_spec.rb +64 -0
- data/spec/api/blacklisted_keys_api_spec.rb +95 -0
- data/spec/api/branches_api_spec.rb +124 -0
- data/spec/api/comments_api_spec.rb +151 -0
- data/spec/api/distributions_api_spec.rb +95 -0
- data/spec/api/formats_api_spec.rb +35 -0
- data/spec/api/git_lab_sync_api_spec.rb +125 -0
- data/spec/api/glossary_api_spec.rb +95 -0
- data/spec/api/glossary_term_translations_api_spec.rb +72 -0
- data/spec/api/glossary_terms_api_spec.rb +100 -0
- data/spec/api/invitations_api_spec.rb +109 -0
- data/spec/api/job_locales_api_spec.rb +135 -0
- data/spec/api/jobs_api_spec.rb +177 -0
- data/spec/api/keys_api_spec.rb +162 -0
- data/spec/api/locales_api_spec.rb +126 -0
- data/spec/api/members_api_spec.rb +81 -0
- data/spec/api/orders_api_spec.rb +98 -0
- data/spec/api/projects_api_spec.rb +90 -0
- data/spec/api/releases_api_spec.rb +115 -0
- data/spec/api/screenshot_markers_api_spec.rb +98 -0
- data/spec/api/screenshots_api_spec.rb +95 -0
- data/spec/api/spaces_api_spec.rb +141 -0
- data/spec/api/style_guides_api_spec.rb +95 -0
- data/spec/api/tags_api_spec.rb +83 -0
- data/spec/api/translations_api_spec.rb +287 -0
- data/spec/api/uploads_api_spec.rb +80 -0
- data/spec/api/users_api_spec.rb +35 -0
- data/spec/api/versions_history_api_spec.rb +56 -0
- data/spec/api/webhooks_api_spec.rb +109 -0
- data/spec/api_client_spec.rb +214 -0
- data/spec/configuration_spec.rb +30 -0
- data/spec/models/account_details1_spec.rb +29 -0
- data/spec/models/account_details_spec.rb +59 -0
- data/spec/models/account_spec.rb +53 -0
- data/spec/models/affected_count_spec.rb +29 -0
- data/spec/models/affected_resources_spec.rb +29 -0
- data/spec/models/authorization_create_parameters_spec.rb +41 -0
- data/spec/models/authorization_spec.rb +71 -0
- data/spec/models/authorization_update_parameters_spec.rb +41 -0
- data/spec/models/authorization_with_token1_spec.rb +29 -0
- data/spec/models/authorization_with_token_spec.rb +77 -0
- data/spec/models/bitbucket_sync_export_parameters_spec.rb +29 -0
- data/spec/models/bitbucket_sync_export_response_spec.rb +29 -0
- data/spec/models/bitbucket_sync_import_parameters_spec.rb +29 -0
- data/spec/models/bitbucket_sync_spec.rb +59 -0
- data/spec/models/blacklisted_key_create_parameters_spec.rb +29 -0
- data/spec/models/blacklisted_key_spec.rb +47 -0
- data/spec/models/blacklisted_key_update_parameters_spec.rb +29 -0
- data/spec/models/branch_create_parameters_spec.rb +29 -0
- data/spec/models/branch_merge_parameters_spec.rb +29 -0
- data/spec/models/branch_spec.rb +65 -0
- data/spec/models/branch_update_parameters_spec.rb +29 -0
- data/spec/models/comment_create_parameters_spec.rb +35 -0
- data/spec/models/comment_mark_read_parameters_spec.rb +29 -0
- data/spec/models/comment_spec.rb +53 -0
- data/spec/models/comment_update_parameters_spec.rb +35 -0
- data/spec/models/distribution_create_parameters_spec.rb +65 -0
- data/spec/models/distribution_preview_spec.rb +65 -0
- data/spec/models/distribution_spec.rb +65 -0
- data/spec/models/distribution_update_parameters_spec.rb +65 -0
- data/spec/models/format_spec.rb +83 -0
- data/spec/models/gitlab_sync_export_parameters_spec.rb +29 -0
- data/spec/models/gitlab_sync_export_spec.rb +35 -0
- data/spec/models/gitlab_sync_history_spec.rb +53 -0
- data/spec/models/gitlab_sync_import_parameters_spec.rb +29 -0
- data/spec/models/gitlab_sync_spec.rb +89 -0
- data/spec/models/glossary_create_parameters_spec.rb +41 -0
- data/spec/models/glossary_spec.rb +53 -0
- data/spec/models/glossary_term_create_parameters_spec.rb +47 -0
- data/spec/models/glossary_term_spec.rb +71 -0
- data/spec/models/glossary_term_translation_create_parameters_spec.rb +35 -0
- data/spec/models/glossary_term_translation_spec.rb +53 -0
- data/spec/models/glossary_term_translation_update_parameters_spec.rb +35 -0
- data/spec/models/glossary_term_update_parameters_spec.rb +47 -0
- data/spec/models/glossary_update_parameters_spec.rb +41 -0
- data/spec/models/invitation_create_parameters_spec.rb +53 -0
- data/spec/models/invitation_spec.rb +83 -0
- data/spec/models/invitation_update_parameters_spec.rb +47 -0
- data/spec/models/job_complete_parameters_spec.rb +29 -0
- data/spec/models/job_create_parameters_spec.rb +59 -0
- data/spec/models/job_details1_spec.rb +47 -0
- data/spec/models/job_details_spec.rb +89 -0
- data/spec/models/job_keys_create_parameters_spec.rb +35 -0
- data/spec/models/job_locale_complete_parameters_spec.rb +29 -0
- data/spec/models/job_locale_reopen_parameters_spec.rb +29 -0
- data/spec/models/job_locale_spec.rb +47 -0
- data/spec/models/job_locale_update_parameters_spec.rb +41 -0
- data/spec/models/job_locales_create_parameters_spec.rb +41 -0
- data/spec/models/job_preview_spec.rb +41 -0
- data/spec/models/job_reopen_parameters_spec.rb +29 -0
- data/spec/models/job_spec.rb +65 -0
- data/spec/models/job_start_parameters_spec.rb +29 -0
- data/spec/models/job_update_parameters_spec.rb +47 -0
- data/spec/models/key_create_parameters_spec.rb +113 -0
- data/spec/models/key_preview_spec.rb +41 -0
- data/spec/models/key_update_parameters_spec.rb +113 -0
- data/spec/models/keys_search_parameters_spec.rb +53 -0
- data/spec/models/keys_tag_parameters_spec.rb +47 -0
- data/spec/models/keys_untag_parameters_spec.rb +47 -0
- data/spec/models/locale_create_parameters_spec.rb +83 -0
- data/spec/models/locale_details1_spec.rb +29 -0
- data/spec/models/locale_details_spec.rb +89 -0
- data/spec/models/locale_preview_spec.rb +41 -0
- data/spec/models/locale_spec.rb +83 -0
- data/spec/models/locale_statistics_spec.rb +65 -0
- data/spec/models/locale_update_parameters_spec.rb +83 -0
- data/spec/models/member_spec.rb +53 -0
- data/spec/models/member_update_parameters_spec.rb +47 -0
- data/spec/models/order_confirm_parameters_spec.rb +29 -0
- data/spec/models/order_create_parameters_spec.rb +107 -0
- data/spec/models/project_create_parameters_spec.rb +59 -0
- data/spec/models/project_details1_spec.rb +35 -0
- data/spec/models/project_details_spec.rb +77 -0
- data/spec/models/project_locales1_spec.rb +29 -0
- data/spec/models/project_locales_spec.rb +59 -0
- data/spec/models/project_short_spec.rb +53 -0
- data/spec/models/project_spec.rb +65 -0
- data/spec/models/project_update_parameters_spec.rb +59 -0
- data/spec/models/release_create_parameters_spec.rb +41 -0
- data/spec/models/release_preview_spec.rb +89 -0
- data/spec/models/release_spec.rb +89 -0
- data/spec/models/release_update_parameters_spec.rb +41 -0
- data/spec/models/screenshot_create_parameters_spec.rb +41 -0
- data/spec/models/screenshot_marker_create_parameters_spec.rb +35 -0
- data/spec/models/screenshot_marker_spec.rb +59 -0
- data/spec/models/screenshot_marker_update_parameters_spec.rb +35 -0
- data/spec/models/screenshot_spec.rb +65 -0
- data/spec/models/screenshot_update_parameters_spec.rb +41 -0
- data/spec/models/space_create_parameters_spec.rb +29 -0
- data/spec/models/space_spec.rb +59 -0
- data/spec/models/space_update_parameters_spec.rb +29 -0
- data/spec/models/spaces_projects_create_parameters_spec.rb +29 -0
- data/spec/models/styleguide_create_parameters_spec.rb +101 -0
- data/spec/models/styleguide_details1_spec.rb +101 -0
- data/spec/models/styleguide_details_spec.rb +125 -0
- data/spec/models/styleguide_preview_spec.rb +35 -0
- data/spec/models/styleguide_spec.rb +47 -0
- data/spec/models/styleguide_update_parameters_spec.rb +101 -0
- data/spec/models/tag_create_parameters_spec.rb +35 -0
- data/spec/models/tag_spec.rb +47 -0
- data/spec/models/tag_with_stats1_spec.rb +29 -0
- data/spec/models/tag_with_stats1_statistics1_spec.rb +35 -0
- data/spec/models/tag_with_stats1_statistics_spec.rb +47 -0
- data/spec/models/tag_with_stats_spec.rb +53 -0
- data/spec/models/translation_create_parameters_spec.rb +71 -0
- data/spec/models/translation_details1_spec.rb +35 -0
- data/spec/models/translation_details_spec.rb +101 -0
- data/spec/models/translation_exclude_parameters_spec.rb +29 -0
- data/spec/models/translation_include_parameters_spec.rb +29 -0
- data/spec/models/translation_key_details1_spec.rb +77 -0
- data/spec/models/translation_key_details_spec.rb +131 -0
- data/spec/models/translation_key_spec.rb +77 -0
- data/spec/models/translation_order_spec.rb +125 -0
- data/spec/models/translation_review_parameters_spec.rb +29 -0
- data/spec/models/translation_spec.rb +89 -0
- data/spec/models/translation_unverify_parameters_spec.rb +29 -0
- data/spec/models/translation_update_parameters_spec.rb +59 -0
- data/spec/models/translation_verify_parameters_spec.rb +29 -0
- data/spec/models/translation_version_spec.rb +71 -0
- data/spec/models/translation_version_with_user1_spec.rb +29 -0
- data/spec/models/translation_version_with_user_spec.rb +77 -0
- data/spec/models/translations_exclude_parameters_spec.rb +47 -0
- data/spec/models/translations_include_parameters_spec.rb +47 -0
- data/spec/models/translations_review_parameters_spec.rb +35 -0
- data/spec/models/translations_search_parameters_spec.rb +47 -0
- data/spec/models/translations_unverify_parameters_spec.rb +47 -0
- data/spec/models/translations_verify_parameters_spec.rb +47 -0
- data/spec/models/upload_create_parameters_spec.rb +113 -0
- data/spec/models/upload_spec.rb +71 -0
- data/spec/models/upload_summary_spec.rb +71 -0
- data/spec/models/user_preview_spec.rb +41 -0
- data/spec/models/user_spec.rb +65 -0
- data/spec/models/webhook_create_parameters_spec.rb +47 -0
- data/spec/models/webhook_spec.rb +65 -0
- data/spec/models/webhook_update_parameters_spec.rb +47 -0
- data/spec/spec_helper.rb +99 -0
- metadata +759 -190
- data/.gitignore +0 -25
- data/.travis.yml +0 -6
- data/Guardfile +0 -29
- data/bin/phrase +0 -8
- data/cacert.pem +0 -3366
- data/lib/ext/all.rb +0 -5
- data/lib/ext/hash.rb +0 -8
- data/lib/ext/object.rb +0 -130
- data/lib/ext/try.rb +0 -57
- data/lib/generators/phrase/install_generator.rb +0 -37
- data/lib/generators/templates/README +0 -11
- data/lib/generators/templates/phrase.rb +0 -21
- data/lib/phrase/adapters/fast_gettext.rb +0 -25
- data/lib/phrase/adapters/i18n.rb +0 -12
- data/lib/phrase/api.rb +0 -7
- data/lib/phrase/api/client.rb +0 -308
- data/lib/phrase/api/client/http.rb +0 -56
- data/lib/phrase/api/config.rb +0 -34
- data/lib/phrase/api/exceptions.rb +0 -9
- data/lib/phrase/api/query_params.rb +0 -22
- data/lib/phrase/backend.rb +0 -7
- data/lib/phrase/backend/base.rb +0 -6
- data/lib/phrase/backend/phrase_service.rb +0 -163
- data/lib/phrase/cache.rb +0 -34
- data/lib/phrase/config.rb +0 -94
- data/lib/phrase/delegate.rb +0 -36
- data/lib/phrase/delegate/fast_gettext.rb +0 -27
- data/lib/phrase/delegate/i18n.rb +0 -166
- data/lib/phrase/engine.rb +0 -17
- data/lib/phrase/formats.rb +0 -176
- data/lib/phrase/formats/angular_translate.rb +0 -19
- data/lib/phrase/formats/csv.rb +0 -19
- data/lib/phrase/formats/custom.rb +0 -40
- data/lib/phrase/formats/gettext.rb +0 -27
- data/lib/phrase/formats/gettext_template.rb +0 -19
- data/lib/phrase/formats/go_i18n.rb +0 -23
- data/lib/phrase/formats/ini.rb +0 -19
- data/lib/phrase/formats/json.rb +0 -19
- data/lib/phrase/formats/laravel.rb +0 -19
- data/lib/phrase/formats/mozilla_properties.rb +0 -8
- data/lib/phrase/formats/nested_json.rb +0 -19
- data/lib/phrase/formats/node_json.rb +0 -23
- data/lib/phrase/formats/php_array.rb +0 -19
- data/lib/phrase/formats/play_properties.rb +0 -15
- data/lib/phrase/formats/plist.rb +0 -19
- data/lib/phrase/formats/properties.rb +0 -19
- data/lib/phrase/formats/properties_xml.rb +0 -19
- data/lib/phrase/formats/qt_phrase_book.rb +0 -19
- data/lib/phrase/formats/qt_translation_source.rb +0 -19
- data/lib/phrase/formats/resx.rb +0 -19
- data/lib/phrase/formats/resx_windowsphone.rb +0 -19
- data/lib/phrase/formats/simple_json.rb +0 -19
- data/lib/phrase/formats/strings.rb +0 -45
- data/lib/phrase/formats/stringsdict.rb +0 -15
- data/lib/phrase/formats/tmx.rb +0 -19
- data/lib/phrase/formats/windows8_resource.rb +0 -19
- data/lib/phrase/formats/xliff.rb +0 -19
- data/lib/phrase/formats/xml.rb +0 -49
- data/lib/phrase/formats/yaml.rb +0 -19
- data/lib/phrase/formats/yaml_symfony.rb +0 -19
- data/lib/phrase/formats/yaml_symfony2.rb +0 -8
- data/lib/phrase/hash_flattener.rb +0 -21
- data/lib/phrase/tool.rb +0 -46
- data/lib/phrase/tool/commands.rb +0 -56
- data/lib/phrase/tool/commands/base.rb +0 -73
- data/lib/phrase/tool/commands/init.rb +0 -51
- data/lib/phrase/tool/commands/pull.rb +0 -109
- data/lib/phrase/tool/commands/push.rb +0 -163
- data/lib/phrase/tool/commands/show_help.rb +0 -26
- data/lib/phrase/tool/commands/show_version.rb +0 -17
- data/lib/phrase/tool/commands/tags.rb +0 -29
- data/lib/phrase/tool/config.rb +0 -122
- data/lib/phrase/tool/encoding_detector.rb +0 -17
- data/lib/phrase/tool/locale.rb +0 -41
- data/lib/phrase/tool/options.rb +0 -32
- data/lib/phrase/tool/options_factory.rb +0 -150
- data/lib/phrase/tool/tag_validator.rb +0 -9
- data/lib/phrase/view_helpers.rb +0 -19
@@ -0,0 +1,446 @@
|
|
1
|
+
require 'cgi'
|
2
|
+
|
3
|
+
module Phrase
|
4
|
+
class WebhooksApi
|
5
|
+
attr_accessor :api_client
|
6
|
+
|
7
|
+
def initialize(api_client = ApiClient.default)
|
8
|
+
@api_client = api_client
|
9
|
+
end
|
10
|
+
# Create a webhook
|
11
|
+
# Create a new webhook.
|
12
|
+
# @param project_id [String] Project ID
|
13
|
+
# @param webhook_create_parameters [WebhookCreateParameters]
|
14
|
+
# @param [Hash] opts the optional parameters
|
15
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
16
|
+
# @return [nil]
|
17
|
+
def webhook_create(project_id, webhook_create_parameters, opts = {})
|
18
|
+
webhook_create_with_http_info(project_id, webhook_create_parameters, opts)
|
19
|
+
nil
|
20
|
+
end
|
21
|
+
|
22
|
+
# Create a webhook
|
23
|
+
# Create a new webhook.
|
24
|
+
# @param project_id [String] Project ID
|
25
|
+
# @param webhook_create_parameters [WebhookCreateParameters]
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
28
|
+
# @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
|
29
|
+
def webhook_create_with_http_info(project_id, webhook_create_parameters, opts = {})
|
30
|
+
if @api_client.config.debugging
|
31
|
+
@api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_create ...'
|
32
|
+
end
|
33
|
+
# verify the required parameter 'project_id' is set
|
34
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
35
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_create"
|
36
|
+
end
|
37
|
+
# verify the required parameter 'webhook_create_parameters' is set
|
38
|
+
if @api_client.config.client_side_validation && webhook_create_parameters.nil?
|
39
|
+
fail ArgumentError, "Missing the required parameter 'webhook_create_parameters' when calling WebhooksApi.webhook_create"
|
40
|
+
end
|
41
|
+
# resource path
|
42
|
+
local_var_path = '/projects/{project_id}/webhooks'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
|
43
|
+
|
44
|
+
# query parameters
|
45
|
+
query_params = opts[:query_params] || {}
|
46
|
+
|
47
|
+
# header parameters
|
48
|
+
header_params = opts[:header_params] || {}
|
49
|
+
# HTTP header 'Content-Type'
|
50
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
51
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
52
|
+
|
53
|
+
# form parameters
|
54
|
+
form_params = opts[:form_params] || {}
|
55
|
+
|
56
|
+
# http body (model)
|
57
|
+
post_body = opts[:body] || @api_client.object_to_http_body(webhook_create_parameters)
|
58
|
+
|
59
|
+
# return_type
|
60
|
+
return_type = opts[:return_type]
|
61
|
+
|
62
|
+
# auth_names
|
63
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
64
|
+
|
65
|
+
new_options = opts.merge(
|
66
|
+
:header_params => header_params,
|
67
|
+
:query_params => query_params,
|
68
|
+
:form_params => form_params,
|
69
|
+
:body => post_body,
|
70
|
+
:auth_names => auth_names,
|
71
|
+
:return_type => return_type
|
72
|
+
)
|
73
|
+
|
74
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
75
|
+
if @api_client.config.debugging
|
76
|
+
@api_client.config.logger.debug "API called: WebhooksApi#webhook_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
77
|
+
end
|
78
|
+
response = ::Phrase::Response.new(data, headers)
|
79
|
+
return response, status_code, headers
|
80
|
+
end
|
81
|
+
|
82
|
+
# Delete a webhook
|
83
|
+
# Delete an existing webhook.
|
84
|
+
# @param project_id [String] Project ID
|
85
|
+
# @param id [String] ID
|
86
|
+
# @param [Hash] opts the optional parameters
|
87
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
88
|
+
# @return [nil]
|
89
|
+
def webhook_delete(project_id, id, opts = {})
|
90
|
+
webhook_delete_with_http_info(project_id, id, opts)
|
91
|
+
nil
|
92
|
+
end
|
93
|
+
|
94
|
+
# Delete a webhook
|
95
|
+
# Delete an existing webhook.
|
96
|
+
# @param project_id [String] Project ID
|
97
|
+
# @param id [String] ID
|
98
|
+
# @param [Hash] opts the optional parameters
|
99
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
100
|
+
# @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
|
101
|
+
def webhook_delete_with_http_info(project_id, id, opts = {})
|
102
|
+
if @api_client.config.debugging
|
103
|
+
@api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_delete ...'
|
104
|
+
end
|
105
|
+
# verify the required parameter 'project_id' is set
|
106
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
107
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_delete"
|
108
|
+
end
|
109
|
+
# verify the required parameter 'id' is set
|
110
|
+
if @api_client.config.client_side_validation && id.nil?
|
111
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_delete"
|
112
|
+
end
|
113
|
+
# resource path
|
114
|
+
local_var_path = '/projects/{project_id}/webhooks/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
115
|
+
|
116
|
+
# query parameters
|
117
|
+
query_params = opts[:query_params] || {}
|
118
|
+
|
119
|
+
# header parameters
|
120
|
+
header_params = opts[:header_params] || {}
|
121
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
122
|
+
|
123
|
+
# form parameters
|
124
|
+
form_params = opts[:form_params] || {}
|
125
|
+
|
126
|
+
# http body (model)
|
127
|
+
post_body = opts[:body]
|
128
|
+
|
129
|
+
# return_type
|
130
|
+
return_type = opts[:return_type]
|
131
|
+
|
132
|
+
# auth_names
|
133
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
134
|
+
|
135
|
+
new_options = opts.merge(
|
136
|
+
:header_params => header_params,
|
137
|
+
:query_params => query_params,
|
138
|
+
:form_params => form_params,
|
139
|
+
:body => post_body,
|
140
|
+
:auth_names => auth_names,
|
141
|
+
:return_type => return_type
|
142
|
+
)
|
143
|
+
|
144
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
145
|
+
if @api_client.config.debugging
|
146
|
+
@api_client.config.logger.debug "API called: WebhooksApi#webhook_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
147
|
+
end
|
148
|
+
response = ::Phrase::Response.new(data, headers)
|
149
|
+
return response, status_code, headers
|
150
|
+
end
|
151
|
+
|
152
|
+
# Get a single webhook
|
153
|
+
# Get details on a single webhook.
|
154
|
+
# @param project_id [String] Project ID
|
155
|
+
# @param id [String] ID
|
156
|
+
# @param [Hash] opts the optional parameters
|
157
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
158
|
+
# @return [Webhook]
|
159
|
+
def webhook_show(project_id, id, opts = {})
|
160
|
+
data, _status_code, _headers = webhook_show_with_http_info(project_id, id, opts)
|
161
|
+
data
|
162
|
+
end
|
163
|
+
|
164
|
+
# Get a single webhook
|
165
|
+
# Get details on a single webhook.
|
166
|
+
# @param project_id [String] Project ID
|
167
|
+
# @param id [String] ID
|
168
|
+
# @param [Hash] opts the optional parameters
|
169
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
170
|
+
# @return [Array<(Response<(Webhook)>, Integer, Hash)>] Response<(Webhook)> data, response status code and response headers
|
171
|
+
def webhook_show_with_http_info(project_id, id, opts = {})
|
172
|
+
if @api_client.config.debugging
|
173
|
+
@api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_show ...'
|
174
|
+
end
|
175
|
+
# verify the required parameter 'project_id' is set
|
176
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
177
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_show"
|
178
|
+
end
|
179
|
+
# verify the required parameter 'id' is set
|
180
|
+
if @api_client.config.client_side_validation && id.nil?
|
181
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_show"
|
182
|
+
end
|
183
|
+
# resource path
|
184
|
+
local_var_path = '/projects/{project_id}/webhooks/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
185
|
+
|
186
|
+
# query parameters
|
187
|
+
query_params = opts[:query_params] || {}
|
188
|
+
|
189
|
+
# header parameters
|
190
|
+
header_params = opts[:header_params] || {}
|
191
|
+
# HTTP header 'Accept' (if needed)
|
192
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
193
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
194
|
+
|
195
|
+
# form parameters
|
196
|
+
form_params = opts[:form_params] || {}
|
197
|
+
|
198
|
+
# http body (model)
|
199
|
+
post_body = opts[:body]
|
200
|
+
|
201
|
+
# return_type
|
202
|
+
return_type = opts[:return_type] || 'Webhook'
|
203
|
+
|
204
|
+
# auth_names
|
205
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
206
|
+
|
207
|
+
new_options = opts.merge(
|
208
|
+
:header_params => header_params,
|
209
|
+
:query_params => query_params,
|
210
|
+
:form_params => form_params,
|
211
|
+
:body => post_body,
|
212
|
+
:auth_names => auth_names,
|
213
|
+
:return_type => return_type
|
214
|
+
)
|
215
|
+
|
216
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
217
|
+
if @api_client.config.debugging
|
218
|
+
@api_client.config.logger.debug "API called: WebhooksApi#webhook_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
219
|
+
end
|
220
|
+
response = ::Phrase::Response.new(data, headers)
|
221
|
+
return response, status_code, headers
|
222
|
+
end
|
223
|
+
|
224
|
+
# Test a webhook
|
225
|
+
# Perform a test request for a webhook.
|
226
|
+
# @param project_id [String] Project ID
|
227
|
+
# @param id [String] ID
|
228
|
+
# @param [Hash] opts the optional parameters
|
229
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
230
|
+
# @return [nil]
|
231
|
+
def webhook_test(project_id, id, opts = {})
|
232
|
+
webhook_test_with_http_info(project_id, id, opts)
|
233
|
+
nil
|
234
|
+
end
|
235
|
+
|
236
|
+
# Test a webhook
|
237
|
+
# Perform a test request for a webhook.
|
238
|
+
# @param project_id [String] Project ID
|
239
|
+
# @param id [String] ID
|
240
|
+
# @param [Hash] opts the optional parameters
|
241
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
242
|
+
# @return [Array<(Response<(nil)>, Integer, Hash)>] Response<(nil, response status code and response headers
|
243
|
+
def webhook_test_with_http_info(project_id, id, opts = {})
|
244
|
+
if @api_client.config.debugging
|
245
|
+
@api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_test ...'
|
246
|
+
end
|
247
|
+
# verify the required parameter 'project_id' is set
|
248
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
249
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_test"
|
250
|
+
end
|
251
|
+
# verify the required parameter 'id' is set
|
252
|
+
if @api_client.config.client_side_validation && id.nil?
|
253
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_test"
|
254
|
+
end
|
255
|
+
# resource path
|
256
|
+
local_var_path = '/projects/{project_id}/webhooks/{id}/test'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
257
|
+
|
258
|
+
# query parameters
|
259
|
+
query_params = opts[:query_params] || {}
|
260
|
+
|
261
|
+
# header parameters
|
262
|
+
header_params = opts[:header_params] || {}
|
263
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
264
|
+
|
265
|
+
# form parameters
|
266
|
+
form_params = opts[:form_params] || {}
|
267
|
+
|
268
|
+
# http body (model)
|
269
|
+
post_body = opts[:body]
|
270
|
+
|
271
|
+
# return_type
|
272
|
+
return_type = opts[:return_type]
|
273
|
+
|
274
|
+
# auth_names
|
275
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
276
|
+
|
277
|
+
new_options = opts.merge(
|
278
|
+
:header_params => header_params,
|
279
|
+
:query_params => query_params,
|
280
|
+
:form_params => form_params,
|
281
|
+
:body => post_body,
|
282
|
+
:auth_names => auth_names,
|
283
|
+
:return_type => return_type
|
284
|
+
)
|
285
|
+
|
286
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
287
|
+
if @api_client.config.debugging
|
288
|
+
@api_client.config.logger.debug "API called: WebhooksApi#webhook_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
289
|
+
end
|
290
|
+
response = ::Phrase::Response.new(data, headers)
|
291
|
+
return response, status_code, headers
|
292
|
+
end
|
293
|
+
|
294
|
+
# Update a webhook
|
295
|
+
# Update an existing webhook.
|
296
|
+
# @param project_id [String] Project ID
|
297
|
+
# @param id [String] ID
|
298
|
+
# @param webhook_update_parameters [WebhookUpdateParameters]
|
299
|
+
# @param [Hash] opts the optional parameters
|
300
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
301
|
+
# @return [Webhook]
|
302
|
+
def webhook_update(project_id, id, webhook_update_parameters, opts = {})
|
303
|
+
data, _status_code, _headers = webhook_update_with_http_info(project_id, id, webhook_update_parameters, opts)
|
304
|
+
data
|
305
|
+
end
|
306
|
+
|
307
|
+
# Update a webhook
|
308
|
+
# Update an existing webhook.
|
309
|
+
# @param project_id [String] Project ID
|
310
|
+
# @param id [String] ID
|
311
|
+
# @param webhook_update_parameters [WebhookUpdateParameters]
|
312
|
+
# @param [Hash] opts the optional parameters
|
313
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
314
|
+
# @return [Array<(Response<(Webhook)>, Integer, Hash)>] Response<(Webhook)> data, response status code and response headers
|
315
|
+
def webhook_update_with_http_info(project_id, id, webhook_update_parameters, opts = {})
|
316
|
+
if @api_client.config.debugging
|
317
|
+
@api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_update ...'
|
318
|
+
end
|
319
|
+
# verify the required parameter 'project_id' is set
|
320
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
321
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_update"
|
322
|
+
end
|
323
|
+
# verify the required parameter 'id' is set
|
324
|
+
if @api_client.config.client_side_validation && id.nil?
|
325
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.webhook_update"
|
326
|
+
end
|
327
|
+
# verify the required parameter 'webhook_update_parameters' is set
|
328
|
+
if @api_client.config.client_side_validation && webhook_update_parameters.nil?
|
329
|
+
fail ArgumentError, "Missing the required parameter 'webhook_update_parameters' when calling WebhooksApi.webhook_update"
|
330
|
+
end
|
331
|
+
# resource path
|
332
|
+
local_var_path = '/projects/{project_id}/webhooks/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
333
|
+
|
334
|
+
# query parameters
|
335
|
+
query_params = opts[:query_params] || {}
|
336
|
+
|
337
|
+
# header parameters
|
338
|
+
header_params = opts[:header_params] || {}
|
339
|
+
# HTTP header 'Accept' (if needed)
|
340
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
341
|
+
# HTTP header 'Content-Type'
|
342
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
343
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
344
|
+
|
345
|
+
# form parameters
|
346
|
+
form_params = opts[:form_params] || {}
|
347
|
+
|
348
|
+
# http body (model)
|
349
|
+
post_body = opts[:body] || @api_client.object_to_http_body(webhook_update_parameters)
|
350
|
+
|
351
|
+
# return_type
|
352
|
+
return_type = opts[:return_type] || 'Webhook'
|
353
|
+
|
354
|
+
# auth_names
|
355
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
356
|
+
|
357
|
+
new_options = opts.merge(
|
358
|
+
:header_params => header_params,
|
359
|
+
:query_params => query_params,
|
360
|
+
:form_params => form_params,
|
361
|
+
:body => post_body,
|
362
|
+
:auth_names => auth_names,
|
363
|
+
:return_type => return_type
|
364
|
+
)
|
365
|
+
|
366
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
367
|
+
if @api_client.config.debugging
|
368
|
+
@api_client.config.logger.debug "API called: WebhooksApi#webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
369
|
+
end
|
370
|
+
response = ::Phrase::Response.new(data, headers)
|
371
|
+
return response, status_code, headers
|
372
|
+
end
|
373
|
+
|
374
|
+
# List webhooks
|
375
|
+
# List all webhooks for the given project.
|
376
|
+
# @param project_id [String] Project ID
|
377
|
+
# @param [Hash] opts the optional parameters
|
378
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
379
|
+
# @option opts [Integer] :page Page number
|
380
|
+
# @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
|
381
|
+
# @return [Array<Webhook>]
|
382
|
+
def webhooks_list(project_id, opts = {})
|
383
|
+
data, _status_code, _headers = webhooks_list_with_http_info(project_id, opts)
|
384
|
+
data
|
385
|
+
end
|
386
|
+
|
387
|
+
# List webhooks
|
388
|
+
# List all webhooks for the given project.
|
389
|
+
# @param project_id [String] Project ID
|
390
|
+
# @param [Hash] opts the optional parameters
|
391
|
+
# @option opts [String] :x_phrase_app_otp Two-Factor-Authentication token (optional)
|
392
|
+
# @option opts [Integer] :page Page number
|
393
|
+
# @option opts [Integer] :per_page allows you to specify a page size up to 100 items, 10 by default
|
394
|
+
# @return [Array<(Response<(Array<Webhook>)>, Integer, Hash)>] Response<(Array<Webhook>)> data, response status code and response headers
|
395
|
+
def webhooks_list_with_http_info(project_id, opts = {})
|
396
|
+
if @api_client.config.debugging
|
397
|
+
@api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_list ...'
|
398
|
+
end
|
399
|
+
# verify the required parameter 'project_id' is set
|
400
|
+
if @api_client.config.client_side_validation && project_id.nil?
|
401
|
+
fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhooks_list"
|
402
|
+
end
|
403
|
+
# resource path
|
404
|
+
local_var_path = '/projects/{project_id}/webhooks'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s))
|
405
|
+
|
406
|
+
# query parameters
|
407
|
+
query_params = opts[:query_params] || {}
|
408
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
409
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
410
|
+
|
411
|
+
# header parameters
|
412
|
+
header_params = opts[:header_params] || {}
|
413
|
+
# HTTP header 'Accept' (if needed)
|
414
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
415
|
+
header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil?
|
416
|
+
|
417
|
+
# form parameters
|
418
|
+
form_params = opts[:form_params] || {}
|
419
|
+
|
420
|
+
# http body (model)
|
421
|
+
post_body = opts[:body]
|
422
|
+
|
423
|
+
# return_type
|
424
|
+
return_type = opts[:return_type] || 'Array<Webhook>'
|
425
|
+
|
426
|
+
# auth_names
|
427
|
+
auth_names = opts[:auth_names] || ['Basic', 'Token']
|
428
|
+
|
429
|
+
new_options = opts.merge(
|
430
|
+
:header_params => header_params,
|
431
|
+
:query_params => query_params,
|
432
|
+
:form_params => form_params,
|
433
|
+
:body => post_body,
|
434
|
+
:auth_names => auth_names,
|
435
|
+
:return_type => return_type
|
436
|
+
)
|
437
|
+
|
438
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
439
|
+
if @api_client.config.debugging
|
440
|
+
@api_client.config.logger.debug "API called: WebhooksApi#webhooks_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
441
|
+
end
|
442
|
+
response = ::Phrase::Response.new(data, headers)
|
443
|
+
return response, status_code, headers
|
444
|
+
end
|
445
|
+
end
|
446
|
+
end
|
@@ -0,0 +1,376 @@
|
|
1
|
+
require 'date'
|
2
|
+
require 'json'
|
3
|
+
require 'logger'
|
4
|
+
require 'tempfile'
|
5
|
+
require 'typhoeus'
|
6
|
+
|
7
|
+
module Phrase
|
8
|
+
class ApiClient
|
9
|
+
# The Configuration object holding settings to be used in the API client.
|
10
|
+
attr_accessor :config
|
11
|
+
|
12
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
13
|
+
#
|
14
|
+
# @return [Hash]
|
15
|
+
attr_accessor :default_headers
|
16
|
+
|
17
|
+
# Initializes the ApiClient
|
18
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
19
|
+
def initialize(config = Configuration.default)
|
20
|
+
@config = config
|
21
|
+
@user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
|
22
|
+
@default_headers = {
|
23
|
+
'Content-Type' => 'application/json',
|
24
|
+
'User-Agent' => @user_agent
|
25
|
+
}
|
26
|
+
end
|
27
|
+
|
28
|
+
def self.default
|
29
|
+
@@default ||= ApiClient.new
|
30
|
+
end
|
31
|
+
|
32
|
+
# Call an API with given options.
|
33
|
+
#
|
34
|
+
# @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
|
35
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
36
|
+
def call_api(http_method, path, opts = {})
|
37
|
+
request = build_request(http_method, path, opts)
|
38
|
+
response = request.run
|
39
|
+
|
40
|
+
if @config.debugging
|
41
|
+
@config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
42
|
+
end
|
43
|
+
|
44
|
+
unless response.success?
|
45
|
+
if response.timed_out?
|
46
|
+
fail ApiError.new('Connection timed out')
|
47
|
+
elsif response.code == 0
|
48
|
+
# Errors from libcurl will be made visible here
|
49
|
+
fail ApiError.new(:code => 0,
|
50
|
+
:message => response.return_message)
|
51
|
+
else
|
52
|
+
fail ApiError.new(:code => response.code,
|
53
|
+
:response_headers => response.headers,
|
54
|
+
:response_body => response.body),
|
55
|
+
response.status_message
|
56
|
+
end
|
57
|
+
end
|
58
|
+
|
59
|
+
if opts[:return_type]
|
60
|
+
data = deserialize(response, opts[:return_type])
|
61
|
+
else
|
62
|
+
data = nil
|
63
|
+
end
|
64
|
+
return data, response.code, response.headers
|
65
|
+
end
|
66
|
+
|
67
|
+
# Builds the HTTP request
|
68
|
+
#
|
69
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
70
|
+
# @param [String] path URL path (e.g. /account/new)
|
71
|
+
# @option opts [Hash] :header_params Header parameters
|
72
|
+
# @option opts [Hash] :query_params Query parameters
|
73
|
+
# @option opts [Hash] :form_params Query parameters
|
74
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
75
|
+
# @return [Typhoeus::Request] A Typhoeus Request
|
76
|
+
def build_request(http_method, path, opts = {})
|
77
|
+
url = build_request_url(path)
|
78
|
+
http_method = http_method.to_sym.downcase
|
79
|
+
|
80
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
81
|
+
query_params = opts[:query_params] || {}
|
82
|
+
form_params = opts[:form_params] || {}
|
83
|
+
|
84
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
85
|
+
|
86
|
+
# set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
|
87
|
+
_verify_ssl_host = @config.verify_ssl_host ? 2 : 0
|
88
|
+
|
89
|
+
req_opts = {
|
90
|
+
:method => http_method,
|
91
|
+
:headers => header_params,
|
92
|
+
:params => query_params,
|
93
|
+
:params_encoding => @config.params_encoding,
|
94
|
+
:timeout => @config.timeout,
|
95
|
+
:ssl_verifypeer => @config.verify_ssl,
|
96
|
+
:ssl_verifyhost => _verify_ssl_host,
|
97
|
+
:sslcert => @config.cert_file,
|
98
|
+
:sslkey => @config.key_file,
|
99
|
+
:verbose => @config.debugging
|
100
|
+
}
|
101
|
+
|
102
|
+
# set custom cert, if provided
|
103
|
+
req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
|
104
|
+
|
105
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
106
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
107
|
+
req_opts.update :body => req_body
|
108
|
+
if @config.debugging
|
109
|
+
@config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
request = Typhoeus::Request.new(url, req_opts)
|
114
|
+
download_file(request) if opts[:return_type] == 'File'
|
115
|
+
request
|
116
|
+
end
|
117
|
+
|
118
|
+
# Builds the HTTP request body
|
119
|
+
#
|
120
|
+
# @param [Hash] header_params Header parameters
|
121
|
+
# @param [Hash] form_params Query parameters
|
122
|
+
# @param [Object] body HTTP body (JSON/XML)
|
123
|
+
# @return [String] HTTP body data in the form of string
|
124
|
+
def build_request_body(header_params, form_params, body)
|
125
|
+
# http form
|
126
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
|
127
|
+
header_params['Content-Type'] == 'multipart/form-data'
|
128
|
+
data = {}
|
129
|
+
form_params.each do |key, value|
|
130
|
+
case value
|
131
|
+
when ::File, ::Array, nil
|
132
|
+
# let typhoeus handle File, Array and nil parameters
|
133
|
+
data[key] = value
|
134
|
+
else
|
135
|
+
data[key] = value.to_s
|
136
|
+
end
|
137
|
+
end
|
138
|
+
elsif body
|
139
|
+
data = body.is_a?(String) ? body : body.to_json
|
140
|
+
else
|
141
|
+
data = nil
|
142
|
+
end
|
143
|
+
data
|
144
|
+
end
|
145
|
+
|
146
|
+
# Check if the given MIME is a JSON MIME.
|
147
|
+
# JSON MIME examples:
|
148
|
+
# application/json
|
149
|
+
# application/json; charset=UTF8
|
150
|
+
# APPLICATION/JSON
|
151
|
+
# */*
|
152
|
+
# @param [String] mime MIME
|
153
|
+
# @return [Boolean] True if the MIME is application/json
|
154
|
+
def json_mime?(mime)
|
155
|
+
(mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
|
156
|
+
end
|
157
|
+
|
158
|
+
# Deserialize the response to the given return type.
|
159
|
+
#
|
160
|
+
# @param [Response] response HTTP response
|
161
|
+
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
162
|
+
def deserialize(response, return_type)
|
163
|
+
body = response.body
|
164
|
+
|
165
|
+
# handle file downloading - return the File instance processed in request callbacks
|
166
|
+
# note that response body is empty when the file is written in chunks in request on_body callback
|
167
|
+
return @tempfile if return_type == 'File'
|
168
|
+
|
169
|
+
return nil if body.nil? || body.empty?
|
170
|
+
|
171
|
+
# return response body directly for String return type
|
172
|
+
return body if return_type == 'String'
|
173
|
+
|
174
|
+
# ensuring a default content type
|
175
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
176
|
+
|
177
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
178
|
+
|
179
|
+
begin
|
180
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
181
|
+
rescue JSON::ParserError => e
|
182
|
+
if %w(String Date DateTime).include?(return_type)
|
183
|
+
data = body
|
184
|
+
else
|
185
|
+
raise e
|
186
|
+
end
|
187
|
+
end
|
188
|
+
|
189
|
+
convert_to_type data, return_type
|
190
|
+
end
|
191
|
+
|
192
|
+
# Convert data to the given return type.
|
193
|
+
# @param [Object] data Data to be converted
|
194
|
+
# @param [String] return_type Return type
|
195
|
+
# @return [Mixed] Data in a particular type
|
196
|
+
def convert_to_type(data, return_type)
|
197
|
+
return nil if data.nil?
|
198
|
+
case return_type
|
199
|
+
when 'String'
|
200
|
+
data.to_s
|
201
|
+
when 'Integer'
|
202
|
+
data.to_i
|
203
|
+
when 'Float'
|
204
|
+
data.to_f
|
205
|
+
when 'Boolean'
|
206
|
+
data == true
|
207
|
+
when 'DateTime'
|
208
|
+
# parse date time (expecting ISO 8601 format)
|
209
|
+
DateTime.parse data
|
210
|
+
when 'Date'
|
211
|
+
# parse date time (expecting ISO 8601 format)
|
212
|
+
Date.parse data
|
213
|
+
when 'Object'
|
214
|
+
# generic object (usually a Hash), return directly
|
215
|
+
data
|
216
|
+
when /\AArray<(.+)>\z/
|
217
|
+
# e.g. Array<Pet>
|
218
|
+
sub_type = $1
|
219
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
220
|
+
when /\AHash\<String, (.+)\>\z/
|
221
|
+
# e.g. Hash<String, Integer>
|
222
|
+
sub_type = $1
|
223
|
+
{}.tap do |hash|
|
224
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
225
|
+
end
|
226
|
+
else
|
227
|
+
# models, e.g. Pet
|
228
|
+
Phrase.const_get(return_type).build_from_hash(data)
|
229
|
+
end
|
230
|
+
end
|
231
|
+
|
232
|
+
# Save response body into a file in (the defined) temporary folder, using the filename
|
233
|
+
# from the "Content-Disposition" header if provided, otherwise a random filename.
|
234
|
+
# The response body is written to the file in chunks in order to handle files which
|
235
|
+
# size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
|
236
|
+
# process can use.
|
237
|
+
#
|
238
|
+
# @see Configuration#temp_folder_path
|
239
|
+
def download_file(request)
|
240
|
+
tempfile = nil
|
241
|
+
encoding = nil
|
242
|
+
request.on_headers do |response|
|
243
|
+
content_disposition = response.headers['Content-Disposition']
|
244
|
+
if content_disposition && content_disposition =~ /filename=/i
|
245
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
246
|
+
prefix = sanitize_filename(filename)
|
247
|
+
else
|
248
|
+
prefix = 'download-'
|
249
|
+
end
|
250
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
251
|
+
encoding = response.body.encoding
|
252
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
253
|
+
@tempfile = tempfile
|
254
|
+
end
|
255
|
+
request.on_body do |chunk|
|
256
|
+
chunk.force_encoding(encoding)
|
257
|
+
tempfile.write(chunk)
|
258
|
+
end
|
259
|
+
request.on_complete do |response|
|
260
|
+
if tempfile
|
261
|
+
tempfile.close
|
262
|
+
@config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
263
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
264
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
265
|
+
"explicitly with `tempfile.delete`"
|
266
|
+
end
|
267
|
+
end
|
268
|
+
end
|
269
|
+
|
270
|
+
# Sanitize filename by removing path.
|
271
|
+
# e.g. ../../sun.gif becomes sun.gif
|
272
|
+
#
|
273
|
+
# @param [String] filename the filename to be sanitized
|
274
|
+
# @return [String] the sanitized filename
|
275
|
+
def sanitize_filename(filename)
|
276
|
+
filename.gsub(/.*[\/\\]/, '')
|
277
|
+
end
|
278
|
+
|
279
|
+
def build_request_url(path)
|
280
|
+
# Add leading and trailing slashes to path
|
281
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
282
|
+
@config.base_url + path
|
283
|
+
end
|
284
|
+
|
285
|
+
# Update hearder and query params based on authentication settings.
|
286
|
+
#
|
287
|
+
# @param [Hash] header_params Header parameters
|
288
|
+
# @param [Hash] query_params Query parameters
|
289
|
+
# @param [String] auth_names Authentication scheme name
|
290
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
291
|
+
Array(auth_names).each do |auth_name|
|
292
|
+
auth_setting = @config.auth_settings[auth_name]
|
293
|
+
next unless auth_setting
|
294
|
+
case auth_setting[:in]
|
295
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
296
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
297
|
+
else fail ArgumentError, 'Authentication token must be in `query` of `header`'
|
298
|
+
end
|
299
|
+
end
|
300
|
+
end
|
301
|
+
|
302
|
+
# Sets user agent in HTTP header
|
303
|
+
#
|
304
|
+
# @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
|
305
|
+
def user_agent=(user_agent)
|
306
|
+
@user_agent = user_agent
|
307
|
+
@default_headers['User-Agent'] = @user_agent
|
308
|
+
end
|
309
|
+
|
310
|
+
# Return Accept header based on an array of accepts provided.
|
311
|
+
# @param [Array] accepts array for Accept
|
312
|
+
# @return [String] the Accept header (e.g. application/json)
|
313
|
+
def select_header_accept(accepts)
|
314
|
+
return nil if accepts.nil? || accepts.empty?
|
315
|
+
# use JSON when present, otherwise use all of the provided
|
316
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
317
|
+
json_accept || accepts.join(',')
|
318
|
+
end
|
319
|
+
|
320
|
+
# Return Content-Type header based on an array of content types provided.
|
321
|
+
# @param [Array] content_types array for Content-Type
|
322
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
323
|
+
def select_header_content_type(content_types)
|
324
|
+
# use application/json by default
|
325
|
+
return 'application/json' if content_types.nil? || content_types.empty?
|
326
|
+
# use JSON when present, otherwise use the first one
|
327
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
328
|
+
json_content_type || content_types.first
|
329
|
+
end
|
330
|
+
|
331
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
332
|
+
# @param [Object] model object to be converted into JSON string
|
333
|
+
# @return [String] JSON string representation of the object
|
334
|
+
def object_to_http_body(model)
|
335
|
+
return model if model.nil? || model.is_a?(String)
|
336
|
+
local_body = nil
|
337
|
+
if model.is_a?(Array)
|
338
|
+
local_body = model.map { |m| object_to_hash(m) }
|
339
|
+
else
|
340
|
+
local_body = object_to_hash(model)
|
341
|
+
end
|
342
|
+
local_body.to_json
|
343
|
+
end
|
344
|
+
|
345
|
+
# Convert object(non-array) to hash.
|
346
|
+
# @param [Object] obj object to be converted into JSON string
|
347
|
+
# @return [String] JSON string representation of the object
|
348
|
+
def object_to_hash(obj)
|
349
|
+
if obj.respond_to?(:to_hash)
|
350
|
+
obj.to_hash
|
351
|
+
else
|
352
|
+
obj
|
353
|
+
end
|
354
|
+
end
|
355
|
+
|
356
|
+
# Build parameter value according to the given collection format.
|
357
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
358
|
+
def build_collection_param(param, collection_format)
|
359
|
+
case collection_format
|
360
|
+
when :csv
|
361
|
+
param.join(',')
|
362
|
+
when :ssv
|
363
|
+
param.join(' ')
|
364
|
+
when :tsv
|
365
|
+
param.join("\t")
|
366
|
+
when :pipes
|
367
|
+
param.join('|')
|
368
|
+
when :multi
|
369
|
+
# return the array directly as typhoeus will handle it as expected
|
370
|
+
param
|
371
|
+
else
|
372
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
373
|
+
end
|
374
|
+
end
|
375
|
+
end
|
376
|
+
end
|