cinch-memo 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cinch-memo.gemspec
+gemspec

data/README.md

@@ -0,0 +1,76 @@
+Cinch-Memo
+===========
+
+The Cinch Memo Plugin. Store messages for users while they are away.
+
+Installation
+---------------------
+
+if you haven't already...
+
+    $ gem install cinch
+    
+then install this gem.
+
+    $ gem install cinch-memo
+
+Installation and Setup
+----------
+
+#### Configuration ####
+
+To setup the plugin to work with your cinch bot, we'll need to provide some info like so:
+
+    Cinch::Plugins::Memo::Base.configure do |c|
+      c.store   = :redis          # data store
+      c.host    = 'localhost'     # your host
+      c.port    = '6709'          # your port
+    end
+
+Currently, only Redis is available as a backend store.
+
+#### Commands ####
+
+  * !memo [nick] [message]    - stores the message for the user
+  * !memo?                    - returns memo's for your nick
+  
+## Integration with Cinch ##
+
+It's simple. follow the guide on cinch or do something like:
+    
+    # mybot.rb
+    require 'cinch'
+    require 'cinch-memo'
+
+    Cinch::Plugins::Memo::Base.configure do |c|
+      c.store   = :redis          # data store
+      c.host    = 'localhost'     # your host
+      c.port    = '6709'          # your port
+    end
+
+    bot = Cinch::Bot.new do
+      configure do |c|
+        c.server           = "irc.freenode.net"
+        c.nick             = "cinch"
+        c.channels         = ["#padrino"]
+        c.plugins.plugins  = [Cinch::Plugins::Memo::Base]
+      end
+
+    end
+
+    bot.start
+
+Finally, run your bot.
+
+    ruby -rubygems mybot.rb
+
+And there you go!
+
+
+TODO
+-----
+
+  * add auto deliver message functionality when you sign on.
+  * add rate limiting ability
+  * add additional backend stores.
+  * add some kind of auth mech

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/cinch-memo.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cinch-memo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cinch-memo"
+  s.version     = Cinch::Plugins::Memo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Arthur Chiu"]
+  s.email       = ["mr.arthur.chiu@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/cinch-memo"
+  s.summary     = %q{Memo Plugin for Cinch}
+  s.description = %q{Give your Cinch bot memo functionality!}
+
+  s.rubyforge_project = "cinch-memo"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'cinch'
+  s.add_dependency 'json'
+  s.add_dependency 'redis'
+  s.add_development_dependency 'riot', '~>0.12.0'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'timecop'
+end

data/lib/cinch-memo/base.rb

@@ -0,0 +1,53 @@
+module Cinch
+  module Plugins
+    module Memo
+      class Base
+        include Cinch::Plugin
+        attr_accessor :backend
+        
+        class << self
+          attr_accessor :store, :host, :port
+
+          def configure(&block)
+            yield self
+          end
+        end
+
+        def initialize(*args)
+          super
+          @backend = 
+            case self.class.store
+            when :redis then Cinch::Plugins::Memo::Redis.new(self.class.host, self.class.port)
+            else
+              self.class.store
+            end
+        end
+
+        match %r{memo (\S*) (.*)}, :method => :store_message
+        match %r{memo\?},          :method => :get_message
+
+        # Stores message to designated user.
+        def store_message(m, nick, message)
+          if nick == @bot.nick
+            m.reply "You can't store a message for me."
+          else
+            @backend.store(nick,m.user.nick, message)
+            m.reply "Message saved!"
+          end
+        end
+
+        # Gets messages for the designated user
+        def get_message(m)
+          messages = @backend.retrieve(m.user.nick)
+          unless messages.nil? || messages.empty?
+            messages.each { |msg| m.reply msg }
+          else
+            m.reply "There are no messages for you."
+          end
+        end
+
+      end # Base
+
+    end # Memo
+  end # Plugins
+end #Cinch

data/lib/cinch-memo/store/redis.rb

@@ -0,0 +1,25 @@
+require 'redis'
+require 'json'
+module Cinch
+  module Plugins
+    module Memo
+      class Redis
+
+        def initialize(host, port)
+          @backend = ::Redis.new(:host => host, :port => port)
+        end
+        
+        def store(recipient, sender, message)
+          @backend.sadd recipient, [sender, message, Time.now.to_s].to_json
+        end
+        
+        def retrieve(recipient)
+          messages = @backend.smembers recipient
+          @backend.del(recipient)
+          messages
+        end
+
+      end # Redis
+    end # Memo
+  end # Plugins
+end # Cinch

data/lib/cinch-memo/version.rb

@@ -0,0 +1,7 @@
+module Cinch
+  module Plugins
+    module Memo
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/cinch-memo.rb

@@ -0,0 +1,10 @@
+require 'cinch'
+
+module Cinch
+  module Plugins
+    module Memo
+      autoload :Base,   'cinch-memo/base'
+      autoload :Redis,  'cinch-memo/store/redis'
+    end
+  end
+end

data/test/base_test.rb

@@ -0,0 +1,78 @@
+require File.expand_path('../teststrap',__FILE__)
+
+context "Base" do
+  dont_register!
+  setup { @bot = mock() }
+  
+  helper :base do |store|
+    Cinch::Plugins::Memo::Base.configure do |c|
+      c.store = store
+    end
+    Cinch::Plugins::Memo::Base
+  end
+
+
+  context "#configure" do
+    setup { base(:redis) }
+    asserts(:store).equals :redis
+  end
+  
+  context "#initialize" do
+    setup { base(:redis).new(@bot) }
+    asserts_topic.assigns :backend
+  end
+  
+  context "#store_message" do 
+    setup do
+      @bot.expects(:nick).returns('bob')
+      @base = base(:redis).new(@bot)
+      @message = mock()
+    end
+    
+    context "with bot nick" do
+      setup { @message.expects(:reply).with("You can't store a message for me.").returns(true) }
+      asserts("that it doesn't save message for bot") { @base.store_message(@message,'bob','hey') }
+    end
+    
+    context "with non-bot nick" do
+      setup do
+        @replier = mock() ; @replier.expects(:nick).returns("chris")
+        @message.expects(:user).returns(@replier)
+        @message.expects(:reply).with("Message saved!").returns(true)
+        @backend = mock()
+        @backend.expects(:store).with('john','chris','hey')
+        @base.backend = @backend
+      end
+      asserts("that it does save message") { @base.store_message(@message, 'john', 'hey') }
+    end    
+  end
+  
+  context "#deliver_message" do 
+    setup do
+      @replier = mock() ; @replier.expects(:nick).returns('chris')
+      @message = mock() ; @message.expects(:user).returns(@replier)
+      @backend = mock()
+      @base = base(:redis).new(@bot)
+    end
+    
+    context "with message" do 
+      setup do
+        @backend.expects(:retrieve).with('chris').returns(["john: hey there!", "john: bye!"])
+        @base.backend = @backend
+        @message.expects(:reply).with("john: hey there!")
+        @message.expects(:reply).with("john: bye!")
+      end
+      asserts("that it returns message") { @base.get_message(@message) }
+    end
+    
+    context "without message" do 
+      setup do
+        @backend.expects(:retrieve).with('chris').returns([])
+        @base.backend = @backend
+        @message.expects(:reply).with("There are no messages for you.").returns(true)
+      end
+      asserts("that it says there aren't messages") { @base.get_message(@message) }
+    end
+  end
+  
+end

data/test/store/redis_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../../teststrap',__FILE__)
+require 'redis'
+context "Redis" do
+  dont_register!
+  setup { @bot = mock() }
+  
+  helper :base do
+    Cinch::Plugins::Memo::Base.configure do |c|
+      c.store = :redis
+      c.host  = 'localhost'
+      c.port  = '6709'
+    end
+    Cinch::Plugins::Memo::Base
+  end
+
+  context "#initialize" do
+    setup { ::Redis.expects(:new).with(:host => 'localhost', :port => '6709') }
+    setup { base.new(@bot) }
+    asserts_topic.assigns :backend
+  end
+
+  context "#store" do
+    setup do
+      Timecop.freeze(Time.now)
+      backend = mock() ; backend.expects(:sadd).with('bob', ['chris','yo yo', Time.now].to_json).returns(true)
+      ::Redis.expects(:new).with(:host => 'localhost', :port => '6709').returns(backend)
+      Cinch::Plugins::Memo::Redis.new('localhost','6709')
+    end
+    asserts("that it stores message") { topic.store('bob', 'chris','yo yo') }
+  end
+
+  context "#retrieve" do
+    setup do
+      Timecop.freeze(Time.now)
+      backend = mock() ; backend.expects(:smembers).with("bob").returns("\[\"a\",\"b\",\"c\"\]")
+      backend.expects(:del).with('bob').returns(true)
+      ::Redis.expects(:new).with(:host => 'localhost', :port => '6709').returns(backend)
+      Cinch::Plugins::Memo::Redis.new('localhost','6709')
+    end
+    asserts("that it retrieves message") { topic.retrieve('bob') }
+  end
+end

data/test/teststrap.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'json'
+require 'riot'
+require 'mocha'
+require 'timecop'
+require File.expand_path('../../lib/cinch-memo',__FILE__)
+
+class Riot::Situation
+  include Mocha::API
+end
+
+class Riot::Context
+  # Turn off bot register hook
+  def dont_register!
+    setup { Cinch::Plugins::Memo::Base.stubs(:__register_with_bot).with(any_parameters).returns(true) }
+  end
+end
+
+class Object
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+    result
+  end
+end

data/test.watchr

@@ -0,0 +1,70 @@
+ENV["WATCHR"] = "1"
+system 'clear'
+
+def growl(message)
+  growlnotify = `which growlnotify`.chomp
+  title = "Watchr Test Results"
+  image = message.include?('0 failures, 0 errors') ? "~/.watchr_images/passed.png" : "~/.watchr_images/failed.png"
+  options = "-w -n Watchr --image '#{File.expand_path(image)}' -m '#{message}' '#{title}'"
+  system %(#{growlnotify} #{options} &)
+end
+
+def run(cmd)
+  puts(cmd)
+  `#{cmd}`
+end
+
+def run_test_file(file)
+  system('clear')
+  result = run(%Q(ruby -I"lib:test" -rubygems #{file}))
+  growl result.split("\n").last rescue nil
+  puts result
+end
+
+def run_all_tests
+  system('clear')
+  result = run "rake test"
+  growl result.split("\n").last rescue nil
+  puts result
+end
+
+def run_all_features
+  system('clear')
+  run "cucumber"
+end
+
+def related_test_files(path)
+  Dir['test/**/*.rb'].select { |file| file =~ /#{File.basename(path).split(".").first}_test.rb/ }
+end
+
+def run_suite
+  run_all_tests
+  # run_all_features
+end
+
+watch('test/teststrap\.rb') { run_all_tests }
+watch('test/(.*).*_test\.rb') { |m| run_test_file(m[0]) }
+watch('lib/.*/.*\.rb') { |m| related_test_files(m[0]).map {|tf| run_test_file(tf) } }
+# watch('features/.*/.*\.feature') { run_all_features }
+
+# Ctrl-\
+Signal.trap 'QUIT' do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+
+@interrupted = false
+
+# Ctrl-C
+Signal.trap 'INT' do
+  if @interrupted then
+    @wants_to_quit = true
+    abort("\n")
+  else
+    puts "Interrupt a second time to quit"
+    @interrupted = true
+    Kernel.sleep 1.5
+    # raise Interrupt, nil # let the run loop catch it
+    run_suite
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: cinch-memo
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Arthur Chiu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-07 01:00:00 -07: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: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: riot
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 0
+        version: 0.12.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: Give your Cinch bot memo functionality!
+email: 
+- mr.arthur.chiu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- cinch-memo.gemspec
+- lib/cinch-memo.rb
+- lib/cinch-memo/base.rb
+- lib/cinch-memo/store/redis.rb
+- lib/cinch-memo/version.rb
+- test.watchr
+- test/base_test.rb
+- test/store/redis_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/cinch-memo
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      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: cinch-memo
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Memo Plugin for Cinch
+test_files: 
+- test/base_test.rb
+- test/store/redis_test.rb
+- test/teststrap.rb