deepl-rb 2.3.1 → 2.5.1

data/lib/deepl/resources/language_pair.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DeepL
+  module Resources
+    class LanguagePair < Base
+      attr_reader :source_lang, :target_lang
+
+      def initialize(source_lang, target_lang, *args)
+        super(*args)
+
+        @source_lang = source_lang
+        @target_lang = target_lang
+      end
+
+      def to_s
+        "#{source_lang} - #{target_lang}"
+      end
+    end
+  end
+end

data/lib/deepl.rb

@@ -11,22 +11,33 @@ require 'deepl/exceptions/authorization_failed'
 require 'deepl/exceptions/bad_request'
 require 'deepl/exceptions/limit_exceeded'
 require 'deepl/exceptions/quota_exceeded'
+require 'deepl/exceptions/not_found'
+require 'deepl/exceptions/not_supported'
 
 # -- Requests
 require 'deepl/requests/base'
+require 'deepl/requests/glossary/create'
+require 'deepl/requests/glossary/destroy'
+require 'deepl/requests/glossary/entries'
+require 'deepl/requests/glossary/find'
+require 'deepl/requests/glossary/language_pairs'
+require 'deepl/requests/glossary/list'
 require 'deepl/requests/languages'
 require 'deepl/requests/translate'
 require 'deepl/requests/usage'
 
 # -- Responses and resources
 require 'deepl/resources/base'
+require 'deepl/resources/glossary'
 require 'deepl/resources/language'
+require 'deepl/resources/language_pair'
 require 'deepl/resources/text'
 require 'deepl/resources/usage'
 
 # -- Other wrappers
 require 'deepl/api'
 require 'deepl/configuration'
+require 'deepl/glossary_api'
 
 # -- Gem interface
 module DeepL
@@ -47,6 +58,11 @@ module DeepL
     Requests::Translate.new(api, text, source_lang, target_lang, options).request
   end
 
+  def glossaries(options = {})
+    configure if @configuration.nil?
+    GlossaryApi.new(api, options)
+  end
+
   def usage(options = {})
     configure if @configuration.nil?
     Requests::Usage.new(api, options).request

data/spec/api/configuration_spec.rb

@@ -9,7 +9,7 @@ describe DeepL::Configuration do
   describe '#initialize' do
     context 'When using default configuration attributes' do
       it 'should use default attributes' do
-        expect(subject.auth_key).to eq(ENV['DEEPL_AUTH_KEY'])
+        expect(subject.auth_key).to eq(ENV.fetch('DEEPL_AUTH_KEY', nil))
         expect(subject.host).to eq('https://api.deepl.com')
         expect(subject.version).to eq('v2')
       end

data/spec/api/deepl_spec.rb

@@ -60,6 +60,26 @@ describe DeepL do
         expect(text).to be_a(DeepL::Resources::Text)
       end
     end
+
+    context 'When translating a text using a glossary' do
+      before(:each) do
+        @glossary = subject.glossaries.create('fixture', 'EN', 'ES', [%w[car auto]])
+      end
+      let(:input) { 'I wish we had a car.' }
+      let(:options) { { glossary_id: @glossary.id } }
+
+      it 'should create and call a request object' do
+        expect(DeepL::Requests::Translate).to receive(:new)
+          .with(subject.api, input, source_lang, target_lang, options).and_call_original
+        text = subject.translate(input, source_lang, target_lang, options)
+        expect(text).to be_a(DeepL::Resources::Text)
+        expect(text.text).to eq('Ojalá tuviéramos un auto.')
+      end
+
+      after(:each) do
+        subject.glossaries.destroy(@glossary.id)
+      end
+    end
   end
 
   describe '#usage' do
@@ -100,4 +120,173 @@ describe DeepL do
       end
     end
   end
+
+  describe '#glossaries' do
+    describe '#glossaries.create' do
+      let(:name) { 'Mi Glosario' }
+      let(:source_lang) { 'EN' }
+      let(:target_lang) { 'ES' }
+      let(:entries) do
+        [
+          %w[Hello Hola],
+          %w[World Mundo]
+        ]
+      end
+      let(:options) { { param: 'fake', entries_format: 'tsv' } }
+
+      around do |example|
+        subject.configure { |config| config.host = 'https://api-free.deepl.com' }
+        VCR.use_cassette('deepl_glossaries') { example.call }
+      end
+
+      context 'When creating a glossary' do
+        it 'should create and call a request object' do
+          expect(DeepL::Requests::Glossary::Create).to receive(:new)
+            .with(subject.api, name, source_lang, target_lang, entries, options).and_call_original
+
+          glossary = subject.glossaries.create(name, source_lang, target_lang, entries, options)
+          expect(glossary).to be_a(DeepL::Resources::Glossary)
+        end
+      end
+    end
+
+    describe '#glossaries.find' do
+      let(:id) { 'd9ad833f-c818-430c-a3c9-47071384fa3e' }
+      let(:options) { {} }
+
+      around do |example|
+        subject.configure { |config| config.host = 'https://api-free.deepl.com' }
+        VCR.use_cassette('deepl_glossaries') { example.call }
+      end
+
+      context 'When fetching a glossary' do
+        it 'should create and call a request object' do
+          expect(DeepL::Requests::Glossary::Find).to receive(:new)
+            .with(subject.api, id, options).and_call_original
+
+          glossary = subject.glossaries.find(id, options)
+          expect(glossary).to be_a(DeepL::Resources::Glossary)
+        end
+      end
+
+      context 'When fetching a non existing glossary' do
+        let(:id) { '00000000-0000-0000-0000-000000000000' }
+
+        it 'should raise an exception when the glossary does not exist' do
+          expect(DeepL::Requests::Glossary::Find).to receive(:new)
+            .with(subject.api, id, options).and_call_original
+          expect { subject.glossaries.find(id, options) }
+            .to raise_error(DeepL::Exceptions::NotFound)
+        end
+      end
+    end
+
+    describe '#glossaries.list' do
+      let(:options) { {} }
+
+      around do |example|
+        subject.configure { |config| config.host = 'https://api-free.deepl.com' }
+        VCR.use_cassette('deepl_glossaries') { example.call }
+      end
+
+      context 'When fetching glossaries' do
+        it 'should create and call a request object' do
+          expect(DeepL::Requests::Glossary::List).to receive(:new)
+            .with(subject.api, options).and_call_original
+
+          glossaries = subject.glossaries.list(options)
+          expect(glossaries).to all(be_a(DeepL::Resources::Glossary))
+        end
+      end
+    end
+
+    describe '#glossaries.destroy' do
+      let(:id) { 'd9ad833f-c818-430c-a3c9-47071384fa3e' }
+      let(:options) { {} }
+
+      around do |example|
+        subject.configure { |config| config.host = 'https://api-free.deepl.com' }
+        VCR.use_cassette('deepl_glossaries') { example.call }
+      end
+
+      context 'When destroy a glossary' do
+        let(:new_glossary) do
+          subject.glossaries.create('fixture', 'EN', 'ES', [%w[Hello Hola]])
+        end
+        it 'should create and call a request object' do
+          expect(DeepL::Requests::Glossary::Destroy).to receive(:new)
+            .with(subject.api, new_glossary.id, options).and_call_original
+
+          glossary_id = subject.glossaries.destroy(new_glossary.id, options)
+          expect(glossary_id).to eq(new_glossary.id)
+        end
+      end
+
+      context 'When destroying a non existing glossary' do
+        let(:id) { '00000000-0000-0000-0000-000000000000' }
+
+        it 'should raise an exception when the glossary does not exist' do
+          expect(DeepL::Requests::Glossary::Destroy).to receive(:new)
+            .with(subject.api, id, options).and_call_original
+          expect { subject.glossaries.destroy(id, options) }
+            .to raise_error(DeepL::Exceptions::NotFound)
+        end
+      end
+    end
+
+    describe '#glossaries.entries' do
+      let(:id) { '012a5576-b551-4d4c-b917-ce01bc8debb6' }
+      let(:options) { {} }
+
+      around do |example|
+        subject.configure { |config| config.host = 'https://api-free.deepl.com' }
+        VCR.use_cassette('deepl_glossaries') { example.call }
+      end
+
+      context 'When listing glossary entries' do
+        it 'should create and call a request object' do
+          expect(DeepL::Requests::Glossary::Entries).to receive(:new)
+            .with(subject.api, id, options).and_call_original
+
+          entries = subject.glossaries.entries(id, options)
+          expect(entries).to all(be_a(Array))
+          entries.each do |entry|
+            expect(entry.size).to eq(2)
+            expect(entry.first).to be_a(String)
+            expect(entry.last).to be_a(String)
+          end
+        end
+      end
+
+      context 'When listing entries of a non existing glossary' do
+        let(:id) { '00000000-0000-0000-0000-000000000000' }
+
+        it 'should raise an exception when the glossary does not exist' do
+          expect(DeepL::Requests::Glossary::Entries).to receive(:new)
+            .with(subject.api, id, options).and_call_original
+          expect { subject.glossaries.entries(id, options) }
+            .to raise_error(DeepL::Exceptions::NotFound)
+        end
+      end
+    end
+
+    describe '#glossaries.language_pairs' do
+      let(:options) { {} }
+
+      around do |example|
+        subject.configure { |config| config.host = 'https://api-free.deepl.com' }
+        VCR.use_cassette('deepl_glossaries') { example.call }
+      end
+
+      context 'When fetching language pairs supported by glossaries' do
+        it 'should create and call a request object' do
+          expect(DeepL::Requests::Glossary::LanguagePairs).to receive(:new)
+            .with(subject.api, options).and_call_original
+
+          language_pairs = subject.glossaries.language_pairs(options)
+          expect(language_pairs).to all(be_a(DeepL::Resources::LanguagePair))
+        end
+      end
+    end
+  end
 end

data/spec/fixtures/vcr_cassettes/deepl_glossaries.yml

@@ -0,0 +1,374 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api-free.deepl.com/v2/glossaries?param=fake
+    body:
+      encoding: US-ASCII
+      string: name=Mi+Glosario&source_lang=EN&target_lang=ES&entries=Hello%09Hola%0AWorld%09Mundo%0A&entries_format=tsv
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Jan 2022 00:37:04 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"glossary_id":"579859d0-0036-489f-8ad5-70c27ffcd3a9","name":"Mi Glosario","ready":true,"source_lang":"en","target_lang":"es","creation_time":"2022-01-24T00:37:04.932382+00:00","entry_count":2}'
+  recorded_at: Mon, 24 Jan 2022 00:37:05 GMT
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/glossaries/d9ad833f-c818-430c-a3c9-47071384fa3e
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Jan 2022 01:51:30 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"glossary_id":"d9ad833f-c818-430c-a3c9-47071384fa3e","name":"Mi Glosario","ready":true,"source_lang":"en","target_lang":"es","creation_time":"2022-01-23T23:01:10.073429+00:00","entry_count":2}'
+  recorded_at: Mon, 24 Jan 2022 01:51:30 GMT
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/glossaries/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Jan 2022 01:51:30 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"Not found"}'
+  recorded_at: Mon, 24 Jan 2022 01:51:30 GMT
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/glossaries
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Jan 2022 02:24:30 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"glossaries":[{"glossary_id":"012a5576-b551-4d4c-b917-ce01bc8debb6","name":"Mi
+        Glosario","ready":true,"source_lang":"en","target_lang":"es","creation_time":"2022-01-24T02:21:43.300323+00:00","entry_count":2}]}'
+  recorded_at: Mon, 24 Jan 2022 02:24:30 GMT
+- request:
+    method: delete
+    uri: https://api-free.deepl.com/v2/glossaries/c03fd58d-1a51-48c1-ad75-5a89d14e3e23
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Jan 2022 02:39:36 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+  recorded_at: Mon, 24 Jan 2022 02:39:35 GMT
+- request:
+    method: delete
+    uri: https://api-free.deepl.com/v2/glossaries/00000000-0000-0000-0000-000000000000
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Jan 2022 02:39:36 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"Not found"}'
+  recorded_at: Mon, 24 Jan 2022 02:39:36 GMT
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/glossaries/012a5576-b551-4d4c-b917-ce01bc8debb6/entries
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Jan 2022 02:52:12 GMT
+      Content-Type:
+      - text/tab-separated-values; charset=UTF-8
+      Content-Length:
+      - '22'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "Hello\tHola\nWorld\tMundo"
+  recorded_at: Mon, 24 Jan 2022 02:52:12 GMT
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/glossaries/00000000-0000-0000-0000-000000000000/entries
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Jan 2022 02:52:13 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"Not found"}'
+  recorded_at: Mon, 24 Jan 2022 02:52:12 GMT
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/glossary-language-pairs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Jan 2022 03:01:06 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"supported_languages":[{"source_lang":"de","target_lang":"en"},{"source_lang":"en","target_lang":"de"},{"source_lang":"en","target_lang":"es"},{"source_lang":"en","target_lang":"fr"},{"source_lang":"es","target_lang":"en"},{"source_lang":"fr","target_lang":"en"}]}'
+  recorded_at: Mon, 24 Jan 2022 03:01:06 GMT
+- request:
+    method: post
+    uri: https://api-free.deepl.com/v2/glossaries
+    body:
+      encoding: US-ASCII
+      string: name=fixture&source_lang=EN&target_lang=ES&entries=Hello%09Hola%0A&entries_format=tsv
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 25 Jan 2022 00:53:44 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"glossary_id":"fd53187f-2306-4f0a-aa13-00df678bd609","name":"fixture","ready":true,"source_lang":"en","target_lang":"es","creation_time":"2022-01-25T00:53:44.380234+00:00","entry_count":1}'
+  recorded_at: Tue, 25 Jan 2022 00:53:44 GMT
+- request:
+    method: delete
+    uri: https://api-free.deepl.com/v2/glossaries/fd53187f-2306-4f0a-aa13-00df678bd609
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 25 Jan 2022 00:53:44 GMT
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+  recorded_at: Tue, 25 Jan 2022 00:53:45 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/deepl_languages.yml

@@ -2,11 +2,13 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api-free.deepl.com/v2/languages?auth_key=VALID_TOKEN&type=target
+    uri: https://api-free.deepl.com/v2/languages?type=target
     body:
       encoding: US-ASCII
       string: ''
     headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept: