wordnik 0.3.2 → 0.3.4

data/Gemfile.lock

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

data/lib/wordnik.rb

@@ -1,4 +1,3 @@
-require 'wordnik/monkey_patches'
 require 'wordnik/endpoint'
 require 'wordnik/operation'
 require 'wordnik/operation_parameter'
@@ -6,6 +5,7 @@ require 'wordnik/request'
 require 'wordnik/resource'
 require 'wordnik/response'
 require 'wordnik/configuration'
+require 'wordnik/version'
 
 module Wordnik
   
@@ -38,10 +38,18 @@ module Wordnik
       self.resources = {}
       self.resource_names.map do |resource_name|
         name = resource_name.underscore.to_sym # 'fooBar' => :foo_bar
-        filename = "api_docs/#{resource_name}.json"
+        begin
+          # This is the path the installed gem will want
+          filename = File.join(ENV['GEM_HOME'], "gems", "wordnik-#{Wordnik::VERSION}", "api_docs/#{resource_name}.json")
+          raw_data = JSON.parse(File.read(filename))
+        rescue
+          # This is the path the not-installed gem in development will want
+          filename = File.join("api_docs/#{resource_name}.json")
+          raw_data = JSON.parse(File.read(filename))
+        end
         resource = Resource.new(
           :name => name,
-          :raw_data => JSON.parse(File.read(filename))
+          :raw_data => raw_data
         )
         self.resources[name] = resource
       end

data/lib/wordnik/request.rb

@@ -5,6 +5,7 @@ module Wordnik
     require 'addressable/uri'
     require 'typhoeus'
     require 'active_model'
+    require "wordnik/version"
     include ActiveModel::Validations
     include ActiveModel::Conversion
     extend ActiveModel::Naming
@@ -24,11 +25,21 @@ module Wordnik
         'Content-Type' => "application/#{attributes[:format].downcase}",
         :api_key => Wordnik.configuration.api_key
       }
-      attributes[:headers] = default_headers.merge(attributes[:headers] || {})
-
-      # If a blank/nil api_key was passed in, remove it from the headers
-      attributes[:headers].delete(:api_key) if attributes[:headers][:api_key].blank?
 
+      # If a nil/blank api_key was passed in, remove it from the headers, even if the override is nil/blank
+      if attributes[:headers].present? && attributes[:headers].has_key?(:api_key)
+        default_headers.delete(:api_key)
+      end
+      
+      # If nil/blank api_key was passed in in the params, it overrides both the default
+      # headers and the argument headers
+      if attributes[:params].present? && attributes[:params].has_key?(:api_key)
+        default_headers.delete(:api_key)
+        attributes[:headers].delete(:api_key) if attributes[:headers].present?
+      end
+      
+      attributes[:headers] = default_headers.merge(attributes[:headers] || {})
+            
       self.http_method = http_method.to_sym
       self.path = path
       attributes.each do |name, value|

data/lib/wordnik/version.rb

@@ -1,3 +1,3 @@
 module Wordnik
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

data/spec/request_spec.rb

@@ -16,7 +16,7 @@ describe Wordnik::Request do
       @request.format.should == "json"
     end
 
-    it "sets get default host from Wordnik.configuration" do
+    it "gets default host from Wordnik.configuration" do
       @request.host.should == Wordnik.configuration.base_uri
     end
 
@@ -112,23 +112,6 @@ describe Wordnik::Request do
       @request.query_string.should == "?foo=criminy&word=dog"
     end
 
-    it "obfuscates the API key when needed" do
-      @request = Wordnik::Request.new(:get, "words/fancy", @default_params.merge({
-        :params => {
-          :word => "dog",
-          :api_key => "123456"
-        }
-      }))
-      @request.query_string_params.should == {:word => "dog", :api_key => "123456"}
-      @request.query_string_params(true).should == {:word => "dog", :api_key => "YOUR_API_KEY"}
-
-      @request.query_string.should == "?api_key=123456&word=dog"
-      @request.query_string(:obfuscated => true).should == "?api_key=YOUR_API_KEY&word=dog"
-
-      @request.url_with_query_string.should =~ /123456/
-      @request.url_with_query_string(:obfuscated => true).should =~ /YOUR\_API\_KEY/
-    end
-
     it "URI encodes the path" do
       @request = Wordnik::Request.new(:get, "word.{format}/{word}/definitions", @default_params.merge({
         :params => {
@@ -151,6 +134,50 @@ describe Wordnik::Request do
     end
     
     it "camelCases parameters"
+    
+  end
+  
+  describe "API key" do
+    
+    it "is inferred from the Wordnik base configuration by default" do
+      Wordnik.configure {|c| c.api_key = "xyz" }
+      Wordnik::Request.new(:get, "word/json").headers[:api_key].should == "xyz"
+    end
+    
+    it "gets obfuscated for public display" do
+      @request = Wordnik::Request.new(:get, "words/fancy", @default_params.merge({
+        :params => {
+          :word => "dog",
+          :api_key => "123456"
+        }
+      }))
+      @request.query_string_params.should == {:word => "dog", :api_key => "123456"}
+      @request.query_string_params(true).should == {:word => "dog", :api_key => "YOUR_API_KEY"}
+
+      @request.query_string.should == "?api_key=123456&word=dog"
+      @request.query_string(:obfuscated => true).should == "?api_key=YOUR_API_KEY&word=dog"
+
+      @request.url_with_query_string.should =~ /123456/
+      @request.url_with_query_string(:obfuscated => true).should =~ /YOUR\_API\_KEY/
+    end
+
+    it "allows a key in the params to override the configuration-level key, even if it's blank" do
+      Wordnik.configure {|c| c.api_key = "abc" }
+      @request_with_key = Wordnik::Request.new(:get, "word/json", :params => {:api_key => "jkl"})
+      @request_with_key.headers[:api_key].should be_nil
+      @request_with_key.params[:api_key].should == "jkl"
+      
+      @request_without_key = Wordnik::Request.new(:get, "word/json", :params => {:api_key => nil})
+      @request_without_key.headers[:api_key].should be_nil
+      @request_without_key.params[:api_key].should be_nil
+    end
+
+    it "allows a key in the headers to override the configuration-level key, even if it's blank" do
+      Wordnik.configure {|c| c.api_key = "hij" }
+      Wordnik::Request.new(:get, "word/json").headers[:api_key].should == "hij"
+      Wordnik::Request.new(:get, "word/json", :headers => {:api_key => "jkl"}).headers[:api_key].should == "jkl"
+      Wordnik::Request.new(:get, "word/json", :headers => {:api_key => nil}).headers[:api_key].should be_nil
+    end
 
   end
 

data/spec/wordnik_spec.rb

@@ -2,7 +2,13 @@ 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
+  end
+
   context "instantiation" do
 
     context "resources" do

metadata

@@ -2,7 +2,7 @@
 name: wordnik
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors: 
 - Zeke Sikelianos