Soleone-gamefaqs 0.0.2 → 0.0.3

data/README.textile

@@ -6,20 +6,13 @@ You can search for games by title and platform, and then view _Reviews_, _FAQs_,
 
 h2. Installation
 
-@gem install soleone-gamefaqs --source=http://gems.github.com@
+@gem install Soleone-gamefaqs --source=http://gems.github.com@
 
-h2. Usage
+(Case sensitive!)
 
-<pre>
-<code>
-require 'gamefaqs'
+h2. Getting started
 
-# and for convenience:
-include GameFaqs
-</code>
-</pre>
-
-h2. Examples
+@require 'gamefaqs'@
 
 h3. Find games and platforms
 
@@ -30,7 +23,7 @@ h3. Find games and platforms
   
   # You can also search starting from the platform
   snes = GameFaqs::Platform.find("snes")
-  game = snes.find("super mario land")
+  game = snes.find("super mario world")
 </code>
 </pre>
 
@@ -62,4 +55,18 @@ h3. Reviews
   review.created_at
   review.author
 </code>
-</pre>
+</pre>
+
+h2. Requirements
+
+*Hpricot* (will be installed automatically by RubyGems as a dependency)
+
+h2. Issues
+
+Speed! Because sometimes there have to be multiple webpages parsed at once.
+
+For example to retrieve the names of all games for a platform, at least 26 pages need to be parsed (one for each letter of the alphabet). So better caching strategies are something to be worked on in the future.
+
+h2. Contribute
+
+If you're interested in this kind of stuff and want to help improve this library, feel free to fork this project and send me pull-requests/patches.

data/lib/gamefaqs.rb

@@ -6,7 +6,7 @@ require 'open-uri'
 require 'date'
 
 # load all source files
-lib = %w[caching platform game search list review]
+lib = %w[caching platform game search list review random]
 lib.each { |file| require File.join(File.dirname(__FILE__), 'gamefaqs', file) }
 
 

data/lib/gamefaqs/game.rb

@@ -27,5 +27,8 @@ module GameFaqs
       sum / reviews(review_type).size.to_f
     end
     
+    def self.find(game, platform)
+      Search.game(game, platform)
+    end
   end
 end

data/lib/gamefaqs/random.rb

@@ -0,0 +1,16 @@
+module GameFaqs  
+  module Random
+    extend self
+    
+    # A review for a game
+    def review(game, platform)
+      game = Search.game(game, platform) if game.is_a?(String)
+      game and game.reviews[rand(game.reviews.size)]
+    end
+    
+    def one_line_review(game, platform, options={:detailed => false})
+      rev = review(game, platform)
+      rev and "#{options[:detailed] ? (rev.game.to_s << ': ') : ''}\"#{rev.title}\" - #{rev.score}"
+    end
+  end
+end

data/lib/gamefaqs/search.rb

@@ -3,52 +3,66 @@ module GameFaqs
     extend Caching
     class SearchException < Exception; end
 
-    # throws a SearchError when no exact match is found
-    def self.game(game_name, platform, refresh=false)
-      cached_value("search-#{game_name}-#{platform}", nil, refresh) do
-        platform = Platform.find(platform) unless platform.is_a?(Platform)
-        games = []
-        doc = Hpricot(open("#{SEARCH_URL}#{add_params(game_name, platform)}"))
-        doc.search("//div.head/h1") do |h1|
-          if h1.inner_html =~ /Best Matches/
-            h1.search("../../div.body/table") do |table|
-              table.search("tr/td/a") do |a|
-                if a.inner_html =~ /#{game_name.split(' ').join('.*')}/i
-                  games << Game.new(a.inner_html.strip, platform, GameFaqs.extract_id(a['href']))
+    class << self
+      # Find a game by it's name on a certain platform (by name or Platform instance).
+      # 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
+          platform = self.platform(platform) unless platform.is_a?(Platform)
+          games = []
+          doc = Hpricot(open("#{SEARCH_URL}#{add_params(game_name, platform)}"))
+          doc.search("//div.head/h1") do |h1|
+            if h1.inner_html =~ /Best Matches/
+              h1.search("../../div.body/table") do |table|
+                table.search("tr/td/a") do |a|
+                  if a.inner_html =~ /#{game_name.split(' ').join('.*')}/i
+                    games << Game.new(a.inner_html.strip, platform, GameFaqs.extract_id(a['href']))
+                  end
                 end
               end
             end
           end
-        end
         
-        case games.size
-        when 1
-          games.first
-        when 0
-          raise SearchException.new("Could not find a game containing the string \"#{game_name}\" on platform \"#{platform}\"!")
-        else
-          raise SearchException.new("Found more than one game containing the string \"#{game_name}\": #{games.join(', ')}")
+          case games.size
+          when 1
+            games.first
+          when 0
+            raise SearchException.new("Could not find a game containing the string \"#{game_name}\" on platform \"#{platform}\"!") if options[:whiny ]
+            nil
+          else
+            raise SearchException.new("Found more than one game containing the string \"#{game_name}\": #{games.join(', ')}") if options[:whiny ]
+            nil
+          end
         end
       end
-    end
     
-    class << self  
-      
-      def platform(platform_name)
+      # Find a platform by name
+      # Per default it returns nil when no platform 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 platform(platform_name, options={:whiny => false})
         # get by full name (case insensitive)
         names = List.platforms.select { |p| p.name.downcase == platform_name.downcase }
         # find other similar if not found exactly one before
+        names = List.platforms.select{|p| p.name.downcase =~ /#{platform_name.split(' ').join('.*')}/i} if names.size != 1
+        # if still nothing it is probably if you searched for "n64".
         if names.size != 1
-          names = List.platforms.select{|p| p.name.downcase =~ /#{platform_name.split(' ').join('.*')}/i}
+          platform = ""
+          platform_name.each_byte do
+            |byte| platform << byte.chr << ".*"
+          end
+          names = List.platforms.select{ |p| p.name.downcase =~ Regexp.compile(platform) }
         end
-
+        
         case names.size
         when 1
           names.first
         when 0
-          raise SearchException.new("Could not find a platform containing the string \"#{platform_name}\"!")
+          raise SearchException.new("Could not find a platform containing the string \"#{platform_name}\"!") if options[:whiny]
+          nil
         else
-          raise SearchException.new("Found more than one platform containing the string \"#{platform_name}\": #{names.join(', ')}")
+          raise SearchException.new("Found more than one platform containing the string \"#{platform_name}\": #{names.join(', ')}") if options[:whiny]
+          nil
         end
       end
       

data/test/gamefaqs_test.rb

@@ -1,11 +1,16 @@
 require 'test/unit'
-require '../game_faqs'
+require '../lib/gamefaqs'
 
 class GameFaqsTest < Test::Unit::TestCase
   include GameFaqs
+
+  def setup
+    @game ||= Search.game("gothic ii", "pc")    
+  end
   
-  def test_all_platforms
-  #  assert Platform.all.first.is_a?(Platform)
+  def test_all_platforms_available
+    assert Platform.all.size > 0
+    assert Platform.all.first.is_a?(Platform)
   end
   
   def test_search_for_game
@@ -16,14 +21,18 @@ class GameFaqsTest < Test::Unit::TestCase
     assert_equal "DS", game.platform.name
   end
   
-  def test_game_reviews_count
-    game = Search.game("Castlevania Order", "ds")
-    reviews = Review.all_for_game(game)
-    #reviews.each { |r| puts r }
+  def test_game_reviews_available
+    reviews = Review.all_for(@game)
+    assert reviews.size > 0
+    assert reviews.first.is_a?(Review)
+  end
+  
+  def test_average_score_available
+    assert @game.average_score <= 10
   end
   
-  def test_average_score
-    game = Search.game("gothic ii", "pc")
-    puts Review.average_score(game)
+  def test_review_score_available
+    assert @game.reviews.first.score[/(\d\d?)\/\d\d/]
+    assert_equal $1.to_i, @game.reviews.first.score_to_i
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Soleone-gamefaqs
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Dennis Theisen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-09 00:00:00 -08:00
+date: 2008-11-11 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,6 +38,7 @@ files:
 - lib/gamefaqs/platform.rb
 - lib/gamefaqs/review.rb
 - lib/gamefaqs/search.rb
+- lib/gamefaqs/random.rb
 - README.textile
 has_rdoc: true
 homepage: http://github.com/soleone/gamefaqs