oxford_dictionary 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b30f885cc09faf1783a64f1b666103936d066373b0a8f2382750d1710fbe2a4
-  data.tar.gz: 9e7bb4ee4e9d066c30dcf062085159218b0540db781130ca400227bd65157725
+  metadata.gz: 76a707cc6713b8162a27f4ccbd2dd5f705a2488298fc6a4f47f64c1cdf58249f
+  data.tar.gz: c1ccb8317f36dfd52dcf0dcf84600c8cf698030f94e1a67edca17ae7b0a7623d
 SHA512:
-  metadata.gz: 30b60f3fceb455902872b749b61a7c9676d6962343051234d30d08414f43f98440a10d9c6a75029676d09bc5b7f8984874fb13573d94b0992ba2dc16c13a8302
-  data.tar.gz: 7a69d03c0cab8929e9e30191d4662123823d8dd1d63be2e2a80bdb74f7aa30f5075fbbba16c9e14b41874ff05e00b82960092f41486072ed77b489ef2d44b40a
+  metadata.gz: 8adefff2b029d5e3bc780c12f457848ef97000a34bf04fec3a9211b330fb55ed0477283c34c2f919a570d6425d58928c72d923ff7968595a3871c7e535831af0
+  data.tar.gz: 7fced4aff346f014ade560cb5652d157ed289e7f8862da9881dc6aa07308b1b7c57c07db2019bc82274ff6bf81eb763ce66ef4ee97332ced2c8fd4663c678718

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## OxfordDictionary master (unreleased)
 
+## OxfordDictionary 2.0.0 (2019-06-29)
+- Remove wordlist endpoint
+  [\#20](https://github.com/swcraig/oxford-dictionary/pull/20)
+- Use new V2 interface for V1 inflection usage
+  [\#21](https://github.com/swcraig/oxford-dictionary/pull/21)
+- Use new V2 interface for V1 search usage
+  [\#22](https://github.com/swcraig/oxford-dictionary/pull/22)
+- Use new V2 interface for V1 entry usage
+  [\#23](https://github.com/swcraig/oxford-dictionary/pull/23)
+- Remove all V1 functionality
+  [\#24](https://github.com/swcraig/oxford-dictionary/pull/24)
+
 ## OxfordDictionary 1.3.0 (2019-06-22)
 
 - Add V2 translations support

data/README.md

@@ -19,79 +19,67 @@ client = OxfordDictionary::Client.new(app_id: 'ID', app_key: 'SECRET')
 client = OxfordDictionary.new(app_id: 'ID', app_key: 'SECRET')
 ```
 ### Usage Examples
-Some documentation on the different endpoint function calls can be found [here](http://rubydoc.info/gems/oxford_dictionary/OxfordDictionary/Endpoints)
-
 This wrapper follows the schema laid out by the API quite closely. The data
 schema for the different API calls can be found [here](https://developer.oxforddictionaries.com/documentation).
 
-###### Get the results for an entry
+###### Entries
 ```ruby
-entry = client.entry('vapid')
+entry = client.entry(word: 'vapid', dataset: 'en-gb', params: {})
 
 # Access the first entry
 # Refer to the API documentation for the schema of the returned data structure
-first_lexical_entry = entry.lexical_entries[0]
+first_lexical_entry = entry.lexicalEntries.first
 
 # With some filters
 filters = { lexicalCategory: 'Verb', domains: 'Art'}
-client.entry('truth', filters)
+client.entry(word: 'truth', dataset: 'en-gb', params: filters)
+
+# You can also search for the results for different datasets
+# Refer to the Oxford Dictionaries documentation for all the
+# possible datasets
+client.entry(word: 'ace', dataset: 'es', params: {})
 
-# Or do them "inline"
-client.entry('truth', lexicalCategory: 'Verb', domains: 'Art')
+# You can query for results from a specific "field"
+# Refer to the Oxford Dictionaries documentation for all the
+# possible fields
+client.entry(word: 'explain', dataset: 'en-gb', params: { fields: 'examples' })
 
-# From a dictionary of a specific language (default is 'en')
-client.entry('ace', lang: 'es')
 ```
 
-###### Or return some subset of information
+###### Lemmas
 ```ruby
-# Like just the examples
-examples = client.entry_examples('explain')
-
-# Or only the pronunciations...
-the_noises = client.entry_pronunciations('knight')
-
-# Or the translations (for Swahili in this example)
-en_to_es = client.entry_translations('change', translations: 'sw')
-# If no :translations filter is supplied, default is 'es'
-
-# Or some of the other documented API calls
-client.entry_sentences('scholar')
-client.entry_definitions('correct')
-client.entry_antonyms_synonyms('monotonous')
-# Etc...
-
-# Generally the method names follow the documented API closely
+client.lemma(word: 'condition', language: 'en', params: {})
 ```
 
-###### Other endpoint calls
+###### Translations
 ```ruby
-# Inflections of a word
-inflections = client.inflection('changed')
-
-# Wordlist results (based on categorys, filters, etc...)
-related = client.wordlist(lexicalCategory: 'Noun', word_length: '>5,<10')
-
-# Or the search endpoint
-search_results = client.search('condition', prefix: true)
+client.translation(
+  word: 'condition',
+  source_language: 'en',
+  target_language: 'es',
+  params: {}
+)
 ```
 
-###### A quick note on how to add filters to queries
-There isn't much argument checking at the moment.  Some endpoints do not accept filter arguments, refer to the API documentation to check for endpoints that accept filters.
+###### Sentences
 ```ruby
-# All endpoints accept the :lang filter.  This specifies which dictionary to use
-# If no argument is supplied, default is 'en'
-filters = { lang: 'es' }
-
-# To use multiple values on a single filter, make it an array
-filters = { lexicalCategory: ['Noun', 'Verb'] }
+client.sentence(word: 'paraphrase', language: 'en', params: {})
+```
 
-# The wordlist endpoint specifically may include "nested" filters
-# These filters (exclude, exclude_senses, etc...) require arrays
-filters = { exclude: [domains: %w(sport art)] }
+###### Search
+```ruby
+client.search(language: 'en-gb', params: { q: 'vapid' })
 ```
 
-Argument names need to be in camelCase, not snake_case. However, the objects returned from API calls use snake_case attributes.
+###### Thesaurus
+```ruby
+client.thesaurus(
+  word: 'book',
+  language: 'en',
+  params: { fields: 'synonyms,antonyms}
+)
+# Or use { fields: 'synonyms' } for just synonyms
+```
 
 ## Development