taskbot 0.1.0

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "cinch", "~> 1.1.2"
+gem "mongo_mapper", "~> 0.8.6"
+gem "bson_ext", "~> 1.2.4"
+gem "daemons", "~> 1.1.0"
+gem "optiflag", "~> 0.7"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.5)
+    bson (1.2.4)
+    bson_ext (1.2.4)
+    cinch (1.1.2)
+    daemons (1.1.0)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    jnunemaker-validatable (1.8.4)
+      activesupport (>= 2.3.4)
+    mongo (1.2.4)
+      bson (>= 1.2.4)
+    mongo_mapper (0.8.6)
+      activesupport (>= 2.3.4)
+      jnunemaker-validatable (~> 1.8.4)
+      plucky (~> 0.3.6)
+    optiflag (0.7)
+    plucky (0.3.7)
+      mongo (~> 1.1)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext (~> 1.2.4)
+  bundler (~> 1.0.0)
+  cinch (~> 1.1.2)
+  daemons (~> 1.1.0)
+  jeweler (~> 1.5.2)
+  mongo_mapper (~> 0.8.6)
+  optiflag (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Logan Koester
+
+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.rdoc

@@ -0,0 +1,83 @@
+= taskbot
+
+Simple to-do lists implemented as an IRC robot
+
+It is distributed as a Ruby gem and based on Cinch and MongoDB.
+
+== Usage
+
+  <&logankoester> !task help
+  < TaskBot> Simple to-do lists implemented as an IRC robot
+  < TaskBot> !task add "Take out the trash" - Add a task for yourself
+  < TaskBot> !task add <nick> "Take out the trash" - Add a task for <nick>
+  < TaskBot> !task complete|finish #<task_id> - Mark a task completed
+  < TaskBot> !task rm|delete|remove #<task_id> - Remove a task
+  < TaskBot> !task list - Get a list of your uncompleted tasks
+  < TaskBot> !task list <nick> - Get a list of <nick>'s uncompleted tasks
+  < TaskBot> Author: Logan Koester <logan@logankoester.com>
+  < TaskBot> Fork me at https://github.com/logankoester/taskbot>
+
+== Installation & Setup
+
+1. Install Ruby 1.9 and rubygems if you don't already have it.
+
+2. Install taskbot
+
+  $ gem install taskbot
+  Successfully installed taskbot-0.1.0
+  1 gem installed
+
+3. Set up a MongoDB database to store users information in. I recommend creating a free account at https://mongohq.com
+
+4. Create a configuration file
+
+  $ taskbot --setup ~/.taskbot
+  taskbot v0.1.0 - Simple to-do lists implemented as an IRC robot
+
+  IRC Configuration
+  -----------------
+  IRC Nick: TaskBot
+  IRC Server: irc.myserver.net
+  For password protected channels, type "#channel PASSWORD"
+  Channel: #mychannel
+  Database Configuration
+  ----------------------
+  You can get free MongoDB hosting from http://mongohq.com
+  MongoDB Host: dbhost
+  MongoDB Port: 6000 
+  MongoDB Database: taskbot
+  MongoDB Username: taskbot
+  MongoDB Password: taskbot
+
+  File written.
+  Use taskbot -f ~/.taskbot to launch your bot.
+
+5. Launch your new IRC bot!
+
+  $ taskbot -f ~/.taskbot
+
+Use --daemonize if you want to run it in the background.
+
+== Usage
+
+Explore the options and features available with !task help
+
+== Getting Help
+
+When all else fails, read the code!
+
+== Contributing to taskbot
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Logan Koester. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "taskbot"
+  gem.homepage = "http://github.com/logankoester/taskbot"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple to-do lists implemented as an IRC robot}
+  gem.description = %Q{Simple to-do lists implemented as an IRC robot}
+  gem.email = "logan@logankoester.com"
+  gem.authors = ["Logan Koester"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "taskbot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/taskbot

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'daemons'
+require 'optiflag'
+require 'yaml'
+
+APP_VERSION = File.read("#{File.dirname(__FILE__)}/../VERSION")
+
+def ask(q)
+  print q
+  a = STDIN.gets.chomp
+  return a
+end
+
+module App extend OptiFlagSet
+  optional_flag "file" do
+    alternate_forms "f"
+    description "Path to a configuration file"
+  end
+
+  optional_flag "setup" do
+    description "Generate a configuration file"
+  end
+
+  optional_switch_flag "daemonize" do
+    alternate_forms "d"
+    description "Run this process in the background"
+  end
+  
+  and_process!
+end
+
+puts "taskbot v#{APP_VERSION} - Simple to-do lists implemented as an IRC robot"
+
+flag = App.flags
+
+if flag.file
+  Daemons.daemonize if flag.daemonize?
+  puts "Using configuration at #{flag.file}"
+  $config = YAML.load_file(flag.file)
+  require File.expand_path("#{File.dirname(__FILE__)}/../lib/taskbot.rb")
+elsif flag.setup
+  $config = {'mongodb' => {}}
+
+  puts
+  puts "IRC Configuration"
+  puts "-----------------"
+  $config['nick'] = ask "IRC Nick: "
+  $config['server'] = ask "IRC Server: "
+  puts "For password protected channels, type \"#channel PASSWORD\""
+  $config['channels'] = [ask("Channel: ")]
+
+  puts "Database Configuration"
+  puts "----------------------"
+  puts "You can get free MongoDB hosting from http://mongohq.com"
+  $config['mongodb']['host'] = ask "MongoDB Host: "
+  $config['mongodb']['port'] = ask "MongoDB Port: "
+  $config['mongodb']['database'] = ask "MongoDB Database: "
+  $config['mongodb']['username'] = ask "MongoDB Username: "
+  $config['mongodb']['password'] = ask "MongoDB Password: "
+
+  File.open(flag.setup, 'w+') { |f| f << $config.to_yaml }
+  puts
+  puts "File written."
+  puts "Use taskbot -f #{flag.setup} to launch your bot."
+else
+  puts "Use taskbot --help for usage"
+end

data/lib/cinch/plugins/taskbot.rb

@@ -0,0 +1,9 @@
+module Cinch
+  module Plugins
+    module TaskBot
+      autoload :Task, File.expand_path('../taskbot/task', __FILE__)
+      autoload :User, File.expand_path('../taskbot/user', __FILE__)
+      autoload :Tasks, File.expand_path('../taskbot/tasks', __FILE__)
+    end
+  end
+end

data/lib/cinch/plugins/taskbot/task.rb

@@ -0,0 +1,14 @@
+module Cinch
+  module Plugins
+    module TaskBot
+
+      class Task
+        include MongoMapper::Document
+        key :content, String
+        key :status, Symbol, :default => :open
+        belongs_to :user
+      end
+
+    end
+  end
+end

data/lib/cinch/plugins/taskbot/tasks.rb

@@ -0,0 +1,117 @@
+module Cinch
+  module Plugins
+    module TaskBot
+      class Tasks
+        include Cinch::Plugin
+
+        match /add "(.+)"/, :method => :add_task
+        match /add (.+) "(.+)"/, :method => :add_task_for
+
+        match /complete|finish #(.+)/, :method => :complete_task
+        match /rm|delete|remove #(.+)/, :method => :remove_task
+
+        match /list$/, :method => :get_list
+        match /list (.+)/, :method => :get_list_for
+
+        match /help$/, :method => :help
+
+        listen_to :channel
+        prefix /^!task /
+
+        def initialize(*args)
+          super
+        end
+
+        def help(m)
+          m.reply "Simple to-do lists implemented as an IRC robot"
+
+          m.reply "!task add \"Take out the trash\" - Add a task for yourself"
+          m.reply "!task add <nick> \"Take out the trash\" - Add a task for <nick>"
+
+          m.reply "!task complete|finish #<task_id> - Mark a task completed"
+          m.reply "!task rm|delete|remove #<task_id> - Remove a task"
+
+          m.reply "!task list - Get a list of your uncompleted tasks"
+          m.reply "!task list <nick> - Get a list of <nick>'s uncompleted tasks"
+
+          m.reply "Author: Logan Koester <logan@logankoester.com>"
+          m.reply "Fork me at https://github.com/logankoester/taskbot>"
+        end
+
+        # Add a task for yourself
+        def add_task(m, content)
+          add_task_for_user(m, m.user.nick, content)
+        end
+        
+        # Add a task for <nick>
+        def add_task_for(m, nick, content)
+          add_task_for_user(m, nick, content)
+        end
+
+        # Mark a task completed
+        def complete_task(m, task_id)
+          set_task_status(m, task_id, :completed)
+        end
+        
+        # Remove a task
+        def remove_task(m, task_id)
+          task = Task.find(task_id)
+          if task
+            Task.destroy(task_id)
+            m.reply "Task ##{task_id} has been removed."
+          else
+            m.reply "Task ##{task_id} not found."
+          end
+        end
+
+        # Get a list of your uncompleted tasks
+        def get_list(m)
+          get_list_for_user(m, m.user.nick)
+        end
+
+        # Get a list of <nick>'s uncompleted tasks
+        def get_list_for(m, nick)
+          get_list_for_user(m, nick)
+        end
+
+      private
+        def add_task_for_user(m, nick, content)
+          nick.downcase!
+          user = User.find_by_nick(nick)
+          user_status = (user.nil?) ? "New user '#{nick}' created" : "Existing user '#{nick}' found"
+          user ||= User.create( :nick => nick )
+          task = user.tasks.create( :content => content )
+          m.reply "#{user_status}, task added as #{task.id}"
+          return task
+        end
+
+        def get_list_for_user(m, nick)
+          nick.downcase!
+          user = User.find_by_nick(nick)
+          user_status = (user.nil?) ? "New user '#{nick}' created" : "Existing user '#{nick}' found"
+          user ||= User.create( :nick => nick )
+          open_tasks = user.tasks.map { |t| t if t.status == :open }
+          if open_tasks.empty?
+            m.reply "#{user_status}, no open tasks."
+          else
+            m.reply "#{user_status}, open tasks:"
+            open_tasks.each { |t| m.reply "##{t._id} #{t.content}" }
+          end
+        end
+
+        def set_task_status(m, task_id, new_status)
+          task = Task.find(task_id)
+          if task
+            old_status = task.status
+            task.status = new_status
+            task.save
+            m.reply "Task ##{task.id} status changed from #{old_status} to #{task.status}"
+          else
+            m.reply "Task ##{task_id} not found."
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/cinch/plugins/taskbot/user.rb

@@ -0,0 +1,13 @@
+module Cinch
+  module Plugins
+    module TaskBot
+
+      class User
+        include MongoMapper::Document
+        key :nick, String
+        many :tasks, :class => Cinch::Plugins::TaskBot::Task
+      end
+
+    end
+  end
+end

data/lib/taskbot.rb

@@ -0,0 +1,30 @@
+%w{rubygems cinch mongo_mapper}.each { |d| require d }
+
+require "#{File.dirname(__FILE__)}/cinch/plugins/taskbot"
+
+begin
+  MongoMapper.connection = Mongo::Connection.new($config['mongodb']['host'], $config['mongodb']['port'])
+  MongoMapper.database = $config['mongodb']['database']
+  MongoMapper.database.authenticate($config['mongodb']['username'], $config['mongodb']['password'])
+rescue Mongo::AuthenticationError => e
+  puts e
+  puts "Host: " + $config['mongodb']['host']
+  puts "Port: " + $config['mongodb']['port']
+  puts "Database: " + $config['mongodb']['database']
+  puts "Username: " + $config['mongodb']['username']
+  puts "Password: " + $config['mongodb']['password']
+  exit
+rescue Exception => e
+  "Failed to connect to database: #{e}"
+end
+
+$bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = $config['server']
+    c.nick = $config['nick']
+    c.channels = $config['channels']
+    c.plugins.plugins = [Cinch::Plugins::TaskBot::Tasks]
+  end
+end
+
+$bot.start

data/taskbot.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{taskbot}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Logan Koester"]
+  s.date = %q{2011-03-21}
+  s.default_executable = %q{taskbot}
+  s.description = %q{Simple to-do lists implemented as an IRC robot}
+  s.email = %q{logan@logankoester.com}
+  s.executables = ["taskbot"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/taskbot",
+    "lib/cinch/plugins/taskbot.rb",
+    "lib/cinch/plugins/taskbot/task.rb",
+    "lib/cinch/plugins/taskbot/tasks.rb",
+    "lib/cinch/plugins/taskbot/user.rb",
+    "lib/taskbot.rb",
+    "taskbot.gemspec"
+  ]
+  s.homepage = %q{http://github.com/logankoester/taskbot}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple to-do lists implemented as an IRC robot}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cinch>, ["~> 1.1.2"])
+      s.add_runtime_dependency(%q<mongo_mapper>, ["~> 0.8.6"])
+      s.add_runtime_dependency(%q<bson_ext>, ["~> 1.2.4"])
+      s.add_runtime_dependency(%q<daemons>, ["~> 1.1.0"])
+      s.add_runtime_dependency(%q<optiflag>, ["~> 0.7"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<cinch>, ["~> 1.1.2"])
+      s.add_dependency(%q<mongo_mapper>, ["~> 0.8.6"])
+      s.add_dependency(%q<bson_ext>, ["~> 1.2.4"])
+      s.add_dependency(%q<daemons>, ["~> 1.1.0"])
+      s.add_dependency(%q<optiflag>, ["~> 0.7"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<cinch>, ["~> 1.1.2"])
+    s.add_dependency(%q<mongo_mapper>, ["~> 0.8.6"])
+    s.add_dependency(%q<bson_ext>, ["~> 1.2.4"])
+    s.add_dependency(%q<daemons>, ["~> 1.1.0"])
+    s.add_dependency(%q<optiflag>, ["~> 0.7"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification 
+name: taskbot
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-21 00:00:00 -04:00
+default_executable: taskbot
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cinch
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 6
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: optiflag
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+description: Simple to-do lists implemented as an IRC robot
+email: logan@logankoester.com
+executables: 
+- taskbot
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/taskbot
+- lib/cinch/plugins/taskbot.rb
+- lib/cinch/plugins/taskbot/task.rb
+- lib/cinch/plugins/taskbot/tasks.rb
+- lib/cinch/plugins/taskbot/user.rb
+- lib/taskbot.rb
+- taskbot.gemspec
+has_rdoc: true
+homepage: http://github.com/logankoester/taskbot
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 88891898656538276
+      segments: 
+      - 0
+      version: "0"
+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: Simple to-do lists implemented as an IRC robot
+test_files: []
+