cinch-quotes 0.0.1

data/README.md

@@ -0,0 +1,47 @@
+# Cinch-Quotes - Quotes plugin
+
+## Description
+
+This is a quotes plugin for Cinch bots. 
+
+## Installation
+
+### RubyGems
+
+You can install the latest Cinch-Quotes gem using RubyGems
+
+    gem install cinch-quotes
+
+### GitHub
+
+Alternatively you can check out the latest code directly from Github
+
+    git clone http://github.com/caitlin/cinch-quotes.git
+
+## Usage
+
+Install the gem and load it in your Cinch bot:
+
+    require "cinch"
+    require "cinch/plugins/quotes"
+
+    bot = Cinch::Bot.new do
+      configure do |c|
+        # add all required options here
+        c.plugins.plugins = [Cinch::Plugins::Quotes] # optionally add more plugins
+      end
+    end
+
+    bot.start
+
+
+## Commands
+
+### !quote
+
+The bot will reply with a random quote. You can optionally provide an ID or a search term for the bot to return a specific quote.
+
+### !addquote
+
+Add a quote to the bot.
+

data/cinch-quotes.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "cinch-quotes"
+  s.version     = "0.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Caitlin Woodward"]
+  s.email       = ["caitlin@caitlinwoodward.me"]
+  s.homepage    = "https://github.com/caitlin/cinch-quotes"
+  s.summary     = %q{Gives Cinch IRC bots ability to manage quotes}
+  s.description = %q{Gives Cinch IRC bots ability to manage quotes}
+
+  s.add_dependency("cinch", "~> 2.0")
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+end

data/lib/cinch/plugins/quotes.rb

@@ -0,0 +1,76 @@
+require 'cinch'
+require 'yaml'
+
+module Cinch
+  module Plugins
+    class Quotes
+      include Cinch::Plugin
+
+      QUOTES_FILE = "data/quotes.yml"
+
+      match /addquote (.+)/i,  method: :addquote
+      match /quote (.+)/i,     method: :quote
+      match "quote",           method: :quote
+
+      def addquote(m, quote)
+        # make the quote
+        new_quote = { "quote" => quote, "added_by" => m.user.nick, "created_at" => Time.now, "deleted" => false }
+
+        # add it to the list
+        existing_quotes = get_quotes || []
+        existing_quotes << new_quote
+
+        # find the id of the new quote and set it based on where it was placed in the quote list
+        new_quote_index = existing_quotes.index(new_quote)
+        existing_quotes[new_quote_index]["id"] = new_quote_index + 1
+
+        # write it to the file
+        output = File.new(QUOTES_FILE, 'w')
+        output.puts YAML.dump(existing_quotes)
+        output.close
+
+        # send reply that quote was added
+        m.reply "#{m.user.nick}: Quote successfully added as ##{new_quote_index + 1}."
+      end
+
+      def quote(m, search = nil)
+        quotes = get_quotes.delete_if{ |q| q["deleted"] == true }
+        if search.nil? # we are pulling random
+          quote = quotes.sample
+          m.reply "#{m.user.nick}: ##{quote["id"]} - #{quote["quote"]}"
+        elsif search.to_i != 0 # then we are searching be id
+          quote = quotes[(search.to_i - 1)]
+          if quote.nil?
+            m.reply "#{m.user.nick}: No quotes found."
+          else 
+            m.reply "#{m.user.nick}: ##{quote["id"]} - #{quote["quote"]}"
+          end
+        else 
+          quotes.keep_if{ |q| q["quote"].downcase.include?(search.downcase) }
+          if quotes.empty?
+            m.reply "#{m.user.nick}: No quotes found."
+          else
+            quote = quotes.first
+            m.reply "#{m.user.nick}: ##{quote["id"]} - #{quote["quote"]}"
+            m.reply "The search term also matched on quote IDs: #{quotes.map{|q| q["id"]}.join(", ")}" if quotes.size > 1
+          end
+        end
+      end
+
+      #--------------------------------------------------------------------------------
+      # Protected
+      #--------------------------------------------------------------------------------
+      
+      protected
+
+      def get_quotes
+        output = File.new(QUOTES_FILE, 'r')
+        quotes = YAML.load(output.read)
+        output.close
+
+        quotes
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: cinch-quotes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Caitlin Woodward
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: &70140338101780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70140338101780
+description: Gives Cinch IRC bots ability to manage quotes
+email:
+- caitlin@caitlinwoodward.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- cinch-quotes.gemspec
+- lib/cinch/plugins/quotes.rb
+homepage: https://github.com/caitlin/cinch-quotes
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Gives Cinch IRC bots ability to manage quotes
+test_files: []