Cinch-Tell 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 024a837e5b67c8db300aa782e99cbcb45fc785ab
+  data.tar.gz: 8f44584f6c4e661578316e04f76e7e8239848f68
+SHA512:
+  metadata.gz: 08f6cacfc6b42682bd7183357cabf0da92a7343a5b8d3bd775cc63bed70ad7e42cd6505e87f1b5d1c5f9e123376317488d9823497bdc18a6226a30d4ffce44d8
+  data.tar.gz: d1a61153a1479bacde04fec5b4da853051fcae633e6d75385132db413659f303294c3faf4e64d9e9039a3002fb6b53a564e74e2a8fd007c275ded8c17de6243f

data/Cinch-Tell.gemspec

@@ -0,0 +1,47 @@
+
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push('lib')
+require 'cinch/plugins/tell/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'Cinch-Tell'
+  s.version  = Cinch::Tell::VERSION.dup
+  s.date     = '2016-02-28'
+  s.summary  = 'Cinch plugin to leave memos for people on IRC'
+  s.email    = 'lilian.jonsdottir@gmail.com'
+  s.homepage = 'https://github.com/lilyseki/Cinch-Tell'
+  s.authors  = ['Lily J']
+  s.license  = 'MIT'
+
+  s.description = <<-EOF
+Leave a message for someone on IRC who is not in the current
+channel. They will recieve the message upon joining the channel
+or changing their nick to the one that the message was left for.
+Messages have a default lifespan of six months before they are
+purged from the database.
+EOF
+
+  dependencies = [
+    [:runtime, 'sequel', '~> 0'],
+    [:runtime, 'time_diff', '~> 0'],
+    [:runtime, 'facets', '~> 0']
+  ]
+
+  s.files         = Dir['**/*']
+  s.test_files    = Dir['test/**/*'] + Dir['spec/**/*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  ## Make sure you can build the gem on older versions of RubyGems too:
+  s.rubygems_version = '2.5.1'
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.specification_version = 3 if s.respond_to? :specification_version
+
+  dependencies.each do |type, name, version|
+    if s.respond_to?("add_#{type}_dependency")
+      s.send("add_#{type}_dependency", name, version)
+    else
+      s.add_dependency(name, version)
+    end
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Lily Jónsdottír / Lily Seki
+
+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,43 @@
+Tell/Memo Plugin for Cinch
+========================
+Leave a note for someone not in an IRC channel, to be relayed when they rejoin
+the channel
+
+Usage
+-----
+
+Until I figure out how to make it into a gem, download the .rb file, and place 
+it in a subdirectory of your bot entitled 
+`plugins` then require it via `require_relative`. 
+Add it to your bot like so:
+
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ruby
+require 'cinch'
+require_relative 'plugins/tell.rb'
+
+bot = Cinch::Bot.new do
+configure do |c|
+  c.server = 'your server'
+  c.nick = 'your nick'
+  c.realname = 'your realname'
+  c.user = 'your user'
+  c.channels = ['#yourchannel']
+  c.plugins.plugins = [Cinch::Plugins::Tell]
+end
+
+bot.start
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Contained Commands
+------------------
+
+**[tell user message]**
+
+Leave note #{message} for #{user}. They must not be in the channel. Messages
+expire after a default of six months.
+
+License
+-------
+
+Licensed under The MIT License (MIT)
+Please see LICENSE

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

@@ -0,0 +1,5 @@
+module Cinch
+  module Tell
+    VERSION = '0.0.1'.freeze
+  end
+end

data/lib/cinch/plugins/tell.rb

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+# encoding=utf-8
+
+require 'sequel'
+require 'time'
+require 'time_diff'
+require 'facets/time/shift'
+
+# These are all very annoying.
+# rubocop:disable Metrics/LineLength, Metrics/ClassLength, Metrics/CyclomaticComplexity
+# rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/AbcSize
+
+module Cinch
+  module Plugins
+    # Leaving messages and things
+    class Tell
+      include Cinch::Plugin
+      # set :prefix, /^\./
+      listen_to :join, method: :check_tells
+      listen_to :nick, method: :check_tells
+
+      private
+
+      def initialize(*args)
+        super
+        @db = Sequel.sqlite('riria.db')
+        # Create the tables if they don't exist
+        @db.create_table? :tells do
+          primary_key :id
+          String :from_user
+          String :to_user
+          String :message
+          Float :time
+        end
+        @db = purge_ancients(@db)
+      end
+
+      def header(title)
+        puts '=' * 5 + " #{title} " + '=' * 5
+      end
+
+      def read_tells(nick)
+        tells = @db[:tells]
+        ret = tells.where(to_user: nick).all
+        return [] if ret.empty?
+        ret
+      end
+
+      def parse_tells(tell)
+        # ready tell for telling
+        to_nick = tell[:to_user]
+        from_nick = tell[:from_user]
+        msg = tell[:message]
+        msg_when = tell[:time]
+        timediff = Time.diff(Time.at(msg_when), Time.now)
+        output = "#{from_nick} wanted to tell you '#{msg}' about "
+        # lots of unless, could use timediff[:diff] but it's ugly
+        ago_str = ''
+        ago_str = "#{timediff[:year]} years, " unless timediff[:year].zero?
+        ago_str << "#{timediff[:month]} months, " unless timediff[:month].zero?
+        ago_str << "#{timediff[:week]} weeks, " unless timediff[:week].zero?
+        ago_str << "#{timediff[:hour]} hours, " unless timediff[:hour].zero?
+        ago_str << "#{timediff[:minute]} minutes, " unless timediff[:minute].zero?
+        ago_str << 'and ' unless ago_str.empty?
+        ago_str << "#{timediff[:second]} seconds " unless timediff[:second].zero?
+        ago_str << 'ago.' unless ago_str.empty?
+        ago_str = 'an undetermined amount of time ago.' if ago_str.empty?
+        output << ago_str
+        # feels odd without "return output" but I guess that's Ruby
+      end
+
+      def purge_ancients(db)
+        # purge any messages older than x date
+        purge_date = Time.now.shift(-6, :months)
+        db[:tells].where('time < ?', purge_date.to_f).delete
+        db
+      end
+
+      def add_tell(nick, msg, from)
+        t = Time.now.to_f
+        @db[:tells].insert(to_user: nick, from_user: from, message: msg, time: t)
+      end
+
+      public
+
+      def check_tells(m)
+        tells = read_tells(m.user.nick.downcase)
+        return if tells.empty?
+        r = parse_tells(tells.first)
+        r = r.prepend("#{m.user.nick}: ") unless m.channel.nil?
+        m.reply(r)
+        if tells.length > 1
+          tells.each_with_index do |i, j|
+            next if j == 0 # Skip the first message because it was already sent
+            User(i[:to_user]).send(parse_tells(i))
+          end
+        end
+        @db[:tells].where(to_user: m.user.nick).delete
+      end
+
+      match(/tell(?: (.+))?/, method: :irc_tell)
+      def irc_tell(m, q)
+        nick = q.split(' ')[0]
+        msg = q.split(' ')[1..-1].join(' ')
+        if m.channel.has_user?(nick)
+          m.reply("#{nick} is here right now, tell them yourself!")
+          return
+        end
+        add_tell(nick.downcase, msg, m.user.nick)
+        m.reply("Okay I'll let #{nick} know the next time they join the channel.")
+      end
+    end
+  end
+end
+
+# vim:tabstop=2 softtabstop=2 expandtab shiftwidth=2 smarttab foldmethod=syntax:

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: Cinch-Tell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lily J
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: time_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: facets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Leave a message for someone on IRC who is not in the current
+  channel. They will recieve the message upon joining the channel
+  or changing their nick to the one that the message was left for.
+  Messages have a default lifespan of six months before they are
+  purged from the database.
+email: lilian.jonsdottir@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Cinch-Tell.gemspec
+- LICENSE
+- README.md
+- Sun_02-28-2016_19-34-28.png
+- lib/cinch/plugins/tell.rb
+- lib/cinch/plugins/tell/version.rb
+homepage: https://github.com/lilyseki/Cinch-Tell
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 3
+summary: Cinch plugin to leave memos for people on IRC
+test_files: []