wordnik 4.06.05 → 4.06.06

data/lib/wordnik/resource_modules/tag.rb

@@ -3,32 +3,6 @@
 
 module TagMethods
 
-  # Returns information about API parameters
-  #
-  def get_help(*args)
-    http_method = :get
-    path = '/tag'
-
-    # Ruby turns all key-value arguments at the end into a single hash
-    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
-    # becomes {:limit => 10, :part_of_speech => 'verb'}
-    last_arg = args.pop if args.last.is_a?(Hash)
-    last_arg = args.pop if args.last.is_a?(Array)
-    last_arg ||= {}
-
-    # Look for a kwarg called :request_only, whose presence indicates
-    # that we want the request itself back, not the response body
-    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
-      request_only = true
-      last_arg.delete(:request_only)
-    end
-
-    params = last_arg
-    body ||= {}
-    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
-    request_only ? request : request.response.body
-  end
-
   # Fetches Words with a specific Tag.
   #
   def get_words_tagged(tag, *args)

data/lib/wordnik/resource_modules/user.rb

@@ -1178,30 +1178,4 @@ module UserMethods
     request_only ? request : request.response.body
   end
 
-  # Returns information about API parameters
-  #
-  def get_help(*args)
-    http_method = :get
-    path = '/user'
-
-    # Ruby turns all key-value arguments at the end into a single hash
-    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
-    # becomes {:limit => 10, :part_of_speech => 'verb'}
-    last_arg = args.pop if args.last.is_a?(Hash)
-    last_arg = args.pop if args.last.is_a?(Array)
-    last_arg ||= {}
-
-    # Look for a kwarg called :request_only, whose presence indicates
-    # that we want the request itself back, not the response body
-    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
-      request_only = true
-      last_arg.delete(:request_only)
-    end
-
-    params = last_arg
-    body ||= {}
-    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
-    request_only ? request : request.response.body
-  end
-
 end

data/lib/wordnik/resource_modules/users.rb

@@ -29,37 +29,12 @@ module UsersMethods
     request_only ? request : request.response.body
   end
 
-  # Returns information about API parameters
+  # Fetches a User by ID
   #
-  def get_help(*args)
+  def get_user_by_id(id, *args)
     http_method = :get
-    path = '/users'
-
-    # Ruby turns all key-value arguments at the end into a single hash
-    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
-    # becomes {:limit => 10, :part_of_speech => 'verb'}
-    last_arg = args.pop if args.last.is_a?(Hash)
-    last_arg = args.pop if args.last.is_a?(Array)
-    last_arg ||= {}
-
-    # Look for a kwarg called :request_only, whose presence indicates
-    # that we want the request itself back, not the response body
-    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
-      request_only = true
-      last_arg.delete(:request_only)
-    end
-
-    params = last_arg
-    body ||= {}
-    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
-    request_only ? request : request.response.body
-  end
-
-  # Creates a User
-  #
-  def create_user(body, *args)
-    http_method = :post
-    path = '/users'
+    path = '/users/id/{id}'
+    path.sub!('{id}', id.to_s)
 
     # Ruby turns all key-value arguments at the end into a single hash
     # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -81,12 +56,12 @@ module UsersMethods
     request_only ? request : request.response.body
   end
 
-  # Fetches a User by ID
+  # Fetches a User by Facebook ID
   #
-  def get_user_by_id(id, *args)
+  def get_by_facebook_id(facebookId, *args)
     http_method = :get
-    path = '/users/id/{id}'
-    path.sub!('{id}', id.to_s)
+    path = '/users/facebook/{facebookId}'
+    path.sub!('{facebookId}', facebookId.to_s)
 
     # Ruby turns all key-value arguments at the end into a single hash
     # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -108,12 +83,11 @@ module UsersMethods
     request_only ? request : request.response.body
   end
 
-  # Fetches a User by Facebook ID
+  # Creates a User
   #
-  def get_by_facebook_id(facebookId, *args)
-    http_method = :get
-    path = '/users/facebook/{facebookId}'
-    path.sub!('{facebookId}', facebookId.to_s)
+  def create_user(body, *args)
+    http_method = :post
+    path = '/users'
 
     # Ruby turns all key-value arguments at the end into a single hash
     # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')

data/lib/wordnik/resource_modules/word.rb

@@ -246,11 +246,12 @@ module WordMethods
     request_only ? request : request.response.body
   end
 
-  # Returns information about API parameters
+  # Returns a top example for a word
   #
-  def get_help(*args)
+  def get_top_example(word, *args)
     http_method = :get
-    path = '/word'
+    path = '/word/{word}/topExample'
+    path.sub!('{word}', word.to_s)
 
     # Ruby turns all key-value arguments at the end into a single hash
     # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -272,11 +273,12 @@ module WordMethods
     request_only ? request : request.response.body
   end
 
-  # Returns a top example for a word
+  # Fetches other forms of a word
+  # Deprecated
   #
-  def get_top_example(word, *args)
+  def get_punctuation_factor(word, *args)
     http_method = :get
-    path = '/word/{word}/topExample'
+    path = '/word/{word}/punctuationFactor'
     path.sub!('{word}', word.to_s)
 
     # Ruby turns all key-value arguments at the end into a single hash
@@ -299,12 +301,12 @@ module WordMethods
     request_only ? request : request.response.body
   end
 
-  # Fetches other forms of a word
-  # Deprecated
+  # Returns definitions for a word based on the sentence in which it is found
+  # Use the offset parameter when the word occurs more than once in the sentence
   #
-  def get_punctuation_factor(word, *args)
+  def contextual_lookup(word, *args)
     http_method = :get
-    path = '/word/{word}/punctuationFactor'
+    path = '/word/{word}/contextualLookup'
     path.sub!('{word}', word.to_s)
 
     # Ruby turns all key-value arguments at the end into a single hash
@@ -330,8 +332,8 @@ module WordMethods
   # Returns definitions for a word based on the sentence in which it is found
   # Use the offset parameter when the word occurs more than once in the sentence
   #
-  def contextual_lookup(word, *args)
-    http_method = :get
+  def contextual_lookup_post(word, body, *args)
+    http_method = :post
     path = '/word/{word}/contextualLookup'
     path.sub!('{word}', word.to_s)
 
@@ -355,12 +357,11 @@ module WordMethods
     request_only ? request : request.response.body
   end
 
-  # Returns definitions for a word based on the sentence in which it is found
-  # Use the offset parameter when the word occurs more than once in the sentence
+  # Returns the number of comments on a word
   #
-  def contextual_lookup_post(word, body, *args)
-    http_method = :post
-    path = '/word/{word}/contextualLookup'
+  def get_comment_count(word, *args)
+    http_method = :get
+    path = '/word/{word}/commentCount'
     path.sub!('{word}', word.to_s)
 
     # Ruby turns all key-value arguments at the end into a single hash
@@ -383,11 +384,11 @@ module WordMethods
     request_only ? request : request.response.body
   end
 
-  # Returns the number of comments on a word
+  # Returns citations for a word
   #
-  def get_comment_count(word, *args)
+  def get_citations(word, *args)
     http_method = :get
-    path = '/word/{word}/commentCount'
+    path = '/word/{word}/citations'
     path.sub!('{word}', word.to_s)
 
     # Ruby turns all key-value arguments at the end into a single hash
@@ -626,33 +627,6 @@ module WordMethods
     request_only ? request : request.response.body
   end
 
-  # Returns citations for a word
-  #
-  def get_citations(word, *args)
-    http_method = :get
-    path = '/word/{word}/citations'
-    path.sub!('{word}', word.to_s)
-
-    # Ruby turns all key-value arguments at the end into a single hash
-    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
-    # becomes {:limit => 10, :part_of_speech => 'verb'}
-    last_arg = args.pop if args.last.is_a?(Hash)
-    last_arg = args.pop if args.last.is_a?(Array)
-    last_arg ||= {}
-
-    # Look for a kwarg called :request_only, whose presence indicates
-    # that we want the request itself back, not the response body
-    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
-      request_only = true
-      last_arg.delete(:request_only)
-    end
-
-    params = last_arg
-    body ||= {}
-    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
-    request_only ? request : request.response.body
-  end
-
   # Returns syllable information for a word
   #
   def get_hyphenation(word, *args)
@@ -1197,7 +1171,7 @@ module WordMethods
 
   # Fetches a Comment by ID
   #
-  def delete_comment_on_word(word, commentId, *args)
+  def get_comment_on_word(word, commentId, *args)
     http_method = :get
     path = '/word/{word}/comment/{commentId}'
     path.sub!('{word}', word.to_s)
@@ -1361,7 +1335,7 @@ module WordMethods
   end
 
   # Fetches single audio pronunciation.
-  # The metadata includes a time-expiring fileUrl which allows reading the audio file directly from the API.    Currently only audio pronunciations from the American Heritage Dictionary in mp3 format are supported.
+  # The metadata includes a time-expiring fileUrl which allows reading the audio file directly from the API.  Currently only audio pronunciations from the American Heritage Dictionary in mp3 format are supported.
   #
   def get_pronunciation(word, pronId, *args)
     http_method = :get

data/lib/wordnik/resource_modules/word_list.rb

@@ -138,32 +138,6 @@ module WordListMethods
     request_only ? request : request.response.body
   end
 
-  # Returns information about API parameters
-  #
-  def get_help(*args)
-    http_method = :get
-    path = '/wordList'
-
-    # Ruby turns all key-value arguments at the end into a single hash
-    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
-    # becomes {:limit => 10, :part_of_speech => 'verb'}
-    last_arg = args.pop if args.last.is_a?(Hash)
-    last_arg = args.pop if args.last.is_a?(Array)
-    last_arg ||= {}
-
-    # Look for a kwarg called :request_only, whose presence indicates
-    # that we want the request itself back, not the response body
-    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
-      request_only = true
-      last_arg.delete(:request_only)
-    end
-
-    params = last_arg
-    body ||= {}
-    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
-    request_only ? request : request.response.body
-  end
-
   # Checks to see if a WordList has been favorited for a user
   #
   def is_favorite_word_list(wordListId, *args)

data/lib/wordnik/resource_modules/word_lists.rb

@@ -57,32 +57,6 @@ module WordListsMethods
     request_only ? request : request.response.body
   end
 
-  # Returns information about API parameters
-  #
-  def get_help(*args)
-    http_method = :get
-    path = '/wordLists'
-
-    # Ruby turns all key-value arguments at the end into a single hash
-    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
-    # becomes {:limit => 10, :part_of_speech => 'verb'}
-    last_arg = args.pop if args.last.is_a?(Hash)
-    last_arg = args.pop if args.last.is_a?(Array)
-    last_arg ||= {}
-
-    # Look for a kwarg called :request_only, whose presence indicates
-    # that we want the request itself back, not the response body
-    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
-      request_only = true
-      last_arg.delete(:request_only)
-    end
-
-    params = last_arg
-    body ||= {}
-    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
-    request_only ? request : request.response.body
-  end
-
   # Fetches a CommentSummary for WordList objects.
   # The CommentSummary is sorted by comment count, descending
   #

data/lib/wordnik/resource_modules/words.rb

@@ -82,32 +82,6 @@ module WordsMethods
     request_only ? request : request.response.body
   end
 
-  # Returns information about API parameters
-  #
-  def get_help(*args)
-    http_method = :get
-    path = '/words'
-
-    # Ruby turns all key-value arguments at the end into a single hash
-    # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
-    # becomes {:limit => 10, :part_of_speech => 'verb'}
-    last_arg = args.pop if args.last.is_a?(Hash)
-    last_arg = args.pop if args.last.is_a?(Array)
-    last_arg ||= {}
-
-    # Look for a kwarg called :request_only, whose presence indicates
-    # that we want the request itself back, not the response body
-    if last_arg.is_a?(Hash) && last_arg[:request_only].present?
-      request_only = true
-      last_arg.delete(:request_only)
-    end
-
-    params = last_arg
-    body ||= {}
-    request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
-    request_only ? request : request.response.body
-  end
-
   # Searches definitions.
   #
   def search_definitions(*args)

data/lib/wordnik/response.rb

@@ -36,11 +36,9 @@ module Wordnik
     # TODO: If body is XML, parse it
     # Otherwise return raw string
     def body
-      begin
-        JSON.parse raw.body
-      rescue
-        raw.body
-      end
+      JSON.parse raw.body
+    rescue
+      raw.body
     end
 
     def headers

data/lib/wordnik/version.rb

@@ -1,4 +1,4 @@
 module Wordnik
-  VERSION = "4.06.05"
+  VERSION = "4.06.06"
 end
 

data/spec/endpoint_spec.rb

@@ -3,17 +3,14 @@ require 'spec_helper'
 describe Wordnik::Endpoint do
 
   before(:each) do
-    VCR.use_cassette('words', :record => :new_episodes) do
-      @response = Typhoeus::Request.get("http://beta.wordnik.com/v4/word.json")
-    end
-    @resource = Wordnik::Resource.new(:name => "word", :raw_data => JSON.parse(@response.body))
+    @resource = Wordnik::Resource.new(:name => "word", :raw_data => JSON.parse(sample_resource_body))
     @endpoint = @resource.endpoints.first
   end
 
   describe "initialization" do
 
     it "successfully initializes" do
-      @endpoint.path.should == "/word.{format}/{word}"
+      @endpoint.path.should =~ /word\.{format}\/{word}/i
     end
 
     it "sets operations" do

data/spec/operation_parameter_spec.rb

@@ -3,11 +3,7 @@ require 'spec_helper'
 describe Wordnik::OperationParameter do
 
   before(:each) do
-    VCR.use_cassette('words', :record => :new_episodes) do
-      @response = Typhoeus::Request.get("http://beta.wordnik.com/v4/word.json")
-    end
-
-    @operation_parameter = Wordnik::OperationParameter.new(JSON.parse(@response.body)['endPoints'].first['operations'].first['parameters'].first)
+    @operation_parameter = Wordnik::OperationParameter.new(JSON.parse(sample_resource_body)['apis'].first['operations'].first['parameters'].first)
   end
 
   it "initializes" do
@@ -18,14 +14,39 @@ describe Wordnik::OperationParameter do
     @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"
+  end    
+
+  context "human_name" do
+    it "is inferred from name" do
+      @operation_parameter.should_receive(:param_type).and_return('path')
+      @operation_parameter.human_name.should == @operation_parameter.name
+    end
   
-  it "detects if its allowable values are delimited as an array"
+    it "is made more descriptive when it's the actual body of the request" do
+      @operation_parameter.should_receive(:param_type).and_return('body')
+      @operation_parameter.human_name.should == 'request body'
+    end
+  end
   
-  it "is required if it's part of the path"
+  it "has an array of allowable values" do
+    @operation_parameter.allowable_values.should be_an(Array)
+  end
   
-  it "is positional if it's part of the path"
+  it "is required if it's a path param" do
+    @operation_parameter.should_receive(:required).and_return(false)
+    @operation_parameter.should_receive(:param_type).and_return('path')
+    @operation_parameter.required?.should == true
+  end
+
+  it "is positional if it's a body param" do
+    @operation_parameter.should_receive(:param_type).and_return('body')
+    @operation_parameter.positional?.should == true
+  end
+
+  it "is positional if it's a path param (except for 'format')" do
+    @operation_parameter.should_receive(:param_type).at_least(:once).and_return('path')
+    @operation_parameter.should_receive(:name).and_return('coolness')
+    @operation_parameter.positional?.should == true
+  end
 
 end