cinch-last_seen 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Dominik Honnef
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Last seen plugin
+
+This plugin provides the traditional _last seen_ functionality for Cinch bots.
+
+## Installation
+First install the gem by running:
+    [sudo] gem install cinch-last_seen
+
+Then load it in your bot:
+    require "cinch"
+    require "cinch/plugins/last_seen"
+
+    bot = Cinch::Bot.new do
+      configure do |c|
+        # add all required options here
+        c.plugins.plugins = [Cinch::Plugins::LastSeen] # optionally add more plugins
+      end
+    end
+
+    bot.start
+
+## Commands
+### !seen <nick>
+This checks if and when someone was last seen. The plugin will either
+respond with the time, channel and message or state that it has never
+seen the person before.
+
+## Options
+### :channels
+#### :include
+Specify a list of channels the bot should log messages for. If this
+option is set, `:exclude` will be ignored.
+
+#### :exclude
+Specify a list of channels the bot should not log messages for. All
+other channels will be logged.
+
+#### A note
+If neither `:include` nor `:exclude` are set, all channels will be logged.
+
+#### Example configuration
+    # ...
+    configure do |c|
+      # only log messages for #cinch-bots
+      c.plugins.options[Cinch::Plugins::LastSeen][:channels] = {:include => ["#cinch-bots"]}
+    end

data/lib/cinch/plugins/last_seen.rb

@@ -0,0 +1,54 @@
+require "time"
+
+# TODO a permanent store, to keep messages even after a restart of the bot
+
+module Cinch
+  module Plugins
+    class LastSeen
+      include Cinch::Plugin
+
+      LoggedMessage = Struct.new(:nick, :channel, :message, :time)
+
+      def initialize(*args)
+        super
+        @logged_messages = {}
+      end
+
+      listen_to :channel, method: :log_message
+      def log_message(m)
+        return unless log_channel?(m.channel)
+        @logged_messages[m.user.nick] = LoggedMessage.new(m.user.nick, m.channel.to_s, m.message, Time.now)
+      end
+
+      match(/seen (.+)/, method: :check_nick)
+      def check_nick(m, nick)
+        message = @logged_messages[nick]
+        if message
+          m.reply "I've last seen #{nick} at #{message.time} in #{message.channel} saying: #{message.message}", true
+        else
+          m.reply "I haven't seen #{nick}, sorry.", true
+        end
+      end
+
+      private
+      def log_channel?(channel)
+        # we log a channel if:
+        # - we have an explicit list of allowed channels and the
+        #   channel is included
+        # - we have an explicit list of disallowed channels and the
+        #   channel is not included
+        # - we don't have either list
+        channel = channel.to_s
+        our_config = config[:channels] || {}
+
+        if our_config[:include]
+          return our_config[:include].include?(channel)
+        elsif our_config[:exclude]
+          return !our_config[:exclude].include?(channel)
+        else
+          return true
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: cinch-last_seen
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dominik Honnef
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-29 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cinch
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+description: A "last seen" plugin for the Cinch framework
+email: 
+- dominikh@fork-bomb.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- lib/cinch/plugins/last_seen.rb
+has_rdoc: true
+homepage: http://rubydoc.info/github/cinchrb/cinch-last_seen
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      - 1
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A "last seen" plugin for the Cinch framework
+test_files: []
+