deepl-rb 0.0.0

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -0,0 +1,177 @@
+---
+http_interactions:
+- 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&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 20:34:26 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '78'
+      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
+- request:
+    method: post
+    uri: https://api.deepl.com/v1/translate?auth_key=VALID_TOKEN
+    body:
+      encoding: US-ASCII
+      string: text=Sample&text=Word&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 20:34:26 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '120'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    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
+- request:
+    method: post
+    uri: https://api.deepl.com/v1/translate?auth_key=invalid
+    body:
+      encoding: US-ASCII
+      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
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sun, 10 Dec 2017 20:34:27 GMT
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version:
+  recorded_at: Sun, 10 Dec 2017 20:34:27 GMT
+- 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 20:34:27 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 20:34:27 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
+    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 20:34:28 GMT
+      Content-Length:
+      - '52'
+      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
+recorded_with: VCR 4.0.0

data/spec/requests/translate_text_spec.rb

@@ -0,0 +1,80 @@
+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 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/resources/text_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe DeepL::Resources::Text do
+  subject { DeepL::Resources::Text.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)
+      end
+
+      it 'should assign the attributes' do
+        expect(subject.text).to eq('Target')
+        expect(subject.detected_source_language).to eq('es')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'vcr'
+
+require_relative '../lib/deepl'
+
+# Lib config
+ENV['DEEPL_AUTH_KEY'] ||= 'TEST-TOKEN'
+
+# VCR tapes configuration
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  config.hook_into :webmock
+  config.filter_sensitive_data('VALID_TOKEN') { ENV['DEEPL_AUTH_KEY'] }
+  config.default_cassette_options = {
+    record: :new_episodes,
+    match_requests_on: %i[method uri body]
+  }
+end
+
+# General helpers
+def build_deepl_api
+  DeepL::API.new(DeepL::Configuration.new)
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: deepl-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Daniel Herzog
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  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
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- ".circleci/config.yml"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION
+- deepl-rb.gemspec
+- lib/deepl.rb
+- lib/deepl/api.rb
+- lib/deepl/configuration.rb
+- lib/deepl/exceptions/authorization_failed.rb
+- lib/deepl/exceptions/bad_request.rb
+- lib/deepl/exceptions/error.rb
+- 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/resources/base.rb
+- lib/deepl/resources/text.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/translate_texts.yml
+- spec/requests/translate_text_spec.rb
+- spec/resources/text_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/wikiti/deepl-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A simple ruby wrapper for the DeepL API
+test_files: []