cinch-bgg 0.0.2 → 0.0.3

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/cinch-bgg.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "cinch-bgg"
-  s.version     = "0.0.2"
+  s.version     = "0.0.3"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Caitlin Woodward"]
   s.email       = ["caitlin@caitlinwoodward.me"]
@@ -10,8 +10,6 @@ Gem::Specification.new do |s|
   s.summary     = %q{Gives Cinch IRC bots access to BoardGameGeek data}
   s.description = %q{Gives Cinch IRC bots access to BoardGameGeek data}
 
-  s.rubyforge_project = "cinch-bgg"
-
   s.add_dependency("cinch", "~> 2.0")
   s.add_dependency("nokogiri", "~> 1.5.2")
 

data/lib/cinch/plugins/bgg.rb

@@ -7,25 +7,74 @@ module Cinch
     class Bgg
       include Cinch::Plugin
 
-      match /bgg (.+)/i,     method: :bgg
-      match /bgguser (.+)/i, method: :bgguser
+      USERS_FILE   = "users_list"
+      USERS_SUBDIR = "users"
+      GAMES_SUBDIR = "games"
+
+      match /bgg (.+)/i,        method: :bgg
+      match /bggme/i,           method: :bggself
+      match /bgguser (.+)/i,    method: :bgguser
+      match /bgguser -u (.+)/i, method: :bggactualuser
+
+      match /link_bgg (.+)/i,   method: :link_to_bgg
+
+      match /whohas (.+)/i,     method: :who_has_game
+
+      def initialize(*args)
+        super
+
+        @data_dir  = config[:data_dir]
+        @community = load_community
+      end
 
       def bgg(m, title)
-        results = search_bgg(title)
-        if results == "not found"
-          m.reply "#{m.user.nick}: \"#{title}\" not found"
-        elsif results == "too big"
-          m.reply "#{m.user.nick}: \"#{title}\" was too broad of a search term"
-        else
-          game = results.sort{ |x, y| x.rank <=> y.rank }.first
+        game = search_bgg(m, title)
+        unless game.nil?
           m.reply "#{m.user.nick}: #{game.name} (#{game.year}) - #{game.rating} - Rank: #{game.game_rank} - Designer: #{game.designers.join(", ")} - Mechanics: #{game.mechanics.join(", ")} - " <<
             "http://boardgamegeek.com/boardgame/#{game.id}"
         end
       end
 
-      def bgguser(m, name)
-        user = search_for_user(name)
-        m.reply "#{m.user.nick}: #{user.name} - Collection: #{user.collection.size} - Top 5: #{user.top_games.first(5).join(", ")} - http://boardgamegeek.com/user/#{user.name}"
+      def bgguser(m, nick)
+        unless nick.start_with?("-u ")
+          if self.in_community?(nick)
+            name = self.find_bgg_by_irc(nick)
+            user = search_for_user(name)
+            m.reply "#{user.name} - Collection: #{user.collection.size} - Top 5: #{user.top_games.first(5).join(", ")} - http://boardgamegeek.com/user/#{user.name}", true
+          else
+            m.reply "There's no \"#{nick}\" in the community. To link yourself and join the community, \"!link_bgg bgg_username\". To search by actual bgg username, \"!bgguser -u bgg_username\".", true
+          end
+        end
+      end
+
+      def bggself(m)
+        self.bgguser(m.user.nick)
+      end
+
+      def bggactualuser(m, nick)
+        user = search_for_user(nick)
+        m.reply "#{user.name} - Collection: #{user.collection.size} - Top 5: #{user.top_games.first(5).join(", ")} - http://boardgamegeek.com/user/#{user.name}", true        
+      end
+
+      def link_to_bgg(m, username)
+        @community[m.user.nick] = username
+        File.open("#{@data_dir}#{USERS_FILE}", 'w') do |file|
+          @community.each do |irc_nick, bgg_name|
+            file.write("#{irc_nick},#{bgg_name}\n")
+          end
+        end
+        m.reply "You are now added to the community!", true
+      end
+
+      def who_has_game(m, title)
+        game = search_bgg(m, title)
+        unless game.nil?
+          community = @community.dup
+          community.each{ |irc, bgg| community[irc] = search_for_user(bgg, { :id => game.id, :use_cache => true }) }
+          
+          community.keep_if{ |irc, user| user.collection.include? game.id.to_s }
+            m.reply "Owning \"#{game.name}\": #{community.keys.join(", ")}", true
+        end
       end
 
       #--------------------------------------------------------------------------------
@@ -33,43 +82,77 @@ module Cinch
       #--------------------------------------------------------------------------------
       protected
 
-      def search_bgg(search_string)
+      def search_bgg(m, search_string)
         search_results_xml = Nokogiri::XML(open("http://boardgamegeek.com/xmlapi2/search?query=#{search_string.gsub(" ", "%20")}&type=boardgame&exact=1").read)
         if search_results_xml.css('items')[0]['total'] == "0"
           search_results_xml = Nokogiri::XML(open("http://boardgamegeek.com/xmlapi2/search?query=#{search_string.gsub(" ", "%20")}&type=boardgame").read)
         end
         search_results = search_results_xml.css('item').map { |i| i['id'].to_i }
         
-        # this is dumb, find a better way
         if search_results.empty?
-          response = "not found"
+          m.reply "\"#{search_string}\" not found", true
         elsif search_results.size > 50
-          response = "too big"
+          m.reply "\"#{search_string}\" was too broad of a search term", true
         else
-          response = search_results.map do |id|
+          results = search_results.map do |id|
             Game.new(id, get_info_for_game(id))
           end
+          response = results.sort{ |x, y| x.rank <=> y.rank }.first
         end
         response
       end
 
       def get_info_for_game(game_id)
-        unless File.exists?("data/#{game_id}.xml")
-          open("data/games/#{game_id}.xml", "wb") do |file|
+        unless File.exists?("#{@data_dir}#{GAMES_SUBDIR}/#{game_id}.xml")
+          open("#{@data_dir}#{GAMES_SUBDIR}/#{game_id}.xml", "wb") do |file|
             open("http://boardgamegeek.com/xmlapi2/thing?id=#{game_id}&stats=1") do |uri|
                file.write(uri.read)
             end
           end
         end
-        Nokogiri::XML(File.open("data/games/#{game_id}.xml"))
+        Nokogiri::XML(File.open("#{@data_dir}#{GAMES_SUBDIR}/#{game_id}.xml"))
       end
 
-      def search_for_user(name)
-        user_xml = Nokogiri::XML(open("http://boardgamegeek.com/xmlapi2/user?name=#{name}&hot=1&top=1").read)
-        collection_xml = Nokogiri::XML(open("http://boardgamegeek.com/xmlapi2/collection?username=#{name}&own=1").read)
+      def search_for_user(name, collection_options = {})
+        use_cache = collection_options[:use_cache] || false
+        game_id   = collection_options[:id] || nil
+
+        search_game_id_str = (game_id.nil? ? "" : "&id=#{game_id}")
+        user_xml = Nokogiri::XML(open("http://boardgamegeek.com/xmlapi2/user?name=#{name}&hot=1&top=1#{search_game_id_str}").read)
+        collection_xml = get_collection_data_for_user(name, use_cache)
         User.new(name, user_xml, collection_xml)
       end
 
+      def get_collection_data_for_user(name, using_cache = false)
+        file_url = "#{@data_dir}#{USERS_SUBDIR}/#{name}.xml"
+        unless using_cache
+          open(file_url, "w") do |file|
+            open("http://boardgamegeek.com/xmlapi2/collection?username=#{name}&own=1&stats=1") do |uri|
+               file.write(uri.read)
+            end
+          end
+        end
+        Nokogiri::XML(File.open(file_url))
+      end
+
+      def load_community
+        users_file = File.open("#{@data_dir}#{USERS_FILE}")
+        users = {}
+        users_file.lines.each do |line|
+          nicks = line.gsub("\n", "").split(",")
+          users[nicks.first] = nicks.last
+        end        
+        users
+      end
+
+      def find_bgg_by_irc(irc_nick)
+        @community[irc_nick]
+      end
+
+      def in_community?(irc_nick)
+        self.find_bgg_by_irc(irc_nick) != nil
+      end
+
     end
 
     class Game
@@ -77,7 +160,7 @@ module Cinch
       
       NOT_RANKED_RANK = 10001
 
-      def initialize(id, xml)
+      def initialize(id, xml)        
         self.id          = id
         self.rating      = xml.css('statistics ratings average')[0]['value'].to_f
         self.rank        = xml.css('statistics ratings ranks rank')[0]["value"]
@@ -111,7 +194,12 @@ module Cinch
         self.hot_games  = user_xml.css("hot item").map{ |g| g["name"] }
         self.collection = {}
         collection_xml.css("items item").each do |g| 
-          self.collection[g["objectid"]] = g.css("name")[0].content
+          self.collection[g["objectid"]]              = {}
+          self.collection[g["objectid"]]["name"]      = g.css("name")[0].content
+          self.collection[g["objectid"]]["for_trade"] = g.css("status fortrade")[0]
+          self.collection[g["objectid"]]["want"]      = g.css("status want")[0]
+          self.collection[g["objectid"]]["plays"]     = g.css("numplays")[0].content.to_i
+          self.collection[g["objectid"]]["ratings"]   = g.css("stats")[0].css("rating")[0]['value']
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-bgg
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-16 00:00:00.000000000Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cinch
-  requirement: &70356809562460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70356809562460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70356809561980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +37,12 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *70356809561980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
 description: Gives Cinch IRC bots access to BoardGameGeek data
 email:
 - caitlin@caitlinwoodward.me
@@ -40,6 +50,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
 - README.md
 - cinch-bgg.gemspec
@@ -63,8 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: cinch-bgg
-rubygems_version: 1.8.6
+rubyforge_project: 
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Gives Cinch IRC bots access to BoardGameGeek data