timespeople 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.sw?
+.DS_Store
+coverage

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2008 Jacob Harris
+
+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.
+
+THESE LICENSE TERMS APPLY TO THE GEM SOFTWARE ONLY AND DO NOT SUPPLEMENT
+OR ABROGATE THE TERMS OF SERVICE FOR THE TIMESPEOPLE API.

data/README

@@ -0,0 +1,8 @@
+timespeople===========
+
+A gem for interacting with the TimesPeople API. More documentation to come.
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Jacob Harris. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "timespeople"
+    s.summary = "A simple gem for the TimesPeople API"
+    s.email = "jharris@nytimes.com"
+    s.homepage = "http://github.com/harrisj/timespeople"
+    s.description = "A simple gem for the TimesPeople API"
+    s.authors = ["Jacob Harris"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'timespeople'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+  puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+end
+
+# begin
+#   require 'cucumber/rake/task'
+#   Cucumber::Rake::Task.new(:features)
+# rescue LoadError
+#   puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+# end
+
+task :default => :test

data/VERSION.yml

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

data/features/support/env.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'timespeople'
+
+require 'test/unit/assertions'
+
+require 'test/unit/assertions'
+
+World do |world|
+  
+  world.extend(Test::Unit::Assertions)
+  
+  world
+end

data/features/timespeople.feature

@@ -0,0 +1,9 @@
+Feature: something something
+  In order to something something
+  A user something something
+  something something something
+
+  Scenario: something something
+    Given inspiration
+    When I create a sweet new gem
+    Then everyone should see how awesome I am

data/lib/times_people.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), 'times_people', 'exceptions')
+require File.join(File.dirname(__FILE__), 'times_people', 'base')
+require File.join(File.dirname(__FILE__), 'times_people', 'user')

data/lib/times_people/base.rb

@@ -0,0 +1,98 @@
+require 'open-uri'
+require 'json'
+require 'htmlentities'
+
+module TimesPeople
+	class Base
+		API_SERVER = 'api.nytimes.com'
+		API_VERSION = 'v1'
+		API_NAME = 'timespeople'
+		
+		@@api_key = nil
+		@@debug = false
+
+		##
+		# 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)
+			@@api_key = key
+		end
+
+		def self.debug=(flag)
+			@@debug = flag
+		end
+
+		##
+		# Returns the current value of the API Key
+		def self.api_key
+			@@api_key
+		end
+
+		##
+		# Builds a request URI to call the API server
+		def self.build_request_url(path, params)
+			URI::HTTP.build :host => API_SERVER,
+			:path => "/svc/#{API_NAME}/api/#{API_VERSION}/#{path}.js",
+			:query => params.map {|k,v| "#{URI.escape(k)}=#{URI.escape(v)}"}.join('&')
+		end
+
+		def self.text_field(value)
+			return nil if value.nil?
+			coder = HTMLEntities.new
+			coder.decode(value)
+		end
+
+		def self.integer_field(value)
+			return nil if value.nil?
+			value.to_i
+		end
+
+		def self.date_field(value)
+			return nil unless value =~ /^\d{8}$/
+			Date.strptime(value, "%Y%m%d")
+		end
+
+		def self.invoke(path, params={})
+			begin
+				if @@api_key.nil?
+					raise AuthenticationError, "You must initialize the API key before you run any API queries"
+				end
+
+				full_params = params.merge 'api-key' => @@api_key
+				uri = build_request_url(path, full_params)	
+
+				puts "REQUEST: #{uri}" if @@debug
+
+				reply = uri.read
+				parsed_reply = JSON.parse reply
+
+				if parsed_reply.nil?
+					raise BadResponseError, "Empty reply returned from API"
+				end
+
+				#case parsed_reply['status']
+				# FIXME
+				#end
+
+				parsed_reply
+			rescue OpenURI::HTTPError => e
+				# FIXME: Return message from body?
+				case e.message
+				when /^400/
+					raise BadRequestError
+				when /^403/
+					raise AuthenticationError
+				when /^404/
+					return nil
+				when /^500/
+					raise ServerError
+				else
+					raise ConnectionError
+				end
+
+				raise "Error connecting to URL #{uri} #{e}"
+			rescue JSON::ParserError => e
+				raise BadResponseError, "Invalid JSON returned from API:\n#{reply}"
+			end
+		end
+	end
+end

data/lib/times_people/exceptions.rb

@@ -0,0 +1,41 @@
+module TimesPeople
+	##
+	# The generic Error class from which all other Errors are derived.
+	class Error < ::RuntimeError
+	end
+
+	##
+	# This error is thrown if there are problems authenticating your API key.
+	class AuthenticationError < Error
+	end
+
+	##
+	# This error is thrown if the request was not parsable by the API server.
+	class BadRequestError < Error
+	end
+
+	##
+	# This error is thrown if the response from the API server is not parsable.
+	class BadResponseError < Error
+	end
+
+	##
+	# This error is thrown if there is an error connecting to the API server.
+	class ServerError < Error
+	end
+
+	##
+	# This error is thrown if there is a timeout connecting to the server (to be implemented).
+	class TimeoutError < Error
+	end
+
+	##
+	# This error is thrown for general connection errors to the API server.
+	class ConnectionError < Error
+	end
+	
+	##
+	# This error is thrown if the User was not found
+	class UserNotFoundError < Error
+	end
+end

data/lib/times_people/user.rb

@@ -0,0 +1,47 @@
+require 'digest/md5'
+
+module TimesPeople
+	class User < Base
+		attr_reader :user_id, :display_name, :location, :picture_url, :following_count, :followers_count
+		
+		def initialize(hash)
+			@user_id = hash[:user_id]
+			@display_name = hash[:display_name]
+			@location = hash[:location]
+			@picture_url = hash[:picture_url]
+			@following_count = hash[:following_count]
+			@followers_count = hash[:followers_count]
+		end
+		
+		# http://api.nytimes.com/svc/timespeople/api/{version}/user/{hash}/id{.response-format}?api-key={your-API-key}
+		def self.find(email_addr)
+			digest = Digest::MD5.hexdigest(email_addr.downcase)
+			
+			begin
+				reply = invoke("user/#{digest}/id")
+				if reply.nil?
+					raise UserNotFoundError, "No user with that email address was found in TimesPeople"
+				end
+				
+			rescue ServerError
+				raise UserNotFoundError, "No user with that email address was found in TimesPeople"
+			end
+			
+			# http://api.nytimes.com/svc/timespeople/api/{version}/user/{user-id}/{data-type}{.response-format}?api-key={your-API-key}
+			unless reply['results'].nil? || reply['results']['user_id'].nil?
+				user_id = reply['results']['user_id']
+				reply = invoke("user/#{user_id}/profile")
+				init_from_api(reply['results'])
+			end
+		end
+		
+		def self.init_from_api(api_hash)
+			new :user_id => api_hash['user_id'],
+					:display_name => api_hash['user_displayname'],
+					:location => api_hash['location'],
+					:picture_url => api_hash['user_pic_url'],
+					:following_count => api_hash['following_count'],
+					:followers_count => api_hash['followers_count']
+		end
+	end
+end

data/lib/timespeople.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'times_people')

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/timespeople.rb'}"
+puts "Loading timespeople gem"
+exec "#{irb} #{libs} --simple-prompt"

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+gem 'chrisk-fakeweb'
+require 'fake_web'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'timespeople'
+
+class Test::Unit::TestCase
+	API_KEY = '13e234323232222'
+
+	def init_test_key
+		TimesPeople::Base.api_key = API_KEY
+	end
+end
+
+module TestTimesPeople
+end

data/test/times_people/test_base.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class TestTimesPeople::TestBase < Test::Unit::TestCase
+	include TimesPeople
+	
+	context "Base.build_request_url" do
+	end
+	
+	context "Base.invoke" do
+		setup do
+			init_test_key
+		end
+		
+		context "when the API key has not been set" do
+			setup do
+				Base.api_key = nil
+			end
+			
+			should_eventually "raise an AuthenticationError" do
+				assert_raise(AuthenticationError) do
+					Base.invoke
+				end
+			end			
+		end
+		
+		context "when the Articles API returns a 403 forbidden error (API key issue)" do
+			setup do
+				FakeWeb.register_uri(api_url_for, :status => ["403", "Forbidden"])
+			end
+			
+			should_eventually "raise an AuthenticationError" do
+				assert_raise(AuthenticationError) do
+					Base.invoke
+				end
+			end
+		end
+		
+		context "when the Articles API returns a 400 bad request error" do
+			setup do
+				FakeWeb.register_uri(api_url_for, :status => ["400", "Bad Request"])
+			end
+			
+			should_eventually "raise an BadRequestError" do
+				assert_raise(BadRequestError) do
+					Base.invoke
+				end
+			end
+		end
+		
+		context "When calling the Articles API returns a 500 server error" do
+			setup do
+				FakeWeb.register_uri(api_url_for, :status => ["500", "Server Error"])
+			end
+			
+			should_eventually "raise an ServerError" do
+				assert_raise(ServerError) do
+					Base.invoke
+				end
+			end
+		end
+		
+		context "when the Articles API returns any other HTTP error" do
+			setup do
+				FakeWeb.register_uri(api_url_for, :status => ["502", "Random Error"])
+			end
+			
+			should_eventually "raise an ConnectionError" do
+				assert_raise(ConnectionError) do
+					Base.invoke
+				end
+			end
+		end
+		
+		context "When the Articles API returns JSON that can't be parsed" do
+			setup do
+				FakeWeb.register_uri(api_url_for, :text => "e2131421212121221 => 3i109sdfvinp;2 112")
+			end
+			
+			should_eventually "raise an BadResponseError" do
+				assert_raise(BadResponseError) do
+					Base.invoke
+				end
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: timespeople
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jacob Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-25 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A simple gem for the TimesPeople API
+email: jharris@nytimes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION.yml
+- features/steps/timespeople_steps.rb
+- features/support/env.rb
+- features/timespeople.feature
+- lib/times_people.rb
+- lib/times_people/base.rb
+- lib/times_people/exceptions.rb
+- lib/times_people/user.rb
+- lib/timespeople.rb
+- script/console
+- test/test_helper.rb
+- test/times_people/test_base.rb
+has_rdoc: true
+homepage: http://github.com/harrisj/timespeople
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: A simple gem for the TimesPeople API
+test_files: 
+- test/test_helper.rb
+- test/times_people/test_base.rb