barkeep-client 0.1.1 → 0.1.2

data/CHANGES.markdown

@@ -0,0 +1,15 @@
+Barkeep Client Changes
+======================
+
+This file summarizes changes between barkeep-client gem versions.
+
+0.1.1
+-----
+
+* Make it easier to pass in arbitrary arguments to `git log` from the `unapproved` command using `--`.
+
+
+0.1.0
+-----
+
+Initial version, including `commit` and `unapproved` commands.

data/README.md

@@ -1,4 +1,6 @@
 Barkeep Client
 ==============
 
-## Coming soon!
+This is a commandline tool to make use of the Barkeep REST API.
+
+See usage instructions in the Barkeep readme.

data/barkeep_client.gemspec

@@ -1,9 +1,11 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 
+require "barkeep/version"
+
 Gem::Specification.new do |s|
   s.name        = "barkeep-client"
-  s.version     = "0.1.1"
+  s.version     = BarkeepClient::VERSION
   s.authors     = ["Caleb Spare"]
   s.email       = ["caleb@ooyala.com"]
   s.homepage    = "https://github.com/ooyala/barkeep"

data/bin/barkeep

@@ -5,20 +5,17 @@ require "dedent"
 require "yaml"
 
 require "barkeep/commit"
+require "barkeep/configuration"
 require "barkeep/unapproved"
-
-CONFIG_FILE = File.join(ENV["HOME"], ".barkeeprc")
+require "barkeep/version"
 
 COMMANDS = {
   "commit" => "Get information about a particular commit.",
   "unapproved" => "Find unapproved commits from a list or commit range."
 }
 
-sub_command = ARGV.shift
-unless COMMANDS.include? sub_command
-  puts sub_command ? "Error: unrecognized command '#{sub_command}'" : "Error: must provide command."
+def usage(exit_status)
   puts <<-EOS.dedent
-
     Usage:
         $ barkeep <command> [args]
     where <command> is one of:
@@ -28,26 +25,28 @@ unless COMMANDS.include? sub_command
 
     Type 'barkeep <command> --help' for more information about a particular command.
   EOS
-  exit 1
+  exit exit_status
 end
 
-# Load in configuration from ~/.barkeeprc.
-begin
-  configuration = YAML.load_file CONFIG_FILE
-rescue
-  puts <<-EOS.dedent
-    Error: #{CONFIG_FILE} must exist to specify barkeep server information, and it must be a valid YAML file.
-  EOS
-  exit 1
+sub_command = ARGV.shift
+
+usage(0) if ["--help", "help", "-h"].include? sub_command
+if ["-v", "--version"].include? sub_command
+  puts "barkeep-client version #{BarkeepClient::VERSION}"
+  exit
+end
+unless COMMANDS.include? sub_command
+  puts sub_command ? "Error: unrecognized command '#{sub_command}'" : "Error: must provide command."
+  puts
+  usage(1)
 end
 
-# Check the configuration
-REQUIRED_KEYS = %w[barkeep_server]
-unless REQUIRED_KEYS.each { |key| configuration.include? key }
-  puts "Error: each of the following configuration keys are required in your #{CONFIG_FILE}:"
-  REQUIRED_KEYS.each { |key| puts "  #{key}" }
+begin
+  configuration = BarkeepClient.get_configuration
+rescue RuntimeError => e
+  puts e.message
   exit 1
 end
 
 # Delegate to the trollop parsing + client logic that lives in the appropriate subcommand file.
-BarkeepClient.send sub_command.to_sym, configuration
+BarkeepClient::Commands.send sub_command.to_sym, configuration

data/lib/barkeep/commit.rb

@@ -7,45 +7,66 @@ require "json"
 require "barkeep/constants"
 
 module BarkeepClient
-  def self.commit(configuration)
-    options = Trollop::options do
-      banner <<-EOS.dedent
-        Barkeep's 'commit' command shows information about a particular commit given its SHA.
+  module Commands
+    def self.commit(configuration)
+      options = Trollop::options do
+        banner <<-EOS.dedent
+          Barkeep's 'commit' command shows information about a particular commit given its SHA.
 
-        Usage:
-            $ barkeep commit [options] <commit>
-        where <commit> is specified as a (partial) SHA-1 hash (for the current repo) or as, for example,
-            myrepo/d29a4a0fa
-        to specify a particular repository, and [options] can include:
-      EOS
-    end
-    Trollop::die "must provide a commit sha" unless ARGV.size == 1
+          Usage:
+              $ barkeep commit [options] <commit>
+          where <commit> is specified as a (partial) SHA-1 hash (for the current repo) or as, for example,
+              myrepo/d29a4a0fa
+          to specify a particular repository, and [options] can include:
+        EOS
+      end
+      Trollop::die "must provide a commit sha" unless ARGV.size == 1
 
-    commit = ARGV[0]
-    repo, sha = case commit
-                when %r{^[^/]+/#{SHA_REGEX}$} # foo/abc123
-                  commit.split "/"
-                when /^#{SHA_REGEX}$/ # abc123
-                  repo = File.basename(`git rev-parse --show-toplevel`).strip
-                  if repo.empty?
-                    Trollop::die "need to be in a git repo or specify a repository (e.g. myrepo/abc123)"
+      commit = ARGV[0]
+      repo, sha = case commit
+                  when %r{^[^/]+/#{SHA_REGEX}$} # foo/abc123
+                    commit.split "/"
+                  when /^#{SHA_REGEX}$/ # abc123
+                    repo = File.basename(`git rev-parse --show-toplevel`).strip
+                    if repo.empty?
+                      Trollop::die "need to be in a git repo or specify a repository (e.g. myrepo/abc123)"
+                    end
+                    [repo, commit]
+                  else
+                    Trollop::die "#{commit} is an invalid commit specification"
                   end
-                  [repo, commit]
-                else
-                  Trollop::die "#{commit} is an invalid commit specification"
-                end
-    uri = URI.parse(File.join(configuration["barkeep_server"], "/api/commits/#{repo}/#{sha}"))
-    result = Net::HTTP.get_response uri
-    if result.code.to_i != 200
-      error = JSON.parse(result.body)["message"] rescue nil
-      puts error ? "Error: #{error}" : "Unspecified server error."
-      exit 1
+
+      begin
+        result = BarkeepClient.commits(configuration, repo, [sha])[sha]
+      rescue RuntimeError => e
+        puts e.message
+        exit 1
+      end
+
+      result.each { |key, value| puts "  #{key.rjust(result.keys.map(&:size).max)}: #{value}" }
     end
-    info = JSON.parse(result.body)
-    info.each do |key, value|
-      next if value.nil?
-      value = Time.at(value).strftime("%m/%d/%Y %I:%M%p") if key == "approved_at"
-      puts "  #{key.rjust(info.keys.map(&:size).max)}: #{value}"
+  end
+
+  # Core method for calling Barkeep's commit API call.
+  # TODO: Support querying lots of commits at once using the altered API call.
+  def self.commits(configuration, repo, shas)
+    result = {}
+    shas.each do |sha|
+      uri = URI.parse(File.join(configuration["barkeep_server"], "/api/commits/#{repo}/#{sha}"))
+      response = Net::HTTP.get_response uri
+      if response.code.to_i != 200
+        error = JSON.parse(response.body)["message"] rescue nil
+        raise error ? "Error: #{error}" : "Unspecified server error."
+      end
+      info = JSON.parse(response.body)
+      commit_data = {}
+      info.each do |key, value|
+        next if value.nil?
+        value = Time.at(value).strftime("%m/%d/%Y %I:%M%p") if key == "approved_at"
+        commit_data[key] = value
+      end
+      result[sha] = commit_data
     end
+    result
   end
 end

data/lib/barkeep/configuration.rb

@@ -0,0 +1,28 @@
+# Load a user's configuration
+
+require "yaml"
+require "dedent"
+
+require "barkeep/constants"
+
+module BarkeepClient
+  def self.get_configuration
+    begin
+      configuration = YAML.load_file CONFIG_FILE
+      raise "Bad file" if configuration == false # On empty yaml files or ones with only comments. Lame API
+    rescue
+      raise <<-EOS.dedent
+        Error: #{CONFIG_FILE} must exist to specify barkeep server information,
+        and it must be a valid YAML file.
+      EOS
+    end
+
+    # Check the configuration
+    unless REQUIRED_CONFIG_KEYS.all? { |key| configuration.include? key }
+      error = "Error: the following configuration keys are required in your #{CONFIG_FILE}: " <<
+              REQUIRED_CONFIG_KEYS.join(', ')
+      raise error
+    end
+    configuration
+  end
+end

data/lib/barkeep/constants.rb

@@ -1,3 +1,5 @@
 module BarkeepClient
   SHA_REGEX = /[0-9a-fA-F]+/
+  CONFIG_FILE = File.join(ENV["HOME"], ".barkeeprc")
+  REQUIRED_CONFIG_KEYS = %w[barkeep_server]
 end

data/lib/barkeep/unapproved.rb

@@ -7,75 +7,72 @@ require "json"
 require "barkeep/constants"
 
 module BarkeepClient
-  def self.unapproved(configuration)
-    options = Trollop::options do
-      banner <<-EOS.dedent
-        Barkeep's 'unapproved' command shows information about a particular commit. It MUST be run from a git
-        repository of the same name as the repository on the server.
+  module Commands
+    def self.unapproved(configuration)
+      options = Trollop::options do
+        banner <<-EOS.dedent
+          Barkeep's 'unapproved' command shows information about a particular commit. It MUST be run from a git
+          repository of the same name as the repository on the server.
 
-        Usage:
-            $ barkeep unapproved [options] <commit-range>
-        where <commit-range> is a commit range specified using git's range syntax (see `man gitrevisions`).
-        For example:
+          Usage:
+              $ barkeep unapproved [options] <commit-range>
+          where <commit-range> is a commit range specified using git's range syntax (see `man gitrevisions`).
+          For example:
 
-            $ barkeep unapproved abc123
-            $ barkeep unapproved ^abc123 def456
-            $ barkeep unapproved abc123..def456
+              $ barkeep unapproved abc123
+              $ barkeep unapproved ^abc123 def456
+              $ barkeep unapproved abc123..def456
 
-        [options] can include:
-      EOS
-      opt :stop_on_unapproved, "Stop and print a message on the first unapproved commit."
-    end
-    Trollop::die "must provide a commit range" if ARGV.empty?
+          [options] can include:
+        EOS
+      end
+      Trollop::die "must provide a commit range" if ARGV.empty?
 
-    repo = File.basename(`git rev-parse --show-toplevel`).strip
-    if repo.empty?
-      Trollop::die "need to be in a git repo"
-    end
+      repo = File.basename(`git rev-parse --show-toplevel`).strip
+      if repo.empty?
+        Trollop::die "need to be in a git repo"
+      end
 
-    commit_range = ARGV.map { |arg| "'#{arg}'" }.join(" ")
-    commits_string = `git log --format='%H' #{commit_range}`
-    exit(1) unless $?.to_i.zero?
-    commits = commits_string.split("\n").map(&:strip)
+      commit_range = ARGV.map { |arg| "'#{arg}'" }.join(" ")
+      commits_string = `git log --format='%H' #{commit_range}`
+      exit(1) unless $?.to_i.zero?
+      commits = commits_string.split("\n").map(&:strip)
 
-    if commits.empty?
-      puts "No commits in range."
-      exit 0
-    elsif commits.size > 100
-      puts "Warning: #{commits.size} commits in range. Lookup could be very slow. Proceed? [yN]"
-      unless STDIN.gets.downcase.strip =~ /^y(es)?/
-        puts "Aborting."
+      if commits.empty?
+        puts "No commits in range."
         exit 0
+      elsif commits.size > 100
+        puts "Warning: #{commits.size} commits in range. Lookup could be very slow. Proceed? [yN]"
+        unless STDIN.gets.downcase.strip =~ /^y(es)?/
+          puts "Aborting."
+          exit 0
+        end
       end
-    end
 
-    unapproved_commits = {}
-    commits.each do |sha|
-      uri = URI.parse(File.join(configuration["barkeep_server"], "/api/commits/#{repo}/#{sha}"))
-      result = Net::HTTP.get_response uri
-      if result.code.to_i != 200
-        error = JSON.parse(result.body)["message"] rescue nil
-        puts error ? "Error: #{error}" : "Unspecified server error."
+      begin
+        commit_data = BarkeepClient.commits(configuration, repo, commits)
+      rescue RuntimeError => e
+        puts e.message
         exit 1
       end
-      info = JSON.parse(result.body)
-      next if info["approved"]
-      author_name = `git log --format='%an' #{sha} -n 1`
-      if options[:stop_on_unapproved]
-        puts "Found unapproved commit #{sha} by #{author_name}"
-        exit 1
+
+      unapproved_commits = {}
+
+      commit_data.each do |sha, commit|
+        next if commit["approved"]
+        author_name = `git log --format='%an' #{sha} -n 1`
+        unapproved_commits[sha] = author_name
       end
-      unapproved_commits[sha] = author_name
-    end
 
-    if unapproved_commits.empty?
-      puts "#{commits.size} approved commit(s) and no unapproved commits in the given range."
-    else
-      puts "#{commits.size - unapproved_commits.size} approved commit(s) and " <<
-           "#{unapproved_commits.size} unapproved commit(s) in the given range."
-      puts "Unapproved:"
-      unapproved_commits.each { |sha, author| puts "#{sha} #{author}" }
-      exit 1
+      if unapproved_commits.empty?
+        puts "#{commits.size} approved commit(s) and no unapproved commits in the given range."
+      else
+        puts "#{commits.size - unapproved_commits.size} approved commit(s) and " <<
+             "#{unapproved_commits.size} unapproved commit(s) in the given range."
+        puts "Unapproved:"
+        unapproved_commits.each { |sha, author| puts "#{sha} #{author}" }
+        exit 1
+      end
     end
   end
 end

data/lib/barkeep/version.rb

@@ -0,0 +1,3 @@
+module BarkeepClient
+  VERSION = "0.1.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: barkeep-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000Z
+date: 2011-12-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70154030714680 !ruby/object:Gem::Requirement
+  requirement: &70356271100060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.16.2
   type: :runtime
   prerelease: false
-  version_requirements: *70154030714680
+  version_requirements: *70356271100060
 - !ruby/object:Gem::Dependency
   name: dedent
-  requirement: &70154030714020 !ruby/object:Gem::Requirement
+  requirement: &70356271098120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *70154030714020
+  version_requirements: *70356271098120
 description: A command-line client for Barkeep's REST API.
 email:
 - caleb@ooyala.com
@@ -43,6 +43,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rbenv-version
+- CHANGES.markdown
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -50,8 +51,10 @@ files:
 - barkeep_client.gemspec
 - bin/barkeep
 - lib/barkeep/commit.rb
+- lib/barkeep/configuration.rb
 - lib/barkeep/constants.rb
 - lib/barkeep/unapproved.rb
+- lib/barkeep/version.rb
 homepage: https://github.com/ooyala/barkeep
 licenses: []
 post_install_message: