smartling 0.5.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTQ1MWMzYzU0ZDBjMGM1MDkyMDNmZTQyYjFkNjBmYTI0MjAyNzhiMA==
+  data.tar.gz: !binary |-
+    YzBhMmI5ZGVkNzdhM2YwYzYyOGQzNjI2NmJlZmQ4Mzg2Y2ExZTg0Ng==
+SHA512:
+  metadata.gz: !binary |-
+    OTliMzE2ZGU1ZWMwYWMxOGIzNzQxMmVlNzgwZDEyYTdhMjUxZmU4ZTIxMTAw
+    NzU0MGQ4ODMwYzY1ZTlkOWQ0MTRkODIwNTY4NDQxOTU0ZmEwYjE0Nzk4YmYy
+    NWIxNTU3ODc3ZTFmZTg3MWY4MzYxMzc3OGQ1OGZmODI0YTIyNmM=
+  data.tar.gz: !binary |-
+    MDlkN2U5MDcwYWY4NWU4NmFhNzNhOGVmM2NhYWU2MWVjYmM3NjBhNTA0MWVk
+    YmZlZTJiNDRhNjRjNjhjYTllNDgzMjJiMTUyZjE3YTMzMzdmYWQyZWQzNjgz
+    ZDgzNTc2ODFiYWFlNGRkMDg4NDEyZDZjZTAwNjhjOTc3NTQ1ZTI=

data/README.md

@@ -1,3 +1,6 @@
+[![rubygems](https://img.shields.io/gem/v/smartling.svg)](https://rubygems.org/gems/smartling)
+[![build status](https://travis-ci.org/Smartling/api-sdk-ruby.svg)](https://travis-ci.org/Smartling/api-sdk-ruby)
+
 [Smartling Translation API](http://docs.smartling.com)
 =================
 
@@ -59,4 +62,3 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-

data/lib/smartling/fileapi.rb

@@ -23,6 +23,7 @@ module Smartling
     FILE_UPLOAD = 'file/upload'
     FILE_RENAME = 'file/rename'
     FILE_DELETE = 'file/delete'
+    FILE_IMPORT = 'file/import'
   end
 
   class File < Api
@@ -63,6 +64,13 @@ module Smartling
       uri = uri(Services::FILE_DELETE, keys, params).require(:fileUri)
       return api_delete(uri.to_s)
     end
+
+    def import(file, name, type, state, params = nil)
+        keys = { :fileUri => name, :fileType => type, :translationState => state}
+        uri = uri(Services::FILE_IMPORT, keys, params).require(:fileUri, :fileType, :locale, :translationState)
+        file = ::File.open(file, 'rb') if file.is_a?(String)
+        return post(uri.to_s, :file => file)
+    end
   end
 
 end

data/lib/smartling/uri.rb

@@ -1,11 +1,11 @@
 # Copyright 2012 Smartling, Inc.
-# 
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #    http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -62,7 +62,7 @@ module Smartling
 
     def format_value(v)
       v.is_a?(Time) ? format_time(v) :
-        URI.escape(v.to_s)
+        CGI.escape(v.to_s).gsub('+', '%20')
     end
 
     def format_time(t)
@@ -71,4 +71,3 @@ module Smartling
 
   end
 end
-

data/lib/smartling/version.rb

@@ -1,11 +1,11 @@
 # Copyright 2012 Smartling, Inc.
-# 
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #    http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -14,6 +14,5 @@
 
 module Smartling
   # This follows Semantic Versioning http://semver.org/
-  VERSION = '0.5.1'
+  VERSION = '1.0.0'
 end
-

data/samples/data.yaml

@@ -0,0 +1,29 @@
+---
+invoice: 34843
+date   : 2001-01-23
+bill-to: &id001
+    given  : Chris
+    family : Dumars
+    address:
+        lines: |
+            458 Walkman Dr.
+            Suite #292
+        city    : Royal Oak
+        state   : MI
+        postal  : 48046
+# ship-to: *id001
+product:
+    - sku         : BL394D
+      quantity    : 4
+      description : Basketball
+      price       : 450.00
+    - sku         : BL4438H
+      quantity    : 1
+      description : Super Hoop
+      price       : 2392.00
+tax  : 251.42
+total: 4443.52
+comments: >
+    Late afternoon is best.
+    Backup contact is Nancy
+    Billsmer @ 338-4338.

data/samples/file_api.rb

@@ -16,84 +16,97 @@
 require 'rubygems'
 require 'smartling'
 
-API_KEY = 'YOUR_APIKEY'
-PROJECT_ID = 'YOUR_PROJECTID'
+def print_msg(msg)
+  puts
+  puts msg
+end
 
-puts 'Smartling Ruby client ' + Smartling::VERSION
+API_KEY = 'YOUR_API_KEY' # change this value to use "Smartling API key" found on the Project Settings -> API page in dashboard
+PROJECT_ID = 'YOUR_PROJECT_ID' # change this value to use "Project Id" found on the Project Settings -> API page in dashboard
 
+print_msg "Smartling Ruby client #{Smartling::VERSION}"
 
-# Initialize client to sandbox
+# Initialize client to use File API on Sandbox
 sl = Smartling::File.sandbox(:apiKey => API_KEY, :projectId => PROJECT_ID)
 
-# Initialize client for production File API
+# Initialize client to use File API on Production
 #sl = Smartling::File.new(:apiKey => API_KEY, :projectId => PROJECT_ID)
 
-# Upload YAML file
-res = sl.upload('source_file.yaml', 'name.yaml', 'YAML')
+# Basic usage
+
+file = 'data.yaml' # your data file
+file_uri = 'my_files/data.yaml' # unique identifier given to the uploaded file
+file_type = 'YAML' # file type
+
+print_msg "Uploading file '#{file}' using file URI '#{file_uri}' and file type '#{file_type}'..."
+res = sl.upload(file, file_uri, file_type)
 p res
 
-# Get list of uploaded files
-res = sl.list()
+print_msg 'Listing all project files...'
+res = sl.list
 p res
 
-name = 'path/file_name.yaml'
-lang = 'es-ES'
+lang = 'es-ES' # any language that exists in your project
+state = 'PUBLISHED' # state at which imported strings are imported as
 
-# Request translation status of the file
-res = sl.status(name, :locale => lang)
+print_msg "Getting status for file URI '#{file_uri}' and language '#{lang}'..."
+res = sl.status(file_uri, :locale => lang)
 p res
 
-# Download translated file in specified language
-data = sl.download(name, :locale => lang)
+print_msg "Importing translation file '#{file}' using file URI '#{file_uri}' and file type '#{file_type}' and language '#{lang}' as '#{state}'..." 
+res = sl.import(file, file_uri, file_type, state, :locale => lang)
+
+print_msg "Downloading translations for file URI '#{file_uri}' and language '#{lang}'..."
+data = sl.download(file_uri, :locale => lang)
 puts data
 
-# Rename file
-newname = 'path/newname.yaml'
-sl.rename(name, newname)
+new_file_uri = 'my_files/new_data.yaml' # new uri to uniquely identify the previously uploaded file
 
-# Delete file
-sl.delete(name)
+print_msg "Renaming file from '#{file_uri}' to '#{new_file_uri}'..."
+sl.rename(file_uri, new_file_uri)
+
+print_msg "Deleting file '#{new_file_uri}'..."
+sl.delete(new_file_uri)
 
 # Extended parameters
 
-# Upload with callback URL
-res = sl.upload('source_file.yaml', 'name.yaml', 'YAML', :callbackUrl => 'http://yourdomain/someservice')
+print_msg 'Uploading file with callback URL provided...'
+res = sl.upload(file, 'name.yaml', 'YAML', :callbackUrl => 'http://yourdomain.com/someservice')
 p res
 
-# Upload with approved flag
-res = sl.upload('source_file.yaml', 'name.yaml', 'YAML', :approved => true)
+print_msg 'Uploading file with approved flag provided...'
+res = sl.upload(file, 'name.yaml', 'YAML', :approved => true)
 p res
 
-# Filter list by mask
+print_msg 'Listing files using URI mask filter...'
 res = sl.list(:uriMask => '%.yaml')
 p res
 
-# Filter list by file type
+print_msg 'Listing files using file type filter...'
 res = sl.list(:fileTypes => ['yaml', 'ios'])
 p res
 
-# Order list by attribute
+print_msg 'Listing files ordered by attributes...'
 res = sl.list(:orderBy => ['fileUri', 'wordCount_desc'])
 p res
 
-# Page by page list
+print_msg 'Listing paginated files...'
 page, size = 2, 10
 res = sl.list(:offset => (page - 1) * size, :limit => size)
 p res
 
-# Filter list by upload date
+print_msg 'Listing files uploaded after a certain date...'
 res = sl.list(:lastUploadedAfter => Time.utc(2012, 04, 05))
 p res
 
-# Filter list by upload date range
+print_msg 'Listing files uploaded between a date range...'
 res = sl.list(:lastUploadedAfter => Time.utc(2012, 04, 01), :lastUploadedBefore => Time.utc(2012, 05, 01))
 p res
 
-# Filter by translation status
+print_msg 'Listing files using translation status...'
 res = sl.list(:conditions => ['haveAllTranslated', 'haveAtLeastOneUnapproved'])
 p res
 
-# Combine multiple filter parameters in a single query
+print_msg 'Listing files while combining multiple parameters...'
 res = sl.list(:fileTypes => 'yaml', :orderBy => 'fileUri', :offset => 20, :limit => 10)
 p res
-

data/tests/api_test.rb

@@ -1,12 +1,12 @@
 #!/usr/bin/ruby
 # Copyright 2012 Smartling, Inc.
-# 
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #    http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -21,7 +21,11 @@ module SmartlingTests
 
     def stub_response(code, body)
       status = Net::HTTPResponse.new('', code, '')
-      RestClient::Response.create(body, status, {})
+      if RestClient::Response.method(:create).arity > 3
+          RestClient::Response.create(body, status, {}, nil)
+      else
+          RestClient::Response.create(body, status, {})
+      end
     end
 
     def test_endpoints
@@ -80,4 +84,3 @@ module SmartlingTests
 
   end
 end
-

data/tests/srv_fileapi_test.rb

@@ -60,6 +60,17 @@ we have: cookies
       @log.debug res.inspect
     end
 
+    def test_2_1_upload
+      @log.debug '<- FileAPI:upload'
+      sl = Smartling::File.new(@config)
+
+      res = nil
+      assert_nothing_raised do
+        res = sl.upload(yaml_file.path, TEST_FILE_YAML, 'YAML')
+      end
+      @log.debug res.inspect
+    end
+
     def test_3_status
       @log.debug '<- FileAPI:status'
       sl = Smartling::File.new(@config)

data/tests/uri_test.rb

@@ -1,12 +1,12 @@
 #!/usr/bin/ruby
 # Copyright 2012 Smartling, Inc.
-# 
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #    http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -87,6 +87,11 @@ module SmartlingTests
       assert_equal('http://hello.wo/', uri.to_s)
     end
 
+    def test_encode
+        uri = Smartling::Uri.new('http://hello.wo/')
+        uri.params = {:foo => ['hello & world!']}
+        assert_equal('http://hello.wo/?foo=hello%20%26%20world%21', uri.to_s)
+    end
+
   end
 end
-

metadata

@@ -1,48 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: smartling
 version: !ruby/object:Gem::Version
-  version: 0.5.1
-  prerelease:
+  version: 1.0.0
 platform: ruby
 authors:
 - Pavel Ivashkov
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: rest-client
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    none: false
-  prerelease: false
-  type: :runtime
 description: A Ruby library to utilize Smartling services
 email:
 - hi@smartling.com
@@ -50,13 +45,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - LICENSE
+- README.md
 - lib/smartling.rb
 - lib/smartling/api.rb
 - lib/smartling/fileapi.rb
 - lib/smartling/uri.rb
 - lib/smartling/version.rb
+- samples/data.yaml
 - samples/file_api.rb
 - tests/api_test.rb
 - tests/config.sample
@@ -66,32 +62,30 @@ files:
 homepage: https://docs.smartling.com
 licenses:
 - LICENSE
-post_install_message:
+metadata: {}
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.8.6
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
-specification_version: 3
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
 summary: Smartling SDK
 test_files:
-- tests/api_test.rb
-- tests/config.sample
-- tests/srv_fileapi_test.rb
-- tests/test_helper.rb
 - tests/uri_test.rb
+- tests/test_helper.rb
+- tests/srv_fileapi_test.rb
+- tests/config.sample
+- tests/api_test.rb