Skip to content

Commit

Permalink
Add Translations endpoint for V2
Browse files Browse the repository at this point in the history
Oxford Dictionaries is updating their API to a new version which
includes quite a few changes:
https://developer.oxforddictionaries.com/version2

They are moving the translations functionality to its own endpoint
(instead of having part of the entries endpoint).

As mentioned in the tests, this only unit tests the endpoint. If someone
would like to contribute, please feel free to update and run the specs
(similar to what was done for the Entries and Lemmas endpoints).

Entries: #8
Lemmas: #10
  • Loading branch information
swcraig committed Jun 23, 2019
1 parent a2a11d9 commit 37d5c97
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 0 deletions.
32 changes: 32 additions & 0 deletions lib/oxford_dictionary/endpoints/translations.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
require 'oxford_dictionary/deserialize'

module OxfordDictionary
module Endpoints
class Translations
ENDPOINT = 'translations'.freeze

def initialize(request_client:)
@request_client = request_client
end

def translation(word:, source_language:, target_language:, params: {})
query_string =
"#{ENDPOINT}/#{source_language}/#{target_language}/#{word}"
uri = URI(query_string)

unless params.empty?
uri.query = URI.encode_www_form(params)
end

response = @request_client.get(uri: uri)
deserialize.call(response.body)
end

private

def deserialize
@deserialize ||= OxfordDictionary::Deserialize.new
end
end
end
end
75 changes: 75 additions & 0 deletions spec/endpoints/translations_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
require 'spec_helper'
require 'oxford_dictionary/endpoints/translations'

# Spec dependencies
require 'oxford_dictionary/request'

RSpec.describe OxfordDictionary::Endpoints::Translations do
let(:request_client) do
OxfordDictionary::Request.
new(app_id: ENV['APP_ID'], app_key: ENV['APP_KEY'])
end

let(:endpoint) { described_class.new(request_client: request_client) }

let(:word) { 'ace' }
let(:source_language) { 'en' }
let(:target_language) { 'es' }
let(:params) { {} }

# The translations endpoint is only avaiable to the paid tier
# If someone with a paid tier account would like to contribute, please
# feel free remove this double (and the stub in the tests), uncomment the
# sections that run VCR against the live endpoint, and PR the resulting files
let(:response_double) { double(body: {}.to_json) }

describe '#translation' do
subject do
endpoint.translation(
word: word,
source_language: source_language,
target_language: target_language,
params: params
)
end

it 'calls API as expected', :aggregate_failures do
expected_uri =
URI("translations/#{source_language}/#{target_language}/#{word}")

expect(request_client).to receive(:get).
with(uri: expected_uri).
and_return(response_double)

subject

# VCR.use_cassette('translations#translation') do
# response = subject
# expect(response).to be_an(OpenStruct)
# expect(response.results.first.id).to eq(word)
# expect(response.results.first.lexicalEntries).to all(be_an(OpenStruct))
# end
end

context 'when the params include strictMatch: true' do
let(:params) { { strictMatch: true } }

it 'only returns strict match translations', :aggregate_failures do
expected_uri =
URI("translations/#{source_language}/#{target_language}/#{word}?strictMatch=true")

expect(request_client).to receive(:get).
with(uri: expected_uri).
and_return(response_double)

subject

# VCR.use_cassette('translations#translation-strict') do
# response = subject
# expect(response).to be_an(OpenStruct)
# expect(response.results.first.id).to eq(word)
# end
end
end
end
end

0 comments on commit 37d5c97

Please sign in to comment.