dictionary_lookup 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe5f411f5d33e70385be7ebb3fca21789501a3ac
-  data.tar.gz: 8441dc3641878aa6665a755fcc779d0e7abfd157
+  metadata.gz: 629803c605ace4605aad3c5f4acc1c74ee34a91a
+  data.tar.gz: 7ae85ec0098a806397647320f568fb1b29783bdf
 SHA512:
-  metadata.gz: 79c126b94b949b08c3b74054c954926dc1241372d8144a766c353acd3a7216befacff6c96e4d27fbf73c277281e6aaf0b0dca3a937346bd13612416896d52649
-  data.tar.gz: 117ecfb6a80ff82b400163f20625038d497dc3eddbace8207ea2b00e980fd0e78feff4f6fe70d3a405b23f41a4dcec79563f717fa912f8f7eb03646403a0998d
+  metadata.gz: 2ac5bd92602355c61f1f9c02e4603ff8f7b285edebbda6c03108e81835ff83aeb2dd12d93ff3ba32b4da1ea71b51626fb6749b1d8af0a6d752782ed29321a6d0
+  data.tar.gz: 9eb97bb7109382ed2b7c9542da30607e21b8a63094c47d303845f57b621e55d25840fb8e8127e0aeb4b7e9ad8cbdaad70a3af310228944e6a392799caf54bf9b

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/dictionary_lookup.svg)](http://badge.fury.io/rb/dictionary_lookup)
 [![Build Status](https://travis-ci.org/nitishparkar/dictionary-lookup-rb.svg?branch=master)](https://travis-ci.org/nitishparkar/dictionary-lookup-rb)
 
-A ruby gem that wraps pearson dictionary API
+A ruby gem that wraps [Pearson dictionary API](http://developer.pearson.com/apis/dictionaries)
 
 ## Getting started
 
@@ -37,3 +37,9 @@ results.first.part_of_speech # => "noun"
 results.first.denotation # => "used as a greeting when you see or meet someone"
 results.first.examples # => ["Hello, John! How are you?"]
 ```
+
+You can specify different dictionary by passing `dictionary` in config hash. List of available dictionaries could be found [here](http://developer.pearson.com/apis/dictionaries#!//listDictionaryEntries)
+
+```ruby
+results = DictionaryLookup::Base.define("hello", {dictionary: "wordwise"})
+```

data/lib/dictionary_lookup.rb

@@ -7,8 +7,8 @@ module DictionaryLookup
     # @param (see Pearson.define)
     # @return (see Pearson.define)
     # @raise (see Pearson.define)
-    def self.define(term)
-      Pearson.define(term)
+    def self.define(term, config={})
+      Pearson.define(term, config)
     end
   end
 end

data/lib/dictionary_lookup/pearson.rb

@@ -4,13 +4,29 @@ require "dictionary_lookup/definition"
 
 module DictionaryLookup
   class Pearson
+
+    VALID_DICTIONARIES = ["ldoce5", "lasde", "ldec", "wordwise", "laesd", "leasd", "laad3", "laes", "lase", "brep", "brpe"]
+
+    DEFAULT_DICTIONARY = VALID_DICTIONARIES.first
+
+    # Helper method. Returns either a valid dictionary specified through config
+    # or the default dictionary
+    def self.get_dictionary(config)
+      VALID_DICTIONARIES.include?(config[:dictionary]) ?
+                                config[:dictionary] : DEFAULT_DICTIONARY
+    end
+
     # Fetches term definitions from Pearson dictionary API
     #
     # @param term [String] term to be defined
-    # @return [Array] an array of DictionaryLookup::Definition objects
+    # @param config [Hash] configuration hash, for now supports :dictionary key.
+    #   For list of valid values see {DictionaryLookup::Pearson::VALID_DICTIONARIES}
+    # @return [Array] an array of {DictionaryLookup::Definition} objects
     # @raise SocketError if not connected to the internet
-    def self.define(term)
-      url = "https://api.pearson.com:443/v2/dictionaries/ldoce5/entries?headword=#{term}"
+    def self.define(term, config)
+      dictionary = get_dictionary(config)
+
+      url = "https://api.pearson.com:443/v2/dictionaries/#{dictionary}/entries?headword=#{term}"
       uri = URI(URI.escape(url))
 
       response = Net::HTTP.get(uri)
@@ -23,7 +39,9 @@ module DictionaryLookup
 
       results.each do |result|
         part_of_speech = result["part_of_speech"]
-        denotation = result["senses"].first["definition"].first
+        # In wordwise dictionary, value of definition is String. Hence the is_a? test
+        _definitions = result["senses"].first["definition"]
+        denotation = _definitions.is_a?(Array) ? _definitions.first : _definitions
         if result["senses"].first["examples"].nil?
           examples = []
         else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dictionary_lookup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Nitish Parkar