dinosaurus 0.0.6 → 0.0.7

data/lib/dinosaurus.rb

@@ -1,5 +1,6 @@
 require "dinosaurus/logging"
 require "dinosaurus/configuration"
+require "dinosaurus/results"
 require "dinosaurus/thesaurus"
 require "dinosaurus/version"
 
@@ -9,6 +10,22 @@ module Dinosaurus
   end
 
   def self.synonyms_of(word)
-    Dinosaurus::Thesaurus.synonyms_of(word)
+    results = lookup(word)
+    results.synonyms
+  end
+
+  def self.antonyms_of(word)
+    results = lookup(word)
+    results.antonyms
+  end
+
+  def self.similar_to(word)
+    results = lookup(word)
+    results.similar_terms
+  end
+
+  def self.related_to(word)
+    results = lookup(word)
+    results.related_terms
   end
 end

data/lib/dinosaurus/results.rb

@@ -0,0 +1,31 @@
+require "active_support/core_ext/hash/indifferent_access"
+
+module Dinosaurus
+  class Results < HashWithIndifferentAccess
+
+    def initialize(data = {})
+      super(data)
+    end
+
+    # Define some convenience methods.
+    { 'synonyms' => :syn,
+      'antonyms' => :ant,
+      'similar_terms' => :sim,
+      'related_terms' => :rel 
+    }.each do |name, key|
+      define_method name do
+        grouped(key)
+      end
+    end
+
+  private
+
+    def grouped(key)
+      group = []
+      self.each do |pos, type|
+        group += type[key] if type[key]
+      end
+      group
+    end
+  end
+end

data/lib/dinosaurus/thesaurus.rb

@@ -5,39 +5,26 @@ require "active_support/core_ext/object/blank"
 
 module Dinosaurus
   class MissingApiKeyError < StandardError; end
+  class RemoteServiceError < StandardError; end
 
   class Thesaurus
     include HTTParty
     base_uri "words.bighugelabs.com"
     format :json
 
-    def self.synonyms_of(word)
-      # No-op if the word is blank.
-      return [] if word.blank?
-      lookup = lookup(word)
-
-      synonyms = []
-      lookup[:results].each do |part_of_speech, types|
-        synonyms += types['syn'] if types['syn']
-        synonyms += types['sim'] if types['sim']
-        synonyms += types['rel'] if types['rel']
-      end
-      synonyms
-    end
-
     def self.lookup(word)
-      return { text: word, results: [] } if word.blank?
+      return Dinosaurus::Results.new if word.blank?
       res = get(url_for(word))
 
       if res.code == 200
-        { text: word, results: JSON.parse(res.body) }
+        json = JSON.parse(res.body)
+        Dinosaurus::Results.new(json)
       # Word does not exist.
       elsif res.code == 404
-        { text: word, results: [] }
+        Dinosaurus::Results.new
       else
         warning = "DINOSAURUS_WARNING: #{res.code}. WORD: #{word}."
         Logging.logger.warn(warning)
-        { text: word }
       end
     end
 

data/lib/dinosaurus/version.rb

@@ -1,3 +1,3 @@
 module Dinosaurus
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/dinosaurus/dinosaurus_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Dinosaurus do
+  let(:res) {  Dinosaurus::Results.new  }
+  before do
+    Dinosaurus.stub(:lookup) { res }
+  end
+
+  describe "synonyms_of" do
+    it "should return synonyms" do
+      res.should_receive(:synonyms)
+      Dinosaurus.synonyms_of('normal')
+    end
+  end
+
+  describe "antonyms_of" do
+    it "should return antonyms" do
+      res.should_receive(:antonyms)
+      Dinosaurus.antonyms_of('normal')
+    end
+  end
+
+  describe "related_to" do
+    it "should return related terms" do
+      res.should_receive(:related_terms)
+      Dinosaurus.related_to('normal')
+    end
+  end
+
+  describe "similar_to" do
+    it "should return similar terms" do
+      res.should_receive(:similar_terms)
+      Dinosaurus.similar_to('normal')
+    end
+  end
+end

data/spec/dinosaurus/results_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Dinosaurus::Results do
+  subject { Dinosaurus::Results }
+
+  let(:noun) do
+    { 'syn' => %w[syn1 syn2 syn3],
+      'sim' => %w[sim1 sim2],
+      'ant' => %w[ant1] }
+  end
+
+  let(:res) do
+    {
+      'noun' => noun,
+      'verb' => {
+        'rel' => %w[rel1 rel2 rel3],
+        'syn' => %w[vsyn1]
+      }
+    }
+  end
+
+  it "should make synonyms available" do
+    results = subject.new(res)
+    results.synonyms.should == %w[syn1 syn2 syn3 vsyn1]
+  end
+
+  it "should make all antonyms available" do
+    results = subject.new(res)
+    results.antonyms.should == %w[ant1]
+  end
+
+  it "should make similar terms available" do
+    results = subject.new(res)
+    results.similar_terms.should == %w[sim1 sim2]
+  end
+
+  it "should make related terms available" do
+    results = subject.new(res)
+    results.related_terms.should == %w[rel1 rel2 rel3]
+  end
+
+  it "should make nouns available" do
+    results = subject.new(res)
+    results[:noun].should == noun
+  end
+end

data/spec/dinosaurus/thesaurus_spec.rb

@@ -3,39 +3,10 @@ require "spec_helper"
 describe Dinosaurus::Thesaurus do
   subject { Dinosaurus::Thesaurus }
 
-  describe "synonyms_of" do
-    it "should return synonyms" do
-      VCR.use_cassette('normal') do
-        results = subject.synonyms_of('normal')
-        # Should include similar and related.
-        results.should include(*%w[sane convention average])
-        # Should not include antynoms.
-        results.should_not include(*%w[abnormal])
-      end
-    end
-
-    it "should return [] if the word is blank" do
-      subject.synonyms_of('').should == []
-    end
-  end
-
   it "should return results" do
     VCR.use_cassette('word') do
-      results = subject.lookup('word')[:results]
-      results["noun"]["syn"].should include("news")
-    end
-  end
-
-  it "should return related terms" do
-    VCR.use_cassette('normal') do
-      results = subject.lookup('normal')[:results]
-      results['adjective']['rel'].should include('sane')
-    end
-  end
-
-  it "should return the lookup word" do
-    VCR.use_cassette('word') do
-      subject.lookup('word')[:text].should == 'word'
+      results = subject.lookup('word')
+      results.should be_instance_of(Dinosaurus::Results)
     end
   end
 
@@ -48,15 +19,15 @@ describe Dinosaurus::Thesaurus do
     end
   end
 
-  it "should return [] for nonsense words" do
+  it "should return {} for nonsense words" do
     VCR.use_cassette('nonsense') do
-      subject.lookup('hsdfkjhsf')[:results].should == []
+      subject.lookup('hsdfkjhsf').should == {}
     end
   end
 
   it "should handle two words" do
     VCR.use_cassette('meal_people') do
-      subject.lookup('meal people')[:results].should == []
+      subject.lookup('meal people').should == {}
     end
   end
 
@@ -66,4 +37,6 @@ describe Dinosaurus::Thesaurus do
       subject.lookup('word')
     end.to raise_error(Dinosaurus::MissingApiKeyError)
   end
+
+  it "should raise if the server 500"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dinosaurus
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-25 00:00:00.000000000 Z
+date: 2012-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70257631167000 !ruby/object:Gem::Requirement
+  requirement: &70298320695400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257631167000
+  version_requirements: *70298320695400
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70257631165340 !ruby/object:Gem::Requirement
+  requirement: &70298320694980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70257631165340
+  version_requirements: *70298320694980
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70257631178460 !ruby/object:Gem::Requirement
+  requirement: &70298320694440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257631178460
+  version_requirements: *70298320694440
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70257631176920 !ruby/object:Gem::Requirement
+  requirement: &70298320693940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70257631176920
+  version_requirements: *70298320693940
 description: Ruby wrapper for the Big Huge Thesaurus APIs.
 email:
 - dtuite@gmail.com
@@ -73,8 +73,11 @@ files:
 - lib/dinosaurus/configuration.rb
 - lib/dinosaurus/logging.rb
 - lib/dinosaurus/railties.rb
+- lib/dinosaurus/results.rb
 - lib/dinosaurus/thesaurus.rb
 - lib/dinosaurus/version.rb
+- spec/dinosaurus/dinosaurus_spec.rb
+- spec/dinosaurus/results_spec.rb
 - spec/dinosaurus/thesaurus_spec.rb
 - spec/fixtures/vcr_cassettes/meal_people.yml
 - spec/fixtures/vcr_cassettes/nonsense.yml
@@ -106,6 +109,8 @@ signing_key:
 specification_version: 3
 summary: Lookup synonyms, antonyms etc. using the Big Huge Thesaurus API.
 test_files:
+- spec/dinosaurus/dinosaurus_spec.rb
+- spec/dinosaurus/results_spec.rb
 - spec/dinosaurus/thesaurus_spec.rb
 - spec/fixtures/vcr_cassettes/meal_people.yml
 - spec/fixtures/vcr_cassettes/nonsense.yml