times_topics 0.1.0 → 0.2.0

data/README.rdoc

@@ -5,8 +5,45 @@
 
 = Usage
 
+First, ensure you have an API key. You may request one here: http://developer.nytimes.com/apps/register/
+
+Once you have an API key, save it in a file in RAILS_ROOT/config/times_topics.yml like so:
+
+api_key: 123456abcde
+
+You can then interact with Times Topics:
+
+require 'times_topics'
+
+tt = TimesTopics.new("Al Qaeda", "organization")
+# => #<TimesTopics:0x10220b798 @url="http://topics.nytimes.com/top/reference/timestopics/organizations/a/al_qaeda/index.html", @related_results=["Al Qaeda in Mesopotamia (Org)", "Al Qaeda in the Islamic Maghreb (Org)"], @query="Al Qaeda", @type="organization", @result={"results"=>["Al Qaeda in Mesopotamia (Org)", "Al Qaeda in the Islamic Maghreb (Org)"], "filter"=>"(Org)", "num_results"=>3, "query"=>"Al Qaeda"}>
+
+tt.url
+# => "http://topics.nytimes.com/top/reference/timestopics/organizations/a/al_qaeda/index.html"
+
+tt.page_exists?
+# => true
+
+tt.related_results
+# => ["Al Qaeda in Mesopotamia (Org)", "Al Qaeda in the Islamic Maghreb (Org)"]
+
+tt.related_result_urls
+# => ["http://topics.nytimes.com/top/reference/timestopics/organizations/a/al_qaeda_in_mesopotamia/index.html", "http://topics.nytimes.com/top/reference/timestopics/organizations/a/al_qaeda_in_the_islamic_maghreb/index.html"]
+
+tt = TimesTopics.new("Osama bin Laden")  ## defaults type to 'person'
+# => #<TimesTopics:0x10154ff18 @url="http://topics.nytimes.com/top/reference/timestopics/people/b/osama_bin_laden/index.html", @query="Osama bin Laden", @type="person", @result={"results"=>[], "filter"=>"(Per)", "num_results"=>1, "query"=>"Osama bin Laden"}>
+
+tt.url
+# => "http://topics.nytimes.com/top/reference/timestopics/people/b/osama_bin_laden/index.html"
+
+tt.page_exists?
+# => true
+
+tt.related_results
+# => nil
+
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/times_tags.rb

@@ -29,19 +29,19 @@ class TimesTags
   end
 
   def self.person_search(name)
-    get('/suggest', :query => { :query => name, :filter => '(Per)'})
+    get('/suggest', :query => { :query => name, :filter => '(Per)', 'api-key' => api_key})
   end
 
   def self.organization_search(name)
-    get('/suggest', :query => { :query => name, :filter => '(Org)'})
+    get('/suggest', :query => { :query => name, :filter => '(Org)', 'api-key' => api_key})
   end
 
   def self.geographic_search(name)
-    get('/suggest', :query => { :query => name, :filter => '(Geo)'})
+    get('/suggest', :query => { :query => name, :filter => '(Geo)', 'api-key' => api_key})
   end
 
   def self.subject_search(name)
-    get('/suggest', :query => { :query => name, :filter => '(Des)'})
+    get('/suggest', :query => { :query => name, :filter => '(Des)', 'api-key' => api_key})
   end
 
   def self.search(query, type)

data/lib/times_topics.rb

@@ -1,3 +1,5 @@
+require 'times_tags'
+
 class TimesTopics
   BASE_URI = 'http://topics.nytimes.com/top/reference/timestopics/'
   attr_accessor :query, :type, :url, :result, :related_results, :num_results

data/times_topics.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{times_topics}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jacqui Maher"]

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jacqui Maher