deepl_api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e882987aea99da75e1dec09b2c375816169d24622a93978f100656bd6b2e11ba
+  data.tar.gz: 2f04a5b7a53d52426f8f93a8f5b6707dcc49e644292ebac45b56b209546257ef
+SHA512:
+  metadata.gz: 696b17977bb4fd596f77056d65a6db83b87f098addd18d71b73e5a2feff8c6545410fbf42050807604e7eefc1385666a500b3e4620f69956ad2a79a6a6d042fd
+  data.tar.gz: a7143248566554a754e05d0e0cd9a487ee81f413ab39672d3f7afeec53add2925d32b1f17ab98053701d8ea1eae7b52c7e4c6293c39fd676329d80845089ece5

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      env:
+        DEEPL_API_KEY: ${{ secrets.DEEPL_API_KEY }}
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/vendor/

data/.rdoc_options

@@ -0,0 +1,27 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+- "./lib"
+charset: UTF-8
+exclude:
+- "bin/"
+- "vendor/"
+- "Gemfile.*"
+- ".*gemspec"
+- "Rakefile"
+hyperlink_all: false
+line_numbers: false
+locale:
+locale_dir: locale
+locale_name:
+main_page: README.md
+markup: markdown
+output_decoration: true
+page_dir:
+show_hash: false
+tab_width: 8
+template_stylesheets: []
+title: DeeplAPI Documentation
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.2.0] - 2021-05-23
+- Added support for the DeepL free tier which requires a different API endpoint, which will be automatically selected based on the provided API key.
+- Removed erroneous limitation of this gem to the darwin-20 platform. It supports all platforms that Ruby runs on.
+
+## [0.1.0] - 2021-02-15
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in deepl_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "rspec-temp_dir", "~> 1.1"
+
+gem "rubocop", "~> 1.7"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    deepl_api (0.2.0)
+      ruby-enum (~> 0.9)
+      thor (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rspec-temp_dir (1.1.0)
+      rspec (>= 3.0)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-enum (0.9.0)
+      i18n
+    ruby-progressbar (1.11.0)
+    thor (1.1.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  deepl_api!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-temp_dir (~> 1.1)
+  rubocop (~> 1.7)
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Martin Gruner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# deepl-api-rb
+
+This repository contains a [Ruby](https://www.ruby-lang.org/) implementation of the [DeepL REST API](https://www.deepl.com/docs-api/).
+
+## Contents
+
+- A [Ruby package](https://mgruner.github.io/deepl-api-rb-docs/DeeplAPI/DeepL.html) for easy integration into Ruby applications.
+- The `deepl` [unix-style commandline application](https://mgruner.github.io/deepl-api-rb-docs/lib/deepl_api/deepl_md.html) for integration into existing toolchains without any programming effort.
+- Unit and integration tests.
+
+Please refer to the linked documentation for instructions on how to get started with the API and/or the CLI tool.
+
+## Features
+
+- Query your account usage & limits information.
+- Fetch the list of available source and target languages provided by DeepL.
+- Translate text.
+
+## Not Implemented
+
+- Support for the [(beta) document translation endpoint](https://www.deepl.com/docs-api/translating-documents/).
+- Support for the [XML handling flags](https://www.deepl.com/docs-api/translating-text/) in the translation endpoint.
+
+## See Also
+
+There are comparable implementations for [Rust](https://github.com/mgruner/deepl-api-rs) and [Python](https://github.com/mgruner/deepl-api-py).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "deepl_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deepl_api.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/deepl_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "deepl_api"
+  spec.version       = DeeplAPI::VERSION
+  spec.authors       = ["Martin Gruner"]
+  spec.email         = ["mg.pub@gmx.net"]
+
+  spec.summary       = "Bindings and a commandline tool for the DeepL REST API"
+  spec.description   = "Bindings and a commandline tool for the DeepL REST API (https://www.deepl.com/docs-api/)"
+  spec.homepage      = "https://github.com/mgruner/deepl-api-rb"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mgruner/deepl-api-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/mgruner/deepl-api-rb/blob/next/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby-enum", "~> 0.9"
+  spec.add_dependency "thor", "~> 1.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/exe/deepl

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "deepl_api/cli"
+
+begin
+  DeeplAPI::CLI.start
+rescue StandardError => e
+  warn "Error: #{e}"
+  exit(1)
+end

data/lib/deepl_api.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "ruby-enum"
+require_relative "deepl_api/version"
+require_relative "deepl_api/errors"
+
+# Provides a lightweight wrapper for the DeepL Pro REST API.
+#
+# This gem contains both the [backend API](DeeplAPI/DeepL.html) and the
+# [deepl command line utility](lib/deepl_api/deepl_md.html).
+
+## Requirements
+#
+# You need to have a valid [DeepL Pro Developer](https://www.deepl.com/pro#developer) account
+# with an associated API key. This key must be made available to the application, e. g. via
+# environment variable:
+#
+# ```bash
+# export DEEPL_API_KEY=YOUR_KEY
+# ```
+#
+# ## Example
+#
+# ```text
+# require "deepl_api"
+#
+# deepl = DeeplAPI::DeepL.new( api_key: ENV["DEEPL_API_KEY"] )
+# usage = deepl.usage_information()
+# => #<DeeplAPI::UsageInformation:0x00007fcbc588cc08 @character_limit=250000, @character_count=1450>
+#
+# translation = deepl.translate( source_language: "DE", target_language: "EN-US", texts: ["ja"] )
+# => [{"detected_source_language"=>"DE", "text"=>"yes"}]
+# ```
+#
+# ## See Also
+#
+# The main API functions are documented in the DeepL class.
+
+module DeeplAPI
+  # The main API entry point representing a DeepL developer account with an associated API key.
+  #
+  # Use this to create a new DeepL API client instance where multiple function calls can be performed.
+  # A valid `api_key` is required.
+  #
+  # Should you ever need to use more than one DeepL account in our program, then you can create one
+  # instance for each account / API key.
+  #
+  # ##Error Handling
+  #
+  # These methods may throw exceptions from DeeplAPI::Errors and `Net::HTTP`.
+  class DeepL
+    # Create an instance by providing a valid API key.
+    def initialize(api_key:)
+      @api_key = api_key.to_s
+      @api_base_url = @api_key[-3, 3].eql?(":fx") ? "https://api-free.deepl.com/v2" : "https://api.deepl.com/v2"
+      return unless @api_key.empty?
+
+      raise DeeplAPI::Errors::DeeplAuthorizationError, "No API key provided."
+    end
+
+    # Retrieve information about API usage & limits.
+    # This can also be used to verify an API key without consuming translation contingent.
+    #
+    # Returns a DeeplAPI::UsageInformation object.
+    #
+    # See also the [vendor documentation](https://www.deepl.com/docs-api/other-functions/monitoring-usage/).
+    def usage_information
+      data = api_call(url: "/usage")
+      UsageInformation.new(
+        character_count: data["character_count"],
+        character_limit: data["character_limit"]
+      )
+    end
+
+    # Retrieve all currently available source languages.
+    #
+    # See also the [vendor documentation](https://www.deepl.com/docs-api/other-functions/listing-supported-languages/).
+    #
+    # Returns a dictionary like: `{"DE" => "German", ...}`
+    def source_languages
+      languages(type: "source")
+    end
+
+    # Retrieve all currently available target languages.
+    #
+    # See also the [vendor documentation](https://www.deepl.com/docs-api/other-functions/listing-supported-languages/).
+    #
+    # Returns a dictionary like: `{"DE" => "German", ...}`
+    def target_languages
+      languages(type: "target")
+    end
+
+    # rubocop:disable Metrics/ParameterLists, Style/KeywordParametersOrder
+
+    # Translate one or more text chunks at once. You can pass in optional
+    # translation options if you need non-default behaviour.
+    #
+    # Please see the parameter documentation and the
+    # [vendor documentation](https://www.deepl.com/docs-api/translating-text/) for details.
+    #
+    # Returns a list of dictionaries for the translated content:
+    #
+    # ```ruby
+    # [
+    #   {
+    #     "detected_source_language" => "DE",
+    #     "text" => "Yes. No.",
+    #   },
+    #   ...
+    # ]
+    # ```
+    def translate(
+      source_language: nil,
+      target_language:,
+      split_sentences: nil,
+      preserve_formatting: true,
+      formality: Formality::DEFAULT,
+      texts:
+    )
+      # rubocop:enable Metrics/ParameterLists, Style/KeywordParametersOrder
+
+      payload = {
+        target_lang: target_language,
+        text: texts
+      }
+
+      payload[:source_lang] = source_language unless source_language.nil?
+      payload[:split_sentences] = split_sentences unless split_sentences.nil?
+      payload[:preserve_formatting] = preserve_formatting unless preserve_formatting.nil?
+      payload[:formality] = formality unless formality.nil?
+
+      data = api_call(url: "/translate", payload: payload)
+
+      raise DeeplAPI::Errors::DeeplDeserializationError unless data.include?("translations")
+
+      data["translations"]
+    end
+
+    private
+
+    # Private method to perform the actual HTTP calls.
+    def api_call(url:, payload: {})
+      res = Net::HTTP.post_form(URI(@api_base_url + url), { **payload, auth_key: @api_key })
+      return JSON.parse(res.body) if res.instance_of? Net::HTTPOK
+      if res.instance_of?(Net::HTTPUnauthorized) || res.instance_of?(Net::HTTPForbidden)
+        raise DeeplAPI::Errors::DeeplAuthorizationError, "Authorization failed, is your API key correct?"
+      end
+
+      begin
+        data = JSON.parse(res.body)
+        if data["message"]
+          raise DeeplAPI::Errors::DeeplServerError,
+                "An error occurred while communicating with the DeepL server: '#{data["message"]}'."
+        end
+      rescue JSON::ParserError
+        raise DeeplAPI::Errors::DeeplServerError, res.code
+      end
+      raise DeeplAPI::Errors::DeeplServerError, res.code
+    end
+
+    # Private method to make API calls for the language lists
+    def languages(type:)
+      data = api_call(url: "/languages", payload: { type: type })
+      raise(DeeplAPI::Errors::DeeplDesearializationError) if !data.length || !data[0].include?("language")
+
+      result = {}
+      data.each { |i| result[i["language"]] = i["name"] }
+      result
+    end
+  end
+
+  # Information about API usage & limits for this account.
+  class UsageInformation
+    # How many characters can be translated per billing period, based on the account settings.
+    attr_reader :character_limit
+    # How many characters were already translated in the current billing period.
+    attr_reader :character_count
+
+    def initialize(character_limit:, character_count:)
+      @character_limit = character_limit
+      @character_count = character_count
+    end
+  end
+
+  # Translation option that controls the splitting of sentences before the translation.
+  #
+  # - `SplitSentences::NONE` - Don't split sentences.
+  # - `SplitSentences::PUNCTUATION` - Split on punctiation only.
+  # - `SplitSentences::PUNCTUATION_AND_NEWLINES` - Split on punctiation and newlines.
+  class SplitSentences
+    include Ruby::Enum
+
+    define :NONE, 0
+    define :PUNCTUATION, 1
+    define :PUNCTUATION_AND_NEWLINES, 2
+  end
+
+  # Translation option that controls the desired translation formality
+  #
+  # - `Formality::LESS` - Translate less formally.
+  # - `Formality::DEFAULT` - Default formality.
+  # - `Formality::MORE` - Translate more formally.
+  class Formality
+    include Ruby::Enum
+
+    define :LESS, "less"
+    define :DEFAULT, "default"
+    define :MORE, "more"
+  end
+end

data/lib/deepl_api/cli.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "../deepl_api"
+
+module DeeplAPI
+  # This class implements the `deepl` command line utility.
+  class CLI < Thor
+    def self.exit_on_failure?
+      # Exit in case of missing arguments etc.
+      true
+    end
+
+    desc "usage-information", "Fetch account usage information"
+    def usage_information
+      usage = instance.usage_information
+      puts("Available characters per billing period: #{usage.character_limit}")
+      puts("Characters already translated in the current billing period: #{usage.character_count}")
+    end
+
+    desc "languages", "Fetch information about available source and target languages"
+    def languages
+      deepl = instance
+      source_langs = deepl.source_languages
+      target_langs = deepl.target_languages
+
+      puts("DeepL can translate from the following source languages:")
+      source_langs.each { |language, name| puts("  #{language.ljust(5)} (#{name})") }
+      puts
+      puts("DeepL can translate to the following target languages:")
+      target_langs.each { |language, name| puts("  #{language.ljust(5)} (#{name})") }
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    option "source-language", desc: "The source language to use", banner: "DE"
+    option "target-language", desc: "The target language to use", banner: "EN", required: true
+    option "input-file", desc: "Read from this file rather than STDIN", banner: "path/to/file"
+    option "output-file", desc: "Write to this file rather than STDOUT", banner: "path/to/file"
+    option "preserve-formatting", desc: "Preserve source text formatting", type: :boolean
+    option "formality-more", desc: "Translate more formally", type: :boolean
+    option "formality-less", desc: "Translate less formally", type: :boolean
+    desc "translate", "Translate text"
+    def translate
+      formality = DeeplAPI::Formality::DEFAULT
+      formality = DeeplAPI::Formality::LESS if options["formality-less"]
+      formality = DeeplAPI::Formality::MORE if options["formality-more"]
+
+      text = if options["input-file"]
+               File.read(options["input-file"])
+             else
+               $stdin.read
+             end
+
+      result = instance.translate(
+        source_language: options["source-language"],
+        target_language: options["target-language"],
+        preserve_formatting: options["preserve-formatting"],
+        formality: formality,
+        texts: [text]
+      )
+
+      text = result.map { |entry| entry["text"] }.join
+
+      if options["output-file"]
+        File.write(options["output-file"], text)
+      else
+        puts text
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    private
+
+    def instance
+      api_key = ENV["DEEPL_API_KEY"].to_s
+      if api_key.empty?
+        raise StandardError, "No DEEPL_API_KEY found. Please provide your API key in this environment variable."
+      end
+
+      DeeplAPI::DeepL.new(api_key: ENV["DEEPL_API_KEY"])
+    end
+  end
+end

data/lib/deepl_api/deepl.md

@@ -0,0 +1,78 @@
+# `deepl` command line utility
+
+Unix-style commandline application for integrating the
+[DeepL API](https://www.deepl.com/docs-api/) into toolchains without any programming effort.
+
+*If you are looking for the `deepl-api` API library, please refer
+to [its documentation](../../DeeplAPI/DeepL.html) instead.*
+
+## Requirements
+
+You need to have a valid [DeepL Pro Developer](https://www.deepl.com/pro#developer) account
+with an associated API key. This key must be made available to the application, e. g. via
+environment variable:
+
+```bash
+export DEEPL_API_KEY=YOUR_KEY
+```
+
+## Examples
+
+### Overview
+
+To get an overview of the available commands, just invoke the program.
+
+```text
+shell> deepl
+Usage: deepl [OPTIONS] COMMAND [ARGS]...
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  languages
+  translate
+  usage-information
+```
+
+You can call `deepl help translate` to get a detailed reference for the various options of the
+`translate` command, for example.
+
+### Translating Text
+
+By default, `deepl` reads from `STDIN` and writes to `STDOUT`, which means that you can integrate
+it nicely into toolchains.
+
+```text
+shell> echo "Please go home." | deepl translate --source-language EN --target-language DE | cat -
+Bitte gehen Sie nach Hause.
+```
+
+By providing the options `--input-file` and / or `--output-file`, you can tell `deepl` to
+read from / write to files, rather than `STDIN` / `STDOUT`.
+
+### Retrieving Account Usage & Limits
+
+```text
+shell> deepl usage-information
+Available characters per billing period: 250000
+Characters already translated in the current billing period: 3317
+```
+
+### Retrieving Available Languages
+
+```text
+shell> deepl languages
+DeepL can translate from the following source languages:
+  DE    (German)
+  EN    (English)
+  ES    (Spanish)
+  ...
+
+DeepL can translate to the following target languages:
+  DE    (German)
+  EN-GB (English (British))
+  EN-US (English (American))
+  ES    (Spanish)
+  ...
+```

data/lib/deepl_api/errors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DeeplAPI
+  # DeepL API exception classes.
+  module Errors
+    # Base class for exceptions in this module.
+    class DeeplBaseError < StandardError
+    end
+
+    # Authorization failed.
+    class DeeplAuthorizationError < DeeplBaseError
+    end
+
+    # Received an error message from the server.
+    class DeeplServerError < DeeplBaseError
+    end
+
+    # Exception raised when deserialization the server response.
+    class DeeplDeserializationError < DeeplBaseError
+    end
+  end
+end

data/lib/deepl_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeeplAPI
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: deepl_api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Martin Gruner
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Bindings and a commandline tool for the DeepL REST API (https://www.deepl.com/docs-api/)
+email:
+- mg.pub@gmx.net
+executables:
+- deepl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rdoc_options"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deepl_api.gemspec
+- exe/deepl
+- lib/deepl_api.rb
+- lib/deepl_api/cli.rb
+- lib/deepl_api/deepl.md
+- lib/deepl_api/errors.rb
+- lib/deepl_api/version.rb
+homepage: https://github.com/mgruner/deepl-api-rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mgruner/deepl-api-rb
+  source_code_uri: https://github.com/mgruner/deepl-api-rb
+  changelog_uri: https://github.com/mgruner/deepl-api-rb/blob/next/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Bindings and a commandline tool for the DeepL REST API
+test_files: []