harrisj-nytimes-articles 0.1.2 → 0.1.3

data/VERSION.yml

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

data/lib/nytimes_articles/article.rb

@@ -16,6 +16,8 @@ module Nytimes
 
 			ALL_FIELDS = TEXT_FIELDS + RAW_FIELDS + NUMERIC_FIELDS + BOOLEAN_FIELDS + MULTIMEDIA_FIELDS + Facet::ALL_FACETS + IMAGE_FIELDS
 
+			EARLIEST_BEGIN_DATE = '19810101'
+			
 			attr_reader *ALL_FIELDS
 			
 			# special additional objects
@@ -164,11 +166,13 @@ module Nytimes
 			# * <tt>:only_facets</tt> - takes a single value or array of facets to search. Facets can either be specified as array pairs (like <tt>[Facet::GEOGRAPHIC, 'CALIFORNIA']</tt>) or facets returned from a previous search can be passed directly. A single string can be passed as well if you have hand-crafted string.
 			# * <tt>:except_facets</tt> - similar to <tt>:only_facets</tt> but is used to specify a list of facets to exclude.
 			#
+			# == TIME SEARCHES
+			# * <tt>:begin_date</tt>, <tt>:end_date</tt> - the parameters are used to specify a start and end date for search results. BOTH of these must be provided or the API will return an error. Accepts either a Time/Date argument or a string of the format YYYYMMDD. For convenience the following alternative methods are provided
+			# * <tt>:before</tt> - an alternative to :end_date. Automatically adds a :before_date of sometime in 1980 if no :since argument is also provided.
+			# * <tt>:since</tt> - An alternative to :begin_date. Automatically adds an :end_date of Time.now if no :before argument is provided.
+			#
 			# == OTHER SEARCH FIELDS
 			# * <tt>:fee</tt> - if set to true, only returns articles that must be purchased. If false, returns only free articles. If not specified, returns all articles
-			# * <tt>:begin_date</tt>, <tt>:end_date</tt> - the parameters are used to specify a start and end date for search results. BOTH of these must be provided or the API will return an error. Accepts either a Time/Date argument or a string of the format YYYYMMDD. For convenience the following alternative methods are provided
-			# * <tt>:before</tt> - an alternative to :end_date. Automatically adds a :before_date of sometime in 1980 if no :since argument is also provided; to be implemented
-			# * <tt>:since</tt> - An alternative to :begin_date. Automatically adds an :end_date of Time.now if no :before argument is provided; to be implemented.
 			# * <tt>:has_thumbnail</tt> - returns only articles that have thumbnail images associated. Note that to see the thumbnails, you must specify either <tt>:thumbnail</tt> or <tt>:all</tt> in the <tt>:fields</tt> argument).
 			# * <tt>:has_multimedia</tt> - to be implemented
 			#
@@ -395,6 +399,30 @@ module Nytimes
 				if in_params[:end_date]
 					out_params['end_date'] = date_argument(:end_date, in_params[:end_date])
 				end
+				
+				if in_params[:since]
+					if in_params[:begin_date]
+						raise ArgumentError, "You can't specify both :begin_date and :since as arguments"
+					end
+					
+					out_params['begin_date'] = date_argument(:since, in_params[:since])
+				end
+				
+				if in_params[:before]
+					if in_params[:end_date]
+						raise ArgumentError, "You can't specify both :end_date and :before as arguments"
+					end
+					
+					out_params['end_date'] = date_argument(:before, in_params[:before])
+				end
+				
+				if in_params[:before] && out_params['begin_date'].nil?
+					out_params['begin_date'] = EARLIEST_BEGIN_DATE
+				end
+				
+				if in_params[:since] && out_params['end_date'].nil?
+					out_params['end_date'] = date_argument(:end_date, Time.now)
+				end
 			end
 
 			def self.add_offset_params(out_params, in_params)

data/lib/nytimes_articles/base.rb

@@ -11,15 +11,8 @@ module Nytimes
 			API_BASE = "/svc/search/#{API_VERSION}/#{API_NAME}"
 
 			@@api_key = nil
-			@@copyright = nil
 			@@debug = false
 
-			##
-			# The copyright footer to be placed at the bottom of any data from the New York Times. Note this is only set after an API call.
-			def self.copyright
-				@@copyright
-			end
-
 			##
 			# 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/
 			def self.api_key=(key)
@@ -82,8 +75,6 @@ module Nytimes
 					# FIXME
 					#end
 
-					@@copyright = parsed_reply['copyright']
-
 					parsed_reply
 				rescue OpenURI::HTTPError => e
 					# FIXME: Return message from body?

data/test/nytimes/articles/test_article.rb

@@ -55,18 +55,84 @@ class TestNytimes::TestArticles::TestArticle < Test::Unit::TestCase
 			should "raise an ArgumentError if the end_date is NOT a string and does not respond_to strftime" do
 				assert_raise(ArgumentError) { Article.search :end_date => 23 }
 			end
-
+			
 			context ":before" do
-				should "add a begin_date in 1980 if no :since or :begin_date argument is provided"
-				should "not add a begin_date is there is a :since argument"
-				should "not add a begin_date if there is a :begin_date argument already"
+				should "send the :before value through as a end_date" do
+					t = Time.now
+					Article.expects(:invoke).with(has_entry('end_date', t.strftime("%Y%m%d")))
+					Article.search :before => t
+				end
+				
+				should "not send through :before as an argument to the API" do
+					t = Time.now
+					Article.expects(:invoke).with(Not(has_key('before')))
+					Article.search :before => t
+				end
+				
+				should "raise an ArgumentError if the before_date is NOT a string and does not respond_to strftime" do
+					assert_raise(ArgumentError) { Article.search :before => 23 }
+				end
+				
+				should "add a begin_date in 1980 if no :since or :begin_date argument is provided" do
+					Article.expects(:invoke).with(has_entry('begin_date', Article::EARLIEST_BEGIN_DATE))
+					Article.search :before => Time.now
+				end
+				
+				should "not automatically add a begin_date is there is a :since argument" do
+					since = Time.now - 12000
+					Article.expects(:invoke).with(has_entry('begin_date', since.strftime("%Y%m%d")))
+					Article.search :before => Time.now, :since => since
+				end
+				
+				should "not automatically add a begin_date if there is a :begin_date argument already" do
+					since = Time.now - 12000
+					Article.expects(:invoke).with(has_entry('begin_date', since.strftime("%Y%m%d")))
+					Article.search :before => Time.now, :begin_date => since
+				end
+				
+				should "raise an ArgumentError if there is also an :end_date argument" do
+					assert_raise(ArgumentError) { Article.search :before => Time.now, :end_date => Time.now }
+				end
 			end
-			
+
 			context ":since" do
-				should "add an end_date of now if no :before or :end_date argument is provided"
-				should "not add an end_date is there is a :before argument"
-				should "not add an end_date if there is a :end_date argument already"
-			end
+				should "send the :since value through as a begin_date" do
+					t = Time.now - 1200
+					Article.expects(:invoke).with(has_entry('begin_date', t.strftime("%Y%m%d")))
+					Article.search :since => t
+				end
+				
+				should "not send through :since as an argument to the API" do
+					t = Time.now
+					Article.expects(:invoke).with(Not(has_key('since')))
+					Article.search :since => t
+				end
+				
+				should "raise an ArgumentError if the before_date is NOT a string and does not respond_to strftime" do
+					assert_raise(ArgumentError) { Article.search :since => 23 }
+				end
+				
+				should "add a end_date of today if no :before or :end_date argument is provided" do
+					Article.expects(:invoke).with(has_entry('end_date', Time.now.strftime("%Y%m%d")))
+					Article.search :since => Time.now
+				end
+				
+				should "not automatically add a end_date is there is a :before argument" do
+					since = '19990101'
+					Article.expects(:invoke).with(has_entry('end_date', '20030101'))
+					Article.search :before => '20030101', :since => since
+				end
+				
+				should "not automatically add a end_date if there is a :end_date argument already" do
+					since = '19990101'
+					Article.expects(:invoke).with(has_entry('end_date', '20030101'))
+					Article.search :end_date => '20030101', :since => since
+				end
+				
+				should "raise an ArgumentError if there is also an :begin_date argument" do
+					assert_raise(ArgumentError) { Article.search :since => Time.now, :begin_date => Time.now }
+				end
+			end			
 		end
 
 		context "facets" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: harrisj-nytimes-articles
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Jacob Harris
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-17 00:00:00 -08:00
+date: 2009-02-23 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency