tehPlayer/yatapp-rails

Yatapp

Welcome to Yata integration gem, this gem will allow you to easy get your translations from http://yatapp.net service.

Installation

Add this line to your application's Gemfile:

gem 'yatapp'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yatapp

Usage in Rails

Before using Yata integration gem you need to configure it. We recommend adding the following lines to freshly created initialiser in your rails project:

include Yatapp

Yatapp.configure do |c|
  c.api_access_token = ENV['YATA_API_KEY'] # access key to Yata
end

yata_project do
  project_id 'your-project-id' # project id you wish to fetch from (you can find it under settings of your organization)
  languages  ['en', 'de']      # add any languages you wish by language code
  translations_format 'json'   # format you wish to get files in, available for now are (yaml, js and json)
end

# another example of the same project, fetching js translation and saving it at custom path
# (in this case to support rails assets pipe line)
# please notice that if 'save_to_path' is not specified gem will save translations to the local directory
# or in case of rails application into 'config/locales' directory

yata_project do
  project_id 'your-project-id'            # project id you wish to fetch from (you can find it under settings of your organization)
  languages  ['en', 'de']                 # add any languages you wish by language code
  translations_format 'js'                # format you wish to get files in, available for now are (yaml, js and json)
  save_to_path "app/assets/javascripts/"
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

1. Fork it ( https://github.com/[my-github-username]/yatapp/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request