crowdin-api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d8029f63eaa8d5f48f6c6e8d9c42df69c04300db
-  data.tar.gz: a54c19e8ae9e6547b3e924c7caa5d4cf68e57d89
+SHA256:
+  metadata.gz: b76f37189de2a8cde395736ad317b4e8ef2bc269667991472947e77afc513f79
+  data.tar.gz: 610af0f467d9872503d84b55444797549d9d1f7989c918d49ba489b4b1832d6e
 SHA512:
-  metadata.gz: a48309684f64281309cf81e639353a6139ce8e61c2e7ed2a9cb51979dd337b5de35461d7d86a88e68c361057e27e12ef138748a85cab33e3997adc4ea30d5d47
-  data.tar.gz: cd1aa0400e8e0763f78d2bf52ea03c89a4e7a51cea239b648cd33cae7f77d6c962c0ce9b5fbfbdf9a9bbba8c247b33555488e01343452d9f7f3c0617d014ca92
+  metadata.gz: 6eacd28cfff8970ae14ac0658cc1605b9939684b5b52eec0b6eb3c064f198fe932ed61e45818c3e8b64ae1f88610893cdff621523ed6059e2b3da75c48cea038
+  data.tar.gz: be4342ea720e23228001533357011923b46326ddf6e85e12cfe7777e62ea7433cc7b86164163f46d31eb798481661ca8ece3c4418702f8b40c670963602da722

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2012-2014 Anton Maminov
+Copyright (c) 2012-2019 Anton Maminov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,7 +2,7 @@
 
 A Ruby interface to the Crowdin API.
 
-For more about the Crowdin API see <https://crowdin.com/page/api>.
+For more about the Crowdin API see <https://support.crowdin.com/api/api-integration-setup/>.
 
 To experiment with that code, run `bin/console` for an interactive prompt.
 
@@ -12,18 +12,20 @@ To experiment with that code, run `bin/console` for an interactive prompt.
 
 Add this line to your application's Gemfile:
 
-```
+```gemfile
 gem 'crowdin-api'
 ```
 
 And then execute:
-```
-$ bundle
+
+```console
+bundle
 ```
 
 Or install it yourself as:
-```
-$ gem install crowdin-api
+
+```console
+gem install crowdin-api
 ```
 
 ## Usage
@@ -52,16 +54,18 @@ Now you can make requests to the api.
 
 Add new file to Crowdin project.
 
-Documentation:  <https://crowdin.com/page/api/add-file>.
+Documentation:  <https://support.crowdin.com/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` - file that should be added (required)
 * `:title` - string that defines title for uploaded file (optional)
 * `:export_pattern` - string that defines name of resulted file (optional)
 
 Optional params:
+
 * `:branch` - a branch name (optional)
 
 **NOTE!** 20 files max are allowed to upload per one time file transfer.
@@ -78,16 +82,18 @@ crowdin.add_file(
 
 Upload fresh version of your localization file.
 
-Documentation <https://crowdin.com/page/api/update-file>
+Documentation <https://support.crowdin.com/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)
 
 Optional params:
+
 * `:branch` - a branch name (optional)
 
 **NOTE!** 20 files max are allowed to upload per one time file transfer.
@@ -105,7 +111,7 @@ crowdin.update_file(
 
 Remove file from Crowdin project.
 
-Documentation <https://crowdin.com/page/api/delete-file>
+Documentation <https://support.crowdin.com/api/delete-file/>
 
 ```ruby
 crowdin.delete_file('strings.xml')
@@ -118,10 +124,11 @@ Create a new directory in Crowdin project.
 First parameter `name` - full directory path that should be created (e.g. /MainPage/AboutUs) (required)
 
 Optional params:
+
 * `:is_branch` - create new branch. Valid values - `'0'`, `'1'`. Only when create root directory.
 * `:branch` - a branch name.
 
-Documentation: <https://crowdin.com/page/api/add-directory>
+Documentation: <https://support.crowdin.com/api/add-directory/>
 
 ```ruby
 crowdin.add_directory('dirname')
@@ -138,9 +145,10 @@ crowdin.add_directory('master', is_branch: '1')
 Remove directory with nested files from Crowdin project.
 
 Optional params:
+
 * `:branch` - a branch name (optional)
 
-Documentation: <https://crowdin.com/page/api/delete-directory>
+Documentation: <https://support.crowdin.com/api/delete-directory/>
 
 ```ruby
 crowdin.delete_directory('dirname')
@@ -150,11 +158,12 @@ crowdin.delete_directory('dirname')
 
 Rename or change directory attributes.
 
-Documentation: <https://crowdin.com/page/api/change-directory>
+Documentation: <https://support.crowdin.com/api/change-directory/>
 
 First parameter `name` - full directory path that should be modified (e.g. /MainPage/AboutUs) (required)
 
 Optional params:
+
 * `:new_name` - new directory name
 * `:title` - new directory title to be displayed in Crowdin UI
 * `:export_pattern` - new direcrory export pattern. Is used to create directory name and path in resulted translations bundle.
@@ -171,18 +180,20 @@ crowdin.change_directory('/MainPage/AboutUs', new_name: 'AboutCompany')
 
 Upload existing translations to your Crowdin project.
 
-Documentation: <https://crowdin.com/page/api/upload-translation>
+Documentation: <https://support.crowdin.com/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](https://crowdin.com/page/api/language-codes) that can be used.
+Check [complete list of Crowdin language codes](https://support.crowdin.com/api/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)
@@ -205,15 +216,15 @@ crowdin.upload_translation(
 
 Download last exported translation package (one target language or all languages as one zip file).
 
-Documentation: <https://crowdin.com/page/api/download>
+Documentation: <https://support.crowdin.com/api/download/>
 
 First parameter is the language of translation you need or download `all` of them at once.
 
 Optional params:
+
 * `:output` - a name of ZIP file with translations
 * `:branch` - a branch name (default: nil)
 
-
 ```ruby
 crowdin.download_translation('ru', :output => '/path/to/download/ru_RU.zip')
 ```
@@ -222,7 +233,7 @@ crowdin.download_translation('ru', :output => '/path/to/download/ru_RU.zip')
 
 Track overall translation and proofreading progress of each target language.
 
-Documentation: <https://crowdin.com/page/api/status>
+Documentation: <https://support.crowdin.com/api/status/>
 
 ```ruby
 crowdin.translations_status
@@ -232,12 +243,18 @@ crowdin.translations_status
 
 Shows project details and meta information (last translations date, currently uploaded files, target languages etc..).
 
-Documentation: <https://crowdin.com/page/api/info>
+Documentation: <https://support.crowdin.com/api/info/>
 
 ```ruby
 crowdin.project_info
 ```
 
+### Export File
+
+Export a single translated file from Crowdin.
+
+Documentation: <https://support.crowdin.com/api/export-file/>
+
 ### Export Translations
 
 Build ZIP archive with the latest translations.
@@ -248,9 +265,10 @@ Also API call will be ignored if there were no changes in the project since prev
 You can see whether ZIP archive with latest translations was actually build by status attribute (`built` or `skipped`) returned in response.
 
 Optional params:
+
 * `:branch` - a branch name (default: nil)
 
-Documentation: <https://crowdin.com/page/api/export>
+Documentation: <https://support.crowdin.com/api/export/>
 
 ```ruby
 crowdin.export_translations
@@ -262,7 +280,7 @@ Get Crowdin Project details.
 
 **Important:** This API method requires `Account API Key`. This key can not be found on your profile pages.
 
-Documentation: <https://crowdin.com/page/api/get-projects>
+Documentation: <https://support.crowdin.com/api/get-projects/>
 
 ```ruby
 crowdin = Crowdin::API.new(account_key: ACCOUNT_KEY)
@@ -275,42 +293,42 @@ Create Crowdin project.
 
 **Important:** This API method requires `Account API Key`. This key can not be found on your profile pages.
 
-Documentation: <https://crowdin.com/page/api/create-project>
+Documentation: <https://support.crowdin.com/api/create-project/>
 
 ### Edit Project
 
-Documentation: <https://crowdin.com/page/api/edit-project>
+Documentation: <https://support.crowdin.com/api/edit-project/>
 
 ### Delete Project
 
-Documentation: <https://crowdin.com/page/api/delete-project>
+Documentation: <https://support.crowdin.com/api/delete-project/>
 
 ### Download Glossary
 
-Documentation: <https://crowdin.com/page/api/download-glossary>
+Documentation: <https://support.crowdin.com/api/download-glossary/>
 
 ### Upload Glossary
 
-Documentation: <https://crowdin.com/page/api/upload-glossary>
+Documentation: <https://support.crowdin.com/api/upload-glossary/>
 
 ### Download TM
 
-Documentation: <https://crowdin.com/page/api/download-tm>
+Documentation: <https://support.crowdin.com/api/download-tm/>
 
 ### Upload TM
 
-Documentation: <https://crowdin.com/page/api/upload-tm>
+Documentation: <https://support.crowdin.com/api/upload-tm/>
 
 ### Supported Languages
 
-Documentation: <https://crowdin.com/page/api/supported-languages>
+Documentation: <https://support.crowdin.com/api/supported-languages/>
 
 ## Supported Rubies
 
 Tested with the following Ruby versions:
 
-- MRI 2.2.1
-- JRuby 9.0.0.0
+* MRI 2.2.1
+* JRuby 9.0.0.0
 
 ## Contributing
 
@@ -324,6 +342,6 @@ Tested with the following Ruby versions:
 
 Author: Anton Maminov (anton.maminov@gmail.com)
 
-Copyright: 2012-2015 [crowdin.com](https://crowdin.com/)
+Copyright: 2012-2019 [crowdin.com](https://crowdin.com/)
 
 This library is distributed under the MIT license. Please see the LICENSE file.

data/lib/crowdin-api/methods.rb

@@ -306,6 +306,31 @@ module Crowdin
       )
     end
 
+    # Export a single translated file from Crowdin.
+    #
+    # == Parameters
+    #
+    # file - File name with path in Crowdin project. (required)
+    # language - Target language. (required)
+    #
+    # Optional:
+    # * :branch - a branch name
+    #
+    # == Request
+    #
+    # GET https://api.crowdin.com/api/project/{project-identifier}/export-file?key={project-key}
+    #
+    def export_file(file, language, params = {})
+      params[:file] = file
+      params[:language] = language
+      request(
+        :method => :get,
+        :path   => "/api/project/#{@project_id}/export-file",
+        :output => params.delete(:output),
+        :query  => params,
+      )
+    end
+
     # Build ZIP archive with the latest translations.
     #
     # Please note that this method can be invoked only every 30 minutes.

data/lib/crowdin-api/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   class API
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2019-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,95 +25,101 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.3
+        version: 0.12.2
 description: Ruby Client for the Crowdin API
 email:
 - support@crowdin.net
@@ -148,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Client library to manage translations on Crowdin