crowdin-api 0.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crowdin-api.gemspec
+gem 'rest-client'

data/Gemfile.lock

@@ -0,0 +1,12 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mime-types (1.19)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rest-client

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Anton Maminov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# Crowdin::API
+
+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>.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'crowdin-api'
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```
+$ gem install crowdin-api
+```
+
+## Usage
+
+Start by creating a connection to Crowdin with your credentials:
+
+```ruby
+require 'crowdin-api'
+
+crowdin = Crowdin::API.new(:api_key => API_KEY, :project_id => PROJECT_ID, :account_key => ACCOUNT_KEY)
+```
+
+Now you can make requests to the api.
+
+### Add File
+
+Documentation:  <http://crowdin.net/page/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` - uploaded file (_required_)
+* `:title` - title for uploaded file (_optional_)
+* `:export_pattern` - string that defines name of resulted file (_optional_)
+
+
+```ruby
+crowdin.add_file(
+  files = [
+    { :dest => '/directory/array.xml', :source => 'array.xml', :export_pattern => '/values-%two_letter_code%/%original_file_name%' },
+    { :dest => 'strings.xml', :source => 'strings.xml', :title => 'Texts in Application' }
+], :type => 'android')
+```
+
+### Update File
+
+Documentation <http://crowdin.net/page/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_)
+
+```ruby
+crowdin.update_file(
+  files = [
+    { :dest => '/directory/array.xml', :source => 'array.xml' },
+    { :dest => 'strings.xml', :source => 'strings.xml' }
+])
+
+```
+
+### Delete File
+
+Documentation <http://crowdin.net/page/api/delete-file>
+
+```ruby
+crowdin.delete_file('strings.xml')
+```
+
+### Upload Translations
+
+### Translation Status
+
+### Project Info
+
+### Download Translations
+
+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')
+```
+
+### Export Translations
+
+### Account Projects
+
+### Create Project
+
+### Edit Project
+
+### Delete Project
+
+### Create Directory
+
+### Delete Directory
+
+### Download Glossary
+
+### Upload Glossary
+
+### Download TM
+
+### Upload TM
+
+###Supported Languages
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+This library is distributed under the MIT license.  Please see the LICENSE file.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/crowdin-api.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/crowdin-api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Anton Maminov"]
+  gem.email         = ["anton.linux@gmail.com"]
+  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/mamantoha/crowdin-api"
+
+  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.add_dependency('rest-client')
+end

data/lib/crowdin-api.rb

@@ -0,0 +1,83 @@
+require 'logger'
+require 'rexml/document'
+require 'rest-client'
+
+require "crowdin-api/errors"
+require "crowdin-api/methods"
+require "crowdin-api/version"
+
+#log = Logger.new(STDOUT)
+#RestClient.log = log
+#log.level = Logger::DEBUG
+
+module Crowdin
+  class API
+
+    def initialize(options = {})
+      @api_key     = options.delete(:api_key)
+      @project_id  = options.delete(:project_id)
+      @account_key = options.delete(:account_key)
+      @base_url    = options.delete(:base_url) || 'http://api.crowdin.net'
+
+      options = {
+        :headers                => {},
+        :params                 => {},
+        :key                    => @api_key,
+        :'account-key'          => @account_key,
+      }.merge(options)
+
+      options[:headers] = {
+        'Accept'                => 'application/xml',
+        'User-Agent'            => "crowdin-rb/#{Crowdin::API::VERSION}",
+        'X-Ruby-Version'        => RUBY_VERSION,
+        'X-Ruby-Platform'       => RUBY_PLATFORM
+      }.merge(options[:headers])
+
+      options[:params] = {
+        :key                    => @api_key,
+        :'account-key'          => @account_key,
+      }.merge(options[:params])
+
+      @connection = RestClient::Resource.new(@base_url, options)
+    end
+
+    def request(params, &block)
+      case params[:method]
+      when :post
+        query = @connection.options.merge(params[:query] || {})
+        @connection[params[:path]].post(query) { |response, _, _|
+          @response = response
+        }
+      when :get
+        query = @connection.options[:params].merge(params[:query] || {})
+        @connection[params[:path]].get(:params => query) { |response, _, _|
+          @response = response
+        }
+      end
+
+      if @response.headers[:content_disposition]
+        filename = params[:output] || @response.headers[:content_disposition][/attachment; filename="(.+?)"/, 1]
+        body = @response.body
+        file = open(filename, 'wb')
+        file.write(body)
+        file.close
+        return true
+      else
+        doc = REXML::Document.new @response.body
+        if doc.elements['error']
+          code    = doc.elements['error'].elements['code'].text
+          message = doc.elements['error'].elements['message'].text
+          error   = Crowdin::API::Errors::Error.new(code, message)
+          raise(error)
+        else
+          # leave body as is
+          return @response
+        end
+      end
+
+    end
+
+    private
+
+  end
+end

data/lib/crowdin-api/errors.rb

@@ -0,0 +1,23 @@
+module Crowdin
+  class API
+
+    module Errors
+      class Error < StandardError
+        attr_reader :error_code
+        attr_reader :error_message
+        attr_reader :message
+
+        def initialize(error_code, error_message)
+          @error_code    = error_code.to_i
+          @error_message = error_message
+          @message = "#{error_code}: #{error_message}"
+        end
+
+        def to_s
+          @message
+        end
+      end
+    end
+
+  end
+end

data/lib/crowdin-api/methods.rb

@@ -0,0 +1,332 @@
+module Crowdin
+
+  class API
+
+    # Add new file to Crowdin project.
+    #
+    # == Parameters
+    #
+    # files - Array of files that should be added to Crowdin project.
+    # file is a Hash {:dest, :source, :title, :export_pattern}
+    # * :dest - file name with path in Crowdin project (required)
+    # * :source - path for uploaded file (required)
+    # * :title - title in Crowdin UI (optional)
+    # * :export_pattern - Resulted file name (optional)
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/add-file?key={project-key}
+    #
+    def add_file(files, params = {})
+      params[:files] = Hash[files.map{ |f| [
+        f[:dest]               || raise(ArgumentError, "'`:dest`' is required"),
+        ::File.open(f[:source] || raise(ArgumentError, "'`:source` is required'"))
+      ] }]
+
+      params[:titles] = Hash[files.map{ |f| [f[:dest], f[:title]] }]
+      params[:titles].delete_if{ |k, v| v.nil? }
+
+      params[:export_patterns] = Hash[files.map{ |f| [f[:dest], f[:export_pattern]] }]
+      params[:export_patterns].delete_if{ |k, v| v.nil? }
+
+      params.delete_if{ |k, v| v.empty? }
+
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/add-file",
+        :query  => params,
+      )
+    end
+
+    # Upload fresh version of your localization file to Crowdin.
+    #
+    # == Parameters
+    #
+    # 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)
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/update-file?key={project-key}
+    #
+    def update_file(files)
+      files = Hash[files.map{ |f| [
+        f[:dest]               || raise(ArgumentError, "'`:dest` is required'"),
+        ::File.open(f[:source] || raise(ArgumentError, "'`:source` is required'") )
+      ] }]
+
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/update-file",
+        :query  => { :files => files }
+      )
+    end
+
+    # Upload existing translations to your Crowdin project.
+    #
+    # == Parameters
+    #
+    # 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)
+    #
+    # Optional:
+    # * :import_duplicates (default: false)
+    # * :import_eq_suggestions (default: false)
+    # * :auto_approve_imported (default: false)
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/upload-translation?key={project-key}
+    #
+    def upload_translation(files, language, params = {})
+      params[:files] = Hash[files.map{ |f| [
+        f[:dest]               || raise(ArgumentError, "`:dest` is required"),
+        ::File.open(f[:source] || raise(ArgumentError, "`:source` is required"))
+      ] }]
+
+      params[:language] = language
+
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/upload-translation",
+        :query  => params,
+      )
+    end
+
+    # Download ZIP file with translations. You can choose the language of translation you need or download all of them at once.
+    # Note: If you would like to download the most recent translations you may want to use export API method before downloading.
+    #
+    # == Request
+    #
+    # GET http://api.crowdin.net/api/project/{project-identifier}/download/{package}.zip?key={project-key}
+    #
+    def download_translation(language = 'all', params = {})
+      request(
+        :method  => :get,
+        :path    => "/api/project/#{@project_id}/download/#{language}.zip",
+        :output  => params[:output],
+      )
+    end
+
+    # Upload your glossarries for Crowdin Project in TBX file format.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/upload-glossary?key={project-key}
+    #
+    def upload_glossary(file)
+      # raise "#{path} file does not exist" unless ::File.exist?(path)
+      file = ::File.open(file, 'rb')
+
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/upload-glossary",
+        :query  => { :file => file },
+      )
+    end
+
+    # Upload your Translation Memory for Crowdin Project in TMX file format.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/upload-tm?key={project-key}
+    #
+    def upload_tm(file)
+      file = ::File.open(file, 'rb')
+
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/upload-tm",
+        :query  => { :file => file },
+      )
+    end
+
+    # Add directory to Crowdin project.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/add-directory?key={project-key}
+    #
+    def add_directory(name)
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/add-directory.json",
+        :query  => { :name => name },
+      )
+    end
+
+    # Delete Crowdin project directory. All nested files and directories will be deleted too.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/delete-directory?key={project-key}
+    #
+    def delete_directory(name)
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/delete-directory",
+        :query  => { :name => name },
+      )
+    end
+
+
+    # Delete file from Crowdin project. All the translations will be lost without ability to restore them.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/delete-file?key={project-key}
+    #
+    def delete_file(file)
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/delete-file",
+        :query  => { :file => file },
+      )
+    end
+
+    # Download Crowdin project glossaries as TBX file.
+    #
+    # == Request
+    #
+    # GET http://api.crowdin.net/api/project/{project-identifier}/download-glossary?key={project-key}
+    #
+    def download_glossary(params = {})
+      request(
+        :method => :get,
+        :path   => "/api/project/#{@project_id}/download-glossary",
+        :output => params[:output],
+      )
+    end
+
+    # Download Crowdin project Translation Memory as TMX file.
+    #
+    # == Request
+    #
+    # GET http://api.crowdin.net/api/project/{project-identifier}/download-tm?key={project-key}
+    #
+    def download_tm(params = {})
+      request(
+        :method => :get,
+        :path   => "/api/project/#{@project_id}/download-tm",
+        :output => params[:output],
+      )
+    end
+
+    # Build ZIP archive with the latest translations. 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.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/export?key={project-key}
+    #
+    def export_translations
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/export",
+      )
+    end
+
+
+    # Get supported languages list with Crowdin codes mapped to locale name and standarded codes.
+    #
+    # == Request
+    #
+    # GET http://api.crowdin.net/api/supported-languages
+    #
+    def supported_languages(format = :xml)
+      request(
+        :method => :get,
+        :path   => "/api/supported-languages",
+        :query  => { format => true },
+      )
+    end
+
+    # Track your Crowdin project translation progress by language. Default response format is XML.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/status?key={project-key}
+    #
+    def translations_status(format = :xml)
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/status",
+        :query  => { format => true },
+      )
+    end
+
+    # Get Crowdin Project details.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/info?key={project-key}
+    #
+    def project_info(format = :json)
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/info",
+        :query  => { format => true },
+      )
+    end
+
+    # Create new Crowdin project.
+    # Important: The API method requires Account API Key. This key can not be found on your profile pages, please contact us to obtain API key for your account.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/account/create-project?account-key={account-key}
+    #
+    def create_project(params = {})
+      request(
+        :method => :post,
+        :path   => "/api/account/create-project",
+        :query  => params,
+      )
+    end
+
+    # Edit Crowdin project.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/edit-project?key={key}
+    #
+    def edit_project(params = {})
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/edit-project",
+        :query  => params,
+      )
+    end
+
+    # Delete Crowdin project with all translations.
+    #
+    # == Request
+    #
+    # POST http://api.crowdin.net/api/project/{project-identifier}/delete-project?key={project-key}
+    #
+    def delete_project
+      request(
+        :method => :post,
+        :path   => "/api/project/#{@project_id}/delete-project",
+      )
+    end
+
+    # Get Crowdin Project details.
+    #
+    # == Request
+    #
+    # GET http://api.crowdin.net/api/account/get-projects?key={account-key}
+    #
+    def get_projects(login)
+      request(
+        :method => :get,
+        :path   => "/api/account/get-projects",
+        :query  => { :login => login },
+      )
+    end
+
+  end
+end

data/lib/crowdin-api/version.rb

@@ -0,0 +1,5 @@
+module Crowdin
+  class API
+    VERSION = "0.0.2"
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: crowdin-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Anton Maminov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-27 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'
+  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
+email:
+- anton.linux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- crowdin-api.gemspec
+- lib/crowdin-api.rb
+- lib/crowdin-api/errors.rb
+- lib/crowdin-api/methods.rb
+- lib/crowdin-api/version.rb
+homepage: https://github.com/mamantoha/crowdin-api
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: The Crowdin Ruby Client is used to interact with the Crowdin API from Ruby
+test_files: []