deepl-rb 2.2.0 → 2.3.0

data/spec/fixtures/vcr_cassettes/usage.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.deepl.com/v2/usage?auth_key=VALID_TOKEN
+    uri: https://api-free.deepl.com/v2/usage?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: ''
@@ -21,14 +21,17 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 08 May 2018 20:42:44 GMT
+      - Mon, 17 May 2021 14:18:32 GMT
+      Content-Type:
+      - application/json
       Content-Length:
-      - '52'
+      - '48'
       Connection:
       - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
     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
+      string: '{"character_count":353,"character_limit":500000}'
+  recorded_at: Mon, 17 May 2021 14:18:32 GMT
+recorded_with: VCR 6.0.0

data/spec/requests/languages_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Requests::Languages do
+  let(:api) { build_deepl_api }
+  let(:options) { {} }
+  subject { DeepL::Requests::Languages.new(api, options) }
+
+  describe '#initialize' do
+    context 'When building a request' do
+      it 'should create a request object' do
+        expect(subject).to be_a(described_class)
+      end
+    end
+  end
+
+  describe '#request' do
+    around do |example|
+      VCR.use_cassette('languages') { example.call }
+    end
+
+    context 'When requesting source languages' do
+      it 'should return an usage object' do
+        languages = subject.request
+
+        expect(languages).to be_an(Array)
+        expect(languages.size).to eq(24)
+        expect(languages.any? { |l| l.code == 'EN' && l.name == 'English' }).to be_truthy
+        expect(languages.any? { |l| l.code == 'ES' && l.name == 'Spanish' }).to be_truthy
+      end
+    end
+
+    context 'When requesting target languages' do
+      let(:options) { { type: :target } }
+
+      it 'should return an usage object' do
+        languages = subject.request
+
+        expect(languages).to be_an(Array)
+        expect(languages.size).to eq(26)
+        expect(languages.any? { |l| l.code == 'EN' && l.name == 'English' }).to be_falsey
+        expect(languages.any? { |l| l.code == 'ES' && l.name == 'Spanish' }).to be_truthy
+        expect(languages.any? { |l| l.code == 'EN-US' && l.name == 'English (American)' })
+          .to be_truthy
+      end
+    end
+
+    context 'When using an invalid type' do
+      let(:options) { { type: :invalid } }
+
+      it 'should return an usage object' do
+        message = "Parameter 'type' is invalid. 'source' and 'target' are valid values."
+        expect { subject.request }.to raise_error(DeepL::Exceptions::BadRequest, message)
+      end
+    end
+  end
+end

data/spec/requests/translate_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::Requests::Translate do
@@ -149,6 +151,7 @@ describe DeepL::Requests::Translate do
 
     context 'When performing a valid request with tag handling' do
       let(:text) { '<p>Sample text</p>' }
+      let(:options) { { tag_handling: 'xml' } }
 
       it 'should return a text object' do
         text = subject.request
@@ -161,13 +164,13 @@ describe DeepL::Requests::Translate do
 
     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' } }
+      let(:options) { { tag_handling: 'xml', 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.text).to eq('Bienvenido y <code>Hello great World</code> ¡Buenos días!')
         expect(text.detected_source_language).to eq('EN')
       end
     end
@@ -198,7 +201,7 @@ describe DeepL::Requests::Translate do
         let(:target_lang) { nil }
 
         it 'should raise a bad request error' do
-          message = "Parameter 'target_lang' not specified."
+          message = "Value for 'target_lang' not supported."
           expect { subject.request }.to raise_error(DeepL::Exceptions::BadRequest, message)
         end
       end

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/language_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Resources::Language do
+  subject { described_class.new('EN', 'English', nil, nil) }
+
+  describe '#initialize' do
+    context 'When building a basic object' do
+      it 'should create a resource' do
+        expect(subject).to be_a(described_class)
+      end
+
+      it 'should assign the attributes' do
+        expect(subject.code).to eq('EN')
+        expect(subject.name).to eq('English')
+      end
+    end
+  end
+end

data/spec/resources/text_spec.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::Resources::Text do
-  subject { DeepL::Resources::Text.new('Target', 'es', nil, nil) }
+  subject { described_class.new('Target', 'es', 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::Text)
+        expect(subject).to be_a(described_class)
       end
 
       it 'should assign the attributes' do

data/spec/resources/usage_spec.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::Resources::Usage do
-  subject { DeepL::Resources::Usage.new(3, 5, nil, nil) }
+  subject { described_class.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)
+        expect(subject).to be_a(described_class)
       end
 
       it 'should assign the attributes' do
@@ -20,7 +22,7 @@ describe DeepL::Resources::Usage do
     end
 
     context 'When building a quota exceeded object' do
-      subject { DeepL::Resources::Usage.new(5, 5, nil, nil) }
+      subject { described_class.new(5, 5, nil, nil) }
 
       it 'should exceed the quota' do
         expect(subject.quota_exceeded?).to be_truthy

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Coverage
 require 'simplecov'
 SimpleCov.start
@@ -25,5 +27,5 @@ end
 
 # General helpers
 def build_deepl_api
-  DeepL::API.new(DeepL::Configuration.new)
+  DeepL::API.new(DeepL::Configuration.new(host: 'https://api-free.deepl.com'))
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Daniel Herzog
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'A simple ruby wrapper for the DeepL translation API (v1). For more information,
   check this: https://www.deepl.com/docs/api-reference.html'
 email: info@danielherzog.es
@@ -36,7 +50,6 @@ files:
 - ".circleci/config.yml"
 - ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
@@ -49,22 +62,29 @@ 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/languages.rb
 - lib/deepl/requests/translate.rb
 - lib/deepl/requests/usage.rb
 - lib/deepl/resources/base.rb
+- lib/deepl/resources/language.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_languages.yml
 - spec/fixtures/vcr_cassettes/deepl_translate.yml
 - spec/fixtures/vcr_cassettes/deepl_usage.yml
+- spec/fixtures/vcr_cassettes/languages.yml
 - spec/fixtures/vcr_cassettes/translate_texts.yml
 - spec/fixtures/vcr_cassettes/usage.yml
+- spec/requests/languages_spec.rb
 - spec/requests/translate_spec.rb
 - spec/requests/usage_spec.rb
+- spec/resources/language_spec.rb
 - spec/resources/text_spec.rb
 - spec/resources/usage_spec.rb
 - spec/spec_helper.rb
@@ -72,7 +92,7 @@ homepage: http://github.com/wikiti/deepl-rb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,9 +107,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