ruby-hackernews 1.0.0

data/README.rdoc

@@ -0,0 +1,114 @@
+
+= ruby-hackernews
+
+An API over Hacker News
+
+== Requirements
+
+    mechanize (>= 1.0.0)
+    require_all (>= 1.1.0)
+
+== Installation
+
+    gem install ruby-hackernews
+
+then, in your script:
+
+    require 'ruby-hackernews'
+
+before using it.
+
+== Entries
+
+You can get entries on the main page with:
+
+    Entry.all # returns an array of entries
+
+You can provide a number of pages:
+
+    Entry.all(3) # will return the entries on the first 3 pages
+
+There are methods for getting specific entry types:
+
+    Entry.questions # gets the first page of questions (ask NH)
+    Entry.newest    # get the first page of new links (new)
+    Entry.jobs      # get the forst page of job offest (jobs)
+
+Each Entry instance has the following data:
+
+    entry = Entry.all.first #get the top entry on the mainpage
+
+    entry.number       # entry's position on HN
+
+    entry.link.title   # the link's name on HN
+    entry.link.href    # the actual link
+    entry.link.site    # the referring's site, if any
+
+    entry.voting.score # the entry's score on HN
+
+    entry.user.name    # submitter's user name
+
+    entry.time         # elapsed time from submission
+
+After you've logged in (see below) you can do the following
+
+    entry.upvote                     #votes the entry
+    entry.write_comment("mycomment") #adds a comment to the entry
+    Entry.submit("mytitle", "myurl") #submit a new link
+    Entry.submit("myquestion")       #submit a new question (ask HN)
+
+== Comments
+
+You get an entry's comments with:
+
+    entry.comments
+
+You can also get the newest comments on HN with:
+
+    Comments.newest
+    Comments.newest(3)  # get the first 3 pages of new comments
+
+Each Comment instance has the following data:
+
+    comment = Entry.all.first.comments.first # gets the first comment of the first entry on HN's main page
+
+    comment.text           # comment's body
+    comment.user.name      # poster's user name on HN
+    comment.voting.score   # comment's score
+
+Comments are enumerable and threaded, so you can do like:
+
+    comment[2][0]          # gets the third reply to this comment, then the first reply to the reply
+    comment.first          # get the first reply to this comment
+    comment.select do |c|  # gets all the comment replies which text contains "test"
+      text ~= /test/
+    end
+    comment.parent         # gets the comment's parent (nil if no parent)
+
+Once you're logged in (see below), you can do the following:
+
+    comment.upvote
+    comment.downvote
+    comment.reply("mycomment")
+
+== Logging in
+
+You define a user with:
+
+    user = User.new("username")
+
+Then, you log in with:
+
+    user.login("password")
+
+You can log out with:
+
+    user.logout
+
+You have to log out before logging in with a different user.
+
+== TO DO
+
+    Get user info (submission, comments...)
+    Create account
+    Change user info/settings

data/Rakefile

@@ -0,0 +1,34 @@
+
+require 'rubygems'
+require 'spec/rake/spectask'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'ruby-hackernews'
+  s.version = '1.0.0'
+  s.add_dependency('require_all', '>= 1.1.0')
+  s.add_dependency('mechanize', '>= 1.0.0')
+  s.has_rdoc = false
+  s.homepage = "http://github.com/bolthar/ruby-hackernews"
+  s.summary = 'An interface to Hacker News'
+  s.description = s.summary
+  s.author = 'Andrea Dallera'
+  s.email = 'andrea@andreadallera.com'
+  s.files = %w(README.rdoc Rakefile) + Dir.glob("{lib}/**/*")
+  s.require_path = "lib"  
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = true
+  t.spec_files = FileList['spec/**/*.rb']
+end

data/lib/HNAPI/domain/comment/comment.rb

@@ -0,0 +1,55 @@
+
+class Comment
+  include Enumerable
+
+  attr_reader :text
+  attr_reader :voting
+  attr_reader :user
+
+  attr_accessor :parent
+  attr_reader :children
+
+  def initialize(text, voting, user_info, reply_link)
+    @text = text
+    @voting = voting
+    @user = user_info
+    @reply_link = reply_link
+    @children = []
+  end
+
+  def <<(comment)
+    comment.parent = self
+    @children << comment
+  end
+
+  def each(&block)
+    @children.each(&block)
+  end
+
+  def <=>(other_comment)
+    return other_comment.voting.score <=> @voting.score
+  end
+
+  def method_missing(method, *args, &block)
+    @children.send(method, *args, &block)
+  end
+
+  def self.newest(pages = 1)
+    return CommentService.new.get_new_comments(pages)
+  end
+
+  def reply(text)
+    return false unless @reply_link
+    CommentService.new.write_comment(@reply_link, text)
+    return true
+  end
+
+  def upvote
+    VotingService.new.vote(@voting.upvote)
+  end
+
+  def downvote
+    VotingService.new.vote(@voting.downvote)
+  end
+
+end

data/lib/HNAPI/domain/entry/comments_info.rb

@@ -0,0 +1,12 @@
+
+class CommentsInfo
+
+  attr_accessor :count
+  attr_reader :page
+
+  def initialize(count, page)
+    @count = count
+    @page  = page
+  end
+
+end

data/lib/HNAPI/domain/entry/entry.rb

@@ -0,0 +1,57 @@
+
+class Entry
+
+  attr_reader :number
+  attr_reader :link
+  attr_reader :voting
+  attr_reader :user
+
+  def initialize(number, link, voting, user, comments, time)
+    @number   = number
+    @link     = link
+    @voting   = voting
+    @user     = user    
+    @time     = time
+    @comments_info = comments
+  end
+
+  def comments
+    unless @comments
+      @comments = CommentService.new.get_comments(@comments_info.page)
+    end
+    return @comments
+  end
+
+  def self.all(pages = 1)
+    return EntryService.new.get_entries(pages)
+  end
+
+  def self.newest(pages = 1)
+    return EntryService.new.get_new_entries(pages)
+  end
+
+  def self.questions(pages = 1)
+    return EntryService.new.get_questions(pages)
+  end
+
+  def self.jobs(pages = 1)
+    return EntryService.new.get_jobs(pages)
+  end
+
+  def time
+    return @time.time
+  end
+
+  def write_comment(text)
+    return CommentService.new.write_comment(@comments_info.page, text)
+  end
+
+  def self.submit(*args)
+    return EntryService.new.submit(*args)
+  end
+
+  def upvote
+    return VotingService.new.vote(@voting.upvote)
+  end
+
+end

data/lib/HNAPI/domain/entry/link_info.rb

@@ -0,0 +1,14 @@
+
+class LinkInfo
+
+  attr_reader :title
+  attr_reader :href
+  attr_reader :site
+
+  def initialize(title, href, site)
+    @title = title
+    @href  = href
+    @site  = site
+  end
+
+end

data/lib/HNAPI/domain/entry/time_info.rb

@@ -0,0 +1,20 @@
+
+class TimeInfo
+
+  SECOND = 1
+  MINUTE = 60 * SECOND
+  HOUR   = 60 * MINUTE
+  DAY    = 24 * HOUR
+
+  def time
+    return Time.at(@unit_of_measure * @value)
+  end
+
+  def initialize(value, unit_of_measure)
+    descriptor = unit_of_measure[unit_of_measure.length - 1].chr == "s" ? unit_of_measure[0..unit_of_measure.length - 2] : unit_of_measure
+    @value           = value
+    @unit_of_measure = self.class.const_get(descriptor.upcase)
+  end
+
+
+end

data/lib/HNAPI/domain/entry/user_info.rb

@@ -0,0 +1,12 @@
+
+class UserInfo
+
+  attr_reader :name
+  attr_reader :page
+
+  def initialize(name, page)
+    @name = name
+    @page = page
+  end
+
+end

data/lib/HNAPI/domain/entry/voting_info.rb

@@ -0,0 +1,14 @@
+
+class VotingInfo
+
+  attr_reader :score
+  attr_reader :upvote
+  attr_reader :downvote
+
+  def initialize(score, upvote, downvote)
+    @score    =  score
+    @upvote   = upvote
+    @downvote = downvote
+  end
+
+end

data/lib/HNAPI/domain/user.rb

@@ -0,0 +1,18 @@
+
+class User
+
+  attr_reader :name
+
+  def initialize(name)
+    @name = name
+  end
+
+  def login(password)
+    return LoginService.new.login(@name, password)
+  end
+
+  def logout
+    return LoginService.new.logout
+  end
+  
+end

data/lib/HNAPI/services/comment_service.rb

@@ -0,0 +1,62 @@
+
+class CommentService
+  include MechanizeContext
+
+  def get_comments(page_url)
+    comments = []
+    last   = comments
+    current_level = -1
+    page = agent.get(page_url)
+    page.search("//table")[3].search("table/tr").select do |tr|
+      tr.search("span.comment").inner_html != "[deleted]"
+    end.each do |tr|
+      comment = parse_comment(tr)
+      level = tr.search("img[@src='http://ycombinator.com/images/s.gif']").first['width'].to_i / 40
+      difference = current_level - level
+      target = last
+      (difference + 1).times do
+        target = target.parent || comments
+      end
+      target << comment
+      last = comment
+      current_level = level
+    end
+    return comments
+  end
+
+  def get_new_comments(pages = 1)
+    parser = EntryPageParser.new(agent.get(ConfigurationService.comments_url))
+    comments = []
+    pages.times do
+      lines = parser.get_lines
+      lines.each do |line|
+        comments << parse_comment(line)
+      end
+      next_url = parser.get_next_url || break
+      parser = EntryPageParser.new(agent.get(next_url))
+    end
+    return comments
+  end
+
+  def parse_comment(element)
+    text = ""
+    element.search("span.comment").first.children.each do |ch|
+      text = ch.inner_html.gsub(/<.{1,2}>/,"")
+    end
+    header = element.search("span.comhead").first
+    voting = VotingInfoParser.new(element.search("td/center/a"), header).parse
+    user_info = UserInfoParser.new(header).parse
+    reply_link = element.search("td[@class='default']/p//u//a").first
+    reply_url = reply_link['href'] if reply_link       
+    return Comment.new(text, voting, user_info, reply_url)
+  end
+
+  def write_comment(page_url, comment)
+    require_authentication
+    form = agent.get(page_url).forms.first
+    form.text = comment
+    form.submit
+    return true
+  end
+  
+end

data/lib/HNAPI/services/configuration_service.rb

@@ -0,0 +1,28 @@
+
+class ConfigurationService
+
+  def self.base_url
+    return "http://news.ycombinator.com/"
+  end
+
+  def self.new_url
+    return File.join(self.base_url, "newest")
+  end
+
+  def self.ask_url
+    return File.join(self.base_url, "ask")
+  end
+
+  def self.jobs_url
+    return File.join(self.base_url, "jobs")
+  end
+
+  def self.comments_url
+    return File.join(self.base_url, "newcomments")
+  end
+
+  def self.submit_url
+    return File.join(self.base_url, "submit")
+  end
+
+end

data/lib/HNAPI/services/entry_service.rb

@@ -0,0 +1,52 @@
+
+class EntryService
+  include MechanizeContext
+
+  def get_entries(pages = 1, url = ConfigurationService.base_url)
+    parser = EntryPageParser.new(agent.get(url))
+    entry_infos = []
+    pages.times do
+      lines = parser.get_lines
+      (lines.length / 2).times do
+        entry_infos << EntryParser.new(lines.shift, lines.shift).parse
+      end
+      next_url = parser.get_next_url || break
+      parser = EntryPageParser.new(agent.get(next_url))
+    end
+    return entry_infos
+  end
+
+  def get_new_entries(pages = 1)
+    return get_entries(pages, ConfigurationService.new_url)
+  end
+
+  def get_questions(pages = 1)
+    return get_entries(pages, ConfigurationService.ask_url)
+  end
+
+  def get_jobs(pages = 1)
+    return get_entries(pages, ConfigurationService.jobs_url)
+  end
+
+  def submit(*args)
+    require_authentication
+    form = agent.get(ConfigurationService.submit_url).forms.first
+    submit_link(form, args[0], args[1]) if args.length == 2
+    submit_question(form, args[0]) if args.length == 1
+    return true
+  end
+
+  private
+  def submit_link(form, title, url)
+    form.t = title
+    form.u = url
+    form.submit
+  end
+
+  def submit_question(form, text)
+    form.x = text
+    form.submit
+  end
+
+  
+end

data/lib/HNAPI/services/login_service.rb

@@ -0,0 +1,26 @@
+
+class LoginService
+  include MechanizeContext
+
+  def login(username, password)
+    raise "You are logged in already - logout first." if authenticated?
+    page = agent.get(ConfigurationService.base_url)
+    login_url = page.search(".pagetop/a").last['href'].sub("/","")
+    login_page = agent.get(ConfigurationService.base_url + login_url)
+    form = login_page.forms.first
+    form.u = username
+    form.p = password
+    page = form.submit
+    return page.title != nil
+  end
+
+  def logout
+    require_authentication
+    page = agent.get(ConfigurationService.base_url)
+    login_url = page.search(".pagetop/a").last['href'].sub("/","")
+    logout_page = agent.get(ConfigurationService.base_url + login_url)
+    agent.cookie_jar.jar.clear
+    return logout_page.search(".pagetop/a").last.inner_html == "login"
+  end
+
+end

data/lib/HNAPI/services/mechanize_context.rb

@@ -0,0 +1,28 @@
+
+module MechanizeContext
+
+  @@contexts = {}
+
+  def self.agent=(key)
+    @@default = key
+  end
+
+  def agent
+    @@default ||= :default
+    @@contexts[@@default] = Mechanize.new unless @@contexts[@@default]
+    return @@contexts[@@default]
+  end
+
+  def [](key)
+    return @@contexts[key]
+  end
+
+  def require_authentication
+    raise NotAuthenticatedError unless authenticated?
+  end
+
+  def authenticated?(key = :default)
+    return @@contexts[key].cookie_jar.jar.any?
+  end
+
+end

data/lib/HNAPI/services/not_authenticated_error.rb

@@ -0,0 +1,8 @@
+
+class NotAuthenticatedError < StandardError
+
+  def message
+    return "You need to authenticate before making this operation"
+  end
+  
+end

data/lib/HNAPI/services/parsers/comments_info_parser.rb

@@ -0,0 +1,16 @@
+class CommentsInfoParser
+
+  def initialize(comments_element)
+    @element = comments_element.search("a")[1]
+  end
+
+  def parse
+    comments_info = nil
+    if @element
+      comments      = @element.inner_html.split[0].to_i
+      comments_page = @element['href']
+      comments_info = CommentsInfo.new(comments, comments_page)
+    end
+    return comments_info
+  end
+end

data/lib/HNAPI/services/parsers/entry_page_parser.rb

@@ -0,0 +1,24 @@
+
+class EntryPageParser
+
+  def initialize(page)
+    @page = page
+  end
+
+  def get_lines
+    lines = @page.search("//table")[2].search("tr").select do |tr|
+      tr['style'] !~ /height/ &&
+      tr.children.first.attributes.count != 0
+    end
+    more_link = lines.last.search("a").first
+    lines.pop if more_link && more_link.inner_html == "More"
+    return lines
+  end
+
+  def get_next_url
+    more_link = @page.search("//table")[2].search("tr/td/a").select { |node| node.inner_html == "More"}.first
+    return more_link['href'] if more_link
+    return nil
+  end
+
+end

data/lib/HNAPI/services/parsers/entry_parser.rb

@@ -0,0 +1,19 @@
+
+class EntryParser
+
+  def initialize(first_line, second_line)
+    @first_line  = first_line
+    @second_line = second_line
+  end
+
+  def parse
+    number   = @first_line.search("[@class='title']")[0].inner_html.sub(".","").to_i
+    link     = LinkInfoParser.new(@first_line.search("[@class='title']")[1]).parse
+    voting   = VotingInfoParser.new(@first_line.search("td/center/a"), @second_line.search("[@class='subtext']")[0]).parse
+    user     = UserInfoParser.new(@second_line.search("[@class='subtext']")[0]).parse
+    comments = CommentsInfoParser.new(@second_line.search("[@class='subtext']")[0]).parse
+    time     = TimeInfoParser.new(@second_line.search("[@class='subtext']").children[3]).parse
+    return Entry.new(number, link, voting, user, comments, time)
+  end
+  
+end

data/lib/HNAPI/services/parsers/link_info_parser.rb

@@ -0,0 +1,17 @@
+
+class LinkInfoParser
+
+  def initialize(link_element)
+    @element = link_element
+  end
+
+  def parse
+    link   = @element.search("a")[0]['href']
+    title  = @element.search("a")[0].inner_html
+    site_element = @element.search("span")
+    site = site_element.inner_html.sub("(","").sub(")","").strip if site_element.any?
+    return LinkInfo.new(title, link, site)
+  end
+  
+
+end

data/lib/HNAPI/services/parsers/time_info_parser.rb

@@ -0,0 +1,15 @@
+
+class TimeInfoParser
+
+  def initialize(time_element)
+    @element = time_element
+  end
+
+  def parse
+    value           = @element.text.strip.split[0].to_i
+    unit_of_measure = @element.text.strip.split[1]
+    return TimeInfo.new(value, unit_of_measure)
+  end
+end
+
+

data/lib/HNAPI/services/parsers/user_info_parser.rb

@@ -0,0 +1,13 @@
+
+class UserInfoParser
+
+  def initialize(user_element)
+    @element = user_element
+  end
+
+  def parse
+    user_name = @element.search("a")[0].inner_html
+    user_page = @element.search("a")[0]['href']
+    return UserInfo.new(user_name, user_page)
+  end
+end

data/lib/HNAPI/services/parsers/voting_info_parser.rb

@@ -0,0 +1,15 @@
+
+class VotingInfoParser
+
+  def initialize(voting_element, score_element)
+    @voting_element   = voting_element
+    @score_element    = score_element
+  end
+
+  def parse
+    upvote   = @voting_element[0]['href'] if @voting_element[0]
+    downvote = @voting_element[1]['href'] if @voting_element[1]
+    score    = @score_element.search("span")[0].inner_html.split[0].to_i
+    return VotingInfo.new(score, upvote, downvote)
+  end
+end

data/lib/HNAPI/services/voting_service.rb

@@ -0,0 +1,11 @@
+
+class VotingService
+  include MechanizeContext
+
+  def vote(url)
+    require_authentication
+    agent.get(url)
+    return true
+  end
+
+end

data/lib/ruby-hackernews.rb

@@ -0,0 +1,8 @@
+
+require 'rubygems'
+require 'mechanize'
+
+require 'require_all'
+
+require_all File.join(File.dirname(__FILE__), 'HNAPI', 'domain')
+require_all File.join(File.dirname(__FILE__), 'HNAPI', 'services')

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-hackernews
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrea Dallera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+description: An interface to Hacker News
+email: andrea@andreadallera.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- Rakefile
+- lib/HNAPI/domain/comment/comment.rb
+- lib/HNAPI/domain/user.rb
+- lib/HNAPI/domain/entry/link_info.rb
+- lib/HNAPI/domain/entry/voting_info.rb
+- lib/HNAPI/domain/entry/time_info.rb
+- lib/HNAPI/domain/entry/user_info.rb
+- lib/HNAPI/domain/entry/entry.rb
+- lib/HNAPI/domain/entry/comments_info.rb
+- lib/HNAPI/services/parsers/link_info_parser.rb
+- lib/HNAPI/services/parsers/entry_parser.rb
+- lib/HNAPI/services/parsers/voting_info_parser.rb
+- lib/HNAPI/services/parsers/user_info_parser.rb
+- lib/HNAPI/services/parsers/time_info_parser.rb
+- lib/HNAPI/services/parsers/entry_page_parser.rb
+- lib/HNAPI/services/parsers/comments_info_parser.rb
+- lib/HNAPI/services/voting_service.rb
+- lib/HNAPI/services/mechanize_context.rb
+- lib/HNAPI/services/comment_service.rb
+- lib/HNAPI/services/login_service.rb
+- lib/HNAPI/services/entry_service.rb
+- lib/HNAPI/services/not_authenticated_error.rb
+- lib/HNAPI/services/configuration_service.rb
+- lib/ruby-hackernews.rb
+has_rdoc: true
+homepage: http://github.com/bolthar/ruby-hackernews
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An interface to Hacker News
+test_files: []
+