githubissueswatcher 0.0.11

data/Gemfile

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

data/README.md

@@ -0,0 +1,109 @@
+## Github Issues Watcher
+
+Github issues watcher is a simple and useful gem that help you to constantly monitor your issues for both public and private repos.
+
+It is a fork of the excellent [githubwatcher](https://github.com/DAddYE/githubwatcher)
+
+It uses [foreverb](https://github.com/DAddYE/foreverb) to demonize the process.
+
+A [demonstration video is here](http://www.daddye.it/post/7275490125/github-growl)
+
+## Prerequisites
+
+You need to have **growlnotify** installed. To do that you can install it through official [site](http://growl.info) or
+if you have the awesome [brew](https://github.com/mxcl/homebrew) simply with:
+
+``` sh
+$ brew install growlnotify
+```
+
+## Installation ##
+
+You may need to manually stop the process and run ```githubissueswatcher start``` if you encounter errors.
+
+``` sh
+$ sudo gem install githubissueswatcher
+$ githubissueswatcher start
+$ githubissueswatcher config
+$ githubissueswatcher repos
+
+$ githubissueswatcher stop
+```
+
+## Configuration ##
+
+
+You need to enter in your username and password for Github in ```~/.githubissueswatcher/config.yaml```
+It's in plaintext so make sure this folder is secure.
+
+You need to tell to our program which repositories you want to watch, to do that simply edit ```~/.githubissueswatcher/repos.yaml```
+with your favorite editor.
+
+Should look like this (if you have ran ```githubissueswatcher start```)
+
+We provide a `config` command to easily edit it.
+
+``` sh
+$ githubissueswatcher config
+```
+
+It will open in texmate or vim this:
+
+``` yaml
+---
+- daddye/foreverb/mentioned-assigned
+- padrino/padrino-framework/all
+```
+The correct format is **username/repo/filters** where filters are separated by a '-'
+Filters include *mentioned*,*assigned*,*created* and *all*.
+Note: Issues where you are mentioned will be *sticky*
+So if for example you want to watch issues in [sinatra](https://github.com/sinatra/sinatra) where you are mentioned or assigned, the result should look like:
+
+``` yaml
+---
+- daddye/foreverb/mentioned-assigned
+- padrino/padrino-framework/all
+- sinatra/sinatra/mentioned-assigned
+```
+
+If you want to watch **all** issues of a repository of a given user you simply provide **/all** so will look like:
+
+``` yaml
+---
+- daddye/foreverb/mentioned-assigned
+- padrino/padrino-framework/all
+- sinatra/sinatra/all
+```
+
+Restart the deamon
+
+``` sh
+$ githubissueswatcher restart
+```
+
+## Working with Ruby Forever
+
+``` sh
+$ foreverb list
+PID    RSS    CPU  CMD
+12494  27132  0.2  Forever: /usr/bin/githubissueswatcher
+
+$ foreverb stop github
+Do you want really stop Forever: /usr/bin/githubissueswatcher  with pid 12494? y
+Killing process Forever: /usr/bin/githubissueswatcher  with pid 12494...
+```
+
+Your are done!
+
+## Hacks
+
+In some env you use `sudo gem install`, so in this case the first time you launch the app use `sudo`,
+in this way will be generated the `Gemfile.lock`, in future you will be able to run it without `sudo`.
+
+## Author ##
+
+Peter Gabbay (Artcentric)
+
+Original Github Issues:
+
+DAddYE, you can follow me on twitter [@daddye](http://twitter.com/daddye)

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rubygems' unless defined?(Gem)
+require 'bundler/gem_tasks'
+
+%w(install release).each do |task|
+  Rake::Task[task].enhance do
+    sh "rm -rf pkg"
+  end
+end
+
+desc "Bump version on github"
+task :bump do
+  puts "Nothing to commit (working directory clean)" and return if `git status -s`.strip == ""
+  if `git status -s`.strip == ""
+    puts "\e[31mNothing to commit (working directory clean)\e[0m"
+  else
+    version = Bundler.load_gemspec(Dir[File.expand_path('../*.gemspec', __FILE__)].first).version
+    sh "git add .; git commit -a -m \"Bump to version #{version}\""
+  end
+end
+
+task :release => :bump

data/bin/githubissueswatcher

@@ -0,0 +1,47 @@
+#!/usr/bin/ruby
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+
+require 'rubygems' unless defined?(Gem)
+require 'bundler/setup'
+require 'forever'
+require 'githubissueswatcher'
+
+while ARGV.size > 0
+  case arg = ARGV.shift
+    when "config"
+      editor = `which mate`.chomp! || `which vim`.chomp!
+      puts "Im unable to find an editor, open manually ~/.githubissueswatcher/config.yaml" and exit unless editor
+      system editor, File.expand_path('~/.githubissueswatcher/config.yaml') and exit
+    when "repos"
+      editor = `which mate`.chomp! || `which vim`.chomp!
+      puts "Im unable to find an editor, open manually ~/.githubissueswatcher/repos.yaml" and exit unless editor
+      system editor, File.expand_path('~/.githubissueswatcher/repos.yaml') and exit
+    when "reset"
+      system "rm -rf ~/.githubissueswatcher"
+  end
+end
+
+Forever.run do
+  # Our working directory, here we store pids/logs and obviously our list of repo to watch
+  dir File.expand_path('~/.githubissueswatcher')
+
+  on_error do |e|
+    unless (@_errors ||= []).include?(e.message)
+      Githubissueswatcher.notify("Error!", e.message, false)
+      @_errors << e.message
+    end
+  end
+
+  on_ready do
+    Githubissueswatcher.setup
+    Githubissueswatcher.notify("GitHub Issues Watcher", "was started...", false)
+  end
+
+  on_exit do
+    Githubissueswatcher.notify("GitHub Issues Watcher", "was stopped...", false)
+  end
+
+  every 30.seconds do
+    Githubissueswatcher.run
+  end
+end

data/githubissueswatcher.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*- #
+
+
+$:.push File.expand_path("../lib", __FILE__)
+require "githubissueswatcher/version"
+
+Gem::Specification.new do |s|
+  s.name        = "githubissueswatcher"
+  s.version     = Githubissueswatcher::VERSION
+  s.authors     = ["Peter Gabbay", "Davide D'Agostino"]
+  s.email       = ["peter@check2.com"]
+  s.homepage    = "https://github.com/Artcentric/githubissueswatcher"
+  s.summary     = "Github Issues Growl Watcher, watch any project issues and receive growl notification"
+  s.description = "Github Issues Growl Watcher, watch any project issues and receive growl notification based on whether you are mentioned, assigned or the creator."
+
+  s.rubyforge_project = "githubissueswatcher"
+
+  s.files         = Dir["**/*"].reject { |f| File.directory?(f) || f == "Gemfile.lock" }
+  s.test_files    = []
+  s.executables   = %w[githubissueswatcher]
+  s.require_paths = %w[lib]
+  s.add_dependency 'httparty', '~>0.7.8'
+  s.add_dependency 'growl',    '~>1.0.3'
+  s.add_dependency 'foreverb', '~>0.2.6'
+end

data/lib/githubissueswatcher.rb

@@ -0,0 +1,140 @@
+require 'yaml' unless defined?(YAML)
+require_relative "githubissueswatcher/version"
+require "httparty"
+require "growl"
+
+YAML::ENGINE.yamler = "syck" if defined?(YAML::ENGINE)
+
+module Githubissueswatcher
+  extend self
+  include HTTParty
+
+  CONFIG   = File.expand_path("~/.githubissueswatcher/config.yaml")
+  WATCH = File.expand_path("~/.githubissueswatcher/repos.yaml")
+  DB    = File.expand_path("~/.githubissueswatcher/db.yaml")
+
+  format :json
+
+  def setup
+    raise "You need to install growlnotify, use brew install growlnotify or install it from growl.info site" unless Growl.installed?
+    puts "Starting GitHub Issues Watcher..."
+    warn "If timeout occurs, your credentials may be wrong."
+
+    unless File.exist?(CONFIG)
+      Dir.mkdir(File.dirname(CONFIG)) unless File.exist?(File.dirname(CONFIG))
+      File.open(CONFIG, "w") { |f| f.write \
+        YAML.load("
+          api:
+            url: 'https://api.github.com'
+            version: 'v3'
+          user:
+            username:
+            password:
+        ").to_yaml }
+    end
+
+    unless File.exist?(WATCH)
+      warn "Add the repositories you're willing to monitor editing: ~/.githubissueswatcher/repos.yaml"
+      Dir.mkdir(File.dirname(WATCH)) unless File.exist?(File.dirname(WATCH))
+      File.open(WATCH, "w") { |f| f.write ["daddye/foreverb/mentioned-assigned", "padrino/padrino-framework/all"].to_yaml }
+    end
+    
+    unless File.exist?(DB)
+      Dir.mkdir(File.dirname(DB)) unless File.exist?(File.dirname(DB))
+      File.open(DB, "w") { |f| f.write (Time.now - 86400).to_yaml }
+    end
+    
+    @_watch = YAML.load_file(WATCH)
+    @_config = YAML.load_file(CONFIG)
+    @base_uri, @api_version = @_config['api']['url'], @_config['api']['version']
+    @username, @password = @_config['user']['username'], @_config['user']['password']
+    raise "Oops. You forgot your username/password in ~/.githubissueswatcher/config.yaml" if @username.nil? || @password.nil?
+    
+    @_db = DB # To accomodate testing
+
+    base_uri @base_uri
+    basic_auth @username, @password
+    
+  end
+
+  def start!
+    time_since = time_since_last_run
+    time_started = Time.now
+    Dir.mkdir(File.dirname(db)) unless File.exist?(File.dirname(db))
+    File.open(db, "w"){ |f| f.write time_started.to_yaml }
+    
+    issues_reported = []
+    
+    watch.each do |value|
+      key, value, filtered = *value.split("/")
+      filtered = filtered.split("-")
+      
+      if filtered.include?("mentioned")
+        m = get_mentioned_issues(key,value,time_since)
+        m.each do |issue|
+          issues_reported << issue["number"]
+          notify("Mentioned Issue - #{value}", issue["title"], true)
+        end
+      end
+      
+      a = get_all_issues(key,value,time_since)
+      a.each do |issue|
+        next if issues_reported.include?(issue["number"])
+        issues_reported << issue["number"]
+        if filtered.include?("assigned") && issue["assignee"] && issue["assignee"]["login"].downcase == config["user"]["username"].downcase
+          notify("Assigned Issue", issue["title"])
+          next
+        end
+        
+        if filtered.include?("created")  && issue["user"]["login"].downcase == config["user"]["username"].downcase
+          notify("Created Issue", issue["title"])
+          next
+        end
+        
+        if filtered.include?("all")
+          notify("Issue", issue["title"])
+          next
+        end
+      end
+    end
+
+  end
+  alias :run :start!
+
+  def time_since_last_run
+    File.exist?(db) ? YAML.load_file(db) : Time.now
+  end
+
+  def watch
+    @_watch ||= []
+  end
+  
+  def config
+    @_config
+  end
+  
+  def db
+    @_db
+  end
+
+  def notify(title, text, sticky=false)
+    Growl.notify(text, :title => title, :icon => File.expand_path("../../images/icon.png", __FILE__), :sticky => sticky)
+    puts "=> #{title}: #{text}"
+  end
+
+  def get_mentioned_issues(username, repo, since_time)
+    giw_get "/repos/#{username}/#{repo}/issues?mentioned=artcentric&since=#{since_time.round.iso8601}"
+  end
+  
+  def get_all_issues(username, repo, since_time)
+    giw_get "/repos/#{username}/#{repo}/issues?since=#{since_time.round.iso8601}"
+  end
+  
+  def giw_get(url)
+    response = get(url)
+    puts response
+    raise "Bad credentials. Check your username/password in ~/.githubissueswatcher/config.yaml" if response.is_a?(Hash) && response["message"] == "Bad credentials"
+    raise "Repo not found at #{url}. Check your repo in ~/.githubissueswatcher/repos.yaml. Also, you may not have proper credentials. Check config.yaml." if response.is_a?(Hash) && response["message"] == "Not Found"
+    return response
+  end
+end

data/lib/githubissueswatcher/version.rb

@@ -0,0 +1,3 @@
+module Githubissueswatcher
+  VERSION = "0.0.11"
+end

data/test/api.yaml

@@ -0,0 +1,7 @@
+--- 
+api: 
+  url: https://api.github.com
+  version: v3
+user: 
+  username: Artcentric
+  password: 'uQ.%:sd9#i0z.E0%:"Q5.I'

data/test/config.yaml

@@ -0,0 +1,7 @@
+--- 
+api: 
+  url: https://api.github.com
+  version: v3
+user: 
+  username: Artcentric
+  password: 'uQ.%:sd9#i0z.E0%:"Q5.I'

data/test/db.yaml

@@ -0,0 +1 @@
+--- 2011-10-10 23:39:49.804623 -07:00

data/test/repos.yaml

@@ -0,0 +1,2 @@
+--- 
+- Artcentric/check2/mentioned-created-assigned

data/test/run_test.rb

@@ -0,0 +1,29 @@
+require_relative 'test_helper'
+
+class RunTest < MiniTest::Unit::TestCase
+  include TestHelper
+  include HTTParty
+  
+  def setup
+    puts "Starting Test"
+    
+    # File.delete(Githubissueswatcher::CONFIG_TEST) if File.exists?(Githubissueswatcher::CONFIG_TEST)
+    # File.delete(Githubissueswatcher::WATCH_TEST) if File.exists?(Githubissueswatcher::WATCH_TEST)
+    File.delete(Githubissueswatcher::DB_TEST) if File.exists?(Githubissueswatcher::DB_TEST)
+    
+    Githubissueswatcher.setup
+    
+    @_watch = YAML.load_file(Githubissueswatcher::WATCH_TEST)
+    @_repos = YAML.load_file(Githubissueswatcher::DB_TEST) if File.exist?(Githubissueswatcher::DB_TEST)
+    @base_uri, @api_version = YAML.load_file(Githubissueswatcher::CONFIG_TEST)
+    
+  end
+  
+
+  
+  def test_run_tester
+    Githubissueswatcher.start!
+    assert_equal true,true
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,69 @@
+require 'rubygems' unless defined?(Gem)
+require_relative '../lib/githubissueswatcher'
+require 'minitest/autorun'
+
+module TestHelper
+  
+  def setup_files(api,watch)
+    
+    Dir.mkdir(File.dirname(api)) unless File.exist?(File.dirname(watch))
+    File.open(api, "w") { |f| f.write ["https://api.github.com", "v3"].to_yaml }
+
+    Dir.mkdir(File.dirname(watch)) unless File.exist?(File.dirname(watch))
+    File.open(watch, "w") { |f| f.write ["daddye/all", "padrino/all"].to_yaml }
+    
+  end
+  
+end
+
+module Githubissueswatcher
+  
+  this_dir = File.dirname(__FILE__)
+  puts this_dir
+
+  CONFIG_TEST   = File.expand_path("#{this_dir}/config.yaml")
+  WATCH_TEST = File.expand_path("#{this_dir}/repos.yaml")
+  DB_TEST    = File.expand_path("#{this_dir}/db.yaml")
+  
+  def self.setup
+    
+    warn "If timeout occurs, your credentials may be wrong."
+
+    unless File.exist?(CONFIG_TEST)
+      Dir.mkdir(File.dirname(CONFIG_TEST)) unless File.exist?(File.dirname(CONFIG_TEST))
+      File.open(CONFIG_TEST, "w") { |f| f.write \
+        YAML.load("
+          api:
+            url: 'https://api.github.com'
+            version: 'v3'
+          user:
+            username:
+            password: 
+        ").to_yaml }
+    end
+
+    unless File.exist?(WATCH_TEST)
+      warn "Add the repositories you're willing to monitor editing: ~/.githubissueswatcher/repos.yaml"
+      Dir.mkdir(File.dirname(WATCH_TEST)) unless File.exist?(File.dirname(WATCH_TEST))
+      File.open(WATCH_TEST, "w") { |f| f.write ["padrino/all"].to_yaml }
+    end
+
+    unless File.exist?(DB_TEST)
+      Dir.mkdir(File.dirname(DB_TEST)) unless File.exist?(File.dirname(DB_TEST))
+      File.open(DB_TEST, "w") { |f| f.write (Time.now - 86400).to_yaml }
+    end
+
+    @_watch = YAML.load_file(WATCH_TEST)
+    @_time_since = YAML.load_file(DB_TEST) if File.exist?(DB_TEST)
+    @_config = YAML.load_file(CONFIG_TEST)
+    @base_uri, @api_version = @_config['api']['url'], @_config['api']['version']
+    @username, @password = @_config['user']['username'], @_config['user']['password']
+    
+    @_db = DB_TEST
+
+    base_uri @base_uri
+    basic_auth @username, @password
+    
+  end
+  
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: githubissueswatcher
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 11
+  version: 0.0.11
+platform: ruby
+authors: 
+- Peter Gabbay
+- Davide D'Agostino
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 8
+        version: 0.7.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: growl
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 3
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: foreverb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 6
+        version: 0.2.6
+  type: :runtime
+  version_requirements: *id003
+description: Github Issues Growl Watcher, watch any project issues and receive growl notification based on whether you are mentioned, assigned or the creator.
+email: 
+- peter@check2.com
+executables: 
+- githubissueswatcher
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/githubissueswatcher
+- Gemfile
+- githubissueswatcher.gemspec
+- images/icon.png
+- lib/githubissueswatcher/version.rb
+- lib/githubissueswatcher.rb
+- pkg/githubissueswatcher-0.0.10.gem
+- pkg/githubissueswatcher-0.0.9.gem
+- Rakefile
+- README.md
+- test/api.yaml
+- test/config.yaml
+- test/db.yaml
+- test/repos.yaml
+- test/run_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/Artcentric/githubissueswatcher
+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: githubissueswatcher
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Github Issues Growl Watcher, watch any project issues and receive growl notification
+test_files: []
+