deepl-rb 1.0.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37163389ddd5655c4c9f1d1e60e0d414e3c35420
-  data.tar.gz: 881b3877774bc62cf3f42900c72d336c7b32583d
+  metadata.gz: 45fd2b316644d0fb624c9bcaadea7524c08933d1
+  data.tar.gz: d79aa178b64a3a302e6fd4e82196fdca1a8bb85a
 SHA512:
-  metadata.gz: d63335bb2ec23d724e77dba606844c711afbc798afe8c7a64f12a420e14561c33c555f36716f7d3537f8f234bed064d8d72aa659837a99b442952186813718cb
-  data.tar.gz: 944992d82a26e096f4389cbc50dd076c80b7d6c58113c84401539e20b8620dcac21ac362730fb3a3b862d97658b70e565911f69fc3c13e2b1f6b26580cb697b7
+  metadata.gz: 6d28b5d519aa43971e13af3675b67a58825f30674f75af82491dd2f2e7f59727fd95d5860ba4d9638fe88ff286a316420695d75dba65601e4e1f29ab78e79e0f
+  data.tar.gz: b33fd1cf048c8ace82ea10d5a15007a2e97b57ec677760da1ba22207655aa190867f81e8c658550963f1d6b0efb03b20d0053b5dd3c95d4f3ea8d6629d1e2d6f

data/.rubocop.yml

@@ -11,7 +11,7 @@ Metrics/BlockLength:
   - "**/*_spec.rb"
 
 Metrics/LineLength:
-  Max: 120
+  Max: 100
 
 Style/Documentation:
   Enabled: false

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/docs/api-reference.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,28 +87,55 @@ 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`:
+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: true
+translation = DeepL.translate '<p>A sample</p>', 'EN', 'ES',
+                              tag_handling: 'xml', split_sentences: false,
+                              non_splitting_tags: 'h1', ignore_tags: %w[code pre]
 
 puts translation.text
 # => "<p>Una muestra</p>"
 ```
 
+The following parameters will be automatically converted:
+
+| Parameter             | Conversion
+| --------------------- | ---------------
+| `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
+
+To check current API usage, use:
+
+```rb
+usage = DeepL.usage
+
+puts usage.character_count
+# => 180118
+puts usage.character_limit
+# => 1250000
+```
+
 ### Handle exceptions
 
 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:
@@ -121,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 the
+backend services to translate content.
+
 ## Development
 
 Clone the repository, and install its dependencies:

data/VERSION

@@ -1 +1 @@
-1.0.1
+2.2.2

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 1.0.1 ruby lib
+# stub: deepl-rb 2.2.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "1.0.1"
+  s.version = "2.2.2"
 
   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-03-31"
+  s.date = "2020-06-18"
   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 = [
@@ -35,23 +35,30 @@ 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_text.rb",
+    "lib/deepl/requests/translate.rb",
+    "lib/deepl/requests/usage.rb",
     "lib/deepl/resources/base.rb",
     "lib/deepl/resources/text.rb",
+    "lib/deepl/resources/usage.rb",
     "spec/api/api_spec.rb",
     "spec/api/configuration_spec.rb",
     "spec/api/deepl_spec.rb",
     "spec/fixtures/vcr_cassettes/deepl_translate.yml",
+    "spec/fixtures/vcr_cassettes/deepl_usage.yml",
     "spec/fixtures/vcr_cassettes/translate_texts.yml",
-    "spec/requests/translate_text_spec.rb",
+    "spec/fixtures/vcr_cassettes/usage.yml",
+    "spec/requests/translate_spec.rb",
+    "spec/requests/usage_spec.rb",
     "spec/resources/text_spec.rb",
+    "spec/resources/usage_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/wikiti/deepl-rb".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.6.13".freeze
+  s.rubygems_version = "2.6.14".freeze
   s.summary = "A simple ruby wrapper for the DeepL API".freeze
 
   if s.respond_to? :specification_version then

data/lib/deepl.rb

@@ -8,14 +8,17 @@ 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'
-require 'deepl/requests/translate_text'
+require 'deepl/requests/translate'
+require 'deepl/requests/usage'
 
 # -- Responses and resources
 require 'deepl/resources/base'
 require 'deepl/resources/text'
+require 'deepl/resources/usage'
 
 # -- Other wrappers
 require 'deepl/api'
@@ -33,7 +36,12 @@ module DeepL
 
   def translate(text, source_lang, target_lang, options = {})
     configure if @configuration.nil?
-    Requests::TranslateText.new(api, text, source_lang, target_lang, options).request
+    Requests::Translate.new(api, text, source_lang, target_lang, options).request
+  end
+
+  def usage(options = {})
+    configure if @configuration.nil?
+    Requests::Usage.new(api, options).request
   end
 
   # -- Configuration

data/lib/deepl/configuration.rb

@@ -1,6 +1,6 @@
 module DeepL
   class Configuration
-    ATTRIBUTES = %i[auth_key host].freeze
+    ATTRIBUTES = %i[auth_key host version].freeze
 
     attr_accessor(*ATTRIBUTES)
 
@@ -8,6 +8,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/quota_exceeded.rb

@@ -0,0 +1,9 @@
+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

@@ -9,7 +9,7 @@ module DeepL
       end
 
       def message
-        'Unkown error.'
+        'Unknown error.'
       end
     end
   end

data/lib/deepl/requests/base.rb

@@ -1,8 +1,6 @@
 module DeepL
   module Requests
     class Base
-      API_VERSION = 'v1'.freeze
-
       attr_reader :api, :response, :options
 
       def initialize(api, options = {})
@@ -16,10 +14,22 @@ module DeepL
 
       private
 
+      def option?(name)
+        options.key?(name.to_s) || options.key?(name.to_sym)
+      end
+
       def option(name)
         options[name.to_s] || options[name.to_sym]
       end
 
+      def set_option(name, value)
+        if options.key?(name.to_sym)
+          options[name.to_sym] = value
+        else
+          options[name.to_s] = value
+        end
+      end
+
       def post(payload)
         request = Net::HTTP::Post.new(uri.request_uri)
         request.set_form_data(payload.reject { |_, v| v.nil? })
@@ -29,6 +39,14 @@ module DeepL
         [request, response]
       end
 
+      def get
+        request = Net::HTTP::Get.new(uri.request_uri)
+        response = http.request(request)
+
+        validate_response!(request, response)
+        [request, response]
+      end
+
       def http
         @http ||= begin
           http = Net::HTTP.new(uri.host, uri.port)
@@ -44,6 +62,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
@@ -53,7 +72,7 @@ module DeepL
       end
 
       def url
-        "#{host}/#{API_VERSION}/#{path}"
+        "#{host}/#{api.configuration.version}/#{path}"
       end
 
       def uri

data/lib/deepl/requests/{translate_text.rb → translate.rb}

@@ -1,13 +1,24 @@
 module DeepL
   module Requests
-    class TranslateText < Base
-      attr_reader :text, :source_lang, :target_lang
+    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: BOOLEAN_CONVERSION,
+        preserve_formatting: BOOLEAN_CONVERSION,
+        non_splitting_tags: ARRAY_CONVERSION,
+        ignore_tags: ARRAY_CONVERSION
+      }.freeze
+
+      attr_reader :text, :source_lang, :target_lang, :ignore_tags, :non_splitting_tags
 
       def initialize(api, text, source_lang, target_lang, options = {})
         super(api, options)
         @text = text
         @source_lang = source_lang
         @target_lang = target_lang
+
+        tweak_parameters!
       end
 
       def request
@@ -17,6 +28,13 @@ module DeepL
 
       private
 
+      def tweak_parameters!
+        OPTIONS_CONVERSIONS.each do |param, converter|
+          next unless option?(param) && converter[option(param)]
+          set_option(param, converter[option(param)])
+        end
+      end
+
       def build_texts(request, response)
         data = JSON.parse(response.body)
 

data/lib/deepl/requests/usage.rb

@@ -0,0 +1,24 @@
+module DeepL
+  module Requests
+    class Usage < Base
+      def initialize(api, options = {})
+        super(api, options)
+      end
+
+      def request
+        build_usage(*get)
+      end
+
+      private
+
+      def build_usage(request, response)
+        data = JSON.parse(response.body)
+        Resources::Usage.new(data['character_count'], data['character_limit'], request, response)
+      end
+
+      def path
+        'usage'
+      end
+    end
+  end
+end

data/lib/deepl/resources/usage.rb

@@ -0,0 +1,22 @@
+module DeepL
+  module Resources
+    class Usage < Base
+      attr_reader :character_count, :character_limit
+
+      def initialize(character_count, character_limit, *args)
+        super(*args)
+
+        @character_count = character_count
+        @character_limit = character_limit
+      end
+
+      def to_s
+        "#{character_count} / #{character_limit}"
+      end
+
+      def quota_exceeded?
+        character_count >= character_limit
+      end
+    end
+  end
+end

data/spec/api/configuration_spec.rb

@@ -9,15 +9,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

@@ -15,12 +15,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
 
@@ -49,7 +50,7 @@ describe DeepL do
 
     context 'When translating a text' do
       it 'should create and call a request object' do
-        expect(DeepL::Requests::TranslateText).to receive(:new)
+        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)
@@ -57,4 +58,22 @@ describe DeepL do
       end
     end
   end
+
+  describe '#usage' do
+    let(:options) { {} }
+
+    around do |example|
+      VCR.use_cassette('deepl_usage') { example.call }
+    end
+
+    context 'When checking usage' do
+      it 'should create and call a request object' do
+        expect(DeepL::Requests::Usage).to receive(:new)
+          .with(subject.api, options).and_call_original
+
+        usage = subject.usage(options)
+        expect(usage).to be_a(DeepL::Resources::Usage)
+      end
+    end
+  end
 end

data/spec/fixtures/vcr_cassettes/deepl_translate.yml

@@ -2,114 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
-    body:
-      encoding: US-ASCII
-      string: 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: 400
-      message: Bad Request
-    headers:
-      Server:
-      - nginx
-      Date:
-      - Sun, 10 Dec 2017 21:20:25 GMT
-      Content-Length:
-      - '45'
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: '{"message":"Parameter ''text'' not specified."}'
-    http_version: 
-  recorded_at: Sun, 10 Dec 2017 21:20:25 GMT
-- request:
-    method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
-    body:
-      encoding: US-ASCII
-      string: text=Abc&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:
-      - Sun, 10 Dec 2017 21:21:23 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '65'
-      Connection:
-      - keep-alive
-      Access-Control-Allow-Origin:
-      - "*"
-    body:
-      encoding: UTF-8
-      string: '{"translations":[{"detected_source_language":"EN","text":"ABC"}]}'
-    http_version: 
-  recorded_at: Sun, 10 Dec 2017 21:21:23 GMT
-- request:
-    method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
-    body:
-      encoding: US-ASCII
-      string: text=Sample&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:
-      - Sun, 10 Dec 2017 21:22:11 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '69'
-      Connection:
-      - keep-alive
-      Access-Control-Allow-Origin:
-      - "*"
-    body:
-      encoding: UTF-8
-      string: '{"translations":[{"detected_source_language":"EN","text":"Muestra"}]}'
-    http_version: 
-  recorded_at: Sun, 10 Dec 2017 21:22:11 GMT
-- 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
@@ -130,7 +23,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Thu, 04 Jan 2018 18:08:31 GMT
+      - Tue, 08 May 2018 16:31:34 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -142,6 +35,6 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"Muestra"}]}'
-    http_version: 
-  recorded_at: Thu, 04 Jan 2018 18:08:31 GMT
+    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

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.deepl.com/v2/usage?auth_key=VALID_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      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:
+      - Tue, 08 May 2018 16:31:35 GMT
+      Content-Length:
+      - '52'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"character_count":802127,"character_limit":1000000}'
+    http_version: 
+  recorded_at: Tue, 08 May 2018 16:31:33 GMT
+recorded_with: VCR 4.0.0

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
@@ -23,11 +23,11 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Sun, 10 Dec 2017 20:34:26 GMT
+      - Tue, 08 May 2018 16:31:36 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '78'
+      - '74'
       Connection:
       - keep-alive
       Access-Control-Allow-Origin:
@@ -37,10 +37,10 @@ http_interactions:
       string: '{"translations":[{"detected_source_language":"EN","text":"Texto de
         muestra"}]}'
     http_version: 
-  recorded_at: Sun, 10 Dec 2017 20:34:26 GMT
+  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
@@ -61,7 +61,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Sun, 10 Dec 2017 20:34:26 GMT
+      - Tue, 08 May 2018 16:31:37 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -74,10 +74,48 @@ http_interactions:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"Muestra"},{"detected_source_language":"EN","text":"Palabra"}]}'
     http_version: 
-  recorded_at: Sun, 10 Dec 2017 20:34:26 GMT
+  recorded_at: Tue, 08 May 2018 16:31:35 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v1/translate?auth_key=invalid
+    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
+    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, 08 May 2018 16:31:37 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '85'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"translations":[{"detected_source_language":"EN","text":"<p>Texto
+        de muestra</p>"}]}'
+    http_version: 
+  recorded_at: Tue, 08 May 2018 16:31:36 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate?auth_key=invalid
     body:
       encoding: US-ASCII
       string: text=Sample+text&source_lang=EN&target_lang=ES
@@ -98,7 +136,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Sun, 10 Dec 2017 20:34:27 GMT
+      - Tue, 08 May 2018 16:31:38 GMT
       Content-Length:
       - '0'
       Connection:
@@ -107,10 +145,10 @@ http_interactions:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Sun, 10 Dec 2017 20:34:27 GMT
+  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
@@ -131,7 +169,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Sun, 10 Dec 2017 20:34:27 GMT
+      - Tue, 08 May 2018 16:31:38 GMT
       Content-Length:
       - '45'
       Connection:
@@ -140,10 +178,10 @@ http_interactions:
       encoding: UTF-8
       string: '{"message":"Parameter ''text'' not specified."}'
     http_version: 
-  recorded_at: Sun, 10 Dec 2017 20:34:27 GMT
+  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
@@ -164,7 +202,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Sun, 10 Dec 2017 20:34:28 GMT
+      - Tue, 08 May 2018 16:31:39 GMT
       Content-Length:
       - '52'
       Connection:
@@ -173,13 +211,13 @@ http_interactions:
       encoding: UTF-8
       string: '{"message":"Parameter ''target_lang'' not specified."}'
     http_version: 
-  recorded_at: Sun, 10 Dec 2017 20:34:28 GMT
+  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&ignore_tags=code,%20span
     body:
       encoding: US-ASCII
-      string: text=%3Cp%3ESample+text%3C%2Fp%3E&source_lang=EN&target_lang=ES
+      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
@@ -197,19 +235,19 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Thu, 04 Jan 2018 18:09:50 GMT
+      - Tue, 24 Jul 2018 16:13:51 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '85'
+      - '119'
       Connection:
       - keep-alive
       Access-Control-Allow-Origin:
       - "*"
     body:
-      encoding: UTF-8
-      string: '{"translations":[{"detected_source_language":"EN","text":"<p>Texto
-        de muestra</p>"}]}'
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IkJpZW52ZW5pZG8geSA8Y29kZT5IZWxsbyBncmVhdCBXb3JsZDwvY29kZT4gQnVlbm9zIGTDrWFzISJ9XX0=
     http_version: 
-  recorded_at: Thu, 04 Jan 2018 18:09:49 GMT
+  recorded_at: Tue, 24 Jul 2018 16:13:49 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/usage.yml

@@ -0,0 +1,34 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.deepl.com/v2/usage?auth_key=VALID_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      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:
+      - Tue, 08 May 2018 20:42:44 GMT
+      Content-Length:
+      - '52'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"character_count":805718,"character_limit":1000000}'
+    http_version: 
+  recorded_at: Tue, 08 May 2018 20:42:43 GMT
+recorded_with: VCR 4.0.0

data/spec/requests/translate_spec.rb

@@ -0,0 +1,207 @@
+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' }
+  let(:options) { {} }
+  subject { DeepL::Requests::Translate.new(api, text, source_lang, target_lang, options) }
+
+  describe '#initialize' do
+    context 'When building a request' do
+      it 'should create a request object' do
+        expect(subject).to be_a(DeepL::Requests::Translate)
+      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)
+        expect(request.options[:split_sentences]).to eq('1')
+      end
+
+      it 'should convert `false` to `0`' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, split_sentences: false)
+        expect(request.options[:split_sentences]).to eq('0')
+      end
+
+      it 'should leave `0` as is' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, split_sentences: '0')
+        expect(request.options[:split_sentences]).to eq('0')
+      end
+
+      it 'should leave `1` as is' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, split_sentences: '1')
+        expect(request.options[:split_sentences]).to eq('1')
+      end
+    end
+
+    context 'when using `preserve_formatting` options' do
+      it 'should convert `true` to `1`' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, preserve_formatting: true)
+        expect(request.options[:preserve_formatting]).to eq('1')
+      end
+
+      it 'should convert `false` to `0`' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, preserve_formatting: false)
+        expect(request.options[:preserve_formatting]).to eq('0')
+      end
+
+      it 'should leave `0` as is' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, preserve_formatting: '0')
+        expect(request.options[:preserve_formatting]).to eq('0')
+      end
+
+      it 'should leave `1` as is' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, preserve_formatting: '1')
+        expect(request.options[:preserve_formatting]).to eq('1')
+      end
+    end
+  end
+
+  describe '#request' do
+    around do |example|
+      VCR.use_cassette('translate_texts') { example.call }
+    end
+
+    context 'When performing a valid request with one text' do
+      it 'should return a text object' do
+        text = subject.request
+
+        expect(text).to be_a(DeepL::Resources::Text)
+        expect(text.text).to eq('Texto de muestra')
+        expect(text.detected_source_language).to eq('EN')
+      end
+    end
+
+    context 'When performing a valid request with multiple texts' do
+      let(:text) { %w[Sample Word] }
+
+      it 'should return a text object' do
+        texts = subject.request
+
+        expect(texts).to be_a(Array)
+        expect(texts.first.text).to eq('Muestra')
+        expect(texts.first.detected_source_language).to eq('EN')
+
+        expect(texts.last.text).to eq('Palabra')
+        expect(texts.last.detected_source_language).to eq('EN')
+      end
+    end
+
+    context 'When performing a valid request with tag handling' do
+      let(:text) { '<p>Sample text</p>' }
+
+      it 'should return a text object' do
+        text = subject.request
+
+        expect(text).to be_a(DeepL::Resources::Text)
+        expect(text.text).to eq('<p>Texto de muestra</p>')
+        expect(text.detected_source_language).to eq('EN')
+      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
+          api = build_deepl_api
+          api.configuration.auth_key = 'invalid'
+          api
+        end
+
+        it 'should raise an unauthorized error' do
+          expect { subject.request }.to raise_error(DeepL::Exceptions::AuthorizationFailed)
+        end
+      end
+
+      context 'When using an invalid text' do
+        let(:text) { nil }
+
+        it 'should raise a bad request error' do
+          message = "Parameter 'text' not specified."
+          expect { subject.request }.to raise_error(DeepL::Exceptions::BadRequest, message)
+        end
+      end
+
+      context 'When using an invalid target language' do
+        let(:target_lang) { nil }
+
+        it 'should raise a bad request error' do
+          message = "Parameter 'target_lang' not specified."
+          expect { subject.request }.to raise_error(DeepL::Exceptions::BadRequest, message)
+        end
+      end
+    end
+  end
+end

data/spec/requests/usage_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe DeepL::Requests::Usage do
+  let(:api) { build_deepl_api }
+  let(:options) { {} }
+  subject { DeepL::Requests::Usage.new(api, options) }
+
+  describe '#initialize' do
+    context 'When building a request' do
+      it 'should create a request object' do
+        expect(subject).to be_a(DeepL::Requests::Usage)
+      end
+    end
+  end
+
+  describe '#request' do
+    around do |example|
+      VCR.use_cassette('usage') { example.call }
+    end
+
+    context 'When performing a valid request' do
+      it 'should return an usage object' do
+        usage = subject.request
+
+        expect(usage).to be_a(DeepL::Resources::Usage)
+        expect(usage.character_count).to be_a(Numeric)
+        expect(usage.character_limit).to be_a(Numeric)
+      end
+    end
+  end
+end

data/spec/resources/usage_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe DeepL::Resources::Usage do
+  subject { DeepL::Resources::Usage.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(DeepL::Resources::Usage)
+      end
+
+      it 'should assign the attributes' do
+        expect(subject.character_count).to eq(3)
+        expect(subject.character_limit).to eq(5)
+      end
+
+      it 'should not exceed the quota' do
+        expect(subject.quota_exceeded?).to be_falsey
+      end
+    end
+
+    context 'When building a quota exceeded object' do
+      subject { DeepL::Resources::Usage.new(5, 5, nil, nil) }
+
+      it 'should exceed the quota' do
+        expect(subject.quota_exceeded?).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: 1.0.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Daniel Herzog
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-31 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -49,18 +49,25 @@ 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_text.rb
+- lib/deepl/requests/translate.rb
+- lib/deepl/requests/usage.rb
 - lib/deepl/resources/base.rb
 - lib/deepl/resources/text.rb
+- lib/deepl/resources/usage.rb
 - spec/api/api_spec.rb
 - spec/api/configuration_spec.rb
 - spec/api/deepl_spec.rb
 - spec/fixtures/vcr_cassettes/deepl_translate.yml
+- spec/fixtures/vcr_cassettes/deepl_usage.yml
 - spec/fixtures/vcr_cassettes/translate_texts.yml
-- spec/requests/translate_text_spec.rb
+- spec/fixtures/vcr_cassettes/usage.yml
+- spec/requests/translate_spec.rb
+- spec/requests/usage_spec.rb
 - spec/resources/text_spec.rb
+- spec/resources/usage_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/wikiti/deepl-rb
 licenses:
@@ -82,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A simple ruby wrapper for the DeepL API

data/spec/requests/translate_text_spec.rb

@@ -1,92 +0,0 @@
-require 'spec_helper'
-
-describe DeepL::Requests::TranslateText do
-  let(:api) { build_deepl_api }
-  let(:text) { 'Sample text' }
-  let(:source_lang) { 'EN' }
-  let(:target_lang) { 'ES' }
-  subject { DeepL::Requests::TranslateText.new(api, text, source_lang, target_lang) }
-
-  describe '#initialize' do
-    context 'When building a request' do
-      it 'should create a request object' do
-        expect(subject).to be_a(DeepL::Requests::TranslateText)
-      end
-    end
-  end
-
-  describe '#request' do
-    around do |example|
-      VCR.use_cassette('translate_texts') { example.call }
-    end
-
-    context 'When performing a valid request with one text' do
-      it 'should return a text object' do
-        text = subject.request
-
-        expect(text).to be_a(DeepL::Resources::Text)
-        expect(text.text).to eq('Texto de muestra')
-        expect(text.detected_source_language).to eq('EN')
-      end
-    end
-
-    context 'When performing a valid request with multiple texts' do
-      let(:text) { %w[Sample Word] }
-
-      it 'should return a text object' do
-        texts = subject.request
-
-        expect(texts).to be_a(Array)
-        expect(texts.first.text).to eq('Muestra')
-        expect(texts.first.detected_source_language).to eq('EN')
-
-        expect(texts.last.text).to eq('Palabra')
-        expect(texts.last.detected_source_language).to eq('EN')
-      end
-    end
-
-    context 'When performing a valid request with tag handling' do
-      let(:text) { '<p>Sample text</p>' }
-
-      it 'should return a text object' do
-        text = subject.request
-
-        expect(text).to be_a(DeepL::Resources::Text)
-        expect(text.text).to eq('<p>Texto de muestra</p>')
-        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
-          api = build_deepl_api
-          api.configuration.auth_key = 'invalid'
-          api
-        end
-
-        it 'should raise an unauthorized error' do
-          expect { subject.request }.to raise_error(DeepL::Exceptions::AuthorizationFailed)
-        end
-      end
-
-      context 'When using an invalid text' do
-        let(:text) { nil }
-
-        it 'should raise a bad request error' do
-          message = "Parameter 'text' not specified."
-          expect { subject.request }.to raise_error(DeepL::Exceptions::BadRequest, message)
-        end
-      end
-
-      context 'When using an invalid target language' do
-        let(:target_lang) { nil }
-
-        it 'should raise a bad request error' do
-          message = "Parameter 'target_lang' not specified."
-          expect { subject.request }.to raise_error(DeepL::Exceptions::BadRequest, message)
-        end
-      end
-    end
-  end
-end