deepl-rb 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 00b65dd648e7d29dc160d9e8b66c2eecc15dccdc
-  data.tar.gz: 47a4e9cd8476b801b617f1290a020e017aa80bb4
+SHA256:
+  metadata.gz: f531ff13d2ba139bab65f6027f2e673f6480b097847d898531ecc7a9b247faea
+  data.tar.gz: e12727852eff8153dbb3a95d853d0fbd5ef5c703f02eaf7dedd089320e6873a2
 SHA512:
-  metadata.gz: 3ef63e90c6708751fffd2229c0e3ba96951932b2a520f66f566856b2990466bb1dc876c815f224495ae642fba9266591af74d1029fadf4abc2263f8ba25a570b
-  data.tar.gz: a017cc9b56ee7c10cba7e41c59bb17e5969f2e285d8293493ef1dff02947cfdb508684901dd0891ae3c1e17cce1511273ed9f758074607f5e9066c590adffd0d
+  metadata.gz: 1d783cba5c207fb772589bc3f328a942919eff214778ea739a6924022bb7589a1898ab62a1cad2b9f6b177f857beb1bd0c5fbe290eba1467c31b26ab9cad461e
+  data.tar.gz: f14387ba9bc6e7ca3b97176fe1d51f4fa001ca9caba1dc6377d13e4c573896f953575f6efa682bbf55d6704657a53eb73686f9ec51711298549b49a2e5a07701

data/.circleci/config.yml

@@ -3,26 +3,14 @@ jobs:
   build:
     working_directory: ~/deepl-rb
     docker:
-    - image: circleci/ruby:2.1
+    - image: circleci/ruby:2.7
     steps:
     - checkout
 
-    # Restore bundle cache
-    - type: cache-restore
-      name: Restore bundle cache
-      key: deepl-rb-bundle-{{ checksum "Gemfile.lock" }}
-
     - run:
         name: Bundle Install
         command: bundle install --path vendor/bundle
 
-    # Store bundle cache
-    - type: cache-save
-      name: Store bundle cache
-      key: deepl-rb-bundle-{{ checksum "Gemfile.lock" }}
-      paths:
-      - vendor/bundle
-
     # Run rspec
     - type: shell
       command: |

data/.rubocop.yml

@@ -2,6 +2,7 @@
 
 AllCops:
   DisplayCopNames: true
+  NewCops: enable
   Exclude:
   - deepl-rb.gemspec
   - vendor/**/*

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 group :development do
@@ -5,6 +7,10 @@ group :development do
   gem 'juwelier'
 end
 
+group :test, :development do
+  gem 'byebug', require: 'byebug'
+end
+
 group :test do
   # Test
   gem 'codecov', require: false

data/README.md

@@ -40,11 +40,39 @@ You can also configure the API host and the API version:
 ```rb
 DeepL.configure do |config|
   config.auth_key = 'your-api-token'
-  config.host = 'https://test-api.deepl.com' # Default value is 'https://api.deepl.com'
+  config.host = 'https://api-free.deepl.com' # Default value is 'https://api.deepl.com'
   config.version = 'v1' # Default value is 'v2'
 end
 ```
 
+### Available languages
+
+Available languages can be retrieved via API:
+
+```rb
+languages = DeepL.languages
+
+puts languages.class
+# => Array
+puts languages.first.class
+# => DeepL::Resources::Language
+puts "#{languages.first.code} -> #{languages.first.name}"
+# => "ES -> Spanish"
+```
+
+Note that source and target languages may be different, which can be retrieved by using the `type`
+option:
+
+```rb
+puts DeepL.languages(type: :source).count
+# => 24
+puts DeepL.languages(type: :target).count
+# => 26
+```
+
+All languages are also defined on the
+[official API documentation](https://www.deepl.com/docs-api/translating-text/)
+
 ### Translate
 
 To translate a simple text, use the `translate` method:
@@ -79,18 +107,6 @@ 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`, `split_sentences`, `non_splitting_tags` or `ignore_tags`:
 
 ```rb
@@ -111,7 +127,7 @@ The following parameters will be automatically converted:
 | `non_splitting_tags`  | Converts arrays to strings joining by commas
 | `ignore_tags`         | Converts arrays to strings joining by commas
 
-### Usage
+### Monitor usage
 
 To check current API usage, use:
 
@@ -128,11 +144,12 @@ puts usage.character_limit
 
 You can capture and process exceptions that may be raised during API calls. These are all the possible exceptions:
 
-| Exception class | Descripcion |
+| Exception class | Description |
 | --------------- | ----------- |
-| `DeepL::Exceptions::AuthorizationFailed` | The authorization process has failed. Check your auth_key value. |
+| `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::QuotaExceeded` | You've reached the API's character limit. |
 | `DeepL::Exceptions::RequestError` | An unkown request error. Check `exception.response` and `exception.request` for more information. |
 
 An exampling of handling a generic exception:
@@ -146,9 +163,31 @@ rescue DeepL::Exceptions::RequestError => e
   puts "Response body: #{e.response.body}"
   puts "Request body: #{e.request.body}"
 end
+```
+
+## Integrations
+
+### Ruby on Rails
+
+You may use this gem as a standalone service by creating an initializer on your
+`config/initializers` folder with your DeepL configuration. For example:
 
+```rb
+# config/initializers/deepl.rb
+DeepL.configure do |config|
+  # Your configuration goes here
+end
 ```
 
+Since the DeepL service is defined globally, you can use service anywhere in your code
+(controllers, models, views, jobs, plain ruby objects… you name it).
+
+### i18n-tasks
+
+You may also take a look at [`i18n-tasks`](https://github.com/glebm/i18n-tasks), which is a gem
+that helps you find and manage missing and unused translations. `deepl-rb` is used as one of the
+backend services to translate content.
+
 ## Development
 
 Clone the repository, and install its dependencies:
@@ -164,11 +203,3 @@ To run tests (rspec and rubocop), use
 ```
 bundle exec rake test
 ```
-
-## Contributors
-
-This project has been developed by:
-
-| Avatar | Name | Nickname | Email |
-| ------ | ---- | -------- | ----- |
-| ![](http://www.gravatar.com/avatar/2ae6d81e0605177ba9e17b19f54e6b6c.jpg?s=64)  | Daniel Herzog | Wikiti | [info@danielherzog.es](mailto:info@danielherzog.es)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 

data/VERSION

@@ -1 +1 @@
-2.2.0
+2.3.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.2.0 ruby lib
+# stub: deepl-rb 2.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "2.2.0"
+  s.version = "2.3.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-11-28"
+  s.date = "2021-05-17"
   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 = [
@@ -22,7 +22,6 @@ Gem::Specification.new do |s|
     ".circleci/config.yml",
     ".rubocop.yml",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.md",
     "README.md",
     "Rakefile",
@@ -35,41 +34,48 @@ Gem::Specification.new do |s|
     "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"
   ]
   s.homepage = "http://github.com/wikiti/deepl-rb".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.6.14".freeze
+  s.rubygems_version = "3.1.2".freeze
   s.summary = "A simple ruby wrapper for the DeepL API".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
-    else
-      s.add_dependency(%q<juwelier>.freeze, [">= 0"])
-    end
+  if s.respond_to? :add_runtime_dependency then
+    s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
   else
     s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_dependency(%q<byebug>.freeze, [">= 0"])
   end
 end
 

data/lib/deepl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -- Dependencies
 require 'json'
 require 'net/http'
@@ -8,14 +10,17 @@ require 'deepl/exceptions/request_error'
 require 'deepl/exceptions/authorization_failed'
 require 'deepl/exceptions/bad_request'
 require 'deepl/exceptions/limit_exceeded'
+require 'deepl/exceptions/quota_exceeded'
 
 # -- Requests
 require 'deepl/requests/base'
+require 'deepl/requests/languages'
 require 'deepl/requests/translate'
 require 'deepl/requests/usage'
 
 # -- Responses and resources
 require 'deepl/resources/base'
+require 'deepl/resources/language'
 require 'deepl/resources/text'
 require 'deepl/resources/usage'
 
@@ -33,6 +38,10 @@ module DeepL
     @api ||= API.new(configuration)
   end
 
+  def languages(options = {})
+    Requests::Languages.new(api, options).request
+  end
+
   def translate(text, source_lang, target_lang, options = {})
     configure if @configuration.nil?
     Requests::Translate.new(api, text, source_lang, target_lang, options).request

data/lib/deepl/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   class API
     attr_reader :configuration

data/lib/deepl/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   class Configuration
     ATTRIBUTES = %i[auth_key host version].freeze

data/lib/deepl/exceptions/authorization_failed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class AuthorizationFailed < RequestError

data/lib/deepl/exceptions/bad_request.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class BadRequest < RequestError
       def message
         JSON.parse(response.body)['message']
+      rescue JSON::ParserError
+        response.body
       end
     end
   end

data/lib/deepl/exceptions/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class Error < StandardError

data/lib/deepl/exceptions/limit_exceeded.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class LimitExceeded < RequestError

data/lib/deepl/exceptions/quota_exceeded.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DeepL
+  module Exceptions
+    class QuotaExceeded < RequestError
+      def message
+        'Quota exceeded. The character limit has been reached.'
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/request_error.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 module DeepL
   module Exceptions
     class RequestError < Error
       attr_reader :request, :response
 
       def initialize(request, response)
+        super()
         @request = request
         @response = response
       end
 
       def message
-        'Unkown error.'
+        'Unknown error.'
       end
     end
   end

data/lib/deepl/requests/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Requests
     class Base
@@ -32,7 +34,7 @@ module DeepL
 
       def post(payload)
         request = Net::HTTP::Post.new(uri.request_uri)
-        request.set_form_data(payload.reject { |_, v| v.nil? })
+        request.set_form_data(payload.compact)
         response = http.request(request)
 
         validate_response!(request, response)
@@ -62,6 +64,7 @@ module DeepL
         when '400' then raise Exceptions::BadRequest.new(request, response)
         when '403' then raise Exceptions::AuthorizationFailed.new(request, response)
         when '429' then raise Exceptions::LimitExceeded.new(request, response)
+        when '456' then raise Exceptions::QuotaExceeded.new(request, response)
         else raise Exceptions::RequestError.new(request, response)
         end
       end

data/lib/deepl/requests/languages.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module DeepL
+  module Requests
+    class Languages < Base
+      def initialize(api, options = {})
+        super(api, options)
+      end
+
+      def request
+        build_languages(*get)
+      end
+
+      private
+
+      def build_languages(request, response)
+        data = JSON.parse(response.body)
+        data.map do |language|
+          Resources::Language.new(language['language'], language['name'], request, response)
+        end
+      end
+
+      def path
+        'languages'
+      end
+    end
+  end
+end