oxford_dictionary 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2bc4731fbb7b2901e23070998aaeb6fb8d61131
-  data.tar.gz: c6332d8e683d8baac52a0e415508c08e08d7af08
+  metadata.gz: 0f3926d3f83c2ba8e1bdd3e8d495d8711477f61c
+  data.tar.gz: 0c8cb98e9868d75be5472937b73aa8dbb63f2d08
 SHA512:
-  metadata.gz: 445ece08c1459cb3fdc1d47696f1b37b1472a32f259070ab37ceadb4f553d7e99980b215e0cf2de9034d725a0b957f2726de38540870bdce07d55bea551e8362
-  data.tar.gz: 1016dac1ce6bafc64f200118e39224d2c8d0f07af89ded910999faed3b07876c1120205203f7f0c475d79bdf17c2e9b869b486b30010bff55fef193a33020d07
+  metadata.gz: e8834b1e8c46e0dcad3a487f6a8e0fbe9e2da18d3f1e55661ed47d4e65dec6f9fc60603e9afedcb5683fa76cb434d15d239e7c077e474ca1c3156d912d22599f
+  data.tar.gz: 183e9474dcddd60208adfbc78c60c3c0a6eb65c95f0ec82210538be288687f729dfcc7eb46cdf107f12c3b7849eacf72f7ffea2f2f60ac0c3ce24f7034d661c1

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## OxfordDictionary master (unreleased)
+
+## OxfordDictionary 1.0.0 (2017-09-19)
+
+- Remove httparty as a runtime dependency
+  [\#1](https://github.com/swcraig/oxford-dictionary/pull/1)
+
+

data/README.md

@@ -1,6 +1,7 @@
 [![Build Status](https://travis-ci.org/swcraig/oxford-dictionary.svg?branch=master)](https://travis-ci.org/swcraig/oxford-dictionary)
 [![Test Coverage](https://codeclimate.com/github/swcraig/oxford-dictionary/badges/coverage.svg)](https://codeclimate.com/github/swcraig/oxford-dictionary/coverage)
 [![Code Climate](https://codeclimate.com/github/swcraig/oxford-dictionary/badges/gpa.svg)](https://codeclimate.com/github/swcraig/oxford-dictionary)
+[![Gem Version](https://badge.fury.io/rb/oxford_dictionary.svg)](https://badge.fury.io/rb/oxford_dictionary)
 # OxfordDictionary
 
 Ruby wrapper to consume the [Oxford Dictionary API](https://developer.oxforddictionaries.com/documentation)
@@ -18,6 +19,11 @@ After registering for an API key, setup the client:
     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
 
     entry = client.entry('vapid')
@@ -68,7 +74,7 @@ After registering for an API key, setup the client:
     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.  
+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'
@@ -85,13 +91,13 @@ Argument names need to be in camelCase, not snake_case. However, the objects ret
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies.      
+After checking out the repo, run `bin/setup` to install dependencies.
 Run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Contributing
 
-Bug reports and pull requests are more than welcome!   
-Please make tests for anything that is added.    
+Bug reports and pull requests are more than welcome!
+Please make tests for anything that is added.
 `bundle exec rake` will run rspec/rubocop.
 
 #### Pull Requests

data/lib/oxford_dictionary.rb

@@ -1,11 +1,5 @@
 require 'oxford_dictionary/client'
-require 'oxford_dictionary/error'
-require 'oxford_dictionary/request'
 require 'oxford_dictionary/version'
-require 'oxford_dictionary/endpoints/entry_endpoint'
-require 'oxford_dictionary/endpoints/inflection_endpoint'
-require 'oxford_dictionary/endpoints/search_endpoint'
-require 'oxford_dictionary/endpoints/wordlist_endpoint'
 
 # Adds some aliasing
 module OxfordDictionary

data/lib/oxford_dictionary/endpoints/entry_endpoint.rb

@@ -52,6 +52,8 @@ module OxfordDictionary
         entry_request(query, params)
       end
 
+      private
+
       def entry_request(query, params)
         EntryResponse.new(request(ENDPOINT, query, params)['results'][0])
       end

data/lib/oxford_dictionary/request.rb

@@ -1,14 +1,13 @@
-require 'httparty'
 require 'json'
+require 'net/http'
 require 'plissken'
 require 'oxford_dictionary/error'
 
 module OxfordDictionary
   # Handles all of the actual API calls
   module Request
-    include HTTParty
-
     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,
@@ -16,12 +15,21 @@ module OxfordDictionary
                         :prefix, :word_length].freeze
 
     def request(endpoint, q, params)
-      url = build_url(endpoint, q, params)
-      resp = HTTParty.get(url, headers: request_headers)
-      unless resp.code == 200
-        raise(Error.new(resp.code), error_message(resp.body))
+      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(resp.body).to_snake_keys
+      JSON.parse(response.body).to_snake_keys
     end
 
     def build_url(endpoint, q, params)
@@ -98,6 +106,7 @@ module OxfordDictionary
       query
     end
 
+    # Remove <p> and </p> in error message
     def error_message(response)
       response.lines.last.chomp[3..-5]
     end
@@ -107,8 +116,12 @@ module OxfordDictionary
       element.is_a?(Hash)
     end
 
-    def request_headers
-      { 'Accept' => ACCEPT_TYPE, 'app_id' => app_id, 'app_key' => app_key }
+    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 = '0.1.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/oxford_dictionary.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'A wrapper for the Oxford Dictionary API'
   spec.description   = 'https://developer.oxforddictionaries.com/documentation'
-  spec.homepage      = 'https://github.com'
+  spec.homepage      = 'https://github.com/swcraig/oxford-dictionary'
   spec.license       = 'MIT'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -27,7 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 2.1.0'
   spec.add_development_dependency 'rubocop', '~> 0.45.0'
 
-  spec.add_runtime_dependency 'httparty', '~> 0.14.0'
   spec.add_runtime_dependency 'virtus', '~> 1.0.5'
   spec.add_runtime_dependency 'plissken', '~> 0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oxford_dictionary
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - swcraig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.45.0
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -155,7 +142,7 @@ files:
 - lib/oxford_dictionary/request.rb
 - lib/oxford_dictionary/version.rb
 - oxford_dictionary.gemspec
-homepage: https://github.com
+homepage: https://github.com/swcraig/oxford-dictionary
 licenses:
 - MIT
 metadata: {}