deepl-rb 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aac8ae68e851fd09ed5a981e7ff9b796efbccbb7df0abdea0cf9bffe218ab71d
-  data.tar.gz: aeca955e569454056d75b54285c2a91d953d3bbd35ee38c1df7fb59bc92fec69
+  metadata.gz: a37d2acfd0320ea201f38b15aed87511a57d9764db6a6ab3c9a3d8e6ad09013a
+  data.tar.gz: 153ef18eab1a014d2733073be19ae5bad6c58a9b72ec9f04ea1e61d1a427f1d2
 SHA512:
-  metadata.gz: a86b786b98936c4a21e3a1d5ee7ed2a5b468c8d35b26b7af43b1ecb7609393b4abbd035bee6d69a39f9b52b38a707fac3d413dabdddee126605dd3d66baf22e7
-  data.tar.gz: 48c99a192c395dd34bd08bd3cc32ebb481bb5c8d96625365e6974af436e7ff44e78617343eb3403c1057bafe1fcb3774c7cd651e94364316e025ccc7be3f20b3
+  metadata.gz: a7cd860107137d7354714382a87b53934aa045e48ff2886b9c8a13f7957b4e4f3c651c3621289a82f2aa23011a8be09fc903bc4022dfcf68e8a76eacc50d2c30
+  data.tar.gz: a27ced11ed3823a7c8bed7fbfa2efa25131ff6a5eb084606109e4ed4ef5a43aa622f305217b6284699bf7492b5a116d43f1b8bb578f878ab70e10c4e62b7cba2

data/CHANGELOG.md

@@ -5,7 +5,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
-## [Unreleased]
+## [3.0.1] - 2024-09-23
+### Fixed
+* `document.translate_document` required a filename, this is now optional. The example in the README now works.
+
+## [3.0.0] - 2024-09-20
 Beginning with version 3, deepl-rb is officially supported by DeepL, and maintained together with [Daniel Herzog](mailto:info@danielherzog.es) the developer of earlier versions of this library.
 The change in major version is only due to the change in maintainership, there is no migration necessary from v2 to v3.
 ### Added
@@ -30,5 +34,6 @@ The change in major version is only due to the change in maintainership, there i
 * Make RequestEntityTooLarge error message more clear
 
 
-[Unreleased]: https://github.com/DeepLcom/deepl-rb/compare/v2.5.3...HEAD
+[3.0.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/DeepLcom/deepl-rb/compare/v2.5.3...v3.0.0
 [2.5.3]: https://github.com/DeepLcom/deepl-rb/compare/v2.5.2...v2.5.3

data/README.md

@@ -252,7 +252,7 @@ puts usage.character_limit
 To translate a document, use the `document.translate_document` method. Example:
 
 ```rb
-DeepL.document.translate_document('/path/to/spanish_document.pdf', 'ES', 'EN', '/path/to/translated_document.pdf')
+DeepL.document.translate_document('/path/to/spanish_document.pdf', '/path/to/translated_document.pdf', 'ES', 'EN')
 ```
 
 The lower level `upload`, `get_status` and `download` methods are also exposed, as well as the convenience method `wait_until_document_translation_finished` on the `DocumentHandle` object, which would replace `get_status`:

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.0.1

data/deepl-rb.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 3.0.0 ruby lib
+# stub: deepl-rb 3.0.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "3.0.0"
+  s.version = "3.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["DeepL SE".freeze]
-  s.date = "2024-09-20"
+  s.date = "2024-09-23"
   s.description = "Official Ruby library for the DeepL language translation API (v2). For more information, check this: https://www.deepl.com/docs/api-reference.html".freeze
   s.email = "open-source@deepl.com".freeze
   s.extra_rdoc_files = [

data/lib/deepl/document_api.rb

@@ -83,13 +83,14 @@ module DeepL
     #                             ISO 639-1, 2-letter language codes, plus a hyphen "-" with the
     #                             variant identifier for languages with variants/dialects/... .
     # @param [String, nil] filename The filename of the file, including its extension. Used to open
-    #                               the different kinds of documents (PDFs, etc).
+    #                               the different kinds of documents (PDFs, etc). If nil, will use
+    #                               the filename of +input_file_path+.
     # @param [Hash] options Additional options for the upload.
     # @param [Hash] additional_headers Additional headers for the upload.
     # @return [DeepL::Resources::DocumentTranslationStatus] Status of the document translation.
 
-    def translate_document(input_file, output_file, source_lang, target_lang, filename, # rubocop:disable Metrics/MethodLength,Metrics/ParameterLists
-                           options = {}, additional_headers = {})
+    def translate_document(input_file, output_file, source_lang, target_lang, # rubocop:disable Metrics/MethodLength,Metrics/ParameterLists
+                           filename = nil, options = {}, additional_headers = {})
       raise IOError 'File already exists at output path' if File.exist?(output_file)
 
       begin

data/spec/integration_tests/document_api_spec.rb

@@ -33,6 +33,18 @@ describe DeepL::DocumentApi do
       expect(example_document_translation(target_lang)).to eq(output_file_contents)
     end
 
+    it 'Translates a document from a filepath without a filename' do
+      File.unlink(output_document_path)
+      source_lang = default_lang_args[:source_lang]
+      target_lang = default_lang_args[:target_lang]
+      example_doc_path = example_document_path(source_lang)
+      DeepL.document.translate_document(example_doc_path, output_document_path,
+                                        source_lang, target_lang)
+      output_file_contents = File.read(output_document_path)
+
+      expect(example_document_translation(target_lang)).to eq(output_file_contents)
+    end
+
     it 'Translates a document using the lower-level methods and returns the correct status' do # rubocop:disable RSpec/ExampleLength
       File.unlink(output_document_path)
       source_lang = default_lang_args[:source_lang]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - DeepL SE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier