wordnik 0.4.7 → 4.06.00

data/lib/wordnik/response.rb

@@ -25,9 +25,17 @@ module Wordnik
     # TODO: If body is XML, parse it
     # Otherwise return raw string
     def body
-      JSON.parse raw.body#.encode(::Encoding::UTF_8, undef: :replace)
-    rescue
-      raw.body#.encode(::Encoding::UTF_8, undef: :replace)
+
+      if self.code > 399
+        raise AuthorizationError, raw.inspect
+      end
+
+      begin
+        JSON.parse raw.body
+      rescue
+        raw.body
+      end
+      
     end
 
     def headers

data/lib/wordnik/version.rb

@@ -1,3 +1,4 @@
 module Wordnik
-  VERSION = "0.4.7"
+  VERSION = "4.06.00"
 end
+

data/spec/operation_parameter_spec.rb

@@ -10,18 +10,22 @@ describe Wordnik::OperationParameter do
     @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.should respond_to(:name)
-      @operation_parameter.should respond_to(:description)
-      @operation_parameter.should respond_to(:required)
-      @operation_parameter.should respond_to(:param_type)
-      @operation_parameter.should respond_to(:default_value)
-      @operation_parameter.should respond_to(:allowable_values)
-      @operation_parameter.should respond_to(:param_access)
-    end
-
+  it "initializes" do
+    @operation_parameter.should respond_to(:name)
+    @operation_parameter.should respond_to(:description)
+    @operation_parameter.should respond_to(:required)
+    @operation_parameter.should respond_to(:param_type)
+    @operation_parameter.should respond_to(:default_value)
+    @operation_parameter.should respond_to(:allowable_values)
+    @operation_parameter.should respond_to(:param_access)
   end
+    
+  it "has a human name"
+  
+  it "detects if its allowable values are delimited as an array"
+  
+  it "is required if it's part of the path"
+  
+  it "is positional if it's part of the path"
 
 end

data/spec/operation_spec.rb

@@ -34,5 +34,15 @@ describe Wordnik::Operation do
       @operation.get?.should == true
     end
   end
+  
+  describe "positional parameter names" do
+    
+    it "returns an empty array if there are no parameters" do
+      @operation.positional_parameter_names.should == ['word']
+      @operation.parameters = []
+      @operation.positional_parameter_names.should == []
+    end
+    
+  end
 
 end

data/spec/resource_spec.rb

@@ -81,7 +81,7 @@ describe Wordnik::Resource do
            :user_id => Wordnik.configuration.user_id,
            :request_only => true
          }
-         @request = Wordnik.word_lists.create_word_list(body)
+         @request = Wordnik.word_lists.create_word_list(body, :request_only => true)
          @request.body.should have_key(:name)
          @request.body.should have_key(:description)
          @request.body.should have_key(:type)
@@ -102,59 +102,4 @@ describe Wordnik::Resource do
     
   end
   
-  context "wordlists" do
-    
-    before do
-      configure_wordnik
-      Wordnik.authenticate
-      @permalink = "wordnik-ruby-test-list-#{RAND}"
-    end
-    
-    it "creates a wordlist" do
-      body = {
-        :name => "Wordnik Ruby Test List #{RAND}",
-        :description => 'This is created by the test suite.',
-        :type => 'PUBLIC',
-        :user_id => Wordnik.configuration.user_id,
-        :request_only => true
-      }
-      request = Wordnik.word_lists.create_word_list(body)
-      response = request.response
-      response.body.should be_a_kind_of(Hash)
-      response.body.should have_key('permalink')
-      response.body['permalink'].should == @permalink
-    end
-    
-    it "finds the new wordlist (method 1, using the wordList resource)" do
-      list = Wordnik.word_list.get_word_list_by_id(@permalink)
-      list.should have_key('permalink')
-      list['permalink'].should == @permalink
-    end
-    
-    it "finds the new wordlist (method 2, among user's wordlists)" do
-      lists = Wordnik.account.get_word_lists_for_current_user
-      permalinks = lists.map { |list| list['permalink'] }
-      permalinks.should include(@permalink)
-    end
-
-    it "adds words to it" #do
-    #   body = [
-    #     {:word => 'foo'},
-    #     {:word => 'bar'},
-    #     {:word => 'metasyntactic'},
-    #   ]
-    #   request = Wordnik.word_list.post_words(@permalink, body)
-    #   # raise request.response.inspect
-    #   
-    #   list = Wordnik.word_list.get(@permalink)
-    #   # raise list.inspect
-    # end
-    
-    it "updates words"
-    
-    it "get all the words"
-    
-    it "deletes a wordlist"
-    
-  end
 end

data/spec/response_spec.rb

@@ -4,7 +4,7 @@ describe Wordnik::Response do
 
   before(:each) do
 
-    VCR.use_cassette('default_response_request', :record => :new_episodes) do
+    VCR.use_cassette('default_response', :record => :new_episodes) do
       @raw = Typhoeus::Request.get("http://beta.wordnik.com/v4/word.json")
     end
 
@@ -26,6 +26,26 @@ describe Wordnik::Response do
       @response.headers['Wordnik-Api-Version'].to_s.should =~ /4\.0/
     end
 
+  end
+  
+  describe "unauthorized" do
+    
+    before do
+      VCR.use_cassette('unauthorized_response', :record => :new_episodes) do
+        @unauthorized_raw = Typhoeus::Request.get("http://beta.wordnik.com/v4/word.json/dog/images/flickr")
+      end
+      @response = Wordnik::Response.new(@unauthorized_raw)
+    end
+
+    it "sets a 401 status code" do
+      @response.code.should == 401
+    end
+    
+    it "raises an error when body is called" do
+      expect { @response.body }.to raise_error(AuthorizationError)
+    end
+    
+
   end
 
   describe "format" do
@@ -63,7 +83,7 @@ describe Wordnik::Response do
     
     it "has a pretty xml body" do
       VCR.use_cassette('xml_response_request', :record => :new_episodes) do
-        @raw = Typhoeus::Request.get("http://beta.wordnik.com/v4/word.xml/help")
+        @raw = Typhoeus::Request.get("http://beta.wordnik.com/v4/word.xml")
       end
       @response = Wordnik::Response.new(@raw)
       @response.pretty_body.should =~ /\?xml/

data/spec/spec_helper.rb

@@ -40,6 +40,7 @@ def configure_wordnik
     config.username = CREDENTIALS[:username]
     config.password = CREDENTIALS[:password]
     config.base_uri = "beta.wordnik.com/v4"
+    # config.resource_names = %w(account corpus document partners system tag user users word words wordList wordLists)
   end
 end
 

data/spec/wordnik_spec.rb

@@ -19,7 +19,7 @@ describe Wordnik do
       end
       
       it "has as many resources as there are resource names" do
-        Wordnik.resources.size.should == Wordnik.resource_names.size
+        Wordnik.resources.size.should == Wordnik.configuration.resource_names.size
       end
 
       it "assigns resource keys that match the resource names" do
@@ -55,7 +55,7 @@ describe Wordnik do
           config.password = 'wrong!'
           config.base_uri = "beta.wordnik.com/v4"
         end
-        lambda { Wordnik.authenticate }.should raise_error(ApiServerError)
+        lambda { Wordnik.authenticate }.should raise_error(AuthorizationError)
         Wordnik.authenticated?.should == false
       end
       

data/wordnik.gemspec

@@ -25,7 +25,11 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'vcr', '>=1.5.1'
   s.add_development_dependency 'webmock', '>=1.6.2'
 
-  s.files         = `git ls-files`.split("\n")
+  s.files         = [
+    `git ls-files`,
+    `find api_docs -name '*.json'`,
+    `find lib/wordnik/resource_modules -name '*.rb'`,
+  ].flatten.join("\n").split("\n").uniq.select{|f| !f.empty? }
   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"]

metadata

@@ -2,7 +2,7 @@
 name: wordnik
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.7
+  version: 4.06.00
 platform: ruby
 authors: 
 - Zeke Sikelianos
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 -07:00
+date: 2011-06-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -130,20 +130,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- USAGE.md
-- api_docs/account.json
-- api_docs/corpus.json
-- api_docs/document.json
-- api_docs/partners.json
-- api_docs/system.json
-- api_docs/tag.json
-- api_docs/user.json
-- api_docs/users.json
-- api_docs/word.json
-- api_docs/wordList.json
-- api_docs/wordLists.json
-- api_docs/wordoftheday.json
-- api_docs/words.json
+- api_docs/.gitkeep
 - config/pretty_print.xsl
 - lib/wordnik.rb
 - lib/wordnik/configuration.rb
@@ -152,13 +139,7 @@ files:
 - lib/wordnik/operation_parameter.rb
 - lib/wordnik/request.rb
 - lib/wordnik/resource.rb
-- lib/wordnik/resource_modules/account.rb
-- lib/wordnik/resource_modules/system.rb
-- lib/wordnik/resource_modules/user.rb
-- lib/wordnik/resource_modules/word.rb
-- lib/wordnik/resource_modules/word_list.rb
-- lib/wordnik/resource_modules/word_lists.rb
-- lib/wordnik/resource_modules/words.rb
+- lib/wordnik/resource_modules/.gitkeep
 - lib/wordnik/response.rb
 - lib/wordnik/version.rb
 - spec/active_support_spec.rb
@@ -172,6 +153,30 @@ files:
 - spec/spec_helper.rb
 - spec/wordnik_spec.rb
 - wordnik.gemspec
+- api_docs/account.json
+- api_docs/corpus.json
+- api_docs/document.json
+- api_docs/partners.json
+- api_docs/system.json
+- api_docs/tag.json
+- api_docs/user.json
+- api_docs/users.json
+- api_docs/word.json
+- api_docs/wordList.json
+- api_docs/wordLists.json
+- api_docs/words.json
+- lib/wordnik/resource_modules/account.rb
+- lib/wordnik/resource_modules/corpus.rb
+- lib/wordnik/resource_modules/document.rb
+- lib/wordnik/resource_modules/partners.rb
+- lib/wordnik/resource_modules/system.rb
+- lib/wordnik/resource_modules/tag.rb
+- lib/wordnik/resource_modules/user.rb
+- lib/wordnik/resource_modules/users.rb
+- lib/wordnik/resource_modules/word.rb
+- lib/wordnik/resource_modules/word_list.rb
+- lib/wordnik/resource_modules/word_lists.rb
+- lib/wordnik/resource_modules/words.rb
 has_rdoc: true
 homepage: http://developer.wordnik.com
 licenses: []

data/USAGE.md

@@ -1,298 +0,0 @@
-
-account
-=======
-
-[Wordnik.account.authenticate(username)](http://developer.wordnik.com/docs/#!/account/authenticate)
-    :password*                       The user's password
-
-[Wordnik.account.get_api_token_status()](http://developer.wordnik.com/docs/#!/account/get_api_token_status)
-    :api_key*                        Wordnik authentication token
-
-[Wordnik.account.get_username_available(username)](http://developer.wordnik.com/docs/#!/account/get_username_available)
-
-[Wordnik.account.create_api_account()](http://developer.wordnik.com/docs/#!/account/create_api_account)
-    :api_key*                        API Key
-
-[Wordnik.account.authenticate_post(username)](http://developer.wordnik.com/docs/#!/account/authenticate_post)
-    :body*                           The user's password
-
-[Wordnik.account.get_logged_in_user()](http://developer.wordnik.com/docs/#!/account/get_logged_in_user)
-    :api_key*                        API Key
-    :auth_token*                     The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)
-
-[Wordnik.account.get_word_lists_for_current_user()](http://developer.wordnik.com/docs/#!/account/get_word_lists_for_current_user)
-    :api_key*                        API Key
-    :auth_token*                     auth_token of logged-in user
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-
-system
-======
-
-[Wordnik.system.get_word_by_id()](http://developer.wordnik.com/docs/#!/system/get_word_by_id)
-    :term                            Term to query
-    :object_type                     Object type
-    :exclude_edge_types              Relationships to exclude
-    :include_edge_types              Specifies the only relationship to include (note, this overrides the exclusions)
-    :start_constraints               Edge start constraints to enforce
-    :end_constraints                 Edge end constraints to enforce
-    :max_hops                        Maximum number of to route
-    :max_results                     Maximum number of routes to return
-    :destination                     Destination to route to (VERY inefficient)
-    :use_graph_ml                    Return is GraphML format
-
-
-user
-====
-
-[Wordnik.user.get_word_of_the_day_by_date(username, date)](http://developer.wordnik.com/docs/#!/user/get_word_of_the_day_by_date)
-    :include_all                     Include WordOfTheDay items for future dates (owner-only)
-
-[Wordnik.user.get_word_of_the_day_list(username)](http://developer.wordnik.com/docs/#!/user/get_word_of_the_day_list)
-    :include_all                     Include future words (owner-only)
-
-[Wordnik.user.update_word_of_the_day_list(username)](http://developer.wordnik.com/docs/#!/user/update_word_of_the_day_list)
-    :body*                           Updated WordOfTheDayList data in the format specified by the URL
-
-[Wordnik.user.create_word_of_the_day_list(username)](http://developer.wordnik.com/docs/#!/user/create_word_of_the_day_list)
-    :body*                           WordOfTheDayList to create, provided in the format specified by the URL
-
-[Wordnik.user.update_item_in_word_of_the_day_list(username, permalink)](http://developer.wordnik.com/docs/#!/user/update_item_in_word_of_the_day_list)
-    :body*                           WordOfTheDay to add, in the format specified by the URL
-
-[Wordnik.user.update_word_of_the_day_list(username, permalink)](http://developer.wordnik.com/docs/#!/user/update_word_of_the_day_list)
-
-[Wordnik.user.delete_word_from_word_of_the_day_list(username, permalink, wordToDelete)](http://developer.wordnik.com/docs/#!/user/delete_word_from_word_of_the_day_list)
-
-[Wordnik.user.add_word_to_word_of_the_day_list(username, permalink)](http://developer.wordnik.com/docs/#!/user/add_word_to_word_of_the_day_list)
-    :body*                           WordOfTheDay to add
-
-
-word
-====
-
-[Wordnik.word.get_word(word)](http://developer.wordnik.com/docs/#!/word/get_word)
-    :use_canonical                   If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-    :include_suggestions             Return suggestions (for correct spelling, case variants, etc.)
-
-[Wordnik.word.get_examples(word)](http://developer.wordnik.com/docs/#!/word/get_examples)
-    :limit                           Maximum number of results to return
-    :include_duplicates              Show duplicate examples from different sources
-    :content_provider                Return results from a specific ContentProvider
-    :use_canonical                   If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-[Wordnik.word.get_definitions(word)](http://developer.wordnik.com/docs/#!/word/get_definitions)
-    :limit                           Maximum number of results to return
-    :part_of_speech                  CSV list of part-of-speech types
-    :include_related                 Return related words with definitions
-    :source_dictionaries             Gets from dictionaries in the supplied order of precedence
-    :use_canonical                   If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-    :include_tags                    Return a closed set of XML tags in response
-
-[Wordnik.word.get_word_frequency(word)](http://developer.wordnik.com/docs/#!/word/get_word_frequency)
-    :use_canonical                   If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-    :start_year                      Starting Year
-    :end_year                        Ending Year
-
-[Wordnik.word.get_top_example(word)](http://developer.wordnik.com/docs/#!/word/get_top_example)
-    :content_provider                Return results from a specific ContentProvider
-    :use_canonical                   If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-
-[Wordnik.word.get_related_words(word)](http://developer.wordnik.com/docs/#!/word/get_related_words)
-    :part_of_speech                  CSV list of part-of-speech types
-    :source_dictionary               Get data from a single dictionary. Valid options are ahd, century, wiktionary, webster, and wordnet.
-    :limit                           Maximum number of results to return
-    :use_canonical                   If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-    :type                            Relationship type
-
-[Wordnik.word.get_phrases(word)](http://developer.wordnik.com/docs/#!/word/get_phrases)
-    :limit                           Maximum number of results to return
-    :wlmi                            Minimum WLMI for the phrase
-    :use_canonical                   If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-
-[Wordnik.word.get_hyphenation(word)](http://developer.wordnik.com/docs/#!/word/get_hyphenation)
-    :use_canonical                   If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-    :source_dictionary               Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.
-    :limit                           Maximum number of results to return
-
-[Wordnik.word.get_text_pronunciations(word)](http://developer.wordnik.com/docs/#!/word/get_text_pronunciations)
-    :use_canonical                   If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-    :source_dictionary               Get from a single dictionary.
-    :type_format                     Text pronunciation type
-    :limit                           Maximum number of results to return
-
-[Wordnik.word.get_word_forms(word)](http://developer.wordnik.com/docs/#!/word/get_word_forms)
-    :use_canonical                   If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.
-
-[Wordnik.word.get_audio(word)](http://developer.wordnik.com/docs/#!/word/get_audio)
-    :use_canonical                   Use the canonical form of the word.
-    :limit                           Maximum number of results to return
-
-[Wordnik.word.contextual_lookup(word)](http://developer.wordnik.com/docs/#!/word/contextual_lookup)
-    :sentence*                       The sentence in which the word occurs
-    :offset                          The start character offset of the word in the given sentence
-    :expand_terms                    Expand context terms using related words
-    :include_source_dictionaries     Only include these comma-delimited source dictionaries
-    :exclude_source_dictionaries     Exclude these comma-delimited source dictionaries
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-[Wordnik.word.contextual_lookup_post(word)](http://developer.wordnik.com/docs/#!/word/contextual_lookup_post)
-    :body*                           The sentence in which the word occurs
-    :offset                          The start character offset of the word in the given sentence
-    :expand_terms                    Expand context terms using related words
-    :include_source_dictionaries     Only include these comma-delimited source dictionaries
-    :exclude_source_dictionaries     Exclude these comma-delimited source dictionaries
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-
-words
-=====
-
-[Wordnik.words.get_random_word()](http://developer.wordnik.com/docs/#!/words/get_random_word)
-    :has_dictionary_def              Only return words with dictionary definitions
-    :include_part_of_speech          CSV part-of-speech values to include
-    :exclude_part_of_speech          CSV part-of-speech values to exclude
-    :min_corpus_count                Minimum corpus frequency for terms
-    :max_corpus_count                Maximum corpus frequency for terms
-    :min_dictionary_count            Minimum dictionary count
-    :max_dictionary_count            Maximum dictionary count
-    :min_length                      Minimum word length
-    :max_length                      Maximum word length
-
-[Wordnik.words.get_random_words()](http://developer.wordnik.com/docs/#!/words/get_random_words)
-    :has_dictionary_def              Only return words with dictionary definitions
-    :include_part_of_speech          CSV part-of-speech values to include
-    :exclude_part_of_speech          CSV part-of-speech values to exclude
-    :min_corpus_count                Minimum corpus frequency for terms (integer)
-    :max_corpus_count                Maximum corpus frequency for terms (integer)
-    :min_dictionary_count            Minimum dictionary count (integer)
-    :max_dictionary_count            Maximum dictionary count (integer)
-    :min_length                      Minimum word length (characters)
-    :max_length                      Maximum word length (characters)
-    :sort_by                         Attribute to sort by
-    :sort_order                      Sort direction
-    :limit                           Maximum number of results to return (integer)
-
-[Wordnik.words.search_words()](http://developer.wordnik.com/docs/#!/words/search_words)
-    :query*                          Search term
-    :case_sensitive                  Search case sensitive
-    :include_part_of_speech          Only include these comma-delimited parts of speech
-    :exclude_part_of_speech          Exclude these comma-delimited parts of speech
-    :min_corpus_count                Minimum corpus frequency for terms
-    :max_corpus_count                Maximum corpus frequency for terms
-    :min_dictionary_count            Minimum number of dictionary entries
-    :max_dictionary_count            Maximum dictionary count
-    :min_length                      Minimum word length
-    :max_length                      Maximum word length
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-[Wordnik.words.get_word_of_the_day_lists_containing_word()](http://developer.wordnik.com/docs/#!/words/get_word_of_the_day_lists_containing_word)
-    :item_count*                     Lists must have the specified number of items
-    :contains_word                   Lists must contain a specific word
-    :subscriber_count                Lists must have the specified number of subscribers
-    :include_all                     Returns future WordOfTheDay items
-
-[Wordnik.words.get_word_of_the_day_lists_for_date(date)](http://developer.wordnik.com/docs/#!/words/get_word_of_the_day_lists_for_date)
-    :include_all                     Returns future WordOfTheDay items
-
-[Wordnik.words.subscribe_to_list(permalink)](http://developer.wordnik.com/docs/#!/words/subscribe_to_list)
-    :auth_token*                     auth_token of logged-in user
-    :medium                          Medium to subscribe with
-    :body                            Username to subscribe
-
-[Wordnik.words.search_definitions()](http://developer.wordnik.com/docs/#!/words/search_definitions)
-    :query*                          Search term
-    :defined_word_search_term        Defined word search term
-    :include_source_dictionaries     Only include these comma-delimited source dictionaries
-    :exclude_source_dictionaries     Exclude these comma-delimited source dictionaries
-    :include_part_of_speech          Only include these comma-delimited parts of speech
-    :exclude_part_of_speech          Exclude these comma-delimited parts of speech
-    :min_corpus_count                Minimum corpus frequency for terms
-    :max_corpus_count                Maximum corpus frequency for terms
-    :min_length                      Minimum word length
-    :max_length                      Maximum word length
-    :expand_terms                    Expand terms
-    :word_types                      Word types
-    :include_tags                    Return a closed set of XML tags in response
-    :sort_by                         Attribute to sort by
-    :sort_order                      Sort direction
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-[Wordnik.words.search_entries()](http://developer.wordnik.com/docs/#!/words/search_entries)
-    :query*                          Search term
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-[Wordnik.words.get_surface_forms()](http://developer.wordnik.com/docs/#!/words/get_surface_forms)
-    :term                            Word to get surface forms for.
-
-[Wordnik.words.get_word_of_the_day()](http://developer.wordnik.com/docs/#!/words/get_word_of_the_day)
-    :date                            Fetches by date in yyyy-MM-dd
-    :category                        Filters response by category
-    :creator                         Filters response by username
-
-[Wordnik.words.get_word_of_the_day_range()](http://developer.wordnik.com/docs/#!/words/get_word_of_the_day_range)
-    :category                        Filters response by category
-    :creator                         Filters response by username
-    :provider                        Filters response by ContentProvider
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-[Wordnik.words.get_word_of_the_day_list(permalink)](http://developer.wordnik.com/docs/#!/words/get_word_of_the_day_list)
-    :include_all                     Returns future WordOfTheDay items
-
-[Wordnik.words.get_word_of_the_day_list_item(permalink, specifier)](http://developer.wordnik.com/docs/#!/words/get_word_of_the_day_list_item)
-
-[Wordnik.words.get_recent_word_of_the_day_lists()](http://developer.wordnik.com/docs/#!/words/get_recent_word_of_the_day_lists)
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-[Wordnik.words.get_word_of_the_day_list_subscription_process_status()](http://developer.wordnik.com/docs/#!/words/get_word_of_the_day_list_subscription_process_status)
-    :date                            Date string to fetch for.
-
-
-word_list
-=========
-
-[Wordnik.word_list.get_word_list_by_id(wordListId)](http://developer.wordnik.com/docs/#!/word_list/get_word_list_by_id)
-    :auth_token*                     The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)
-
-[Wordnik.word_list.get_word_list_words(wordListId)](http://developer.wordnik.com/docs/#!/word_list/get_word_list_words)
-    :auth_token*                     The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)
-    :sort_by                         Field to sort by
-    :sort_order                      Direction to sort
-    :skip                            Results to skip
-    :limit                           Maximum number of results to return
-
-[Wordnik.word_list.add_words_to_word_list(wordListId)](http://developer.wordnik.com/docs/#!/word_list/add_words_to_word_list)
-    :auth_token*                     The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)
-    :body                            Words to add to WordList
-
-[Wordnik.word_list.update_word_list(wordListId)](http://developer.wordnik.com/docs/#!/word_list/update_word_list)
-    :auth_token*                     The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)
-    :body                            Updated WordList
-
-[Wordnik.word_list.delete_word_list(wordListId)](http://developer.wordnik.com/docs/#!/word_list/delete_word_list)
-    :auth_token*                     The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)
-
-[Wordnik.word_list.delete_words_from_word_list(wordListId)](http://developer.wordnik.com/docs/#!/word_list/delete_words_from_word_list)
-    :auth_token*                     The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)
-    :body                            Words to remove from WordList
-
-
-word_lists
-==========
-
-[Wordnik.word_lists.get_help()](http://developer.wordnik.com/docs/#!/word_lists/get_help)
-
-[Wordnik.word_lists.create_word_list()](http://developer.wordnik.com/docs/#!/word_lists/create_word_list)
-    :auth_token*                     The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)
-    :body                            WordList to create
-