deepl-rb 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 441fcd26032548de810426a4d3d32796de8795e8
-  data.tar.gz: b3ce1748c9f5b74c99c66c5955b71e86c9fd321d
+  metadata.gz: a1c91abf5249e9f0e384d543ed2d849adf9b3942
+  data.tar.gz: edd33d6c73e38b9b83372d8acbdd66bab5af0a74
 SHA512:
-  metadata.gz: d393a4e056f780cfc4669227e0dc0b3a92446a5bd919a838462274aa4805abe0853b95c14db92d870d567be54c1217bdae887bdf2e16bd982cccbdc0669bfc6d
-  data.tar.gz: 6cb6200ba9a56c0fe50481225159f1ef72797bfb654c1feed59efd1104433ab401556cdaa2c9d54badcd5a7727ac0c56becc435990860720982ff5509478fef1
+  metadata.gz: 5b549cc903c25708d605dc149136ff35d6cbd6b200d4e4c7e66773918fb4b291bf84e729fa9909de5ef32781c368ec6f04268bb21d1b585f8d37eeec5ca1745e
+  data.tar.gz: bd6317763f346f308aa7e0f1eb11f1fced3352ec1ea64e1cb323170e60f56601e0b2c5a00ce491afac7f4397550fbc6324bd203b07d4bc1a8728598a9cc4ac5d

data/.circleci/config.yml

@@ -3,7 +3,7 @@ jobs:
   build:
     working_directory: ~/deepl-rb
     docker:
-    - image: circleci/ruby:2.4-node
+    - image: circleci/ruby:2.1
     steps:
     - checkout
 

data/.rubocop.yml

@@ -4,6 +4,7 @@ AllCops:
   DisplayCopNames: true
   Exclude:
   - deepl-rb.gemspec
+  - vendor/**/*
 
 Metrics/BlockLength:
   Exclude:

data/Gemfile

@@ -7,6 +7,7 @@ end
 
 group :test do
   # Test
+  gem 'codecov', require: false
   gem 'rspec'
   gem 'rubocop'
   gem 'simplecov'

data/Gemfile.lock

@@ -5,6 +5,10 @@ GEM
       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)
@@ -21,24 +25,20 @@ GEM
       hashie (~> 3.5, >= 3.5.2)
       oauth2 (~> 1.0)
     hashdiff (0.3.7)
-    hashie (3.5.6)
+    hashie (3.5.7)
     highline (1.7.10)
     json (2.1.0)
-    juwelier (2.4.7)
+    juwelier (2.1.3)
       builder
-      bundler
-      git
+      bundler (>= 1.13)
+      git (>= 1.2.5)
       github_api
-      highline
-      kamelcase (~> 0)
-      nokogiri
-      psych
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
       rake
       rdoc
-      semver2
+      semver
     jwt (1.5.6)
-    kamelcase (0.0.1)
-      semver2 (~> 3)
     mini_portile2 (2.3.0)
     multi_json (1.12.2)
     multi_xml (0.6.0)
@@ -51,22 +51,20 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    parallel (1.12.0)
+    parallel (1.12.1)
     parser (2.4.0.2)
       ast (~> 2.3)
     powerpack (0.1.1)
-    psych (2.2.2)
     public_suffix (3.0.1)
-    rack (2.0.3)
-    rainbow (2.2.2)
-      rake
+    rack (1.6.8)
+    rainbow (3.0.0)
     rake (12.3.0)
-    rdoc (5.0.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.0)
+    rspec-core (3.7.1)
       rspec-support (~> 3.7.0)
     rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -75,16 +73,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
-    rubocop (0.51.0)
+    rubocop (0.52.1)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
+      parser (>= 2.4.0.2, < 3.0)
       powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 3.0)
+      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)
-    semver2 (3.4.2)
+    semver (1.0.1)
     simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -92,8 +90,9 @@ GEM
     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.1.1)
+    webmock (3.2.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -102,6 +101,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  codecov
   juwelier
   rspec
   rubocop
@@ -110,4 +110,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.15.4
+   1.16.0.pre.2

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)
+[![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)
 
 # DeepL for ruby
 
@@ -10,6 +10,7 @@ Install this gem with
 
 ```sh
 gem install deepl-rb
+# Load it in your ruby file using `require 'deepl'`
 ```
 
 Or add it to your Gemfile:
@@ -48,35 +49,82 @@ end
 To translate a simple text, use the `translate` method:
 
 ```rb
-item = DeepL.translate 'This is my text', 'EN', 'ES'
+translation = DeepL.translate 'This is my text', 'EN', 'ES'
 
-puts item.class
+puts translation.class
 # => DeepL::Resources::Text
-puts item.text
+puts translation.text
 # => 'Este es mi texto'
 ```
 
-You can also auto-detect source language by skipping it with `nil`:
+Enable auto-detect source language by skipping the source language with `nil`:
 
 ```rb
-item = DeepL.translate 'This is my text', nil, 'ES'
+translation = DeepL.translate 'This is my text', nil, 'ES'
 
-puts item.detected_source_language
+puts translation.detected_source_language
 # => 'EN'
 ```
 
-You can also translate a list of texts by passing an array as an argument:
+Translate a list of texts by passing an array as an argument:
 
 ```rb
 texts = ['Sample text', 'Another text']
-items = DeepL.translate texts, 'EN', 'ES'
+translations = DeepL.translate texts, 'EN', 'ES'
 
-puts items.class
+puts translations.class
 # => Array
-puts items.first.class
+puts translations.first.class
 # => DeepL::Resources::Text
 ```
 
+Here's a list of available language codes:
+
+| Language code   | Language
+| --------------- | ---------------
+| `EN`            | English
+| `DE`            | German
+| `FR`            | French
+| `ES`            | Spanish
+| `IT`            | Italian
+| `NL`            | Dutch
+| `PL`            | Polish
+
+You can also use custom query parameters, like `tag_handling`:
+
+```rb
+texts = ['Sample text',¡]
+translation = DeepL.translate '<p>A sample</p>', 'EN', 'ES', tag_handling: true
+
+puts translation.text
+# => ""
+```
+
+### Handle exceptions
+
+You can capture and process exceptions that may be raised during API calls. These are all the possible exceptions:
+
+| Exception class | Descripcion |
+| --------------- | ----------- |
+| `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::RequestError` | An unkown request error. Check `exception.response` and `exception.request` for more information. |
+
+An exampling of handling a generic exception:
+
+```rb
+def my_method
+  item = DeepL.translate 'This is my text', nil, 'ES'
+rescue DeepL::Exceptions::RequestError => e
+  puts 'Oops!'
+  puts "Code: #{e.response.code}"
+  puts "Response body: #{e.response.body}"
+  puts "Request body: #{e.request.body}"
+end
+
+```
+
 ## Development
 
 Clone the repository, and install its dependencies:

data/VERSION

@@ -1 +1 @@
-0.0.1
+1.0.0

data/deepl-rb.gemspec

@@ -1,19 +1,19 @@
 # Generated by juwelier
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Juwelier::Tasks in rakefile, and run 'rake gemspec'
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 0.0.1 ruby lib
+# stub: deepl-rb 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "deepl-rb".freeze
-  s.version = "0.0.1"
+  s.name = "deepl-rb"
+  s.version = "1.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 = "2017-12-12"
-  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.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Daniel Herzog"]
+  s.date = "2018-01-04"
+  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"
+  s.email = "info@danielherzog.es"
   s.extra_rdoc_files = [
     "LICENSE.md",
     "README.md"
@@ -49,21 +49,21 @@ Gem::Specification.new do |s|
     "spec/resources/text_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.summary = "A simple ruby wrapper for the DeepL API".freeze
+  s.homepage = "http://github.com/wikiti/deepl-rb"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "A simple ruby wrapper for the DeepL API"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+      s.add_development_dependency(%q<juwelier>, [">= 0"])
     else
-      s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+      s.add_dependency(%q<juwelier>, [">= 0"])
     end
   else
-    s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_dependency(%q<juwelier>, [">= 0"])
   end
 end
 

data/lib/deepl.rb

@@ -31,10 +31,9 @@ module DeepL
     @api ||= API.new(configuration)
   end
 
-  def translate(text, options = {})
+  def translate(text, source_lang, target_lang, options = {})
     configure if @configuration.nil?
-    Requests::TranslateText.new(api, text, fetch(options, :source_lang),
-                                fetch(options, :target_lang)).request
+    Requests::TranslateText.new(api, text, source_lang, target_lang, options).request
   end
 
   # -- Configuration
@@ -47,10 +46,4 @@ module DeepL
     yield configuration if block_given?
     configuration.validate!
   end
-
-  private
-
-  def fetch(hash, key)
-    hash[key.to_s] || hash[key.to_sym]
-  end
 end

data/lib/deepl/requests/base.rb

@@ -3,10 +3,11 @@ module DeepL
     class Base
       API_VERSION = 'v1'.freeze
 
-      attr_reader :api, :response
+      attr_reader :api, :response, :options
 
-      def initialize(api)
+      def initialize(api, options = {})
         @api = api
+        @options = options
       end
 
       def request
@@ -15,9 +16,13 @@ module DeepL
 
       private
 
+      def option(name)
+        options[name.to_s] || options[name.to_sym]
+      end
+
       def post(payload)
         request = Net::HTTP::Post.new(uri.request_uri)
-        request.set_form_data(payload.compact)
+        request.set_form_data(payload.reject { |_, v| v.nil? })
         response = http.request(request)
 
         validate_response!(request, response)
@@ -65,7 +70,7 @@ module DeepL
       end
 
       def query_params
-        { auth_key: api.configuration.auth_key }
+        { auth_key: api.configuration.auth_key }.merge(options)
       end
     end
   end

data/lib/deepl/requests/translate_text.rb

@@ -3,8 +3,8 @@ module DeepL
     class TranslateText < Base
       attr_reader :text, :source_lang, :target_lang
 
-      def initialize(api, text, source_lang, target_lang)
-        super(api)
+      def initialize(api, text, source_lang, target_lang, options = {})
+        super(api, options)
         @text = text
         @source_lang = source_lang
         @target_lang = target_lang

data/spec/api/deepl_spec.rb

@@ -41,6 +41,7 @@ describe DeepL do
     let(:input) { 'Sample' }
     let(:source_lang) { 'EN' }
     let(:target_lang) { 'ES' }
+    let(:options) { { param: 'fake' } }
 
     around do |example|
       VCR.use_cassette('deepl_translate') { example.call }
@@ -49,9 +50,9 @@ 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)
-          .with(subject.api, input, source_lang, target_lang).and_call_original
+          .with(subject.api, input, source_lang, target_lang, options).and_call_original
 
-        text = subject.translate(input, source_lang: source_lang, target_lang: target_lang)
+        text = subject.translate(input, source_lang, target_lang, options)
         expect(text).to be_a(DeepL::Resources::Text)
       end
     end

data/spec/fixtures/vcr_cassettes/deepl_translate.yml

@@ -107,4 +107,41 @@ http_interactions:
       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
+    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:
+      - Thu, 04 Jan 2018 18:08:31 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: Thu, 04 Jan 2018 18:08:31 GMT
 recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -36,7 +36,7 @@ http_interactions:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"Texto de
         muestra"}]}'
-    http_version:
+    http_version: 
   recorded_at: Sun, 10 Dec 2017 20:34:26 GMT
 - request:
     method: post
@@ -73,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: Sun, 10 Dec 2017 20:34:26 GMT
 - request:
     method: post
@@ -106,7 +106,7 @@ http_interactions:
     body:
       encoding: UTF-8
       string: ''
-    http_version:
+    http_version: 
   recorded_at: Sun, 10 Dec 2017 20:34:27 GMT
 - request:
     method: post
@@ -139,7 +139,7 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"message":"Parameter ''text'' not specified."}'
-    http_version:
+    http_version: 
   recorded_at: Sun, 10 Dec 2017 20:34:27 GMT
 - request:
     method: post
@@ -172,6 +172,44 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"message":"Parameter ''target_lang'' not specified."}'
-    http_version:
+    http_version: 
   recorded_at: Sun, 10 Dec 2017 20:34:28 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
+    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:
+      - Thu, 04 Jan 2018 18:09:50 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: Thu, 04 Jan 2018 18:09:49 GMT
 recorded_with: VCR 4.0.0

data/spec/requests/translate_text_spec.rb

@@ -45,6 +45,18 @@ describe DeepL::Requests::TranslateText do
       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

data/spec/spec_helper.rb

@@ -1,11 +1,18 @@
-require 'vcr'
+# Coverage
+require 'simplecov'
+SimpleCov.start
+
+require 'codecov'
+SimpleCov.formatter = SimpleCov::Formatter::Codecov
 
+# Load lib
 require_relative '../lib/deepl'
 
 # Lib config
 ENV['DEEPL_AUTH_KEY'] ||= 'TEST-TOKEN'
 
 # VCR tapes configuration
+require 'vcr'
 VCR.configure do |config|
   config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   config.hook_into :webmock

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Daniel Herzog
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-12 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple ruby wrapper for the DeepL API