wordnik 0.4.5 → 0.4.6

data/.rspec-tm

@@ -0,0 +1,2 @@
+--rspec-version 2.0.0
+--bundler

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wordnik (0.4.5)
+    wordnik (0.4.6)
       activemodel (>= 3.0.3)
       addressable (>= 2.2.4)
       htmlentities (>= 4.2.4)
@@ -26,14 +26,14 @@ GEM
     json (1.5.1)
     mime-types (1.16)
     nokogiri (1.4.4)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    rspec-mocks (2.5.0)
     typhoeus (0.2.4)
       mime-types
       mime-types
@@ -46,7 +46,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  rspec (>= 2.4.0)
+  rspec (>= 2.5.0)
   vcr (>= 1.5.1)
   webmock (>= 1.6.2)
   wordnik!

data/README.md

@@ -61,23 +61,21 @@ Put this somewhere in your app's initialization process:
 Usage
 -----
 
-	# The simple version..
-	examples = Wordnik.word.get_examples('monkey', :limit => 50, :part_of_speech => 'verb')
+	# The clean version..
 	examples = Wordnik.word.get_examples('monkey', :limit => 50, :part_of_speech => 'verb')
 	
 	# ..and its low-level equivalent
 	request = Wordnik::Request.new(:get, '/word/{word}/examples', :params => {:word => 'monkey', :limit => 50, :part_of_speech => 'verb'})
 	examples = request.response.body
+	
+      request1 = Wordnik.word_list.get_word_list_by_id('dog', :request_only => true)
 
-For a full list of convenience methods, checkout [USAGE.md](https://github.com/wordnik/wordnik-ruby/blob/master/USAGE.md). The wordnik gem automatically generates its convenience methods by parsing the [Wordnik API documentation](http://developer.wordnik.com/docs).
+For a full list of methods, checkout [USAGE.md](https://github.com/wordnik/wordnik-ruby/blob/master/USAGE.md). The wordnik gem automatically generates its convenience methods by parsing the [Wordnik API documentation](http://developer.wordnik.com/docs).
 
 Specs
 -----
 
-The wordnik gem uses rspec 2. To run the test suite, you have to pass in your API 
-key as an environment variable, like so:
-
-	KEY=12345 rake spec
+The wordnik gem uses rspec 2. To run the test suite, just type `rake` or `rake spec` in the gem's base directory.
 	
 Contributing
 ------------
@@ -92,8 +90,8 @@ Contributing
 Wishlist
 --------
 
-* Allow boolean params to really party like booleans (instead of 'true')
-* Remove the now-antiquated method_missing approach
+* Go Kart
+* Helicopter
 
 Props
 -----

data/Rakefile

@@ -9,11 +9,17 @@ RSpec::Core::RakeTask.new('spec')
 # If you want to make this the default task
 task :default => :spec
 
+desc 'Download the latest API docs and build out resource methods'
+task :build do
+  Rake::Task['fetch_api_docs'].execute
+  Rake::Task['write_resource_methods'].execute
+  # Rake::Task['generate_usage_docs'].invoke  
+end
 
 desc 'Download the API docs to disk'
 task :fetch_api_docs do
   
-  Wordnik.configure
+  Wordnik.configure {|c| c.base_uri = 'beta.wordnik.com/v4' }
   
   Wordnik.resource_names.each do |resource_name|
 
@@ -29,7 +35,7 @@ task :fetch_api_docs do
   
 end
 
-desc 'Iterate over resource>endpoint>operation nicknames, generating markdown documentation.'
+desc 'Iterate over resource > endpoint > operation nicknames, generating markdown documentation.'
 task :generate_usage_docs do
   Wordnik.configure
   filename = "USAGE.md"
@@ -50,12 +56,12 @@ task :generate_usage_docs do
         
         # Required kwargs
         operation.required_kwargs.each do |parameter|
-          file.write "    :#{parameter.name.underscore}* #{' ' * (29-parameter.name.underscore.size)} #{parameter.description}\n"
+          file.write "    :#{parameter.name.to_s.underscore}* #{' ' * (29-parameter.name.to_s.underscore.size)} #{parameter.description}\n"
         end
 
         # Optional kwargs
         operation.optional_kwargs.each do |parameter|
-          file.write "    :#{parameter.name.underscore} #{' ' * (30-parameter.name.underscore.size)} #{parameter.description}\n"
+          file.write "    :#{parameter.name.to_s.underscore} #{' ' * (30-parameter.name.to_s.underscore.size)} #{parameter.description}\n"
         end
       end
       
@@ -64,4 +70,83 @@ task :generate_usage_docs do
   end
 
   file.close
+end
+
+
+desc 'Iterate over each resource, generating a ruby module with operation methods for each.'
+task :write_resource_methods do
+  
+  # Remove old shit
+  system "rm lib/wordnik/resource_modules/*.rb"
+  
+  Wordnik.configure  
+  Wordnik.resources.each_pair do |resource_name, resource|
+
+    next unless resource.endpoints.present?
+    
+    filename = "lib/wordnik/resource_modules/#{resource_name}.rb"
+    file = File.new(filename, "w")
+    lines = []
+
+    lines << "# HEY HACKER! THIS IS AN AUTO-GENERATED FILE."
+    lines << "# So don't bother editing it. To see how it's built, take a look at the Rakefile\n"
+    
+    lines << "module #{resource_name.to_s.camelize}Methods\n"
+    
+    resource.endpoints.each do |endpoint|
+      endpoint.operations.each do |operation|
+        
+        next if operation.nickname.blank?
+
+        # Comment about the operation
+        lines << "  # #{operation.summary}" if operation.summary.present?
+        lines << "  # #{operation.notes}" if operation.notes.present?
+        lines << "  #" if operation.summary.present?
+        
+        # Start writing the method
+        lines << "  def #{operation.nickname}(#{[operation.positional_parameter_names, '*args'].flatten.join(', ')})"
+
+        # HTTP Method
+        lines << "    http_method = :#{operation.http_method}"
+
+        # Path
+        lines << "    path = '#{endpoint.path.sub(".{format}", "")}'"
+        operation.positional_parameter_names.each do |param|
+          lines << "    path.sub!('\{#{param}\}', #{param})\n"
+        end
+
+        lines << "    # Ruby turns all key-value arguments at the end into a single hash"
+        lines << "    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')"
+        lines << "    # becomes {:limit => 10, :part_of_speech => 'verb'}"
+        lines << "    last_arg = args.pop if args.last.is_a?(Hash)"
+        lines << "    last_arg = args.pop if args.last.is_a?(Array)"
+        lines << "    last_arg ||= {}\n"
+        
+        lines << "    # Look for a kwarg called :request_only, whose presence indicates"
+        lines << "    # that we want the request itself back, not the response body"
+        lines << "    if last_arg.is_a?(Hash) && last_arg[:request_only].present?"
+        lines << "      request_only = true"
+        lines << "      last_arg.delete(:request_only)"
+        lines << "    end\n"
+        
+        lines << "    if [:post, :put].include?(http_method)"
+        lines << "      params = nil"
+        lines << "      body = last_arg"
+        lines << "    else"
+        lines << "      params = last_arg"
+        lines << "      body = nil"
+        lines << "    end\n"
+        
+        lines << "    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)"
+        lines << "    request_only ? request : request.response.body"
+        lines << "  end\n"
+      end      
+    end
+
+    lines << "end"
+    file.write lines.join("\n")
+    file.close
+    
+  end
+
 end

data/USAGE.md

@@ -2,30 +2,77 @@
 account
 =======
 
-[Wordnik.account.get_authenticate(username)](http://developer.wordnik.com/docs/#!/account/get_authenticate)
+[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.post_authenticate(username)](http://developer.wordnik.com/docs/#!/account/post_authenticate)
+[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_user()](http://developer.wordnik.com/docs/#!/account/get_user)
+[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()](http://developer.wordnik.com/docs/#!/account/get_word_lists)
+[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)](http://developer.wordnik.com/docs/#!/word/get)
+[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.)
 
@@ -45,7 +92,7 @@ word
     :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_frequency(word)](http://developer.wordnik.com/docs/#!/word/get_frequency)
+[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
@@ -54,7 +101,7 @@ word
     :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(word)](http://developer.wordnik.com/docs/#!/word/get_related)
+[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
@@ -71,16 +118,37 @@ word
     :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_pronunciations(word)](http://developer.wordnik.com/docs/#!/word/get_pronunciations)
+[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
 =====
@@ -96,7 +164,7 @@ words
     :min_length                      Minimum word length
     :max_length                      Maximum word length
 
-[Wordnik.words.get_random()](http://developer.wordnik.com/docs/#!/words/get_random)
+[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
@@ -110,7 +178,7 @@ words
     :sort_order                      Sort direction
     :limit                           Maximum number of results to return (integer)
 
-[Wordnik.words.get_search()](http://developer.wordnik.com/docs/#!/words/get_search)
+[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
@@ -124,53 +192,107 @@ words
     :skip                            Results to skip
     :limit                           Maximum number of results to return
 
-[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_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_search(query)](http://developer.wordnik.com/docs/#!/words/get_search)
-    :case_sensitive                  Search case sensitive
+[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_dictionary_count            Minimum number of dictionary entries
-    :max_dictionary_count            Maximum dictionary count
     :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_id)](http://developer.wordnik.com/docs/#!/word_list/get)
-
-[Wordnik.word_list.post_delete_words(word_list_id)](http://developer.wordnik.com/docs/#!/word_list/post_delete_words)
-    :body                            Words to remove from WordList
+[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_words(word_list_id)](http://developer.wordnik.com/docs/#!/word_list/get_words)
+[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.post_words(word_list_id)](http://developer.wordnik.com/docs/#!/word_list/post_words)
+[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.put(word_list_id)](http://developer.wordnik.com/docs/#!/word_list/put)
+[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_id)](http://developer.wordnik.com/docs/#!/word_list/delete)
+[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.post()](http://developer.wordnik.com/docs/#!/word_lists/post)
-    :body                            WordList to create
+[Wordnik.word_lists.get_help()](http://developer.wordnik.com/docs/#!/word_lists/get_help)
 
-[Wordnik.word_lists.get()](http://developer.wordnik.com/docs/#!/word_lists/get)
+[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
 

data/api_docs/account.json

@@ -1 +1 @@
-{"endPoints":[{"path":"/account.{format}/authenticate/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"paramType":"path"},{"name":"password","description":"The user's password","required":true,"paramType":"query"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"AuthenticationToken","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"summary":"Authenticates a User","open":false,"httpMethod":"GET"}]},{"path":"/account.{format}/apiTokenStatus","description":"","operations":[{"parameters":[{"name":"api_key","description":"Wordnik authentication token","required":true,"paramType":"header"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"ApiTokenStatus","errorResponses":[{"reason":"No token supplied.","code":400},{"reason":"No API account with supplied token.","code":404}],"condition":"any"}],"summary":"Returns usage statistics for the API account.","open":true,"httpMethod":"GET"}]},{"path":"/account.{format}/authenticate/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"paramType":"path"},{"description":"The user's password","required":true,"paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"AuthenticationToken","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"summary":"Authenticates a user","open":false,"httpMethod":"POST"}]},{"path":"/account.{format}/user","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"paramType":"header"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"paramType":"header"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"summary":"Returns the logged-in User","open":false,"notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]},{"path":"/account.{format}/wordLists","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"paramType":"header"},{"name":"skip","description":"Results to skip","required":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"paramType":"query"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403},{"reason":"User account not found.","code":404}],"condition":"any"}],"summary":"Fetches WordList objects for the logged-in user.","open":false,"httpMethod":"GET"}]}],"models":[{"name":"wordList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"WordListType"},{"name":"description","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"permalink","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"username","required":false,"paramType":"string"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"paramType":"long"}]},{"name":"ApiTokenStatus","fields":[{"name":"token","required":false,"paramType":"string"},{"name":"expiresInMillis","required":false,"paramType":"long"},{"name":"totalRequests","required":false,"paramType":"long"},{"name":"remainingCalls","required":false,"paramType":"long"},{"name":"resetsInMillis","required":false,"paramType":"long"}]},{"name":"AuthenticationToken","fields":[{"name":"token","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"}]},{"name":"user","fields":[{"name":"id","description":"Unique idenitifier for a user","required":false,"paramType":"long"},{"name":"displayName","description":"Display name","required":false,"paramType":"string"},{"name":"status","description":"Account status","required":false,"allowableValues":"0,1,2,3","paramType":"int"},{"name":"password","required":false,"paramType":"string"},{"name":"userName","description":"User name","required":false,"paramType":"string"},{"name":"email","description":"Email address","required":false,"paramType":"string"},{"name":"faceBookId","description":"Facebook ID","required":false,"paramType":"string"}]}]}
+{"endPoints":[{"path":"/account.{format}/authenticate/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","paramType":"path"},{"name":"password","description":"The user's password","required":true,"dataType":"string","paramType":"query"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"AuthenticationToken","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Authentication","summary":"Authenticates a User","suggestedName":"authenticate","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/account.{format}/apiTokenStatus","description":"","operations":[{"parameters":[{"name":"api_key","description":"Wordnik authentication token","required":true,"dataType":"string","paramType":"header"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"ApiTokenStatus","errorResponses":[{"reason":"No token supplied.","code":400},{"reason":"No API account with supplied token.","code":404}],"condition":"any"}],"category":"ApiAccount","summary":"Returns usage statistics for the API account.","suggestedName":"getApiTokenStatus","deprecated":false,"open":true,"httpMethod":"GET"}]},{"path":"/account.{format}/usernameAvailable/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","paramType":"path"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"ApiResponse","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"condition":"any"}],"category":"Activation","summary":"Returns an ApiResponse indicating whether or not a username is available","suggestedName":"getUsernameAvailable","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/account.{format}/regenerateApiToken","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","paramType":"header"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid token supplied.","code":400}],"condition":"any"}],"category":"ApiAccount","summary":"Regenerates an API Token.  Currently not supported or tested.","suggestedName":"createApiAccount","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/account.{format}/authenticate/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","paramType":"path"},{"description":"The user's password","required":true,"dataType":"string","paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"AuthenticationToken","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"Authentication","summary":"Authenticates a user","suggestedName":"authenticatePost","deprecated":false,"open":false,"httpMethod":"POST"}]},{"path":"/account.{format}/user","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","paramType":"header"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","paramType":"header"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"user","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"condition":"any"}],"category":"UserInfo","summary":"Returns the logged-in User","suggestedName":"getLoggedInUser","deprecated":false,"open":false,"notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]},{"path":"/account.{format}/wordLists","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","paramType":"header"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403},{"reason":"User account not found.","code":404}],"condition":"any"}],"category":"WordLists","summary":"Fetches WordList objects for the logged-in user.","suggestedName":"getWordListsForCurrentUser","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"ApiResponse","fields":[{"name":"message","required":false,"paramType":"string"},{"name":"type","required":false,"paramType":"string"}]},{"name":"wordList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"permalink","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"username","required":false,"paramType":"string"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"paramType":"long"}]},{"name":"ApiTokenStatus","fields":[{"name":"token","required":false,"paramType":"string"},{"name":"expiresInMillis","required":false,"paramType":"long"},{"name":"totalRequests","required":false,"paramType":"long"},{"name":"remainingCalls","required":false,"paramType":"long"},{"name":"resetsInMillis","required":false,"paramType":"long"}]},{"name":"AuthenticationToken","fields":[{"name":"token","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"}]},{"name":"user","fields":[{"name":"id","description":"Unique idenitifier for a user","required":false,"paramType":"long"},{"name":"displayName","description":"Display name","required":false,"paramType":"string"},{"name":"status","description":"Account status","required":false,"allowableValues":"0,1,2,3","paramType":"int"},{"name":"password","required":false,"paramType":"string"},{"name":"userName","description":"User name","required":false,"paramType":"string"},{"name":"email","description":"Email address","required":false,"paramType":"string"},{"name":"faceBookId","description":"Facebook ID","required":false,"paramType":"string"}]}]}

data/api_docs/system.json

@@ -1 +1 @@
-{}
+{"endPoints":[{"path":"/system.{format}/graph","description":"","operations":[{"parameters":[{"name":"term","description":"Term to query","required":false,"dataType":"string","paramType":"query"},{"name":"objectType","description":"Object type","required":false,"dataType":"string","allowableValues":"word","paramType":"query"},{"name":"excludeEdgeTypes","description":"Relationships to exclude","required":false,"dataType":"string","paramType":"query"},{"name":"includeEdgeTypes","description":"Specifies the only relationship to include (note, this overrides the exclusions)","required":false,"dataType":"string","paramType":"query"},{"name":"startConstraints","description":"Edge start constraints to enforce","required":false,"dataType":"string","paramType":"query"},{"name":"endConstraints","description":"Edge end constraints to enforce","required":false,"dataType":"string","paramType":"query"},{"name":"maxHops","defaultValue":"2","description":"Maximum number of to route","required":false,"dataType":"string","paramType":"query"},{"name":"maxResults","defaultValue":"2","description":"Maximum number of routes to return","required":false,"dataType":"string","paramType":"query"},{"name":"destination","description":"Destination to route to (VERY inefficient)","required":false,"dataType":"string","paramType":"query"},{"name":"useGraphML","description":"Return is GraphML format","required":false,"dataType":"string","paramType":"query"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"graph","errorResponses":[{"reason":"Invalid query.","code":400},{"reason":"No data found.","code":404}],"condition":"any"}],"category":"Graph","summary":"Returns a graph response for the supplied terms","suggestedName":"getWordById","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"element","fields":[{"name":"id","required":true,"paramType":"string"},{"name":"weight","required":false,"paramType":"float"},{"name":"type","required":false,"paramType":"string"}]},{"name":"graph","fields":[{"name":"elements","required":false,"paramType":"List[element]"}]}]}

data/api_docs/user.json

@@ -1 +1 @@
-{}
+{"endPoints":[{"path":"/user.{format}/{username}/wordOfTheDay/{date}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDay owner","required":true,"dataType":"string","paramType":"path"},{"name":"date","description":"Date of the WordOfTheDay to retrieve (yyyy-MM-dd) format","required":true,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Include WordOfTheDay items for future dates (owner-only)","required":false,"dataType":"string","paramType":"query"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"WordOfTheDay","errorResponses":[{"reason":"Invalid username or dateString supplied","code":400},{"reason":"User not found or no list available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Returns the WordOfTheDay for a given user on a given date","suggestedName":"getWordOfTheDayByDate","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Include future words (owner-only)","required":false,"dataType":"string","paramType":"query"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"wordOfTheDayList","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Returns a user's WordOfTheDayList","suggestedName":"getWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"description":"Updated WordOfTheDayList data in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Updates a user's WordOfTheDayList","suggestedName":"updateWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDayList to create, provided in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"wordOfTheDayList","errorResponses":[{"reason":"User already has a list or list is invalid","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Creates a WordOfTheDayList","suggestedName":"createWordOfTheDayList","deprecated":false,"open":false,"notes":"A user can have only one WordOfTheDayList.","httpMethod":"POST"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of the WordOfTheDayList to add the WordOfTheDay to","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDay to add, in the format specified by the URL","required":true,"dataType":"WordOfTheDay","paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Adds a WordOfTheDay to a user's WordOfTheDayList","suggestedName":"updateItemInWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete","required":true,"dataType":"string","paramType":"path"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Deletes a user's WordOfTheDayList","suggestedName":"updateWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/{wordToDelete}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete a word from","required":true,"dataType":"string","paramType":"path"},{"name":"wordToDelete","description":"Word to delete","required":true,"dataType":"string","paramType":"path"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Deletes a specific word from a user's WordOfTheDayList","suggestedName":"deleteWordFromWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/add","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"WordOfTheDayList to modify","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDay to add","required":true,"dataType":"WordOfTheDay","paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Adds an item to a user's WordOfTheDayList","suggestedName":"addWordToWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]}],"models":[{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"paramType":"List[root]"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"WordOfTheDay","fields":[{"name":"id","required":true,"paramType":"long"},{"name":"category","required":false,"paramType":"string"},{"name":"example","required":false,"wrapperName":"examples","paramType":"List[SimpleExample]"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"word","required":false,"paramType":"string"},{"name":"definition","required":false,"wrapperName":"definitions","paramType":"List[SimpleDefinition]"},{"name":"contentProvider","required":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"publishDate","required":false,"paramType":"Date"},{"name":"parentId","required":false,"paramType":"string"},{"name":"note","required":false,"paramType":"string"},{"name":"htmlExtra","required":false,"paramType":"string"}]},{"name":"SubscriptionStatus","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"SimpleDefinition","fields":[{"name":"text","required":false,"paramType":"string"},{"name":"partOfSpeech","required":false,"paramType":"string"},{"name":"note","required":false,"paramType":"string"},{"name":"source","required":false,"paramType":"string"}]},{"name":"wordOfTheDayList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":true,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"category","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"items","required":false,"paramType":"List[WordOfTheDay]"},{"name":"subscriberCount","required":false,"paramType":"int"},{"name":"subscriptionStatus","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"commentCount","required":false,"paramType":"int"},{"name":"voteCount","required":false,"paramType":"integer"},{"name":"voteAverage","required":false,"paramType":"float"},{"name":"voteWeightedAverage","required":false,"paramType":"float"},{"name":"itemCount","required":false,"paramType":"int"},{"name":"firstItemDate","required":false,"paramType":"Date"},{"name":"lastItemDate","required":false,"paramType":"Date"},{"name":"subscriptionSchedule","required":false,"paramType":"string"},{"name":"subscriptionNamespace","required":false,"paramType":"string"},{"name":"subscriptionIdentifier","required":false,"paramType":"string"}]},{"name":"SimpleExample","fields":[{"name":"url","required":false,"paramType":"string"},{"name":"text","required":false,"paramType":"string"},{"name":"title","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"}]}]}