rdoc

alaz · Dec 20, 2016 · b42f04f · b42f04f
1 parent 658fc62
commit b42f04f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/lib/legitbot/Match.rb b/lib/legitbot/Match.rb
@@ -1,4 +1,8 @@
 module Legitbot
+  ##
+  # Represents a bot instance match. Typical methods are
+  # +valid?+, +fake?+ and +detected_as+
+  #
   class Match
     def initialize(ip, resolver_config = nil)
       @dns = Resolv::DNS.new(resolver_config)

diff --git a/lib/legitbot/legitbot.rb b/lib/legitbot/legitbot.rb
@@ -1,6 +1,15 @@
 module Legitbot
   @rules = []
 
+  ##
+  # Lookup a bot based on its signature from +User-Agent+ header.
+  #
+  # If a block given, passes the found bot to the block.
+  #
+  # Returns +nil+ if no bot found and a bot match instance
+  # otherwise.
+  # :yields: a found bot
+  #
   def self.bot(userAgent, ip, resolver_config = nil)
     bot =
       @rules.select { |rule|