Add possibility to set smartling.client_lib_id directive value and send it to Smartling

Smartling / api-sdk-ruby

SDK for integrating with the Smartling API. The Smartling API allows developers to upload language specific resource files and download the translations of those files for easy integration within their application.

http://docs.smartling.com

Other

13 stars 15 forks source link

Add possibility to set smartling.client_lib_id directive value and send it to Smartling #8

Open dimitrystd opened 8 years ago

dimitrystd commented 8 years ago

DoD:

Add the new property clientUid to SDK
New property is optional and must have default value
- Default value must contain name of lib + version
- Exact format of strings {"client":"smartling-api-sdk-ruby","version":"1.0.0" }
SDK must add smartling.client_lib_id directive to all Upload request into request params (not a file body)

Example of implementation in java sdk

foo4u commented 7 years ago

@dimitrystd in what form would this render on requests, the user agent, some custom header?

dimitrystd commented 7 years ago

Actually there is 2 separate tasks:

Add lib version as smartling directive (this task)
Add lib version into http user-agent. An example https://github.com/Smartling/api-sdk-java/issues/34

Each one is used for different cases. Smartling directive is saved in content_files table and can be used in looker reports (we have couple of them). But it works only for uploads requests. That the reason why we added to user-agent, to track other activities (check status; downloads). In this case it's possible to use splunk.

amadatimvu commented 6 years ago

facing issue importing smartling: require "smartling_xcode" require "smartling"

': [!] Exit status of command 'cd ..; s/l10n push' was 1 instead of 0. (FastlaneCore::Interface::FastlaneShellError) s/l10n:3:in require': cannot load such file -- smartling_xcode (LoadError) from s/l10n:3:in