wordnik 0.3.6 → 0.3.7

data/README.md

@@ -22,8 +22,10 @@ Then from your project's RAILS_ROOT, run:
 Create config/initializers/wordnik.rb and drop this in:
 
 	Wordnik.configure do |config|
-		config.api_key = '12345abcde'
-		config.response_format = :json # defaults to json, but xml is also supported
+		config.api_key = '12345abcde'			# required
+		config.username = 'bozo'					# optional, but needed for user-related functions
+		config.password = 'cl0wnt0wn'			# optional, but needed for user-related functions
+		config.response_format = :json		# defaults to json, but xml is also supported
 	end
 
 ### Rails 2.x
@@ -73,6 +75,11 @@ Contributing
 * Commit and push until you are happy with your contribution
 * Make sure to add tests for the feature/bugfix. This is important so we don't break it in a future version unintentionally.
 
+Wishlist
+--------
+
+* Allow boolean params to really party like booleans (instead of 'true')
+
 Props
 -----
 

data/lib/wordnik.rb

@@ -23,12 +23,15 @@ module Wordnik
     #
     # @example
     #   Wordnik.configure do |config|
-    #     config.api_key = '1234567890abcdef'
-    #     config.response_format = :json
+    #     config.api_key = '1234567890abcdef'     # required
+    #     config.username = 'wordlover'           # optional, but needed for user-related functions
+    #     config.password = 'i<3words'            # optional, but needed for user-related functions
+    #     config.response_format = :json          # optional, defaults to json
     #   end
     def configure
       self.configuration ||= Configuration.new
       yield(configuration) if block_given?
+
       self.build_resources
     end
 
@@ -46,6 +49,26 @@ module Wordnik
         self.resources[name] = resource
       end
     end
+
+    def authenticated?
+      Wordnik.configuration.user_id.present? && Wordnik.configuration.auth_token.present?
+    end
+    
+    def de_authenticate
+      Wordnik.configuration.user_id = nil
+      Wordnik.configuration.auth_token = nil
+    end
+    
+    def authenticate
+      return if Wordnik.authenticated?
+      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
+      end
+    end
     
     # The names of all the resources.
     # This is used by Wordnik.build_resources and the rake task that fetches remote API docs
@@ -54,10 +77,16 @@ module Wordnik
       %w(account corpus document partners system tag user users word words wordList wordLists wordoftheday)
     end
     
+    # An alias. For convenience.
+    #
     def word
       Wordnik.resources[:word]
     end
     
+    def account
+      Wordnik.resources[:account]
+    end
+    
   end
   
 end

data/lib/wordnik/configuration.rb

@@ -2,11 +2,14 @@ module Wordnik
 
   class Configuration
 
-    # Wordnik API key
+    # Wordnik credentials
     attr_accessor :api_key
+    attr_accessor :username
+    attr_accessor :password
     
     # TODO: Steal all the auth stuff from the old gem!
-    # attr_accessor :auth_token    
+    attr_accessor :auth_token
+    attr_accessor :user_id
     
     # Response format can be :json (default) or :xml
     attr_accessor :response_format

data/lib/wordnik/version.rb

@@ -1,3 +1,3 @@
 module Wordnik
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'wordnik'
 require 'vcr'
 require 'typhoeus'
 require 'json'
+require 'yaml'
 
 RSpec.configure do |config|
   # some (optional) config here
@@ -14,12 +15,31 @@ VCR.config do |config|
   config.stub_with :webmock # or :fakeweb
 end
 
-unless ENV['KEY']
-  puts "\nOn Noes! You gotta include your API key when running the specs, like so:\n\nKEY=12345 rake spec\n\n"
+def help
+  puts "\nOh noes! You gotta stuff your wordnik credentials in ~/.wordnik.yml like so:\n\n"
+  puts "api_key: '12345abcdefg'"
+  puts "username: 'fumanchu'"
+  puts "password: 'kalamazoo'\n\n"
   exit
 end
 
-Wordnik.configure do |config|
-  config.api_key =  ENV['KEY']
-  config.base_uri = "beta.wordnik.com/v4"
-end
+# Parse ~/.wordnik.yml for user credentials
+begin
+  CREDENTIALS = YAML::load_file(File.join(ENV['HOME'], ".wordnik.yml")).symbolize_keys
+rescue
+  help
+end
+
+help unless Object.const_defined? 'CREDENTIALS'
+help unless [:api_key, :username, :password].all? {|key| CREDENTIALS[key].present? }
+
+def configure_wordnik
+  Wordnik.configure do |config|
+    config.api_key = CREDENTIALS[:api_key]
+    config.username = CREDENTIALS[:username]
+    config.password = CREDENTIALS[:password]
+    config.base_uri = "beta.wordnik.com/v4"
+  end
+end
+
+configure_wordnik

data/spec/wordnik_spec.rb

@@ -3,13 +3,10 @@ require 'spec_helper'
 describe Wordnik do
 
   before(:each) do
-    Wordnik.configure do |config|
-      config.api_key =  ENV['KEY']
-      config.base_uri = "beta.wordnik.com/v4"
-    end
+    configure_wordnik
   end
 
-  context "instantiation" do
+  context "initialization" do
 
     context "resources" do
       it "instantiates resources from cached JSON" do
@@ -24,7 +21,39 @@ describe Wordnik do
       it "assigns resource keys that match the resource names" do
         Wordnik.resources[:word].name.should == :word
       end
-            
+
+    end
+    
+    context "authentication" do
+      
+      before(:each) do
+      end
+      
+      it "succeeds if a username and password are present in the configuration" do
+        Wordnik.authenticate
+        Wordnik.authenticated?.should == true
+      end
+      
+      it "de_authenticates" do
+        Wordnik.authenticate
+        Wordnik.authenticated?.should == true
+        Wordnik.de_authenticate
+        Wordnik.authenticated?.should == false
+      end
+      
+      it "fails if credentials are invalid" do
+        Wordnik.de_authenticate
+        Wordnik.configure do |config|
+          config.api_key = CREDENTIALS[:api_key]
+          config.username = CREDENTIALS[:username]
+          config.password = 'wrong!'
+          config.base_uri = "beta.wordnik.com/v4"
+        end
+        Wordnik.authenticated?.should == false
+      end
+      
+      it "fails if username and/or password are absent"
+      
     end
     
   end
@@ -65,7 +94,9 @@ describe Wordnik do
     
     context "wordlists" do
       
-      it "creates a wordlist"
+      it "creates a wordlist" do
+        
+      end
       
       it "adds words"
       

metadata

@@ -2,7 +2,7 @@
 name: wordnik
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors: 
 - Zeke Sikelianos
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-04 00:00:00 -08:00
+date: 2011-03-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: wordnik
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A ruby wrapper for the Wordnik API