wordnik 0.0.2 → 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -1,3 +1,22 @@
-pkg/*
-*.gem
-.bundle
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.api-key

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.1.0:
+* First release

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2009, Jason M. Adams
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+- Neither the name of Jason M. Adams nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,23 @@
+= Wordnik
+
+Wordnik wants to be a place for all the words, and everything known about them.  They have provided a RESTful API accessible after applying for a key.  Visit http://docs.wordnik.com/api for more information and to apply for a key.
+
+== Installation
+
+Install gem via gemcutter.
+
+  gem install wordnik
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  If you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Jason Adams under the BSD license. See LICENSE for details.

data/Rakefile

@@ -1,9 +1,54 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'rubygems'
+require 'rake'
 
-require 'rspec/core/rake_task'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "wordnik"
+    gem.summary = %Q{Ruby interface to the Wordnik API}
+    gem.description = %Q{Ruby interface to the Wordnik API.  Details at http://docs.wordnik.com/api/methods.}
+    gem.email = "jasonmadams@gmail.com"
+    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 is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
 
-RSpec::Core::RakeTask.new('spec')
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
 
-# If you want to make this the default task
-task :default => :spec
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "wordnik #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/wordnik.rb

@@ -1,33 +1,4 @@
-require 'wordnik/endpoint'
-require 'wordnik/operation'
-require 'wordnik/operation_parameter'
-require 'wordnik/request'
-require 'wordnik/resource'
-require 'wordnik/response'
-require 'wordnik/configuration'
-
-module Wordnik
-  
-  API_VERSION = "4.01.61"
-  
-  class << self
-    
-    # A Wordnik configuration object. Must act like a hash and return sensible
-    # values for all Wordnik configuration options. See Wordnik::Configuration.
-    attr_accessor :configuration
-    
-    # Call this method to modify defaults in your initializers.
-    #
-    # @example
-    #   Wordnik.configure do |config|
-    #     config.api_key = '1234567890abcdef'
-    #     config.response_format = :json
-    #   end
-    def configure
-      self.configuration ||= Configuration.new
-      yield(configuration) if block_given?
-    end
-    
-  end
-  
-end
+require 'httparty'
+require 'singleton'
+require 'wordnik/wordnik'
+require 'wordnik/word'

data/lib/wordnik/word.rb

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,61 @@
+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

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'wordnik'
+
+class Test::Unit::TestCase
+end

data/test/test_wordnik.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+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"
+  end
+end

data/wordnik.gemspec

@@ -1,32 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "wordnik/version"
 
 Gem::Specification.new do |s|
-  s.name        = "wordnik"
-  s.version     = Wordnik::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Zeke Sikelianos", "John McGrath"]
-  s.email       = ["zeke@wordnik.com", "john@wordnik.com"]
-  s.homepage    = "http://developer.wordnik.com"
-  s.summary     = %q{A ruby wrapper for the Wordnik API}
-  s.description = %q{This gem provides a simple interface to the entire Wordnik API. Its methods are defined by the documentation that comes from the API itself, so it's guaranteed to be up to date.}
+  s.name = %q{wordnik}
+  s.version = "0.1.0"
 
-  s.rubyforge_project = "wordnik"
-
-  s.add_dependency 'typhoeus', '0.2.1'
-  s.add_dependency 'htmlentities', '4.2.4'
-  s.add_dependency 'addressable', '2.2.4'
-  s.add_dependency 'nokogiri', '1.4.4'
-  s.add_dependency 'activemodel', '3.0.3'
-  s.add_dependency 'json', '1.4.6'
+  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.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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/wordnik.rb",
+     "lib/wordnik/word.rb",
+     "lib/wordnik/wordnik.rb",
+     "test/helper.rb",
+     "test/test_wordnik.rb"
+  ]
+  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.summary = %q{Ruby interface to the Wordnik API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_wordnik.rb"
+  ]
 
-  s.add_development_dependency 'rspec', '2.4.0'
-  s.add_development_dependency 'vcr', '1.5.1'
-  s.add_development_dependency 'webmock', '1.6.2'
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
 end
+

metadata

@@ -1,232 +1,88 @@
 --- !ruby/object:Gem::Specification 
 name: wordnik
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
-- Zeke Sikelianos
-- John McGrath
+- Jason Adams
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-02-16 00:00:00 -08:00
+date: 2009-11-07 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: typhoeus
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 2
-        - 1
-        version: 0.2.1
-  type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: htmlentities
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 4
-        - 2
-        - 4
-        version: 4.2.4
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: addressable
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 2
-        - 4
-        version: 2.2.4
-  type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 4
-        version: 1.4.4
-  type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: activemodel
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 3
-        version: 3.0.3
+  name: httparty
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 4
-        - 6
-        version: 1.4.6
-  type: :runtime
-  version_requirements: *id006
+        version: 0.4.5
+    version: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 4
-        - 0
-        version: 2.4.0
+  name: thoughtbot-shoulda
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: vcr
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: webmock
-  prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 6
-        - 2
-        version: 1.6.2
-  type: :development
-  version_requirements: *id009
-description: This gem provides a simple interface to the entire Wordnik API. Its methods are defined by the documentation that comes from the API itself, so it's guaranteed to be up to date.
-email: 
-- zeke@wordnik.com
-- john@wordnik.com
+        version: "0"
+    version: 
+description: Ruby interface to the Wordnik API.  Details at http://docs.wordnik.com/api/methods.
+email: jasonmadams@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
 files: 
+- .document
 - .gitignore
-- Gemfile
-- Gemfile.lock
-- README.md
+- CHANGELOG
+- LICENSE
+- README.rdoc
 - Rakefile
+- VERSION
 - lib/wordnik.rb
-- lib/wordnik/configuration.rb
-- lib/wordnik/endpoint.rb
-- lib/wordnik/operation.rb
-- lib/wordnik/operation_parameter.rb
-- lib/wordnik/request.rb
-- lib/wordnik/resource.rb
-- lib/wordnik/response.rb
-- lib/wordnik/version.rb
-- spec/endpoint_spec.rb
-- spec/operation_parameter_spec.rb
-- spec/operation_spec.rb
-- spec/request_spec.rb
-- spec/resource_spec.rb
-- spec/response_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/wordnik_spec.rb
+- lib/wordnik/word.rb
+- lib/wordnik/wordnik.rb
+- test/helper.rb
+- test/test_wordnik.rb
 - wordnik.gemspec
 has_rdoc: true
-homepage: http://developer.wordnik.com
+homepage: http://github.com/ealdent/wordnik
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
+  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
+  version: 
 requirements: []
 
-rubyforge_project: wordnik
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A ruby wrapper for the Wordnik API
+summary: Ruby interface to the Wordnik API
 test_files: 
-- spec/endpoint_spec.rb
-- spec/operation_parameter_spec.rb
-- spec/operation_spec.rb
-- spec/request_spec.rb
-- spec/resource_spec.rb
-- spec/response_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/wordnik_spec.rb
+- test/helper.rb
+- test/test_wordnik.rb