oxford_dictionary 1.3.1 → 2.0.0

data/fixtures/vcr_cassettes/v1_search.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://od-api.oxforddictionaries.com/api/v1/search/en?prefix=false&q=vapid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - application/json
+      User-Agent:
+      - Ruby
+      Host:
+      - od-api.oxforddictionaries.com
+      App-Id:
+      - APP_ID
+      App-Key:
+      - APP_KEY
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Content-Type:
+      - text/plain; charset=us-ascii
+      Date:
+      - Sun, 30 Jun 2019 04:42:49 GMT
+      Server:
+      - openresty/1.9.7.4
+      Content-Length:
+      - '21'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: Authentication failed
+    http_version: 
+  recorded_at: Sun, 30 Jun 2019 04:42:49 GMT
+recorded_with: VCR 4.0.0

data/fixtures/vcr_cassettes/v1_search_prefix.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://od-api.oxforddictionaries.com/api/v1/search/en?prefix=true&q=condition
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - application/json
+      User-Agent:
+      - Ruby
+      Host:
+      - od-api.oxforddictionaries.com
+      App-Id:
+      - APP_ID
+      App-Key:
+      - APP_KEY
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Content-Type:
+      - text/plain; charset=us-ascii
+      Date:
+      - Sun, 30 Jun 2019 04:42:49 GMT
+      Server:
+      - openresty/1.9.7.4
+      Content-Length:
+      - '21'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: Authentication failed
+    http_version: 
+  recorded_at: Sun, 30 Jun 2019 04:42:49 GMT
+recorded_with: VCR 4.0.0

data/fixtures/vcr_cassettes/v1_search_translation.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://od-api.oxforddictionaries.com/api/v1/search/en/translations=id?prefix=false&q=eye
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - application/json
+      User-Agent:
+      - Ruby
+      Host:
+      - od-api.oxforddictionaries.com
+      App-Id:
+      - APP_ID
+      App-Key:
+      - APP_KEY
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Content-Type:
+      - text/plain; charset=us-ascii
+      Date:
+      - Sun, 30 Jun 2019 04:42:50 GMT
+      Server:
+      - openresty/1.9.7.4
+      Content-Length:
+      - '21'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: Authentication failed
+    http_version: 
+  recorded_at: Sun, 30 Jun 2019 04:42:50 GMT
+recorded_with: VCR 4.0.0

data/lib/oxford_dictionary/client.rb

@@ -1,8 +1,3 @@
-require 'oxford_dictionary/endpoints/entry_endpoint'
-require 'oxford_dictionary/endpoints/inflection_endpoint'
-require 'oxford_dictionary/endpoints/search_endpoint'
-require 'oxford_dictionary/endpoints/wordlist_endpoint'
-
 require 'oxford_dictionary/endpoints/entries'
 require 'oxford_dictionary/endpoints/lemmas'
 require 'oxford_dictionary/endpoints/translations'
@@ -15,11 +10,6 @@ require 'oxford_dictionary/request'
 module OxfordDictionary
   # The client object to interact with
   class Client
-    include OxfordDictionary::Endpoints::EntryEndpoint
-    include OxfordDictionary::Endpoints::InflectionEndpoint
-    include OxfordDictionary::Endpoints::SearchEndpoint
-    include OxfordDictionary::Endpoints::WordlistEndpoint
-
     attr_reader :app_id, :app_key
 
     def initialize(params)
@@ -41,19 +31,171 @@ module OxfordDictionary
         )
       else
         warn '''
-          The V1 interface for this library is DEPRECATED and will become
-          non-functional on June 30, 2019. Use the new V2 interface for this
+          The V1 interface for this library is DEPRECATED.
+          Use the new V2 interface for this
           method instead. Reference github.com/swcraig/oxford-dictionary/pull/8
           for more information. Specifically check out
           OxfordDictionary::Endpoints::Entries#entry for the new interface.
         '''
-        # Support V1 behaviour
-        super(*args)
+        # Try our best
+        dataset = args[1].is_a?(Hash) && args[1][:lang] || 'en-gb'
+        has_lang = args[1].is_a?(Hash) && args[1][:lang]
+        args[1].delete(:lang) if has_lang
+
+          params = args[1]&.map do |key, value|
+            if value.is_a?(Array)
+              [key, value.join(',')]
+            else
+              [key, value]
+            end
+          end.to_h
+          parameters = params || {}
+        entry(word: args.first, dataset: dataset, params: parameters)
       end
     end
 
+    def entry_definitions(*args)
+      warn '''
+        Client#entry_defintions is DEPRECATED.
+        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\' }
+      '''
+
+      dataset = args[1].is_a?(Hash) && args[1][:lang] || 'en-gb'
+      entry(
+        word: args.first,
+        dataset: dataset,
+        params: { fields: 'definitions' }
+      )
+    end
+
+    def entry_examples(*args)
+      warn '''
+        Client#entry_examples is DEPRECATED. 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\' }
+      '''
+
+      dataset = args[1].is_a?(Hash) && args[1][:lang] || 'en-gb'
+      entry(
+        word: args.first,
+        dataset: dataset,
+        params: { fields: 'examples' }
+      )
+    end
+
+    def entry_pronunciations(*args)
+      warn '''
+        Client#entry_pronunciations is DEPRECATED.
+        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\' }
+      '''
+
+      dataset = args[1].is_a?(Hash) && args[1][:lang] || 'en-gb'
+      entry(
+        word: args.first,
+        dataset: dataset,
+        params: { fields: 'pronunciations' }
+      )
+    end
+
+    def entry_sentences(*args)
+      warn '''
+        Client#entry_sentences is DEPRECATED.
+        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.
+      '''
+
+      dataset = args[1].is_a?(Hash) && args[1][:lang] || 'en'
+      sentence(
+        word: args.first,
+        language: dataset,
+        params: {}
+      )
+    end
+
+    def entry_antonyms(*args)
+      warn '''
+        Client#entry_antonyms is DEPRECATED.
+        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\' }
+      '''
+
+      thesaurus(
+        word: args.first,
+        language: 'en',
+        params: { fields: 'antonyms' }
+      )
+    end
+
+    def entry_synonyms(*args)
+      warn '''
+        Client#entry_synonyms is DEPRECATED.
+        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\' }
+      '''
+
+      thesaurus(
+        word: args.first,
+        language: 'en',
+        params: { fields: 'synonyms' }
+      )
+    end
+
+    def entry_antonyms_synonyms(*args)
+      warn '''
+        Client#entry_antonyms_synonyms is DEPRECATED.
+        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\' }
+      '''
+
+      thesaurus(
+        word: args.first,
+        language: 'en',
+        params: { fields: 'antonyms,synonyms' }
+      )
+    end
+
+    def entry_translations(*args)
+      warn '''
+        Client#entry_translations is DEPRECATED.
+        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.
+      '''
+
+      language = args[1] && args[1][:translations] || 'es'
+      translation(
+        word: args.first,
+        source_language: 'en-us',
+        target_language: language,
+        params: {}
+      )
+    end
+
     def entry_snake_case(word:, dataset:, params: {})
       warn 'Client#entry_snake_case is DEPRECATED. Use Client#entry instead.'
+
       entry_endpoint.
         entry_snake_case(word: word, dataset: dataset, params: params)
     end
@@ -90,16 +232,43 @@ module OxfordDictionary
       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
+          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.
         '''
+
+        language_parameter = args[1].is_a?(Hash) && args[1][:lang]
+        language = language_parameter || 'en-gb'
+        args[1].delete(:lang) if language_parameter
+
         if args[1].is_a?(Hash) && args[1][:translations]
-          super(args[0], translations: args[1][:translations])
+          target_language = args[1][:translations]
+          args[1].delete(:translations)
+
+          params = args[1]&.map do |key, value|
+            if value.is_a?(Array)
+              [key, value.join(',')]
+            else
+              [key, value]
+            end
+          end.to_h
+          parameters = params&.merge(q: args[0]) || {}
+          search_translation(
+            source_language: language,
+            target_language: target_language,
+            params: parameters
+          )
         else
-          super(*args)
+          params = args[1]&.map do |key, value|
+            if value.is_a?(Array)
+              [key, value.join(',')]
+            else
+              [key, value]
+            end
+          end.to_h
+          parameters = params&.merge(q: args[0]) || {}
+          search_endpoint.search(language: language, params: parameters)
         end
       end
     end
@@ -112,6 +281,30 @@ module OxfordDictionary
       )
     end
 
+    def inflection(*args)
+      warn '''
+          Client#inflection is DEPRECATED.
+          Use Client#lemma instead. Reference
+          github.com/swcraig/oxford-dictionary/pull/10 for for more information.
+          Check out OxfordDictionary::Endpoints::Lemmas#lemma for the interface
+          to use.
+      '''
+
+      language_parameter = args[1].is_a?(Hash) && args[1][:lang]
+      language = language_parameter || 'en'
+      args[1].delete(:lang) if language_parameter
+
+      params = args[1]&.map do |key, value|
+        if value.is_a?(Array)
+          [key, value.join(',')]
+        else
+          [key, value]
+        end
+      end.to_h
+      parameters = params || {}
+
+      lemma(word: args.first, language: language, params: parameters)
+    end
 
     private
 

data/lib/oxford_dictionary/version.rb

@@ -1,3 +1,3 @@
 module OxfordDictionary
-  VERSION = '1.3.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxford_dictionary
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - swcraig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -161,28 +161,32 @@ files:
 - fixtures/vcr_cassettes/lemmas_lemma-es.yml
 - fixtures/vcr_cassettes/lemmas_lemma-verbs.yml
 - fixtures/vcr_cassettes/lemmas_lemma.yml
+- fixtures/vcr_cassettes/v1_entry.yml
+- fixtures/vcr_cassettes/v1_entry_antonym_synonym.yml
+- fixtures/vcr_cassettes/v1_entry_antonyms.yml
+- fixtures/vcr_cassettes/v1_entry_definitions.yml
+- fixtures/vcr_cassettes/v1_entry_error.yml
+- fixtures/vcr_cassettes/v1_entry_es.yml
+- fixtures/vcr_cassettes/v1_entry_examples.yml
+- fixtures/vcr_cassettes/v1_entry_past_nouns.yml
+- fixtures/vcr_cassettes/v1_entry_pronunciations.yml
+- fixtures/vcr_cassettes/v1_entry_synonyms.yml
+- fixtures/vcr_cassettes/v1_entry_us.yml
+- fixtures/vcr_cassettes/v1_inflection.yml
+- fixtures/vcr_cassettes/v1_inflection_filters.yml
+- fixtures/vcr_cassettes/v1_search.yml
+- fixtures/vcr_cassettes/v1_search_prefix.yml
+- fixtures/vcr_cassettes/v1_search_translation.yml
 - lib/oxford_dictionary.rb
-- lib/oxford_dictionary/api_objects/entry.rb
-- lib/oxford_dictionary/api_objects/entry_response.rb
-- lib/oxford_dictionary/api_objects/lexical_entry.rb
-- lib/oxford_dictionary/api_objects/list_response.rb
-- lib/oxford_dictionary/api_objects/pronunciation.rb
-- lib/oxford_dictionary/api_objects/sense.rb
 - 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
 - lib/oxford_dictionary/version.rb
 - oxford_dictionary.gemspec
@@ -205,8 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A wrapper for the Oxford Dictionary API

data/lib/oxford_dictionary/api_objects/entry.rb

@@ -1,11 +0,0 @@
-require 'virtus'
-require 'oxford_dictionary/api_objects/sense'
-
-# Entry
-class Entry
-  include Virtus.model
-  attribute :etymologies, Array[String]
-  attribute :grammatical_features, Array[OpenStruct]
-  attribute :homograph_number, String
-  attribute :senses, Array[Sense]
-end

data/lib/oxford_dictionary/api_objects/entry_response.rb

@@ -1,12 +0,0 @@
-require 'virtus'
-require 'oxford_dictionary/api_objects/lexical_entry'
-
-# Top level response (excluding metadata) from entries endpoints
-class EntryResponse
-  include Virtus.model
-  attribute :id, String
-  attribute :language, String
-  attribute :lexical_entries, Array[LexicalEntry]
-  attribute :type, String
-  attribute :word, String
-end

data/lib/oxford_dictionary/api_objects/lexical_entry.rb

@@ -1,16 +0,0 @@
-require 'virtus'
-require 'oxford_dictionary/api_objects/entry'
-require 'oxford_dictionary/api_objects/pronunciation'
-
-# LexicalEntry
-class LexicalEntry
-  include Virtus.model
-  attribute :entries, Array[Entry]
-  attribute :grammatical_features, Array[OpenStruct]
-  attribute :inflection_of, Array[OpenStruct]
-  attribute :language, String
-  attribute :lexical_category, String
-  attribute :pronunciations, Array[Pronunciation]
-  attribute :sentences, Array[OpenStruct]
-  attribute :text, String
-end

data/lib/oxford_dictionary/api_objects/list_response.rb

@@ -1,7 +0,0 @@
-require 'virtus'
-
-# Top level response (excluding metadata) from search and wordlist endpoints
-class ListResponse
-  include Virtus.model
-  attribute :results, Array[OpenStruct]
-end

data/lib/oxford_dictionary/api_objects/pronunciation.rb

@@ -1,10 +0,0 @@
-require 'virtus'
-
-# Pronunciation
-class Pronunciation
-  include Virtus.model
-  attribute :audio_file, String
-  attribute :dialects, Array[String]
-  attribute :phonetic_notation, String
-  attribute :phonetic_spelling, String
-end

data/lib/oxford_dictionary/api_objects/sense.rb

@@ -1,19 +0,0 @@
-require 'virtus'
-
-# Sense
-class Sense
-  include Virtus.model
-  attribute :id, String
-  attribute :antonyms, Array[OpenStruct]
-  attribute :cross_references, Array[OpenStruct]
-  attribute :cross_reference_markers, Array[String]
-  attribute :definitions, Array[String]
-  attribute :domains, Array[String]
-  attribute :examples, Array[OpenStruct]
-  attribute :regions, Array[String]
-  attribute :registers, Array[String]
-  attribute :subsenses, Array[Sense]
-  attribute :synonyms, Array[OpenStruct]
-  attribute :translations, Array[OpenStruct]
-  attribute :variant_forms, Array[OpenStruct]
-end

data/lib/oxford_dictionary/deprecated_request.rb

@@ -1,127 +0,0 @@
-require 'json'
-require 'net/http'
-require 'plissken'
-require 'oxford_dictionary/error'
-
-module OxfordDictionary
-  # Handles all of the actual API calls
-  module DeprecatedRequest
-    BASE = 'https://od-api.oxforddictionaries.com/api/v1'.freeze
-    HTTP_OK = '200'.freeze
-    ACCEPT_TYPE = 'application/json'.freeze
-    # May be used by the wordlist endpoint
-    ADVANCED_FILTERS = [:exact, :exclude, :exclude_senses,
-                        :exclude_prime_senses, :limit, :offset,
-                        :prefix, :word_length].freeze
-
-    def request(endpoint, q, params)
-      url = URI(build_url(endpoint, q, params))
-      response = Net::HTTP.start(url.host, url.port, use_ssl: true) do |http|
-        request = build_get_request(url)
-        http.request(request)
-      end
-      parse_body_or_raise(response)
-    end
-
-    private
-
-    def parse_body_or_raise(response)
-      unless response.code == HTTP_OK
-        raise(Error.new(response.code), error_message(response.body))
-      end
-      JSON.parse(response.body).to_snake_keys
-    end
-
-    def build_url(endpoint, q, params)
-      params[:lang] || params[:lang] = 'en'
-      url_start = "#{BASE}/#{endpoint}/#{params[:lang]}"
-      if params[:q]
-        "#{url_start}#{search_endpoint_url(params)}".chomp('/')
-      else
-        unless q
-          # The wordlist endpoint uses a slightly different url structure
-          return "#{url_start}/#{build_advanced_url(params)}".chomp('/')
-        end
-        "#{url_start}/#{q}/#{finish_url(params)}".chomp('/')
-      end
-    end
-
-    def build_advanced_url(params)
-      advanced_params = {}
-      params.each do |k, v|
-        if ADVANCED_FILTERS.include?(k)
-          params.delete(k)
-          advanced_params[k] = v
-        end
-      end
-      "#{create_query_string(params)}#{advanced_query(advanced_params)}"
-    end
-
-    def advanced_query(params)
-      unless params.empty?
-        params[:exact] || params[:exact] = false
-        return "?#{create_query_string(params, '&')}"
-      end
-      ''
-    end
-
-    # The search endpoint has a slightly different url structure
-    def search_endpoint_url(params)
-      params[:prefix] || params[:prefix] = false
-      append = ''
-      if params[:translations]
-        append = "/translations=#{params[:translations]}"
-        params.delete(:translations)
-      end
-      "#{append}?#{create_query_string(params, '&')}"
-    end
-
-    def finish_url(params)
-      params[:end] || create_query_string(params)
-    end
-
-    def create_query_string(params, seperator = ';')
-      params.delete(:lang)
-      count = 0
-      query = ''
-      params.each do |k, v|
-        query += "#{k}=#{options(v)}"
-        query += seperator if count < params.size - 1
-        count += 1
-      end
-      query
-    end
-
-    def options(v)
-      if v.is_a?(Array)
-        hash_element?(v[0]) ? query_from_hash(v) : v.join(',')
-      else
-        v
-      end
-    end
-
-    def query_from_hash(hash)
-      query = ''
-      hash.each { |h| query += create_query_string(h) }
-      query
-    end
-
-    # Remove <p> and </p> in error message
-    def error_message(response)
-      response.lines.last.chomp[3..-5]
-    end
-
-    # The wordlist endpoint may nest filters
-    def hash_element?(element)
-      element.is_a?(Hash)
-    end
-
-    def build_get_request(url)
-      request = Net::HTTP::Get.new(url)
-      request['Accept'] = ACCEPT_TYPE
-      request['app_id'] = app_id
-      request['app_key'] = app_key
-      request
-    end
-  end
-end