PearsonLongman-Dictionary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7592938025c5ab2d124294261dc788132361c74c
+  data.tar.gz: 999f9964d00bc5b0d43eefef9547030464e65bdd
+SHA512:
+  metadata.gz: 40865771a407c61fd3ba1675da99733ac1344a73fd0b3aa83b185de7adcfbc716625b91ee41609edb82a99fb53c48673f0f1a24924d8cfc05674a478663a2d05
+  data.tar.gz: 8d54fcbb289649815275226cc0cd44c002bad586f95a4019e4fdc8bff0ba6ad9026d7356277f85937935b7f765deb9eaa8df95f436136901117d0e7073434a31

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Nitish Parkar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,43 @@
+# Pearson Longman Dictionary
+
+
+A ruby gem that wraps [Pearson dictionary API](http://developer.pearson.com/apis/dictionaries)
+
+## Getting started
+
+You can add it to your Gemfile with:
+
+```ruby
+gem 'pearsonlongman-dictionary'
+```
+or
+
+You can install it directly
+
+    gem install pearsonlongman-dictionary
+
+and then require it
+
+    require 'pearsonlongman-dictionary'
+
+## Usage
+
+You can lookup a word definition by:
+
+```ruby
+results = DictionaryLookup::Base.define("hello")
+```
+
+results will contain an array of DictionaryLookup::Definition objects.
+```ruby
+results.count # => 1
+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/PearsonLongman-Dictionary.rb

@@ -0,0 +1,14 @@
+require "PearsonLongman-Dictionary/pearson"
+
+module DictionaryLookup
+  class Base
+    # Handles a lookup request
+    #
+    # @param (see Pearson.define)
+    # @return (see Pearson.define)
+    # @raise (see Pearson.define)
+    def self.define(term, config={})
+      Pearson.define(term, config)
+    end
+  end
+end

data/lib/PearsonLongman-Dictionary/definition.rb

@@ -0,0 +1,12 @@
+module DictionaryLookup
+  class Definition
+    attr_accessor :headword, :part_of_speech, :denotation, :examples
+
+    def initialize(headword, part_of_speech, denotation, examples)
+      @headword = headword
+      @part_of_speech = part_of_speech
+      @denotation = denotation
+      @examples = examples
+    end
+  end
+end

data/lib/PearsonLongman-Dictionary/pearson.rb

@@ -0,0 +1,60 @@
+require "net/http"
+require "json"
+require "PearsonLongman-Dictionary/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
+    # @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, config)
+      dictionary = get_dictionary(config)
+
+      url = "https://api.pearson.com/v2/dictionaries/#{dictionary}/entries?headword=#{term}"
+      uri = URI(URI.escape(url))
+
+      response = Net::HTTP.get(uri)
+      data = JSON.parse(response)
+
+      # Select definitions that match exactly with the term
+      results = data["results"].select{ |d| dhead = d["headword"].downcase
+
+        d["headword"].downcase == term.downcase or dhead[term.length] == ","
+      }
+      definitions = []
+
+      results.each do |result|
+        headword = result["headword"]
+        part_of_speech = result["part_of_speech"]
+        # 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
+          examples = result["senses"].first["examples"].map{|e| e["text"]}
+        end
+        definitions << DictionaryLookup::Definition.new(headword, part_of_speech, denotation, examples)
+      end
+
+      definitions
+    end
+
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: PearsonLongman-Dictionary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arnold Tonderai Marunda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email: arnold-fungai@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/PearsonLongman-Dictionary.rb
+- lib/PearsonLongman-Dictionary/definition.rb
+- lib/PearsonLongman-Dictionary/pearson.rb
+homepage: https://github.com/arnoldfungai/PearsonLongman-Dictionary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A ruby gem that wraps Pearson Dictionary API
+test_files: []