dinosaurus 0.0.9 → 0.0.10

data/README.md

@@ -18,7 +18,10 @@ Or install it yourself as:
 
 ## Usage
 
-Add your api key using the `configure` method.
+### Basic
+
+Add your api key using the `configure` method. If you're in the Rails
+environemnt then this can be done in an initializer file.
 
     Dinosaurus.configure do |config|
       config.api_key = 'djksfhjk'
@@ -27,11 +30,44 @@ Add your api key using the `configure` method.
 Now, lookup words in the Thesaurus:
 
     require "dinosaurus"
-
     results = Dinosaurus.lookup('word')
 
+### Results
+
+The 'results' object is a hash with some special accessors added.
+
+    # You can use it like a normal hash:
+    results['noun']
+    # => { 'syn' => [..., ..., ...], 'ant' => [..., ...]
+
+    # Or you can access it with symbols.
+    results[:noun]
+    # => { 'syn' => [..., ..., ...], 'ant' => [..., ...]
+
+    # Or you can take advantage of the special accesor methods. The
+    # methods provided are
+    #  - synonyms
+    #  - antonyms
+    #  - related_terms
+    #  - similar_terms
+    results.synonyms
+    # => [..., ..., ...]
+
+### Convenience Methods
+
+Certain convenience methods are provided on the top level namespace.
+Each method returns an array.
+
+    Dinosaurus.synonyms_of('word')
+    Dinosaurus.anyonyms_of('word')
+    Dinosaurus.related_to('word')
+    Dinosaurus.similar_to('word')
+
 ## Contributing
 
+There is a public [Trello development board](https://trello.com/board/dinosaurus/50128d79aaa25ad30857e434) for the project
+which lists ideas and todos. THat might be a good place to start if you would like to contribute.
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/dinosaurus.rb

@@ -5,25 +5,55 @@ require "dinosaurus/thesaurus"
 require "dinosaurus/version"
 
 module Dinosaurus
+  # Lookup a word in the Big Huge Thesaurus. 
+  #
+  # +word+ is expected to be a string. This method is 
+  # a no-op if the +word+ is blank as defined by ActiveSupport.
+  #
+  #   Dinosaurus.lookup('people')
+  #
+  # Returns an instance of <tt>Dinosaurus::Results</tt>
   def self.lookup(word)
     Dinosaurus::Thesaurus.lookup(word)
   end
 
+  # Convenience method to retrieve synonyms of a +word+.
+  #
+  #   Dinosaurus.synonyms_of('people')
+  #
+  # Returns an array.
   def self.synonyms_of(word)
     results = lookup(word)
     results.synonyms
   end
 
+  # Convenience method to retrieve antonyms of a +word+.
+  #
+  #   Dinosaurus.antonyms_of('people')
+  #
+  # Returns an array.
   def self.antonyms_of(word)
     results = lookup(word)
     results.antonyms
   end
 
+  # Convenience method to retrieve similar terms to the
+  # given +word+.
+  #
+  #   Dinosaurus.similar_to('people')
+  #
+  # Returns an array.
   def self.similar_to(word)
     results = lookup(word)
     results.similar_terms
   end
 
+  # Convenience method to retrieve terms which are
+  # related to the given +word+.
+  #
+  #   Dinosaurus.related_to('people')
+  #
+  # Returns an array.
   def self.related_to(word)
     results = lookup(word)
     results.related_terms

data/lib/dinosaurus/version.rb

@@ -1,3 +1,3 @@
 module Dinosaurus
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dinosaurus
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70143840141880 !ruby/object:Gem::Requirement
+  requirement: &70162947795100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70143840141880
+  version_requirements: *70162947795100
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70143840141420 !ruby/object:Gem::Requirement
+  requirement: &70162947794620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70143840141420
+  version_requirements: *70162947794620
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70143840140880 !ruby/object:Gem::Requirement
+  requirement: &70162947794100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70143840140880
+  version_requirements: *70162947794100
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70143840140360 !ruby/object:Gem::Requirement
+  requirement: &70162947793540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70143840140360
+  version_requirements: *70162947793540
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70143840139720 !ruby/object:Gem::Requirement
+  requirement: &70162947813280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70143840139720
+  version_requirements: *70162947813280
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70143840161820 !ruby/object:Gem::Requirement
+  requirement: &70162947812760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70143840161820
+  version_requirements: *70162947812760
 description: Ruby wrapper for the Big Huge Thesaurus APIs.
 email:
 - dtuite@gmail.com