harrisj-nytimes-articles 0.2.1 → 0.3.0

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 2
-:patch: 1
+:minor: 3
+:patch: 0
 :major: 0

data/lib/nytimes_articles/base.rb

@@ -12,6 +12,7 @@ module Nytimes
 
 			@@api_key = nil
 			@@debug = false
+			@@decode_html_entities = true
 
 			##
 			# Set the API key used for operations. This needs to be called before any requests against the API. To obtain an API key, go to http://developer.nytimes.com/
@@ -22,6 +23,12 @@ module Nytimes
 			def self.debug=(flag)
 				@@debug = flag
 			end
+			
+			##
+			# Set whether or not to decode HTML entities when returning text fields.
+			def self.decode_html_entities=(flag)
+			  @@decode_html_entities = flag
+		  end
 
 			##
 			# Returns the current value of the API Key
@@ -34,13 +41,12 @@ module Nytimes
 			def self.build_request_url(params)
 				URI::HTTP.build :host => API_SERVER,
 				:path => API_BASE,
-				:query => params.map {|k,v| "#{URI.escape(k)}=#{URI.escape(v)}"}.join('&')
+				:query => params.map {|k,v| "#{URI.escape(k)}=#{URI.escape(v.to_s)}"}.join('&')
 			end
 			
 			def self.text_field(value)
 				return nil if value.nil?
-				coder = HTMLEntities.new
-				coder.decode(value)
+				@@decode_html_entities ? HTMLEntities.new.decode(value) : value
 			end
 			
 			def self.integer_field(value)

data/lib/nytimes_articles/query.rb

@@ -0,0 +1,28 @@
+require 'digest'
+
+module Nytimes
+	module Articles
+	  ##
+	  # The Query class represents a single query to the Article Search API.  Supports
+	  # all of the named parameters to Article.search as accessor methods.
+	  #
+	  class Query
+      FIELDS = [:only_facets, :except_facets, :begin_date, :end_date, :since, 
+	              :before, :fee, :has_thumbnail, :facets, :fields, :query, :offset] + Article::TEXT_FIELDS.map(&:to_sym)
+      FIELDS.each {|f| attr_accessor f}
+      
+      # Produce a hash which uniquely identifies this query
+      def hash
+        strs = FIELDS.collect {|f| "#{f}:#{send(f).inspect}"}
+        Digest::SHA256.hexdigest(strs.join(' '))
+      end
+      
+      # Perform this query.  Returns result of Article.search
+      def perform
+        params = {}
+        FIELDS.each {|f| params[f] = send(f) unless send(f).nil?}
+        Article.search(params)
+      end
+    end
+  end
+end

data/lib/nytimes_articles.rb

@@ -1,9 +1,6 @@
 # should I be setting this?
 $KCODE = 'UTF8'
 
-require File.join(File.dirname(__FILE__), 'nytimes_articles', 'exceptions')
-require File.join(File.dirname(__FILE__), 'nytimes_articles', 'base')
-require File.join(File.dirname(__FILE__), 'nytimes_articles', 'facet')
-require File.join(File.dirname(__FILE__), 'nytimes_articles', 'thumbnail')
-require File.join(File.dirname(__FILE__), 'nytimes_articles', 'article')
-require File.join(File.dirname(__FILE__), 'nytimes_articles', 'result_set')
+%w(exceptions base facet thumbnail article result_set query).each do |f|
+  require File.join(File.dirname(__FILE__), 'nytimes_articles', f)
+end

data/test/nytimes/articles/test_base.rb

@@ -88,5 +88,33 @@ class TestNytimes::TestArticles::TestBase < Test::Unit::TestCase
 				end
 			end
 		end
+		
+		context "when passing Integer for offset" do
+		  # note Article.search requries integer for offset
+		  setup do
+				FakeWeb.register_uri(api_url_for('offset' => '1'), :status => ['200', 'OK'], :string => '{}')
+			end
+		  
+		  should "not raise NoMethodError" do
+		    assert_nothing_raised(NoMethodError) { Base.invoke('offset' => 1) }
+	    end
+	  end
 	end
+	
+	context "Base#text_field" do
+    context "when decode_html_entities == true" do
+      should "decode HTML entities in text fields" do
+        assert_equal "foó", Base.text_field("fo&oacute;")
+      end
+    end
+    
+    context "when decode_html_entities == false" do
+      setup { Base.decode_html_entities = false }
+      teardown { Base.decode_html_entities = true }
+      
+      should "not decode HTML entities in text fields" do
+        assert_equal "fo&oacute;", Base.text_field("fo&oacute;")
+      end
+    end
+  end
 end

data/test/nytimes/articles/test_query.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/../../test_helper.rb'
+
+class TestNytimes::TestArticles::TestQuery < Test::Unit::TestCase
+	include Nytimes::Articles
+
+  def setup
+    Base.stubs(:invoke)
+    @query = Query.new
+  end
+
+  def assert_has_accessor(obj, name, value='foo')
+    assert_nothing_raised { obj.send("#{name}=", value) }
+    assert_equal value, obj.send(name)
+  end
+
+  def expect_search_with(hsh)
+    Article.expects(:search).with(has_entry(hsh))
+  end
+
+  def self.should_proxy_search_param(name, value)
+    should "provide accessor for :#{name}" do
+      assert_has_accessor(@query, name, value)
+    end
+
+    should "pass :#{name} to Article#search" do
+      @query.send("#{name}=", value)
+      expect_search_with name => value
+      @query.perform      
+    end
+  end
+
+  context "proxying named parameters to Article.search" do
+    (Article::TEXT_FIELDS + [:query]).each do |name|
+      should_proxy_search_param name.to_sym, 'some text field'
+    end
+
+    [:only_facets, :except_facets].each do |name|
+      should_proxy_search_param name, {'geo_facet' => 'NEW YORK CITY'}
+    end
+
+    [:begin_date, :end_date, :since, :before].each do |name|
+      should_proxy_search_param name, Time.now
+    end
+
+    [:fee, :has_thumbnail].each do |name|
+      should_proxy_search_param name, true
+    end
+
+    should_proxy_search_param :facets, ['geo_facet', 'org_facet', 'per_facet']
+    should_proxy_search_param :fields, ['title', 'abstract']
+    should_proxy_search_param :offset, 99
+    
+    should "not pass nil parameters" do
+      @query.query = 'foo'
+      Article.expects(:search).with(:query => 'foo')
+      @query.perform
+    end
+  end
+  
+  context "generating hash" do
+    # not sure how one would test this exhaustively, going for coverage + non-regression...
+    
+    should "produce the same hash for identical queries" do
+      q0 = Query.new
+      q0.query = 'foo bar baz'
+      q0.only_facets = {'geo_facet' => 'NEW YORK CITY'}
+      
+      q1 = Query.new
+      q1.query = 'foo bar baz'
+      q1.only_facets = {'geo_facet' => 'NEW YORK CITY'}
+      
+      assert_equal q0.hash, q1.hash
+    end
+    
+    should "not produce the same hash for non-identical queries" do
+      q0 = Query.new; q0.query = 'foo'
+      q1 = Query.new; q1.query = 'bar'
+      assert_not_equal q0.hash, q1.hash
+      
+      q0 = Query.new; q0.facets = {'geo_facet' => 'NEW YORK CITY'}
+      q1 = Query.new; q1.facets = {'geo_facet' => 'CALIFORNIA'}
+      assert_not_equal q0.hash, q1.hash
+      
+      q0 = Query.new; q0.since = Date.parse('1/1/2009')
+      q1 = Query.new; q1.since = Date.parse('1/2/2009')
+      assert_not_equal q0.hash, q1.hash
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: harrisj-nytimes-articles
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Jacob Harris
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-01 00:00:00 -08:00
+date: 2009-03-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,6 +37,7 @@ files:
 - lib/nytimes_articles/base.rb
 - lib/nytimes_articles/exceptions.rb
 - lib/nytimes_articles/facet.rb
+- lib/nytimes_articles/query.rb
 - lib/nytimes_articles/result_set.rb
 - lib/nytimes_articles/thumbnail.rb
 - lib/nytimes_articles.rb
@@ -45,6 +46,7 @@ files:
 - test/nytimes/articles/test_article.rb
 - test/nytimes/articles/test_base.rb
 - test/nytimes/articles/test_facet.rb
+- test/nytimes/articles/test_query.rb
 - test/nytimes/articles/test_result_set.rb
 - test/nytimes/articles/test_thumbnail.rb
 - test/test_helper.rb