deepl-rb 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13a3bbfea258695f87a655395197001cef339a23
-  data.tar.gz: 683f5b706dee4a5b8f23d1c02b8a081ec452e46e
+  metadata.gz: 7c3fdd20441317600a911a02659531c6595949ac
+  data.tar.gz: 54818a5de28df31e33f2cf8434834177fbe71989
 SHA512:
-  metadata.gz: cc8cb5c628c1c146f3f29c84425205175a714301a8978db7f0c1d3559503f8d3206855502055b02021bdbe90cdcddeab9b28088c4599178e5b4271c1a539ddfe
-  data.tar.gz: e9daaaed2529971d5cd5813ff593a99a4950f559d280dee881b7fd7fc356b7fc0cfbc88a25978414e46cda54872f0180d23b848df49c7106f3867d45af1b6e19
+  metadata.gz: e389b2270f9cc4584bbe5e77cf6d1f7f6aa087d23a4aa649afe8507c3f0be484685813c161e72d9b30acba49a67277e116ec141b7943216cc1eef399d703edd6
+  data.tar.gz: 1dc00e5ba9ab6622f1bcd0fad1b4df2eef7258dcf1ee667ad6c9b7d647975c4eced8f4a37db192c96df020a395124bc48ab599f5dd2a05da23fa8452907bf12f

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,4 +1,4 @@
-[![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
 
@@ -90,11 +90,12 @@ Here's a list of available language codes:
 | `NL`            | Dutch
 | `PL`            | Polish
 
-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 +105,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
 

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/deepl-rb.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 2.0.0 ruby lib
+# stub: deepl-rb 2.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "2.0.0"
+  s.version = "2.1.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-05-08"
+  s.date = "2018-07-24"
   s.description = "A simple ruby wrapper for the DeepL translation API (v1). For more information, check this: https://www.deepl.com/docs/api-reference.html".freeze
   s.email = "info@danielherzog.es".freeze
   s.extra_rdoc_files = [

data/lib/deepl/requests/translate.rb

@@ -1,12 +1,16 @@
 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)

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -34,8 +34,9 @@ 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
@@ -72,7 +73,7 @@ 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
@@ -110,7 +111,7 @@ 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
@@ -143,7 +144,7 @@ http_interactions:
     body:
       encoding: UTF-8
       string: ''
-    http_version:
+    http_version: 
   recorded_at: Tue, 08 May 2018 16:31:37 GMT
 - request:
     method: post
@@ -176,7 +177,7 @@ 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
@@ -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/v1/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/requests/translate_spec.rb

@@ -1,11 +1,15 @@
 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 +18,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 +159,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Daniel Herzog
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier