weblate 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +5 -0
- data/COPYING +674 -0
- data/Gemfile +8 -0
- data/README.md +334 -0
- data/Rakefile +49 -0
- data/bin/console +11 -0
- data/bin/setup +8 -0
- data/bin/smoketest +14 -0
- data/bin/smoketest~ +0 -0
- data/docs/ActionEnum.md +15 -0
- data/docs/Addon.md +28 -0
- data/docs/AddonsApi.md +366 -0
- data/docs/AutoComponentList.md +20 -0
- data/docs/BasicUser.md +22 -0
- data/docs/BlankEnum.md +15 -0
- data/docs/CategoriesApi.md +520 -0
- data/docs/Category.md +30 -0
- data/docs/Change.md +42 -0
- data/docs/ChangesApi.md +163 -0
- data/docs/ColorEnum.md +15 -0
- data/docs/Component.md +146 -0
- data/docs/ComponentLanguageCodeStyle.md +49 -0
- data/docs/ComponentList.md +30 -0
- data/docs/ComponentListsApi.md +667 -0
- data/docs/ComponentsApi.md +1653 -0
- data/docs/ConflictsEnum.md +15 -0
- data/docs/DirectionEnum.md +15 -0
- data/docs/FileFormatEnum.md +15 -0
- data/docs/FrequencyEnum.md +15 -0
- data/docs/FuzzyEnum.md +15 -0
- data/docs/Group.md +40 -0
- data/docs/GroupsApi.md +1257 -0
- data/docs/Language.md +36 -0
- data/docs/LanguageCodeStyleEnum.md +15 -0
- data/docs/LanguagePlural.md +26 -0
- data/docs/LanguageSelectionEnum.md +15 -0
- data/docs/LanguagesApi.md +520 -0
- data/docs/LicenseEnum.md +15 -0
- data/docs/LockRequest.md +18 -0
- data/docs/Memory.md +34 -0
- data/docs/MemoryApi.md +448 -0
- data/docs/MergeStyleEnum.md +15 -0
- data/docs/MethodEnum.md +15 -0
- data/docs/Metrics.md +42 -0
- data/docs/MetricsApi.md +81 -0
- data/docs/NewLangEnum.md +15 -0
- data/docs/Notification.md +28 -0
- data/docs/NotificationEnum.md +15 -0
- data/docs/OperationEnum.md +15 -0
- data/docs/PaginatedAddonList.md +24 -0
- data/docs/PaginatedBasicUserList.md +24 -0
- data/docs/PaginatedCategoryList.md +24 -0
- data/docs/PaginatedChangeList.md +24 -0
- data/docs/PaginatedComponentList.md +24 -0
- data/docs/PaginatedComponentListList.md +24 -0
- data/docs/PaginatedGroupList.md +24 -0
- data/docs/PaginatedLanguageList.md +24 -0
- data/docs/PaginatedMemoryList.md +24 -0
- data/docs/PaginatedNotificationList.md +24 -0
- data/docs/PaginatedProjectList.md +24 -0
- data/docs/PaginatedRoleList.md +24 -0
- data/docs/PaginatedScreenshotList.md +24 -0
- data/docs/PaginatedTranslationList.md +24 -0
- data/docs/PaginatedUnitList.md +24 -0
- data/docs/PatchedAddon.md +28 -0
- data/docs/PatchedBasicUser.md +22 -0
- data/docs/PatchedCategory.md +30 -0
- data/docs/PatchedComponent.md +146 -0
- data/docs/PatchedComponentList.md +30 -0
- data/docs/PatchedGroup.md +40 -0
- data/docs/PatchedLanguage.md +36 -0
- data/docs/PatchedMemory.md +34 -0
- data/docs/PatchedNotification.md +28 -0
- data/docs/PatchedProject.md +58 -0
- data/docs/PatchedRole.md +24 -0
- data/docs/PatchedScreenshot.md +30 -0
- data/docs/PatchedUnitWrite.md +26 -0
- data/docs/PriorityEnum.md +15 -0
- data/docs/Project.md +58 -0
- data/docs/ProjectSelectionEnum.md +15 -0
- data/docs/ProjectsApi.md +1392 -0
- data/docs/RepoRequest.md +18 -0
- data/docs/Role.md +24 -0
- data/docs/RolesApi.md +448 -0
- data/docs/ScopeEnum.md +15 -0
- data/docs/Screenshot.md +30 -0
- data/docs/ScreenshotFile.md +18 -0
- data/docs/ScreenshotsApi.md +815 -0
- data/docs/SearchApi.md +75 -0
- data/docs/SourceEnum.md +15 -0
- data/docs/StateEnum.md +15 -0
- data/docs/TasksApi.md +145 -0
- data/docs/TextDirection.md +49 -0
- data/docs/Translation.md +80 -0
- data/docs/TranslationsApi.md +1028 -0
- data/docs/Unit.md +76 -0
- data/docs/UnitFlatLabels.md +24 -0
- data/docs/UnitLabels.md +24 -0
- data/docs/UnitWrite.md +26 -0
- data/docs/UnitsApi.md +376 -0
- data/docs/UploadRequest.md +28 -0
- data/docs/UploadRequestConflicts.md +49 -0
- data/docs/UploadRequestFuzzy.md +49 -0
- data/docs/UsersApi.md +1130 -0
- data/docs/VcsEnum.md +15 -0
- data/git_push.sh +57 -0
- data/lib/weblate/api/addons_api.rb +353 -0
- data/lib/weblate/api/categories_api.rb +495 -0
- data/lib/weblate/api/changes_api.rb +165 -0
- data/lib/weblate/api/component_lists_api.rb +642 -0
- data/lib/weblate/api/components_api.rb +1775 -0
- data/lib/weblate/api/groups_api.rb +1261 -0
- data/lib/weblate/api/languages_api.rb +495 -0
- data/lib/weblate/api/memory_api.rb +429 -0
- data/lib/weblate/api/metrics_api.rb +84 -0
- data/lib/weblate/api/projects_api.rb +1331 -0
- data/lib/weblate/api/roles_api.rb +429 -0
- data/lib/weblate/api/screenshots_api.rb +803 -0
- data/lib/weblate/api/search_api.rb +75 -0
- data/lib/weblate/api/tasks_api.rb +146 -0
- data/lib/weblate/api/translations_api.rb +1232 -0
- data/lib/weblate/api/units_api.rb +363 -0
- data/lib/weblate/api/users_api.rb +1104 -0
- data/lib/weblate/api_client.rb +437 -0
- data/lib/weblate/api_error.rb +58 -0
- data/lib/weblate/configuration.rb +392 -0
- data/lib/weblate/models/action_enum.rb +108 -0
- data/lib/weblate/models/addon.rb +314 -0
- data/lib/weblate/models/auto_component_list.rb +263 -0
- data/lib/weblate/models/basic_user.rb +292 -0
- data/lib/weblate/models/blank_enum.rb +39 -0
- data/lib/weblate/models/category.rb +361 -0
- data/lib/weblate/models/change.rb +408 -0
- data/lib/weblate/models/color_enum.rb +54 -0
- data/lib/weblate/models/component.rb +1377 -0
- data/lib/weblate/models/component_language_code_style.rb +106 -0
- data/lib/weblate/models/component_list.rb +366 -0
- data/lib/weblate/models/conflicts_enum.rb +41 -0
- data/lib/weblate/models/direction_enum.rb +40 -0
- data/lib/weblate/models/file_format_enum.rb +101 -0
- data/lib/weblate/models/frequency_enum.rb +43 -0
- data/lib/weblate/models/fuzzy_enum.rb +40 -0
- data/lib/weblate/models/group.rb +421 -0
- data/lib/weblate/models/language.rb +417 -0
- data/lib/weblate/models/language_code_style_enum.rb +51 -0
- data/lib/weblate/models/language_plural.rb +314 -0
- data/lib/weblate/models/language_selection_enum.rb +40 -0
- data/lib/weblate/models/license_enum.rb +677 -0
- data/lib/weblate/models/lock_request.rb +221 -0
- data/lib/weblate/models/memory.rb +329 -0
- data/lib/weblate/models/merge_style_enum.rb +41 -0
- data/lib/weblate/models/method_enum.rb +45 -0
- data/lib/weblate/models/metrics.rb +415 -0
- data/lib/weblate/models/new_lang_enum.rb +42 -0
- data/lib/weblate/models/notification.rb +323 -0
- data/lib/weblate/models/notification_enum.rb +60 -0
- data/lib/weblate/models/operation_enum.rb +43 -0
- data/lib/weblate/models/paginated_addon_list.rb +259 -0
- data/lib/weblate/models/paginated_basic_user_list.rb +259 -0
- data/lib/weblate/models/paginated_category_list.rb +259 -0
- data/lib/weblate/models/paginated_change_list.rb +259 -0
- data/lib/weblate/models/paginated_component_list.rb +259 -0
- data/lib/weblate/models/paginated_component_list_list.rb +259 -0
- data/lib/weblate/models/paginated_group_list.rb +259 -0
- data/lib/weblate/models/paginated_language_list.rb +259 -0
- data/lib/weblate/models/paginated_memory_list.rb +259 -0
- data/lib/weblate/models/paginated_notification_list.rb +259 -0
- data/lib/weblate/models/paginated_project_list.rb +259 -0
- data/lib/weblate/models/paginated_role_list.rb +259 -0
- data/lib/weblate/models/paginated_screenshot_list.rb +259 -0
- data/lib/weblate/models/paginated_translation_list.rb +259 -0
- data/lib/weblate/models/paginated_unit_list.rb +259 -0
- data/lib/weblate/models/patched_addon.rb +279 -0
- data/lib/weblate/models/patched_basic_user.rb +271 -0
- data/lib/weblate/models/patched_category.rb +319 -0
- data/lib/weblate/models/patched_component.rb +1242 -0
- data/lib/weblate/models/patched_component_list.rb +324 -0
- data/lib/weblate/models/patched_group.rb +365 -0
- data/lib/weblate/models/patched_language.rb +375 -0
- data/lib/weblate/models/patched_memory.rb +287 -0
- data/lib/weblate/models/patched_notification.rb +281 -0
- data/lib/weblate/models/patched_project.rb +472 -0
- data/lib/weblate/models/patched_role.rb +262 -0
- data/lib/weblate/models/patched_screenshot.rb +309 -0
- data/lib/weblate/models/patched_unit_write.rb +279 -0
- data/lib/weblate/models/priority_enum.rb +43 -0
- data/lib/weblate/models/project.rb +563 -0
- data/lib/weblate/models/project_selection_enum.rb +43 -0
- data/lib/weblate/models/repo_request.rb +243 -0
- data/lib/weblate/models/role.rb +290 -0
- data/lib/weblate/models/scope_enum.rb +43 -0
- data/lib/weblate/models/screenshot.rb +351 -0
- data/lib/weblate/models/screenshot_file.rb +221 -0
- data/lib/weblate/models/source_enum.rb +45 -0
- data/lib/weblate/models/state_enum.rb +43 -0
- data/lib/weblate/models/text_direction.rb +105 -0
- data/lib/weblate/models/translation.rb +760 -0
- data/lib/weblate/models/unit.rb +757 -0
- data/lib/weblate/models/unit_flat_labels.rb +315 -0
- data/lib/weblate/models/unit_labels.rb +315 -0
- data/lib/weblate/models/unit_write.rb +293 -0
- data/lib/weblate/models/upload_request.rb +307 -0
- data/lib/weblate/models/upload_request_conflicts.rb +105 -0
- data/lib/weblate/models/upload_request_fuzzy.rb +105 -0
- data/lib/weblate/models/vcs_enum.rb +46 -0
- data/lib/weblate/version.rb +15 -0
- data/lib/weblate.rb +135 -0
- data/manifest.scm +6 -0
- data/schema.patched.yaml +10113 -0
- data/schema.yaml +10116 -0
- data/sig/weblate.rbs +4 -0
- data/spec/api/addons_api_spec.rb +88 -0
- data/spec/api/categories_api_spec.rb +115 -0
- data/spec/api/changes_api_spec.rb +62 -0
- data/spec/api/component_lists_api_spec.rb +139 -0
- data/spec/api/components_api_spec.rb +307 -0
- data/spec/api/groups_api_spec.rb +236 -0
- data/spec/api/languages_api_spec.rb +115 -0
- data/spec/api/memory_api_spec.rb +104 -0
- data/spec/api/metrics_api_spec.rb +46 -0
- data/spec/api/projects_api_spec.rb +251 -0
- data/spec/api/roles_api_spec.rb +104 -0
- data/spec/api/screenshots_api_spec.rb +163 -0
- data/spec/api/search_api_spec.rb +45 -0
- data/spec/api/tasks_api_spec.rb +55 -0
- data/spec/api/translations_api_spec.rb +218 -0
- data/spec/api/units_api_spec.rb +93 -0
- data/spec/api/users_api_spec.rb +218 -0
- data/spec/models/action_enum_spec.rb +30 -0
- data/spec/models/addon_spec.rb +66 -0
- data/spec/models/auto_component_list_spec.rb +42 -0
- data/spec/models/basic_user_spec.rb +48 -0
- data/spec/models/blank_enum_spec.rb +30 -0
- data/spec/models/category_spec.rb +72 -0
- data/spec/models/change_spec.rb +108 -0
- data/spec/models/color_enum_spec.rb +30 -0
- data/spec/models/component_language_code_style_spec.rb +32 -0
- data/spec/models/component_list_spec.rb +72 -0
- data/spec/models/component_spec.rb +420 -0
- data/spec/models/conflicts_enum_spec.rb +30 -0
- data/spec/models/direction_enum_spec.rb +30 -0
- data/spec/models/file_format_enum_spec.rb +30 -0
- data/spec/models/frequency_enum_spec.rb +30 -0
- data/spec/models/fuzzy_enum_spec.rb +30 -0
- data/spec/models/group_spec.rb +102 -0
- data/spec/models/language_code_style_enum_spec.rb +30 -0
- data/spec/models/language_plural_spec.rb +60 -0
- data/spec/models/language_selection_enum_spec.rb +30 -0
- data/spec/models/language_spec.rb +90 -0
- data/spec/models/license_enum_spec.rb +30 -0
- data/spec/models/lock_request_spec.rb +36 -0
- data/spec/models/memory_spec.rb +84 -0
- data/spec/models/merge_style_enum_spec.rb +30 -0
- data/spec/models/method_enum_spec.rb +30 -0
- data/spec/models/metrics_spec.rb +108 -0
- data/spec/models/new_lang_enum_spec.rb +30 -0
- data/spec/models/notification_enum_spec.rb +30 -0
- data/spec/models/notification_spec.rb +66 -0
- data/spec/models/operation_enum_spec.rb +30 -0
- data/spec/models/paginated_addon_list_spec.rb +54 -0
- data/spec/models/paginated_basic_user_list_spec.rb +54 -0
- data/spec/models/paginated_category_list_spec.rb +54 -0
- data/spec/models/paginated_change_list_spec.rb +54 -0
- data/spec/models/paginated_component_list_list_spec.rb +54 -0
- data/spec/models/paginated_component_list_spec.rb +54 -0
- data/spec/models/paginated_group_list_spec.rb +54 -0
- data/spec/models/paginated_language_list_spec.rb +54 -0
- data/spec/models/paginated_memory_list_spec.rb +54 -0
- data/spec/models/paginated_notification_list_spec.rb +54 -0
- data/spec/models/paginated_project_list_spec.rb +54 -0
- data/spec/models/paginated_role_list_spec.rb +54 -0
- data/spec/models/paginated_screenshot_list_spec.rb +54 -0
- data/spec/models/paginated_translation_list_spec.rb +54 -0
- data/spec/models/paginated_unit_list_spec.rb +54 -0
- data/spec/models/patched_addon_spec.rb +66 -0
- data/spec/models/patched_basic_user_spec.rb +48 -0
- data/spec/models/patched_category_spec.rb +72 -0
- data/spec/models/patched_component_list_spec.rb +72 -0
- data/spec/models/patched_component_spec.rb +420 -0
- data/spec/models/patched_group_spec.rb +102 -0
- data/spec/models/patched_language_spec.rb +90 -0
- data/spec/models/patched_memory_spec.rb +84 -0
- data/spec/models/patched_notification_spec.rb +66 -0
- data/spec/models/patched_project_spec.rb +156 -0
- data/spec/models/patched_role_spec.rb +54 -0
- data/spec/models/patched_screenshot_spec.rb +72 -0
- data/spec/models/patched_unit_write_spec.rb +60 -0
- data/spec/models/priority_enum_spec.rb +30 -0
- data/spec/models/project_selection_enum_spec.rb +30 -0
- data/spec/models/project_spec.rb +156 -0
- data/spec/models/repo_request_spec.rb +36 -0
- data/spec/models/role_spec.rb +54 -0
- data/spec/models/scope_enum_spec.rb +30 -0
- data/spec/models/screenshot_file_spec.rb +36 -0
- data/spec/models/screenshot_spec.rb +72 -0
- data/spec/models/source_enum_spec.rb +30 -0
- data/spec/models/state_enum_spec.rb +30 -0
- data/spec/models/text_direction_spec.rb +32 -0
- data/spec/models/translation_spec.rb +222 -0
- data/spec/models/unit_flat_labels_spec.rb +54 -0
- data/spec/models/unit_labels_spec.rb +54 -0
- data/spec/models/unit_spec.rb +210 -0
- data/spec/models/unit_write_spec.rb +60 -0
- data/spec/models/upload_request_conflicts_spec.rb +32 -0
- data/spec/models/upload_request_fuzzy_spec.rb +32 -0
- data/spec/models/upload_request_spec.rb +66 -0
- data/spec/models/vcs_enum_spec.rb +30 -0
- data/spec/spec_helper.rb +111 -0
- data/weblate.gemspec +47 -0
- metadata +526 -0
@@ -0,0 +1,437 @@
|
|
1
|
+
=begin
|
2
|
+
#Weblate's REST API
|
3
|
+
|
4
|
+
# The API is accessible on the ``/api/`` URL and it is based on [Django REST framework](https://www.django-rest-framework.org/). The OpenAPI specification is available as feature preview, feedback welcome!
|
5
|
+
|
6
|
+
The version of the OpenAPI document:
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.9.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'json'
|
15
|
+
require 'logger'
|
16
|
+
require 'tempfile'
|
17
|
+
require 'time'
|
18
|
+
require 'faraday'
|
19
|
+
require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
|
20
|
+
require 'marcel'
|
21
|
+
|
22
|
+
|
23
|
+
module Weblate
|
24
|
+
class ApiClient
|
25
|
+
# The Configuration object holding settings to be used in the API client.
|
26
|
+
attr_accessor :config
|
27
|
+
|
28
|
+
# Defines the headers to be used in HTTP requests of all API calls by default.
|
29
|
+
#
|
30
|
+
# @return [Hash]
|
31
|
+
attr_accessor :default_headers
|
32
|
+
|
33
|
+
# Initializes the ApiClient
|
34
|
+
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
35
|
+
def initialize(config = Configuration.default)
|
36
|
+
@config = config
|
37
|
+
@user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
|
38
|
+
@default_headers = {
|
39
|
+
'Content-Type' => 'application/json',
|
40
|
+
'User-Agent' => @user_agent
|
41
|
+
}
|
42
|
+
end
|
43
|
+
|
44
|
+
def self.default
|
45
|
+
@@default ||= ApiClient.new
|
46
|
+
end
|
47
|
+
|
48
|
+
# Call an API with given options.
|
49
|
+
#
|
50
|
+
# @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
|
51
|
+
# the data deserialized from response body (could be nil), response status code and response headers.
|
52
|
+
def call_api(http_method, path, opts = {})
|
53
|
+
stream = nil
|
54
|
+
begin
|
55
|
+
response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
|
56
|
+
request = build_request(http_method, path, req, opts)
|
57
|
+
stream = download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
|
58
|
+
end
|
59
|
+
|
60
|
+
if config.debugging
|
61
|
+
config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
|
62
|
+
end
|
63
|
+
|
64
|
+
unless response.success?
|
65
|
+
if response.status == 0 && response.respond_to?(:return_message)
|
66
|
+
# Errors from libcurl will be made visible here
|
67
|
+
fail ApiError.new(code: 0,
|
68
|
+
message: response.return_message)
|
69
|
+
else
|
70
|
+
fail ApiError.new(code: response.status,
|
71
|
+
response_headers: response.headers,
|
72
|
+
response_body: response.body),
|
73
|
+
response.reason_phrase
|
74
|
+
end
|
75
|
+
end
|
76
|
+
rescue Faraday::TimeoutError
|
77
|
+
fail ApiError.new('Connection timed out')
|
78
|
+
rescue Faraday::ConnectionFailed
|
79
|
+
fail ApiError.new('Connection failed')
|
80
|
+
end
|
81
|
+
|
82
|
+
if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
|
83
|
+
data = deserialize_file(response, stream)
|
84
|
+
elsif opts[:return_type]
|
85
|
+
data = deserialize(response, opts[:return_type])
|
86
|
+
else
|
87
|
+
data = nil
|
88
|
+
end
|
89
|
+
return data, response.status, response.headers
|
90
|
+
end
|
91
|
+
|
92
|
+
# Builds the HTTP request
|
93
|
+
#
|
94
|
+
# @param [String] http_method HTTP method/verb (e.g. POST)
|
95
|
+
# @param [String] path URL path (e.g. /account/new)
|
96
|
+
# @option opts [Hash] :header_params Header parameters
|
97
|
+
# @option opts [Hash] :query_params Query parameters
|
98
|
+
# @option opts [Hash] :form_params Query parameters
|
99
|
+
# @option opts [Object] :body HTTP body (JSON/XML)
|
100
|
+
# @return [Faraday::Request] A Faraday Request
|
101
|
+
def build_request(http_method, path, request, opts = {})
|
102
|
+
url = build_request_url(path, opts)
|
103
|
+
http_method = http_method.to_sym.downcase
|
104
|
+
|
105
|
+
header_params = @default_headers.merge(opts[:header_params] || {})
|
106
|
+
query_params = opts[:query_params] || {}
|
107
|
+
form_params = opts[:form_params] || {}
|
108
|
+
|
109
|
+
update_params_for_auth! header_params, query_params, opts[:auth_names]
|
110
|
+
|
111
|
+
if [:post, :patch, :put, :delete].include?(http_method)
|
112
|
+
req_body = build_request_body(header_params, form_params, opts[:body])
|
113
|
+
if config.debugging
|
114
|
+
config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
|
115
|
+
end
|
116
|
+
end
|
117
|
+
request.headers = header_params
|
118
|
+
request.body = req_body
|
119
|
+
|
120
|
+
# Overload default options only if provided
|
121
|
+
request.options.params_encoder = config.params_encoder if config.params_encoder
|
122
|
+
request.options.timeout = config.timeout if config.timeout
|
123
|
+
|
124
|
+
request.url url
|
125
|
+
request.params = query_params
|
126
|
+
request
|
127
|
+
end
|
128
|
+
|
129
|
+
# Builds the HTTP request body
|
130
|
+
#
|
131
|
+
# @param [Hash] header_params Header parameters
|
132
|
+
# @param [Hash] form_params Query parameters
|
133
|
+
# @param [Object] body HTTP body (JSON/XML)
|
134
|
+
# @return [String] HTTP body data in the form of string
|
135
|
+
def build_request_body(header_params, form_params, body)
|
136
|
+
# http form
|
137
|
+
if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
|
138
|
+
data = URI.encode_www_form(form_params)
|
139
|
+
elsif header_params['Content-Type'] == 'multipart/form-data'
|
140
|
+
data = {}
|
141
|
+
form_params.each do |key, value|
|
142
|
+
case value
|
143
|
+
when ::File, ::Tempfile
|
144
|
+
data[key] = Faraday::FilePart.new(value.path, Marcel::MimeType.for(Pathname.new(value.path)))
|
145
|
+
when ::Array, nil
|
146
|
+
# let Faraday handle Array and nil parameters
|
147
|
+
data[key] = value
|
148
|
+
else
|
149
|
+
data[key] = value.to_s
|
150
|
+
end
|
151
|
+
end
|
152
|
+
elsif body
|
153
|
+
data = body.is_a?(String) ? body : body.to_json
|
154
|
+
else
|
155
|
+
data = nil
|
156
|
+
end
|
157
|
+
data
|
158
|
+
end
|
159
|
+
|
160
|
+
def download_file(request)
|
161
|
+
stream = []
|
162
|
+
|
163
|
+
# handle streaming Responses
|
164
|
+
request.options.on_data = Proc.new do |chunk, overall_received_bytes|
|
165
|
+
stream << chunk
|
166
|
+
end
|
167
|
+
|
168
|
+
stream
|
169
|
+
end
|
170
|
+
|
171
|
+
def deserialize_file(response, stream)
|
172
|
+
body = response.body
|
173
|
+
encoding = body.encoding
|
174
|
+
|
175
|
+
# reconstruct content
|
176
|
+
content = stream.join
|
177
|
+
content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'binary'
|
178
|
+
content = content.force_encoding(encoding)
|
179
|
+
|
180
|
+
# return byte stream
|
181
|
+
return content if @config.return_binary_data == true
|
182
|
+
|
183
|
+
# return file instead of binary data
|
184
|
+
content_disposition = response.headers['Content-Disposition']
|
185
|
+
if content_disposition && content_disposition =~ /filename=/i
|
186
|
+
filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
|
187
|
+
prefix = sanitize_filename(filename)
|
188
|
+
else
|
189
|
+
prefix = 'download-'
|
190
|
+
end
|
191
|
+
prefix = prefix + '-' unless prefix.end_with?('-')
|
192
|
+
|
193
|
+
tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
|
194
|
+
tempfile.write(content)
|
195
|
+
tempfile.close
|
196
|
+
|
197
|
+
config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
|
198
|
+
"with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
|
199
|
+
"will be deleted automatically with GC. It's also recommended to delete the temp file "\
|
200
|
+
"explicitly with `tempfile.delete`"
|
201
|
+
tempfile
|
202
|
+
end
|
203
|
+
|
204
|
+
def connection(opts)
|
205
|
+
opts[:header_params]['Content-Type'] == 'multipart/form-data' ? connection_multipart : connection_regular
|
206
|
+
end
|
207
|
+
|
208
|
+
def connection_multipart
|
209
|
+
@connection_multipart ||= build_connection do |conn|
|
210
|
+
conn.request :multipart
|
211
|
+
conn.request :url_encoded
|
212
|
+
end
|
213
|
+
end
|
214
|
+
|
215
|
+
def connection_regular
|
216
|
+
@connection_regular ||= build_connection
|
217
|
+
end
|
218
|
+
|
219
|
+
def build_connection
|
220
|
+
Faraday.new(url: config.base_url, ssl: ssl_options, proxy: config.proxy) do |conn|
|
221
|
+
basic_auth(conn)
|
222
|
+
config.configure_middleware(conn)
|
223
|
+
yield(conn) if block_given?
|
224
|
+
conn.adapter(Faraday.default_adapter)
|
225
|
+
config.configure_connection(conn)
|
226
|
+
end
|
227
|
+
end
|
228
|
+
|
229
|
+
def ssl_options
|
230
|
+
{
|
231
|
+
ca_file: config.ssl_ca_file,
|
232
|
+
verify: config.ssl_verify,
|
233
|
+
verify_mode: config.ssl_verify_mode,
|
234
|
+
client_cert: config.ssl_client_cert,
|
235
|
+
client_key: config.ssl_client_key
|
236
|
+
}
|
237
|
+
end
|
238
|
+
|
239
|
+
def basic_auth(conn)
|
240
|
+
if config.username && config.password
|
241
|
+
if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
|
242
|
+
conn.request(:authorization, :basic, config.username, config.password)
|
243
|
+
else
|
244
|
+
conn.request(:basic_auth, config.username, config.password)
|
245
|
+
end
|
246
|
+
end
|
247
|
+
end
|
248
|
+
|
249
|
+
# Check if the given MIME is a JSON MIME.
|
250
|
+
# JSON MIME examples:
|
251
|
+
# application/json
|
252
|
+
# application/json; charset=UTF8
|
253
|
+
# APPLICATION/JSON
|
254
|
+
# */*
|
255
|
+
# @param [String] mime MIME
|
256
|
+
# @return [Boolean] True if the MIME is application/json
|
257
|
+
def json_mime?(mime)
|
258
|
+
(mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
|
259
|
+
end
|
260
|
+
|
261
|
+
# Deserialize the response to the given return type.
|
262
|
+
#
|
263
|
+
# @param [Response] response HTTP response
|
264
|
+
# @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
|
265
|
+
def deserialize(response, return_type)
|
266
|
+
body = response.body
|
267
|
+
return nil if body.nil? || body.empty?
|
268
|
+
|
269
|
+
# return response body directly for String return type
|
270
|
+
return body.to_s if return_type == 'String'
|
271
|
+
|
272
|
+
# ensuring a default content type
|
273
|
+
content_type = response.headers['Content-Type'] || 'application/json'
|
274
|
+
|
275
|
+
fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
|
276
|
+
|
277
|
+
begin
|
278
|
+
data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
|
279
|
+
rescue JSON::ParserError => e
|
280
|
+
if %w(String Date Time).include?(return_type)
|
281
|
+
data = body
|
282
|
+
else
|
283
|
+
raise e
|
284
|
+
end
|
285
|
+
end
|
286
|
+
|
287
|
+
convert_to_type data, return_type
|
288
|
+
end
|
289
|
+
|
290
|
+
# Convert data to the given return type.
|
291
|
+
# @param [Object] data Data to be converted
|
292
|
+
# @param [String] return_type Return type
|
293
|
+
# @return [Mixed] Data in a particular type
|
294
|
+
def convert_to_type(data, return_type)
|
295
|
+
return nil if data.nil?
|
296
|
+
case return_type
|
297
|
+
when 'String'
|
298
|
+
data.to_s
|
299
|
+
when 'Integer'
|
300
|
+
data.to_i
|
301
|
+
when 'Float'
|
302
|
+
data.to_f
|
303
|
+
when 'Boolean'
|
304
|
+
data == true
|
305
|
+
when 'Time'
|
306
|
+
# parse date time (expecting ISO 8601 format)
|
307
|
+
Time.parse data
|
308
|
+
when 'Date'
|
309
|
+
# parse date time (expecting ISO 8601 format)
|
310
|
+
Date.parse data
|
311
|
+
when 'Object'
|
312
|
+
# generic object (usually a Hash), return directly
|
313
|
+
data
|
314
|
+
when /\AArray<(.+)>\z/
|
315
|
+
# e.g. Array<Pet>
|
316
|
+
sub_type = $1
|
317
|
+
data.map { |item| convert_to_type(item, sub_type) }
|
318
|
+
when /\AHash\<String, (.+)\>\z/
|
319
|
+
# e.g. Hash<String, Integer>
|
320
|
+
sub_type = $1
|
321
|
+
{}.tap do |hash|
|
322
|
+
data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
|
323
|
+
end
|
324
|
+
else
|
325
|
+
# models (e.g. Pet) or oneOf
|
326
|
+
klass = Weblate.const_get(return_type)
|
327
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
|
328
|
+
end
|
329
|
+
end
|
330
|
+
|
331
|
+
# Sanitize filename by removing path.
|
332
|
+
# e.g. ../../sun.gif becomes sun.gif
|
333
|
+
#
|
334
|
+
# @param [String] filename the filename to be sanitized
|
335
|
+
# @return [String] the sanitized filename
|
336
|
+
def sanitize_filename(filename)
|
337
|
+
filename.split(/[\/\\]/).last
|
338
|
+
end
|
339
|
+
|
340
|
+
def build_request_url(path, opts = {})
|
341
|
+
# Add leading and trailing slashes to path
|
342
|
+
path = "/#{path}".gsub(/\/+/, '/')
|
343
|
+
@config.base_url(opts[:operation]) + path
|
344
|
+
end
|
345
|
+
|
346
|
+
# Update header and query params based on authentication settings.
|
347
|
+
#
|
348
|
+
# @param [Hash] header_params Header parameters
|
349
|
+
# @param [Hash] query_params Query parameters
|
350
|
+
# @param [String] auth_names Authentication scheme name
|
351
|
+
def update_params_for_auth!(header_params, query_params, auth_names)
|
352
|
+
Array(auth_names).each do |auth_name|
|
353
|
+
auth_setting = @config.auth_settings[auth_name]
|
354
|
+
next unless auth_setting
|
355
|
+
case auth_setting[:in]
|
356
|
+
when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
|
357
|
+
when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
|
358
|
+
else fail ArgumentError, 'Authentication token must be in `query` or `header`'
|
359
|
+
end
|
360
|
+
end
|
361
|
+
end
|
362
|
+
|
363
|
+
# Sets user agent in HTTP header
|
364
|
+
#
|
365
|
+
# @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
|
366
|
+
def user_agent=(user_agent)
|
367
|
+
@user_agent = user_agent
|
368
|
+
@default_headers['User-Agent'] = @user_agent
|
369
|
+
end
|
370
|
+
|
371
|
+
# Return Accept header based on an array of accepts provided.
|
372
|
+
# @param [Array] accepts array for Accept
|
373
|
+
# @return [String] the Accept header (e.g. application/json)
|
374
|
+
def select_header_accept(accepts)
|
375
|
+
return nil if accepts.nil? || accepts.empty?
|
376
|
+
# use JSON when present, otherwise use all of the provided
|
377
|
+
json_accept = accepts.find { |s| json_mime?(s) }
|
378
|
+
json_accept || accepts.join(',')
|
379
|
+
end
|
380
|
+
|
381
|
+
# Return Content-Type header based on an array of content types provided.
|
382
|
+
# @param [Array] content_types array for Content-Type
|
383
|
+
# @return [String] the Content-Type header (e.g. application/json)
|
384
|
+
def select_header_content_type(content_types)
|
385
|
+
# return nil by default
|
386
|
+
return if content_types.nil? || content_types.empty?
|
387
|
+
# use JSON when present, otherwise use the first one
|
388
|
+
json_content_type = content_types.find { |s| json_mime?(s) }
|
389
|
+
json_content_type || content_types.first
|
390
|
+
end
|
391
|
+
|
392
|
+
# Convert object (array, hash, object, etc) to JSON string.
|
393
|
+
# @param [Object] model object to be converted into JSON string
|
394
|
+
# @return [String] JSON string representation of the object
|
395
|
+
def object_to_http_body(model)
|
396
|
+
return model if model.nil? || model.is_a?(String)
|
397
|
+
local_body = nil
|
398
|
+
if model.is_a?(Array)
|
399
|
+
local_body = model.map { |m| object_to_hash(m) }
|
400
|
+
else
|
401
|
+
local_body = object_to_hash(model)
|
402
|
+
end
|
403
|
+
local_body.to_json
|
404
|
+
end
|
405
|
+
|
406
|
+
# Convert object(non-array) to hash.
|
407
|
+
# @param [Object] obj object to be converted into JSON string
|
408
|
+
# @return [String] JSON string representation of the object
|
409
|
+
def object_to_hash(obj)
|
410
|
+
if obj.respond_to?(:to_hash)
|
411
|
+
obj.to_hash
|
412
|
+
else
|
413
|
+
obj
|
414
|
+
end
|
415
|
+
end
|
416
|
+
|
417
|
+
# Build parameter value according to the given collection format.
|
418
|
+
# @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
|
419
|
+
def build_collection_param(param, collection_format)
|
420
|
+
case collection_format
|
421
|
+
when :csv
|
422
|
+
param.join(',')
|
423
|
+
when :ssv
|
424
|
+
param.join(' ')
|
425
|
+
when :tsv
|
426
|
+
param.join("\t")
|
427
|
+
when :pipes
|
428
|
+
param.join('|')
|
429
|
+
when :multi
|
430
|
+
# return the array directly as typhoeus will handle it as expected
|
431
|
+
param
|
432
|
+
else
|
433
|
+
fail "unknown collection format: #{collection_format.inspect}"
|
434
|
+
end
|
435
|
+
end
|
436
|
+
end
|
437
|
+
end
|
@@ -0,0 +1,58 @@
|
|
1
|
+
=begin
|
2
|
+
#Weblate's REST API
|
3
|
+
|
4
|
+
# The API is accessible on the ``/api/`` URL and it is based on [Django REST framework](https://www.django-rest-framework.org/). The OpenAPI specification is available as feature preview, feedback welcome!
|
5
|
+
|
6
|
+
The version of the OpenAPI document:
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
Generator version: 7.9.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
module Weblate
|
14
|
+
class ApiError < StandardError
|
15
|
+
attr_reader :code, :response_headers, :response_body
|
16
|
+
|
17
|
+
# Usage examples:
|
18
|
+
# ApiError.new
|
19
|
+
# ApiError.new("message")
|
20
|
+
# ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
|
21
|
+
# ApiError.new(:code => 404, :message => "Not Found")
|
22
|
+
def initialize(arg = nil)
|
23
|
+
if arg.is_a? Hash
|
24
|
+
if arg.key?(:message) || arg.key?('message')
|
25
|
+
super(arg[:message] || arg['message'])
|
26
|
+
else
|
27
|
+
super arg
|
28
|
+
end
|
29
|
+
|
30
|
+
arg.each do |k, v|
|
31
|
+
instance_variable_set "@#{k}", v
|
32
|
+
end
|
33
|
+
else
|
34
|
+
super arg
|
35
|
+
@message = arg
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
# Override to_s to display a friendly error message
|
40
|
+
def to_s
|
41
|
+
message
|
42
|
+
end
|
43
|
+
|
44
|
+
def message
|
45
|
+
if @message.nil?
|
46
|
+
msg = "Error message: the server returns an error"
|
47
|
+
else
|
48
|
+
msg = @message
|
49
|
+
end
|
50
|
+
|
51
|
+
msg += "\nHTTP status code: #{code}" if code
|
52
|
+
msg += "\nResponse headers: #{response_headers}" if response_headers
|
53
|
+
msg += "\nResponse body: #{response_body}" if response_body
|
54
|
+
|
55
|
+
msg
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|