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.

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

Add OxfordDictionary::Endpoints::Search #15

Merged
merged 3 commits into from
Jun 23, 2019
Merged

Add OxfordDictionary::Endpoints::Search #15

merged 3 commits into from
Jun 23, 2019

Conversation

swcraig
Copy link
Owner

@swcraig swcraig commented Jun 23, 2019

Oxford Dictionaries is updating their API to a new version which
includes quite a few changes:
https://developer.oxforddictionaries.com/version2

There have been updates to the search functionality which is documented
in the migration guide linked above.

I've tried to be smart and preserve the interface so that users can
upgrade to V2 without any immediate breaking changes (as long as the
V1 usage was what was documented in the README).

Check out OxfordDictionary::Endpoints::Search#search for how to use
the new interface which uses named parameters.

@swcraig swcraig changed the title Add v2 search Add OxfordDictionary::Endpoints::Search Jun 23, 2019
@swcraig swcraig marked this pull request as ready for review June 23, 2019 04:37
Oxford Dictionaries is updating their API to a new version which
includes quite a few changes:
https://developer.oxforddictionaries.com/version2

There have been updates to the search functionality which is documented
in the migration guide linked above.

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
Oxford Dictionaries is updating their API to a new version which
includes quite a few changes:
https://developer.oxforddictionaries.com/version2

There have been updates to the search functionality which is documented
in the migration guide linked above.

I've tried to be smart and preserve the interface so that users can
upgrade to V2 without any immediate breaking changes (as long as the
V1 usage was what was documented in the README).

Check out `OxfordDictionary::Endpoints::Search#search` for how to use
the new interface which uses named parameters.
Oxford Dictionaries is updating their API to a new version which
includes quite a few changes:
https://developer.oxforddictionaries.com/version2

There have been updates to the search functionality which is documented
in the migration guide linked above.

Use `Client#search` with named parameters instead. Reference
#15 for more
information.

I've tried to be smart and preserve the interface so that users can
upgrade to V2 without any immediate breaking changes (as long as the
V1 usage was what was documented in the README).

Check out OxfordDictionary::Endpoints::Search#search for how to use
the new interface which uses named parameters.
@swcraig swcraig merged commit 7dd3d64 into master Jun 23, 2019
@swcraig swcraig deleted the add-v2-search branch June 23, 2019 04:52
swcraig added a commit that referenced this pull request Jun 23, 2019
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
swcraig added a commit that referenced this pull request Jun 23, 2019
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
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
swcraig added a commit that referenced this pull request Jun 30, 2019
Oxford Dictionaries is upgrading their API. As part of the V2 changes
this library is going to use a named parameters approach to accessing
the endpoint. Reference
#15 for the new
interface.

https://developer.oxforddictionaries.com/version2
swcraig added a commit that referenced this pull request Jun 30, 2019
Oxford Dictionaries is upgrading their API. As part of the V2 changes
this library is going to use a named parameters approach to accessing
the endpoint. Reference
#15 for the new
interface.

https://developer.oxforddictionaries.com/version2
swcraig added a commit that referenced this pull request Jun 30, 2019
Oxford Dictionaries is upgrading their API. As part of the V2 changes
this library is going to use a named parameters approach to accessing
the endpoint. Reference
#15 for the new
interface.

https://developer.oxforddictionaries.com/version2
swcraig added a commit that referenced this pull request Jun 30, 2019
Oxford Dictionaries is upgrading their API. As part of the V2 changes
this library is going to use a named parameters approach to accessing
the endpoint. Reference
#15 for the new
interface.

https://developer.oxforddictionaries.com/version2
swcraig added a commit that referenced this pull request Jun 30, 2019
Oxford Dictionaries is upgrading their API. As part of the V2 changes
this library is going to use a named parameters approach to accessing
the endpoint. Reference
#15 for the new
interface.

https://developer.oxforddictionaries.com/version2
swcraig added a commit that referenced this pull request Jun 30, 2019
Oxford Dictionaries is upgrading their API. As part of the V2 changes
this library is going to use a named parameters approach to accessing
the endpoint. Reference
#15 for the new
interface.

https://developer.oxforddictionaries.com/version2
swcraig added a commit that referenced this pull request Jun 30, 2019
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
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
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
swcraig added a commit that referenced this pull request Jun 30, 2019
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
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant