deepl-rb 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12e4767413ff5fc13b5b91e23cdc80c99b7252045753f7c2ef197bc4b0c0a0d2
-  data.tar.gz: 05ac02229186bc7cf8f234767f8a258b2c472e4045fa4f5c006f77bbc14314b3
+  metadata.gz: 9f9236d354e5ca92bb03e6c8f34e9b332dff42c1bd985a80193b39f7509bbf99
+  data.tar.gz: d0796f1d303279647026c81a588f1d8442b526edc9c0f7be13252fff7cbd957b
 SHA512:
-  metadata.gz: 218d0486a3ae68ab23849762976810940d8e2efb6fadc094e0b63d62e59a5c2ef06129a8a6681d8a985875a0bcf92ba4767d769826ab1a545c0a26391529808c
-  data.tar.gz: d991c7bb24a02f5c0f415bcd27c728f936a8365c20a1b91847f1cef4ba1b8031a01e23b17fe4ba7ad13aec58f6df5c2df112af2457f08a6e61cda54879cc12c9
+  metadata.gz: 9c30aea5725784be6a7766bc9d7c8a0909338937352dfbe04254341d7355f12ffad801c14364b10a8b0eefccc52dd003783e22f3b9679f65767fb664b27b710f
+  data.tar.gz: 3a4b61ebfdd6f130ec1d24a0d7ee81c7cab1b783dfb7a6e113a2af91f4240863fe727c5a054b9487e3d4bd2af011d644d15b426ae46a1c435b89ade536cc7c6a

data/README.md

@@ -71,7 +71,10 @@ puts DeepL.languages(type: :target).count
 ```
 
 All languages are also defined on the
-[official API documentation](https://www.deepl.com/docs-api/translating-text/)
+[official API documentation](https://www.deepl.com/docs-api/translating-text/).
+
+Note that target languages may include the `supports_formality` flag, which may be checked
+using the `DeepL::Resources::Language#supports_formality?`.
 
 ### Translate
 
@@ -154,6 +157,7 @@ You can capture and process exceptions that may be raised during API calls. Thes
 | `DeepL::Exceptions::LimitExceeded` | You've reached the API's call limit. |
 | `DeepL::Exceptions::QuotaExceeded` | You've reached the API's character limit. |
 | `DeepL::Exceptions::RequestError` | An unkown request error. Check `exception.response` and `exception.request` for more information. |
+| `DeepL::Exceptions::NotSupported` | The requested method or API endpoint is not supported. |
 
 An exampling of handling a generic exception:
 

data/VERSION

@@ -1 +1 @@
-2.3.1
+2.4.0

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 2.3.1 ruby lib
+# stub: deepl-rb 2.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "2.3.1"
+  s.version = "2.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Daniel Herzog".freeze]
-  s.date = "2021-09-28"
+  s.date = "2022-01-24"
   s.description = "A simple ruby wrapper for the DeepL translation API (v1). For more information, check this: https://www.deepl.com/docs/api-reference.html".freeze
   s.email = "info@danielherzog.es".freeze
   s.extra_rdoc_files = [
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
     "lib/deepl/exceptions/bad_request.rb",
     "lib/deepl/exceptions/error.rb",
     "lib/deepl/exceptions/limit_exceeded.rb",
+    "lib/deepl/exceptions/not_supported.rb",
     "lib/deepl/exceptions/quota_exceeded.rb",
     "lib/deepl/exceptions/request_error.rb",
     "lib/deepl/requests/base.rb",

data/lib/deepl/configuration.rb

@@ -18,7 +18,7 @@ module DeepL
     end
 
     def attributes
-      ATTRIBUTES.map { |attr| [attr, send(attr)] }.to_h
+      ATTRIBUTES.to_h { |attr| [attr, send(attr)] }
     end
 
     def ==(other)

data/lib/deepl/exceptions/not_supported.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DeepL
+  module Exceptions
+    class NotSupported < Error
+      def initialize(msg = 'The feature is not supported')
+        super
+      end
+    end
+  end
+end

data/lib/deepl/requests/languages.rb

@@ -16,7 +16,9 @@ module DeepL
       def build_languages(request, response)
         data = JSON.parse(response.body)
         data.map do |language|
-          Resources::Language.new(language['language'], language['name'], request, response)
+          Resources::Language.new(language['language'], language['name'],
+                                  language['supports_formality'],
+                                  request, response)
         end
       end
 

data/lib/deepl/resources/language.rb

@@ -5,16 +5,23 @@ module DeepL
     class Language < Base
       attr_reader :code, :name
 
-      def initialize(code, name, *args)
+      def initialize(code, name, supports_formality, *args)
         super(*args)
 
         @code = code
         @name = name
+        @supports_formality = supports_formality
       end
 
       def to_s
         "#{code} - #{name}"
       end
+
+      def supports_formality?
+        return @supports_formality unless @supports_formality.nil?
+
+        raise Exceptions::NotSupported, 'Support formality is only available on target languages'
+      end
     end
   end
 end

data/lib/deepl.rb

@@ -11,6 +11,7 @@ require 'deepl/exceptions/authorization_failed'
 require 'deepl/exceptions/bad_request'
 require 'deepl/exceptions/limit_exceeded'
 require 'deepl/exceptions/quota_exceeded'
+require 'deepl/exceptions/not_supported'
 
 # -- Requests
 require 'deepl/requests/base'

data/spec/resources/language_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe DeepL::Resources::Language do
-  subject { described_class.new('EN', 'English', nil, nil) }
+  subject { described_class.new('EN', 'English', nil, nil, nil) }
 
   describe '#initialize' do
     context 'When building a basic object' do
@@ -15,6 +15,28 @@ describe DeepL::Resources::Language do
         expect(subject.code).to eq('EN')
         expect(subject.name).to eq('English')
       end
+
+      it 'should not define the supports formality method' do
+        expect { subject.supports_formality? }.to raise_error(DeepL::Exceptions::NotSupported)
+      end
+    end
+
+    context 'when building a target language object' do
+      subject { described_class.new('EN', 'English', true, nil, nil) }
+
+      it 'should create a resource' do
+        expect(subject).to be_a(described_class)
+      end
+
+      it 'should assign the attributes' do
+        expect(subject.code).to eq('EN')
+        expect(subject.name).to eq('English')
+      end
+
+      it 'should include the supports formality method' do
+        expect { subject.supports_formality? }.not_to raise_error
+        expect(subject.supports_formality?).to be_truthy
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Daniel Herzog
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -62,6 +62,7 @@ files:
 - lib/deepl/exceptions/bad_request.rb
 - lib/deepl/exceptions/error.rb
 - lib/deepl/exceptions/limit_exceeded.rb
+- lib/deepl/exceptions/not_supported.rb
 - lib/deepl/exceptions/quota_exceeded.rb
 - lib/deepl/exceptions/request_error.rb
 - lib/deepl/requests/base.rb