wordnik 4.07 → 4.08

data/lib/wordnik/version.rb

@@ -1,5 +1,3 @@
 module Wordnik
-  VERSION = "4.07"
+  VERSION = "4.08"
 end
-
- 

data/spec/100words.txt

@@ -0,0 +1,100 @@
+sustain
+almandite
+source
+dessert
+scorching
+illuminant
+impeccancy
+impetrated
+acetaminophen
+phreatophyte
+churlish
+pitchblende
+delicious
+clinquant
+balmacaan
+mordant
+exhume
+scribbling
+kookaburra
+cogwheel
+pallesthesia
+expertise
+attitudinal
+omission
+paralipomena
+hooroosh
+caret
+gristliness
+jaded
+provolone
+quizzical
+grotto
+flammeous
+courageous
+phoneme
+chough
+ooze
+soundproof
+cynodont
+conjunction
+mamba
+garlicky
+pageantry
+gnosis
+heifer
+binturong
+emissaries
+ombrophobous
+forbiddance
+junior
+sporophore
+namaycush
+dwindling
+covinous
+parent
+jackroller
+saccharine
+gabelle
+exequy
+demurred
+effervescently
+ickiness
+criophore
+deity
+aliquant
+threshold
+chessman
+isallotherm
+abominable
+grease
+smuggleable
+heraldry
+bleakness
+rhododendron
+paradoxical
+ronquil
+graminaceous
+submerge
+rivulet
+asthma
+anemochore
+animadversion
+glabrescent
+argot
+insincere
+sponson
+biennial
+keenness
+stade
+hesitancy
+charades
+brilliantly
+dillydally
+fibrinogen
+apyretic
+japonaiserie
+oxlip
+amass
+satiny
+unpronounceable

data/spec/load_balancer_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Wordnik::LoadBalancer do
+	before(:each) do
+		@hosts = ["alpha","beta","gamma","delta"].map{|x| "#{x}.wordnik.com"}
+	end
+
+	describe "Load Balancer" do
+    it "allows creation with a list of hosts" do
+     	lb = Wordnik::LoadBalancer.new(@hosts)
+     	h = lb.host
+     	@hosts.should include(h)
+    end
+
+    it "returns different (random) hosts" do
+    	lb = Wordnik::LoadBalancer.new(@hosts)
+    	counts = Hash.new(0)
+    	1.upto(1000) do
+    		h = lb.host
+    		counts[h] += 1
+    	end
+    	@hosts.each {|host| counts[host].should > 10}
+    end
+
+    it "should not leak memory"
+
+  end
+end

data/spec/performance.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+require 'ruby-prof'
+
+describe "Load Balancer Performance" do
+
+	describe "With single host -- host performance" do
+		Wordnik.configuration.clear
+		Wordnik.configure do |config|
+    	config.api_key = CREDENTIALS[:api_key]
+    	config.username = CREDENTIALS[:username]
+    	config.password = CREDENTIALS[:password]
+    	config.logger = Logger.new('/dev/null')
+    	config.host = CREDENTIALS[:host] = 'api.wordnik.com'
+    	config.hosts = []
+    	config.base_path = CREDENTIALS[:base_path] || '/v4'
+  	end
+		start_time = Time.now
+  	RubyProf.start
+  	100000.times {|i| host = Wordnik.configuration.host}
+  	result = RubyProf.stop
+  	printer = RubyProf::FlatPrinter.new(result)
+		printer.print(STDOUT)
+	end
+
+	describe "With multiple hosts -- host performance" do
+		Wordnik.configuration.clear
+		Wordnik.configure do |config|
+    	config.api_key = CREDENTIALS[:api_key]
+    	config.username = CREDENTIALS[:username]
+    	config.password = CREDENTIALS[:password]
+    	config.logger = Logger.new('/dev/null')
+    	config.host = CREDENTIALS[:host] = 'api.wordnik.com'
+    	config.hosts = CREDENTIALS[:hosts] || ['ec2-50-18-25-12.us-west-1.compute.amazonaws.com',' ec2-50-18-67-92.us-west-1.compute.amazonaws.com']
+    	config.base_path = CREDENTIALS[:base_path] || '/v4'
+  	end
+		start_time = Time.now
+  	RubyProf.start
+  	100000.times {|i| host = Wordnik.configuration.host}
+  	result = RubyProf.stop
+  	printer = RubyProf::FlatPrinter.new(result)
+		printer.print(STDOUT)
+	end
+
+end
+
+ describe "Wordnik GET performance" do
+
+ 	describe "With single host" do
+	 	RubyProf.start
+	 	Wordnik.configuration.clear
+		Wordnik.configure do |config|
+    	config.api_key = CREDENTIALS[:api_key]
+    	config.username = CREDENTIALS[:username]
+    	config.password = CREDENTIALS[:password]
+    	config.logger = Logger.new('/dev/null')
+    	config.host = CREDENTIALS[:host] = 'api.wordnik.com'
+    	config.hosts = []
+    	config.base_path = CREDENTIALS[:base_path] || '/v4'
+  	end
+	 	words = File.open(File.dirname(__FILE__) + "/100words.txt").readlines.map{|w| w.strip}
+	 	start_time = Time.now
+	 	Wordnik.logger.debug "Starting at #{start_time}"
+	 	found = 0
+	 	defs = 0
+	 	examples = 0
+	 	words.each do |word|
+	 		found += 1 if Wordnik.word.get_word(word)["id"]==0
+	 		defs += Wordnik.word.get_definitions(word).size
+	 		examples += Wordnik.word.get_examples(word).size
+	 	end
+	 	total = Time.now - start_time
+	 	result = RubyProf.stop
+	 	STDOUT.puts "Found #{found} words out of #{words.size}; #{defs} definitions; #{examples} examples in #{total} seconds"
+	 	printer = RubyProf::FlatPrinter.new(result)
+	 	printer.print(STDOUT)
+ 	end
+
+ 	describe "With two hosts" do
+	 	RubyProf.start
+	 	Wordnik.configuration.clear
+		Wordnik.configure do |config|
+    	config.api_key = CREDENTIALS[:api_key]
+    	config.username = CREDENTIALS[:username]
+    	config.password = CREDENTIALS[:password]
+    	config.logger = Logger.new('/dev/null')
+    	config.host = CREDENTIALS[:host] = 'api.wordnik.com'
+    	config.hosts = CREDENTIALS[:hosts] || ['ec2-50-18-25-12.us-west-1.compute.amazonaws.com',' ec2-50-18-67-92.us-west-1.compute.amazonaws.com']
+    	config.base_path = CREDENTIALS[:base_path] || '/v4'
+  	end
+	 	words = File.open(File.dirname(__FILE__) + "/100words.txt").readlines.map{|w| w.strip}
+	 	start_time = Time.now
+	 	Wordnik.logger.debug "Starting at #{start_time}"
+	 	found = 0
+	 	defs = 0
+	 	examples = 0
+	 	words.each do |word|
+	 		found += 1 if Wordnik.word.get_word(word)["id"]==0
+	 		defs += Wordnik.word.get_definitions(word).size
+	 		examples += Wordnik.word.get_examples(word).size
+	 	end
+	 	total = Time.now - start_time
+	 	result = RubyProf.stop
+	 	STDOUT.puts "Found #{found} words out of #{words.size}; #{defs} definitions; #{examples} examples in #{total} seconds"
+	 	printer = RubyProf::FlatPrinter.new(result)
+	 	printer.print(STDOUT)
+ 	end
+
+describe "With three hosts -- one invalid" do
+	 	RubyProf.start
+	 	Wordnik.configuration.clear
+		Wordnik.configure do |config|
+    	config.api_key = CREDENTIALS[:api_key]
+    	config.username = CREDENTIALS[:username]
+    	config.password = CREDENTIALS[:password]
+    	config.logger = Logger.new('/dev/null')
+    	config.host = CREDENTIALS[:host] = 'api.wordnik.com'
+    	config.hosts = CREDENTIALS[:hosts] || ['ec2-50-18-25-12.us-west-1.compute.amazonaws.com',
+    																					'ec2-50-18-67-92.us-west-1.compute.amazonaws.com',
+    																				  'localhost']
+    	config.base_path = CREDENTIALS[:base_path] || '/v4'
+  	end
+	 	words = File.open(File.dirname(__FILE__) + "/100words.txt").readlines.map{|w| w.strip}
+	 	start_time = Time.now
+	 	Wordnik.logger.debug "Starting at #{start_time}"
+	 	found = 0
+	 	defs = 0
+	 	examples = 0
+	 	words.each do |word|
+	 		found += 1 if Wordnik.word.get_word(word)["id"]==0
+	 		defs += Wordnik.word.get_definitions(word).size
+	 		examples += Wordnik.word.get_examples(word).size
+	 	end
+	 	total = Time.now - start_time
+	 	result = RubyProf.stop
+	 	STDOUT.puts "Found #{found} words out of #{words.size}; #{defs} definitions; #{examples} examples in #{total} seconds"
+	 	printer = RubyProf::FlatPrinter.new(result)
+	 	printer.print(STDOUT)
+ 	end
+
+ end

data/spec/request_spec.rb

@@ -15,7 +15,7 @@ describe Wordnik::Request do
     it "sets default response format to json" do
       @request.format.should == 'json'
     end
-    
+
     it "allows params to be nil" do
       @request = Wordnik::Request.new(@default_http_method, @default_path, :params => nil)
       @request.query_string.should == ""
@@ -44,11 +44,11 @@ describe Wordnik::Request do
     end
 
     it "constructs a full url" do
-      @request.url.should == "http://localhost:8001/admin/api/words.json/fancy?bar=2&foo=1"
+      @request.url.has_suffix?("#{Wordnik.configuration.base_path}/words.json/fancy?bar=2&foo=1").should == true
     end
 
   end
-  
+
   describe "body" do
 
     it "camelCases parameters" do
@@ -60,7 +60,7 @@ describe Wordnik::Request do
       }))
       @request.body.keys.should == [:badDog, :goodDog]
     end
-    
+
   end
 
   describe "path" do
@@ -72,7 +72,7 @@ describe Wordnik::Request do
           :word => "cat"
         }
       }))
-      @request.url.should == "http://localhost:8001/admin/api/word.xml/cat/entries"
+      @request.url.has_suffix?("#{Wordnik.configuration.base_path}/word.xml/cat/entries").should == true
     end
 
     it "does string substitution on path params" do
@@ -82,7 +82,7 @@ describe Wordnik::Request do
           :word => "cat"
         }
       }))
-      @request.url.should == "http://localhost:8001/admin/api/word.xml/cat/entries"
+      @request.url.has_suffix?("#{Wordnik.configuration.base_path}/word.xml/cat/entries").should == true
     end
 
     it "leaves path-bound params out of the query string" do
@@ -135,7 +135,7 @@ describe Wordnik::Request do
       @request.query_string.should =~ /\?limit=100/
       @request.url.should =~ /\?limit=100/
     end
-    
+
     it "camelCases parameters" do
       @request = Wordnik::Request.new(@default_http_method, @default_path, @default_params.merge({
         :params => {
@@ -145,22 +145,22 @@ describe Wordnik::Request do
       }))
       @request.query_string.should == "?badDog=bud&goodDog=dud"
     end
-    
+
     it "converts boolean values to their string representation" do
       params = {:stringy => "fish", :truthy => true, :falsey => false}
       @request = Wordnik::Request.new(:get, 'fakeMethod', :params => params)
       @request.query_string.should == "?falsey=false&stringy=fish&truthy=true"
     end
-    
+
   end
-  
+
   describe "API key" do
-    
+
     it "is inferred from the Wordnik base configuration by default" do
       Wordnik.configure {|c| c.api_key = "xyz" }
       Wordnik::Request.new(:get, "word/json").headers[:api_key].should == "xyz"
     end
-    
+
     it "can be obfuscated for public display" do
       @request = Wordnik::Request.new(:get, "words/fancy", @default_params.merge({
         :params => {
@@ -178,7 +178,7 @@ describe Wordnik::Request do
       @request_with_key = Wordnik::Request.new(:get, "word/json", :params => {:api_key => "jkl"})
       @request_with_key.headers[:api_key].should be_nil
       @request_with_key.params[:api_key].should == "jkl"
-      
+
       @request_without_key = Wordnik::Request.new(:get, "word/json", :params => {:api_key => nil})
       @request_without_key.headers[:api_key].should be_nil
       @request_without_key.params[:api_key].should be_nil
@@ -193,4 +193,4 @@ describe Wordnik::Request do
 
   end
 
-end
+end

data/spec/resource_spec.rb

@@ -21,7 +21,7 @@ describe Wordnik::Resource do
       @resource.endpoints.size.should >= 10
       @resource.endpoints.first.class.should == Wordnik::Endpoint
     end
-     
+
     it "defines a method for each operation nickname" do
       @resource.public_methods.should include(:get_word)
       @resource.public_methods.should include(:get_definitions)
@@ -30,14 +30,14 @@ describe Wordnik::Resource do
     end
 
   end
-  
+
   describe "auto-generated methods" do
-    
+
     before(:each) do
       configure_wordnik
-      VCR.use_cassette('wordnik_authenticate', :record => :new_episodes) do
-        Wordnik.authenticate
-      end
+      #VCR.use_cassette('wordnik_authenticate', :record => :new_episodes) do
+      #  Wordnik.authenticate
+      #end
     end
 
     it "builds requests but doesn't run them if :request_only is passed" do
@@ -46,25 +46,25 @@ describe Wordnik::Resource do
     end
 
     it "runs requests and returns their body if :request_only is absent" do
-      VCR.use_cassette('get_word_dynamo', :record => :new_episodes) do
+      #VCR.use_cassette('get_word_dynamo', :record => :new_episodes) do
         @response_body = Wordnik.word.get_word('dynamo')
-      end
+      #end
       @response_body.class.should == Hash
       @response_body.keys.sort.should == %w(canonicalForm id lookupCount scrabble word)
     end
-    
+
     it "allows the same auto-generated method to be called with different parameters" do
       request1 = Wordnik.word_list.get_word_list_by_id('dog', :request_only => true)
       request2 = Wordnik.word_list.get_word_list_by_id('cat', :request_only => true)
       request1.path.should_not == request2.path
     end
-    
+
     context "argument handling" do
 
       before(:each) do
          @request = Wordnik.word.get_examples('dynamo', :skip => 2, :limit => 10, :request_only => true)
        end
-       
+
        it "injects required arguments into the path" do
          @request.path.should == "/word/dynamo/examples"
        end
@@ -72,7 +72,7 @@ describe Wordnik::Resource do
        it "passes optional key-value arguments to the query string" do
          @request.query_string.should == "?limit=10&skip=2"
        end
-       
+
        it "puts key-value arguments in the request body instead of the query params for POSTs and PUTs" do
          body = {
            :name => "Wordnik Ruby Test List #{RAND}",
@@ -87,19 +87,19 @@ describe Wordnik::Resource do
          @request.body.should have_key(:type)
          @request.body.should have_key(:userId)
        end
-       
+
     end
-    
+
     context "response transmogrification" do
-      
-      it "converts definitions response into an array of definition objects" # do
-        # defs = Wordnik.word.get_definitions('boogaloo')
-        # defs.should be_an(Array)
-        # defs.first.should be_a(Wordnik::Definition)
-      # end
-      
+
+      it "converts definitions response into an array of definition objects" #do
+        #defs = Wordnik.word.get_definitions('set')
+        #defs.should be_an(Array)
+        #defs.first.should be_a(Wordnik::Definition)
+      #end
+
     end
-    
+
   end
-  
-end
+
+end