oxford_dictionary 1.0.1 → 1.1.0

data/lib/oxford_dictionary/deprecated_request.rb

@@ -0,0 +1,127 @@
+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

data/lib/oxford_dictionary/deserialize.rb

@@ -0,0 +1,9 @@
+require 'json'
+
+module OxfordDictionary
+  class Deserialize
+    def call(payload)
+      JSON.parse(payload, object_class: OpenStruct)
+    end
+  end
+end

data/lib/oxford_dictionary/endpoints/entries.rb

@@ -0,0 +1,45 @@
+require 'oxford_dictionary/deserialize'
+require 'plissken'
+
+module OxfordDictionary
+  module Endpoints
+    class Entries
+      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)
+
+        unless params.empty?
+          uri.query = URI.encode_www_form(params)
+        end
+
+        response = @request_client.get(uri: uri)
+        deserialize.call(response.body)
+      end
+
+      def entry_snake_case(word:, dataset:, params: {})
+        query_string = "#{ENDPOINT}/#{dataset}/#{word}"
+        uri = URI(query_string)
+
+        unless params.empty?
+          uri.query = URI.encode_www_form(params)
+        end
+
+        response = @request_client.get(uri: uri)
+        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

@@ -1,11 +1,11 @@
-require 'oxford_dictionary/request'
+require 'oxford_dictionary/deprecated_request'
 require 'oxford_dictionary/api_objects/entry_response'
 
 module OxfordDictionary
   module Endpoints
     # Interface to '/entries' endpoint
     module EntryEndpoint
-      include OxfordDictionary::Request
+      include OxfordDictionary::DeprecatedRequest
       ENDPOINT = 'entries'.freeze
 
       def entry(query, params = {})

data/lib/oxford_dictionary/endpoints/inflection_endpoint.rb

@@ -1,11 +1,11 @@
-require 'oxford_dictionary/request'
+require 'oxford_dictionary/deprecated_request'
 require 'oxford_dictionary/api_objects/entry_response'
 
 module OxfordDictionary
   module Endpoints
     # Interface to '/inflections' endpoint
     module InflectionEndpoint
-      include OxfordDictionary::Request
+      include OxfordDictionary::DeprecatedRequest
       ENDPOINT = 'inflections'.freeze
 
       def inflection(query, params = {})

data/lib/oxford_dictionary/endpoints/search_endpoint.rb

@@ -1,11 +1,11 @@
-require 'oxford_dictionary/request'
+require 'oxford_dictionary/deprecated_request'
 require 'oxford_dictionary/api_objects/list_response'
 
 module OxfordDictionary
   module Endpoints
     # Interface to '/search' endpoint
     module SearchEndpoint
-      include OxfordDictionary::Request
+      include OxfordDictionary::DeprecatedRequest
       ENDPOINT = 'search'.freeze
 
       def search(query, params = {})

data/lib/oxford_dictionary/endpoints/wordlist_endpoint.rb

@@ -1,12 +1,12 @@
-require 'oxford_dictionary/request'
+require 'oxford_dictionary/deprecated_request'
 require 'oxford_dictionary/api_objects/list_response'
 
 module OxfordDictionary
   module Endpoints
     # Interface to '/wordlist' endpoint
     module WordlistEndpoint
-      include OxfordDictionary::Request
       extend Gem::Deprecate
+      include OxfordDictionary::DeprecatedRequest
 
       ENDPOINT = 'wordlist'.freeze
       ADVANCED_FILTERS = [:exact, :exclude, :exclude_senses,

data/lib/oxford_dictionary/request.rb

@@ -1,127 +1,30 @@
-require 'json'
 require 'net/http'
-require 'plissken'
-require 'oxford_dictionary/error'
 
 module OxfordDictionary
-  # Handles all of the actual API calls
-  module Request
-    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
+  class Request
+    BASE_URL = 'https://od-api.oxforddictionaries.com/api/v2'.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
+    def initialize(app_id:, app_key:)
+      @app_id = app_id
+      @app_key = app_key
     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
+    def get(uri:)
+      uri = URI("#{BASE_URL}/#{uri}")
 
-    # 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)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |https|
+        https.request(request_object(uri))
       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
+    private
 
-    def options(v)
-      if v.is_a?(Array)
-        hash_element?(v[0]) ? query_from_hash(v) : v.join(',')
-      else
-        v
+    def request_object(uri)
+      Net::HTTP::Get.new(uri).tap do |request|
+        request['Accept'] = 'application/json'
+        request['app_id'] = @app_id
+        request['app_key'] = @app_key
       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

data/lib/oxford_dictionary/version.rb

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

data/oxford_dictionary.gemspec

@@ -26,6 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 2.1.0'
   spec.add_development_dependency 'rubocop', '~> 0.45.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'vcr', '~> 4.0.0'
 
   spec.add_runtime_dependency 'virtus', '~> 1.0.5'
   spec.add_runtime_dependency 'plissken', '~> 0.1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxford_dictionary
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - swcraig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-08 00:00:00.000000000 Z
+date: 2019-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.45.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +154,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- fixtures/vcr_cassettes/entries_entry-en-us.yml
+- fixtures/vcr_cassettes/entries_entry-verbs.yml
+- fixtures/vcr_cassettes/entries_entry.yml
+- fixtures/vcr_cassettes/entries_entry_snake_case.yml
 - lib/oxford_dictionary.rb
 - lib/oxford_dictionary/api_objects/entry.rb
 - lib/oxford_dictionary/api_objects/entry_response.rb
@@ -134,6 +166,9 @@ files:
 - 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/entries.rb
 - lib/oxford_dictionary/endpoints/entry_endpoint.rb
 - lib/oxford_dictionary/endpoints/inflection_endpoint.rb
 - lib/oxford_dictionary/endpoints/search_endpoint.rb