Class: DeepL::Requests::Base

Inherits:

Object

• Object
• DeepL::Requests::Base

Defined in:

lib/deepl/requests/base.rb

Overview

rubocop:disable Metrics/ClassLength

Direct Known Subclasses

Document::Download, Document::GetStatus, Document::Upload, Glossary::Create, Glossary::Destroy, Glossary::Entries, Glossary::Find, Glossary::LanguagePairs, Glossary::List, Languages, Rephrase, StyleRule::Create, StyleRule::CreateCustomInstruction, StyleRule::Destroy, StyleRule::DestroyCustomInstruction, StyleRule::Find, StyleRule::FindCustomInstruction, StyleRule::List, StyleRule::Update, StyleRule::UpdateConfiguredRules, StyleRule::UpdateCustomInstruction, Translate, TranslationMemory::Base, TranslationMemory::StorageBase, Usage

Constant Summary

MAX_GLOSSARY_IDS =

Maximum number of glossaries that may be provided via the glossary_ids option.

5

Instance Attribute Summary

• #api ⇒ Object readonly

  Returns the value of attribute api.

• #options ⇒ Object readonly

  Returns the value of attribute options.

• #response ⇒ Object readonly

  Returns the value of attribute response.

Instance Method Summary

• #details ⇒ Object
• #initialize(api, options = {}, additional_headers = {}) ⇒ Base constructor

  A new instance of Base.

• #request ⇒ Object

Constructor Details

#initialize(api, options = {}, additional_headers = {}) ⇒ Base

Returns a new instance of Base.

# File 'lib/deepl/requests/base.rb', line 14

def initialize(api, options = {}, additional_headers = {})
  @api = api
  @options = options
  @additional_headers = additional_headers
  @num_retries = 0
  @backoff_timer = Utils::BackoffTimer.new
end

Instance Attribute Details

#api ⇒ Object (readonly)

Returns the value of attribute api.

# File 'lib/deepl/requests/base.rb', line 12

def api
  @api
end

#options ⇒ Object (readonly)

Returns the value of attribute options.

# File 'lib/deepl/requests/base.rb', line 12

def options
  @options
end

#response ⇒ Object (readonly)

Returns the value of attribute response.

# File 'lib/deepl/requests/base.rb', line 12

def response
  @response
end

Instance Method Details

#details ⇒ Object

# File 'lib/deepl/requests/base.rb', line 26

def details
  "HTTP Headers #{headers}"
end

#request ⇒ Object

Raises:

• (NotImplementedError)

# File 'lib/deepl/requests/base.rb', line 22

def request
  raise NotImplementedError
end