cinch-github 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-github.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Arthur Chiu
+
+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,81 @@
+Cinch-Github
+===========
+
+The Cinch Github Plugin. Give your cinch bot abilities to interact with Github! This is still in its early phases!
+
+Installation
+---------------------
+
+if you haven't already...
+
+    $ gem install cinch
+    
+then install this gem.
+
+    $ gem install cinch-github
+
+Cinch::Plugins::Github
+----------
+
+### Issues ###
+
+This plugin manages interaction between Github issues via the Github API.
+
+#### Configuration ####
+
+To setup the Issue plugin to work with your cinch bot, we'll need to provide some info like so:
+
+    Cinch::Github::Issue.configure do |c|
+      c.user    = 'achiu'                   # your github username
+      c.token   = 'some_token'              # your github API token
+      c.author  = 'padrino'                 # your repository author
+      c.repo    = 'padrino-framework'       # your repository name
+    end
+
+#### Commands ####
+
+  * !issue state [open|closed] [query]    - returns issues that have state open or closed matching the query
+  * !issue find [query]                   - returns issues matching the query. defaults to state open
+  * !issue link [number]                  - returns issue link for issue number(must be digits)
+  * !help github issue                    - returns commands for Github Issue
+  
+
+
+## Integration with Cinch ##
+
+It's simple. follow the guide on cinch or do something like:
+    
+    # mybot.rb
+    require 'cinch'
+    require 'cinch-github'
+
+    Cinch::Plugins::Github::Issue.configure do |c|
+      c.user    = 'achiu'                   # your github username
+      c.token   = 'some_token'              # your github API token
+      c.author  = 'padrino'                 # your repository author
+      c.repo    = 'padrino-framework'       # your repository name
+    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::Github::Issue]
+      end
+
+    end
+
+    bot.start
+
+Finally, run your bot.
+
+    ruby -rubygems mybot.rb
+
+And there you go!
+
+
+TODO
+-----
+
+  * finish the other plugins for rest of Github API

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-github.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cinch-github/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cinch-github"
+  s.version     = Cinch::Plugins::Github::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Arthur Chiu"]
+  s.email       = ["mr.arthur.chiu@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/cinch-github"
+  s.summary     = %q{Github Plugin for Cinch}
+  s.description = %q{Cinch Plugin to let bots interact with Github}
+
+  s.rubyforge_project = "cinch-github"
+
+  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  'octopi'
+  s.add_development_dependency 'riot', '~>0.12.0'
+  s.add_development_dependency 'mocha'
+end

data/lib/cinch-github.rb

@@ -0,0 +1,7 @@
+module Cinch
+  module Plugins
+    module Github
+      autoload :Issue, 'cinch-github/issue'
+    end
+  end
+end

data/lib/cinch-github/issue.rb

@@ -0,0 +1,69 @@
+require 'octopi'
+require 'cinch'
+
+module Cinch
+  module Plugins
+    module Github
+      # Handles interaction with Issues API.
+      class Issue
+        include Cinch::Plugin
+        include Octopi
+
+        class << self
+          attr_accessor :user, :token, :author, :repo
+
+          def configure(&block)
+            yield self
+          end
+        end
+
+        match %r{help github issue},                :method => :display_help  # !issue help gitub issue
+        match %r{issue state (open|closed) (.*)},   :method => :get_ticket    # !issue state closed bugs
+        match %r{issue find (.*)},                  :method => :get_ticket    # !issue find sinatra
+        match %r{issue link (.*)},                  :method => :reply_link    # !issue link 35
+
+        # Display Github Issue Help
+        def display_help(m)
+          User(m.user.nick).send (<<-EOF).gsub(/^ {10}/,'')
+          !issue state [open|closed] [query] - query for a ticket with state closed
+          !issue find [query] - query for a ticket with state open
+          !issue link [number] - returns link for issue number.
+          EOF
+        end
+
+        # Find ticket with gieven
+        def get_ticket(m, *args)
+          query, state = args.reverse
+          results = search_issue CGI.escape(query), state
+          output m, results.first.last
+        end
+
+        # Return the link of the issue
+        def reply_link(m, arg)
+          arg =~ /\D+/ ? m.reply("You need to give me a number...") : m.reply(issue_link(arg))
+        end
+
+        # Use Github API and Search for the Issue
+        def search_issue(query, state = 'open')
+          authenticated_with :login => self.class.user, :token => self.class.token do
+            Octopi::Issue.search :user => self.class.author, :repo => self.class.repo, :state => state, :keyword => query
+          end
+        end
+
+        # Returns the issue as a link
+        def issue_link(number)
+          "https://www.github.com/#{self.class.author}/#{self.class.repo}/issues/#{number}"
+        end
+
+        private
+
+          # Outputs the reply back to screen
+          def output(m, results)
+            m.reply "#{results.size} Results"
+            results.each { |result| m.reply "#{result['title']} : #{issue_link(result['number'])}" }
+          end
+
+      end
+    end
+  end
+end

data/lib/cinch-github/version.rb

@@ -0,0 +1,7 @@
+module Cinch
+  module Plugins
+    module Github
+      VERSION = "0.0.1"
+    end
+  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

data/test/issue_test.rb

@@ -0,0 +1,113 @@
+require File.expand_path('../teststrap',__FILE__)
+
+context "Issue Plugin" do
+  helper :issue do
+    Cinch::Plugins::Github::Issue.configure do |c|
+      c.user    = 'achiu'
+      c.token   = 'my_token'
+      c.author  = 'achiu'
+      c.repo    = 'cinch-github'
+    end
+    Cinch::Plugins::Github::Issue
+  end
+
+  context "#configure" do
+    setup { issue }
+    asserts(:user).equals   'achiu'
+    asserts(:token).equals  'my_token'
+    asserts(:author).equals 'achiu'
+    asserts(:repo).equals   'cinch-github'
+  end
+
+  context "matches" do 
+    setup do
+      @issue = issue
+      mock_match @issue, %r{help github issue},                :display_help
+      mock_match @issue, %r{issue state (open|closed) (.*)},   :get_ticket
+      mock_match @issue, %r{issue find (.*)},                  :get_ticket
+      mock_match @issue, %r{issue link (.*)},                  :reply_link 
+    end
+    asserts("that it has matches") { @issue.new(Cinch::Bot.new) }
+  end
+
+
+  context "#issue_link" do
+    setup { issue.new(Cinch::Bot.new) }
+    asserts("that returns the correct issue") do
+      topic.issue_link(135)
+    end.equals 'https://www.github.com/achiu/cinch-github/issues/135'
+  end
+
+  context "#reply_link" do
+    setup { @m = mock() }
+
+    context "with number" do
+      setup { @m.expects(:reply).with("https://www.github.com/achiu/cinch-github/issues/1").returns(true) }
+      asserts("that it returns link") { issue.new(Cinch::Bot.new).reply_link(@m, '1') }
+    end
+
+    context "not a number" do
+      setup { @m.expects(:reply).with("You need to give me a number...").returns(true) }
+      asserts("that it returns a message") { issue.new(Cinch::Bot.new).reply_link(@m,'ab1cx2d') }
+    end
+  end
+
+  context "#display_help" do
+    setup do
+      @user    = mock() ; @user.expects(:send).with { |value| value =~ /\!issue/ }.returns(true)
+      @replier = mock() ; @replier.expects(:nick).returns("bob")
+      @message = mock() ; @message.expects(:user).returns(@replier)
+      @issue   = issue.new(Cinch::Bot.new) ; @issue.expects(:User).with("bob").returns(@user)
+    end
+    asserts("that it displays message") { @issue.display_help(@message) }
+  end
+
+  context "#get_ticket" do
+    
+    context "with closed state" do 
+      setup do
+        @issue = issue.new(Cinch::Bot.new)
+        @message = mock()
+        @issue.expects(:search_issue).with('bob','open').returns([[false,true], true])
+        @issue.expects(:output).with(@message, true).returns(true)
+      end
+      asserts("that it searches") { @issue.get_ticket(@message, 'open', 'bob') }
+    end
+
+    context "without state" do 
+      setup do
+        @issue   = issue.new(Cinch::Bot.new)
+        @message = mock()
+        @issue.expects(:search_issue).with('what+bob', nil).returns([[false,true], true])
+        @issue.expects(:output).with(@message, true).returns(true)
+      end
+      asserts("that it searches") { @issue.get_ticket(@message, 'what bob') }
+    end
+
+  end
+
+  context "#search_issue" do 
+    
+    context "with default" do 
+      setup do
+        @issue = issue.new(Cinch::Bot.new)
+        @issue.expects(:authenticated_with).with(:login => 'achiu',:token => 'my_token').returns(true)
+        params = {:user => 'achiu', :repo => 'cinch-github', :state => 'open', :keyword => 'bob'}
+        Octopi::Issue.expects(:search).with(params).returns(true)
+      end
+      asserts("that it searches with state open") { @issue.search_issue('bob') }
+    end
+  
+    context "with state" do 
+      setup do
+        @issue = issue.new(Cinch::Bot.new)
+        @issue.expects(:authenticated_with).with(:login => 'achiu', :token => 'my_token').returns(true)
+        params = { :user => 'achiu', :repo => 'cinch-github', :state => 'closed', :keyword => 'boo' }
+        Octopi::Issue.expects(:search).with(params).returns(true)
+      end
+      asserts("that it searches with state closed") { @issue.search_issue('bob', 'closed') }
+    end
+
+  end
+
+end

data/test/teststrap.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'riot'
+require 'mocha'
+require File.expand_path('../../lib/cinch-github',__FILE__)
+
+class Riot::Situation
+  include Mocha::API
+  
+  # Checks to see if plugin has the designated matches
+  # asserts_has_match @issue, /help/, :display_help
+  def mock_match(plugin, regex, method_name)
+    plugin.expects(:match).with(regex, :method => method_name).returns(true)
+  end
+  
+  
+end
+
+class Riot::Context
+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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: cinch-github
+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-05 00: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: octopi
+  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: riot
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 0
+        version: 0.12.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Cinch Plugin to let bots interact with Github
+email: 
+- mr.arthur.chiu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cinch-github.gemspec
+- lib/cinch-github.rb
+- lib/cinch-github/issue.rb
+- lib/cinch-github/version.rb
+- test.watchr
+- test/issue_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/cinch-github
+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-github
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Github Plugin for Cinch
+test_files: 
+- test/issue_test.rb
+- test/teststrap.rb