deepl-rb 2.5.3 → 3.0.0

data/spec/resources/usage_spec.rb

@@ -1,31 +1,34 @@
+# Copyright 2018 Daniel Herzog
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
 # frozen_string_literal: true
 
 require 'spec_helper'
 
 describe DeepL::Resources::Usage do
-  subject { described_class.new(3, 5, nil, nil) }
+  subject(:usage) { described_class.new(3, 5, nil, nil) }
 
   describe '#initialize' do
-    context 'When building a basic object' do
-      it 'should create a resource' do
-        expect(subject).to be_a(described_class)
+    context 'when building a basic object' do
+      it 'creates a resource' do
+        expect(usage).to be_a(described_class)
       end
 
-      it 'should assign the attributes' do
-        expect(subject.character_count).to eq(3)
-        expect(subject.character_limit).to eq(5)
+      it 'assigns the attributes' do
+        expect(usage.character_count).to eq(3)
+        expect(usage.character_limit).to eq(5)
       end
 
-      it 'should not exceed the quota' do
-        expect(subject.quota_exceeded?).to be_falsey
+      it 'does not exceed the quota' do
+        expect(usage).not_to be_quota_exceeded
       end
     end
 
-    context 'When building a quota exceeded object' do
-      subject { described_class.new(5, 5, nil, nil) }
+    context 'when building a quota exceeded object' do
+      subject(:usage) { described_class.new(5, 5, nil, nil) }
 
-      it 'should exceed the quota' do
-        expect(subject.quota_exceeded?).to be_truthy
+      it 'exceeds the quota' do
+        expect(usage).to be_quota_exceeded
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,18 +1,56 @@
+# Copyright 2018 Daniel Herzog
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
 # frozen_string_literal: true
 
 # Coverage
 require 'simplecov'
 SimpleCov.start
 
-require 'codecov'
-SimpleCov.formatter = SimpleCov::Formatter::Codecov
+require 'simplecov-cobertura'
+SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
 
 # Load lib
 require_relative '../lib/deepl'
+require_relative 'integration_tests/integration_test_utils'
 
 # Lib config
 ENV['DEEPL_AUTH_KEY'] ||= 'TEST-TOKEN'
 
+# General helpers
+def build_deepl_api
+  DeepL::API.new(DeepL::Configuration.new)
+end
+
+uri_ignoring_deepl_api_subdomain = lambda do |request1, request2|
+  deepl_api_regexp = %r{https?://api.*\.deepl\.com/}
+  uri1 = request1.uri
+  uri2 = request2.uri
+  uri1_match = uri1.match(deepl_api_regexp)
+  uri2_match = uri2.match(deepl_api_regexp)
+  if uri1_match && uri2_match
+    uri1_without_deepl_domain = uri1.gsub(uri1_match[0], '')
+    uri2_without_deepl_domain = uri2.gsub(uri2_match[0], '')
+    uri1_without_deepl_domain == uri2_without_deepl_domain
+  else
+    uri1 == uri2
+  end
+end
+
+headers_ignoring_user_agent = lambda do |request1, request2|
+  user_agent_key = 'User-Agent'
+  # Pass by reference, so we need to use a copy of the headers
+  headers1 = request1.headers.dup
+  headers2 = request2.headers.dup
+  headers1_has_user_agent = headers1.key?(user_agent_key)
+  headers2_has_user_agent = headers2.key?(user_agent_key)
+  return false if headers1_has_user_agent != headers2_has_user_agent
+
+  headers1.delete(user_agent_key)
+  headers2.delete(user_agent_key)
+  headers1 == headers2
+end
+
 # VCR tapes configuration
 require 'vcr'
 VCR.configure do |config|
@@ -20,12 +58,31 @@ VCR.configure do |config|
   config.hook_into :webmock
   config.filter_sensitive_data('VALID_TOKEN') { ENV.fetch('DEEPL_AUTH_KEY', nil) }
   config.default_cassette_options = {
+    # Uncomment this line when adding new tests, run the tests once, then comment it again
     # record: :new_episodes,
-    match_requests_on: %i[method uri body headers]
+    match_requests_on: [:method, uri_ignoring_deepl_api_subdomain, :body,
+                        headers_ignoring_user_agent]
   }
 end
 
-# General helpers
-def build_deepl_api
-  DeepL::API.new(DeepL::Configuration.new(host: 'https://api-free.deepl.com'))
+# Test helpers
+
+def replace_env_preserving_deepl_vars
+  env_auth_key = ENV.fetch('DEEPL_AUTH_KEY', false)
+  env_server_url = ENV.fetch('DEEPL_SERVER_URL', false)
+  env_mock_server_port = ENV.fetch('DEEPL_MOCK_SERVER_PORT', false)
+  tmp_env = ENV.to_hash
+  ENV.clear
+  ENV['DEEPL_AUTH_KEY'] = (env_auth_key || 'VALID')
+  ENV['DEEPL_SERVER_URL'] = (env_server_url || '')
+  ENV['DEEPL_MOCK_SERVER_PORT'] = (env_mock_server_port || '')
+  tmp_env
+end
+
+def replace_env_preserving_deepl_vars_except_mock_server
+  env_auth_key = ENV.fetch('DEEPL_AUTH_KEY', false)
+  tmp_env = ENV.to_hash
+  ENV.clear
+  ENV['DEEPL_AUTH_KEY'] = (env_auth_key || 'VALID')
+  tmp_env
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 3.0.0
 platform: ruby
 authors:
-- Daniel Herzog
+- DeepL SE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -38,28 +38,38 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'A simple ruby wrapper for the DeepL translation API (v1). For more information,
-  check this: https://www.deepl.com/docs/api-reference.html'
-email: info@danielherzog.es
+description: 'Official Ruby library for the DeepL language translation API (v2). For
+  more information, check this: https://www.deepl.com/docs/api-reference.html'
+email: open-source@deepl.com
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE.md
 - README.md
+- license_checker.sh
 files:
 - ".circleci/config.yml"
+- ".github/workflows/add_issues_to_kanban.yml"
+- ".gitlab-ci.yml"
 - ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.md
 - README.md
 - Rakefile
+- SECURITY.md
 - VERSION
 - deepl-rb.gemspec
 - lib/deepl.rb
 - lib/deepl/api.rb
 - lib/deepl/configuration.rb
+- lib/deepl/document_api.rb
 - lib/deepl/exceptions/authorization_failed.rb
 - lib/deepl/exceptions/bad_request.rb
+- lib/deepl/exceptions/document_translation_error.rb
 - lib/deepl/exceptions/error.rb
 - lib/deepl/exceptions/limit_exceeded.rb
 - lib/deepl/exceptions/not_found.rb
@@ -67,8 +77,12 @@ files:
 - lib/deepl/exceptions/quota_exceeded.rb
 - lib/deepl/exceptions/request_entity_too_large.rb
 - lib/deepl/exceptions/request_error.rb
+- lib/deepl/exceptions/server_error.rb
 - lib/deepl/glossary_api.rb
 - lib/deepl/requests/base.rb
+- lib/deepl/requests/document/download.rb
+- lib/deepl/requests/document/get_status.rb
+- lib/deepl/requests/document/upload.rb
 - lib/deepl/requests/glossary/create.rb
 - lib/deepl/requests/glossary/destroy.rb
 - lib/deepl/requests/glossary/entries.rb
@@ -79,15 +93,22 @@ files:
 - lib/deepl/requests/translate.rb
 - lib/deepl/requests/usage.rb
 - lib/deepl/resources/base.rb
+- lib/deepl/resources/document_handle.rb
+- lib/deepl/resources/document_translation_status.rb
 - lib/deepl/resources/glossary.rb
 - lib/deepl/resources/language.rb
 - lib/deepl/resources/language_pair.rb
 - lib/deepl/resources/text.rb
 - lib/deepl/resources/usage.rb
+- lib/deepl/utils/backoff_timer.rb
 - lib/deepl/utils/exception_builder.rb
+- lib/http_client_options.rb
+- license_checker.sh
 - spec/api/api_spec.rb
 - spec/api/configuration_spec.rb
 - spec/api/deepl_spec.rb
+- spec/fixtures/vcr_cassettes/deepl_document.yml
+- spec/fixtures/vcr_cassettes/deepl_document_download.yml
 - spec/fixtures/vcr_cassettes/deepl_glossaries.yml
 - spec/fixtures/vcr_cassettes/deepl_languages.yml
 - spec/fixtures/vcr_cassettes/deepl_translate.yml
@@ -96,6 +117,8 @@ files:
 - spec/fixtures/vcr_cassettes/languages.yml
 - spec/fixtures/vcr_cassettes/translate_texts.yml
 - spec/fixtures/vcr_cassettes/usage.yml
+- spec/integration_tests/document_api_spec.rb
+- spec/integration_tests/integration_test_utils.rb
 - spec/requests/glossary/create_spec.rb
 - spec/requests/glossary/destroy_spec.rb
 - spec/requests/glossary/entries_spec.rb
@@ -111,7 +134,7 @@ files:
 - spec/resources/text_spec.rb
 - spec/resources/usage_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/wikiti/deepl-rb
+homepage: https://github.com/DeepLcom/deepl-rb
 licenses:
 - MIT
 metadata: {}
@@ -130,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
-summary: A simple ruby wrapper for the DeepL API
+summary: Official Ruby library for the DeepL language translation API.
 test_files: []