oxford_dictionary 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 181397797e822f74e2ffd2904834d9d057f611f166c3f1b4cc717f79ed899ad3
-  data.tar.gz: 14ed048797dafe19066a7fb9ad94ec21d6f776a8512dab20c389bead210da32b
+  metadata.gz: 78ec18e159b5cbee6d642ed69123ce7478c2d578c9a8cac8ebc87462eb9f44fe
+  data.tar.gz: fd8b47b41a3693f5dcd55c9fa97b260ae9278405a12b596ad3fd9276b2e7ab1c
 SHA512:
-  metadata.gz: e6d27d507afb9196658b8c07faa4170f1d2ccf3fe3fa5e216095eae04d027a87b04f189d390b898eebf40e6cf793179582d9b66408e691606f4830b92eb1969a
-  data.tar.gz: 47cf60f38d246938585962dd2d8aeead434337331cef0fd4c49e1cb40eb4b34b206475973db9503203f71b3ad2836f0a9197929852925172fad12ee73e5ff058
+  metadata.gz: 1e6eeb2e17ceb1be3473863ac38a94f44a0f4f4ae6101a31ccf00504d84d90380484c51a33e3e20f066dae77a70840930c334165b4689848bb27b92701d0e7e0
+  data.tar.gz: 1d57ef61a92b985d85d8ca5be8890852c8c734c7dea76f9e96c6761a03d01c15b0f1f5bf8ff58af0137138d4aad98897efedf9e8c40849597a1de0b1449df4c6

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## OxfordDictionary master (unreleased)
 
+## OxfordDictionary 1.3.0 (2019-06-22)
+
+- Add V2 translations support
+  [\#10](https://github.com/swcraig/oxford-dictionary/pull/12)
+- Add V2 sentences support
+  [\#10](https://github.com/swcraig/oxford-dictionary/pull/13)
+- Add V2 thesaurus support
+  [\#10](https://github.com/swcraig/oxford-dictionary/pull/14)
+- Add V2 search support
+  [\#10](https://github.com/swcraig/oxford-dictionary/pull/15)
+
 ## OxfordDictionary 1.2.0 (2019-06-22)
 
 - Add V2 lemmas support

data/lib/oxford_dictionary/client.rb

@@ -5,6 +5,10 @@ require 'oxford_dictionary/endpoints/wordlist_endpoint'
 
 require 'oxford_dictionary/endpoints/entries'
 require 'oxford_dictionary/endpoints/lemmas'
+require 'oxford_dictionary/endpoints/translations'
+require 'oxford_dictionary/endpoints/sentences'
+require 'oxford_dictionary/endpoints/thesaurus'
+require 'oxford_dictionary/endpoints/search'
 
 module OxfordDictionary
   # The client object to interact with
@@ -28,11 +32,11 @@ module OxfordDictionary
     def entry(*args)
       if args.first.is_a?(Hash)
         args = args.first
-          entry_endpoint.entry(
-            word: args[:word],
-            dataset: args[:dataset],
-            params: args[:params]
-          )
+        entry_endpoint.entry(
+          word: args[:word],
+          dataset: args[:dataset],
+          params: args[:params]
+        )
       else
         warn '''
           The V1 interface for this library is DEPRECATED and will become
@@ -56,6 +60,57 @@ module OxfordDictionary
       lemma_endpoint.lemma(word: word, language: language, params: params)
     end
 
+    def translation(word:, source_language:, target_language:, params: {})
+      translation_endpoint.translation(
+        word: word,
+        source_language: source_language,
+        target_language: target_language,
+        params: params
+      )
+    end
+
+    def sentence(word:, language:, params: {})
+      sentence_endpoint.sentence(word: word, language: language, params: params)
+    end
+
+    def thesaurus(word:, language:, params: {})
+      thesaurus_endpoint.thesaurus(
+        word: word,
+        language: language,
+        params: params
+      )
+    end
+
+    def search(*args)
+      if args.first.is_a?(Hash)
+        args = args.first
+        search_endpoint.search(language: args[:language], params: args[:params])
+      else
+        warn '''
+          Client#search without parameters is DEPRECATED.
+          Using the method without named parameters will become
+          non-functional on June 30, 2019. Use the new V2 interface for this
+          method instead. Reference github.com/swcraig/oxford-dictionary/pull/15
+          for more information. Specifically check out
+          OxfordDictionary::Endpoints::Search#search for the new interface.
+        '''
+        if args[1].is_a?(Hash) && args[1][:translations]
+          super(args[0], translations: args[1][:translations])
+        else
+          super(*args)
+        end
+      end
+    end
+
+    def search_translation(source_language:, target_language:, params: {})
+      search_endpoint.search_translation(
+        source_language: source_language,
+        target_language: target_language,
+        params: params
+      )
+    end
+
+
     private
 
     def lemma_endpoint
@@ -63,11 +118,35 @@ module OxfordDictionary
         OxfordDictionary::Endpoints::Lemmas.new(request_client: request_client)
     end
 
+    def translation_endpoint
+      @translation_endpoint ||= OxfordDictionary::Endpoints::Translations.new(
+        request_client: request_client
+      )
+    end
+
     def entry_endpoint
       @entry_endpoint ||=
         OxfordDictionary::Endpoints::Entries.new(request_client: request_client)
     end
 
+    def sentence_endpoint
+      @sentence_endpoint ||= OxfordDictionary::Endpoints::Sentences.new(
+        request_client: request_client
+      )
+    end
+
+    def search_endpoint
+      @search_endpoint ||= OxfordDictionary::Endpoints::Search.new(
+        request_client: request_client
+      )
+    end
+
+    def thesaurus_endpoint
+      @thesaurus_endpoint ||= OxfordDictionary::Endpoints::Thesaurus.new(
+        request_client: request_client
+      )
+    end
+
     def request_client
       @request_client ||=
         OxfordDictionary::Request.new(app_id: @app_id, app_key: @app_key)

data/lib/oxford_dictionary/endpoints/endpoint.rb

@@ -0,0 +1,17 @@
+require 'oxford_dictionary/deserialize'
+
+module OxfordDictionary
+  module Endpoints
+    class Endpoint
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      private
+
+      def deserialize
+        @deserialize ||= OxfordDictionary::Deserialize.new
+      end
+    end
+  end
+end

data/lib/oxford_dictionary/endpoints/entries.rb

@@ -1,15 +1,11 @@
-require 'oxford_dictionary/deserialize'
+require 'oxford_dictionary/endpoints/endpoint'
 require 'plissken'
 
 module OxfordDictionary
   module Endpoints
-    class Entries
+    class Entries < Endpoint
       ENDPOINT = 'entries'.freeze
 
-      def initialize(request_client:)
-        @request_client = request_client
-      end
-
       def entry(word:, dataset:, params: {})
         query_string = "#{ENDPOINT}/#{dataset}/#{word}"
         uri = URI(query_string)
@@ -34,12 +30,6 @@ module OxfordDictionary
         snake_keys = JSON.parse(response.body).to_snake_keys
         deserialize.call(JSON.generate(snake_keys))
       end
-
-      private
-
-      def deserialize
-        @deserialize ||= OxfordDictionary::Deserialize.new
-      end
     end
   end
 end

data/lib/oxford_dictionary/endpoints/entry_endpoint.rb

@@ -13,41 +13,110 @@ module OxfordDictionary
       end
 
       def entry_definitions(query, params = {})
+        warn '''
+        Client#entry_defintions is DEPRECATED and will become non-functional
+        on June 30, 2019. Use Client#entry instead. Reference
+        https://github.com/swcraig/oxford-dictionary/pull/8 for more
+        information. Check out OxfordDictionary::Endpoints::Entries for the
+        interface to use. Specifically use it with
+        params: { fields: \'definitions\' }
+        '''
+
         params[:end] = 'definitions'
         entry_request(query, params)
       end
 
       def entry_examples(query, params = {})
+        warn '''
+        Client#entry_examples is DEPRECATED and will become non-functional
+        on June 30, 2019. Use Client#entry instead. Reference
+        https://github.com/swcraig/oxford-dictionary/pull/8 for more
+        information. Check out OxfordDictionary::Endpoints::Entries for the
+        interface to use. Specifically use it with
+        params: { fields: \'examples\' }
+        '''
+
         params[:end] = 'examples'
         entry_request(query, params)
       end
 
       def entry_pronunciations(query, params = {})
+        warn '''
+        Client#entry_pronunciations is DEPRECATED and will become non-functional
+        on June 30, 2019. Use Client#entry instead. Reference
+        https://github.com/swcraig/oxford-dictionary/pull/8 for more
+        information. Check out OxfordDictionary::Endpoints::Entries for the
+        interface to use. Specifically use it with
+        params: { fields: \'pronunciations\' }
+        '''
+
         params[:end] = 'pronunciations'
         entry_request(query, params)
       end
 
       def entry_sentences(query, params = {})
+        warn '''
+        Client#entry_sentences is DEPRECATED and will become non-functional
+        on June 30, 2019. Use Client#sentence instead. Reference
+        https://github.com/swcraig/oxford-dictionary/pull/13 for more
+        information. Check out OxfordDictionary::Endpoints::Sentences for the
+        interface to use.
+        '''
+
         params[:end] = 'sentences'
         entry_request(query, params)
       end
 
       def entry_antonyms(query, params = {})
+        warn '''
+        Client#entry_antonyms is DEPRECATED and will become non-functional
+        on June 30, 2019. Use Client#thesaurus instead. Reference
+        https://github.com/swcraig/oxford-dictionary/pull/13 for more
+        information. Check out OxfordDictionary::Endpoints::Thesaurus for the
+        interface to use. Specifically use it with
+        params: { fields: \'antonyms\' }
+        '''
+
         params[:end] = 'antonyms'
         entry_request(query, params)
       end
 
       def entry_synonyms(query, params = {})
+        warn '''
+        Client#entry_synonyms is DEPRECATED and will become non-functional
+        on June 30, 2019. Use Client#thesaurus instead. Reference
+        https://github.com/swcraig/oxford-dictionary/pull/13 for more
+        information. Check out OxfordDictionary::Endpoints::Thesaurus for the
+        interface to use. Specifically use it with
+        params: { fields: \'synonyms\' }
+        '''
+
         params[:end] = 'synonyms'
         entry_request(query, params)
       end
 
       def entry_antonyms_synonyms(query, params = {})
+        warn '''
+        Client#entry_antonyms_synonyms is DEPRECATED and will be non-functional
+        on June 30, 2019. Use Client#thesaurus instead. Reference
+        https://github.com/swcraig/oxford-dictionary/pull/14 for more
+        information. Check out OxfordDictionary::Endpoints::Thesaurus for the
+        interface to use. Specifically use it with
+        params: { fields: \'synonyms,antonyms\' }
+        '''
+
         params[:end] = 'synonyms;antonyms'
         entry_request(query, params)
       end
 
       def entry_translations(query, params = {})
+        warn '''
+        Client#entry_translations is DEPRECATED and will become non-functional
+        on June 30, 2019. Use Client#translation instead. Reference
+        https://github.com/swcraig/oxford-dictionary/pull/12 for more
+        information. Check out OxfordDictionary::Endpoints::Translations for the
+        interface to use.
+        '''
         params.key?(:translations) || params[:translations] = 'es'
         entry_request(query, params)
       end

data/lib/oxford_dictionary/endpoints/lemmas.rb

@@ -1,14 +1,10 @@
-require 'oxford_dictionary/deserialize'
+require 'oxford_dictionary/endpoints/endpoint'
 
 module OxfordDictionary
   module Endpoints
-    class Lemmas
+    class Lemmas < Endpoint
       ENDPOINT = 'lemmas'.freeze
 
-      def initialize(request_client:)
-        @request_client = request_client
-      end
-
       def lemma(word:, language:, params: {})
         query_string = "#{ENDPOINT}/#{language}/#{word}"
         uri = URI(query_string)
@@ -20,12 +16,6 @@ module OxfordDictionary
         response = @request_client.get(uri: uri)
         deserialize.call(response.body)
       end
-
-      private
-
-      def deserialize
-        @deserialize ||= OxfordDictionary::Deserialize.new
-      end
     end
   end
 end

data/lib/oxford_dictionary/endpoints/search.rb

@@ -0,0 +1,34 @@
+require 'oxford_dictionary/endpoints/endpoint'
+
+module OxfordDictionary
+  module Endpoints
+    class Search < Endpoint
+      ENDPOINT = 'search'.freeze
+
+      def search(language:, params: {})
+        query_string = "#{ENDPOINT}/#{language}"
+        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
+
+      def search_translation(source_language:, target_language:, params: {})
+        query_string =
+          "#{ENDPOINT}/translations/#{source_language}/#{target_language}"
+        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
+    end
+  end
+end

data/lib/oxford_dictionary/endpoints/search_endpoint.rb

@@ -9,6 +9,15 @@ module OxfordDictionary
       ENDPOINT = 'search'.freeze
 
       def search(query, params = {})
+        warn '''
+        Client#search without using named parameters is DEPRECATED and will
+        become non-functional on June 30, 2019 (it uses the V1 interface which
+        Oxford Dictionaries is taking offline). Reference
+        https://github.com/swcraig/oxford-dictionary/pull/15 for more
+        information. Check out OxfordDictionary::Endpoints::Search for the
+        interface to use.
+        '''
+
         params[:q] = query
         ListResponse.new(request(ENDPOINT, query, params))
       end

data/lib/oxford_dictionary/endpoints/sentences.rb

@@ -0,0 +1,21 @@
+require 'oxford_dictionary/endpoints/endpoint'
+
+module OxfordDictionary
+  module Endpoints
+    class Sentences < Endpoint
+      ENDPOINT = 'sentences'.freeze
+
+      def sentence(word:, language:, params: {})
+        query_string = "#{ENDPOINT}/#{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
+    end
+  end
+end

data/lib/oxford_dictionary/endpoints/thesaurus.rb

@@ -0,0 +1,21 @@
+require 'oxford_dictionary/endpoints/endpoint'
+
+module OxfordDictionary
+  module Endpoints
+    class Thesaurus < Endpoint
+      ENDPOINT = 'thesaurus'.freeze
+
+      def thesaurus(word:, language:, params: {})
+        query_string = "#{ENDPOINT}/#{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
+    end
+  end
+end

data/lib/oxford_dictionary/endpoints/translations.rb

@@ -0,0 +1,22 @@
+require 'oxford_dictionary/endpoints/endpoint'
+
+module OxfordDictionary
+  module Endpoints
+    class Translations < Endpoint
+      ENDPOINT = 'translations'.freeze
+
+      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
+    end
+  end
+end

data/lib/oxford_dictionary/version.rb

@@ -1,3 +1,3 @@
 module OxfordDictionary
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oxford_dictionary
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - swcraig
@@ -171,11 +171,16 @@ files:
 - lib/oxford_dictionary/client.rb
 - lib/oxford_dictionary/deprecated_request.rb
 - lib/oxford_dictionary/deserialize.rb
+- lib/oxford_dictionary/endpoints/endpoint.rb
 - lib/oxford_dictionary/endpoints/entries.rb
 - lib/oxford_dictionary/endpoints/entry_endpoint.rb
 - lib/oxford_dictionary/endpoints/inflection_endpoint.rb
 - lib/oxford_dictionary/endpoints/lemmas.rb
+- lib/oxford_dictionary/endpoints/search.rb
 - lib/oxford_dictionary/endpoints/search_endpoint.rb
+- lib/oxford_dictionary/endpoints/sentences.rb
+- lib/oxford_dictionary/endpoints/thesaurus.rb
+- lib/oxford_dictionary/endpoints/translations.rb
 - lib/oxford_dictionary/endpoints/wordlist_endpoint.rb
 - lib/oxford_dictionary/error.rb
 - lib/oxford_dictionary/request.rb