Soleone-gamefaqs 0.0.4 → 0.0.5

data/README.textile

@@ -57,24 +57,48 @@ h3. Reviews
 </code>
 </pre>
 
+h3. Questions (and Answers)
+
+<pre>
+<code>
+  # Get an array with all user questions for a game
+  game.questions
+  
+  question = game.questions.first
+  
+  # Get the number of answers for this question
+  question.replies
+  # Get the status of the question (e.g. already answered or not)
+  question.status
+  # Get an array of all the answers for this question
+  question.answers
+</code>
+</pre>
+
 h3. Examples for quick random quotes
 
 <pre>
 <code>
   include GameFaqs
 
+  game = Game.find("super mario land", "game boy")
+
   # The title of a random review for Super Mario Land
+  Random.review(game).title
+  # long version
   Random.review("super mario land", "game boy").title
   
-  Random.one_line_review("super mario land", "game boy")
+  Random.one_line_review(game)
   # => "Not Nintendo's (or my) best, but still a decent effort." - 6/10
 
-  Random.one_line_review("super mario land", "game boy", :detailed => true)
+  Random.one_line_review(game, :detailed => true)
   # => "Super Mario Land [Game Boy]: Not Nintendo's (or my) best, but still a decent effort." - 6/10
+
+  # The title of a random user question for a game
+  question = Random.question(game).title
 </code>
 </pre>
 
-
 h2. Requirements
 
 *Hpricot* (will be installed automatically by RubyGems as a dependency)

data/lib/gamefaqs.rb

@@ -6,13 +6,14 @@ require 'open-uri'
 require 'date'
 
 # load all source files
-lib = %w[caching platform game search list review random]
+lib = %w[caching platform game search list review question random]
 lib.each { |file| require File.join(File.dirname(__FILE__), 'gamefaqs', file) }
 
 
 module GameFaqs
   BASE_URL = "http://www.gamefaqs.com"
   SEARCH_URL = "#{BASE_URL}/search/index.html"
+  SITEMAP_URL = "http://sitemap.gamefaqs.com"
 
 protected  
   def self.extract_id(url, with_html=true)
@@ -20,6 +21,11 @@ protected
     $1
   end
   
+  def self.extract_question_id(url)
+    url.match(/\/[\da-zA-Z]+\.html?qid=(\d+)$/)
+    $1
+  end
+  
   # 1. convert <br> to \n
   # 2. convert <b> to * (textile)
   # 3. convert <i> to _ (textile)
@@ -27,4 +33,21 @@ protected
   def self.strip_html(string)
     string.gsub(/<br ?\/?>/, "\n").gsub(/<b>(.+)<\/b>/i, "*\\1*").gsub(/<i>(.+)<\/i>/i, "_\\1_").gsub(/<\/?(\d|\w)+>/i, "")
   end
+  
+  # Extract a table with a certain header from a html document
+  # Yields 1) the Hpricot body element which usually contains a table
+  # And 2) the heading of the table as a String
+  def self.find_table(doc, header_regexp=/./, sub_path=nil)
+    doc.search("//div.head/h1") do |h1|
+      header = h1.inner_html
+
+      if header =~ header_regexp
+        body_path = "../../div.body#{'/'+sub_path if sub_path}"
+        h1.search(body_path) do |body|
+          yield body, header
+        end
+      end
+    end
+  end
+  
 end

data/lib/gamefaqs/caching.rb

@@ -1,16 +1,71 @@
 module GameFaqs
   module Caching
+    class Store < Hash
+      attr_reader :keys
+      
+      def initialize(*args)
+        super(*args)
+        @keys = []
+      end
+      
+      def []=(key, value)
+        @keys << key
+        clean!
+        super
+      end
+
+      # retain only second half of cache if it gets to big
+      def clean!
+        if @keys.size > Cache.max_size
+          @keys = @keys[(Cache.max_size/2)...@keys.size]
+          reject! { |key, value| !@keys.include?(key) }
+        end
+      end
+    end
+      
     
+    class Cache
+      STORE = Store.new
+
+      @@max_size = 100
+      
+      class << self
+        def max_size=(size)
+          @@max_size = size
+        end
+      
+        def max_size
+          @@max_size
+        end
+
+        def [](key)
+          STORE[key]
+        end
+        alias :fetch :[]
+        
+        def []=(key, value)
+          STORE[key] = value
+        end
+        
+        def size
+          STORE.size
+        end
+        
+        def each(*args, &blk)
+          STORE.each(*args, &blk)
+        end
+      end
+    end
+
   protected
     # perform the block only when the name isn't filled already
     def cached_value(name, object=nil, force=false)
-      @@cache ||= {}
-      if force || @@cache[name].nil?
-        @@cache[name] = object
+      if force || Cache.fetch(name).nil?
+        Cache[name] = object
         return_value = yield object
-        @@cache[name] = return_value if object.nil?
+        Cache[name] = return_value if object.nil?
       end
-      @@cache[name] 
+      Cache.fetch(name)
     end
   end
 end

data/lib/gamefaqs/game.rb

@@ -1,6 +1,8 @@
 module GameFaqs  
   class Game
-
+    
+    GENRES = { "Action" => "54", "Action-Adventure" => "163", "Adventure" => "50", "Driving" => "47", "Miscellaneous" => "49", "Role-Playing" => "48", "Simulation" => "46", "Sports" => "43", "Strategy" => "45"}
+    
     attr_reader :name, :platform, :homepage, :faqs, :codes
     
     def initialize(name, platform, id)
@@ -22,9 +24,17 @@ module GameFaqs
       List.reviews(self, review_type)
     end
     
+    def questions
+      List.questions(self)
+    end
+    
     def average_score(review_type=nil)
       sum = reviews(review_type).map{|r| r.score_to_i}.inject{|memo, score| memo + score}
-      sum / reviews(review_type).size.to_f
+      sum ? (sum / reviews(review_type).size.to_f) : -1
+    end
+    
+    def average_score_to_s
+      "%.2f - #{to_s}" % average_score
     end
     
     def self.find(game, platform)

data/lib/gamefaqs/list.rb

@@ -17,49 +17,57 @@ module GameFaqs
         end
       end
     
-      # find all games (very expensive)
+      # find all games (very expensive, takes nearly a minute, because of 27 html requests and resulting parsing)
       def games(platform, refresh=false)
-        cached_value("games", []) do |games|
+        platform = Platform.find(platform) unless platform.is_a?(Platform)
+        cached_value("games-#{platform.to_s.downcase}", []) do |games|
           letters = ('a'..'z').to_a << '0'
           letters.each do |letter|
             doc = Hpricot(open("#{platform.homepage}list_#{letter}.html"))
-            doc.search(GAMES_PATH).each do |link|
-              name = link.inner_html
-              games << Game.new(name, platform, GameFaqs.extract_id(link['href']))
-            end
+            insert_games_to_array(games, doc, platform, /Games by/)
           end
         end
       end
   
+      def games_by_genre(platform, genre, refresh=false)
+        platform = Platform.find(platform) unless platform.is_a?(Platform)
+        cached_value("games_by_#{genre.downcase}-#{platform.to_s.downcase}", []) do |games|
+          doc = Hpricot(open("#{platform.homepage}cat_#{Game.GENRES[genre]}.html"))
+          insert_games_to_array(games, doc, platform, /Games by Category/)
+        end
+      end
+      
+      def top_games(platform, refresh=false)
+        platform = Platform.find(platform) unless platform.is_a?(Platform)
+        cached_value("top_games-#{platform.to_s.downcase}", []) do |games|
+          doc = Hpricot(open(platform.homepage))
+          insert_games_to_array(games, doc, platform, /Top 10 Games/, "ul/li/a")
+        end
+      end
+      
       def reviews(game, type=nil, refresh=false)
-        reviews = cached_value("reviews-#{game.to_s}", [], refresh) do |reviews|
+        reviews = cached_value("reviews-#{game.to_s.downcase}", [], refresh) do |reviews|
           url = game.homepage.sub(/\/home\//, "/review/")
           doc = Hpricot(open(url))
-          doc.search("//div.head/h1") do |h1|
-            header = h1.inner_html
-
-            if header =~ /Reviews/
-              h1.search("../../div.body/table/tr") do |tr|
-                review = {}
-                review[:type] = Review.review_type(header)
-                tr.search("td:eq(0)") do |td|
-                  td.search("a") do |a|
-                    review[:id] = GameFaqs.extract_id(a['href'])
-                    review[:title] = a.inner_html.strip
-                  end
-                end
-                tr.search("td:eq(1)") do |td|
-                  td.search("a") do |a|
-                    review[:author] = a.inner_html.strip
-                  end
-                end
-                tr.search("td:eq(2)") do |td|
-                  review[:score] = td.inner_html.strip
-                end
-                review[:game] = game   
-                reviews << Review.new(review)
+          GameFaqs.find_table(doc, /Reviews/, "table/tr") do |tr, header|
+            review = {}
+            review[:type] = Review.review_type(header)
+            tr.search("td:eq(0)") do |td|
+              td.search("a") do |a|
+                review[:id] = GameFaqs.extract_id(a['href'])
+                review[:title] = a.inner_html.strip
+              end
+            end
+            tr.search("td:eq(1)") do |td|
+              td.search("a") do |a|
+                review[:author] = a.inner_html.strip
               end
             end
+            tr.search("td:eq(2)") do |td|
+              review[:score] = td.inner_html.strip
+            end
+            review[:game] = game   
+            reviews << Review.new(review)
           end
         end
         if type
@@ -71,33 +79,53 @@ module GameFaqs
         end
       end
 
+      def questions(game, refresh=false)
+        questions = cached_value("questions-#{game.to_s.downcase}", [], refresh) do |questions|
+          url = game.homepage.sub(/\/home\//, "/qna/") << "?type=-1"
+          doc = Hpricot(open(url))
+          GameFaqs.find_table(doc, /Help$/, "table/tr") do |tr, header|
+            question = {}
+            question[:type] = header
+            tr.search("td:eq(0)") do |td|
+              td.search("a") do |a|
+                question[:id] = GameFaqs.extract_question_id(a['href'])
+                question[:title] = a.inner_html.strip
+              end
+            end
+            tr.search("td:eq(1)") do |td|
+              question[:status] = td.inner_html
+            end
+            tr.search("td:eq(2)") do |td|
+              question[:replies] = td.inner_html
+            end
+            questions << Question.new(game, question[:id], question)
+          end
+        end
+      end
+      
       def faqs(game, type=nil, refresh=false)
-        faqs = cached_value("faqs-#{game.to_s}", [], refresh) do |faqs|
+        faqs = cached_value("faqs-#{game.to_s.downcase}", [], refresh) do |faqs|
           url = game.homepage.sub(/\/home\//, "/game/")
           doc = Hpricot(open(url))
-          doc.search("//div.head/h1") do |h1|
-            header = h1.inner_html
-
-            h1.search("../../div.body/table/tr") do |tr|
-              faq = {}
-              faq[:type] = header
-              tr.search("td:eq(0)") do |td|
-                td.search("a") do |a|
-                  review[:id] = GameFaqs.extract_id(a['href'])
-                  review[:title] = a.inner_html.strip
-                end
+          GameFaqs.find_table(doc, /./, "table/tr") do |tr, header|
+            faq = {}
+            faq[:type] = header
+            tr.search("td:eq(0)") do |td|
+              td.search("a") do |a|
+                review[:id] = GameFaqs.extract_id(a['href'])
+                review[:title] = a.inner_html.strip
               end
-              tr.search("td:eq(1)") do |td|
-                td.search("a") do |a|
-                  review[:author] = a.inner_html.strip
-                end
-              end
-              tr.search("td:eq(2)") do |td|
-                review[:score] = td.inner_html.strip
+            end
+            tr.search("td:eq(1)") do |td|
+              td.search("a") do |a|
+                review[:author] = a.inner_html.strip
               end
-              review[:game] = game   
-              reviews << Review.new(review)
             end
+            tr.search("td:eq(2)") do |td|
+              review[:score] = td.inner_html.strip
+            end
+            review[:game] = game   
+            reviews << Review.new(review)
           end
         end
         if type
@@ -118,7 +146,17 @@ module GameFaqs
           end
         end
       end
-      
+    
+    private
+      # Will add all games found within the +doc+ to the specfied +array+
+      # Search in a table with the header +header_regexp+ and the specified +sub_path+
+      def insert_games_to_array(array, doc, platform, header_regexp, sub_path="table/tr/td:eq(0)/a")
+        GameFaqs.find_table(doc, header_regexp, sub_path) do |link, header|
+          name = link.inner_html
+          array << Game.new(name, platform, GameFaqs.extract_id(link['href']))
+        end
+      end  
+    
     end # class < self
   end
 end

data/lib/gamefaqs/question.rb

@@ -0,0 +1,18 @@
+module GameFaqs
+  class Question
+    attr_reader :game, :id, :homepage, :title, :status, :replies, :type
+    
+    def initialize(game, id, options={})
+      @game, @id = game, id
+      @homepage = @game.homepage.gsub(/home/, "qna") << "?id=#{@id}"
+      @title, @status, @replies, @type = options[:title], options[:status], options[:replies], options[:type]
+    end
+    
+    def params(list=:all)
+      case list
+      when :all
+        "type=-1"
+      end
+    end
+  end
+end

data/lib/gamefaqs/random.rb

@@ -3,14 +3,26 @@ module GameFaqs
     extend self
     
     # A review for a game
-    def review(game, platform)
+    def review(game, platform=game.platform)
       game = Search.game(game, platform) if game.is_a?(String)
-      game and game.reviews[rand(game.reviews.size)]
+      game and random(game.reviews)
     end
     
-    def one_line_review(game, platform, options={:detailed => false})
+    # Return the title and the score of a review
+    def one_line_review(game, platform=game.platform, options={:detailed => false})
       rev = review(game, platform)
       rev and "#{options[:detailed] ? (rev.game.to_s << ': ') : ''}\"#{rev.title}\" - #{rev.score}"
     end
+    alias :opinion :one_line_review
+    
+    def question(game, platform=game.platform)
+      game = Search.game(game, platform) if game.is_a?(String)
+      game and random(game.questions)
+    end
+    
+  private
+    def random(array)
+      array[rand(array.size)]
+    end
   end
 end

data/lib/gamefaqs/search.rb

@@ -8,7 +8,7 @@ module GameFaqs
       # Per default it returns nil when no game could be found, or if there are multiple matches
       # Throws a detailed SearchError with help when no exact match is found (only when :whiny => true)
       def game(game_name, platform, options={:refresh => false, :whiny => false})
-        cached_value("search-#{game_name}-#{platform}", nil, options[:refresh]) do
+        cached_value("search-#{game_name.to_s.downcase} [#{platform.to_s.downcase}]", nil, options[:refresh]) do
           platform = self.platform(platform) unless platform.is_a?(Platform)
           games = []
           doc = Hpricot(open("#{SEARCH_URL}#{add_params(game_name, platform)}"))

data/test/gamefaqs_test.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require '../lib/gamefaqs'
+require File.join(File.dirname(__FILE__), '../lib/gamefaqs')
 
 class GameFaqsTest < Test::Unit::TestCase
   include GameFaqs
@@ -35,4 +35,45 @@ class GameFaqsTest < Test::Unit::TestCase
     assert @game.reviews.first.score[/(\d\d?)\/\d\d/]
     assert_equal $1.to_i, @game.reviews.first.score_to_i
   end
+  
+  # takes about a minute!
+  
+  #def test_list_all_games
+  #  games = List.games("ds")
+  #  assert games.size > 100
+  #  assert games.first.is_a?(Game)
+  #end
+  
+  def test_list_all_top_games
+    games = List.top_games("pc")
+    assert_equal 10, games.size
+    assert games.first.is_a?(Game)
+  end
+  
+  def list_games_by_genre
+    games = List.games_by_genre("pc", "Action")
+    assert games.size > 100
+    assert games.first.is_a?(Game)
+  end
+  
+  def list_questions_for_game
+    game = Game.find("fallout 3", "pc")
+    assert List.questions(game).size > 50
+  end
+  
+  def test_cache_resizing
+    Caching::Cache.max_size = 3
+    5.times { Game.find("fallout 3", "pc") }
+    puts Caching::Cache.size
+    assert Caching::Cache.size <= 3
+    Caching::Cache.max_size = 100
+  end
+  
+  def test_random_question
+    game = Game.find("fallout 3", "pc")
+    q = Random.question(game)
+    assert q.is_a?(Question)
+    puts q.title
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Soleone-gamefaqs
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Dennis Theisen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-11 00:00:00 -08:00
+date: 2008-11-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,6 +37,7 @@ files:
 - lib/gamefaqs/list.rb
 - lib/gamefaqs/platform.rb
 - lib/gamefaqs/review.rb
+- lib/gamefaqs/question.rb
 - lib/gamefaqs/search.rb
 - lib/gamefaqs/random.rb
 - README.textile