cinch-bgg 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. data/README.md +13 -46
  2. data/cinch-bgg.gemspec +2 -2
  3. metadata +6 -6
data/README.md CHANGED
@@ -1,82 +1,49 @@
1
- # Cinch-IMDb - IMDb.com plugin
1
+ # Cinch-BGG - BoardGameGeek plugin
2
2
 
3
3
  ## Description
4
4
 
5
- This plugin uses the [Film Buff gem](https://github.com/sachse/filmbuff) to access data from IMDb.com.
5
+ This is a BoardGameGeek plugin for Cinch bots. Handcrafted for #boardgames on freenode.
6
6
 
7
7
  ## Installation
8
8
 
9
9
  ### RubyGems
10
10
 
11
- You can install the latest Cinch-IMDb gem using RubyGems
11
+ You can install the latest Cinch-BGG gem using RubyGems
12
12
 
13
- gem install cinch-imdb
13
+ gem install cinch-bgg
14
14
 
15
15
  ### GitHub
16
16
 
17
17
  Alternatively you can check out the latest code directly from Github
18
18
 
19
- git clone http://github.com/sachse/cinch-imdb.git
19
+ git clone http://github.com/caitlin/cinch-bgg.git
20
20
 
21
21
  ## Usage
22
22
 
23
23
  Install the gem and load it in your Cinch bot:
24
24
 
25
25
  require "cinch"
26
- require "cinch/plugins/imdb"
26
+ require "cinch/plugins/bgg"
27
27
 
28
28
  bot = Cinch::Bot.new do
29
29
  configure do |c|
30
30
  # add all required options here
31
- c.plugins.plugins = [Cinch::Plugins::IMDb] # optionally add more plugins
31
+ c.plugins.plugins = [Cinch::Plugins::Bgg] # optionally add more plugins
32
32
  end
33
33
  end
34
34
 
35
35
  bot.start
36
36
 
37
- 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.
38
-
39
- require "cinch"
40
- require "cinch/plugins/imdb"
41
-
42
- bot = Cinch::Bot.new do
43
- configure do |c|
44
- # add all required options here
45
- c.plugins.plugins = [Cinch::Plugins::IMDb] # optionally add more plugins
46
- c.plugins.options[Cinch::Plugins::IMDb][:locale] = "de_DE"
47
- end
48
- end
49
-
50
- bot.start
51
37
 
52
38
  ## Commands
53
39
 
54
- ### imdb
55
-
56
- By default the bot will reply with "Title (Year) - Rating/10 - IMDb link"
57
- e.g. "The Wizard of Oz (1939) - 8.3/10 - http://www.imdb.com/title/tt0032138"
58
-
59
- 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"
60
-
61
- If you want to change the output format this can be done in imdb.rb
62
- 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:
63
-
64
- - Title
65
- - Tagline
66
- - Plot
67
- - Runtime
68
- - Rating
69
- - Amount of votes
70
- - Poster URL
71
- - Genres
72
- - Release date
73
- - IMDb ID
40
+ ### !bgg
74
41
 
75
- ## Authors
42
+ The bot will reply with "Title (Year) - Rating - Rank - Designer(s) - Mechanics - BGG Link"
43
+ e.g. "Dominion (2008) - 7.94377 - Rank: 11 - Designer: Donald X. Vaccarino - Mechanics: Card Drafting, Deck / Pool Building, Hand Management - http://boardgamegeek.com/boardgame/36218"
76
44
 
77
- * [Kristoffer Sachse](https://github.com/sachse)
45
+ ### !bgguser
78
46
 
79
- ## Contribute
47
+ The bot will reply with "Username - Collection Size - Top 5 Games - BGG Profile Link"
48
+ e.g. "nolemonplease - Collection: 94 - Top 5: Battlestar Galactica, Space Alert, Mage Knight: Board Game, Trajan, Troyes - http://boardgamegeek.com/user/nolemonplease"
80
49
 
81
- Fork the project, implement your changes in it's own branch, and send
82
- a pull request to me. I'll gladly consider any help or ideas.
data/cinch-bgg.gemspec CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Gem::Specification.new do |s|
4
4
  s.name = "cinch-bgg"
5
- s.version = "0.0.1"
5
+ s.version = "0.0.2"
6
6
  s.platform = Gem::Platform::RUBY
7
7
  s.authors = ["Caitlin Woodward"]
8
8
  s.email = ["caitlin@caitlinwoodward.me"]
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
12
12
 
13
13
  s.rubyforge_project = "cinch-bgg"
14
14
 
15
- s.add_dependency("cinch", "~> 1.0")
15
+ s.add_dependency("cinch", "~> 2.0")
16
16
  s.add_dependency("nokogiri", "~> 1.5.2")
17
17
 
18
18
  s.files = `git ls-files`.split("\n")
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cinch-bgg
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -13,18 +13,18 @@ date: 2012-06-16 00:00:00.000000000Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: cinch
16
- requirement: &70337759365740 !ruby/object:Gem::Requirement
16
+ requirement: &70356809562460 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ~>
20
20
  - !ruby/object:Gem::Version
21
- version: '1.0'
21
+ version: '2.0'
22
22
  type: :runtime
23
23
  prerelease: false
24
- version_requirements: *70337759365740
24
+ version_requirements: *70356809562460
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: nokogiri
27
- requirement: &70337759365260 !ruby/object:Gem::Requirement
27
+ requirement: &70356809561980 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - ~>
@@ -32,7 +32,7 @@ dependencies:
32
32
  version: 1.5.2
33
33
  type: :runtime
34
34
  prerelease: false
35
- version_requirements: *70337759365260
35
+ version_requirements: *70356809561980
36
36
  description: Gives Cinch IRC bots access to BoardGameGeek data
37
37
  email:
38
38
  - caitlin@caitlinwoodward.me