wordnik 0.2.1 → 0.3.0

data/lib/wordnik/version.rb

@@ -0,0 +1,3 @@
+module Wordnik
+  VERSION = "0.3.0"
+end

data/spec/endpoint_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Wordnik::Endpoint do
+
+  before(:each) do
+    VCR.use_cassette('words', :record => :new_episodes) do
+      @response = Typhoeus::Request.get("http://api.wordnik.com/v4/word.json")
+    end
+
+    @endpoint = Wordnik::Endpoint.new(JSON.parse(@response.body)['endPoints'].first)
+  end
+
+  describe "initialization" do
+
+    it "successfully initializes" do
+      @endpoint.path.should == "/word.{format}/{word}"
+    end
+
+    it "sets operations" do
+      @endpoint.operations.class.should == Array
+      @endpoint.operations.first.class.should == Wordnik::Operation
+    end
+
+  end
+
+end

data/spec/operation_parameter_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Wordnik::OperationParameter do
+
+  before(:each) do
+    VCR.use_cassette('words', :record => :new_episodes) do
+      @response = Typhoeus::Request.get("http://api.wordnik.com/v4/word.json")
+    end
+
+    @operation_parameter = Wordnik::OperationParameter.new(JSON.parse(@response.body)['endPoints'].first['operations'].first['parameters'].first)
+  end
+
+  describe "initialization" do
+
+    it "successfully initializes" do
+      @operation_parameter.respond_to?(:name).should == true
+      @operation_parameter.respond_to?(:description).should == true
+      @operation_parameter.respond_to?(:required).should == true
+      @operation_parameter.respond_to?(:param_type).should == true
+      @operation_parameter.respond_to?(:default_value).should == true
+      @operation_parameter.respond_to?(:allowable_values).should == true
+    end
+
+  end
+
+end

data/spec/operation_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Wordnik::Operation do
+
+  before(:each) do
+    VCR.use_cassette('words', :record => :new_episodes) do
+      @response = Typhoeus::Request.get("http://api.wordnik.com/v4/word.json")
+    end
+
+    @operation = Wordnik::Operation.new(JSON.parse(@response.body)['endPoints'].first['operations'].first)
+  end
+
+  describe "initialization" do
+
+    it "successfully initializes" do
+      @operation.summary.should =~ /returns the WordObject/i
+    end
+
+    it "sets parameters" do
+      @operation.parameters.class.should == Array
+      @operation.parameters.first.class.should == Wordnik::OperationParameter
+    end
+
+  end
+
+  describe "instance methods" do
+    it "knows if its HTTP method is GET" do
+      @operation.http_method = "GET"
+      @operation.get?.should == true
+      @operation.http_method = "POST"
+      @operation.get?.should == false
+      @operation.http_method = "get"
+      @operation.get?.should == true
+    end
+  end
+
+end

data/spec/request_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+
+describe Wordnik::Request do
+
+  before(:each) do
+    @default_http_method = :get
+    @default_path = "words/fancy"
+    @default_params = {
+      :params => {:foo => "1", :bar => "2"}
+    }
+    @request = Wordnik::Request.new(@default_http_method, @default_path, @default_params)
+  end
+
+  describe "initialization" do
+    it "sets default response format to json" do
+      @request.format.should == "json"
+    end
+
+    it "sets get default host from Wordnik.configuration" do
+      @request.host.should == Wordnik.configuration.base_uri
+    end
+
+  end
+
+  describe "attr_accessors" do
+
+    it "has working attributes" do
+      @request.host.should == Wordnik.configuration.base_uri
+      @request.path.should == "words/fancy"
+    end
+
+    it "allows attributes to be overwritten" do
+      @request.http_method.should == :get
+      @request.http_method = "post"
+      @request.http_method.should == 'post'
+    end
+
+  end
+
+  describe "url" do
+
+    it "constructs a base URL" do
+      @request.url.should == "http://beta.wordnik.com/v4/words.json/fancy"
+    end
+
+    it "constructs a query string" do
+      @request.query_string.should == "?bar=2&foo=1"
+    end
+
+    it "constructs a full url" do
+      @request.url_with_query_string.should == "http://beta.wordnik.com/v4/words.json/fancy?bar=2&foo=1"
+    end
+
+    it "accounts for excessive slashes" do
+      @request = Wordnik::Request.new(:get, "andBurn", @default_params.merge({
+        :host => "slash.com/"
+      }))
+      @request.url.should == "http://slash.com/andBurn.json"
+    end
+
+  end
+
+  describe "path" do
+
+    it "accounts for a total absence of format in the path string" do
+      @request = Wordnik::Request.new(:get, "/word/{word}/entries", @default_params.merge({
+        :format => "xml",
+        :params => {
+          :word => "cat"
+        }
+      }))
+      @request.url.should == "http://beta.wordnik.com/v4/word.xml/cat/entries"
+    end
+
+    it "does string substitution on path params" do
+      @request = Wordnik::Request.new(:get, "/word.{format}/{word}/entries", @default_params.merge({
+        :format => "xml",
+        :params => {
+          :word => "cat"
+        }
+      }))
+      @request.url.should == "http://beta.wordnik.com/v4/word.xml/cat/entries"
+    end
+
+    it "leaves path-bound params out of the query string" do
+      @request = Wordnik::Request.new(:get, "/word.{format}/{word}/entries", @default_params.merge({
+        :params => {
+          :word => "cat",
+          :limit => 20
+        }
+      }))
+      @request.query_string.should == "?limit=20"
+    end
+
+    it "returns a question-mark free (blank) query string if no query params are present" do
+      @request = Wordnik::Request.new(:get, "/word.{format}/{word}/entries", @default_params.merge({
+        :params => {
+          :word => "cat",
+        }
+      }))
+      @request.query_string.should == ""
+    end
+
+    it "removes blank params" do
+      @request = Wordnik::Request.new(:get, "words/fancy", @default_params.merge({
+        :params => {
+          :word => "dog",
+          :limit => "",
+          :foo => "criminy"
+        }
+      }))
+      @request.query_string.should == "?foo=criminy&word=dog"
+    end
+
+    it "obfuscates the API key when needed" do
+      @request = Wordnik::Request.new(:get, "words/fancy", @default_params.merge({
+        :params => {
+          :word => "dog",
+          :api_key => "123456"
+        }
+      }))
+      @request.query_string_params.should == {:word => "dog", :api_key => "123456"}
+      @request.query_string_params(true).should == {:word => "dog", :api_key => "YOUR_API_KEY"}
+
+      @request.query_string.should == "?api_key=123456&word=dog"
+      @request.query_string(:obfuscated => true).should == "?api_key=YOUR_API_KEY&word=dog"
+
+      @request.url_with_query_string.should =~ /123456/
+      @request.url_with_query_string(:obfuscated => true).should =~ /YOUR\_API\_KEY/
+    end
+
+    it "URI encodes the path" do
+      @request = Wordnik::Request.new(:get, "word.{format}/{word}/definitions", @default_params.merge({
+        :params => {
+          :word => "bill gates"
+        }
+      }))
+      @request.url.should =~ /word.json\/bill\%20gates\/definitions/
+    end
+
+    it "converts numeric params to strings" do
+      @request = Wordnik::Request.new(@default_http_method, @default_path, @default_params.merge({
+        :params => {
+          :limit => 100
+        }
+      }))
+
+      @request.interpreted_path.should_not be_nil
+      @request.query_string.should =~ /\?limit=100/
+      @request.url_with_query_string.should =~ /\?limit=100/
+    end
+    
+    it "camelCases parameters"
+
+  end
+
+end

data/spec/resource_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Wordnik::Resource do
+
+  before(:each) do
+    VCR.use_cassette('words', :record => :new_episodes) do
+      @response = Typhoeus::Request.get("http://api.wordnik.com/v4/word.json")
+    end
+
+    @default_params = {
+      :name => "word",
+      :raw_data => JSON.parse(@response.body)
+    }
+
+    @resource = Wordnik::Resource.new(@default_params)
+  end
+
+  describe "initialization" do
+
+    it "successfully initializes" do
+      @resource.name.should == "word"
+    end
+
+    it "sets endpoints" do
+      @resource.endpoints.size.should == 10
+      @resource.endpoints.first.class.should == Wordnik::Endpoint
+    end
+
+  end
+
+end

data/spec/response_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Wordnik::Response do
+
+  before(:each) do
+
+    VCR.use_cassette('default_response_request', :record => :new_episodes) do
+      @raw = Typhoeus::Request.get("http://api.wordnik.com/v4/word.json")
+    end
+
+    @response = Wordnik::Response.new(@raw)
+  end
+
+  describe "initialization" do
+    it "sets body" do
+      @response.body.class.should == Hash
+      @response.body.has_key?('endPoints').should == true
+    end
+
+    it "sets code" do
+      @response.code.should == 200
+    end
+
+    it "converts header string into a hash" do
+      @response.headers.class.should == Hash
+      @response.headers['Wordnik-Api-Version'].to_s.should =~ /4\.0/
+    end
+
+  end
+
+  describe "format" do
+
+    it "recognizes json" do
+      @response.format.should == :json
+      @response.json?.should == true
+    end
+
+    it "recognizes xml" do
+      VCR.use_cassette('xml_response_request', :record => :new_episodes) do
+        @raw = Typhoeus::Request.get("http://api.wordnik.com/v4/word.xml/help")
+      end
+      @response = Wordnik::Response.new(@raw)
+      @response.format.should == :xml
+      @response.xml?.should == true
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'wordnik'
+require 'vcr'
+require 'typhoeus'
+require 'json'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end
+
+VCR.config do |config|
+  config.cassette_library_dir = 'spec/vcr'
+  config.stub_with :webmock # or :fakeweb
+end
+
+unless ENV['KEY']
+  puts "\nOn Noes! You gotta include your API key when running the specs, like so:\n\nKEY=12345 rake spec\n\n"
+  exit
+end
+
+Wordnik.configure do |config|
+  config.api_key =  ENV['KEY']
+  config.base_uri = "beta.wordnik.com/v4"
+end

data/spec/wordnik_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Wordnik do
+
+  
+  context "instantiation" do
+
+    context "resources" do
+      it "instantiates resources from cached JSON" do
+        Wordnik.resources.class.should == Hash
+        Wordnik.resources[:word].class.should == Wordnik::Resource
+      end
+      
+      it "has as many resources as there are resource names" do
+        Wordnik.resources.size.should == Wordnik.resource_names.size
+      end
+
+      it "assigns resource keys that match the resource names" do
+        Wordnik.resources[:word].name.should == :word
+      end
+            
+    end
+    
+  end
+  
+  context "dynamic method_missing magic" do
+    
+    it "maps shorthand Wordnik.resource calls to their resources" do
+      Wordnik.word.class.should == Wordnik::Resource
+      Wordnik.word.name.should == :word
+    end
+
+    it "builds requests but doesn't run them if method name begins with 'build_'" do
+      @request = Wordnik.word.build_get('dynamo')
+      @request.class.should == Wordnik::Request
+    end
+
+    it "runs requests and returns their body if method name doesn't begin with 'build_'" do
+      @response_body = Wordnik.word.get('dynamo')
+      @response_body.class.should == Hash
+      @response_body.keys.sort.should == %w(canonicalForm word)
+    end
+    
+    context "argument handling" do
+
+      before(:each) do
+         @request = Wordnik.word.build_get_examples('dynamo', :skip => 2, :limit => 10)
+       end
+       
+       it "injects required arguments into the path" do
+         @request.path.should == "/word/dynamo/examples"
+       end
+
+       it "passes optional key-value arguments to the query string" do
+         @request.query_string.should == "?limit=10&skip=2"
+       end
+       
+    end
+    
+    context "wordlists" do
+      
+      it "creates a wordlist"
+      
+      it "adds words"
+      
+      it "updates words"
+      
+      it "get all the words"
+      
+      it "deletes a wordlist"
+      
+    end
+        
+  end
+  
+end