gitlab 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e73d6232b1c15dcf05f0b58e12e4d93ca076d210
-  data.tar.gz: b8e227455c58f3195448c2712b0ea6f1e3d56ade
+  metadata.gz: 88679bf87230b7d3d6bb8f0e96fb779967936216
+  data.tar.gz: 6c41b6c43280434257bc160aa38963ef50a4cc72
 SHA512:
-  metadata.gz: e624e3813e30c96657d5810788dc56bcf032b8f132a8a36a88ad3a7a13aa9a42f2c7bf3f61a47c9c21c5013dc09327e79d305db7a67f985530a6998c5e94da95
-  data.tar.gz: d118ef1b86f69311740d79e0f74390c8041e2c8a5b96345ed0edb52bbbc5bfa243fd380b8e8106eeaf71d28114968aeac879938ec5a76aa399d4adb2c075b47d
+  metadata.gz: ae58eefafd56dba8d8b87029c89972d036c479d3a3d15b6a7196e08495d9325de841a1860cb29151dd879aa05bee8fef1f340118d6309b520532804615b464d9
+  data.tar.gz: a96ddd98eebc816f295856c6996b1b29462c9a236d4a1d67b5c6259dc00e7f1b7b08bbf395c7bc69d1b8983e7be990ca2cda9a143c218f33dab3d3df8134731f

data/.gitignore

@@ -16,3 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 .idea
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2013 Nihad Abbasov <mail@narkoz.me>
+Copyright (c) 2012-2014 Nihad Abbasov <mail@narkoz.me>
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -2,7 +2,10 @@
 
 [![Build Status](https://travis-ci.org/NARKOZ/gitlab.png)](http://travis-ci.org/NARKOZ/gitlab)
 
-Gitlab is a Ruby wrapper for the [GitLab API](https://github.com/gitlabhq/gitlabhq/tree/master/doc/api#gitlab-api).
+[website](http://narkoz.github.io/gitlab) |
+[documentation](http://rubydoc.info/gems/gitlab/frames)
+
+Gitlab is a Ruby wrapper and CLI for the [GitLab API](https://github.com/gitlabhq/gitlabhq/tree/master/doc/api#gitlab-api).
 
 ## Installation
 
@@ -25,7 +28,7 @@ Configuration example:
 
 ```ruby
 Gitlab.configure do |config|
-  config.endpoint       = 'https://example.net/api/v2' # API endpoint URL (required)
+  config.endpoint       = 'https://example.net/api/v3' # API endpoint URL (required)
   config.private_token  = 'qEsq1pt6HJPaNciie3MG'       # user's private token (required)
   config.user_agent     = 'Custom User Agent'          # user agent, default to 'Gitlab Ruby Gem [version]' (optional)
 end
@@ -35,7 +38,7 @@ Usage examples:
 
 ```ruby
 # set an API endpoint
-Gitlab.endpoint = 'http://example.net/api/v2'
+Gitlab.endpoint = 'http://example.net/api/v3'
 # => "http://example.net/api/v2"
 
 # set a user private token
@@ -69,6 +72,28 @@ Gitlab.sudo = nil
 
 For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/frames).
 
+## CLI
+
+Usage examples:
+
+```sh
+# list users
+gitlab users
+
+# get current user
+gitlab user
+
+# get a user
+gitlab user 2
+
+# filter output
+gitlab user --only=id,username
+
+gitlab user --except=email,bio
+```
+
+For more information, refer to [website](http://narkoz.github.io/gitlab).
+
 ## License
 
 Released under the BSD 2-clause license. See LICENSE.txt for details.

data/bin/gitlab

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'gitlab/cli'
+
+Gitlab::CLI.start(ARGV)

data/gitlab.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Gitlab::VERSION
   gem.authors       = ["Nihad Abbasov"]
   gem.email         = ["mail@narkoz.me"]
-  gem.description   = %q{Ruby client for GitLab API}
-  gem.summary       = %q{A Ruby wrapper for the GitLab API}
+  gem.description   = %q{Ruby client and CLI for GitLab API}
+  gem.summary       = %q{A Ruby wrapper and CLI for the GitLab API}
   gem.homepage      = "https://github.com/narkoz/gitlab"
 
   gem.files         = `git ls-files`.split($/)
@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency 'httparty'
+  gem.add_runtime_dependency 'terminal-table'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/lib/gitlab.rb

@@ -26,4 +26,12 @@ module Gitlab
   def self.respond_to?(method)
     return client.respond_to?(method) || super
   end
+
+  # Returns an unsorted array of available client methods.
+  #
+  # @return [Array<Symbol>]
+  def self.actions
+    hidden = /endpoint|private_token|user_agent|sudo|get|post|put|\Adelete\z|validate|set_request_defaults/
+    (Gitlab::Client.instance_methods - Object.methods).reject {|e| e[hidden]}
+  end
 end

data/lib/gitlab/api.rb

@@ -2,7 +2,7 @@ module Gitlab
   # @private
   class API < Request
     # @private
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
     # Creates a new API.
     # @raise [Error:MissingCredentials]

data/lib/gitlab/cli.rb

@@ -0,0 +1,57 @@
+require 'gitlab'
+require 'terminal-table/import'
+require_relative 'cli_helpers'
+
+class Gitlab::CLI
+  extend Helpers
+
+  def self.start(args)
+    command = args.shift.strip rescue 'help'
+    run(command, args)
+  end
+
+  def self.run(cmd, args=[])
+    case cmd
+    when 'help'
+      puts actions_table
+    when 'info'
+      endpoint = Gitlab.endpoint ? Gitlab.endpoint : 'not set'
+      private_token = Gitlab.private_token ? Gitlab.private_token : 'not set'
+      puts "Gitlab endpoint is #{endpoint}"
+      puts "Gitlab private token is #{private_token}"
+      puts "Ruby Version is #{RUBY_VERSION}"
+      puts "Gitlab Ruby Gem #{Gitlab::VERSION}"
+    when '-v', '--version'
+      puts "Gitlab Ruby Gem #{Gitlab::VERSION}"
+    else
+      unless Gitlab.actions.include?(cmd.to_sym)
+        puts "Unknown command. Run `gitlab help` for a list of available commands."
+        exit(1)
+      end
+
+      if args.any? && (args.last.start_with?('--only=') || args.last.start_with?('--except='))
+        command_args = args[0..-2]
+      else
+        command_args = args
+      end
+
+      confirm_command(cmd)
+
+      begin
+        data = args.any? ? Gitlab.send(cmd, *command_args) : Gitlab.send(cmd)
+      rescue => e
+        puts e.message
+        exit(1)
+      end
+
+      case data
+      when Gitlab::ObjectifiedHash
+        puts single_record_table(data, cmd, args)
+      when Array
+        puts multiple_record_table(data, cmd, args)
+      else
+        puts data.inspect
+      end
+    end
+  end
+end

data/lib/gitlab/cli_helpers.rb

@@ -0,0 +1,141 @@
+class Gitlab::CLI
+  # Defines methods related to CLI output and formatting.
+  module Helpers
+    extend self
+
+    # Returns filtered required fields.
+    #
+    # @return [Array]
+    def required_fields(args)
+      if args.any? && args.last.start_with?('--only=')
+        args.last.gsub('--only=', '').split(',')
+      else
+        []
+      end
+    end
+
+    # Returns filtered excluded fields.
+    #
+    # @return [Array]
+    def excluded_fields(args)
+      if args.any? && args.last.start_with?('--except=')
+        args.last.gsub('--except=', '').split(',')
+      else
+        []
+      end
+    end
+
+    # Confirms command with a desctructive action.
+    #
+    # @return [String]
+    def confirm_command(cmd)
+      if cmd.start_with?('remove_') || cmd.start_with?('delete_')
+        puts "Are you sure? (y/n)"
+        if %w(y yes).include?($stdin.gets.to_s.strip.downcase)
+          puts 'Proceeding..'
+        else
+          puts 'Command aborted.'
+          exit(1)
+        end
+      end
+    end
+
+    # Table with available commands.
+    #
+    # @return [String]
+    def actions_table
+      client = Gitlab::Client.new(endpoint: '')
+      actions = Gitlab.actions
+      methods = []
+
+      actions.each do |action|
+        methods << {
+          name: action,
+          owner: client.method(action).owner.to_s.gsub('Gitlab::Client::', '')
+        }
+      end
+
+      owners = methods.map {|m| m[:owner]}.uniq.sort
+      methods_c = methods.group_by {|m| m[:owner]}
+      methods_c = methods_c.map {|_, v| [_, v.sort_by {|hv| hv[:name]}] }
+      methods_c = Hash[methods_c.sort_by(&:first).map {|k, v| [k, v]}]
+      max_column_length = methods_c.values.max_by(&:size).size
+
+      rows = max_column_length.times.map do |i|
+        methods_c.keys.map do |key|
+          methods_c[key][i] ? methods_c[key][i][:name] : ''
+        end
+      end
+
+      table do |t|
+        t.title = "Available commands (#{actions.size} total)"
+        t.headings = owners
+
+        rows.each do |row|
+          t.add_row row
+        end
+      end
+    end
+
+    # Table for a single record.
+    #
+    # @return [String]
+    def single_record_table(data, cmd, args)
+      hash = data.to_h
+      keys = hash.keys.sort {|x, y| x.to_s <=> y.to_s }
+      keys = keys & required_fields(args) if required_fields(args).any?
+      keys = keys - excluded_fields(args)
+
+      table do |t|
+        t.title = "Gitlab.#{cmd} #{args.join(', ')}"
+
+        keys.each_with_index do |key, index|
+          case value = hash[key]
+          when Hash
+            value = 'Hash'
+          when nil
+            value = 'null'
+          end
+
+          t.add_row [key, value]
+          t.add_separator unless keys.size - 1 == index
+        end
+      end
+    end
+
+    # Table for multiple records.
+    #
+    # @return [String]
+    def multiple_record_table(data, cmd, args)
+      return 'No data' if data.empty?
+
+      arr = data.map(&:to_h)
+      keys = arr.first.keys.sort {|x, y| x.to_s <=> y.to_s }
+      keys = keys & required_fields(args) if required_fields(args).any?
+      keys = keys - excluded_fields(args)
+
+      table do |t|
+        t.title = "Gitlab.#{cmd} #{args.join(', ')}"
+        t.headings = keys
+
+        arr.each_with_index do |hash, index|
+          values = []
+
+          keys.each do |key|
+            case value = hash[key]
+            when Hash
+              value = 'Hash'
+            when nil
+              value = 'null'
+            end
+
+            values << value
+          end
+
+          t.add_row values
+          t.add_separator unless arr.size - 1 == index
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/client.rb

@@ -1,16 +1,18 @@
 module Gitlab
   # Wrapper for the Gitlab REST API.
   class Client < API
-    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each {|f| require f}
 
-    include Users
+    include Branches
+    include Groups
     include Issues
-    include Notes
+    include MergeRequests
     include Milestones
-    include Snippets
+    include Notes
     include Projects
     include Repositories
-    include MergeRequests
-    include Groups
+    include Snippets
+    include SystemHooks
+    include Users
   end
 end

data/lib/gitlab/client/branches.rb

@@ -0,0 +1,79 @@
+class Gitlab::Client
+  # Defines methods related to repositories.
+  module Branches
+    # Gets a list of project repositiory branches.
+    #
+    # @example
+    #   Gitlab.branches(42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def branches(project, options={})
+      get("/projects/#{project}/repository/branches", :query => options)
+    end
+    alias_method :repo_branches, :branches
+
+    # Gets information about a repository branch.
+    #
+    # @example
+    #   Gitlab.branch(3, 'api')
+    #   Gitlab.repo_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def branch(project, branch)
+      get("/projects/#{project}/repository/branches/#{branch}")
+    end
+    
+    alias_method :repo_branch, :branch
+
+    # Protects a repository branch.
+    #
+    # @example
+    #   Gitlab.protect_branch(3, 'api')
+    #   Gitlab.repo_protect_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def protect_branch(project, branch)
+      put("/projects/#{project}/repository/branches/#{branch}/protect")
+    end
+    alias_method :repo_protect_branch, :protect_branch
+
+    # Unprotects a repository branch.
+    #
+    # @example
+    #   Gitlab.unprotect_branch(3, 'api')
+    #   Gitlab.repo_unprotect_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def unprotect_branch(project, branch)
+      put("/projects/#{project}/repository/branches/#{branch}/unprotect")
+    end
+    alias_method :repo_unprotect_branch, :unprotect_branch
+
+    # Creates a repository branch.  Requires Gitlab >= 6.8.x
+    #
+    # @example
+    #   Gitlab.create_branch(3, 'api')
+    #   Gitlab.repo_create_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the new branch.
+    # @param  [String] ref Create branch from commit sha or existing branch
+    # @return [Gitlab::ObjectifiedHash]
+    def create_branch(project, branch, ref)
+      post("/projects/#{project}/repository/branches",:body => {:branch_name => branch, :ref => ref})
+    end
+    alias_method :repo_create_branch, :create_branch
+
+  end
+end
+

data/lib/gitlab/client/merge_requests.rb

@@ -62,6 +62,7 @@ class Gitlab::Client
     # @option options [String] :source_branch The source branch name.
     # @option options [String] :target_branch The target branch name.
     # @option options [Integer] :assignee_id The ID of a user to assign merge request.
+    # @option options [String] :state_event New state (close|reopen|merge).
     # @return [Gitlab::ObjectifiedHash] Information about updated merge request.
     def update_merge_request(project, id, options={})
       put("/projects/#{project}/merge_request/#{id}", :body => options)
@@ -70,8 +71,8 @@ class Gitlab::Client
     # Adds a comment to a merge request.
     #
     # @example
-    #   Gitlab.comment_merge_request(5, 1, "Awesome merge!")
-    #   Gitlab.comment_merge_request('gitlab', 1, "Awesome merge!")
+    #   Gitlab.create_merge_request_comment(5, 1, "Awesome merge!")
+    #   Gitlab.create_merge_request_comment('gitlab', 1, "Awesome merge!")
     #
     # @param  [Integer] project The ID of a project.
     # @param  [Integer] id The ID of a merge request.
@@ -81,6 +82,18 @@ class Gitlab::Client
       post("/projects/#{project}/merge_request/#{id}/comments", :body => {:note => note})
     end
 
+    # Gets the comments on a merge request.
+    #
+    # @example
+    #   Gitlab.merge_request_comments(5, 1)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Integer] id The ID of a merge request.
+    # @return [Gitlab::ObjectifiedHash] The merge request's comments.
+    def merge_request_comments(project, id)
+      get("/projects/#{project}/merge_request/#{id}/comments")
+    end
+
     private
 
     def check_attributes!(options, attrs)