Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Lokalise API v2 official Ruby interface

Gem Build Status Test Coverage Downloads total

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

Looking for a Rails integration? Try the new lokalise_rails gem.

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 = Lokalise.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

Usage

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

License

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

Copyright (c) Lokalise team, Ilya Bodrov