deepl-rb 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37163389ddd5655c4c9f1d1e60e0d414e3c35420
-  data.tar.gz: 881b3877774bc62cf3f42900c72d336c7b32583d
+  metadata.gz: 13a3bbfea258695f87a655395197001cef339a23
+  data.tar.gz: 683f5b706dee4a5b8f23d1c02b8a081ec452e46e
 SHA512:
-  metadata.gz: d63335bb2ec23d724e77dba606844c711afbc798afe8c7a64f12a420e14561c33c555f36716f7d3537f8f234bed064d8d72aa659837a99b442952186813718cb
-  data.tar.gz: 944992d82a26e096f4389cbc50dd076c80b7d6c58113c84401539e20b8620dcac21ac362730fb3a3b862d97658b70e565911f69fc3c13e2b1f6b26580cb697b7
+  metadata.gz: cc8cb5c628c1c146f3f29c84425205175a714301a8978db7f0c1d3559503f8d3206855502055b02021bdbe90cdcddeab9b28088c4599178e5b4271c1a539ddfe
+  data.tar.gz: e9daaaed2529971d5cd5813ff593a99a4950f559d280dee881b7fd7fc356b7fc0cfbc88a25978414e46cda54872f0180d23b848df49c7106f3867d45af1b6e19

data/README.md

@@ -2,7 +2,7 @@
 
 # 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 (v1)](https://www.deepl.com/api.html).
 
 ## Installation
 
@@ -90,15 +90,36 @@ Here's a list of available language codes:
 | `NL`            | Dutch
 | `PL`            | Polish
 
-You can also use custom query parameters, like `tag_handling`:
+You can also use custom query parameters, like `tag_handling` or `split_sentences`:
 
 ```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
 
 puts translation.text
 # => "<p>Una muestra</p>"
 ```
 
+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'`
+
+### 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:

data/VERSION

@@ -1 +1 @@
-1.0.1
+2.0.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 1.0.1 ruby lib
+# stub: deepl-rb 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "1.0.1"
+  s.version = "2.0.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 = "2018-03-31"
+  s.date = "2018-05-08"
   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 = [
@@ -37,21 +37,27 @@ Gem::Specification.new do |s|
     "lib/deepl/exceptions/limit_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

@@ -11,11 +11,13 @@ require 'deepl/exceptions/limit_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 +35,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/requests/base.rb

@@ -16,10 +16,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 +41,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)

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

@@ -1,6 +1,11 @@
 module DeepL
   module Requests
-    class TranslateText < Base
+    class Translate < Base
+      OPTIONS_CONVERSIONS = {
+        split_sentences: { true => '1', false => '0' },
+        preserve_formatting: { true => '1', false => '0' }
+      }.freeze
+
       attr_reader :text, :source_lang, :target_lang
 
       def initialize(api, text, source_lang, target_lang, options = {})
@@ -8,6 +13,8 @@ module DeepL
         @text = text
         @source_lang = source_lang
         @target_lang = target_lang
+
+        tweak_parameters!
       end
 
       def request
@@ -17,6 +24,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/deepl_spec.rb

@@ -49,7 +49,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 +57,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

@@ -1,112 +1,5 @@
 ---
 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
@@ -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:
@@ -143,5 +36,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"Muestra"}]}'
     http_version: 
-  recorded_at: Thu, 04 Jan 2018 18:08:31 GMT
+  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/v1/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

@@ -23,21 +23,20 @@ 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:
       - "*"
     body:
       encoding: UTF-8
-      string: '{"translations":[{"detected_source_language":"EN","text":"Texto de
-        muestra"}]}'
-    http_version: 
-  recorded_at: Sun, 10 Dec 2017 20:34:26 GMT
+      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
@@ -61,7 +60,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:
@@ -73,14 +72,14 @@ http_interactions:
     body:
       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
+    http_version:
+  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/v1/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
-      string: text=Sample+text&source_lang=EN&target_lang=ES
+      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
@@ -92,28 +91,33 @@ http_interactions:
       - application/x-www-form-urlencoded
   response:
     status:
-      code: 403
-      message: Forbidden
+      code: 200
+      message: OK
     headers:
       Server:
       - nginx
       Date:
-      - Sun, 10 Dec 2017 20:34:27 GMT
+      - Tue, 08 May 2018 16:31:37 GMT
+      Content-Type:
+      - application/json
       Content-Length:
-      - '0'
+      - '85'
       Connection:
       - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
-      string: ''
-    http_version: 
-  recorded_at: Sun, 10 Dec 2017 20:34:27 GMT
+      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/v1/translate?auth_key=VALID_TOKEN
+    uri: https://api.deepl.com/v1/translate?auth_key=invalid
     body:
       encoding: US-ASCII
-      string: source_lang=EN&target_lang=ES
+      string: text=Sample+text&source_lang=EN&target_lang=ES
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
@@ -125,28 +129,28 @@ http_interactions:
       - application/x-www-form-urlencoded
   response:
     status:
-      code: 400
-      message: Bad Request
+      code: 403
+      message: Forbidden
     headers:
       Server:
       - nginx
       Date:
-      - Sun, 10 Dec 2017 20:34:27 GMT
+      - Tue, 08 May 2018 16:31:38 GMT
       Content-Length:
-      - '45'
+      - '0'
       Connection:
       - keep-alive
     body:
       encoding: UTF-8
-      string: '{"message":"Parameter ''text'' not specified."}'
-    http_version: 
-  recorded_at: Sun, 10 Dec 2017 20:34:27 GMT
+      string: ''
+    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
     body:
       encoding: US-ASCII
-      string: text=Sample+text&source_lang=EN
+      string: source_lang=EN&target_lang=ES
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
@@ -164,22 +168,22 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Sun, 10 Dec 2017 20:34:28 GMT
+      - Tue, 08 May 2018 16:31:38 GMT
       Content-Length:
-      - '52'
+      - '45'
       Connection:
       - keep-alive
     body:
       encoding: UTF-8
-      string: '{"message":"Parameter ''target_lang'' not specified."}'
-    http_version: 
-  recorded_at: Sun, 10 Dec 2017 20:34:28 GMT
+      string: '{"message":"Parameter ''text'' not specified."}'
+    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
     body:
       encoding: US-ASCII
-      string: text=%3Cp%3ESample+text%3C%2Fp%3E&source_lang=EN&target_lang=ES
+      string: text=Sample+text&source_lang=EN
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
@@ -191,25 +195,20 @@ http_interactions:
       - application/x-www-form-urlencoded
   response:
     status:
-      code: 200
-      message: OK
+      code: 400
+      message: Bad Request
     headers:
       Server:
       - nginx
       Date:
-      - Thu, 04 Jan 2018 18:09:50 GMT
-      Content-Type:
-      - application/json
+      - Tue, 08 May 2018 16:31:39 GMT
       Content-Length:
-      - '85'
+      - '52'
       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: Thu, 04 Jan 2018 18:09:49 GMT
+      string: '{"message":"Parameter ''target_lang'' not specified."}'
+    http_version:
+  recorded_at: Tue, 08 May 2018 16:31:37 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/v1/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_text_spec.rb → translate_spec.rb}

@@ -1,16 +1,60 @@
 require 'spec_helper'
 
-describe DeepL::Requests::TranslateText do
+describe DeepL::Requests::Translate 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) }
+  subject { DeepL::Requests::Translate.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)
+        expect(subject).to be_a(DeepL::Requests::Translate)
+      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

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.0.0
 platform: ruby
 authors:
 - Daniel Herzog
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-31 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -51,16 +51,22 @@ files:
 - lib/deepl/exceptions/limit_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 +88,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