times_wire 0.5.0 → 0.6.0

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2011 Derek Willis
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this library except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -0,0 +1,61 @@
+
+  .-----. _                        .-.   .-. _            
+  `-. .-':_;                       : :.-.: ::_;           
+    : :  .-.,-.,-.,-. .--.  .--.   : :: :: :.-..--.  .--. 
+    : :  : :: ,. ,. :' '_.'`._-.'  : `' `' ;: :: ..'' '_.'
+    :_;  :_;:_;:_;:_;`.__.'`.__.'   `.,`.,' :_;:_;  `.__.
+
+Times Wire is a Ruby gem for interacting with The New York Times Newswire API (http://developer.nytimes.com/docs/read/times_newswire_api), which provides an up-to-the-minute stream of articles and blog posts published on NYTimes.com and The International Herald-Tribune.
+
+== News
+
+* 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.
+
+== Installation
+
+Install Times Wire as a gem:
+
+  gem install times_wire
+  
+For use in a Rails 3 application, put the following in your Gemfile:
+
+  gem "times_wire", "~> 0.5.0"
+
+then issue the 'bundle install' command. Times Wire has been tested under Ruby 1.8.7.
+
+== Getting Started
+
+You'll need an API Key from The New York Times Developer Network (http://developer.nytimes.com/). You can set your key as an environment variable (handy for running the test suite) or set it within a script or app:
+
+  TimesWire::Base.api_key = API_KEY
+  
+Times Wire allows users to retrieve news items by source ('nyt', 'iht' or 'all'), by section (such as 'world', 'u.s.', 'sports') or by NYTimes.com blog names ("The Caucus", "FiveThirtyEight" or "At War", for example). Building a request is easy. To retrieve the latest items from The New York Times:
+
+  @items = Item.latest('nyt')
+  
+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):
+
+  @items = Item.section('nyt', 'world')
+  
+Retrieving items from a single Times blog is similar:
+
+  @items = Item.blog_name('nyt', 'u.s.', 'The Caucus')
+
+Items from the Newswire API have mostly the same attributes, with some exceptions. Blog posts will have a "blog_name" attribute, while articles do not. Items that have facets and related_urls will return an array of those items, and items that have some multimedia elements (usually photographs) will return an array containing a hash for each multimedia element.
+
+== Future Development
+
+On the list for future additions is the ability to limit requests to a specific number of hours and to support offsets. Patches, pull requests and feature ideas welcomed.
+
+== Authors
+
+Derek Willis, dwillis@nytimes.com
+
+== Copyright
+
+Copyright (c) 2011 Derek Willis. See LICENSE for details.

data/lib/times_wire/item.rb

@@ -30,7 +30,9 @@ module TimesWire
                :org_facets => params['org_facet'],
                :per_facets => params['per_facet'],
                :geo_facets => params['geo_facet'],
-               :related_urls => params['related_urls']
+               :blog_name => params['blog_name'],
+               :related_urls => params['related_urls'],
+               :multimedia => params['multimedia']
     end
     
     def self.latest(source="nyt", limit=20)

data/lib/times_wire/version.rb

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

data/test/times_wire/test_item.rb

@@ -3,14 +3,22 @@ class TestTimesWire::TestItem < Test::Unit::TestCase
 	
 	context "create single Item" do
 		setup do
-		  reply = Base.invoke('', {"url" => "http://www.nytimes.com/2010/12/17/world/asia/17sanger.html"})
+		  reply = Base.invoke('', {"url" => "http://www.nytimes.com/2011/12/14/us/california-revenue-shortfall-to-force-cuts.html"})
 			@result = reply['results'].first
 			@item = Item.create_from_api(@result)
 		end
 		
-		should "return an object of the Item type" do
+		should "return an object of the Item type" do		  
 			assert_kind_of(Item, @item)
 		end
+		
+		should "have a byline" do
+		  assert_equal("By JENNIFER MEDINA", @item.byline)
+		end
+		
+		should "have a multimedia array" do
+		  assert_equal("Standard Thumbnail", @item.multimedia.first['format'])
+		end
   end
 
 	context "create list of items from NYT only" do
@@ -51,7 +59,7 @@ class TestTimesWire::TestItem < Test::Unit::TestCase
   
   context "create list of items from The Caucus blog" do
 		setup do
-		  @items = Item.blog_name('nyt', 'U.S.', 'The Caucus')
+		  @items = Item.blog_name('nyt', 'u.s.', 'The Caucus')
 		end
 
 		should "return an array of objects of the Item type from the NYT U.S. section and Caucus blog" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: times_wire
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: 
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Derek Willis
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-13 00:00:00 -05:00
+date: 2011-12-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,8 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
+- README.rdoc
 - Rakefile
 - lib/times_wire.rb
 - lib/times_wire/base.rb