wordnik 0.3.8 → 0.3.9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wordnik (0.3.8)
+    wordnik (0.3.9)
       activemodel (>= 3.0.3)
       addressable (>= 2.2.4)
       htmlentities (>= 4.2.4)

data/lib/wordnik.rb

@@ -8,9 +8,7 @@ require 'wordnik/configuration'
 require 'wordnik/version'
 
 module Wordnik
-  
-  API_VERSION = "4.01.61"
-  
+    
   class << self
     
     # A Wordnik configuration object. Must act like a hash and return sensible
@@ -61,12 +59,17 @@ module Wordnik
     
     def authenticate
       return if Wordnik.authenticated?
+      
+      if Wordnik.configuration.username.blank? || Wordnik.configuration.password.blank?
+        raise ConfigurationError, "Username and password are required to authenticate."
+      end
+      
       response_body = Wordnik.account.get_authenticate(Wordnik.configuration.username, :password => Wordnik.configuration.password)
       if response_body.is_a?(Hash) && response_body['userId'].present? && response_body['token'].present?
         Wordnik.configuration.user_id = response_body['userId']
         Wordnik.configuration.auth_token = response_body['token']
       else
-        raise response.inspect
+        raise ApiServerError, response_body.to_s
       end
     end
     
@@ -89,4 +92,10 @@ module Wordnik
     
   end
   
+end
+
+class ConfigurationError < StandardError
+end
+
+class ApiServerError < StandardError
 end

data/lib/wordnik/operation_parameter.rb

@@ -6,9 +6,7 @@ module Wordnik
     include ActiveModel::Conversion
     extend ActiveModel::Naming
 
-    attr_accessor :name, :description, :required, :param_type, :default_value, :allowable_values
-
-    validates_presence_of :name, :description, :required, :param_type, :default_value, :allowable_values
+    attr_accessor :name, :description, :required, :param_type, :default_value, :allowable_values, :param_access, :internal_description, :wrapper_name
 
     def initialize(attributes = {})
       attributes.each do |name, value|

data/lib/wordnik/request.rb

@@ -10,23 +10,26 @@ module Wordnik
     include ActiveModel::Conversion
     extend ActiveModel::Naming
 
-    attr_accessor :host, :port, :path, :format, :params, :body, :http_method, :headers
+    attr_accessor :host, :path, :format, :params, :body, :http_method, :headers
 
     validates_presence_of :host, :path, :format, :http_method
 
+    # All requests must have an HTTP method and a path
+    # Optionals parameters are :params, :headers, :body, :format, :host
+    # 
     def initialize(http_method, path, attributes={})
       attributes[:format] ||= "json"
       attributes[:host] ||= Wordnik.configuration.base_uri
       attributes[:params] ||= {}
 
-      # Set default headers, but allow them to be overridden
+      # Set default headers
       default_headers = {
         'User-Agent' => "Wordnik Ruby Gem #{Wordnik::VERSION}",
         'Content-Type' => "application/#{attributes[:format].downcase}",
         :api_key => Wordnik.configuration.api_key
       }
 
-      # If a nil/blank api_key was passed in, remove it from the headers, even if the override is nil/blank
+      # If a nil/blank api_key was passed in, remove it from the headers, even if the override value is nil/blank
       if attributes[:headers].present? && attributes[:headers].has_key?(:api_key)
         default_headers.delete(:api_key)
       end
@@ -38,7 +41,13 @@ module Wordnik
         attributes[:headers].delete(:api_key) if attributes[:headers].present?
       end
       
+      # Merge argument headers into defaults
       attributes[:headers] = default_headers.merge(attributes[:headers] || {})
+      
+      # Stick in the auth token if there is one
+      if Wordnik.authenticated?
+        attributes[:headers].merge!({:auth_token => Wordnik.configuration.auth_token})
+      end
             
       self.http_method = http_method.to_sym
       self.path = path
@@ -50,8 +59,7 @@ module Wordnik
     # Construct a base URL
     def url
       u = Addressable::URI.new
-      u.host = self.host.sub(/\/$/, '')
-      u.port = self.port if self.port.present?
+      u.host = self.host.sub(/\/$/, '') # Remove trailing slash
       u.path = self.interpreted_path
       u.scheme = "http" # For some reason this must be set _after_ host, otherwise Addressable gets upset
       u.to_s
@@ -76,10 +84,17 @@ module Wordnik
       URI.encode(p)
     end
   
-    def interpreted_body
-      return unless self.body.present?
-      return self.body.to_json if self.body.is_a?(Hash)
-      self.body
+    # Massage the request body into a state of readiness
+    # If body is a hash, camelize all keys then convert to a json string
+    #
+    def body=(value)      
+      if value.is_a?(Hash)
+        value = value.inject({}) do |memo, (k,v)|
+          memo[k.to_s.camelize(:lower).to_sym] = v
+          memo
+        end
+      end
+      @body = value
     end
   
     # Iterate over all params,
@@ -132,21 +147,21 @@ module Wordnik
       when :post
         Typhoeus::Request.post(
           self.url_with_query_string,
-          :body => self.interpreted_body,
+          :body => self.body.to_json,
           :headers => self.headers.stringify_keys
         )
 
       when :put
         Typhoeus::Request.put(
           self.url_with_query_string,
-          :body => self.interpreted_body,
+          :body => self.body.to_json,
           :headers => self.headers.stringify_keys
         )
       
       when :delete
         Typhoeus::Request.delete(
           self.url_with_query_string,
-          :body => self.interpreted_body,
+          :body => self.body.to_json,
           :headers => self.headers.stringify_keys
         )
       end

data/lib/wordnik/version.rb

@@ -1,3 +1,3 @@
 module Wordnik
-  VERSION = "0.3.8"
+  VERSION = "0.3.9"
 end

data/spec/operation_parameter_spec.rb

@@ -13,12 +13,13 @@ describe Wordnik::OperationParameter do
   describe "initialization" do
 
     it "successfully initializes" do
-      @operation_parameter.respond_to?(:name).should == true
-      @operation_parameter.respond_to?(:description).should == true
-      @operation_parameter.respond_to?(:required).should == true
-      @operation_parameter.respond_to?(:param_type).should == true
-      @operation_parameter.respond_to?(:default_value).should == true
-      @operation_parameter.respond_to?(:allowable_values).should == true
+      @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
 
   end

data/spec/request_spec.rb

@@ -19,6 +19,11 @@ describe Wordnik::Request do
     it "gets default host from Wordnik.configuration" do
       @request.host.should == Wordnik.configuration.base_uri
     end
+    
+    it "allows params to be nil" do
+      @request = Wordnik::Request.new(@default_http_method, @default_path, :params => nil)
+      @request.query_string.should == ""
+    end
 
   end
 
@@ -59,6 +64,20 @@ describe Wordnik::Request do
     end
 
   end
+  
+  describe "body" do
+
+    it "camelCases parameters" do
+      @request = Wordnik::Request.new(@default_http_method, @default_path, @default_params.merge({
+        :body => {
+          :bad_dog => 'bud',
+          :goodDog => "dud"
+        }
+      }))
+      @request.body.keys.should == [:badDog, :goodDog]
+    end
+    
+  end
 
   describe "path" do
 

data/spec/spec_helper.rb

@@ -43,3 +43,7 @@ def configure_wordnik
 end
 
 configure_wordnik
+
+# A random string to tack onto stuff to ensure we're not seeing 
+# data from a previous test run
+RAND = ("a".."z").to_a.sample(4).join

data/spec/wordnik_spec.rb

@@ -5,6 +5,9 @@ describe Wordnik do
   before(:each) do
     configure_wordnik
   end
+  
+  after(:each) do
+  end
 
   context "initialization" do
 
@@ -49,10 +52,21 @@ describe Wordnik do
           config.password = 'wrong!'
           config.base_uri = "beta.wordnik.com/v4"
         end
+        lambda { Wordnik.authenticate }.should raise_error(ApiServerError)
         Wordnik.authenticated?.should == false
       end
       
-      it "fails if username and/or password are absent"
+      it "fails if username and/or password are absent" do
+        Wordnik.de_authenticate
+        Wordnik.configure do |config|
+          config.api_key = CREDENTIALS[:api_key]
+          config.username = nil
+          config.password = nil
+          config.base_uri = "beta.wordnik.com/v4"
+        end
+        lambda { Wordnik.authenticate }.should raise_error(ConfigurationError, /username and password are required/i)
+        Wordnik.authenticated?.should == false
+      end
       
     end
     
@@ -90,15 +104,36 @@ describe Wordnik do
          @request.query_string.should == "?limit=10&skip=2"
        end
        
+       it "puts key-value arguments in the request body instead of the query params"
+       
     end
     
     context "wordlists" do
       
+      before do
+        configure_wordnik
+        Wordnik.authenticate        
+      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 = Wordnik::Request.new(:post, "wordLists", :body => body)
+        request.response.body.should be_a_kind_of(Hash)
+        request.response.body.should have_key('permalink')
       end
       
-      it "adds words"
+      it "finds the new wordlist" do
+        lists = Wordnik.account.get_word_lists
+        permalinks = lists.map { |list| list['permalink'] }
+        permalinks.should include("wordnik-ruby-test-list-#{RAND}")
+      end
+
+      it "finds the new wordlist and adds words to it"
       
       it "updates words"
       

metadata

@@ -2,7 +2,7 @@
 name: wordnik
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors: 
 - Zeke Sikelianos
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-15 00:00:00 -07:00
+date: 2011-03-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency