hackernews 0.1.0

data/README.rdoc

@@ -0,0 +1,69 @@
+= HackerNews
+
+by Tim Morgan (http://timmorgan.org)
+
+== About
+
+This is a fairly simple Ruby class for accessing certain parts of Hacker News (http://news.ycombinator.com). I may add functionality with time.
+
+== Features
+
+* Handles Hacker News session cookie and login.
+* Can retreive user page, along with karma and average karma values.
+
+== To Do
+
+* Add ability to vote.
+* Add ability to post news.
+* Add ability to post comments.
+
+== Source Code
+
+    http://github.com/seven1m/hackernews
+
+== Installation
+
+    gem install hackernews
+    
+== Usage
+
+    require 'hackernews'
+    
+    hn = HackerNews.new(USERNAME, PASSWORD)
+    hn.karma # => '62'
+    hn.average_karma # => '1.87'
+    
+== Feedback
+
+I’d love to hear from you if you have suggestions for improvement, bug fixes, or whatever. Email me at tim@timmorgan.org or fork the project and send a pull request.
+
+To run the tests:
+
+    HN_USERNAME=yourusername \
+    HN_PASSWORD=yourpassword \
+    ruby test/hackernews_test.rb
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2010 Tim Morgan
+
+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/lib/hackernews.rb

@@ -0,0 +1,61 @@
+require 'uri'
+require 'net/http'
+require 'open-uri'
+
+class HackerNews
+
+  VERSION = '0.1.0'
+
+  # Returns the version string for the library.
+  def self.version
+    VERSION
+  end
+
+  BASE_URL = 'http://news.ycombinator.com'
+  USER_URL = 'http://news.ycombinator.com/user?id=%s'
+  
+  # Creates a new HackerNews object.
+  # Specify your username and password.
+  def initialize(username, password)
+    login_url = open(BASE_URL).read.match(/href="([^"]+)">login<\/a>/)[1]
+    form_html = open(BASE_URL + login_url).read
+    submit_url = URI.parse(BASE_URL)
+    response = Net::HTTP.new(submit_url.host, submit_url.port).start do |http|
+      req = Net::HTTP::Post.new('/y')
+      req.set_form_data(
+        'fnid' => form_html.match(/<input type=hidden name="fnid" value="([^"]+)"/)[1],
+        'u'    => username,
+        'p'    => password
+      )
+      http.request(req)
+    end
+    @cookie = response.header['set-cookie']
+    @username = username
+    @password = password
+  end
+  
+  # Retrieves the karma for the logged in user, or for the specified username (if given).
+  def karma(username=nil)
+    user_page(username).match(/<td valign=top>karma\:<\/td><td>(\d+)<\/td>/)[1]
+  end
+  
+  # Retrieves the average karma per post for the logged in user.
+  def average_karma
+    user_page.match(/<td valign=top>avg:<\/td><td>([\d\.]+)<\/td>/)[1]
+  end
+  
+  # Retrieves the user page html for the specified username (or the current logged in user if none is specified).
+  def user_page(username=nil)
+    username ||= @username
+    @user_pages ||= {}
+    @user_pages[username] ||= begin
+      url = URI.parse(USER_URL % username)
+      response = Net::HTTP.start(url.host, url.port) do |http|
+        header = {'Cookie' => @cookie}
+        http.get(url.path + '?' + url.query, header)
+      end
+      response.body
+    end
+  end
+
+end

data/test/hackernews_test.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/hackernews.rb'
+
+class HackerNewsTest < Test::Unit::TestCase
+
+  def setup
+    if ENV['HN_USERNAME'] and ENV['HN_PASSWORD']
+      @hn = HackerNews.new(ENV['HN_USERNAME'], ENV['HN_PASSWORD'])
+    else
+      puts 'Must set HN_USERNAME and HN_PASSWORD env variables before running.'
+      exit(1)
+    end
+  end
+
+  def test_login
+    assert @hn.instance_eval('@cookie') =~ /user=[a-z0-9]+;/i
+  end
+  
+  def test_karma
+    assert @hn.karma.to_s != ''
+    assert @hn.karma('pg').to_i > 59000
+  end
+  
+  def test_average_karma
+    assert @hn.average_karma.to_s != ''
+  end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: hackernews
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-03 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tim@timmorgan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- lib/hackernews.rb
+- test/hackernews_test.rb
+has_rdoc: true
+homepage: http://rdoc.info/projects/seven1m/hackernews
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.5
+signing_key: 
+specification_version: 3
+summary: Ruby gem to login and interact with the Hacker News website.
+test_files: []
+