crowdin-api 0.3.0 → 0.4.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72070c7f8a25a54dbce0ed12d8c2788428fe0747
-  data.tar.gz: 97ea30a8860ca975dedef7a55cd71abbb34965da
+  metadata.gz: 21b2c419fc865199393792868efd92917fe9350b
+  data.tar.gz: 2bbb0c118a6480be3ca45000682e7d3482597e45
 SHA512:
-  metadata.gz: 005b02706cda35ba8de5fc38ac0efba1b48e37a3cdf70209e4756ead6b88391e072e23a49f8311c842207add560fb853f6b94310ab923b1c0888b755819dd73d
-  data.tar.gz: 469129180e883c4665487cbe5abcecabaf0a743bd928f2834451b439c2d67e23cdc18677297b6a42848db120c139e933b684a22dbecb9de6f8c23906b4513df4
+  metadata.gz: aba7345cf676b48cf41475198e9a0212e3ce46396bb554e31154d634f7258878de24cb292565edc6effbcc48097d962288e4e9a34aeece9b340206bc8bf3bc41
+  data.tar.gz: 3d58d2f449e22e30d098dafe4853a5d1e213215406fd58e6084eef6abff26b50d304a6c065e9eebaec77716d429d1c4c53476f7d0f6d08c55830e8b73a40ce73

data/README.md

@@ -4,6 +4,8 @@ A Ruby interface to the Crowdin API.
 
 For more about the Crowdin API see <https://crowdin.com/page/api>.
 
+To experiment with that code, run `bin/console` for an interactive prompt.
+
 > **WARNING**: This is a development version: It contains the latest changes, but may also have severe known issues, including crashes and data loss situations. In fact, it may not work at all.
 
 ## Installation
@@ -59,6 +61,9 @@ Every file is hash:
 * `: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.
 
 ```ruby
@@ -82,6 +87,9 @@ Every file is hash:
 * `: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.
 
 ```ruby
@@ -107,16 +115,31 @@ crowdin.delete_file('strings.xml')
 
 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>
 
 ```ruby
 crowdin.add_directory('dirname')
 ```
 
+Create a new branch:
+
+```ruby
+crowdin.add_directory('master', is_branch: '1')
+```
+
 ### Delete Directory
 
 Remove directory with nested files from Crowdin project.
 
+Optional params:
+* `:branch` - a branch name (optional)
+
 Documentation: <https://crowdin.com/page/api/delete-directory>
 
 ```ruby
@@ -135,6 +158,8 @@ 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.
+* `:branch` - a branch name.
+
 
 When renaming directory the path can not be changed (it means `new_name` parameter can not contain path, name only).
 
@@ -161,6 +186,7 @@ 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)
+* `:branch` - a branch name (default: nil)
 
 **NOTE!** 20 files max are allowed to upload per one time file transfer.
 
@@ -183,6 +209,11 @@ Documentation: <https://crowdin.com/page/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')
 ```
@@ -216,6 +247,9 @@ Build ZIP archive with the latest translations.
 Also API call will be ignored if there were no changes in the project since previous export.
 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>
 
 ```ruby
@@ -276,7 +310,7 @@ Documentation: <https://crowdin.com/page/api/supported-languages>
 Tested with the following Ruby versions:
 
 - MRI 2.2.1
-- JRuby 9.0.0.0.pre2
+- JRuby 9.0.0.0
 
 ## Contributing
 

data/lib/crowdin-api.rb

@@ -1,4 +1,3 @@
-require 'pp'
 require 'json'
 require 'rest-client'
 
@@ -70,6 +69,9 @@ module Crowdin
     end
 
     def request(params, &block)
+      # Returns a query hash with non nil values.
+      params[:query].reject! { |_, value| value.nil? } if params[:query]
+
       case params[:method]
       when :post
         query = @connection.options.merge(params[:query] || {})
@@ -84,7 +86,6 @@ module Crowdin
       end
 
       log.debug("args: #{@response.args}") if log
-      log.debug("body: #{@response.body}") if log
 
       if @response.headers[:content_disposition]
         filename = params[:output] || @response.headers[:content_disposition][/attachment; filename="(.+?)"/, 1]
@@ -95,6 +96,8 @@ module Crowdin
         return true
       else
         doc = JSON.load(@response.body)
+        log.debug("body: #{doc}") if log
+
         if doc.kind_of?(Hash) && doc['success'] == false
           code    = doc['error']['code']
           message = doc['error']['message']

data/lib/crowdin-api/methods.rb

@@ -18,6 +18,14 @@ module Crowdin
     # * :title - title in Crowdin UI (optional)
     # * :export_pattern - Resulted file name (optional)
     #
+    # Optional:
+    # * :branch - a branch name.
+    #   If the branch is not exists Crowdin will be return an error:
+    #     "error":{
+    #       "code":8,
+    #       "message":"File was not found"
+    #   }
+    #
     # == Request
     #
     # POST https://api.crowdin.com/api/project/{project-identifier}/add-file?key={project-key}
@@ -54,6 +62,9 @@ module Crowdin
     # * :title - title in Crowdin UI (optional)
     # * :export_pattern - Resulted file name (optional)
     #
+    # Optional:
+    # * :branch - a branch name
+    #
     # == Request
     #
     # POST https://api.crowdin.com/api/project/{project-identifier}/update-file?key={project-key}
@@ -89,13 +100,16 @@ module Crowdin
     #
     # files - Array of files that should be added to Crowdin project.
     # file is a Hash { :dest, :source }
-    # * :dest - file name with path in Crowdin project (required)
-    # * :source - path for uploaded file (required)
+    #   * :dest - file name with path in Crowdin project (required)
+    #   * :source - path for uploaded file (required)
+    # language - Target language. With a single call it's possible to upload translations for several
+    #   files but only into one of the languages. (required)
     #
     # Optional:
     # * :import_duplicates (default: false)
     # * :import_eq_suggestions (default: false)
     # * :auto_approve_imported (default: false)
+    # * :branch - a branch name
     #
     # == Request
     #
@@ -120,6 +134,10 @@ module Crowdin
     #
     # Note: If you would like to download the most recent translations you may want to use export API method before downloading.
     #
+    # Optional:
+    # * :output - a name of ZIP file with translations
+    # * :branch - a branch name
+    #
     # == Request
     #
     # GET https://api.crowdin.com/api/project/{project-identifier}/download/{package}.zip?key={project-key}
@@ -128,7 +146,8 @@ module Crowdin
       request(
         :method  => :get,
         :path    => "/api/project/#{@project_id}/download/#{language}.zip",
-        :output  => params[:output],
+        :output  => params.delete(:output),
+        :query   => params,
       )
     end
 
@@ -167,29 +186,53 @@ module Crowdin
 
     # Add directory to Crowdin project.
     #
+    # == Parameters
+    #
+    # name - directory name (with path if nested directory should be created). (required)
+    #
+    # Optional:
+    # * :is_branch - create new branch. Valid values - 0, 1. Only when create root directory.
+    # * :branch - a branch name.
+    #
     # == Request
     #
     # POST https://api.crowdin.com/api/project/{project-identifier}/add-directory?key={project-key}
     #
-    def add_directory(name)
+    def add_directory(name, params = {})
+      params[:name] = name
+
       request(
         :method => :post,
         :path   => "/api/project/#{@project_id}/add-directory",
-        :query  => { :name => name },
+        :query  => params,
       )
     end
 
     # Delete Crowdin project directory. All nested files and directories will be deleted too.
     #
+    # == Parameters
+    #
+    # name - Directory path (or just name if the directory is in root) (required)
+    # :branch - a branch name (optional)
+    #
+    # FIXME
+    # When you try to remove the branch directory Crowdin will be return an error:
+    #   "error":{
+    #     "code":17,
+    #     "message":"Specified directory was not found"
+    #   }
+    #
     # == Request
     #
     # POST https://api.crowdin.com/api/project/{project-identifier}/delete-directory?key={project-key}
     #
-    def delete_directory(name)
+    def delete_directory(name, params = {})
+      params[:name] = name
+
       request(
         :method => :post,
         :path   => "/api/project/#{@project_id}/delete-directory",
-        :query  => { :name => name },
+        :query  => params,
       )
     end
 
@@ -204,6 +247,7 @@ module Crowdin
     # * :new_name - new directory name (not contain path, name only)
     # * :title - new directory title to be displayed in Crowdin UI
     # * :export_pattern - new directory export pattern
+    # * :branch - a branch name
     #
     # == Request
     #
@@ -267,14 +311,18 @@ module Crowdin
     # Please note that this method can be invoked only every 30 minutes.
     # Also API call will be ignored if there were no any changes in project since last export.
     #
+    # Optional:
+    # * :branch - a branch name
+    #
     # == Request
     #
-    # POST https://api.crowdin.com/api/project/{project-identifier}/export?key={project-key}
+    # GET https://api.crowdin.com/api/project/{project-identifier}/export?key={project-key}
     #
-    def export_translations
+    def export_translations(params = {})
       request(
-        :method => :post,
+        :method => :get,
         :path   => "/api/project/#{@project_id}/export",
+        :query  => params,
       )
     end
 

data/lib/crowdin-api/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   class API
-    VERSION = "0.3.0"
+    VERSION = "0.4.0.pre"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0.pre
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: Ruby Client for the Crowdin API
 email:
 - support@crowdin.net
@@ -68,12 +96,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Client library to manage translations on Crowdin