qordoba_ruby_sdk 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +110 -4
- data/lib/qordoba_ruby_sdk/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 71cf3ec670e319851adeac3b72642481c33c42f3
|
|
4
|
+
data.tar.gz: 7502634fbf4790d744e0a3caf732ce25c5e6d188
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 66a5799dda47dfe7f184f19acd0f39925dfb519f0866a6b815ace97946ddc011c8310949334892eaa8c83fd41188261a1e34c90a0a3c12253e4f150b3a22f3c1
|
|
7
|
+
data.tar.gz: a70266917dbe359a5275706cb88e3a3a33082f2fe9cb67675a1e34fe9373d84396a54a14f3e678dc2c2c4b8fc300befbeb00b4736705cb7c0d60707b12464b9a
|
data/README.md
CHANGED
|
@@ -1,12 +1,118 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Qordoba Ruby Client
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The Ruby client for interacting with the [Qordoba V2 API](https://dev.qordoba.com/v2/reference#about).
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Basic Use
|
|
6
|
+
Install the SDK via RubyGems:
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
`gem install qordoba_ruby_sdk`
|
|
9
|
+
|
|
10
|
+
Instantiate a new app with your consumer_key, organization_id, and project_id:
|
|
11
|
+
|
|
12
|
+
`app = QordobaRubySdk.new('{consumer_key}', '{organization_id}', '{project_id}')`
|
|
13
|
+
|
|
14
|
+
Print a list of all the supported languages:
|
|
15
|
+
|
|
16
|
+
`puts app.languages`
|
|
17
|
+
|
|
18
|
+
Upload a file:
|
|
19
|
+
|
|
20
|
+
`app.file_upload('{path_to_file}', '{version_tag}')`
|
|
21
|
+
|
|
22
|
+
Download a file in JSON:
|
|
23
|
+
|
|
24
|
+
`app.file_json('{language_id}', '{milestone_id}', '{file_id}')`
|
|
25
|
+
|
|
26
|
+
## Full Documentation
|
|
27
|
+
|
|
28
|
+
### Getting Started
|
|
29
|
+
Get the status of the Qordoba API
|
|
30
|
+
|
|
31
|
+
`app.ping`
|
|
32
|
+
|
|
33
|
+
Language detail for Qordoba
|
|
34
|
+
|
|
35
|
+
`app.languages`
|
|
36
|
+
|
|
37
|
+
Country list for Qordoba
|
|
38
|
+
|
|
39
|
+
`app.countries`
|
|
40
|
+
|
|
41
|
+
### Organization
|
|
42
|
+
|
|
43
|
+
Information about your organization's team members
|
|
44
|
+
|
|
45
|
+
`app.organization_team`
|
|
46
|
+
|
|
47
|
+
### Project
|
|
48
|
+
|
|
49
|
+
List of projects that belong to an organization, including some project details.
|
|
50
|
+
|
|
51
|
+
`app.project_list`
|
|
52
|
+
|
|
53
|
+
Detailed information about a project
|
|
54
|
+
|
|
55
|
+
`app.project_detail`
|
|
56
|
+
|
|
57
|
+
Status of all projects
|
|
58
|
+
|
|
59
|
+
`app.project_status`
|
|
60
|
+
|
|
61
|
+
Milestone information, status, and language for a project
|
|
62
|
+
|
|
63
|
+
`app.project_workflow`
|
|
64
|
+
|
|
65
|
+
### File
|
|
66
|
+
|
|
67
|
+
List of project files for a given target languageId or languageCode
|
|
68
|
+
|
|
69
|
+
`app.file_list('{language_id}')`
|
|
70
|
+
- language_id = {number} The id of a target language
|
|
71
|
+
|
|
72
|
+
List of the file types in a project
|
|
73
|
+
|
|
74
|
+
`app.file_types`
|
|
75
|
+
|
|
76
|
+
Uploads a JSON file with a version tag to a project
|
|
77
|
+
|
|
78
|
+
`app.file_upload( '{path_to_file}', '{version_tag}' )`
|
|
79
|
+
- path_to_file = {string} The path to the target file
|
|
80
|
+
- version_tag = {string} A version tag (i.e. '1.0') for the uploaded file
|
|
81
|
+
|
|
82
|
+
Returns a link for downloading a .zip file that contains project files for a specified page and target language
|
|
83
|
+
|
|
84
|
+
`app.file_export( '{language_id}', '{file_ids}' )`
|
|
85
|
+
- language_id = {number} The id of a target language
|
|
86
|
+
- file_ids = {array|number} List of file ids to download
|
|
87
|
+
|
|
88
|
+
Updates a file in a project - parallel updates are not supported
|
|
89
|
+
|
|
90
|
+
`app.file_update( '{path_to_file}', '{file_id}' )`
|
|
91
|
+
- path_to_file = {string} The path to the target file
|
|
92
|
+
- file_id = {number} The id of the target file to update
|
|
93
|
+
|
|
94
|
+
Lists the segments in a file
|
|
95
|
+
|
|
96
|
+
`app.file_segments( '{language_id}', '{file_id}' )`
|
|
97
|
+
- language_id = {number} The id of a target language
|
|
98
|
+
- file_id = {number} The id of the target file
|
|
99
|
+
|
|
100
|
+
Returns a file segment by its id
|
|
101
|
+
|
|
102
|
+
`app.file_segment( '{language_id}', '{file_id}', '{segment_id}' )`
|
|
103
|
+
- language_id = {number} The id of a target language
|
|
104
|
+
- file_id = {number} The id of the target file
|
|
105
|
+
- segment_id = {number} Id of target file segment
|
|
106
|
+
|
|
107
|
+
Returns json object of key value pairs representing a file
|
|
108
|
+
|
|
109
|
+
`app.file_json( '{language_id}', '{milestone_id}', '{file_id}' )`
|
|
110
|
+
- language_id = {number} The id of a target language
|
|
111
|
+
- milestone_id = {number} The id of the milestone to download translation from (i.e. 'proofreading')
|
|
112
|
+
- file_id = {number} The id of the target file
|
|
8
113
|
|
|
9
114
|
## Contributing
|
|
115
|
+
Erik Suddath
|
|
10
116
|
|
|
11
117
|
## License
|
|
12
118
|
|