wordnik 0.1.0 → 0.2.0

data/CHANGELOG

@@ -1,2 +1,8 @@
-0.1.0:
-* First release
+0.1.1 - 2009-11-10
+------------------
+- finish adding tests
+- numerous bug fixes
+
+0.1.0 - 2009-11-07
+------------------
+- First release

data/Rakefile

@@ -11,7 +11,7 @@ begin
     gem.homepage = "http://github.com/ealdent/wordnik"
     gem.authors = ["Jason Adams"]
     gem.add_dependency "httparty", ">= 0.4.5"
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/wordnik.rb

@@ -1,4 +1,89 @@
 require 'httparty'
-require 'singleton'
-require 'wordnik/wordnik'
-require 'wordnik/word'
+
+class Wordnik
+  include HTTParty
+
+  attr_reader :api_key
+
+  base_uri 'http://api.wordnik.com/api'
+
+  def initialize(api_key = nil)
+    @api_key = (api_key || File.read('.api-key').strip || '').dup
+    unless @api_key.blank?
+      self.class.default_params :api_key => @api_key
+    end
+  end
+
+  def api_key=(api_key)
+    @api_key = api_key.to_s.dup
+    self.class.default_params :api_key => @api_key
+    @api_key
+  end
+
+  def lookup(word)
+    do_request("word.json/#{word.downcase}")
+  end
+
+  def define(word, *args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    unless options.key?(:count)
+      options[:count] = args.any? ? args.first.to_i : 100
+    end
+    do_request("word.json/#{word.downcase}/definitions", options)
+  end
+
+  def frequency(word)
+    do_request("word.json/#{word.downcase}/frequency")
+  end
+
+  def examples(word)
+    do_request("word.json/#{word.downcase}/examples")
+  end
+
+  def autocomplete(word_fragment, count = 100)
+    do_request("suggest.json/#{word_fragment.downcase}", :count => count)
+  end
+
+  def word_of_the_day
+    do_request("wordoftheday.json")
+  end
+
+  def random(has_definition = true)
+    do_request("words.json/randomWord", :hasDictionaryDef => has_definition)
+  end
+
+  def punctuation(word)
+    do_request("word.json/#{word.downcase}/punctuationFactor")
+  end
+
+  protected
+
+  def do_request(request, options = {})
+    handle_result(self.class.get("/#{request}", sanitize_options(options)))
+  end
+
+  def handle_result(result)
+    if result.is_a?(String)
+      raise 'Error in result.'
+    elsif result.is_a?(Hash) && result.key?('type') && result['type'] == 'error'
+      raise "Error in result: #{result['message']}"
+    else
+      result
+    end
+  end
+
+  def sanitize_options(opts)
+    options = {}
+
+    options[:count] = opts[:count].to_i if opts.key?(:count)
+    options[:hasDictionaryDef] = !!opts[:hasDictionaryDef] if opts.key?(:hasDictionaryDef)
+
+    if opts.key?(:partOfSpeech)
+      options[:partOfSpeech] = opts[:partOfSpeech].reject do |pos|
+        ![:noun, :verb, :adjective, :adverb, :idiom, :article, :abbreviation, :preposition, :prefix, :interjection, :suffix].include?(pos.to_sym)
+      end
+    end
+
+    options
+  end
+end

data/test/test_wordnik.rb

@@ -1,7 +1,89 @@
 require 'helper'
 
+#  In order to run any tests, you must copy your API key into a file in the
+#  same directory that you run your tests from, or else set the environment
+#  variable WORDNIK_API_KEY to the api key you wish to use.
 class TestWordnik < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  context "initializing a Wordnik object" do
+    should "instantiate given an API key" do
+      assert_equal Wordnik.new('TESTTESTETESTTESTSETESTTESTTETST').nil?, false
+    end
+  end
+
+  context "a single Wordnik instance" do
+    setup do
+      @api_key = (File.exists?('.api-key') ? File.read('.api-key') : ENV['WORDNIK_API_KEY']).strip
+      raise "No API key available." unless @api_key
+
+      @wordnik = Wordnik.new(@api_key)
+      @test_word = 'test'
+      @test_word_fragment = 'invas'
+    end
+
+    should "make its api-key accessible" do
+      assert_equal @wordnik.api_key, @api_key
+    end
+
+    should "lookup the id for a word" do
+      word = @wordnik.lookup(@test_word)
+
+      assert_equal word.is_a?(Hash), true
+      assert_equal word.empty?, false
+      assert_equal word.member?('id'), true
+      assert_equal word['id'].to_i > 0, true
+    end
+
+    should "lookup definitions for a word" do
+      definitions = @wordnik.define(@test_word)
+
+      assert_equal definitions.is_a?(Array), true
+      assert_equal definitions.empty?, false
+      assert_equal definitions.first.is_a?(Hash), true
+      assert_equal definitions.first.member?('id'), true
+    end
+
+    should "find frequency counts for a word" do
+      frequency = @wordnik.frequency(@test_word)
+
+      assert_equal frequency.is_a?(Hash), true
+      assert_equal frequency.member?('frequency'), true
+    end
+
+    should "find examples for a word" do
+      examples = @wordnik.examples(@test_word)
+
+      assert_equal examples.is_a?(Array), true
+      assert_equal examples.empty?, false
+    end
+
+    should "autocomplete a word fragment" do
+      suggestions = @wordnik.autocomplete(@test_word_fragment)
+
+      assert_equal suggestions.is_a?(Hash), true
+      assert_equal suggestions['match'].is_a?(Array), true
+      assert_equal suggestions['match'].empty?, false
+    end
+
+    should "get the word of the day" do
+      word = @wordnik.word_of_the_day
+
+      assert_equal word.is_a?(Hash), true
+      assert_equal word.member?('wordstring'), true
+    end
+
+    should "get a random word" do
+      word = @wordnik.random
+
+      assert_equal word.is_a?(Hash), true
+      assert_equal word.member?('wordstring'), true
+    end
+
+    should "get punctuation info for a word" do
+      punctuation = @wordnik.punctuation(@test_word)
+
+      assert_equal punctuation.is_a?(Hash), true
+      assert_equal punctuation.key?('wordId'), true
+      assert_equal punctuation.key?('periodCount'), true
+    end
   end
 end

data/wordnik.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wordnik}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Adams"]
-  s.date = %q{2009-11-07}
+  s.date = %q{2010-03-12}
   s.description = %q{Ruby interface to the Wordnik API.  Details at http://docs.wordnik.com/api/methods.}
   s.email = %q{jasonmadams@gmail.com}
   s.extra_rdoc_files = [
@@ -19,20 +19,20 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "lib/wordnik.rb",
-     "lib/wordnik/word.rb",
-     "lib/wordnik/wordnik.rb",
      "test/helper.rb",
-     "test/test_wordnik.rb"
+     "test/test_wordnik.rb",
+     "wordnik.gemspec"
   ]
   s.homepage = %q{http://github.com/ealdent/wordnik}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Ruby interface to the Wordnik API}
   s.test_files = [
     "test/helper.rb",
@@ -44,12 +44,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.5"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
     else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.4.5"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
     end
   else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.4.5"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: wordnik
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jason Adams
@@ -9,29 +14,35 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 -05:00
+date: 2010-03-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 5
         version: 0.4.5
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 description: Ruby interface to the Wordnik API.  Details at http://docs.wordnik.com/api/methods.
 email: jasonmadams@gmail.com
 executables: []
@@ -50,8 +61,6 @@ files:
 - Rakefile
 - VERSION
 - lib/wordnik.rb
-- lib/wordnik/word.rb
-- lib/wordnik/wordnik.rb
 - test/helper.rb
 - test/test_wordnik.rb
 - wordnik.gemspec
@@ -68,18 +77,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby interface to the Wordnik API

data/lib/wordnik/word.rb

@@ -1,35 +0,0 @@
-module Wordnik
-  class Word
-    attr_reader :word
-
-    def initialize(word, eager = false)
-      @word = word.dup.freeze
-      load_all if eager
-    end
-
-    def wordnik_id
-      @wordnik_id ||= Wordnik.instance.lookup(word)['id']
-    end
-
-    def definitions
-      @definitions ||= Wordnik.instance.define(word)
-    end
-
-    def frequencies
-      @frequencies ||= Wordnik.instance.frequency(word)
-    end
-
-    def examples
-      @examples ||= Wordnik.instance.examples(word)
-    end
-
-    private
-
-    def load_all
-      wordnik_id
-      definitions
-      frequencies
-      examples
-    end
-  end
-end

data/lib/wordnik/wordnik.rb

@@ -1,61 +0,0 @@
-module Wordnik
-  class Wordnik
-    include Singleton
-    include HTTParty
-
-    attr_reader :api_key
-
-    base_uri 'http://api.wordnik.com/api'
-
-    def initialize(api_key = nil)
-      @api_key = (api_key || File.read('.api-key').strip || '').dup
-      self.class.default_params :api_key => @api_key
-    end
-
-    def api_key=(api_key)
-      @api_key = api_key.dup
-    end
-
-    def lookup(word)
-      do_request("word.json/#{word.downcase}")
-    end
-
-    def define(word, count = 100)
-      do_request("word.json/#{word.downcase}/definitions", :count => count)
-    end
-
-    def frequency(word)
-      do_request("word.json/#{word.downcase}/frequency")
-    end
-
-    def examples(word)
-      do_request("word.json/#{word.downcase}/examples")
-    end
-
-    def autocomplete(word_fragment, count = 100)
-      do_request("suggest.json/#{word_fragment.downcase}", :count => count)
-    end
-
-    def word_of_the_day
-      do_request("wordoftheday.json")
-    end
-
-    def random(has_definition = true)
-      do_request("words.json/randomWord", :hasDictionaryDef => has_definition)
-    end
-
-    protected
-
-    def do_request(request, options = {})
-      handle_result(self.class.get("/#{request}", options))
-    end
-
-    def handle_result(result)
-      if result.is_a?(String)
-        raise 'Error in result.'
-      else
-        result
-      end
-    end
-  end
-end