times_topics 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jacqui Maher
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,20 @@
+= TimesTopics
+  A simple wrapper for the TimesTags API and Times Topics
+
+  Interact with the TimesTags API (http://developer.nytimes.com/docs/timestags_api) with this rubygem. Find people, organizations, locations, and subjects matching queries. Find Times Topics pages for query matches along with related topics, when applicable.
+
+= Usage
+
+== 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
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jacqui Maher. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "times_topics"
+    gem.summary = %Q{A simple wrapper for the TimesTags API and Times Topics}
+    gem.description = %Q{Interact with the TimesTags API (http://developer.nytimes.com/docs/timestags_api) with this rubygem. Find people, organizations, locations, and subjects matching queries. Find Times Topics pages for query matches along with related topics, when applicable.}
+    gem.email = "jacqui.maher@nytimes.com"
+    gem.homepage = "http://github.com/jacqui/times_topics"
+    gem.authors = ["Jacqui Maher"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/times_tags.rb

@@ -0,0 +1,62 @@
+require 'httparty'
+
+class TimesTags
+  include HTTParty
+
+  base_uri "http://api.nytimes.com/svc/timestags"
+  format :json
+
+  def self.api_key
+    config['api_key']
+  end
+
+  def self.config
+    @config ||= YAML::load_file(config_path)
+  end
+
+  # Path to the times_topics.yml file.
+  def self.config_path
+    if @config_path.nil?
+      if defined?(Rails.env)
+        @config_path = File.join(RAILS_ROOT, 'config', 'times_topics.yml')
+      end
+    end
+    @config_path
+  end
+
+  def self.config_path= value
+    @config_path = value
+  end
+
+  def self.person_search(name)
+    get('/suggest', :query => { :query => name, :filter => '(Per)'})
+  end
+
+  def self.organization_search(name)
+    get('/suggest', :query => { :query => name, :filter => '(Org)'})
+  end
+
+  def self.geographic_search(name)
+    get('/suggest', :query => { :query => name, :filter => '(Geo)'})
+  end
+
+  def self.subject_search(name)
+    get('/suggest', :query => { :query => name, :filter => '(Des)'})
+  end
+
+  def self.search(query, type)
+    case type
+    when /person/
+      person_search(query)
+    when /organization/
+      organization_search(query)
+    when /geographic/
+      geographic_search(query)
+    when /subject|description/
+      subject_search(query)
+    else
+      person_search(query)
+    end
+  end
+
+end

data/lib/times_topics.rb

@@ -0,0 +1,77 @@
+class TimesTopics
+  BASE_URI = 'http://topics.nytimes.com/top/reference/timestopics/'
+  attr_accessor :query, :type, :url, :result, :related_results, :num_results
+
+  def initialize(query, type = 'person')
+    @type = type
+    @query = query
+
+    if @result = TimesTags.search(query, type)
+      @num_results = @result["num_results"]
+      if @num_results > 0
+        top_result = @result["results"].shift
+        case @type
+        when /person/
+          @url = build_person_url(top_result)
+        when /organization/
+          @url = build_organization_url(top_result)
+        end
+
+        if @result["num_results"] > 1
+          @related_results = @result["results"]
+        end
+      end
+    end
+  end
+
+  def filter(long_form)
+    case long_form
+    when /org/i
+      "(Org)"
+    when /people|person/i
+      "(Per)"
+    when /geo/i
+      "(Geo)"
+    when /des/i
+      "(Des)"
+    end
+  end
+
+  def page_exists?
+    return false if @url.nil?
+    parsed_url = URI.parse(@url)
+    request = Net::HTTP::Get.new(parsed_url.path)
+    result = Net::HTTP.start(parsed_url.host, parsed_url.port) {|http|
+      http.request(request)
+    }
+    result.is_a?(Net::HTTPOK)
+  end
+
+  def related_result_urls
+    return [] if @related_results.nil? || @related_results.empty?
+    @related_results.map do |result|
+      case @type
+      when /person/i
+        build_person_url(result)
+      when /organization/
+        build_organization_url(result)
+      end
+    end
+  end
+
+  def build_person_url(result)
+    # http://topics.nytimes.com/top/reference/timestopics/people/b/osama_bin_laden/index.html
+    topic_name = result.sub(filter('person'), "").split(',').map(&:strip).reverse.join('_').gsub(/\s/, '_').downcase
+    index_char = result[0,1].downcase
+    BASE_URI + 'people/' + index_char + '/' + topic_name + '/index.html'
+  end
+
+  def build_organization_url(result)
+    # http://topics.nytimes.com/top/reference/timestopics/organizations/a/al_qaeda/index.html
+    topic_name = result.sub(filter('organization'), "").strip.gsub(/\s/, '_').downcase
+    index_char = result[0,1].downcase
+    BASE_URI + 'organizations/' + index_char + '/' + topic_name + '/index.html'
+  end
+
+
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'times_topics'
+
+class Test::Unit::TestCase
+end

data/test/test_times_tags.rb

@@ -0,0 +1,48 @@
+require 'helper'
+require File.join(File.dirname(__FILE__), '../lib/times_tags.rb')
+
+class TestTimesTags < Test::Unit::TestCase
+  context "API Key" do
+    should "find the api key specified in a config file" do
+      TimesTags.config_path = File.join(File.dirname(__FILE__), 'times_topics.yml')
+      assert_equal "000111222333444555666777888999abcdefg+", TimesTags.api_key
+    end
+  end
+
+  context "Searching" do
+    setup do
+      TimesTags.config_path = File.join(File.dirname(__FILE__), 'times_topics.yml')
+      TimesTags.stubs(:get)
+    end
+    should "person_search" do
+      TimesTags.expects(:get).with('/suggest', :query => { :query => 'Sebastien', :filter => '(Per)' })
+      TimesTags.person_search('Sebastien')
+    end
+    should "organization_search" do
+      TimesTags.expects(:get).with('/suggest', :query => { :query => 'Sebastien', :filter => '(Org)' })
+      TimesTags.organization_search('Sebastien')
+    end
+    should "geographic_search" do
+      TimesTags.expects(:get).with('/suggest', :query => { :query => 'Sebastien', :filter => '(Geo)' })
+      TimesTags.geographic_search('Sebastien')
+    end
+    should "subject_search" do
+      TimesTags.expects(:get).with('/suggest', :query => { :query => 'Sebastien', :filter => '(Des)' })
+      TimesTags.subject_search('Sebastien')
+    end
+    should "search" do
+      TimesTags.expects(:get).with('/suggest', :query => { :query => 'Sebastien', :filter => '(Des)' })
+      TimesTags.search('Sebastien', 'subject')
+
+      TimesTags.expects(:get).with('/suggest', :query => { :query => 'Sebastien', :filter => '(Geo)' })
+      TimesTags.search('Sebastien', 'geographic')
+
+      TimesTags.expects(:get).with('/suggest', :query => { :query => 'Sebastien', :filter => '(Org)' })
+      TimesTags.search('Sebastien', 'organization')
+
+      TimesTags.expects(:get).with('/suggest', :query => { :query => 'Sebastien', :filter => '(Per)' })
+      TimesTags.search('Sebastien', 'person')
+    end
+
+  end
+end

data/test/test_times_topics.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+class TestTimesTopics < Test::Unit::TestCase
+  context "TimesTopics" do
+    context "not found" do
+      setup do
+        TimesTags.stubs(:search).returns({ "results"=>[], "filter"=>"(Per)", "num_results"=>0, "query"=>"Not found"})
+        @topic = TimesTopics.new("Not found")
+      end
+      should "page_exists?" do
+        assert !@topic.page_exists?
+      end
+      should "url" do
+        assert_nil @topic.url
+      end
+      should "related_result_urls" do
+        assert @topic.related_result_urls.empty?
+      end
+    end
+
+    context "result found" do
+      setup do
+        TimesTags.stubs(:search).returns({"results"=>["bin Laden, Osama (Per)"], "filter"=>"(Per)", "num_results"=>1, "query"=>"Osama Bin Laden"})
+        @topic = TimesTopics.new("Osama Bin Laden")
+      end
+      should "page_exists?" do
+        assert @topic.page_exists?
+      end
+      should "url" do
+        assert_equal "http://topics.nytimes.com/top/reference/timestopics/people/b/osama_bin_laden/index.html", @topic.url
+      end
+      should "related_result_urls" do
+        assert @topic.related_result_urls.empty?
+      end
+    end
+  end
+end

data/test/times_topics.yml

@@ -0,0 +1 @@
+api_key: 000111222333444555666777888999abcdefg+

data/times_topics.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{times_topics}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jacqui Maher"]
+  s.date = %q{2010-06-03}
+  s.description = %q{Interact with the TimesTags API (http://developer.nytimes.com/docs/timestags_api) with this rubygem. Find people, organizations, locations, and subjects matching queries. Find Times Topics pages for query matches along with related topics, when applicable.}
+  s.email = %q{jacqui.maher@nytimes.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/times_tags.rb",
+     "lib/times_topics.rb",
+     "test/helper.rb",
+     "test/test_times_tags.rb",
+     "test/test_times_topics.rb",
+     "test/times_topics.yml",
+     "times_topics.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jacqui/times_topics}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A simple wrapper for the TimesTags API and Times Topics}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_times_tags.rb",
+     "test/test_times_topics.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: times_topics
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jacqui Maher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Interact with the TimesTags API (http://developer.nytimes.com/docs/timestags_api) with this rubygem. Find people, organizations, locations, and subjects matching queries. Find Times Topics pages for query matches along with related topics, when applicable.
+email: jacqui.maher@nytimes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/times_tags.rb
+- lib/times_topics.rb
+- test/helper.rb
+- test/test_times_tags.rb
+- test/test_times_topics.rb
+- test/times_topics.yml
+- times_topics.gemspec
+has_rdoc: true
+homepage: http://github.com/jacqui/times_topics
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple wrapper for the TimesTags API and Times Topics
+test_files: 
+- test/helper.rb
+- test/test_times_tags.rb
+- test/test_times_topics.rb