Crowdin::API

The Crowdin Ruby Client is used to interact with the Crowdin API from Ruby.

For more about the Crowdin API see http://crowdin.net/page/api.

Installation

Add this line to your application's Gemfile:

gem 'crowdin-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install crowdin-api

Usage

Start by creating a connection to Crowdin with your credentials:

require 'crowdin-api'
require 'logger'

crowdin = Crowdin::API.new(:api_key => API_KEY, :project_id => PROJECT_ID, :account_key => ACCOUNT_KEY)
crowdin.log = Logger.new $stderr

Now you can make requests to the api.

Add File

Documentation: http://crowdin.net/page/api/add-file.

First parameter is array of files that should be added to Crowdin project. Every file is hash:

:dest - file name with path in Crowdin project (required)
:source - uploaded file (required)
:title - title for uploaded file (optional)
:export_pattern - string that defines name of resulted file (optional)

crowdin.add_file(
  files = [
    { :dest => '/directory/array.xml', :source => 'array.xml', :export_pattern => '/values-%two_letters_code%/%original_file_name%' },
    { :dest => 'strings.xml', :source => 'strings.xml', :title => 'Texts in Application' }
], :type => 'android')

Update File

Documentation http://crowdin.net/page/api/update-file

First parameter is array of files that should be updated in Crowdin project. Every file is hash:

:dest - file name with path in Crowdin project (required)
:source - uploaded file (required)
:title - title for uploaded file (optional)
:export_pattern - string that defines name of resulted file (optional)

crowdin.update_file(
  files = [
    { :dest => '/directory/array.xml', :source => 'array.xml', :export_pattern => '/values-%two_letters_code%/%original_file_name%'},
    { :dest => 'strings.xml', :source => 'strings.xml' }
])

Delete File

Documentation http://crowdin.net/page/api/delete-file

crowdin.delete_file('strings.xml')

Upload Translations

Documentation: http://crowdin.net/page/api/upload-translation

First parameter is array of translated files that should be added to Crowdin project. Every file is hash:

:dest - file names in Crowdin (required)
:source - uploaded translation (required)

Second parameter is target language. With a single call it's possible to upload translations for several files but only into one of the languages. Check complete list of Crowdin language codes that can be used.

Optional params:

:import_duplicates - defines whether to add translation if there is the same translation previously added (default: false)
:import_eq_suggestions - defines whether to add translation if it is equal to source string at Crowdin (default: false)
:auto_approve_imported - mark uploaded translations as approved (default: false)

crowdin.upload_translation(
  files = [
    { :dest => 'strings.xml', :source => 'strings_uk.xml' },
    { :dest => 'array.xml', :source => 'array_uk.xml' }
  ],
  language = 'uk',
  params = {:import_duplicates => true}
)

First parameter is the language of translation you need or download all of them at once.

crowdin.download_translation('ru', :output => '/path/to/download/ru_RU.zip')

Export Translations

Documentation: http://crowdin.net/page/api/export

Account Projects

Documentation: http://crowdin.net/page/api/get-projects

Create Project

Documentation: http://crowdin.net/page/api/create-project

Edit Project

Documentation: http://crowdin.net/page/api/edit-project

Delete Project

Documentation: http://crowdin.net/page/api/delete-project

Create Directory

Documentation: http://crowdin.net/page/api/add-directory

Delete Directory

Documentation: http://crowdin.net/page/api/delete-directory

Download Glossary

Documentation: http://crowdin.net/page/api/download-glossary

Upload Glossary

Documentation: http://crowdin.net/page/api/upload-glossary

Download TM

Documentation: http://crowdin.net/page/api/download-tm

Upload TM

Documentation: http://crowdin.net/page/api/upload-tm

Supported Languages

Documentation: http://crowdin.net/page/api/supported-languages

Supported Rubies

Tested with the following Ruby versions:

MRI 1.9.3
JRuby 1.7.0

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Added some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

License and Author

Author: Anton Maminov ([email protected])

This library is distributed under the MIT license. Please see the LICENSE file.