oxford_dictionary 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0f3926d3f83c2ba8e1bdd3e8d495d8711477f61c
-  data.tar.gz: 0c8cb98e9868d75be5472937b73aa8dbb63f2d08
+SHA256:
+  metadata.gz: ffecd6360a45c8bdfad1a77ff7e73784e785690c05c87d6d6bb58456c764d716
+  data.tar.gz: 4f5ad09e2c4b424d1bb49eae62a5e37b5c3ee2faf2de7cec72c2bbcab2ea3e83
 SHA512:
-  metadata.gz: e8834b1e8c46e0dcad3a487f6a8e0fbe9e2da18d3f1e55661ed47d4e65dec6f9fc60603e9afedcb5683fa76cb434d15d239e7c077e474ca1c3156d912d22599f
-  data.tar.gz: 183e9474dcddd60208adfbc78c60c3c0a6eb65c95f0ec82210538be288687f729dfcc7eb46cdf107f12c3b7849eacf72f7ffea2f2f60ac0c3ce24f7034d661c1
+  metadata.gz: 5b3d5945ce79c7e0d36ac8d981b73813c12245870146d68132e0da67ee98a5149994ac8262c48da1951fba09febd39b639e1f603517f3b12e67851601ee92178
+  data.tar.gz: 28dbe3edc24b6ec9ede400141a01029e21bdfde2aeadedafc0fedc66dbbdc1051e79c833673dab32c5cf11bc105a770c0e457d750bf4106953f6ae7cc3dc3f0f

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## OxfordDictionary master (unreleased)
 
+## OxfordDictionary 1.0.1 (2019-05-07)
+
+- Deprecate the Wordlist endpoint
+  [\#5](https://github.com/swcraig/oxford-dictionary/pull/5)
+
 ## OxfordDictionary 1.0.0 (2017-09-19)
 
 - Remove httparty as a runtime dependency

data/README.md

@@ -14,10 +14,10 @@ Ruby wrapper to consume the [Oxford Dictionary API](https://developer.oxforddict
     require 'oxford_dictionary'
 
 After registering for an API key, setup the client:
-
-    client = OxfordDictionary::Client.new(app_id: 'ID', app_key: 'SECRET')
-    client = OxfordDictionary.new(app_id: 'ID', app_key: 'SECRET')
-
+```ruby
+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)
 
@@ -25,67 +25,71 @@ 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
+```ruby
+entry = client.entry('vapid')
 
-    entry = client.entry('vapid')
+# Access the first entry
+# Refer to the API documentation for the schema of the returned data structure
+first_lexical_entry = entry.lexical_entries[0]
 
-    # Access the first entry
-    # Refer to the API documentation for the schema of the returned data structure
-    first_lexical_entry = entry.lexical_entries[0]
+# With some filters
+filters = { lexicalCategory: 'Verb', domains: 'Art'}
+client.entry('truth', filters)
 
-    # With some filters
-    filters = { lexicalCategory: 'Verb', domains: 'Art'}
-    client.entry('truth', filters)
+# Or do them "inline"
+client.entry('truth', lexicalCategory: 'Verb', domains: 'Art')
 
-    # Or do them "inline"
-    client.entry('truth', lexicalCategory: 'Verb', domains: 'Art')
-
-    # From a dictionary of a specific language (default is 'en')
-    client.entry('ace', lang: 'es')
+# From a dictionary of a specific language (default is 'en')
+client.entry('ace', lang: 'es')
+```
 
 ###### Or return some subset of information
+```ruby
+# Like just the examples
+examples = client.entry_examples('explain')
 
-    # Like just the examples
-    examples = client.entry_examples('explain')
-
-    # Or only the pronunciations...
-    the_noises = client.entry_pronunciations('knight')
+# 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 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...
+# 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
+# Generally the method names follow the documented API closely
+```
 
 ###### Other endpoint calls
+```ruby
+# Inflections of a word
+inflections = client.inflection('changed')
 
-    # Inflections of a word
-    inflections = client.inflection('changed')
+# Wordlist results (based on categorys, filters, etc...)
+related = client.wordlist(lexicalCategory: 'Noun', word_length: '>5,<10')
 
-    # 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)
+# Or the search endpoint
+search_results = client.search('condition', prefix: true)
+```
 
 ###### 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.
-
-    # 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'] }
-
-    # The wordlist endpoint specifically may include "nested" filters
-    # These filters (exclude, exclude_senses, etc...) require arrays
-    filters = { exclude: [domains: %w(sport art)] }
+```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'] }
+
+# The wordlist endpoint specifically may include "nested" filters
+# These filters (exclude, exclude_senses, etc...) require arrays
+filters = { exclude: [domains: %w(sport art)] }
+```
 
 Argument names need to be in camelCase, not snake_case. However, the objects returned from API calls use snake_case attributes.
 

data/lib/oxford_dictionary/endpoints/wordlist_endpoint.rb

@@ -6,6 +6,8 @@ module OxfordDictionary
     # Interface to '/wordlist' endpoint
     module WordlistEndpoint
       include OxfordDictionary::Request
+      extend Gem::Deprecate
+
       ENDPOINT = 'wordlist'.freeze
       ADVANCED_FILTERS = [:exact, :exclude, :exclude_senses,
                           :exclude_prime_senses, :limit, :offset,
@@ -18,6 +20,7 @@ module OxfordDictionary
         end
         ListResponse.new(request(ENDPOINT, nil, params))
       end
+      deprecate :wordlist, :none, 2019, 6
 
       private
 

data/lib/oxford_dictionary/version.rb

@@ -1,3 +1,3 @@
 module OxfordDictionary
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxford_dictionary
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - swcraig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2019-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A wrapper for the Oxford Dictionary API