README.md

Lokalise API v2 official Ruby interface

Official opinionated Ruby interface for the Lokalise API that represents returned data as Ruby objects.

Looking for a Rails integration? Try the lokalise_rails gem. Also you can use a lokalise_manager gem which allows to exchange translation files between Lokalise and any Ruby script.

Quickstart

Install the gem by running:

$ gem install ruby-lokalise-api

Obtain an API token in your personal profile (API tokens section) and initialize the client:

require 'ruby_lokalise_api'

@client = RubyLokaliseApi.client 'YOUR_TOKEN_HERE'

Now the @client can be used to perform API requests:

project = @client.project '123.abc'
project.name

process = @client.upload_file project_id,
                              data: 'Base-64 encoded data... ZnI6DQogI...',
                              filename: 'my_file.yml',
                              lang_iso: 'en'

process.status

Alternatively instantiate your client with an OAuth2 token:

@client = RubyLokaliseApi.oauth2_client 'YOUR_OAUTH2_TOKEN_HERE'

Learn how to generate an OAuth2 token in the docs.

Usage

Detailed documentation can be found at lokalise.github.io/ruby-lokalise-api.

You can also check this repo containing some usage examples and this blog post with explanations.

License

This gem is licensed under the BSD 3 Clause license. Prior to version 4 the license type was MIT.

Copyright (c) Lokalise team and Ilya Krukowski