dictionary_lookup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9dbf32d1b9cd363fe86ce55d059a45476762a84e
+  data.tar.gz: 088862d3ae6fadf85a007d1e4fa08954b37911e1
+SHA512:
+  metadata.gz: ededd2aa79156b4f0969c5c518e20d3f65a4769e6a1eec3ca462584a615bd8339d42571f8811e67cebaf6728bcc2ce14ff29fdfcf7e2fb8ae9e96c8251f72c5e
+  data.tar.gz: bd163f7f2ea4b2f5dee2608280dbe8a79e2918fc43c7f4b211a868730ae02595ab4db41d804ce3bd60a5f3390fc9a266c3ae5e908ae16d9f49d634071f8e806f

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,36 @@
+# Dictionary Lookup
+
+A ruby gem that wraps pearson dictionary API
+
+## Getting started
+
+You can add it to your Gemfile with:
+
+```ruby
+gem 'dictionary_lookup'
+```
+or
+
+You can install it directly
+
+    gem install dictionary_lookup
+
+and then require it
+
+    require 'dictionary_lookup'
+
+## 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?"]
+```

data/lib/dictionary_lookup/definition.rb

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

data/lib/dictionary_lookup/pearson.rb

@@ -0,0 +1,39 @@
+require "net/http"
+require "json"
+require "dictionary_lookup/definition"
+
+module DictionaryLookup
+  class Pearson
+    # Fetches term definitions from Pearson dictionary API
+    #
+    # @param term [String] term to be defined
+    # @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}"
+      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| d["headword"].downcase == term.downcase }
+
+      definitions = []
+
+      results.each do |result|
+        part_of_speech = result["part_of_speech"]
+        denotation = result["senses"].first["definition"].first
+        if result["senses"].first["examples"].nil?
+          examples = []
+        else
+          examples = result["senses"].first["examples"].map{|e| e["text"]}
+        end
+        definitions << DictionaryLookup::Definition.new(part_of_speech, denotation, examples)
+      end
+
+      definitions
+    end
+
+  end
+end

data/lib/dictionary_lookup.rb

@@ -0,0 +1,14 @@
+require "dictionary_lookup/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)
+      Pearson.define(term)
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: dictionary_lookup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nitish Parkar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-05 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: developer.nitish@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/dictionary_lookup.rb
+- lib/dictionary_lookup/definition.rb
+- lib/dictionary_lookup/pearson.rb
+homepage: https://github.com/nitishparkar/dictionary-lookup-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby gem that wraps pearson dictionary API
+test_files: []
+has_rdoc: