crowdin-api 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,7 @@
 # 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
@@ -81,10 +82,16 @@ crowdin.delete_file('strings.xml')
 
 ### Upload Translations
 
+Documentation: <http://crowdin.net/page/api/upload-translation>
+
 ### Translation Status
 
+Documentation: <http://crowdin.net/page/api/status>
+
 ### Project Info
 
+Documentation: <http://crowdin.net/page/api/info>
+
 ### Download Translations
 
 Documentation: <http://crowdin.net/page/api/download>
@@ -97,28 +104,59 @@ crowdin.download_translation('ru', :output => '/path/to/download/ru_RU.zip')
 
 ### Export Translations
 
+Documentation: <http://crowdin.net/page/api/export>
+
 ### Account Projects
 
+Documentation: <http://crowdin.net/page/api/get-projects>
+
 ### Create Project
 
+Documentation: <http://crowdin.net/page/api/create-project>
+
 ### Edit Project
 
+Documentation: <http://crowdin.net/page/api/edit-project>
+
 ### Delete 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>
+
 ### Upload Glossary
 
+Documentation: <http://crowdin.net/page/api/upload-glossary>
+
 ### Download TM
 
+Documentation: <http://crowdin.net/page/api/download-tm>
+
 ### Upload TM
 
-###Supported Languages
+Documentation: <http://crowdin.net/page/api/upload-tm>
+
+### Supported Languages
+
+Documentation: <http://crowdin.net/page/api/supported-languages>
+
+
+## Supported Rubies
+
+Tested with the following Ruby versions:
 
+- MRI 1.9.3
+- JRuby 1.7.0
 
 ## Contributing
 

data/lib/crowdin-api.rb

@@ -1,5 +1,6 @@
+require 'pp'
 require 'logger'
-require 'rexml/document'
+require 'json'
 require 'rest-client'
 
 require "crowdin-api/errors"
@@ -13,6 +14,13 @@ require "crowdin-api/version"
 module Crowdin
   class API
 
+    # Create a new API object using the given parameters.
+    #
+    # @param [String] api_key the authentication API key can be found on the project settings page
+    # @param [String] project_id the project identifier.
+    # @param [String] account_key the account API Key
+    # @param [String] base_url the url of the Crowdin API
+    #
     def initialize(options = {})
       @api_key     = options.delete(:api_key)
       @project_id  = options.delete(:project_id)
@@ -24,10 +32,11 @@ module Crowdin
         :params                 => {},
         :key                    => @api_key,
         :'account-key'          => @account_key,
+        :json                   => true
       }.merge(options)
 
       options[:headers] = {
-        'Accept'                => 'application/xml',
+        'Accept'                => 'application/json',
         'User-Agent'            => "crowdin-rb/#{Crowdin::API::VERSION}",
         'X-Ruby-Version'        => RUBY_VERSION,
         'X-Ruby-Platform'       => RUBY_PLATFORM
@@ -36,6 +45,7 @@ module Crowdin
       options[:params] = {
         :key                    => @api_key,
         :'account-key'          => @account_key,
+        :json                   => true
       }.merge(options[:params])
 
       @connection = RestClient::Resource.new(@base_url, options)
@@ -63,15 +73,14 @@ module Crowdin
         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
+        doc = JSON.load(@response.body)
+        if doc.kind_of?(Hash) && doc['success'] == false
+          code    = doc['error']['code']
+          message = doc['error']['message']
           error   = Crowdin::API::Errors::Error.new(code, message)
           raise(error)
         else
-          # leave body as is
-          return @response
+          return doc
         end
       end
 

data/lib/crowdin-api/methods.rb

@@ -1,4 +1,9 @@
 module Crowdin
+  # A wrapper and interface to the Crowdin api. Please visit the Crowdin developers
+  # site for a full explaination of what each of the Crowdin api methods
+  # expect and perform.
+  #
+  # http://crowdin.net/page/api
 
   class API
 
@@ -236,25 +241,23 @@ module Crowdin
     #
     # GET http://api.crowdin.net/api/supported-languages
     #
-    def supported_languages(format = :xml)
+    def supported_languages
       request(
         :method => :get,
         :path   => "/api/supported-languages",
-        :query  => { format => true },
       )
     end
 
-    # Track your Crowdin project translation progress by language. Default response format is XML.
+    # Track your Crowdin project translation progress by language.
     #
     # == Request
     #
     # POST http://api.crowdin.net/api/project/{project-identifier}/status?key={project-key}
     #
-    def translations_status(format = :xml)
+    def translations_status
       request(
         :method => :post,
         :path   => "/api/project/#{@project_id}/status",
-        :query  => { format => true },
       )
     end
 
@@ -264,11 +267,10 @@ module Crowdin
     #
     # POST http://api.crowdin.net/api/project/{project-identifier}/info?key={project-key}
     #
-    def project_info(format = :json)
+    def project_info
       request(
         :method => :post,
         :path   => "/api/project/#{@project_id}/info",
-        :query  => { format => true },
       )
     end
 

data/lib/crowdin-api/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   class API
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2012-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client