Module: DeepL

Extended by:
DeepL
Included in:
DeepL
Defined in:
lib/deepl.rb,
lib/deepl/api.rb,
lib/deepl/glossary_api.rb,
lib/deepl/configuration.rb,
lib/deepl/requests/base.rb,
lib/deepl/requests/usage.rb,
lib/deepl/resources/base.rb,
lib/deepl/resources/text.rb,
lib/deepl/resources/usage.rb,
lib/deepl/exceptions/error.rb,
lib/deepl/requests/languages.rb,
lib/deepl/requests/translate.rb,
lib/deepl/resources/glossary.rb,
lib/deepl/resources/language.rb,
lib/deepl/exceptions/not_found.rb,
lib/deepl/exceptions/bad_request.rb,
lib/deepl/requests/glossary/find.rb,
lib/deepl/requests/glossary/list.rb,
lib/deepl/resources/language_pair.rb,
lib/deepl/utils/exception_builder.rb,
lib/deepl/exceptions/not_supported.rb,
lib/deepl/exceptions/request_error.rb,
lib/deepl/requests/glossary/create.rb,
lib/deepl/exceptions/limit_exceeded.rb,
lib/deepl/exceptions/quota_exceeded.rb,
lib/deepl/requests/glossary/destroy.rb,
lib/deepl/requests/glossary/entries.rb,
lib/deepl/exceptions/authorization_failed.rb,
lib/deepl/requests/glossary/language_pairs.rb,
lib/deepl/exceptions/request_entity_too_large.rb

Overview

– Gem interface

Defined Under Namespace

Modules: Exceptions, Requests, Resources, Utils Classes: API, Configuration, GlossaryApi

Instance Method Summary collapse

Instance Method Details

#api ⇒ Object

– API shortcuts



52
53
54
 
# File 'lib/deepl.rb', line 52

def api
  @api ||= API.new(configuration)
end

#configuration ⇒ Object

– Configuration



77
78
79
 
# File 'lib/deepl.rb', line 77

def configuration
  @configuration ||= Configuration.new
end

#configure {|configuration| ... } ⇒ Object

Yields:



81
82
83
84
 
# File 'lib/deepl.rb', line 81

def configure
  yield configuration if block_given?
  configuration.validate!
end

#glossaries(options = {}) ⇒ Object 



65
66
67
68
 
# File 'lib/deepl.rb', line 65

def glossaries(options = {})
  configure if @configuration.nil?
  GlossaryApi.new(api, options)
end

#languages(options = {}) ⇒ Object 



56
57
58
 
# File 'lib/deepl.rb', line 56

def languages(options = {})
  Requests::Languages.new(api, options).request
end

#translate(text, source_lang, target_lang, options = {}) ⇒ Object 



60
61
62
63
 
# File 'lib/deepl.rb', line 60

def translate(text, source_lang, target_lang, options = {})
  configure if @configuration.nil?
  Requests::Translate.new(api, text, source_lang, target_lang, options).request
end

#usage(options = {}) ⇒ Object 



70
71
72
73
 
# File 'lib/deepl.rb', line 70

def usage(options = {})
  configure if @configuration.nil?
  Requests::Usage.new(api, options).request
end