github-control 0.9.0

data/bin/github-control

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/github-control'
+
+GithubControl::CLI.execute(ARGV)

data/config/example.yml

@@ -0,0 +1,5 @@
+---
+user:
+  name: fakie
+  token: fakie
+  password: fakie

data/lib/github-control.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+
+begin
+  require 'json'
+rescue LoadError
+  require 'rubygems'
+  require 'json'
+end
+
+require 'rest_client'
+require 'nokogiri'
+
+module GithubControl
+  class Error < StandardError; end
+  class APIError < Error; end
+  class ProblemWithOptions < Error; end
+end
+
+$:.unshift File.dirname(__FILE__)
+
+require 'github-control/version'
+require 'github-control/cli'
+require 'github-control/console'
+require 'github-control/user'
+require 'github-control/repository'
+require 'github-control/repositories'
+require 'github-control/collaborators'
+require 'github-control/post_receive_urls'
+
+require 'github-control/action'
+require 'github-control/actions/repositories'
+require 'github-control/actions/shell'
+require 'github-control/actions/collaborators'
+require 'github-control/actions/add_collaborators'
+require 'github-control/actions/remove_collaborators'

data/lib/github-control/action.rb

@@ -0,0 +1,19 @@
+module GithubControl
+  class Action
+    def initialize(cli)
+      @cli = cli
+    end
+
+    def options
+      @options ||= {}
+    end
+
+    def add_options(parser)
+      raise NotImplementedError, "Please implement the #{self.class}#add_options method"
+    end
+
+    def call
+      raise NotImplementedError, "Please implement the #{self.class}#call method"
+    end
+  end
+end

data/lib/github-control/actions/add_collaborators.rb

@@ -0,0 +1,34 @@
+module GithubControl
+  module Actions
+    class AddCollaborators < Action
+      def add_options(parser)
+        parser.on("-R name", "--repository name", "The repository on Github") do |repository_name|
+          options[:repository_name] = repository_name
+        end
+
+        parser.on("-U name", "--user name", "The user on Github") do |user_name|
+          options[:user_name] = user_name
+        end
+      end
+
+      def call
+        puts "Adding #{user.name} to the collaborators of #{repository.full_name}"
+        puts "-" * 40
+        if repository.collaborators.include?(user)
+          puts "#{user.name} is already a collaborator"
+        else
+          repository.collaborators << user
+          puts "Done"
+        end
+      end
+
+      def repository
+        @cli.console.current_user.repo_for(options[:repository_name] || raise(ProblemWithOptions, "Please specify a repository"))
+      end
+
+      def user
+        @cli.console.user_for(options[:user_name] || raise(ProblemWithOptions, "Please specify a user"))
+      end
+    end
+  end
+end

data/lib/github-control/actions/collaborators.rb

@@ -0,0 +1,31 @@
+module GithubControl
+  module Actions
+    class Collaborators < Action
+      def add_options(parser)
+        parser.on("-R name", "--repository name", "The repository on Github") do |repository_name|
+          options[:repository_name] = repository_name
+        end
+
+        parser.on("-U name", "--user name", "The user on Github") do |user_name|
+          options[:user_name] = user_name
+        end
+      end
+
+      def call
+        puts "Listing the collaborators of #{repository.full_name}"
+        puts "-" * 40
+        repository.collaborators.each do |user|
+          puts "- #{user.name}"
+        end
+      end
+
+      def repository
+        user.repo_for(options[:repository_name] || raise(ProblemWithOptions, "Please specify a repository"))
+      end
+
+      def user
+        @cli.console.user_for(options[:user_name] || raise(ProblemWithOptions, "Please specify a user"))
+      end
+    end
+  end
+end

data/lib/github-control/actions/remove_collaborators.rb

@@ -0,0 +1,34 @@
+module GithubControl
+  module Actions
+    class RemoveCollaborators < Action
+      def add_options(parser)
+        parser.on("-R name", "--repository name", "The repository on Github") do |repository_name|
+          options[:repository_name] = repository_name
+        end
+
+        parser.on("-U name", "--user name", "The user on Github") do |user_name|
+          options[:user_name] = user_name
+        end
+      end
+
+      def call
+        puts "Removing #{user.name} from the collaborators of #{repository.full_name}"
+        puts "-" * 40
+        unless repository.collaborators.include?(user)
+          puts "#{user.name} is not a collaborator"
+        else
+          repository.collaborators.delete(user)
+          puts "Done"
+        end
+      end
+
+      def repository
+        @cli.console.current_user.repo_for(options[:repository_name] || raise(ProblemWithOptions, "Please specify a repository"))
+      end
+
+      def user
+        @cli.console.user_for(options[:user_name] || raise(ProblemWithOptions, "Please specify a user"))
+      end
+    end
+  end
+end

data/lib/github-control/actions/repositories.rb

@@ -0,0 +1,23 @@
+module GithubControl
+  module Actions
+    class Repositories < Action
+      def add_options(parser)
+        parser.on("-U name", "--user name", "The user to list the repositories") do |user_name|
+          options[:user_name] = user_name
+        end
+      end
+
+      def call
+        puts "Repositories for #{user.name}"
+        puts "-" * 40
+        user.repositories.each do |repo|
+          puts "- #{repo.name}"
+        end
+      end
+
+      def user
+        @cli.console.user_for(options[:user_name] || @cli.console.current_user.name)
+      end
+    end
+  end
+end

data/lib/github-control/actions/shell.rb

@@ -0,0 +1,17 @@
+require 'irb'
+
+module GithubControl
+  module Actions
+    class Shell < Action
+      def add_options(parser)
+      end
+
+      def call
+        console = @cli.console
+        puts "You are now able to interact with Github via the 'github' method"
+        Object.send(:define_method, :github) { console }
+        IRB.start
+      end
+    end
+  end
+end

data/lib/github-control/cli.rb

@@ -0,0 +1,105 @@
+require 'optparse'
+
+module GithubControl
+  class CLI
+    def self.execute(args)
+      new(args).run
+    end
+
+    def initialize(args)
+      @args = args
+    end
+
+    def run
+      current_action.add_options(option_parser)
+      option_parser.parse!(@args)
+      current_action.call
+    rescue ProblemWithOptions, OptionParser::ParseError => e
+      puts e.backtrace
+      $stderr.puts
+      $stderr.puts e.message
+      $stderr.puts
+      $stderr.puts option_parser
+      exit 2
+    end
+
+    def current_action
+      @current_action ||= create_action
+    end
+
+    def create_action
+      case action_name
+      when "list"
+        Actions::Repositories.new(self)
+      when "shell"
+        Actions::Shell.new(self)
+      when "collab"
+        Actions::Collaborators.new(self)
+      when "add_collab"
+        Actions::AddCollaborators.new(self)
+      when "remove_collab"
+        Actions::RemoveCollaborators.new(self)
+      else
+        raise ProblemWithOptions, "#{action_name} is not a valid action"
+      end
+    end
+
+    def action_name
+      @action_name ||= @args.shift || raise(ProblemWithOptions, "Please provide an action to run")
+    end
+
+    def console
+      @console ||= Console.new(user_config)
+    end
+
+    def user_config
+      config["user"] || raise(ProblemWithOptions, "You need to provide user data in the YAML file")
+    end
+
+    def config
+      @config ||= YAML.load_file(config_filename)
+    end
+
+    def config_filename
+      options[:config_filename] || raise(ProblemWithOptions, "You need to provide the path to the YAML filename")
+    end
+
+    def options
+      @options ||= {
+        :debug => false,
+        :argv => @args,
+      }
+    end
+
+    def option_parser
+      @option_parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: github-control #{@action_name || '[action]'} [options] ..."
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          $stderr.puts opts
+          exit
+        end
+
+        opts.on("--debug", "Display debugging information") {
+          options[:debug] = true
+          $debug = true
+        }
+
+        opts.on("-c filename", "--config filename", "Load the config from this YAML file") do |filename|
+          options[:config_filename] = filename
+        end
+
+        opts.on("-v", "--version", "Display the github version, and exit.") do
+          puts "Github Control version #{GithubControl::VERSION}"
+          exit
+        end
+
+        opts.separator ""
+      end
+    end
+
+    def inspect
+      "#<#{self.class} logged in as #{current_user.name.inspect}>"
+    end
+  end
+end

data/lib/github-control/collaborators.rb

@@ -0,0 +1,36 @@
+module GithubControl
+  class Collaborators
+    include Enumerable
+
+    attr_reader :repository
+
+    def initialize(repository)
+      @repository = repository
+    end
+
+    def create(user)
+      @repository.owner.cli.post("/repos/collaborators/" \
+        "#{@repository.name}/add/#{user}")
+    end
+
+    def delete(user)
+      @repository.owner.cli.post("/repos/collaborators/" \
+        "#{@repository.name}/remove/#{user}")
+    end
+
+    def each(&block)
+      set.each(&block)
+    end
+
+    def set
+      @set ||= json_data["collaborators"].map { |name|
+        @repository.owner.cli.user_for(name)
+      }
+    end
+
+    def json_data
+      @repository.owner.cli.post("/repos/show/" \
+        "#{@repository.owner.name}/#{@repository.name}/collaborators")
+    end
+  end
+end

data/lib/github-control/console.rb

@@ -0,0 +1,63 @@
+module GithubControl
+  class Console
+    def initialize(user_config)
+      @user_config = user_config
+      @users = {}
+    end
+
+    def current_user
+      @current_user ||= user_for(user_name)
+    end
+
+    def user_for(name)
+      @users[name] ||= User.new(self, name)
+    end
+
+    def post(path, params={})
+      params.merge!(:login => user_name, :token => user_token)
+      data = JSON.parse(RestClient.post(url_for(path), params))
+      if error = data["error"]
+        raise APIError, error.first["error"]
+      else
+        data
+      end
+    end
+
+    def get(path, params={})
+      RestClient.get(url_for(path), params)
+    end
+
+    def url_for(path)
+      "http://github.com/api/v2/json#{path}"
+    end
+
+    def cookies
+      @cookies ||= session_cookie
+    end
+
+    def session_cookie
+      response = raw_post("/session", {:login => user_name,
+        :password => user_password}, {}, :auto_redirect => false)
+      response.headers[:set_cookie].split(";").first
+    end
+
+    def user_name
+      @user_config["name"] ||
+        raise(ProblemWithOptions, "You need to provide the user name in the YAML file")
+    end
+
+    def user_token
+      @user_config["token"] ||
+        raise(ProblemWithOptions, "You need to provide the user token in the YAML file")
+    end
+
+    def user_password
+      @user_config["password"] ||
+        raise(ProblemWithOptions, "You need to provide the user password in the YAML file")
+    end
+
+    def inspect
+      "#<#{self.class} logged in as #{current_user.name.inspect}>"
+    end
+  end
+end

data/lib/github-control/post_receive_urls.rb

@@ -0,0 +1,54 @@
+module GithubControl
+  class PostReceiveUrls
+    include Enumerable
+
+    def initialize(repository)
+      @repository = repository
+    end
+    attr_reader :repository
+
+    def <<(url)
+      update_with(set + [url])
+    end
+
+    def delete(url)
+      update_with(set - [url])
+    end
+
+    def clear
+      update_with([])
+    end
+
+    def update_with(urls)
+      form_data = []
+      urls.each do |url|
+        value = URI.escape(url.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+        form_data << "urls[]=#{value}"
+      end
+      @repository.owner.cli.scrape_post("/#{@repository.owner.name}/#{@repository.name}/edit/postreceive_urls",
+                                        form_data.join("&"), :accept => 'text/javascript')
+    end
+
+    def empty?
+      set.empty?
+    end
+
+    def each(&block)
+      set.each(&block)
+    end
+
+    def set
+      set = []
+      doc = Nokogiri::HTML(html_data)
+      doc.search("fieldset#postreceive_urls.service-hook form p input[name='urls[]']").each do |input|
+        set << input["value"] if input["value"]
+      end
+      set
+    end
+
+    def html_data
+      @repository.owner.cli.scrape_get("/#{@repository.owner.name}/#{@repository.name}/edit/hooks")
+    end
+  end
+end
+

data/lib/github-control/repositories.rb

@@ -0,0 +1,61 @@
+module GithubControl
+  class Repositories
+    include Enumerable
+
+    def initialize(user)
+      @user  = user
+    end
+
+    def create(name, access)
+      @user.cli.post("/repos/create",
+        :name    => name,
+        :public  => access == :public ? 1 : 0
+      )
+
+      repo = Repository.new(@user, name, access)
+      set << repo
+      repo
+    end
+
+    def [](name)
+      set.detect { |r| r.name == name }
+    end
+
+    def delete(name)
+      response = @user.cli.post("/repos/delete/#{name}")
+      @user.cli.post("/repos/delete/#{name}",
+        :delete_token => response["delete_token"])
+      any? && set.delete(name)
+    end
+
+    def destroy
+      each { |r| delete(r.name) }
+    end
+
+    def each(&block)
+      set.each(&block)
+    end
+
+    def clear
+      @set = nil
+    end
+
+    def empty?
+      ! any?
+    end
+
+    def size
+      set.size
+    end
+
+    private
+      def set
+        @set ||= @user.cli.post("/repos/show/#{@user.name}")["repositories"].
+          sort_by { |r| r["name"] }.
+          map { |r|
+            access = r["private"] ? :private : :public
+            Repository.new(@user, r["name"], access)
+          }
+      end
+  end
+end

data/lib/github-control/repository.rb

@@ -0,0 +1,33 @@
+module GithubControl
+  class Repository
+    attr_reader :owner, :name, :access
+
+    def initialize(owner, name, access)
+      @owner, @name, @access = owner, name, access
+    end
+
+    def private?
+      @access == :private
+    end
+
+    def public?
+      @access == :public
+    end
+
+    def full_name
+      "#{@owner.name}/#{@name}"
+    end
+
+    def collaborators
+      @collaborators ||= Collaborators.new(self)
+    end
+
+    def post_receive_urls
+      @post_receive_urls ||= PostReceiveUrls.new(self)
+    end
+
+    def destroy
+      @owner.repositories.delete(@name)
+    end
+  end
+end

data/lib/github-control/user.rb

@@ -0,0 +1,21 @@
+module GithubControl
+  class User
+    attr_reader :cli, :name
+
+    def initialize(cli, name)
+      @cli, @name = cli, name
+    end
+
+    def repositories
+      @repos ||= Repositories.new(self)
+    end
+
+    def public_repositories
+      repositories.select { |r| r.public? }
+    end
+
+    def private_repositories
+      repositories.select { |r| r.private? }
+    end
+  end
+end

data/lib/github-control/version.rb

@@ -0,0 +1,3 @@
+module GithubControl
+  VERSION = "0.9.0"
+end

data/spec/github_control_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe "Github Control" do
+  def config
+    @config ||= YAML.load_file("spec/config.yml")["user"]
+  end
+
+  def console
+    @console ||= GithubControl::Console.new(config)
+  end
+
+  def current_user
+    @user ||= console.current_user
+  end
+
+  before(:all) do
+    RestClient.log = "restclient.log"
+  end
+
+  before(:each) do
+    current_user.repositories.destroy
+  end
+
+  it "creates a public repository" do
+    current_user.should have(:no).repositories
+    current_user.repositories.create("public-repo", :public)
+    current_user.should have(1).repositories
+    current_user.repositories["public-repo"].should be_public
+  end
+
+  it "creates a private repository" do
+    current_user.should have(:no).private_repositories
+    current_user.repositories.create("private-repo", :private)
+    current_user.should have(1).private_repositories
+    current_user.repositories["private-repo"].should be_private
+  end
+
+  it "creates and destroys collaborators on a repository" do
+    repo = current_user.repositories.create("test-repo", :public)
+    repo.collaborators << GithubControl::User.new("atmos", console)
+    repo.collaborators << GithubControl::User.new("tim", console)
+    repo.collaborators << GithubControl::User.new("ben", console)
+    repo.collaborators << GithubControl::User.new("sr", console)
+
+    repo.should have(4).collaborators
+
+    # sorry dude :(
+    repo.collaborators.delete("atmos")
+    repo.should have(3).collaborators
+  end
+
+  it "adds and remove post-receive urls"
+end

data/spec/models/post_receive_urls_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Post-receive URLs" do
+  describe "for a repository with a single URL" do
+    before(:each) do
+      @repo = @console.current_user.repo_for("with-one-post-receive-url")
+    end
+
+    it "can be fetched" do
+      @repo.post_receive_urls.to_a.should == ["http://github-control.r.spork.in/post-receive"]
+    end
+  end
+
+  describe "for a repository with no URLs" do
+    before(:each) do
+      @repo = @console.current_user.repo_for("with-no-post-receive-urls")
+      @repo.post_receive_urls.clear
+    end
+
+    it "can be fetched" do
+      @repo.post_receive_urls.should be_empty
+    end
+
+    it "adds a new URL" do
+      @repo.post_receive_urls << "http://example.org"
+      @repo.post_receive_urls.to_a.should == ["http://example.org"]
+    end
+  end
+
+  describe "for a repository with 3 URLs" do
+    before(:each) do
+      @repo = @console.current_user.repo_for("with-three-post-receive-urls")
+      urls = ["http://example.com/1", "http://example.com/2", "http://example.com/3"]
+      @repo.post_receive_urls.update_with(urls)
+    end
+
+    it "can be fetched" do
+      @repo.post_receive_urls.to_a.should == ["http://example.com/1", "http://example.com/2", "http://example.com/3"]
+    end
+
+    it "adds a new URL" do
+      @repo.post_receive_urls.delete("http://example.com/1")
+      @repo.post_receive_urls.to_a.should == ["http://example.com/2", "http://example.com/3"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'spec'
+require 'randexp'
+require "pp"
+
+require File.dirname(__FILE__) + '/../lib/github-control'
+
+Spec::Runner.configure do |config|
+  config.mock_with(:rr)
+  config.before(:all) do
+    @console = GithubControl::Console.new(YAML.load_file(File.dirname(__FILE__) + '/config.yml')["user"])
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: github-control
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Tim Carey-Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-28 00:00:00 -08:00
+default_executable: github-control
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+description: github-control allows you to interact with Github through a nice ruby interface
+email: tim@spork.in
+executables: 
+- github-control
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- config/example.yml
+- lib/github-control/action.rb
+- lib/github-control/actions/add_collaborators.rb
+- lib/github-control/actions/collaborators.rb
+- lib/github-control/actions/remove_collaborators.rb
+- lib/github-control/actions/repositories.rb
+- lib/github-control/actions/shell.rb
+- lib/github-control/cli.rb
+- lib/github-control/collaborators.rb
+- lib/github-control/console.rb
+- lib/github-control/post_receive_urls.rb
+- lib/github-control/repositories.rb
+- lib/github-control/repository.rb
+- lib/github-control/user.rb
+- lib/github-control/version.rb
+- lib/github-control.rb
+- spec/github_control_spec.rb
+- spec/models/post_receive_urls_spec.rb
+- spec/models/user_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/halorgium/github-control
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: github-control allows you to interact with Github through a nice ruby interface
+test_files: []
+