Class: EasyTranslate::Translation::TranslationRequest

Inherits:
Request
  • Object
show all
Defined in:
lib/easy_translate/translation.rb

Overview

A convenience class for wrapping a translation request

Instance Attribute Summary

Attributes inherited from Request

#http_options

Instance Method Summary collapse

Methods inherited from Request

#perform_raw

Constructor Details

#initialize(texts, options, http_options = {}) ⇒ TranslationRequest

Set the texts and options

Parameters:

  • texts (String, Array) —

    • the text (or texts) to translate

  • options (Hash) —

    • Options to override or pass along with the request

Raises:

  • (ArgumentError) 


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/easy_translate/translation.rb', line 64

def initialize(texts, options, http_options = {})
  options = options.dup
  self.texts = texts
  self.html = options.delete(:html)
  @source = options.delete(:from)
  @target = options.delete(:to)
  raise ArgumentError.new('No target language provided') unless @target
  raise ArgumentError.new('Support for multiple targets dropped in V2') if @target.is_a?(Array)
  @http_options = http_options
  if options
    @options = options
    if replacement_api_key = @options.delete(:api_key)
      @options[:key] = replacement_api_key
    end
  end
end

Instance Method Details

#body ⇒ String

The body for the request

Returns:

  • (String) —

    the body for the request, URL escaped



100
101
102
 
# File 'lib/easy_translate/translation.rb', line 100

def body
  @texts.map { |t| "q=#{CGI::escape(t)}" }.join '&'
end

#multi? ⇒ Boolean

Whether or not this was a request for multiple texts

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/easy_translate/translation.rb', line 106

def multi?
  @multi
end

#params ⇒ Hash

The params for this request

Returns:

  • (Hash) —

    the params for the request



83
84
85
86
87
88
89
90
 
# File 'lib/easy_translate/translation.rb', line 83

def params
  params          = super || {}
  params[:source] = lang(@source) unless @source.nil?
  params[:target] = lang(@target) unless @target.nil?
  params[:format] = @format unless @format.nil?
  params.merge! @options if @options
  params
end

#path ⇒ String

The path for the request

Returns:

  • (String) —

    The path for the request



94
95
96
 
# File 'lib/easy_translate/translation.rb', line 94

def path
  '/language/translate/v2'
end