pra 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 990d69dd58accffc7a9a697b26589334785b0eed
+  data.tar.gz: e075ae03f303e947c04b7275d22cb3b58a72e03f
+SHA512:
+  metadata.gz: e6fc9ec8e865363b814e8e453a8918aeb1a483dae88ac5ad3fc37d64b5c410e7c7eb0cda259ef90f71e293eb518fd579f4a6f2369601f08c57b4f8e1f6ecdf33
+  data.tar.gz: f8b78ff247073c23f30e38df0a3601a6493a3c4490748572dc7d9eec0fefdee879fa9ec4293a0ac34094bddaa4b52435f10222064c4a6f900f673f84d0084c9c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+pra

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/ChangeLog.md

@@ -0,0 +1,22 @@
+# ChangeLog
+
+The following are lists of the notable changes included with each release.
+This is inteded to help keep people informed about notable changes between
+versions as well as provide a rough history.
+
+#### Next Release
+
+#### v0.1.1
+
+* Fixed up the gemspec to include homepage on rubygems.org
+
+#### v0.1.0
+
+This is the first public release. It includes the following:
+
+* Added ability to open selected pull request
+* Made Pull Requests in the list selectable
+* Listing of Pull Requests found to be open
+* Support for pulling Pull Requests from GitHub
+* Support for pulling Pull Requests from Stash
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,47 @@
+Copyright (c) 2013 Andrew De Ponte, ReachLocal, Inc.
+
+MIT License
+
+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.
+
+Dependency License
+
+rest-client
+
+Released under the MIT License: www.opensource.org/licenses/mit-license.php
+
+launchy
+
+ISC LICENSE - http://opensource.org/licenses/isc-license.txt
+
+Copyright (c) 2007-2013 Jeremy Hinegardner
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/README.md

@@ -0,0 +1,181 @@
+# pra - The Pull-Request Aggregator
+
+`pra` is a command line tool designed to allow developers to see the
+current state of open pull-requests across multiple services. Currently, it
+supports the following services:
+
+- [GitHub](http://github.com)
+- [Stash](http://www.atlassian.com/software/stash)
+
+## Installation
+
+You can easily install `pra` with the following command:
+
+    $ gem install pra
+
+## Configuration
+
+`pra` requires one configuration, `~/.pra.json`, to exist in your home
+directory. The following is an example config that can be used as a starter.
+*Note:* You will need to replace **your.username**, **your.password**,
+**your.stash.server**, and the **repositories** sections of each of the pull
+sources.
+
+    {
+      "pull_sources": [
+        {
+          "type": "stash",
+          "config": {
+            "protocol": "https",
+            "host": "your.stash.server",
+            "username": "your.username",
+            "password": "your.password",
+            "repositories": [
+              { "project_slug": "CAP", "repository_slug": "capture_api" },
+              { "project_slug": "RELENG", "repository_slug": "ramboo" }
+            ]
+          }
+        },
+        {
+          "type": "github",
+          "config": {
+            "protocol": "https",
+            "host": "api.github.com",
+            "username": "your.username",
+            "password": "your.password",
+            "repositories": [
+              { "owner": "reachlocal", "repository": "snapdragon" },
+              { "owner": "brewster", "repository": "cequel" }
+            ]
+          }
+        }
+      ]
+    }
+
+I suggest copying and pasting the above starter file into your `~/.pra.json`
+file to get you started. Then simply replace the appropriate fields and the
+**repositories** sections for all the pull sources with the repository
+information for the repositories you want to watch for open pull requests.
+
+## Usage
+
+Once you have configured `pra` as described above you can launch it by simply
+running the following command:
+
+    pra
+
+Once it launches, it will use the information provided in the `~/.pra.json`
+configuration file to fetch all the open pull requests and display them. Once,
+the pull requests are displayed you can perorm any of the following actions.
+
+### Move Selection Up
+
+To move the selection up simply press either the `k` or the `up arrow` key.
+
+### Move Selection Down
+
+To move the selection down simply press either the `j` or `down arrow` key.
+
+### Open Selected Pull Request
+
+If you would like to open the currently selected pull request in your default
+browser you can press either the `o` or `enter` key.
+
+### Quit
+
+If you decide you have had enough and  want to exit `pra` press the `q` key.
+
+## Contributing
+
+If you would like to contribute to the `pra` project. You can do so in the
+following areas:
+
+### Bug Reporting
+
+As with all software I am sure `pra` will have some bugs. I would very much
+appreciate any contributions of bug reports. These can be reported on the
+[issues page](http://github.com/reachlocal/pra/issues) of the project.
+
+### Feature Requests
+
+The current state of `pra` is just the MVP (minimum viable product). This
+means there is always room for growth. If you would like to contribute your
+thoughts on features that you would like `pra` to have you can submit them on
+the [issues page](http://github.com/reachlocal/pra/issues) of the project.
+
+### Improve Documentation
+
+If you would like to contribute documentation improvements you should follow
+the directions below.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Writing Code
+
+If you want to contribute by writing code for `pra` you need to know the
+following:
+
+##### Overview
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+##### RVM
+
+We use [RVM](http://rvm.io/) with `pra` to encapsulate the dependency gems in our
+development environments. Therefore, we have the `.ruby-version` and
+`.ruby-gemset` files in the repository which define the current version of
+ruby and the gemset that we are developing with.
+
+You should have [RVM](http://rvm.io) installed of course and when you change
+into the project root directory it should switch to the proper ruby version if
+you have it intsalled via [RVM](http://rvm.io). It should also create and
+switch to the proper gemset.
+
+If the proper version of ruby is NOT installed via [RVM](http://rvm.io) you
+should first install that version of ruby and then change out of the project
+root directory, then change back into it and verify that you are in the
+proper ruby version and gemset. This can be done with the following command.
+
+    rvm current
+
+The above command should have output the following
+
+    ruby-2.0.0-p247@pra
+
+##### Bundler
+
+We use [Bundler](http://bundler.io/) to manage the development dependencies of
+`pra`. Once you got setup with [RVM](http://rvm.io) as described above you
+should be able to install all the development dependencies using the following
+command:
+
+    bundle
+
+##### Test Driven Development
+
+I eveloped `pra` using the TDD methodology with
+[RSpec](http://www.relishapp.com/rspec) as the testing tool of choice.
+Therefore, if you are going to contribute code to `pra` please TDD your code
+changes using [RSpec](http://www.relishapp.com/rspec). If you do not submit
+your changes with test coverage your request will likely be denied requesting
+you add appropriate test coverage.
+
+##### Run Development Version Manually
+
+If you have setup [RVM](http://rvm.io) as described above and installed the
+development dependencies using [Bundler](http://bundler.io/) as described
+above you should be able to run the development version of `pra` by running
+the following command:
+
+    ./bin/pra
+
+*Note:* The above of course assumes that you have a `~/.pra.json` file
+already configured.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/pra

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift ::File.expand_path(::File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+
+require 'pra/app'
+
+app = Pra::App.new
+app.run

data/lib/pra/app.rb

@@ -0,0 +1,36 @@
+require 'thread'
+
+require 'pra/window_system_factory'
+require 'pra/pull_request_service'
+
+Thread.abort_on_exception=true
+
+module Pra
+  class App
+    def run
+      @window_system = Pra::WindowSystemFactory.build('curses')
+      @window_system.setup
+
+      spawn_pull_request_fetcher
+
+      @window_system.run_loop
+    end
+
+    def spawn_pull_request_fetcher
+      Thread.new { pull_request_fetcher_thread }
+    end
+
+    def fetch_and_refresh_pull_requests
+      @window_system.fetching_pull_requests
+      pull_requests = Pra::PullRequestService.fetch_pull_requests
+      @window_system.refresh_pull_requests(pull_requests)
+      Kernel.sleep(5 * 60)
+    end
+
+    def pull_request_fetcher_thread
+      while( true ) do
+        fetch_and_refresh_pull_requests
+      end
+    end
+  end
+end

data/lib/pra/config.rb

@@ -0,0 +1,40 @@
+require 'json'
+
+module Pra
+  class Config
+    def initialize(initial_config = {})
+      @initial_config = initial_config
+    end
+
+    def self.load_config
+      return self.new(self.parse_config_file)
+    end
+
+    def self.parse_config_file
+      self.json_parse(self.read_config_file)
+    end
+
+    def self.read_config_file
+      file = File.open(self.config_path, "r")
+      contents = file.read
+      file.close
+      return contents
+    end
+
+    def self.config_path
+      return File.join(self.users_home_directory, '.pra.json')
+    end
+
+    def self.users_home_directory
+      return ENV['HOME']
+    end
+
+    def self.json_parse(content)
+      return JSON.parse(content)
+    end
+
+    def pull_sources
+      @initial_config["pull_sources"]
+    end
+  end
+end

data/lib/pra/curses_window_system.rb

@@ -0,0 +1,124 @@
+require 'pra/window_system'
+require 'launchy'
+require 'curses'
+require 'thread'
+
+module Pra
+  class CursesWindowSystem < Pra::WindowSystem
+    ENTER_KEY = 10
+
+    def initialize
+      @selected_pull_request_index = 0
+      @current_pull_requests = []
+      @previous_number_of_pull_requests = 0
+      @state_lock = Mutex.new
+    end
+
+    def setup
+      initialize_screen_settings
+      display_instructions
+      output_string(3, 0, "0 Pull Requests")
+    end
+
+    def fetching_pull_requests
+      output_string(3, 0, "Fetching pull requests...")
+    end
+
+    def refresh_pull_requests(pull_requests)
+      @previous_number_of_pull_requests = @current_pull_requests.length
+
+      @state_lock.synchronize {
+        @current_pull_requests = pull_requests.dup
+      }
+      draw_current_pull_requests
+    end
+
+    def run_loop
+      c = Curses.getch()
+      while (c != 'q') do
+        case c
+        when 'j', Curses::Key::DOWN
+          move_selection_down
+          draw_current_pull_requests
+        when 'k', Curses::Key::UP
+          move_selection_up
+          draw_current_pull_requests
+        when 'o', ENTER_KEY
+          @state_lock.synchronize {
+            Launchy.open(@current_pull_requests[@selected_pull_request_index].link)
+          }
+        end
+        c = Curses.getch()
+      end
+
+      Curses.close_screen
+    end
+
+    private
+
+    def initialize_screen_settings
+      Curses.noecho # do not show typed keys
+      Curses.init_screen
+      Curses.stdscr.keypad(true)
+      Curses.start_color
+      Curses.curs_set(0)
+      Curses.init_pair(1, Curses::COLOR_CYAN, Curses::COLOR_BLACK)
+    end
+    
+    def output_string(row, col, str)
+      Curses.setpos(row, col)
+      Curses.clrtoeol
+      Curses.addstr(str)
+      Curses.refresh
+    end
+
+    def output_highlighted_string(row, col, str)
+      Curses.attron(Curses.color_pair(1)|Curses::A_NORMAL) {
+        output_string(row, col, str)
+      }
+    end
+
+    def display_instructions
+      output_string(0, 0, "Pra: Helping you own pull requests")
+      output_string(1, 0, "quit: q, up: k|#{"\u25B2".encode("UTF-8")}, down: j|#{"\u25BC".encode("UTF-8")}, open: o|#{"\u21A9".encode("UTF-8")}")
+    end
+
+    def move_selection_up
+      @state_lock.synchronize {
+        if @selected_pull_request_index > 0
+          @selected_pull_request_index -= 1
+        end
+      }
+    end
+
+    def move_selection_down
+      @state_lock.synchronize {
+        if @selected_pull_request_index < @current_pull_requests.length-1
+          @selected_pull_request_index += 1
+        end
+      }
+    end
+
+    def draw_current_pull_requests
+      @state_lock.synchronize {
+        output_string(3, 0, "#{@current_pull_requests.length} Pull Requests")
+        output_string(5, 0, "repository      title                   from_reference          to_reference            author                  service")
+        output_string(6, 0, "--------------------------------------------------------------------------------------------------------------------------------")
+        
+        (7...7+@previous_number_of_pull_requests).each do |i|
+          Curses.setpos(i,0)
+          Curses.clrtoeol
+          Curses.refresh
+        end
+
+        @current_pull_requests.each_with_index do |pull_request, index|
+          if index == @selected_pull_request_index
+            output_highlighted_string(7 + index, 0, "#{pull_request.repository.ljust(15)[0..14]}\t#{pull_request.title.ljust(20)[0..19]}\t#{pull_request.from_reference.ljust(20)[0..19]}\t#{pull_request.to_reference.ljust(20)[0..19]}\t#{pull_request.author.ljust(20)[0..19]}\t#{pull_request.service_id.ljust(10)[0..9]}")
+          else
+            output_string(7 + index, 0, "#{pull_request.repository.ljust(15)[0..14]}\t#{pull_request.title.ljust(20)[0..19]}\t#{pull_request.from_reference.ljust(20)[0..19]}\t#{pull_request.to_reference.ljust(20)[0..19]}\t#{pull_request.author.ljust(20)[0..19]}\t#{pull_request.service_id.ljust(10)[0..9]}")
+          end
+        end
+      }
+    end
+  end
+end

data/lib/pra/github_pull_source.rb

@@ -0,0 +1,36 @@
+require 'pra/pull_source'
+require 'pra/pull_request'
+require 'rest_client'
+require 'json'
+
+module Pra
+  class GithubPullSource < Pra::PullSource
+    def pull_requests
+      requests = []
+      repositories.each do |repo_config|
+        requests.concat(get_repo_pull_requests(repo_config))
+      end
+      return requests
+    end
+
+    def repositories
+      @config["repositories"]
+    end
+
+    def get_repo_pull_requests(repository_config)
+      requests = []
+      JSON.parse(rest_api_pull_request_resource(repository_config).get).each do |request|
+        requests << Pra::PullRequest.new(title: request["title"], from_reference: request["head"]["label"], to_reference: request["base"]["label"], author: request["user"]["login"], link: request['html_url'], service_id: 'github', repository: repository_config["repository"])
+      end
+      return requests
+    end
+
+    def rest_api_pull_request_url(repository_config)
+      "#{@config['protocol']}://#{@config['host']}/repos/#{repository_config["owner"]}/#{repository_config["repository"]}/pulls"
+    end
+
+    def rest_api_pull_request_resource(repository_config)
+      RestClient::Resource.new(rest_api_pull_request_url(repository_config), user: @config['username'], password: @config['password'], content_type: :json, accept: :json)
+    end
+  end
+end

data/lib/pra/pull_request.rb

@@ -0,0 +1,15 @@
+module Pra
+  class PullRequest
+    attr_accessor :title, :from_reference, :to_reference, :author, :link, :service_id, :repository
+
+    def initialize(attributes={})
+      @title = attributes[:title]
+      @from_reference = attributes[:from_reference]
+      @to_reference = attributes[:to_reference]
+      @author = attributes[:author]
+      @link = attributes[:link]
+      @service_id = attributes[:service_id]
+      @repository = attributes[:repository]
+    end
+  end
+end

data/lib/pra/pull_request_service.rb

@@ -0,0 +1,27 @@
+require 'pra/config'
+require 'pra/pull_source_factory'
+
+module Pra
+  module PullRequestService
+    def self.fetch_pull_requests
+      pull_requests = []
+      pull_sources.each do |pull_source|
+        pull_requests.concat(pull_source.pull_requests)
+      end
+      return pull_requests
+    end
+
+    def self.pull_sources
+      config = Pra::Config.load_config
+      return map_config_to_pull_sources(config)
+    end
+
+    def self.map_config_to_pull_sources(config)
+      sources = []
+      config.pull_sources.each do |pull_source_config|
+        sources << Pra::PullSourceFactory.build_pull_source(pull_source_config)
+      end
+      return sources
+    end
+  end
+end

data/lib/pra/pull_source.rb

@@ -0,0 +1,17 @@
+module Pra
+  class PullSource
+    class NotImplemented < RuntimeError; end
+
+    def initialize(config = {})
+      @config = config
+    end
+
+    # This method is a pure virtual method and is intended to implemented by
+    # all inheriting classes. It is responsible for obtaining and returning
+    # the opened pull requests from the pull source. Note: These should be
+    # returned as an array of Pra::PullRequest instances.
+    def pull_requests
+      raise NotImplemented, "The 'pull_requests' method needs to be implemented by the inheriting class"
+    end
+  end
+end

data/lib/pra/pull_source_factory.rb

@@ -0,0 +1,20 @@
+require 'pra/stash_pull_source'
+require 'pra/github_pull_source'
+
+module Pra
+  module PullSourceFactory
+    def self.build_pull_source(pull_source_config)
+      klass = map_type_to_klass(pull_source_config["type"])
+      klass.new(pull_source_config["config"])
+    end
+
+    def self.map_type_to_klass(type)
+      case type
+      when 'stash'
+        return StashPullSource
+      when 'github'
+        return GithubPullSource
+      end
+    end
+  end
+end

data/lib/pra/stash_pull_source.rb

@@ -0,0 +1,36 @@
+require 'pra/pull_source'
+require 'pra/pull_request'
+require 'rest_client'
+require 'json'
+
+module Pra
+  class StashPullSource < Pra::PullSource
+    def pull_requests
+      requests = []
+      repositories.each do |repo_config|
+        requests.concat(get_repo_pull_requests(repo_config))
+      end
+      return requests
+    end
+
+    def repositories
+      @config["repositories"]
+    end
+
+    def get_repo_pull_requests(repository_config)
+      requests = []
+      JSON.parse(rest_api_pull_request_resource(repository_config).get)["values"].each do |request|
+        requests << Pra::PullRequest.new(title: request["title"], from_reference: request["fromRef"]["id"], to_reference: request["toRef"]["id"], author: request["author"]["user"]["name"], link: "#{@config['protocol']}://#{@config['host']}#{request['link']['url']}", service_id: 'stash', repository: repository_config["repository_slug"])
+      end
+      return requests
+    end
+
+    def rest_api_pull_request_url(repository_config)
+      "#{@config['protocol']}://#{@config['host']}/rest/api/1.0/projects/#{repository_config["project_slug"]}/repos/#{repository_config["repository_slug"]}/pull-requests"
+    end
+
+    def rest_api_pull_request_resource(repository_config)
+      RestClient::Resource.new(rest_api_pull_request_url(repository_config), user: @config['username'], password: @config['password'], content_type: :json, accept: :json)
+    end
+  end
+end

data/lib/pra/version.rb

@@ -0,0 +1,3 @@
+module Pra
+  VERSION = "0.1.1"
+end