gitlab 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3aff91d521f83558b2ae2a2f9d5044be3753c48
-  data.tar.gz: e44498d72ac0c58dc3c8d609e53167fef2a30107
+  metadata.gz: d2242783ef61cde9b3be8c6fad965bfbeb98aaa4
+  data.tar.gz: 01c567c9524d1e9ca20a0c0798d9b72fbe618f47
 SHA512:
-  metadata.gz: 0e5dc00e6c2c0f34837798e9370a82013154c595b4cde38397d20e87b3bd7457cb5a0e32a6b578df1ebbe6e1457eda03c468da21a91c4ab26a42ff54de43d91e
-  data.tar.gz: d9cd147c62de28adb48a9be726b6b1a44b8c0e2d63337d44df2cd1f6eaf18ace338a7f1b8ab7a649683bbe6bb3537015be8dd45a46e44577bb1fdf9b0548bc52
+  metadata.gz: 350d4ff66a74e000d55127271d526c77fbb56889d54b52e3c4f683c210f3c9ea62a763b706086070e1b0ff7cc02293fdc303ddd841c29cd51c4f79f1036f5e77
+  data.tar.gz: 4ca42fbb5fd028381944d77b016167e2471f013393b59030ee7ed3f5c700cf791af9ae43a542f45f7f769550003e64017fa6dde079c3e683dc3314718f6c32ea

data/CHANGELOG.md

@@ -1,7 +1,35 @@
 ## Change Log
 
-### upcoming
-- **Your contribution here.**
+### upcoming (26/11/2015)
+- [a4f2150](https://github.com/NARKOZ/gitlab/commit/a4f21504a7288caace5b7433b49f49dc31e32b30) Add support for namespaces endpoint
+- [3ad81a1](https://github.com/NARKOZ/gitlab/commit/3ad81a19a10b35ea422c0abcf08e6d03a325f4cd) Add missing "@" in doc. (@asedge)
+- [fc34acb](https://github.com/NARKOZ/gitlab/commit/fc34acb6b475bb2555e4b035c11fdf42b3db4085) Add Gitlab::Client::Commits and rearrange methods and tests related to commits. (@asedge)
+- [527089b](https://github.com/NARKOZ/gitlab/commit/527089b17fa7ed74a39b30dc6e8bb33482c1044b) Add commit status API, was added in Gitlab 8.1 (@dsander)
+- [0a2f1db](https://github.com/NARKOZ/gitlab/commit/0a2f1dbe3efb66511dc836ef0ef884efedd70ef3) Add --json CLI parameter to output results as JSON
+- [3f9cb62](https://github.com/NARKOZ/gitlab/commit/3f9cb625517c7294652139f2748e4bc7b98848cc) Adding sudo option for when forking a project (@gregoriomelo)
+- [8dd964e](https://github.com/NARKOZ/gitlab/commit/8dd964ee743e051fade3137d8fac9bb387770150) Fix CLI configuration example comment line width to <= 80. (@asedge)
+- [bbb8b61](https://github.com/NARKOZ/gitlab/commit/bbb8b61db46b32b8649956cb81d9a41e132493d4) Add comment for CLI configuration example. (@asedge)
+- [30e96b9](https://github.com/NARKOZ/gitlab/commit/30e96b9444f7d60d4c0a56f57202c609497126eb) Update README.md (@raine)
+- [d81f05b](https://github.com/NARKOZ/gitlab/commit/d81f05b80b7aaccef49641acfada3b2181f1633d) Change #handle_error method so it handles errors that are returned as an Array. (@asedge)
+- [4c0395e](https://github.com/NARKOZ/gitlab/commit/4c0395ebc58c5a907489b6dc9dcac151e07b4dc8) Add Unprocessable error handler (@ondra-m)
+- [3179bed](https://github.com/NARKOZ/gitlab/commit/3179bedc498b6c5577cc3c0b04633f67eb286ea9) Add block/unblock user. This API feature was added in GitLab 7.13 (@azomazo)
+- [9946c7d](https://github.com/NARKOZ/gitlab/commit/9946c7d2a2c4261cbfc9c4a492b079c79abc2767) Check for specific exceptions in tests to suppress rspec warnings. (@asedge)
+- [5e1c025](https://github.com/NARKOZ/gitlab/commit/5e1c025b8fdf723770c7c7ac0116acdf5cc9f2d5) Added support description option in create_group method (@azomazo)
+- [46b657e](https://github.com/NARKOZ/gitlab/commit/46b657e47a29bc18f4122fff593a9eb58b73e4f1) deleting a gitlab project returns the string "true" (@tosmi)
+- [cc3b489](https://github.com/NARKOZ/gitlab/commit/cc3b489cdeb3bd18b4ec841f80e76e74ddd0ce37) add development scripts (@NARKOZ)
+- [24ad7fd](https://github.com/NARKOZ/gitlab/commit/24ad7fd2a1bd99eb468f1181d95c75fbec5d8fe0) Added specs edit_project, create_fork, create_user_with_username (@p404)
+- [42e73a2](https://github.com/NARKOZ/gitlab/commit/42e73a2fde3e64dc8e3cf0ec73b8cfad88e43ca8) Added edit_project method to Projects module && updated the create_user method (@p404)
+- [c9822f1](https://github.com/NARKOZ/gitlab/commit/c9822f1b61a8d7a5e855616e80e725730340cd48) Refactor create_user method (@p404)
+- [6d7c4e7](https://github.com/NARKOZ/gitlab/commit/6d7c4e7c3285ee082513b3125346e6ed9c18b24b) Added create_fork method to Projects module (@p404)
+- [54155b6](https://github.com/NARKOZ/gitlab/commit/54155b6c59d6e307744668cb3592ca98cf11d8f2) Add snippet_content method + tests. (@asedge)
+- [cfff385](https://github.com/NARKOZ/gitlab/commit/cfff385b7f528223bf9ddc5f4177883e5ca56492) Remove executable permission on fixture file. (@asedge)
+- [487a372](https://github.com/NARKOZ/gitlab/commit/487a372f7041d104975570747a63c9021881c952) Add RepositoryFiles#get_file method. (@asedge)
+- [c9c05ad](https://github.com/NARKOZ/gitlab/commit/c9c05adee50828cc2e31048006cc95b5f2b9b7ce) Hide auth_token method from CLI/shell. (@asedge)
+- [ef408a7](https://github.com/NARKOZ/gitlab/commit/ef408a7de0e677a568a66dbf212139aafc2e6186) Remove unnecessary require. (@asedge)
+- [a2752d1](https://github.com/NARKOZ/gitlab/commit/a2752d1f5a01759a85d1e2003bb81c8e59cf85d3) Add some missing examples. (@asedge)
+- [ac595af](https://github.com/NARKOZ/gitlab/commit/ac595af15a07601b3b657d4b4c1c479651aaa7d7) Add group_search method. (@asedge)
+- [53a6671](https://github.com/NARKOZ/gitlab/commit/53a667184ed3640aefcb3f67836d37f58a504f24) Added Users#delete_user method (@cthulhu666)
+- [a2360f0](https://github.com/NARKOZ/gitlab/commit/a2360f08019632c2660dbbc6753bd3094286b993) Add httparty ENV variable for CLI. Fixes #127. (@asedge)
 
 ### 3.4.0 (22/04/2015)
 - [9acb83d](https://github.com/NARKOZ/gitlab/commit/9acb83d2d068720b07934f5152313dc22a2f6374) remove check for missing attributes

data/README.md

@@ -88,6 +88,17 @@ For more information, refer to [documentation](http://rubydoc.info/gems/gitlab/f
 
 ## CLI
 
+Configuration example:
+
+```sh
+export GITLAB_API_ENDPOINT=https://gitlab.yourcompany.com/api/v3
+export GITLAB_API_PRIVATE_TOKEN=<your private token from /profile/account>
+# This one is optional and can be used to set any HTTParty option you may need
+# using YAML hash syntax. For example, this is how you would disable SSL
+# verification (useful if using a self-signed cert).
+export GITLAB_API_HTTPARTY_OPTIONS="{verify: false}"
+```
+
 Usage examples:
 
 ```sh
@@ -105,6 +116,9 @@ gitlab user --only=id,username
 
 gitlab user --except=email,bio
 
+# get a user and render result as json
+gitlab user 2 --json
+
 # passing options hash to a command (use YAML)
 gitlab create_merge_request 4 "New merge request" "{source_branch: 'new_branch', target_branch: 'master', assignee_id: 42}"
 
@@ -134,6 +148,14 @@ gitlab> create_merge_request 4 "New merge request" "{source_branch: 'new_branch'
 Web version is available at https://gitlab-live.herokuapp.com  
 For more information, refer to [website](http://narkoz.github.io/gitlab).
 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+For more information see [CONTRIBUTING.md](https://github.com/NARKOZ/gitlab/blob/master/CONTRIBUTING.md).
+
 ## License
 
 Released under the BSD 2-clause license. See LICENSE.txt for details.

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# ENV['GITLAB_API_ENDPOINT'] = ''
+# ENV['GITLAB_API_PRIVATE_TOKEN'] = ''
+
+require 'bundler/setup'
+require 'gitlab'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install &&
+  echo 'NOTE: You may need to set GITLAB_API_ENDPOINT and GITLAB_API_PRIVATE_TOKEN environment variables.'

data/gitlab.gemspec

@@ -13,13 +13,16 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/narkoz/gitlab"
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.bindir        = "exe"
+  gem.executables   = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+  gem.license       = "BSD"
 
   gem.add_runtime_dependency 'httparty'
   gem.add_runtime_dependency 'terminal-table'
 
+  gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'webmock'

data/lib/gitlab.rb

@@ -36,7 +36,7 @@ module Gitlab
   #
   # @return [Array<Symbol>]
   def self.actions
-    hidden = /endpoint|private_token|user_agent|sudo|get|post|put|\Adelete\z|validate|set_request_defaults|httparty/
+    hidden = /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|\Adelete\z|validate|set_request_defaults|httparty/
     (Gitlab::Client.instance_methods - Object.methods).reject {|e| e[hidden]}
   end
 end

data/lib/gitlab/cli.rb

@@ -6,6 +6,9 @@ require_relative 'shell'
 class Gitlab::CLI
   extend Helpers
 
+  # If set to true, JSON will be rendered as output
+  @render_json = false
+
   # Starts a new CLI session.
   #
   # @example
@@ -43,6 +46,11 @@ class Gitlab::CLI
     when 'shell'
       Gitlab::Shell.start
     else
+      if args.include? '--json'
+        @json_output = true
+        args.delete '--json'
+      end
+
       unless valid_command?(cmd)
         puts "Unknown command. Run `gitlab help` for a list of available commands."
         exit(1)
@@ -55,8 +63,7 @@ class Gitlab::CLI
       end
 
       begin
-        yaml_load_arguments! command_args
-        command_args.map! {|arg| symbolize_keys arg }
+        command_args.map! { |arg| symbolize_keys(yaml_load(arg)) }
       rescue => e
         puts e.message
         exit 1
@@ -65,6 +72,17 @@ class Gitlab::CLI
       confirm_command(cmd)
 
       data = gitlab_helper(cmd, command_args) { exit(1) }
+
+      render_output(cmd, args, data)
+    end
+  end
+
+  # Helper method that checks whether we want to get the output as json
+  # @return [nil]
+  def self.render_output(cmd,args,data)
+    if @json_output
+      output_json(cmd, args, data)
+    else
       output_table(cmd, args, data)
     end
   end

data/lib/gitlab/cli_helpers.rb

@@ -1,4 +1,6 @@
 require 'yaml'
+require 'json'
+
 
 class Gitlab::CLI
   # Defines methods related to CLI output and formatting.
@@ -99,16 +101,29 @@ class Gitlab::CLI
       end
     end
 
+    def output_json(cmd, args, data)
+      if data.empty?
+        puts '{}'
+      else
+        hash_result = case data
+          when Gitlab::ObjectifiedHash
+            record_hash([data], cmd, args, true)
+          when Array
+            record_hash(data, cmd, args)
+          else
+            { :cmd => cmd, :data => data, :args => args }
+        end
+        puts JSON.pretty_generate(hash_result)
+      end
+    end
+
     # Table to display records.
     #
     # @return [Terminal::Table]
     def 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)
+      arr, keys = get_keys(args, data)
 
       table do |t|
         t.title = "Gitlab.#{cmd} #{args.join(', ')}"
@@ -134,6 +149,54 @@ class Gitlab::CLI
       end
     end
 
+    # Renders the result of given commands and arguments into a Hash
+    #
+    # @param  [Array]  data         Resultset from the API call
+    # @param  [String] cmd          The command passed to the API
+    # @param  [Array]  args         Options passed to the API call
+    # @param  [bool]   single_value If set to true, a single result should be returned
+    # @return [Hash]   Result hash
+    def record_hash(data, cmd, args, single_value = false)
+      if data.empty?
+        result = nil
+      else
+        arr, keys = get_keys(args, data)
+        result = []
+        arr.each do |hash|
+          row = {}
+
+          keys.each do |key|
+            case hash[key]
+              when Hash
+                row[key] = 'Hash'
+              when nil
+                row[key] = nil
+              else
+                row[key] = hash[key]
+            end
+          end
+
+          result.push row
+        end
+        result = result[0] if single_value && result.count > 0
+      end
+
+      {
+        :cmd => "Gitlab.#{cmd} #{args.join(', ')}".strip,
+        :result => result
+      }
+
+    end
+
+    # Helper function to get rows and keys from data returned from API call
+    def get_keys(args, data)
+      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)
+      return arr, keys
+    end
+
     # Helper function to call Gitlab commands with args.
     def gitlab_helper(cmd, args = [])
       begin
@@ -162,18 +225,14 @@ class Gitlab::CLI
       hash
     end
 
-    # Run YAML::load on each arg.
-    # @return [Array]
-    def yaml_load_arguments!(args)
-      args.map! do |arg|
-        begin
-          arg = YAML::load(arg)
-        rescue Psych::SyntaxError
-          raise "error: Argument is not valid YAML syntax: #{arg}"
-        end
-
-        arg
+    # YAML::load on a single argument
+    def yaml_load(arg)
+      begin
+        yaml = YAML::load(arg)
+      rescue Psych::SyntaxError
+        raise "error: Argument is not valid YAML syntax: #{arg}"
       end
+      yaml
     end
   end
 end

data/lib/gitlab/client.rb

@@ -4,11 +4,13 @@ module Gitlab
     Dir[File.expand_path('../client/*.rb', __FILE__)].each {|f| require f}
 
     include Branches
+    include Commits
     include Groups
     include Issues
     include Labels
     include MergeRequests
     include Milestones
+    include Namespaces
     include Notes
     include Projects
     include Repositories

data/lib/gitlab/client/commits.rb

@@ -0,0 +1,121 @@
+class Gitlab::Client
+  # Defines methods related to repository commits.
+  # @see https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/commits.md
+  module Commits
+    # Gets a list of project commits.
+    #
+    # @example
+    #   Gitlab.commits('viking')
+    #   Gitlab.repo_commits('gitlab', :ref_name => 'api')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :ref_name The branch or tag name of a project repository.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def commits(project, options={})
+      get("/projects/#{project}/repository/commits", :query => options)
+    end
+    alias_method :repo_commits, :commits
+
+    # Gets a specific commit identified by the commit hash or name of a branch or tag.
+    #
+    # @example
+    #   Gitlab.commit(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.repo_commit(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag
+    # @return [Gitlab::ObjectifiedHash]
+    def commit(project, sha)
+      get("/projects/#{project}/repository/commits/#{sha}")
+    end
+    alias_method :repo_commit, :commit
+
+    # Get the diff of a commit in a project.
+    #
+    # @example
+    #   Gitlab.commit_diff(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.repo_commit_diff(3, 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The name of a repository branch or tag or if not given the default branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def commit_diff(project, sha)
+      get("/projects/#{project}/repository/commits/#{sha}/diff")
+    end
+    alias_method :repo_commit_diff, :commit_diff
+
+    # Gets a list of comments for a commit.
+    #
+    # @example
+    #   Gitlab.commit_comments(5, 'c9f9662a9b1116c838b523ed64c6abdb4aae4b8b')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [String] sha The commit hash or name of a repository branch or tag.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def commit_comments(project, commit, options={})
+      get("/projects/#{project}/repository/commits/#{commit}/comments", :query => options)
+    end
+    alias_method :repo_commit_comments, :commit_comments
+
+    # Creates a new comment for a commit.
+    #
+    # @example
+    #   Gitlab.create_commit_comment(5, 'c9f9662a9b1116c838b523ed64c6abdb4aae4b8b', 'Nice work on this commit!')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The commit hash or name of a repository branch or tag.
+    # @param  [String] note The text of a comment.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :path The file path.
+    # @option options [Integer] :line The line number.
+    # @option options [String] :line_type The line type (new or old).
+    # @return [Gitlab::ObjectifiedHash] Information about created comment.
+    def create_commit_comment(project, commit, note, options={})
+      post("/projects/#{project}/repository/commits/#{commit}/comments", :body => options.merge(:note => note))
+    end
+    alias_method :repo_create_commit_comment, :create_commit_comment
+
+    # Get the status of a commit
+    #
+    # @example
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6')
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', name: 'jenkins')
+    #   Gitlab.commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', name: 'jenkins', all: true)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The commit hash
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :ref Filter by ref name, it can be branch or tag
+    # @option options [String] :stage Filter by stage
+    # @option options [String] :name Filer by status name, eg. jenkins
+    # @option options [Boolean] :all The flag to return all statuses, not only latest ones
+    def commit_status(id, sha, options = {})
+      get("/projects/#{id}/repository/commits/#{sha}/statuses", query: options)
+    end
+    alias_method :repo_commit_status, :commit_status
+
+    # Adds or updates a status of a commit.
+    #
+    # @example
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'success')
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'failed', name: 'jenkins')
+    #   Gitlab.update_commit_status(42, '6104942438c14ec7bd21c6cd5bd995272b3faff6', 'canceled', name: 'jenkins', target_url: 'http://example.com/builds/1')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] sha The commit hash
+    # @param  [String] state of the status. Can be: pending, running, success, failed, canceled
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :ref The ref (branch or tag) to which the status refers
+    # @option options [String] :name Filer by status name, eg. jenkins
+    # @option options [String] :target_url The target URL to associate with this status
+    def update_commit_status(id, sha, state, options = {})
+      post("/projects/#{id}/statuses/#{sha}", query: options.merge(state: state))
+    end
+    alias_method :repo_update_commit_status, :update_commit_status
+  end
+end