smartring 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ff999e9fccd2e5dc5ef5fb4708f55ea6b0a5d35a1fd3fb8e4133aa1e6691a5e
-  data.tar.gz: c8f983c46d6ce9d8d8174d75406b262ba1584186ee7ceef07407c4e0111ef8cf
+  metadata.gz: 837a79f27bba855d63ff0055ef98af9f3b065c09f4d9172a8107af31a15fde77
+  data.tar.gz: 5afc964127b1f19de3c0c8462e854c98e24a6df02a4341625ef94b4ee5204bfe
 SHA512:
-  metadata.gz: 5d890e27264dbaedbefada0a2d2da93afbb39e37905599fe415c3a07a5a6936bd0bf4d3e930bcc0c17cbd7a012c7c3249bb0a7e6cbd26a61a07d4cc46e2166c1
-  data.tar.gz: 3a05050cde3198f794953b226ab3554e78c082e555f9b4ed83c223fce44abc7209e2f4a38a4a89968dab316fad39cfc961487e1bf8d8198d91d09dd538bc7beb
+  metadata.gz: a6aa2a8fb795346e6e4bad8b49737bc2e4b09af53ab6668b71f32818e061415c882767a94f5807bc83094b82e11f6ec8e299f42c76d8503a85df232411fa61c8
+  data.tar.gz: 4cabd64289c24452b2365045d4b3a0d286086c8a4725ba6032e44f0fd37d45d10d0177ac0485e354971f851cab944261b96a5eec32d14f5cb08e183795aed04f

data/lib/smartling/files.rb

@@ -11,7 +11,12 @@ module Smartling
       get(path)
     end
 
-    def file(project_id: @project_id, file_uri:, locale: nil)
+    def file_types(project_id: @project_id)
+      path = "/files-api/v2/projects/#{project_id}/file-types"
+      get(path)
+    end
+
+    def file_status(project_id: @project_id, file_uri:, locale: nil)
       path = ["/files-api/v2/projects/#{project_id}"]
       path << "locales/#{locale}" unless locale.nil?
       path << 'file/status'
@@ -19,11 +24,39 @@ module Smartling
       get(path, query: { fileUri: file_uri })
     end
 
+    alias file file_status
+
+    def download_original_file(project_id: @project_id, file_uri:)
+      path = "/files-api/v2/projects/#{project_id}/file"
+      get(path, query: { fileUri: file_uri })
+    end
+
+    def download_translated_file(project_id: @project_id, file_uri:, locale:,
+                                retrieval_type: nil, include_original: nil)
+      path = "/files-api/v2/projects/#{project_id}/locales/#{locale}/file"
+      query = { fileUri: file_uri }
+      query[:retrievalType] = retrieval_type unless retrieval_type.nil?
+      query[:includeOriginalStrings] = true if include_original
+      get(path, query: query)
+    end
+
+    def download_file(project_id: @project_id, file_uri:, locale: nil)
+      return download_translated_file(project_id: project_id,
+                                      file_uri: file_uri,
+                                      locale: locale) unless locale.nil?
+      download_original_file(project_id: project_id, file_uri: file_uri)
+    end
+
     def delete_file(project_id: @project_id, file_uri:)
       path = "/files-api/v2/projects/#{project_id}/file/delete"
       post(path, body: { fileUri: file_uri })
     end
 
+    def rename_file(project_id: @project_id, file_uri:, new_file_uri:)
+      path = "/files-api/v2/projects/#{project_id}/file/rename"
+      post(path, body: { fileUri: file_uri, newFileUri: new_file_uri })
+    end
+
     def upload_file(project_id: @project_id, file:, file_uri:, file_type:,
                     callback: nil, authorize: nil, locales_to_authorize: nil,
                     smartling: {})
@@ -39,6 +72,39 @@ module Smartling
       post(path, body: body)
     end
 
+    def import_translations(project_id: @project_id, file_uri:, locale:,
+                            file:, file_type:, translation_state: nil,
+                            overwrite: nil)
+      raise(InvalidFile, file) unless Files.valid_file?(file)
+      path = "/files-api/v2/projects/#{project_id}/locales/#{locale}/file/import"
+      body = { file: file, fileUri: file_uri, fileType: file_type }
+      body[:translationState] = translation_state unless translation_state.nil?
+      body[:overwrite] = overwrite unless overwrite.nil?
+      post(path, body: body)
+    end
+
+    def translate_file(project_id: @project_id, file_uri:, locale:, file:,
+                       file_type:, retrieval_type: nil,
+                       include_original_strings: nil)
+      raise(InvalidFile, file) unless Files.valid_file?(file)
+      path = "/files-api/v2/projects/#{project_id}/locales/#{locale}/file/get-translations"
+      body = { file: file, fileUri: file_uri, fileType: file_type }
+      body[:retrievalType] = retrieval_type unless retrieval_type.nil?
+      body[:includeOriginalStrings] = include_original_strings unless include_original_strings.nil?
+      post(path, body: body)
+    end
+
+    def file_last_modified(project_id: @project_id, file_uri:, locale: nil,
+                           since: nil)
+      path = ["/files-api/v2/projects/#{project_id}"]
+      path << "locales/#{locale}" unless locale.nil?
+      path << 'file/last-modified'
+      path = path.join('/')
+      query = { fileUri: file_uri }
+      query[:lastModifiedAfter] = since.to_s.iso8601 unless since.nil?
+      get(path, query: query)
+    end
+
     InvalidFile = Class.new(ArgumentError)
 
     def self.valid_file?(content)

data/test/smartling/files_test.rb

@@ -19,18 +19,87 @@ describe Smartling::Files do
     end
   end
 
-  describe 'file' do
+  describe 'file_types' do
+    it 'lists file types' do
+      smartling.expect(:get, nil) do |path|
+        assert_match %r{files-api/v2/projects/1/file-types$}, path
+      end
+      smartling.file_types(project_id: 1)
+    end
+  end
+
+  describe 'file_status' do
     it 'gets the /file/status endpoint with the right param' do
       smartling.expect(:get, nil) do |path, query:|
         assert_match %r{files-api/v2/projects/1/file/status$}, path
         assert_equal({ fileUri: 'x' }, query)
       end
-      smartling.file(project_id: 1, file_uri: 'x')
+      smartling.file_status(project_id: 1, file_uri: 'x')
+    end
+  end
+
+  describe 'download_file with no locale' do
+    it 'gets /file with the right param' do
+      smartling.expect(:get, nil) do |path, query:|
+        assert_match %r{files-api/v2/projects/1/file$}, path
+        assert_equal({ fileUri: 'x' }, query)
+      end
+      smartling.download_file(project_id: 1, file_uri: 'x')
+    end
+  end
+
+  describe 'download_original_file' do
+    it 'gets /file with the right param' do
+      smartling.expect(:get, nil) do |path, query:|
+        assert_match %r{files-api/v2/projects/1/file$}, path
+        assert_equal({ fileUri: 'x' }, query)
+      end
+      smartling.download_original_file(project_id: 1, file_uri: 'x')
+    end
+  end
+
+  describe 'download_file with a locale' do
+    it 'gets /locales/<locale>/file with the right param' do
+      smartling.expect(:get, nil) do |path, query:|
+        assert_match %r{files-api/v2/projects/1/locales/es/file$}, path
+        assert_equal({ fileUri: 'x' }, query)
+      end
+      smartling.download_file(project_id: 1, file_uri: 'x', locale: 'es')
+    end
+  end
+
+  describe 'download_translated_file' do
+    it 'gets /locales/x/file with the right param' do
+      smartling.expect(:get, nil) do |path, query:|
+        assert_match %r{files-api/v2/projects/1/locales/es/file$}, path
+        assert_equal({ fileUri: 'x' }, query)
+      end
+      smartling.download_translated_file(project_id: 1, file_uri: 'x', locale: 'es')
+    end
+  end
+
+  describe 'file_last_modified (without locale)' do
+    it 'gets /file/last-modified with the right param' do
+      smartling.expect(:get, nil) do |path, query:|
+        assert_match %r{files-api/v2/projects/1/file/last-modified$}, path
+        assert_equal({ fileUri: 'x' }, query)
+      end
+      smartling.file_last_modified(project_id: 1, file_uri: 'x')
+    end
+  end
+
+  describe 'file_last_modified (with locale)' do
+    it 'gets /locales/x/file/last-modified with the right param' do
+      smartling.expect(:get, nil) do |path, query:|
+        assert_match %r{files-api/v2/projects/1/locales/es/file/last-modified$}, path
+        assert_equal({ fileUri: 'x' }, query)
+      end
+      smartling.file_last_modified(project_id: 1, file_uri: 'x', locale: 'es')
     end
   end
 
   describe 'file with locale' do
-    it 'gets the /locale/x/file/status endpoint with the right params' do
+    it 'gets the /locales/x/file/status endpoint with the right params' do
       smartling.expect(:get, nil) do |path, query:|
         assert_match %r{files-api/v2/projects/1/locales/es/file/status$}, path
         assert_equal({ fileUri: 'x' }, query)
@@ -49,6 +118,16 @@ describe Smartling::Files do
     end
   end
 
+  describe 'rename_file' do
+    it 'posts the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_match %r{files-api/v2/projects/1/file/rename$}, path,
+                     assert_equal({ fileUri: 'x', newFileUri: 'y' }, body)
+      end
+      smartling.rename_file(project_id: 1, file_uri: 'x', new_file_uri: 'y')
+    end
+  end
+
   describe 'upload_file' do
     it 'posts the right body to the right endpoint' do
       smartling.expect(:post, nil) do |path, body:|
@@ -75,4 +154,34 @@ describe Smartling::Files do
       end
     end
   end
+
+  describe 'import_translations' do
+    it 'posts the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_equal '/files-api/v2/projects/1/locales/es/file/import', path
+        assert_equal 'x', body.fetch(:fileUri)
+        assert_equal 'json', body.fetch(:fileType)
+        assert_equal '"hello"', body.fetch(:file).read
+        assert_equal 'application/json', body.fetch(:file).content_type
+      end
+      file = UploadIO.new(StringIO.new('"hello"'), 'application/json')
+      smartling.import_translations(project_id: 1, file: file, file_uri: 'x',
+                                    file_type: 'json', locale: 'es')
+    end
+  end
+
+  describe 'translate_file' do
+    it 'posts the right body to the right endpoint' do
+      smartling.expect(:post, nil) do |path, body:|
+        assert_equal '/files-api/v2/projects/1/locales/es/file/get-translations', path
+        assert_equal 'x', body.fetch(:fileUri)
+        assert_equal 'json', body.fetch(:fileType)
+        assert_equal '"hello"', body.fetch(:file).read
+        assert_equal 'application/json', body.fetch(:file).content_type
+      end
+      file = UploadIO.new(StringIO.new('"hello"'), 'application/json')
+      smartling.translate_file(project_id: 1, file: file, file_uri: 'x',
+                               file_type: 'json', locale: 'es')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartring
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - JJ Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv