{"id":13994439,"url":"https://github.com/phrase/phraseapp-ruby","last_synced_at":"2025-07-05T15:03:50.913Z","repository":{"id":32914036,"uuid":"36509290","full_name":"phrase/phraseapp-ruby","owner":"phrase","description":"API Client to access Phrase API written in Ruby","archived":false,"fork":false,"pushed_at":"2021-09-21T12:51:04.000Z","size":1643,"stargazers_count":18,"open_issues_count":0,"forks_count":4,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-04-23T19:50:12.478Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://phrase.com","language":"Ruby","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/phrase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2015-05-29T14:30:35.000Z","updated_at":"2023-07-03T05:48:53.000Z","dependencies_parsed_at":"2022-09-25T05:10:53.341Z","dependency_job_id":null,"html_url":"https://github.com/phrase/phraseapp-ruby","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/phrase/phraseapp-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phrase%2Fphraseapp-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phrase%2Fphraseapp-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phrase%2Fphraseapp-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phrase%2Fphraseapp-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phrase","download_url":"https://codeload.github.com/phrase/phraseapp-ruby/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phrase%2Fphraseapp-ruby/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259868391,"owners_count":22924233,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-09T14:02:52.563Z","updated_at":"2025-06-22T22:04:19.146Z","avatar_url":"https://github.com/phrase.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# [Deprecated]\nThis library is deprecated and has been replaced by [phrase-ruby](https://github.com/phrase/phrase-ruby)\n\n\n# phraseapp-ruby\n\nphraseapp-ruby is a Ruby gem that allows you to interact with the [Phrase API](https://developers.phrase.com/api/).\n\nPhrase is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase for your account.\n\nphraseapp-ruby is not a replacement for the **phrase gem**, it is a pure API client for programmaticly using our features inside your own applications and does not support the push or pull commands for locale files. However, it does support uploading and downloading of single locale files through the according API endpoints.\n\nIf you're looking for a CLI sync command for Phrase, please user our official [Phrase client](https://help.phrase.com/phraseapp-for-developers/phraseapp-client/phraseapp-in-your-terminal). The **phrase gem** is deprecated and will be discontinued at the end of 2015.\n\n## Installation\n\nInstall the gem:\n\n    gem install phraseapp-ruby\n\nor add it to your Gemfile when using bundler:\n\n    gem 'phraseapp-ruby'\n\nand install it via\n\n    bundle install\n\n## Usage\n\nFor usage examples please refer to our [Wiki](https://github.com/phrase/phraseapp-ruby/wiki/Usage-Example) for this. Here is a basic setup with an [Access Token](https://app.phrase.com/settings/oauth_access_tokens) that you can find in your Phrase user profile for Authentication.\n\n```ruby\n# Require the gem\nrequire 'phraseapp-ruby'\n\n# Setup Authentication Credentials and Client\ncredentials = PhraseApp::Auth::Credentials.new(token: \"YOUR_ACCESS_TOKEN\")\nclient = PhraseApp::Client.new(credentials)\n\n# List projects page 1 and list 10 projects per_page\nrsp, err = client.projects_list(1, 10)\nputs rsp\n\n# Create a new key\nparams = PhraseApp::RequestParams::TranslationKeyParams.new(name: \"foo\")\nrsp, err = client.key_create('YOUR_PROJECT_ID', params)\nputs rsp\n```\n\nThere are also other ways of authentication, which are described in our [API v2 Documentation](https://developers.phrase.com/api/)\n\n## Documentation\n\nFor a full list of available client actions, see the [phraseapp-ruby Documentation](http://www.rubydoc.info/gems/phraseapp-ruby/PhraseApp/Client)\n\nThe actions are generated automatically from our API specification, so once you get the hang of the Ruby specific naming, you should be able to infer names of actions and endpoints through our [API v2 Documentation](https://developers.phrase.com/api/)\n\n## OpenSSL\n\nPlease note that OpenSSL may cause issues, especially on MacOS X. The following error patterns might be seen:\n\n* `certificate verification failed`: On MacOS X this might be caused by [rvm](http://rvm.io) binary releases trying to fiddle with root certificates. Using `rvm install ruby-2.2.3 --disable-binary` fixes the issue. If you already had installed the rvm binaries it might be necessary to reinstall openssl and removing artifacts (like `/etc/openssl` and `/usr/local/etc/openssl`).\n* `handshake failure`: This is most probably related to an outdated version of OpenSSL that tries to initiate a connection using SSLv2/v3 which is not supported by our servers. Updating OpenSSL to version 1.0.2d or later should be sufficient.\n\n## Tests\n\nTo run the test first install the dependencies\n\n    $ bundle install\n\nand run the tests by\n\n    $ rake test\n\n\n## Contributing\n\nThis library is auto-generated from templates that run against a API specification file. Therefore we can not accept any pull requests in this repository. Please use the [GitHub Issue Tracker](https://github.com/phrase/phraseapp-ruby/issues) to report bugs.\n\n\n## Further reading\n\n* [phraseapp-ruby documentation](http://www.rubydoc.info/gems/phraseapp-ruby)\n* [Phrase](https://phrase.com)\n* [Phrase API documentation](https://developers.phrase.com/api/)\n\n\n## Get help / support\n\nPlease contact [support@phrase.com](mailto:support@phrase.com?subject=[GitHub]%20phraseapp-ruby) and we can take more direct action toward finding a solution.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphrase%2Fphraseapp-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphrase%2Fphraseapp-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphrase%2Fphraseapp-ruby/lists"}