Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add OxfordDictionary::Endpoints::Thesaurus #14

Merged
merged 3 commits into from
Jun 23, 2019
Merged

Add OxfordDictionary::Endpoints::Thesaurus #14

merged 3 commits into from
Jun 23, 2019

Conversation

swcraig
Copy link
Owner

@swcraig swcraig commented Jun 23, 2019 •
edited
Loading

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 thesaurus functionality to its own endpoint
(instead of having part of the entries endpoint).

Use Client#thesaurus instead. Specifically use Client#thesaurus with
the filter parameter to define what you want.

For example:

Client.thesaurus(
  word: 'ace',
  language: 'en',
  params: { filter: 'synonyms,antonyms' }
)

Or to get just the synonyms/antonyms:

Client.thesaurus(
  word: 'ace',
  language: 'en',
  params: { filter: 'synonyms' }
)

@swcraig swcraig force-pushed the add-v2-thesaurus branch 2 times, most recently from 1a9f9ea to b5e27ea Compare June 23, 2019 03:55
swcraig added 2 commits June 22, 2019 20:56
@swcraig
Add OxfordDictionary::Endpoints::Thesaurus
8afc9d1 
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 thesaurus 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
@swcraig
Add OxfordDictionary::Client#thesaurus
3a32f75 
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 thesaurus functionality to its own endpoint
(instead of having part of the entries endpoint).

Use this instead of `Client#entry_synonyms`, `Client#entry_antonyms`,
and `Client#entry_antonyms_synonyms`.
@swcraig swcraig force-pushed the add-v2-thesaurus branch from b5e27ea to 3880332 Compare June 23, 2019 04:00
@swcraig
Deprecate V1 Thesaurus functionality
8a55e0f 
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 thesaurus functionality to its own endpoint
(instead of having part of the entries endpoint).

Use `Client#thesaurus` instead. Specifically use `Client#thesaurus` with
the `filter` parameter to define what you want.

For example:

```
Client.thesaurus(
  word: 'ace',
  language: 'en',
  params: { filter: 'synonyms,antonyms' }
)

```
@swcraig swcraig force-pushed the add-v2-thesaurus branch from 3880332 to 8a55e0f Compare June 23, 2019 04:01
@swcraig swcraig marked this pull request as ready for review June 23, 2019 04:02
@swcraig swcraig merged commit 0cc0ef2 into master Jun 23, 2019
@swcraig swcraig deleted the add-v2-thesaurus branch June 23, 2019 04:05
swcraig added a commit that referenced this pull request Jun 23, 2019
@swcraig
Cut 1.3.0
9910911 
Oxford Dictionaries is updating their API to a new version which
includes quite a few changes:
https://developer.oxforddictionaries.com/version2

Oxford Dictionaries is taking their V1 API offline on June 30, 2019.

The deprecation warnings (please check the closed PRs online which
include them) should give an idea on how users should update their
applications to use the new V2 interfaces. All V2 interfaces use named
parameters and specifically leverage their `params` arguments for more
control over how the endpoints are called. Check out [Oxford
Dictionaries' online documentation]
(https://developer.oxforddictionaries.com/documentation), the specs, and
the commit messages for the V2 endpoints for more information.

v1.3.0 does not include a README update (I will do that when I cut
v2.0.0).

The 2.0.0 of this library will include the removal of all V1 interfaces.

The V2 interfaces for this library are in the following PRs:
Entries: #8
Translations: #12
Sentences: #13
Thesaurus: #14
Lemmas: #10
Search: #15
@swcraig swcraig mentioned this pull request Jun 23, 2019
Merged
swcraig added a commit that referenced this pull request Jun 23, 2019
@swcraig
Cut 1.3.0
d3ebc5e 
Oxford Dictionaries is updating their API to a new version which
includes quite a few changes:
https://developer.oxforddictionaries.com/version2

Oxford Dictionaries is taking their V1 API offline on June 30, 2019.

The deprecation warnings (please check the closed PRs online which
include them) should give an idea on how users should update their
applications to use the new V2 interfaces. All V2 interfaces use named
parameters and specifically leverage their `params` arguments for more
control over how the endpoints are called. Check out [Oxford
Dictionaries' online documentation]
(https://developer.oxforddictionaries.com/documentation), the specs, and
the commit messages for the V2 endpoints for more information.

v1.3.0 does not include a README update (I will do that when I cut
v2.0.0).

The 2.0.0 of this library will include the removal of all V1 interfaces.

The V2 interfaces for this library are in the following PRs:
Entries: #8
Translations: #12
Sentences: #13
Thesaurus: #14
Lemmas: #10
Search: #15
swcraig added a commit that referenced this pull request Jun 23, 2019
@swcraig
Cut 1.3.0
3e15d3d 
Oxford Dictionaries is updating their API to a new version which
includes quite a few changes:
https://developer.oxforddictionaries.com/version2

Oxford Dictionaries is taking their V1 API offline on June 30, 2019.

The deprecation warnings (please check the closed PRs online which
include them) should give an idea on how users should update their
applications to use the new V2 interfaces. All V2 interfaces use named
parameters and specifically leverage their `params` arguments for more
control over how the endpoints are called. Check out [Oxford
Dictionaries' online documentation]
(https://developer.oxforddictionaries.com/documentation), the specs, and
the commit messages for the V2 endpoints for more information.

v1.3.0 does not include a README update (I will do that when I cut
v2.0.0).

The 2.0.0 of this library will include the removal of all V1 interfaces.

The V2 interfaces for this library are in the following PRs:
Entries: #8
Translations: #12
Sentences: #13
Thesaurus: #14
Lemmas: #10
Search: #15
This was referenced Jun 23, 2019
Closed
Merged
swcraig added a commit that referenced this pull request Jun 30, 2019
@swcraig
Add basic V2 documentation to the README
46e967b 
Oxford Dictionaries has discontinued their V1 API (it will be taken
offline on June 30, 2019). As part of the upgrade of this wrapper the
new interface uses named parameters.

Reference the following PRs for the new usage:
- Entries: #8
- Translations: #12
- Sentences: #13
- Thesaurus: #14
- Lemmas: #10
- Search: #15

All of the response objects are OpenStructs with camelCase keys. This is
a departure from V1 (which used snake_case keys in the response).
swcraig added a commit that referenced this pull request Jun 30, 2019
@swcraig
Add basic V2 documentation to the README
8fa34ff 
Oxford Dictionaries has discontinued their V1 API (it will be taken
offline on June 30, 2019). As part of the upgrade of this wrapper the
new interface uses named parameters.

Reference the following PRs for the new usage:
- Entries: #8
- Translations: #12
- Sentences: #13
- Thesaurus: #14
- Lemmas: #10
- Search: #15

All of the response objects are OpenStructs with camelCase keys. This is
a departure from V1 (which used snake_case keys in the response).
swcraig added a commit that referenced this pull request Jun 30, 2019
@swcraig
Cut 2.0.0
d10d6c6 
Oxford Dictionaries has made a V2 upgrade to their API and will be
taking their V1 API offline on June 30, 2019.

Reference the following PRs for the new usage:
- Entries: #8
- Translations: #12
- Sentences: #13
- Thesaurus: #14
- Lemmas: #10
- Search: #15

This version uses the V2 endpoints exclusively.
@swcraig swcraig mentioned this pull request Jun 30, 2019
Merged
swcraig added a commit that referenced this pull request Jun 30, 2019
@swcraig
Cut 2.0.0
f9dcfc7 
Oxford Dictionaries has made a V2 upgrade to their API and will be
taking their V1 API offline on June 30, 2019.

Reference the following PRs for the new usage:
- Entries: #8
- Translations: #12
- Sentences: #13
- Thesaurus: #14
- Lemmas: #10
- Search: #15

This version uses the V2 endpoints exclusively.
swcraig added a commit that referenced this pull request Jun 30, 2019
@swcraig
Cut 2.0.0
bb7475f 
Oxford Dictionaries has made a V2 upgrade to their API and will be
taking their V1 API offline on June 30, 2019.

Reference the following PRs for the new usage:
- Entries: #8
- Translations: #12
- Sentences: #13
- Thesaurus: #14
- Lemmas: #10
- Search: #15

This version uses the V2 endpoints exclusively.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@swcraig