deepl-rb 2.0.0 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 13a3bbfea258695f87a655395197001cef339a23
-  data.tar.gz: 683f5b706dee4a5b8f23d1c02b8a081ec452e46e
+SHA256:
+  metadata.gz: 83485dc84bdce1dd11492bc0eb141825202b624e903cc747cc7bcc2f0afbc74e
+  data.tar.gz: 2f39d5af1a2926e123fa2fb1e3a3cae247546234f6382a0fc185f3e0fb5d7599
 SHA512:
-  metadata.gz: cc8cb5c628c1c146f3f29c84425205175a714301a8978db7f0c1d3559503f8d3206855502055b02021bdbe90cdcddeab9b28088c4599178e5b4271c1a539ddfe
-  data.tar.gz: e9daaaed2529971d5cd5813ff593a99a4950f559d280dee881b7fd7fc356b7fc0cfbc88a25978414e46cda54872f0180d23b848df49c7106f3867d45af1b6e19
+  metadata.gz: 44bb0eb91abfea54a199830b26abdf52b275badcf3cad7ca0a905cd2bfef7360cd3ced29690047438f263c46dfa71e2ce9c34abab09b30f4af25565aac7309d4
+  data.tar.gz: df542383415d3c0eecb848d29e01c0c1e8ef2b8d7e272ce224383251ea1ca876edb4f6cc65f8c78f9978621f918cb75e946737a9bffc2a40fc8e87506bc5e5f3

data/.circleci/config.yml

@@ -3,26 +3,14 @@ jobs:
   build:
     working_directory: ~/deepl-rb
     docker:
-    - image: circleci/ruby:2.1
+    - image: circleci/ruby:2.7
     steps:
     - checkout
 
-    # Restore bundle cache
-    - type: cache-restore
-      name: Restore bundle cache
-      key: deepl-rb-bundle-{{ checksum "Gemfile.lock" }}
-
     - run:
         name: Bundle Install
         command: bundle install --path vendor/bundle
 
-    # Store bundle cache
-    - type: cache-save
-      name: Store bundle cache
-      key: deepl-rb-bundle-{{ checksum "Gemfile.lock" }}
-      paths:
-      - vendor/bundle
-
     # Run rspec
     - type: shell
       command: |

data/.rubocop.yml

@@ -2,6 +2,7 @@
 
 AllCops:
   DisplayCopNames: true
+  NewCops: enable
   Exclude:
   - deepl-rb.gemspec
   - vendor/**/*
@@ -11,7 +12,7 @@ Metrics/BlockLength:
   - "**/*_spec.rb"
 
 Metrics/LineLength:
-  Max: 120
+  Max: 100
 
 Style/Documentation:
   Enabled: false

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 group :development do

data/README.md

@@ -1,8 +1,8 @@
-[![Gem Version](https://badge.fury.io/rb/deepl-rb.svg)](https://badge.fury.io/rb/deepl-rb) [![Dependency Status](https://gemnasium.com/badges/github.com/wikiti/deepl-rb.svg)](https://gemnasium.com/github.com/wikiti/deepl-rb) [![CircleCI](https://circleci.com/gh/wikiti/deepl-rb.svg?style=shield)](https://circleci.com/gh/wikiti/deepl-rb) [![CodeCov](https://codecov.io/gh/wikiti/deepl-rb/branch/master/graph/badge.svg?token=SHLgQNlZ4o)](https://codecov.io/gh/wikiti/deepl-rb)
+[![Gem Version](https://badge.fury.io/rb/deepl-rb.svg)](https://badge.fury.io/rb/deepl-rb) [![CircleCI](https://circleci.com/gh/wikiti/deepl-rb.svg?style=shield)](https://circleci.com/gh/wikiti/deepl-rb) [![CodeCov](https://codecov.io/gh/wikiti/deepl-rb/branch/master/graph/badge.svg?token=SHLgQNlZ4o)](https://codecov.io/gh/wikiti/deepl-rb)
 
 # DeepL for ruby
 
-A simple ruby wrapper for the [DeepL translation API (v1)](https://www.deepl.com/api.html).
+A simple ruby wrapper for the [DeepL translation API (v2)](https://www.deepl.com/api.html).
 
 ## Installation
 
@@ -35,12 +35,13 @@ DeepL.configure do |config|
 end
 ```
 
-You can also configure the api host:
+You can also configure the API host and the API version:
 
 ```rb
 DeepL.configure do |config|
   config.auth_key = 'your-api-token'
   config.host = 'https://test-api.deepl.com' # Default value is 'https://api.deepl.com'
+  config.version = 'v1' # Default value is 'v2'
 end
 ```
 
@@ -86,15 +87,18 @@ Here's a list of available language codes:
 | `DE`            | German
 | `FR`            | French
 | `ES`            | Spanish
+| `PT`            | Portuguese
 | `IT`            | Italian
 | `NL`            | Dutch
 | `PL`            | Polish
+| `RU`            | Russian
 
-You can also use custom query parameters, like `tag_handling` or `split_sentences`:
+You can also use custom query parameters, like `tag_handling`, `split_sentences`, `non_splitting_tags` or `ignore_tags`:
 
 ```rb
 translation = DeepL.translate '<p>A sample</p>', 'EN', 'ES',
-                              tag_handling: 'xml', split_sentences: false
+                              tag_handling: 'xml', split_sentences: false,
+                              non_splitting_tags: 'h1', ignore_tags: %w[code pre]
 
 puts translation.text
 # => "<p>Una muestra</p>"
@@ -104,8 +108,10 @@ The following parameters will be automatically converted:
 
 | Parameter             | Conversion
 | --------------------- | ---------------
-| `preserve_formatting` | Convertes `false` to `'0'` and `true` to `'1'`
-| `split_sentences`     | Convertes `false` to `'0'` and `true` to `'1'`
+| `preserve_formatting` | Converts `false` to `'0'` and `true` to `'1'`
+| `split_sentences`     | Converts `false` to `'0'` and `true` to `'1'`
+| `non_splitting_tags`  | Converts arrays to strings joining by commas
+| `ignore_tags`         | Converts arrays to strings joining by commas
 
 ### Usage
 
@@ -124,11 +130,12 @@ puts usage.character_limit
 
 You can capture and process exceptions that may be raised during API calls. These are all the possible exceptions:
 
-| Exception class | Descripcion |
+| Exception class | Description |
 | --------------- | ----------- |
-| `DeepL::Exceptions::AuthorizationFailed` | The authorization process has failed. Check your auth_key value. |
+| `DeepL::Exceptions::AuthorizationFailed` | The authorization process has failed. Check your `auth_key` value. |
 | `DeepL::Exceptions::BadRequest` | Something is wrong in your request. Check `exception.message` for more information. |
 | `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. |
 
 An exampling of handling a generic exception:
@@ -142,9 +149,31 @@ rescue DeepL::Exceptions::RequestError => e
   puts "Response body: #{e.response.body}"
   puts "Request body: #{e.request.body}"
 end
+```
+
+## Integrations
+
+### Ruby on Rails
+
+You may use this gem as a standalone service by creating an initializer on your
+`config/initializers` folder with your DeepL configuration. For example:
 
+```rb
+# config/initializers/deepl.rb
+DeepL.configure do |config|
+  # Your configuration goes here
+end
 ```
 
+Since the DeepL service is defined globally, you can use service anywhere in your code
+(controllers, models, views, jobs, plain ruby objects… you name it).
+
+### i18n-tasks
+
+You may also take a look at [`i18n-tasks`](https://github.com/glebm/i18n-tasks), which is a gem
+that helps you find and manage missing and unused translations. `deepl-rb` is used as one of the
+backend services to translate content.
+
 ## Development
 
 Clone the repository, and install its dependencies:
@@ -160,11 +189,3 @@ To run tests (rspec and rubocop), use
 ```
 bundle exec rake test
 ```
-
-## Contributors
-
-This project has been developed by:
-
-| Avatar | Name | Nickname | Email |
-| ------ | ---- | -------- | ----- |
-| ![](http://www.gravatar.com/avatar/2ae6d81e0605177ba9e17b19f54e6b6c.jpg?s=64)  | Daniel Herzog | Wikiti | [info@danielherzog.es](mailto:info@danielherzog.es)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.2.3

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.0.0 ruby lib
+# stub: deepl-rb 2.2.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "2.0.0"
+  s.version = "2.2.3"
 
   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 = "2018-05-08"
+  s.date = "2020-11-14"
   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 = [
@@ -22,7 +22,6 @@ Gem::Specification.new do |s|
     ".circleci/config.yml",
     ".rubocop.yml",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.md",
     "README.md",
     "Rakefile",
@@ -35,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/quota_exceeded.rb",
     "lib/deepl/exceptions/request_error.rb",
     "lib/deepl/requests/base.rb",
     "lib/deepl/requests/translate.rb",
@@ -57,17 +57,15 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/wikiti/deepl-rb".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.6.14".freeze
+  s.rubygems_version = "3.1.2".freeze
   s.summary = "A simple ruby wrapper for the DeepL API".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
-    else
-      s.add_dependency(%q<juwelier>.freeze, [">= 0"])
-    end
+  if s.respond_to? :add_runtime_dependency then
+    s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
   else
     s.add_dependency(%q<juwelier>.freeze, [">= 0"])
   end

data/lib/deepl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -- Dependencies
 require 'json'
 require 'net/http'
@@ -8,6 +10,7 @@ require 'deepl/exceptions/request_error'
 require 'deepl/exceptions/authorization_failed'
 require 'deepl/exceptions/bad_request'
 require 'deepl/exceptions/limit_exceeded'
+require 'deepl/exceptions/quota_exceeded'
 
 # -- Requests
 require 'deepl/requests/base'

data/lib/deepl/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   class API
     attr_reader :configuration

data/lib/deepl/configuration.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module DeepL
   class Configuration
-    ATTRIBUTES = %i[auth_key host].freeze
+    ATTRIBUTES = %i[auth_key host version].freeze
 
     attr_accessor(*ATTRIBUTES)
 
@@ -8,6 +10,7 @@ module DeepL
       data.each { |key, value| send("#{key}=", value) }
       @auth_key ||= ENV['DEEPL_AUTH_KEY']
       @host ||= 'https://api.deepl.com'
+      @version ||= 'v2'
     end
 
     def validate!

data/lib/deepl/exceptions/authorization_failed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class AuthorizationFailed < RequestError

data/lib/deepl/exceptions/bad_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class BadRequest < RequestError

data/lib/deepl/exceptions/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class Error < StandardError

data/lib/deepl/exceptions/limit_exceeded.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class LimitExceeded < RequestError

data/lib/deepl/exceptions/quota_exceeded.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DeepL
+  module Exceptions
+    class QuotaExceeded < RequestError
+      def message
+        'Quota exceeded. The character limit has been reached.'
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/request_error.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class RequestError < Error
       attr_reader :request, :response
 
       def initialize(request, response)
+        super()
         @request = request
         @response = response
       end
 
       def message
-        'Unkown error.'
+        'Unknown error.'
       end
     end
   end

data/lib/deepl/requests/base.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 module DeepL
   module Requests
     class Base
-      API_VERSION = 'v1'.freeze
-
       attr_reader :api, :response, :options
 
       def initialize(api, options = {})
@@ -34,7 +34,7 @@ module DeepL
 
       def post(payload)
         request = Net::HTTP::Post.new(uri.request_uri)
-        request.set_form_data(payload.reject { |_, v| v.nil? })
+        request.set_form_data(payload.compact)
         response = http.request(request)
 
         validate_response!(request, response)
@@ -64,6 +64,7 @@ module DeepL
         when '400' then raise Exceptions::BadRequest.new(request, response)
         when '403' then raise Exceptions::AuthorizationFailed.new(request, response)
         when '429' then raise Exceptions::LimitExceeded.new(request, response)
+        when '456' then raise Exceptions::QuotaExceeded.new(request, response)
         else raise Exceptions::RequestError.new(request, response)
         end
       end
@@ -73,7 +74,7 @@ module DeepL
       end
 
       def url
-        "#{host}/#{API_VERSION}/#{path}"
+        "#{host}/#{api.configuration.version}/#{path}"
       end
 
       def uri

data/lib/deepl/requests/translate.rb

@@ -1,12 +1,18 @@
+# frozen_string_literal: true
+
 module DeepL
   module Requests
     class Translate < Base
+      BOOLEAN_CONVERSION = { true => '1', false => '0' }.freeze
+      ARRAY_CONVERSION = ->(value) { value.is_a?(Array) ? value.join(', ') : value }.freeze
       OPTIONS_CONVERSIONS = {
-        split_sentences: { true => '1', false => '0' },
-        preserve_formatting: { true => '1', false => '0' }
+        split_sentences: BOOLEAN_CONVERSION,
+        preserve_formatting: BOOLEAN_CONVERSION,
+        non_splitting_tags: ARRAY_CONVERSION,
+        ignore_tags: ARRAY_CONVERSION
       }.freeze
 
-      attr_reader :text, :source_lang, :target_lang
+      attr_reader :text, :source_lang, :target_lang, :ignore_tags, :non_splitting_tags
 
       def initialize(api, text, source_lang, target_lang, options = {})
         super(api, options)
@@ -27,6 +33,7 @@ module DeepL
       def tweak_parameters!
         OPTIONS_CONVERSIONS.each do |param, converter|
           next unless option?(param) && converter[option(param)]
+
           set_option(param, converter[option(param)])
         end
       end

data/lib/deepl/requests/usage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Requests
     class Usage < Base

data/lib/deepl/resources/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Resources
     class Base

data/lib/deepl/resources/text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Resources
     class Text < Base

data/lib/deepl/resources/usage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Resources
     class Usage < Base

data/spec/api/api_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::API do

data/spec/api/configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::Configuration do
@@ -9,15 +11,17 @@ describe DeepL::Configuration do
       it 'should use default attributes' do
         expect(subject.auth_key).to eq(ENV['DEEPL_AUTH_KEY'])
         expect(subject.host).to eq('https://api.deepl.com')
+        expect(subject.version).to eq('v2')
       end
     end
 
     context 'When using custom configuration attributes' do
-      let(:attributes) { { auth_key: 'SAMPLE', host: 'http://www.example.org' } }
+      let(:attributes) { { auth_key: 'SAMPLE', host: 'http://www.example.org', version: 'v1' } }
 
       it 'should use custom attributes' do
         expect(subject.auth_key).to eq(attributes[:auth_key])
         expect(subject.host).to eq(attributes[:host])
+        expect(subject.version).to eq(attributes[:version])
       end
     end
   end

data/spec/api/deepl_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL do
@@ -15,12 +17,13 @@ describe DeepL do
 
     context 'When providing a valid configuration' do
       let(:configuration) do
-        DeepL::Configuration.new(auth_key: 'VALID', host: 'http://www.example.org')
+        DeepL::Configuration.new(auth_key: 'VALID', host: 'http://www.example.org', version: 'v1')
       end
       before do
         subject.configure do |config|
           config.auth_key = configuration.auth_key
           config.host = configuration.host
+          config.version = configuration.version
         end
       end
 

data/spec/fixtures/vcr_cassettes/deepl_translate.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN&param=fake
+    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN&param=fake
     body:
       encoding: US-ASCII
       string: text=Sample&source_lang=EN&target_lang=ES
@@ -35,6 +35,6 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"Muestra"}]}'
-    http_version: 
+    http_version:
   recorded_at: Tue, 08 May 2018 16:31:33 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/deepl_usage.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.deepl.com/v1/usage?auth_key=VALID_TOKEN
+    uri: https://api.deepl.com/v2/usage?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
+    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: text=Sample+text&source_lang=EN&target_lang=ES
@@ -34,12 +34,13 @@ http_interactions:
       - "*"
     body:
       encoding: UTF-8
-      string: '{"translations":[{"detected_source_language":"EN","text":"Texto de muestra"}]}'
-    http_version:
+      string: '{"translations":[{"detected_source_language":"EN","text":"Texto de
+        muestra"}]}'
+    http_version: 
   recorded_at: Tue, 08 May 2018 16:31:34 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
+    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: text=Sample&text=Word&source_lang=EN&target_lang=ES
@@ -72,11 +73,11 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"Muestra"},{"detected_source_language":"EN","text":"Palabra"}]}'
-    http_version:
+    http_version: 
   recorded_at: Tue, 08 May 2018 16:31:35 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
+    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: text=%3Cp%3ESample+text%3C%2Fp%3E&source_lang=EN&target_lang=ES
@@ -110,11 +111,11 @@ http_interactions:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"<p>Texto
         de muestra</p>"}]}'
-    http_version:
+    http_version: 
   recorded_at: Tue, 08 May 2018 16:31:36 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=invalid
+    uri: https://api.deepl.com/v2/translate?auth_key=invalid
     body:
       encoding: US-ASCII
       string: text=Sample+text&source_lang=EN&target_lang=ES
@@ -143,11 +144,11 @@ http_interactions:
     body:
       encoding: UTF-8
       string: ''
-    http_version:
+    http_version: 
   recorded_at: Tue, 08 May 2018 16:31:37 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
+    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: source_lang=EN&target_lang=ES
@@ -176,11 +177,11 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"message":"Parameter ''text'' not specified."}'
-    http_version:
+    http_version: 
   recorded_at: Tue, 08 May 2018 16:31:37 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
+    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: text=Sample+text&source_lang=EN
@@ -209,6 +210,44 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"message":"Parameter ''target_lang'' not specified."}'
-    http_version:
+    http_version: 
   recorded_at: Tue, 08 May 2018 16:31:37 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN&ignore_tags=code,%20span
+    body:
+      encoding: US-ASCII
+      string: text=Welcome+and+%3Ccode%3EHello+great+World%3C%2Fcode%3E+Good+Morning%21&source_lang=EN&target_lang=ES
+    headers:
+      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: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 24 Jul 2018 16:13:51 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '119'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IkJpZW52ZW5pZG8geSA8Y29kZT5IZWxsbyBncmVhdCBXb3JsZDwvY29kZT4gQnVlbm9zIGTDrWFzISJ9XX0=
+    http_version: 
+  recorded_at: Tue, 24 Jul 2018 16:13:49 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/usage.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.deepl.com/v1/usage?auth_key=VALID_TOKEN
+    uri: https://api.deepl.com/v2/usage?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: ''

data/spec/requests/translate_spec.rb

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::Requests::Translate do
+  let(:tags_str) { 'p, strong, span' }
+  let(:tags_array) { %w[p strong span] }
+
   let(:api) { build_deepl_api }
   let(:text) { 'Sample text' }
   let(:source_lang) { 'EN' }
   let(:target_lang) { 'ES' }
-  subject { DeepL::Requests::Translate.new(api, text, source_lang, target_lang) }
+  let(:options) { {} }
+  subject { DeepL::Requests::Translate.new(api, text, source_lang, target_lang, options) }
 
   describe '#initialize' do
     context 'When building a request' do
@@ -14,6 +20,60 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'when using `non_splitting_tags` options' do
+      it 'should work with a nil values' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, non_splitting_tags: nil)
+        expect(request.options[:non_splitting_tags]).to eq(nil)
+      end
+
+      it 'should work with a blank list' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, non_splitting_tags: '')
+        expect(request.options[:non_splitting_tags]).to eq('')
+      end
+
+      it 'should work with a comma-separated list' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, non_splitting_tags: tags_str)
+        expect(request.options[:non_splitting_tags]).to eq(tags_str)
+      end
+
+      it 'should convert arrays to strings' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, non_splitting_tags: tags_array)
+        expect(request.options[:non_splitting_tags]).to eq(tags_str)
+      end
+
+      it 'should leave strings as they are' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, non_splitting_tags: tags_str)
+        expect(request.options[:non_splitting_tags]).to eq(tags_str)
+      end
+    end
+
+    context 'when using `ignore_tags` options' do
+      it 'should work with a nil values' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, ignore_tags: nil)
+        expect(request.options[:ignore_tags]).to eq(nil)
+      end
+
+      it 'should work with a blank list' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, ignore_tags: '')
+        expect(request.options[:ignore_tags]).to eq('')
+      end
+
+      it 'should work with a comma-separated list' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, ignore_tags: tags_str)
+        expect(request.options[:ignore_tags]).to eq(tags_str)
+      end
+
+      it 'should convert arrays to strings' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, ignore_tags: tags_array)
+        expect(request.options[:ignore_tags]).to eq(tags_str)
+      end
+
+      it 'should leave strings as they are' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, ignore_tags: tags_str)
+        expect(request.options[:ignore_tags]).to eq(tags_str)
+      end
+    end
+
     context 'when using `split_sentences` options' do
       it 'should convert `true` to `1`' do
         request = DeepL::Requests::Translate.new(api, nil, nil, nil, split_sentences: true)
@@ -101,6 +161,19 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'When performing a valid request and passing a variable' do
+      let(:text) { 'Welcome and <code>Hello great World</code> Good Morning!' }
+      let(:options) { { ignore_tags: 'code, span' } }
+
+      it 'should return a text object' do
+        text = subject.request
+
+        expect(text).to be_a(DeepL::Resources::Text)
+        expect(text.text).to eq('Bienvenido y <code>Hello great World</code> Buenos días!')
+        expect(text.detected_source_language).to eq('EN')
+      end
+    end
+
     context 'When performing a bad request' do
       context 'When using an invalid token' do
         let(:api) do

data/spec/requests/usage_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::Requests::Usage do

data/spec/resources/text_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::Resources::Text do

data/spec/resources/usage_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::Resources::Usage do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Coverage
 require 'simplecov'
 SimpleCov.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.3
 platform: ruby
 authors:
 - Daniel Herzog
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -36,7 +36,6 @@ files:
 - ".circleci/config.yml"
 - ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
@@ -49,6 +48,7 @@ files:
 - lib/deepl/exceptions/bad_request.rb
 - lib/deepl/exceptions/error.rb
 - lib/deepl/exceptions/limit_exceeded.rb
+- lib/deepl/exceptions/quota_exceeded.rb
 - lib/deepl/exceptions/request_error.rb
 - lib/deepl/requests/base.rb
 - lib/deepl/requests/translate.rb
@@ -72,7 +72,7 @@ homepage: http://github.com/wikiti/deepl-rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,9 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A simple ruby wrapper for the DeepL API
 test_files: []

data/Gemfile.lock

@@ -1,113 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.3.0)
-    builder (3.2.3)
-    codecov (0.1.10)
-      json
-      simplecov
-      url
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    faraday (0.12.2)
-      multipart-post (>= 1.2, < 3)
-    git (1.3.0)
-    github_api (0.18.2)
-      addressable (~> 2.4)
-      descendants_tracker (~> 0.0.4)
-      faraday (~> 0.8)
-      hashie (~> 3.5, >= 3.5.2)
-      oauth2 (~> 1.0)
-    hashdiff (0.3.7)
-    hashie (3.5.7)
-    highline (1.7.10)
-    json (2.1.0)
-    juwelier (2.1.3)
-      builder
-      bundler (>= 1.13)
-      git (>= 1.2.5)
-      github_api
-      highline (>= 1.6.15)
-      nokogiri (>= 1.5.10)
-      rake
-      rdoc
-      semver
-    jwt (1.5.6)
-    mini_portile2 (2.3.0)
-    multi_json (1.12.2)
-    multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
-    oauth2 (1.4.0)
-      faraday (>= 0.8, < 0.13)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    parallel (1.12.1)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    powerpack (0.1.1)
-    public_suffix (3.0.1)
-    rack (1.6.8)
-    rainbow (3.0.0)
-    rake (12.3.0)
-    rdoc (5.1.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    rubocop (0.52.1)
-      parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    safe_yaml (1.0.4)
-    semver (1.0.1)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    unicode-display_width (1.3.0)
-    url (0.3.2)
-    vcr (4.0.0)
-    webmock (3.2.1)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  codecov
-  juwelier
-  rspec
-  rubocop
-  simplecov
-  vcr
-  webmock
-
-BUNDLED WITH
-   1.16.0.pre.2