cinch-bgg 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,82 @@
+# Cinch-IMDb - IMDb.com plugin
+
+## Description
+
+This plugin uses the [Film Buff gem](https://github.com/sachse/filmbuff) to access data from IMDb.com.
+
+## Installation
+
+### RubyGems
+
+You can install the latest Cinch-IMDb gem using RubyGems
+
+    gem install cinch-imdb
+
+### GitHub
+
+Alternatively you can check out the latest code directly from Github
+
+    git clone http://github.com/sachse/cinch-imdb.git
+
+## Usage
+
+Install the gem and load it in your Cinch bot:
+
+    require "cinch"
+    require "cinch/plugins/imdb"
+
+    bot = Cinch::Bot.new do
+      configure do |c|
+        # add all required options here
+        c.plugins.plugins = [Cinch::Plugins::IMDb] # optionally add more plugins
+      end
+    end
+
+    bot.start
+
+If you want to return results in other languages this is possible as well. The supported locales are "de_DE", "en_US", "es_ES", "fr_FR", "it_IT" and "pt_PT" with "en_US" being the default.
+
+    require "cinch"
+    require "cinch/plugins/imdb"
+
+    bot = Cinch::Bot.new do
+      configure do |c|
+        # add all required options here
+        c.plugins.plugins = [Cinch::Plugins::IMDb] # optionally add more plugins
+        c.plugins.options[Cinch::Plugins::IMDb][:locale] = "de_DE"
+      end
+    end
+
+    bot.start
+
+## Commands
+
+### imdb
+
+By default the bot will reply with "Title (Year) - Rating/10 - IMDb link"
+e.g. "The Wizard of Oz (1939) - 8.3/10 - http://www.imdb.com/title/tt0032138"
+
+With a German locale (de_DE) the bot would instead reply with "Das zauberhafte Land (1939) - 8.3/10 - http://www.imdb.com/title/tt0032138"
+
+If you want to change the output format this can be done in imdb.rb
+The amount of information available is dependent on the Film Buff gem, which is used for accessing IMDb.com - At the time of writing the following information is accessible:
+
+- Title
+- Tagline
+- Plot
+- Runtime
+- Rating
+- Amount of votes
+- Poster URL
+- Genres
+- Release date
+- IMDb ID
+
+## Authors
+
+* [Kristoffer Sachse](https://github.com/sachse)
+
+## Contribute
+
+Fork the project, implement your changes in it's own branch, and send
+a pull request to me. I'll gladly consider any help or ideas.

data/cinch-bgg.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "cinch-bgg"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Caitlin Woodward"]
+  s.email       = ["caitlin@caitlinwoodward.me"]
+  s.homepage    = "https://github.com/caitlin/cinch-bgg"
+  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", "~> 1.0")
+  s.add_dependency("nokogiri", "~> 1.5.2")
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+end

data/lib/cinch/plugins/bgg.rb

@@ -0,0 +1,120 @@
+require 'cinch'
+require 'open-uri'
+require 'nokogiri'
+
+module Cinch
+  module Plugins
+    class Bgg
+      include Cinch::Plugin
+
+      match /bgg (.+)/i,     method: :bgg
+      match /bgguser (.+)/i, method: :bgguser
+
+      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
+          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}"
+      end
+
+      #--------------------------------------------------------------------------------
+      # Protected
+      #--------------------------------------------------------------------------------
+      protected
+
+      def search_bgg(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"
+        elsif search_results.size > 50
+          response = "too big"
+        else
+          response = search_results.map do |id|
+            Game.new(id, get_info_for_game(id))
+          end
+        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|
+            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"))
+      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)
+        User.new(name, user_xml, collection_xml)
+      end
+
+    end
+
+    class Game
+      attr_accessor :id, :rating, :rank, :name, :year, :minplayers, :maxplayers, :playingtime, :categories, :mechanics, :designers, :publishers
+      
+      NOT_RANKED_RANK = 10001
+
+      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"]
+        # if ranked, convert the value to integer; if not, set the value of the rank to the last possible
+        self.rank        = self.rank == "Not Ranked" ? NOT_RANKED_RANK : self.rank.to_i
+        self.name        = xml.css('name')[0]['value']
+        self.year        = xml.css('yearpublished')[0]['value'].to_i
+        self.minplayers  = xml.css('minplayers')[0]['value'].to_i
+        self.maxplayers  = xml.css('maxplayers')[0]['value'].to_i
+        self.playingtime = xml.css('playingtime')[0]['value'].to_i
+        self.categories  = xml.css('link[type=boardgamecategory]').map{ |l| l['value'] }
+        self.mechanics   = xml.css('link[type=boardgamemechanic]').map{ |l| l['value'] }
+        self.designers   = xml.css('link[type=boardgamedesigner]').map{ |l| l['value'] }
+        self.publishers  = xml.css('link[type=boardgamepublisher]').map{ |l| l['value'] }
+      end
+      
+      # Since we are resetting the not ranked values, let's make sure  we return the correct values
+      #
+      def game_rank
+        (self.rank == NOT_RANKED_RANK) ? "Not Ranked" : self.rank  
+      end
+    end
+
+    class User
+
+      attr_accessor :name, :top_games, :hot_games, :collection
+
+      def initialize(username, user_xml, collection_xml)
+        self.name       = username
+        self.top_games  = user_xml.css("top item").map{ |g| g["name"] }
+        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
+        end
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: cinch-bgg
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Caitlin Woodward
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: &70337759365740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70337759365740
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70337759365260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70337759365260
+description: Gives Cinch IRC bots access to BoardGameGeek data
+email:
+- caitlin@caitlinwoodward.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- cinch-bgg.gemspec
+- lib/cinch/plugins/bgg.rb
+homepage: https://github.com/caitlin/cinch-bgg
+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: cinch-bgg
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Gives Cinch IRC bots access to BoardGameGeek data
+test_files: []