times_wire 0.6.0 → 0.7.0

data/README.rdoc

@@ -9,6 +9,7 @@ Times Wire is a Ruby gem for interacting with The New York Times Newswire API (h
 
 == News
 
+* Dec. 15, 2011: Version 0.7.0 released, adding support for retrieving list of sections.
 * Dec. 14, 2011: Version 0.6.0 released, with support for related URLs and blog name attributes.
 * Dec. 13, 2011: Version 0.5.0 released.
 
@@ -20,7 +21,7 @@ Install Times Wire as a gem:
   
 For use in a Rails 3 application, put the following in your Gemfile:
 
-  gem "times_wire", "~> 0.5.0"
+  gem "times_wire", "~> 0.6.0"
 
 then issue the 'bundle install' command. Times Wire has been tested under Ruby 1.8.7.
 
@@ -38,7 +39,11 @@ By default, 20 items are returned, but you may change the limit in any request:
 
   @items = Item.latest('iht', 15)
 
-Limiting the items retrieved to a section of The Times is easy, too. For a list of sections, please see the Newswire API documentation (http://developer.nytimes.com/docs/read/times_newswire_api):
+Limiting the items retrieved to a section of The Times is easy, too. A list of sections supported by the News Wire API can be retrieved as follows:
+
+  @sections = Section.all
+  
+A section name can then be passed as an argument to retrieve items from that section:
 
   @items = Item.section('nyt', 'world')
   

data/lib/times_wire/item.rb

@@ -42,6 +42,7 @@ module TimesWire
     end
     
     def self.section(source='nyt', section=section, limit=20)
+      section = section.gsub(' ', '+').gsub('&', '%26')
 		  reply = Base.invoke("#{source}/#{section}/", {"limit" => limit})
 			results = reply['results']
 			@items = results.map {|r| Item.create_from_api(r)}      

data/lib/times_wire/section.rb

@@ -0,0 +1,24 @@
+module TimesWire
+  class Section < Base
+    
+    attr_reader :name
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+    
+    def self.create_from_api(params={})
+      self.new :name => params['section'],
+               :display_name => params['display_name']
+    end
+    
+    def self.all
+		  reply = Base.invoke("section-list", {"limit" => 20})
+			results = reply['results']
+			sections = results.map {|r| Section.create_from_api(r)}
+    end
+    
+  end
+end

data/lib/times_wire/version.rb

@@ -1,3 +1,3 @@
 module TimesWire
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/times_wire.rb

@@ -1,3 +1,3 @@
-%w(base item version).each do |f|
+%w(base item section version).each do |f|
   require File.join(File.dirname(__FILE__), 'times_wire', f)
 end

data/test/test_helper.rb

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'shoulda'
 require 'json'
 
-%w(base item).each do |f|
+%w(base item section).each do |f|
   require File.join(File.dirname(__FILE__), '../lib/times_wire', f)
 end
 

data/test/times_wire/test_item.rb

@@ -57,6 +57,19 @@ class TestTimesWire::TestItem < Test::Unit::TestCase
 		end
   end
   
+  # test that sections with spaces and ampersands are properly handled
+  context "create list of 20 items from the fashion & style section of NYT" do
+		setup do
+		  @items = Item.section('nyt', 'fashion & style', 20)
+		end
+
+		should "return an array of objects of the Item type from the NYT Fashion & Style section" do
+		  assert_equal(20, @items.size)
+			assert_kind_of(Item, @items.first)
+			assert_equal(["Fashion & Style"], @items.map {|i| i.section}.uniq)
+		end
+  end
+  
   context "create list of items from The Caucus blog" do
 		setup do
 		  @items = Item.blog_name('nyt', 'u.s.', 'The Caucus')

data/test/times_wire/test_section.rb

@@ -0,0 +1,15 @@
+class TestTimesWire::TestSection < Test::Unit::TestCase
+	include TimesWire
+	
+	context "list all Sections" do
+		setup do
+		  reply = Base.invoke("section-list", {"limit" => 20})
+			results = reply['results']
+			@sections = results.map {|r| Section.create_from_api(r)}
+		end
+		
+		should "return objects of the Section type" do		  
+			assert_kind_of(Section, @sections.first)
+		end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: times_wire
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Derek Willis
@@ -50,9 +50,11 @@ files:
 - lib/times_wire.rb
 - lib/times_wire/base.rb
 - lib/times_wire/item.rb
+- lib/times_wire/section.rb
 - lib/times_wire/version.rb
 - test/test_helper.rb
 - test/times_wire/test_item.rb
+- test/times_wire/test_section.rb
 - times_wire.gemspec
 has_rdoc: true
 homepage: http://rubygems.org/gems/times_wire
@@ -91,3 +93,4 @@ summary: A thin client for The New York Times Newswire API
 test_files: 
 - test/test_helper.rb
 - test/times_wire/test_item.rb
+- test/times_wire/test_section.rb