smartling_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 713340cf808262a469600f0001be4079774b902f
-  data.tar.gz: 19477fba5d20febd6b1dda5265656f101aeee222
+  metadata.gz: 1549c7e511da6e551aa91e70c2707976fb301481
+  data.tar.gz: b301bd98ab189ea78f8dae633d9ce2a13458d9fc
 SHA512:
-  metadata.gz: e9e72780412954073160ec77022c5f275c08c79d7b828511f15c8f18f318a2a0cb52dd0b41986a0e2d2ad9bef26a002961e605abad8aecaea096c7f9b1c76c2c
-  data.tar.gz: 8dd59928f5d9eb5ab7d7eaf4cb4d5b4d707b727eed95223163ce8efa5c3d4c6044b6dc2d10dc26bad992f41c03b740ad17bd8f0a0040eca4d9ab2b7302b22cd4
+  metadata.gz: 86746de96df5ee3a6cea3dfeeeaee6e8e4db71a7202785b1889205b7472c70c2a1fa20a6f31437a16c81cfae32e5f32e37c0b9105d27182e5ee74a9e981582c0
+  data.tar.gz: 566a3ab12ccb40dbb806b93e504451481c722642e1ab45f6b753738349f4ad30eba7c2cd77a2d864fb068c11b3c7dc5583dc1e322f4d181c3693e7fbb593a0a0

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.3
+
+script: bundle exec rspec spec

data/README.md

@@ -1,6 +1,13 @@
-# Smartling Api
+Smartling Api
+=============
 
-## Overview
+![Build Status](https://travis-ci.org/redbubble/smartling_api.svg?branch=master)
+[![Code Climate](https://codeclimate.com/github/redbubble/smartling_api/badges/gpa.svg)](https://codeclimate.com/github/redbubble/smartling_api)
+[![Gem Version](https://badge.fury.io/rb/smartling_api.svg)](https://badge.fury.io/rb/smartling_api)
+![Docs](https://inch-ci.org/github/redbubble/smartling_api.svg?branch=master)
+
+Overview
+--------
 
 Ruby wrapper for accessing the Smartling Translation API V2.
 
@@ -8,21 +15,31 @@ The Smartling Translation API lets developers to internationalize their website
 
 [Smartling API V2](http://docs.smartling.com/pages/API/v2/)
 
-## Requirements
+
+Installation
+------------
+
+### Requirements
 
 - ruby 2.0+
 
-## Installation
+### Setup
 
 Add this line to your application's Gemfile:
 
   	gem 'smartling_api', '0.2.0'
+  	
+### Run Tests
+
+  	bundle exec rspec
+  	
 
-## Usage
+Usage
+-----
 
-### Configure
+### Config
 
-You will need to configure smartling user id and secret. In Rails you would put it in an initializer file.
+You will need to configure smartling user id and secret. In Rails you would put it in an initializer file. eg. `<project_home>/config/smartling_api.rb`
 
 	SmartlingApi.configure do |config|
   	  config.id = <id>
@@ -34,92 +51,11 @@ You can obtain an id, secret via [Create Authentication Tokens](http://docs.smar
 
 The `project_id` is optional.  If you are only using a single `project_id` per application then you may add your `project_id` here.  If not you will have to pass the `project_id` when you create your api call. Examples below.
 
-## Authentication Api
-
-
-### Retrieve Access Token
-
--  [Authenticate API](http://docs.smartling.com/pages/API/v2/Authentication/Authenticate). Retrieve OAuth2 access token to be used with each api call.
-
-
-		> SmartlingApi::Authentication.new.access_token 
-		=> "Token"
-
-The Authentication API will throw `SmartlingApi::Errors::Credentials` if the Smartling id and/or secret has not been set.
-
-## Project Api
-
-Create a Project Api via,
-
-@param `token`: Optional ( Will default to using authentication api to retrieve access token )
-	
-@param `project_id`: Optional ( Will default to using configured project_id )
-
-	> SmartlingApi::Project.new
-	or
-	> SmartlingApi::Project.new(token: 'token', project_id: 'project_id')
-	
-
-- [List Locales API](http://docs.smartling.com/pages/API/v2/Projects/List-Projects/). Retrieve a list of all locales available.
-
-		> SmartlingApi::Project.new.list_locales 
-		=> { "locales" => [{ "localeId" => "de-DE", "description" => "German (Germany)" }, ...] }
-		
-		
-## File Api
-Create a Project Api via,
-
-@param `token`: Optional ( Will default to using authentication api to retrieve access token )
-	
-@param `project_id`: Optional ( Will default to using configured project_id )
-
-	> SmartlingApi::File.new
-	or
-	> SmartlingApi::File.new(token: 'token', project_id: 'project_id')
-	
-
-- [Delete File API](http://docs.smartling.com/pages/API/v2/FileAPI/Delete/). Delete a file within Smartling.
-
-	@param `file_uri`: File path within Smartling to delete
-
-		> SmartlingApi::File.new.delete(file_uri: '/translations/website') 
-		=> { "code" => "SUCCESS" }
-		
-
-
-- [Download Locale File API](http://docs.smartling.com/pages/API/v2/FileAPI/Download-File/Single-Locale/).  Returns the content of a file for the given locale and path.
-
-	@param `file_uri`: File path within Smartling to download
-	
-	@param `locale_id`: Locale Id of file to download
-
-		> SmartlingApi::File.new.download_locale(locale_id: 'fr-Fr', file_uri: '/translation/website') 
-		=> "translations"
-		
-
-- [List File API](http://docs.smartling.com/pages/API/v2/FileAPI/List/).  Retrieve list of files for a given project.
-
-	@param `**options`: Additional options for the given request. NOTE: If using a hash as parameters ensure all keys are symbols and then use `**options`.  See Smartling API Doc for options.
-
-		> SmartlingApi::File.new.list_files(uriMask: '.json') 
-		=> [{"fileUri" => "[/translate/file.json]", ...}]
-		
-
-- [Upload File API](http://docs.smartling.com/pages/API/v2/FileAPI/Upload-File/).  Upload a file to the given path.
-
-	@param `file_path`: Location of file to upload
-	
-	@param `file_uri`: File path within smartling
-	
-	@param `file_type`: Type of file to upload. See Smartling API DOC for types.
-	
-	@param `**options`: Additional options for the given request. NOTE: If using a hash as parameters ensure all keys are symbols and then use `**options`.  See Smartling API Doc for options.
+### Api Reference
 
-		SmartlingApi::File.new.upload(file_path: 'website.pot', file_uri: '/translation/website', file_type: 'gettext') 
-		=> { "code" => "SUCCESS" }
-		
+Reference documentation on accessing the smartling api can be found on: [Api documentation](./doc/api.md)
 
-## Errors
+### Errors
 
 SmartlingApi will handle errors according to the response received from Smartling.  The errors that might be thrown on a request are,
 
@@ -131,7 +67,8 @@ SmartlingApi will handle errors according to the response received from Smartlin
 
 The errors all inherit, and will default to `SmartlingApi::Errors::Client` if any other response other than 2xx or 3xx is received.
 
-## Todo
+Todo
+----
 
 The following apis still need to be implemented:
 
@@ -144,20 +81,22 @@ The following apis still need to be implemented:
 -  File Api:  Last Modified: Single Locale
 -  File Api:  Last Modified: All Locales
 -  File Api:  Import Translations
--  File Api: Get Translations
+-  ~~File Api: Get Translations~~
 -  File Api:  Download Translated Files: Original File
 -  File Api:  Download Translated Files: Multiple Locales as ZIP
 -  File Api:  Download Translated Files: All Locales as ZIP
 -  File Api:  Download Translated Files: All Locales in one File - CSV
 
-## Credits
+Maintainers
+-------
 
-[![](/redbubble.png)][redbubble]
+[![](/doc/redbubble.png)][redbubble]
 
 smartling api is maintained and funded by [Redbubble][redbubble].
 
   [redbubble]: https://www.redbubble.com
 
-## License
+License
+-------
 
 Licensed under [MIT](./LICENCE.txt)

data/lib/smartling_api/clients/smartling.rb

@@ -53,7 +53,10 @@ module SmartlingApi
       # @return [Hash] Response returned from request
       # @raise [Errors::Client] If response does not return a 2xx or 3xx
       def upload(url:, token:, body:)
-        multipart_connection.post(url, body, header(token)).body.fetch('response')
+        response = multipart_connection.post(url, body, header(token)).body
+        return response if response.is_a?(String)
+
+        response.fetch('response')
       end
 
       # Download a file from smartling for the given url

data/lib/smartling_api/file.rb

@@ -77,6 +77,27 @@ module SmartlingApi
       smartling.post(url: "/files-api/v2/projects/#{project_id}/file/delete", token: token, body: { fileUri: file_uri })
     end
 
+    # Temporarily uploads a file, then returns a translated version for requested locales.
+    #
+    # @see http://docs.smartling.com/pages/API/v2/FileAPI/Get-Translations/
+    #
+    # @example Get Translations
+    #   SmartlingApi::File.new.get_translations(file: 'translations.pot', file_uri: '/translations/website.pot') #=> { "code" => "SUCCESS" }
+    #
+    # @param file_path [String] File path of contents to upload
+    # @param file_uri [String] File path within Smartling to base off
+    # @param locale_id [String] Locale id for the given file
+    # @param options [Hash] Additional options for the given request.
+    # @return [Hash] Details of tranlsations
+    def get_translations(file_path:, file_uri:, locale_id:, **options)
+      body = {
+        file:     Faraday::UploadIO.new(file_path, 'text/plain'),
+        fileUri:  file_uri,
+      }.merge(options)
+
+      smartling.upload(url: "/files-api/v2/projects/#{project_id}/locales/#{locale_id}/file/get-translations", token: token, body: body)
+    end
+
   private
 
     attr_reader :smartling, :token, :project_id

data/lib/smartling_api/version.rb

@@ -1,3 +1,3 @@
 module SmartlingApi
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/smartling_api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["developers@redbubble.com"]
 
   spec.summary       = %q{Wrapper for the Smartling API.}
-  spec.homepage      = "https://www.redbubble.com/"
+  spec.homepage      = "https://github.com/redbubble/smartling_api"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartling_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Redbubble
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-26 00:00:00.000000000 Z
+date: 2017-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,11 +116,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENCE.txt
 - README.md
 - bin/console
 - bin/setup
+- doc/api.md
+- doc/redbubble.png
 - lib/smartling_api.rb
 - lib/smartling_api/authentication.rb
 - lib/smartling_api/clients/smartling.rb
@@ -134,9 +138,8 @@ files:
 - lib/smartling_api/file.rb
 - lib/smartling_api/project.rb
 - lib/smartling_api/version.rb
-- redbubble.png
 - smartling_api.gemspec
-homepage: https://www.redbubble.com/
+homepage: https://github.com/redbubble/smartling_api
 licenses:
 - MIT
 metadata: {}
@@ -156,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Wrapper for the Smartling API.