toptranslation_api 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a7a5e459dc186fd8dc7ca31ed08de8aa2f59489f13c5a7921c0b6e276feaf11
-  data.tar.gz: 90ef9708e838df69119982d77fdf27b5427f037cb1fc34391ec563a54d89ba73
+  metadata.gz: 700cce0881675c0dafc87f6b0164c4de80495fc146ff9487584c1c2d7d1abf02
+  data.tar.gz: 23384b7748432e0d96ac60f45dba8e6e1c0219fe6c0ed53fdd70c54b7a2e3388
 SHA512:
-  metadata.gz: a50b0d1ad993cff3c7b2477e694022d4042be6ed62792a679a8e0a1559a1db5670f0484cace778f37810663fffa1ec836071d24e0ec501c57f1383cda2d16a96
-  data.tar.gz: 5ae7cbb4208769f291386f72ad420071d54328babe299028d2f2df9208f8e46457efbc00368df5ef541a7f36c779c36c20bee49c53938fcbb989766403ff9f19
+  metadata.gz: 770ef06cea32101858e51b52c0ac6322315174ed484f01ee16809d44242a4d639d12bb18861cb9fbc4ffb0959605095a310ef0255749f595ec8361ea0409617a
+  data.tar.gz: 710217d985fd2fd1094de9f4d3152cdb8452599b9b414303ad063c326ce6d1b818ef2fa1875a586d23e0c89e658574f35a5463edbea9f584a8c14ed33296e3ec

data/lib/toptranslation/connection.rb

@@ -1,6 +1,8 @@
 module Toptranslation
   class Connection
-    attr_accessor :upload_token, :verbose, :access_token
+    attr_accessor :verbose, :access_token
+
+    API_VERSION = 'v2'.freeze
 
     def initialize(options = {})
       @base_url = options[:base_url] || 'https://api.toptranslation.com'
@@ -11,15 +13,15 @@ module Toptranslation
     end
 
     def get(path, options = {})
-      transform_response(request(:get, path, options), options)
+      transform_response(request(:get, path, options))
     end
 
     def post(path, options = {})
-      transform_response(request(:post, path, options), options)
+      transform_response(request(:post, path, options))
     end
 
     def patch(path, options = {})
-      transform_response(request(:patch, path, options), options)
+      transform_response(request(:patch, path, options))
     end
 
     def download(url, path, &block)
@@ -28,10 +30,12 @@ module Toptranslation
       download_uri(uri, path, &block)
     end
 
-    def upload(filepath, type, &block)
-      uri = URI.parse("#{@files_url}/documents")
+    # Uploads go directly to the document store (castor): the response
+    # carries the document token that authorizes further use of the file.
+    def upload(filepath, _type = 'document', &block)
+      uri = URI.parse("#{@files_url}/v2/documents")
       file = File.new(filepath)
-      upload_file(file, type, uri, &block)
+      upload_file(file, uri, &block)
     end
 
     def sign_in!(options)
@@ -43,7 +47,7 @@ module Toptranslation
         application_id: 'pollux'
       }.merge(options)
 
-      @access_token = post('/auth/sign_in', sign_in_options.merge(version: 2))['access_token']
+      @access_token = post('/auth/sign_in', sign_in_options)['access_token']
 
       puts "# Requested access token #{@access_token}" if @verbose
 
@@ -52,12 +56,8 @@ module Toptranslation
 
     private
 
-      def version(options)
-        options[:version] || 0
-      end
-
       def request(method, path, options)
-        url = "#{@base_url}/v#{version(options)}#{path}"
+        url = "#{@base_url}/#{API_VERSION}#{path}"
         puts "# #{method}-request #{url}" if @verbose
         puts "options: #{prepare_request_options(options, method)}" if @verbose
         RestClient.send(method, url, prepare_request_options(options, method))
@@ -66,30 +66,13 @@ module Toptranslation
         raise e
       end
 
-      def upload_token
-        @upload_token ||= request_upload_token
-      end
-
-      def request_upload_token
-        puts '# Requesting upload-token' if @verbose
-        token = post('/upload_tokens')['upload_token']
-        puts "# Upload-token retrieved: #{token}" if @verbose
-        token
-      end
-
-      def transform_response(response, options)
+      def transform_response(response)
         puts response if @verbose
-        parsed = JSON.parse(response)
-        if version(options) == 2
-          parsed
-        else
-          parsed['data']
-        end
+        JSON.parse(response)
       end
 
       def prepare_request_options(options, method)
         request_options = options.dup
-        request_options.delete(:version)
         if [:post, :patch].include? method
           request_options.merge(auth_params)
         else
@@ -139,15 +122,17 @@ module Toptranslation
         end
       end
 
-      def upload_file(file, type, uri)
+      def upload_file(file, uri)
         response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
           request = Net::HTTP::Post.new(uri)
-          request.set_form({ 'file' => file, 'token' => upload_token, 'type' => type }, 'multipart/form-data')
+          # stable per upload (not per attempt): the document store recognizes
+          # retries and returns the already created document instead of a duplicate
+          request.set_form({ 'file' => file, 'idempotency_key' => SecureRandom.uuid }, 'multipart/form-data')
 
           http.request(request)
         end
 
-        transform_response(response.body, version: 0)
+        transform_response(response.body)
       end
   end
 end

data/lib/toptranslation/resource/document.rb

@@ -8,17 +8,6 @@ module Toptranslation::Resource
       update_from_response(options)
     end
 
-    def add_translation(filepath, locale_code, options = {})
-      upload = Upload.new(@connection).upload(filepath)
-
-      response = @connection.post("/documents/#{@identifier}/translations", options.merge(
-                                                                              document_store_id: upload.document_store_id,
-                                                                              document_token: upload.document_token,
-                                                                              locale_code: locale_code,
-                                                                              sha1: upload.sha1
-                                                                            ))
-    end
-
     def download_url(locale_code, options = {})
       params = { file_format: options[:file_format], locale_code: locale_code }.compact
       @connection.get("/documents/#{@identifier}/download", params: params)['download_url']
@@ -36,24 +25,8 @@ module Toptranslation::Resource
       @connection.download(download_url(locale_code, options), download_path, &block)
     end
 
-    def save
-      response = @connection.patch("/documents/#{@identifier}", remote_hash)
-      update_and_return_from_response(response)
-    end
-
-    def strings
-      StringList.new(@connection, document_identifier: @identifier)
-    end
-
     private
 
-      def update_and_return_from_response(response)
-        if response
-          update_from_response(response)
-          self
-        end
-      end
-
       def update_from_response(response)
         @identifier = response['identifier'] if response['identifier']
         @name = response['name'] if response['name']
@@ -70,10 +43,5 @@ module Toptranslation::Resource
         end
       end
 
-      def remote_hash
-        hash = {}
-        hash[:name] = @name if @name
-        hash
-      end
   end
 end

data/lib/toptranslation/resource/document_list.rb

@@ -7,11 +7,6 @@ module Toptranslation::Resource
       @options = options
     end
 
-    def find(identifier)
-      result = @connection.get("/documents/#{identifier}")
-      Document.new(@connection, result)
-    end
-
     def each
       documents.each { |document| yield Document.new(@connection, document) }
     end

data/lib/toptranslation/resource/project.rb

@@ -33,10 +33,6 @@ module Toptranslation::Resource
       ProjectDocumentList.new(@connection, options)
     end
 
-    def strings
-      StringList.new(@connection, project_identifier: @identifier)
-    end
-
     def save
       response = @identifier ? update_remote_project : create_remote_project
       update_and_return_from_response(response)
@@ -62,11 +58,13 @@ module Toptranslation::Resource
       def update_from_response(response)
         @identifier = response['identifier'] if response['identifier']
         @created_at = DateTime.parse(response['created_at']) if response['created_at']
-        @locales = response['locales'].inject([]) do |accu, locale_data|
+        @locales = Array(response['locales']).inject([]) do |accu, locale_data|
           locale = Locale.new(locale_data)
           @source_locale = locale if locale_data['is_source_locale'] # Set source locale of the project
           accu << locale
         end
+        # API v2 liefert die Ausgangssprache zusätzlich als eigenes Feld
+        @source_locale = Locale.new(response['source_locale']) if response['source_locale']
         @name = response['name'] if response['name']
       end
 

data/lib/toptranslation/resource/project_document_list.rb

@@ -1,5 +1,11 @@
 module Toptranslation::Resource
   class ProjectDocumentList < DocumentList
+    # projektbezogener Lookup — API v2 kennt kein unscoped GET /documents/:id
+    def find(identifier)
+      result = @connection.get("/projects/#{@options[:project_identifier]}/documents/#{identifier}")
+      Document.new(@connection, result)
+    end
+
     def create(name, path, options = {})
       response = @connection.post("/projects/#{@options[:project_identifier]}/documents", options.merge(name: name, path: path))
       Document.new(@connection, response)

data/lib/toptranslation/resource/translation_list.rb

@@ -19,7 +19,7 @@ module Toptranslation::Resource
     private
 
       def translations
-        @connection.get("/orders/#{@options[:order_identifier]}/translations") if @options[:order_identifier]
+        @connection.get('/translations', params: { order_identifier: @options[:order_identifier] }) if @options[:order_identifier]
       end
   end
 end

data/lib/toptranslation/resource/upload.rb

@@ -12,7 +12,8 @@ module Toptranslation::Resource
       response = @connection.upload(filepath, type, &block)
 
       @document_store_id = response['identifier']
-      @document_token    = response['document_token']
+      # Document-Store v2 nennt das Feld token
+      @document_token    = response['token'] || response['document_token']
       @sha1              = response['sha1']
 
       self

data/lib/toptranslation/version.rb

@@ -1,3 +1,3 @@
 module Toptranslation
-  VERSION = '3.0.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

data/lib/toptranslation_api.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'securerandom'
 require 'rest-client'
 require 'toptranslation/client'
 require 'toptranslation/connection'
@@ -13,8 +14,6 @@ require 'toptranslation/resource/project'
 require 'toptranslation/resource/project_list'
 require 'toptranslation/resource/quote'
 require 'toptranslation/resource/reference_document'
-require 'toptranslation/resource/string_list'
-require 'toptranslation/resource/string'
 require 'toptranslation/resource/translation'
 require 'toptranslation/resource/translation_list'
 require 'toptranslation/resource/upload'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toptranslation_api
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Toptranslation GmbH
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2026-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -156,8 +156,6 @@ files:
 - lib/toptranslation/resource/project_list.rb
 - lib/toptranslation/resource/quote.rb
 - lib/toptranslation/resource/reference_document.rb
-- lib/toptranslation/resource/string.rb
-- lib/toptranslation/resource/string_list.rb
 - lib/toptranslation/resource/translation.rb
 - lib/toptranslation/resource/translation_list.rb
 - lib/toptranslation/resource/upload.rb
@@ -184,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A ruby client for the Toptranslation API

data/lib/toptranslation/resource/string.rb

@@ -1,64 +0,0 @@
-module Toptranslation::Resource
-  class String
-    attr_reader :identifier, :updated_at, :created_at
-    attr_accessor :value, :state, :project_identifier, :document_identifier, :key, :comment, :context, :array_index, :plural_form, :locale_code
-
-    def initialize(connection, options = {})
-      @connection = connection
-      @options = options
-
-      update_from_response(options)
-    end
-
-    def save
-      response = @identifier ? update_remote_string : create_remote_string
-      update_and_return_from_response(response)
-    end
-
-    private
-
-      def update_remote_string
-        @connection.patch("/strings/#{@identifier}", remote_hash)
-      end
-
-      def create_remote_string
-        @connection.post('/strings', remote_hash)
-      end
-
-      def update_and_return_from_response(response)
-        if response
-          update_from_response(response)
-          self
-        end
-      end
-
-      def update_from_response(response)
-        @identifier = response['identifier'] if response['identifier']
-        @key = response['key'] if response['key']
-        @value = response['value'] if response['value']
-        @state = response['state'] if response['state']
-        @comment = response['comment'] if response['comment']
-        @context = response['context'] if response['context']
-        @array_index = response['array_index'] if response['array_index']
-        @plural_form = response['plural_form'] if response['plural_form']
-        @locale_code = response['locale_code'] if response['locale_code']
-        @project_identifier = response['project_identifier'] if response['project_identifier']
-        @document_identifier = response['document_identifier'] if response['document_identifier']
-        @updated_at = DateTime.parse(response['updated_at']) if response['updated_at']
-        @created_at = DateTime.parse(response['created_at']) if response['created_at']
-      end
-
-      def remote_hash
-        hash = {}
-        hash[:key]   = @key   if @key
-        hash[:value] = @value if @value
-        hash[:state] = @state if @state
-        hash[:comment] = @comment if @comment
-        hash[:locale_code] = @locale_code if @locale_code
-        hash[:plural_form] = @plural_form if @plural_form
-        hash[:project_identifier] = @project_identifier if @project_identifier
-        hash[:document_identifier] = @document_identifier if @document_identifier
-        hash
-      end
-  end
-end

data/lib/toptranslation/resource/string_list.rb

@@ -1,32 +0,0 @@
-module Toptranslation::Resource
-  class StringList
-    include Enumerable
-
-    def initialize(connection, options = {})
-      @connection = connection
-      @options = options
-    end
-
-    def find(identifier)
-      result = @connection.get("/strings/#{identifier}")
-      Document.new(@connection, result)
-    end
-
-    def each
-      strings.each { |string| yield String.new(@connection, string) }
-    end
-
-    def create(options = {})
-      project_identifier = options['project_identifier'] || @options[:project_identifier]
-      document_identifier = options['document_identifier'] || @options[:document_identifier]
-
-      String.new(@connection, options.merge('project_identifier' => project_identifier, 'document_identifier' => document_identifier))
-    end
-
-    private
-
-      def strings
-        @connection.get('/strings', params: { project_identifier: @options[:project_identifier], document_identifier: @options[:document_identifier] })
-      end
-  end
-end