hn2json 0.0.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Joseph Adams
+
+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/Rakefile

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/lib/hn2json/version'
+
+def command?(command)
+  system("type #{command} > /dev/null 2>&1")
+end
+
+#
+# Gems
+#
+
+desc "Build gem."
+task :gem do
+  sh "gem build hn2json.gemspec"
+end
+
+task :push => [:gem] do
+  file = Dir["*-#{HN2JSON::VERSION}.gem"].first
+  sh "gem push #{file}"
+end
+
+desc "Install gem."
+task :install => [:gem] do
+  sh "gem install hn2json-#{HN2JSON::VERSION}.gem"
+end
+
+desc "Build the gem, install it and open irb."
+task :irb => [:install] do
+  sh "irb -r hn2json"
+end
+
+desc "tag version"
+task :tag do
+  sh "git tag v#{HN2JSON::VERSION}"
+  sh "git push origin master --tags"
+  sh "git clean -fd"
+end
+
+desc "tag version and push gem to server"
+task :release => [:push, :tag] do 
+  puts "And away it goes!"
+end

data/lib/hn2json/entity.rb

@@ -0,0 +1,97 @@
+module HN2JSON
+  # Internal: Represents a post, poll, discussion or comment on HackerNews.
+  class Entity
+
+    # Public: Returns the IDs of all top-level comments.
+    attr_reader :comments
+
+    # Public: Returns the String date when the Entity was posted to HackerNews.
+    attr_reader :date_posted
+
+    # Public: Return the String text of the Entity, if available.
+    attr_reader :fulltext
+
+    # Public: Returns the Integer ID of the Entity
+    attr_reader :id
+
+    # Public: Returns the Integer ID of the parent, if available
+    attr_reader :parent
+
+    # Public: Returns the String username of the user who posted the Entity
+    attr_reader :posted_by
+
+    # Public: Returns the String title of the Entity, if available
+    attr_reader :title
+
+    # Public: Returns the Symbol type of the Entity (:post, :poll, :discussion, :comment)
+    attr_reader :type
+
+    # Public: Returns the String url of an Entity, if available
+    attr_reader :url
+
+    # Public: Returns the Interger number of upvotes the Entity has recieved
+    attr_reader :votes
+
+    # Public: Returns a 2D Array of ["Thing you're voting on", number of upvotes]
+    attr_reader :voting_on
+
+
+    def initialize id
+      @id = id
+
+      @type = nil
+      @parent = nil
+      @url = nil
+      @title = nil
+      @fulltext = nil
+      @posted_by = nil
+      @date_posted = nil
+      @voting_on = nil
+      @comments = nil
+      @votes = nil
+
+      get_page
+      determine_type
+
+      get_attrs
+    end
+
+    def get_page
+      @html = Request.new(id)
+      @parser = Parser.new @html
+    end
+
+    def determine_type
+      @type = @parser.determine_type
+    end
+
+    def get_attrs
+      case @type
+        when :post
+          @parser.get_attrs_post self
+        when :comment
+          @parser.get_attrs_comment self
+        when :poll
+          @parser.get_attrs_poll self
+        when :discussion
+          @parser.get_attrs_discussion self
+        when :error
+        end
+    end
+    
+    # Internal: Yields self for adding attr
+    #
+    # Examples
+    #
+    #   entity.add_attrs do |entity|
+    #     entity.title = "Hello World!"
+    #   end
+    #
+    # Returns nothing.
+    def add_attrs
+      yield self
+    end
+
+  end
+
+end

data/lib/hn2json/exceptions.rb

@@ -0,0 +1,8 @@
+module HN2JSON
+	class InvalidIdError < StandardError
+	end
+	class RequestError < StandardError
+	end
+	class ParseError < StandardError
+	end
+end

data/lib/hn2json/parser.rb

@@ -0,0 +1,246 @@
+module HN2JSON
+
+  # Public: Parse HTML to produce HackerNews entities
+
+  class Parser
+
+    attr_reader :doc
+
+    def initialize response
+
+      html = response.html
+      html.force_encoding "UTF-8"
+      begin
+        @doc = Nokogiri::HTML::DocumentFragment.parse html
+      rescue
+        raise ParseError, "there was an error parsing the page"
+      end
+    end
+
+
+    def determine_type
+      title = @doc.css('.title a')
+
+
+      if title.length < 1 || title[0].content == "More"
+        if @doc.css('td').length > 7
+          return :comment
+        else
+          return :error
+        end
+      else
+        td = @doc.css('td')[12]
+
+        if td.css('table').length > 0
+          return :poll
+        elsif td.css('form').length == 1
+          return :discussion
+        else
+          return :post
+        end
+      end
+
+    end
+
+    def get_attrs_comment entity
+
+      parent_url = @doc.css('.comhead a')[2]['href']
+      parent_regex = /id\=(.*)/
+      parent = parent_regex.match(parent_url)[1]
+      
+      fulltext_nolinks = @doc.css('.comment')[0].to_s
+      fulltext_nolinks = fulltext_nolinks.gsub(/\<a\shref\=['"](.*)['"].*rel\=.*\>.*\<\/a\>/, '\1')
+      fulltext = fulltext_nolinks.gsub(/<\/?[^>]*>/, '')
+
+      comhead = @doc.css('.comhead')[0]
+      
+      date_posted = get_date comhead
+
+      posted_by = get_posted_by comhead
+
+      comments = get_comments
+
+      entity.add_attrs do |e|
+        e.parent = parent
+        e.fulltext = fulltext
+        e.date_posted = date_posted
+        e.comments = comments
+        e.posted_by = posted_by
+      end
+    end
+
+
+    def get_attrs_post entity
+
+      subtext = @doc.css('.subtext')[0]
+
+      date_posted = get_date subtext
+
+      posted_by = get_posted_by subtext
+
+      votes = get_num_votes subtext
+
+      comments = get_comments
+
+      head = @doc.css('.title a')[0]
+
+      title = head.content
+
+      url = head['href']
+
+      entity.add_attrs do |e|
+        e.url = url
+        e.title = title
+        e.date_posted = date_posted
+        e.comments = comments
+        e.votes = votes
+        e.posted_by = posted_by
+      end
+    end
+
+    def get_attrs_poll entity
+
+      title = @doc.css('.title a')[0].content
+
+      td = @doc.css('td')[10]
+
+      subtext = @doc.css('.subtext')[0]
+
+      date_posted = get_date subtext
+
+      posted_by = get_posted_by subtext
+
+      votes = get_num_votes subtext
+
+      comments = get_comments
+
+
+      fulltext_elem = @doc.css('tr[style="height:2px"] + tr > td')
+
+      if fulltext_elem.length == 2
+        fulltext = fulltext_elem[1].content
+      else
+        fulltext = ''
+      end
+
+      voting_on = get_voting_on
+
+      entity.add_attrs do |e|
+        e.title = title
+        e.fulltext = fulltext
+        e.date_posted = date_posted
+        e.posted_by = posted_by
+        e.votes = votes
+        e.comments = comments
+        e.voting_on = voting_on
+      end
+    end
+
+    def get_attrs_discussion entity
+
+      title = @doc.css('.title a')[0].content
+
+      fulltext = @doc.css('td')[10].content
+
+      subtext = @doc.css('.subtext')[0]
+
+      date_posted = get_date subtext      
+
+      posted_by = get_posted_by subtext
+
+      votes = get_num_votes subtext
+
+      comments = get_comments
+
+      entity.add_attrs do |e|
+        e.title = title
+        e.fulltext = fulltext
+        e.date_posted = date_posted
+        e.posted_by = posted_by
+        e.comments = comments
+        e.votes = votes
+      end
+    end
+
+
+    def get_voting_on 
+      voting_on = []
+      trs = @doc.css('tr > td + td > table tr')
+
+      trs.each_with_index do |tr, index|
+        if index % 3 == 0
+          voting_on.push []
+          voting_on[(index / 3).floor].push tr.content
+        elsif index % 3 == 1
+          voting_on[(index / 3).floor].push tr.content.gsub(/\spoints/, '')
+        end
+      end
+
+      return voting_on
+
+    end
+
+    def get_comments
+      comments = []
+
+      full_comments = @doc.css('td > img[width="0"]').xpath("..").xpath("..").css('.default')
+
+      full_comments.each do |comment|
+        comment_id = comment.css('span a')[1]['href'].gsub("item?id=", '')
+        comments.push comment_id
+      end
+
+      # TODO: Follow the [More] link
+      #
+      # $tr = $('tr')
+      # $($tr[$tr.length - 3]).find('a').eq(0).attr('href')
+
+      comments = get_comments_more doc, comments
+
+      return comments
+    end
+
+    def get_comments_more doc, comments
+      trs = doc.css('tr .title a')
+
+      if trs.length == 0
+        return comments
+      end
+
+      url = trs.last['href']
+
+      url_regex = /\/x\?fnid=(.*)/
+
+      match = url_regex.match(url)
+
+      if match == nil
+        return comments
+      end
+
+      req = Request.new match[1], true
+      parser = Parser.new req
+
+      comments = comments + parser.get_comments
+
+      return comments
+    end
+
+    def get_num_votes subtext
+      return subtext.css('span')[0].content.to_i
+    end
+
+    def get_posted_by subtext
+      return subtext.css('a')[0].content
+    end
+
+    def get_date subtext
+      date_regex = /.*\s(.*\s.*\sago)/
+      ago = date_regex.match(subtext.content)[1]
+      date_posted = Chronic.parse(ago).to_s
+
+      return date_posted
+    end
+
+  end
+
+end

data/lib/hn2json/request.rb

@@ -0,0 +1,34 @@
+module HN2JSON
+
+  class Request
+    attr_accessor :html
+
+    def initialize id, more_page=false
+      @base_url = "http://news.ycombinator.com/item?id="
+      @complete_url = @base_url + id.to_s
+
+      if more_page
+        @complete_url = "http://news.ycombinator.com/x?fnid=" + id
+      end
+
+      request_page
+    end
+
+    private
+
+    def request_page
+      begin
+        @html = RestClient.get @complete_url
+      rescue
+        raise RequestError, "there was an error requesting the page, check your connection"
+      end
+
+      if @html == "No such item." || @html == "Unknown."
+        id = @complete_url.gsub(/^.*id\=/, '')
+        raise RequestError, "no such item or id, #{id}"
+      end
+    end
+
+  end
+
+end

data/lib/hn2json/version.rb

@@ -0,0 +1,4 @@
+module HN2JSON
+  # Public: String current version of HN2JSON
+  VERSION = '0.0.4'
+end

data/lib/hn2json.rb

@@ -0,0 +1,52 @@
+require 'rest-client'
+require 'nokogiri'
+require 'chronic'
+
+
+# Public: Interface to HackerNews (news.ycombinator.com)
+#
+# Examples
+#
+#    HN2JSON.find 123456
+#    # => HN2JSON::Entity:0xffffffffffffff
+module HN2JSON
+  extend HN2JSON
+
+  autoload :Request,        'hn2json/request'
+
+  autoload :Parser,         'hn2json/parser'
+
+  autoload :Entity,         'hn2json/entity'
+
+  autoload :InvalidIdError, 'hn2json/exceptions'
+  autoload :RequestError,   'hn2json/exceptions'
+  autoload :ParseError,     'hn2json/exceptions'
+
+  autoload :VERSION,        'hn2json/version'
+
+  # Public: Make a request to HackerNews and extract retrieved data.
+  #
+  # id  - The ID of the page to request
+  #
+  #
+  # Returns the fetched HackerNews Entity.
+  def find id
+    check_for_falsy_id id
+    Entity.new id
+  end
+
+  private
+
+  # Internal: Check if a given ID is valid to be requested.
+  #
+  # id - The ID to check.
+  #
+  #
+  # Returns nothing.
+  # Raises HN2JSON::InvalidIdError if the ID is invalid.
+  def check_for_falsy_id id
+  	if id.class != Fixnum || id < 1
+  		raise InvalidIdError, "id must be > 0 and a Fixnum, you passed #{id}"
+  	end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: hn2json
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Joseph Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: ! "    HN2JSON is a developer frendly interface to HackerNews.\n    It
+  provides the functionality to retrieve any HN content\n    page in stringified JSON
+  or a Ruby object.\n"
+email: whitegolem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- LICENSE
+- lib/hn2json/entity.rb
+- lib/hn2json/exceptions.rb
+- lib/hn2json/parser.rb
+- lib/hn2json/request.rb
+- lib/hn2json/version.rb
+- lib/hn2json.rb
+homepage: http://github.com/jcla1/HN2JSON
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby interface to HackerNews
+test_files: []