bemurphy-cinch-last_seen 0.0.2

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,10 @@
+require 'cinch'
+
+module Cinch
+  module Plugins
+    module LastSeen
+      autoload :Base, File.expand_path('./lib/cinch/plugins/last_seen/base.rb')
+      autoload :RedisStorage, File.expand_path('./lib/cinch/plugins/last_seen/storage/redis_storage.rb')
+    end
+  end
+end

data/lib/cinch/plugins/last_seen/base.rb

@@ -0,0 +1,51 @@
+module Cinch
+  module Plugins
+    module LastSeen
+      class Base
+        include Cinch::Plugin
+        attr_accessor :backend
+
+        def initialize(*args)
+          super
+          # TODO config this
+          self.backend = RedisStorage.new
+        end
+
+        listen_to :channel, :method => :log_message
+
+        def log_message(m)
+          return unless log_channel?(m.channel)
+          backend.record_time m.channel, m.user.nick
+        end
+
+        match /seen (.+)/, :method => :check_nick
+
+        def check_nick(m, nick)
+          return unless log_channel?(m.channel)
+
+          if time = backend.get_time(m.channel, nick)
+            readable_time = Time.at time.to_i
+            m.reply "I've last seen #{nick} at #{readable_time}", true
+          else
+            m.reply "I haven't seen #{nick}, sorry.", true
+          end
+        end
+
+        private
+
+        def log_channel?(channel)
+          channel = channel.to_s
+          our_config = config[:channels] || {}
+
+          if our_config[:include]
+            our_config[:include].include?(channel)
+          elsif our_config[:exclude]
+            !our_config[:exclude].include?(channel)
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cinch/plugins/last_seen/storage/redis_storage.rb

@@ -0,0 +1,28 @@
+require 'redis'
+require 'redis-namespace'
+
+# TODO extract this into a gem so we can reuse across cinch plugins,
+# or just general config a redis connection at toplevel for re-use
+
+module Cinch
+  module Plugins
+    module LastSeen
+      class RedisStorage
+        attr_reader :redis
+
+        def initialize
+          @redis = ::Redis::Namespace.new("cinch-seen_last", :redis => ::Redis.new(:thread_safe => true))
+        end
+
+        def record_time(set, key)
+          redis.zadd(set.to_s, Time.now.to_i, key.to_s)
+        end
+
+        def get_time(set, key)
+          time = redis.zscore(set, key)
+          Time.at(time.to_i) if time
+        end
+      end
+    end
+  end
+end

data/lib/cinch/plugins/last_seen/version.rb

@@ -0,0 +1,8 @@
+module Cinch
+  module Plugins
+    module LastSeen
+      VERSION = "0.0.2"
+    end
+  end
+end
+

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: bemurphy-cinch-last_seen
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Dominik Honnef
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-09 00:00:00.000000000 -07:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: &2165643460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165643460
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2165643000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165643000
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: &2165642540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165642540
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2165642160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165642160
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2165641700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165641700
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &2165641280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165641280
+description: A "last seen" plugin for the Cinch framework
+email:
+- xternal1+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/cinch/plugins/last_seen/base.rb
+- lib/cinch/plugins/last_seen/storage/redis_storage.rb
+- lib/cinch/plugins/last_seen/version.rb
+- lib/cinch/plugins/last_seen.rb
+has_rdoc: true
+homepage: https://github.com/bemurphy/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
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A "last seen" plugin for the Cinch framework
+test_files: []