crowdin-api 0.0.11 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 711091f239baf6c07fd3546143e48c42c1721c91
+  data.tar.gz: 101c3ad68a30ad38f1d7c12b40493b2458539de5
+SHA512:
+  metadata.gz: 09053e23e21053d98d9a2d338fee3a0b8926e6c94b1fad3836671390247b6e146f1ced6ac4b8d55ff8295c2fbeca38ed3189781286f1ac727f96447698f2f7ea
+  data.tar.gz: 1ac06ab9ffd89a038343391fa494790b6a1286c17b4188c124e4a2aeda507300c910a03ce62180f4b4187dff59217a9981c4e49bb6e32e7b068bedc3ab8c80a4

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in crowdin-api.gemspec
+# gem 'rest-client', :git => 'git://github.com/rest-client/rest-client.git'
 gem 'rest-client'

data/README.md

@@ -4,6 +4,8 @@ The Crowdin Ruby Client is used to interact with the Crowdin API from Ruby.
 
 For more about the Crowdin API see <http://crowdin.net/page/api>.
 
+> **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
 
 Add this line to your application's Gemfile:
@@ -30,7 +32,7 @@ Start by creating a connection to Crowdin with your credentials:
 require 'crowdin-api'
 require 'logger'
 
-crowdin = Crowdin::API.new(:api_key => API_KEY, :project_id => PROJECT_ID, :account_key => ACCOUNT_KEY)
+crowdin = Crowdin::API.new(api_key: API_KEY, project_id: PROJECT_ID, account_key: ACCOUNT_KEY)
 crowdin.log = Logger.new $stderr
 ```
 
@@ -38,6 +40,8 @@ Now you can make requests to the api.
 
 ### Add File
 
+Add new file to Crowdin project.
+
 Documentation:  <http://crowdin.net/page/api/add-file>.
 
 First parameter is array of files that should be added to Crowdin project.
@@ -58,6 +62,8 @@ crowdin.add_file(
 
 ### Update File
 
+Upload fresh version of your localization file.
+
 Documentation <http://crowdin.net/page/api/update-file>
 
 First parameter is array of files that should be updated in Crowdin project.
@@ -78,14 +84,38 @@ crowdin.update_file(
 
 ### Delete File
 
+Remove file from Crowdin project.
+
 Documentation <http://crowdin.net/page/api/delete-file>
 
 ```ruby
 crowdin.delete_file('strings.xml')
 ```
 
+### Create Directory
+
+Create a new directory in Crowdin project.
+
+Documentation: <http://crowdin.net/page/api/add-directory>
+
+```ruby
+crowdin.add_directory('dirname')
+```
+
+### Delete Directory
+
+Remove directory with nested files from Crowdin project.
+
+Documentation: <http://crowdin.net/page/api/delete-directory>
+
+```ruby
+crowdin.delete_directory('dirname')
+```
+
 ### Upload Translations
 
+Upload translations made in a third party software or previously made translations.
+
 Documentation: <http://crowdin.net/page/api/upload-translation>
 
 First parameter is array of translated files that should be added to Crowdin project.
@@ -113,28 +143,48 @@ crowdin.upload_translation(
 )
 ```
 
+### Download Translations
+
+Download last exported translation package (one target language or all languages as one zip file).
+
+Documentation: <http://crowdin.net/page/api/download>
+
+First parameter is the language of translation you need or download `all` of them at once.
+
+```ruby
+crowdin.download_translation('ru', :output => '/path/to/download/ru_RU.zip')
+```
+
 ### Translation Status
 
-Documentation: <http://crowdin.net/page/api/status>
+Track overall translation and proofreading progress of each target language.
 
-### Project Info
+Documentation: <http://crowdin.net/page/api/status>
 
-Documentation: <http://crowdin.net/page/api/info>
+```ruby
+crowdin.translations_status
+```
 
-### Download Translations
+### Project Info
 
-Documentation: <http://crowdin.net/page/api/download>
+Shows project details and meta information (last translations date, currently uploaded files, target languages etc..).
 
-First parameter is the language of translation you need or download `all` of them at once.
+Documentation: <http://crowdin.net/page/api/info>
 
 ```ruby
-crowdin.download_translation('ru', :output => '/path/to/download/ru_RU.zip')
+crowdin.project_info
 ```
 
 ### Export Translations
 
+Build ZIP archive with the latest translations.
+
 Documentation: <http://crowdin.net/page/api/export>
 
+```ruby
+crowdin.export_translations
+```
+
 ### Account Projects
 
 Documentation: <http://crowdin.net/page/api/get-projects>
@@ -151,14 +201,6 @@ Documentation: <http://crowdin.net/page/api/edit-project>
 
 Documentation: <http://crowdin.net/page/api/delete-project>
 
-### Create Directory
-
-Documentation: <http://crowdin.net/page/api/add-directory>
-
-### Delete Directory
-
-Documentation: <http://crowdin.net/page/api/delete-directory>
-
 ### Download Glossary
 
 Documentation: <http://crowdin.net/page/api/download-glossary>
@@ -179,7 +221,6 @@ Documentation: <http://crowdin.net/page/api/upload-tm>
 
 Documentation: <http://crowdin.net/page/api/supported-languages>
 
-
 ## Supported Rubies
 
 Tested with the following Ruby versions:
@@ -201,4 +242,4 @@ Author: Anton Maminov (anton.maminov@gmail.com)
 
 Copyright: 2012-2013 [Crowdin.net](http://crowdin.net/)
 
-This library is distributed under the MIT license.  Please see the LICENSE file.
+This library is distributed under the MIT license. Please see the LICENSE file.

data/crowdin-api.gemspec

@@ -1,19 +1,22 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
+
 require File.expand_path('../lib/crowdin-api/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Crowdin"]
-  gem.email         = ["support@crowdin.net"]
-  gem.description   = %q{The Crowdin Ruby Client is used to interact with the Crowdin API from Ruby}
-  gem.summary       = %q{The Crowdin Ruby Client is used to interact with the Crowdin API from Ruby}
-  gem.homepage      = "https://github.com/crowdin/crowdin-cli"
+  gem.name          = 'crowdin-api'
+  gem.version       = Crowdin::API::VERSION
+
+  gem.authors       = ['Crowdin']
+  gem.email         = ['support@crowdin.net']
+  gem.homepage      = 'https://github.com/crowdin/crowdin-api/'
+  gem.description   = 'Ruby Client for the Crowdin API'
+  gem.summary       = 'Client library to manage translations on Crowdin'
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "crowdin-api"
-  gem.require_paths = ["lib"]
-  gem.version       = Crowdin::API::VERSION
+  gem.require_paths = ['lib']
 
-  gem.add_dependency('rest-client')
+  gem.add_dependency 'rest-client', '>= 1.6.7'
 end

data/examples/Gemfile

@@ -1,3 +1,5 @@
-source :rubygems
+source 'https://rubygems.org'
 
+#gem 'rest-client', :git => 'git://github.com/rest-client/rest-client.git'
+gem 'rest-client'
 gem 'crowdin-api', :path => '../'

data/lib/crowdin-api.rb

@@ -6,7 +6,6 @@ require "crowdin-api/errors"
 require "crowdin-api/methods"
 require "crowdin-api/version"
 
-
 # The Crowdin::API library is used for interactions with a crowdin.net website.
 #
 # == Example
@@ -46,6 +45,7 @@ module Crowdin
       options = {
         :headers                => {},
         :params                 => {},
+        :timeout                => -1,
         :key                    => @api_key,
         :'account-key'          => @account_key,
         :json                   => true

data/lib/crowdin-api/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   class API
-    VERSION = "0.0.11"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,34 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 0.0.11
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
-description: The Crowdin Ruby Client is used to interact with the Crowdin API from
-  Ruby
+        version: 1.6.7
+description: Ruby Client for the Crowdin API
 email:
 - support@crowdin.net
 executables: []
@@ -41,34 +37,33 @@ files:
 - Rakefile
 - crowdin-api.gemspec
 - examples/Gemfile
-- examples/Gemfile.lock
 - examples/project_info.rb
 - lib/crowdin-api.rb
 - lib/crowdin-api/errors.rb
 - lib/crowdin-api/methods.rb
 - lib/crowdin-api/version.rb
-homepage: https://github.com/crowdin/crowdin-cli
-licenses: []
+homepage: https://github.com/crowdin/crowdin-api/
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: The Crowdin Ruby Client is used to interact with the Crowdin API from Ruby
+specification_version: 4
+summary: Client library to manage translations on Crowdin
 test_files: []

data/examples/Gemfile.lock

@@ -1,19 +0,0 @@
-PATH
-  remote: ../
-  specs:
-    crowdin-api (0.0.9)
-      rest-client
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    mime-types (1.19)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-
-PLATFORMS
-  java
-  ruby
-
-DEPENDENCIES
-  crowdin-api!