gitlab 3.2.0 → 3.3.0

data/lib/gitlab/client/repositories.rb

@@ -19,14 +19,15 @@ class Gitlab::Client
     # Creates a new project repository tag.
     #
     # @example
-    #   Gitlab.create_tag(42,'new_tag','master'))
+    #   Gitlab.create_tag(42,'new_tag','master')
     #
     # @param  [Integer] project The ID of a project.
     # @param  [String]  tag_name The name of the new tag.
     # @param  [String]  ref The ref (commit sha, branch name, or another tag) the tag will point to.
+    # @param  [String]  message Optional message for tag, creates annotated tag if specified.
     # @return [Gitlab::ObjectifiedHash]
-    def create_tag(project, tag_name, ref)
-      post("/projects/#{project}/repository/tags", body: {tag_name: tag_name, ref: ref})
+    def create_tag(project, tag_name, ref, message='')
+      post("/projects/#{project}/repository/tags", body: {tag_name: tag_name, ref: ref, message: message})
     end
     alias_method :repo_create_tag, :create_tag
 
@@ -71,8 +72,87 @@ class Gitlab::Client
     # @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") 
+      get("/projects/#{project}/repository/commits/#{sha}/diff")
     end
     alias_method :repo_commit_diff, :commit_diff
+
+    # Get the contents of a file
+    #
+    # @example
+    #   Gitlab.file_contents(42, 'Gemfile')
+    #   Gitlab.repo_file_contents(3, 'Gemfile', 'ed899a2f4b50b4370feeea94676502b42383c746')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] filepath The relative path of the file in the repository
+    # @param  [String] ref The name of a repository branch or tag or if not given the default branch.
+    # @return [String]
+    def file_contents(project, filepath, ref = 'master')
+      get "/projects/#{project}/repository/blobs/#{ref}?filepath=#{filepath}",
+        format: nil,
+        headers: { Accept: 'text/plain' },
+        parser: ::Gitlab::Request::Parser
+    end
+    alias_method :repo_file_contents, :file_contents
+
+    # 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.
+    #
+    # @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 file tree project (root level).
+    #
+    # @example
+    #   Gitlab.tree(42)
+    #   Gitlab.tree(42, path: "Gemfile")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :path The path inside repository.
+    # @option options [String] :ref_name The name of a repository branch or tag.
+    # @return [Gitlab::ObjectifiedHash]
+    def tree(project, options={})
+      get("/projects/#{project}/repository/tree", query: options)
+    end
+    alias_method :repo_tree, :tree
+
+    # Compares branches, tags or commits.
+    #
+    # @example
+    #   Gitlab.compare(42, 'master', 'feature/branch')
+    #   Gitlab.repo_compare(42, 'master', 'feature/branch')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [String] from The commit SHA or branch name of from branch.
+    # @param [String] to The commit SHA or branch name of to branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def compare(project, from, to)
+      get("/projects/#{project}/repository/compare", :query => {:from => from, :to => to})
+    end
+    alias_method :repo_compare, :compare
   end
 end

data/lib/gitlab/configuration.rb

@@ -2,7 +2,7 @@ module Gitlab
   # Defines constants and methods related to configuration.
   module Configuration
     # An array of valid keys in the options hash when configuring a Gitlab::API.
-    VALID_OPTIONS_KEYS = [:endpoint, :private_token, :user_agent, :sudo].freeze
+    VALID_OPTIONS_KEYS = [:endpoint, :private_token, :user_agent, :sudo, :httparty].freeze
 
     # The user agent that will be sent to the API endpoint if none is set.
     DEFAULT_USER_AGENT = "Gitlab Ruby Gem #{Gitlab::VERSION}".freeze

data/lib/gitlab/help.rb

@@ -20,10 +20,10 @@ module Gitlab::Help
             ri_output = `#{ri_cmd} -T #{namespace} 2>&1`.chomp
 
             if $? == 0
-              ri_output.gsub!(/#{cmd}\((.*)\)/, cmd+' \1')
+              ri_output.gsub!(/#{cmd}\((.*?)\)/m, cmd+' \1')
               ri_output.gsub!(/Gitlab\./, 'gitlab> ')
               ri_output.gsub!(/Gitlab\..+$/, '')
-              ri_output.gsub!(/\,/, '')
+              ri_output.gsub!(/\,[\s]*/, ' ')
               help = ri_output
             else
               help = "Ri docs not found for #{namespace}, please install the docs to use 'help'"

data/lib/gitlab/objectified_hash.rb

@@ -20,5 +20,9 @@ module Gitlab
     def method_missing(key)
       @data.key?(key.to_s) ? @data[key.to_s] : nil
     end
+
+    def respond_to?(method_name, include_private = false)
+      @hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
+    end
   end
 end

data/lib/gitlab/request.rb

@@ -9,7 +9,7 @@ module Gitlab
     headers 'Accept' => 'application/json'
     parser Proc.new { |body, _| parse(body) }
 
-    attr_accessor :private_token
+    attr_accessor :private_token, :endpoint
 
     # Converts the response body to an ObjectifiedHash.
     def self.parse(body)
@@ -34,23 +34,27 @@ module Gitlab
     end
 
     def get(path, options={})
+      set_httparty_config(options)
       set_private_token_header(options)
-      validate self.class.get(path, options)
+      validate self.class.get(@endpoint + path, options)
     end
 
     def post(path, options={})
+      set_httparty_config(options)
       set_private_token_header(options, path)
-      validate self.class.post(path, options)
+      validate self.class.post(@endpoint + path, options)
     end
 
     def put(path, options={})
+      set_httparty_config(options)
       set_private_token_header(options)
-      validate self.class.put(path, options)
+      validate self.class.put(@endpoint + path, options)
     end
 
     def delete(path, options={})
+      set_httparty_config(options)
       set_private_token_header(options)
-      validate self.class.delete(path, options)
+      validate self.class.delete(@endpoint + path, options)
     end
 
     # Checks the response code for common errors.
@@ -76,8 +80,8 @@ module Gitlab
     def set_request_defaults(endpoint, private_token, sudo=nil)
       raise Error::MissingCredentials.new("Please set an endpoint to API") unless endpoint
       @private_token = private_token
+      @endpoint = endpoint
 
-      self.class.base_uri endpoint
       self.class.default_params :sudo => sudo
       self.class.default_params.delete(:sudo) if sudo.nil?
     end
@@ -93,6 +97,14 @@ module Gitlab
       end
     end
 
+    # Set HTTParty configuration
+    # @see https://github.com/jnunemaker/httparty
+    def set_httparty_config(options)
+      if self.httparty
+        options.merge!(self.httparty)
+      end
+    end
+
     def error_message(response)
       "Server responded with code #{response.code}, message: #{response.parsed_response.message}. " \
       "Request URI: #{response.request.base_uri}#{response.request.path}"

data/lib/gitlab/shell.rb

@@ -1,12 +1,16 @@
 require 'gitlab'
 require 'gitlab/help'
 require 'gitlab/cli_helpers'
+require 'gitlab/shell_history'
 require 'readline'
+require 'shellwords'
 
 class Gitlab::Shell
   extend Gitlab::CLI::Helpers
 
+  # Start gitlab shell and run infinite loop waiting for user input
   def self.start
+    history.load
     actions = Gitlab.actions
 
     comp = proc { |s| actions.map(&:to_s).grep(/^#{Regexp.escape(s)}/) }
@@ -16,9 +20,21 @@ class Gitlab::Shell
 
     client = Gitlab::Client.new(endpoint: '')
 
-    while buf = Readline.readline("gitlab> ", true)
+    while buf = Readline.readline('gitlab> ')
+      trap('INT') { quit_shell } # capture ctrl-c
+
       next if buf.nil? || buf.empty?
-      buf = buf.split.map(&:chomp)
+      quit_shell if buf == 'exit'
+
+      history << buf
+
+      begin
+        buf = Shellwords.shellwords(buf)
+      rescue ArgumentError => e
+        puts e.message
+        next
+      end
+
       cmd = buf.shift
       args = buf.count > 0 ? buf : []
 
@@ -32,18 +48,40 @@ class Gitlab::Shell
           }
         end
 
-        args[0].nil? ? Gitlab::Help.get_help(methods) : Gitlab::Help.get_help(methods, args[0])
+        args[0].nil? ? Gitlab::Help.get_help(methods) :
+                       Gitlab::Help.get_help(methods, args[0])
         next
       end
 
+      syntax_errors = false
+
+      begin
+        yaml_load_and_symbolize_hash!(args)
+      rescue
+        syntax_errors = true
+      end
+
+      # errors have been displayed, return to the prompt
+      next if syntax_errors 
+
       data = if actions.include?(cmd.to_sym)
         confirm_command(cmd)
         gitlab_helper(cmd, args)
       else
-        "'#{cmd}' is not a valid command.  See the 'help' for a list of valid commands."
+        "'#{cmd}' is not a valid command. " +
+        "See the 'help' for a list of valid commands."
       end
 
       output_table(cmd, args, data)
     end
   end
+
+  def self.quit_shell
+    history.save
+    exit
+  end
+
+  def self.history
+    @history ||= History.new
+  end
 end

data/lib/gitlab/shell_history.rb

@@ -0,0 +1,61 @@
+class Gitlab::Shell
+  class History
+    DEFAULT_HISTFILESIZE = 200
+    DEFAULT_FILE_PATH = File.join(Dir.home, '.gitlab_shell_history')
+
+    def initialize(options = {})
+      @file_path = options[:file_path] || DEFAULT_FILE_PATH
+      Readline::HISTORY.clear
+    end
+
+    def load
+      read_from_file { |line| Readline::HISTORY << line.chomp }
+    end
+
+    def save
+      lines.each { |line| history_file.puts line if history_file }
+    end
+
+    def push(line)
+      Readline::HISTORY << line
+    end
+    alias_method :<<, :push
+
+    def lines
+      Readline::HISTORY.to_a.last(max_lines)
+    end
+
+    private
+
+    def history_file
+      if defined?(@history_file)
+        @history_file
+      else
+        @history_file = File.open(history_file_path, 'w', 0600).tap do |file|
+          file.sync = true
+        end
+      end
+    rescue Errno::EACCES
+      warn 'History not saved; unable to open your history file for writing.'
+      @history_file = false
+    end
+
+    def history_file_path
+      File.expand_path(@file_path)
+    end
+
+    def read_from_file
+      path = history_file_path
+
+      if File.exist?(path)
+        File.foreach(path) { |line| yield(line) }
+      end
+    rescue => error
+      warn "History file not loaded: #{error.message}"
+    end
+
+    def max_lines
+      (ENV['GITLAB_HISTFILESIZE']|| DEFAULT_HISTFILESIZE).to_i
+    end
+  end
+end

data/lib/gitlab/version.rb

@@ -1,3 +1,3 @@
 module Gitlab
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

data/spec/fixtures/compare_merge_request_diff.json

@@ -0,0 +1,31 @@
+
+{
+  "commit": {
+    "id": "12d65c8dd2b2676fa3ac47d955accc085a37a9c1",
+    "short_id": "12d65c8dd2b",
+    "title": "JS fix",
+    "author_name": "Dmitriy Zaporozhets",
+    "author_email": "dmitriy.zaporozhets@gmail.com",
+    "created_at": "2014-02-27T10:27:00+02:00"
+  },
+  "commits": [{
+    "id": "12d65c8dd2b2676fa3ac47d955accc085a37a9c1",
+    "short_id": "12d65c8dd2b",
+    "title": "JS fix",
+    "author_name": "Dmitriy Zaporozhets",
+    "author_email": "dmitriy.zaporozhets@gmail.com",
+    "created_at": "2014-02-27T10:27:00+02:00"
+  }],
+  "diffs": [{
+    "old_path": "files/js/application.js",
+    "new_path": "files/js/application.js",
+    "a_mode": null,
+    "b_mode": "100644",
+    "diff": "--- a/files/js/application.js\n+++ b/files/js/application.js\n@@ -24,8 +24,10 @@\n //= require g.raphael-min\n //= require g.bar-min\n //= require branch-graph\n-//= require highlightjs.min\n-//= require ace/ace\n //= require_tree .\n //= require d3\n //= require underscore\n+\n+function fix() { \n+  alert(\"Fixed\")\n+}",
+    "new_file": false,
+    "renamed_file": false,
+    "deleted_file": false
+  }],
+  "compare_timeout": false,
+  "compare_same_ref": false
+}

data/spec/fixtures/label.json

@@ -0,0 +1 @@
+{"name": "Backlog", "color": "#DD10AA"}

data/spec/fixtures/labels.json

@@ -0,0 +1 @@
+[{"name": "Backlog", "color": "#DD10AA"},{"name": "Documentation", "color": "#1E80DD"}]

data/spec/fixtures/project_commit_comment.json

@@ -0,0 +1 @@
+{"note":"Nice code!","author":{"id":1,"username":"jsmith","email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-07-11T01:32:18Z"}}

data/spec/fixtures/project_commit_comments.json

@@ -0,0 +1 @@
+[{"note":"this is the 1st comment on commit 6104942438c14ec7bd21c6cd5bd995272b3faff6","author":{"id":11,"username":"admin","email":"admin@example.com","name":"A User","state":"active","created_at":"2014-03-06T08:17:35.000Z"}},{"note":"another discussion point on commit 6104942438c14ec7bd21c6cd5bd995272b3faff6","author":{"id":12,"username":"admin","email":"admin@example.com","name":"A User","state":"active","created_at":"2014-03-06T08:17:35.000Z"}}]

data/spec/fixtures/project_tag_annotated.json

@@ -0,0 +1 @@
+{"name": "v1.1.0","message": "Release 1.1.0","commit": {"id": "2695effb5807a22ff3d138d593fd856244e155e7","parents": [],"message": "Initial commit","authored_date": "2012-05-28T04:42:42-07:00","author_name": "John Smith","author email": "john@example.com","committer_name": "Jack Smith","committed_date": "2012-05-28T04:42:42-07:00","committer_email": "jack@example.com"}}

data/spec/fixtures/project_tag_lightweight.json

@@ -0,0 +1 @@
+{"name": "v1.0.0","message": null,"commit": {"id": "2695effb5807a22ff3d138d593fd856244e155e7","parents": [],"message": "Initial commit","authored_date": "2012-05-28T04:42:42-07:00","author_name": "John Smith","author email": "john@example.com","committer_name": "Jack Smith","committed_date": "2012-05-28T04:42:42-07:00","committer_email": "jack@example.com"}}

data/spec/fixtures/raw_file.json

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gem 'rails', '4.1.2'

data/spec/fixtures/shell_history.json

@@ -0,0 +1,2 @@
+party on, dudes
+be excellent to each other

data/spec/fixtures/tree.json

@@ -0,0 +1 @@
+[{"id":"a2cc3b0ffc1c7d06fab5642eb99ea387b57f22f8","name":"app","type":"tree","mode":"040000"},{"id":"63164bdfbc11b69f1032fbe35da0f1e9c18af2fd","name":"bin","type":"tree","mode":"040000"},{"id":"2cf682191722f20f00a371d7da58f6a35701c11d","name":"config","type":"tree","mode":"040000"},{"id":"2e76c8c1bbc46bcc762788a432d802d65a534a28","name":"db","type":"tree","mode":"040000"},{"id":"767cfc8360b50c50bb5bdde288b96a84e3efa66e","name":"doc","type":"tree","mode":"040000"},{"id":"3fa0d1024f5e372bf9e43d1dac47bd1e95ab0858","name":"lib","type":"tree","mode":"040000"},{"id":"4e79d0ac6225844602a1b9273b26d8996f777bf2","name":"log","type":"tree","mode":"040000"},{"id":"7cb7f593c6914d20fa6cc4ab5a7c34337a50e97c","name":"public","type":"tree","mode":"040000"},{"id":"d97169eef778f3cd1d4d94cbe3415b3166d15c71","name":"spec","type":"tree","mode":"040000"},{"id":"97c97da29fa97e2158cfdcdcb042af9da0bc3de4","name":"vendor","type":"tree","mode":"040000"},{"id":"d316760e4746059c117007507594a1d75b47df38","name":".gitignore","type":"blob","mode":"100644"},{"id":"f2e7cd477536f18d8e939faf452930b59a27063d","name":".travis.yml","type":"blob","mode":"100644"},{"id":"d5c68bda5f0fe703a80906f66cfe537ca807a5a6","name":"Capfile","type":"blob","mode":"100644"},{"id":"8f46eac03c6cd7ce03cda7ec3d78afdc6971e4c0","name":"Gemfile","type":"blob","mode":"100644"},{"id":"5e260573173b51eaa073661d7914fb0e935ee27f","name":"Gemfile.lock","type":"blob","mode":"100644"},{"id":"e57032f682b69f14243c09d66a0892a03b4c6045","name":"Procfile","type":"blob","mode":"100644"},{"id":"905e96da839dad683dfcf4e202bf1e030390b964","name":"README.md","type":"blob","mode":"100644"},{"id":"24a16769fd94926350a59f7b1cbd78e9e2674c57","name":"Rakefile","type":"blob","mode":"100644"},{"id":"b384d6d57c6a775a9b6bc35d79ad7f03e673a233","name":"config.ru","type":"blob","mode":"100644"}]

data/spec/gitlab/client/branches_spec.rb

@@ -39,7 +39,7 @@ describe Gitlab::Client do
 
   describe ".protect_branch" do
     before do
-      stub_put("/projects/3/repository/branches/api/protect", "protect_branch")
+      stub_put("/projects/3/repository/branches/api/protect", "branch")
       @branch = Gitlab.protect_branch(3, "api")
     end
 
@@ -49,13 +49,12 @@ describe Gitlab::Client do
 
     it "should return information about a protected repository branch" do
       expect(@branch.name).to eq("api")
-      expect(@branch.protected).to eq(true)
     end
   end
 
   describe ".unprotect_branch" do
     before do
-      stub_put("/projects/3/repository/branches/api/unprotect", "unprotect_branch")
+      stub_put("/projects/3/repository/branches/api/unprotect", "branch")
       @branch = Gitlab.unprotect_branch(3, "api")
     end
 
@@ -65,39 +64,21 @@ describe Gitlab::Client do
 
     it "should return information about an unprotected repository branch" do
       expect(@branch.name).to eq("api")
-      expect(@branch.protected).to eq(false)
     end
   end
 
   describe ".create_branch" do
-    context "with branch name" do
-      before do
-        stub_post("/projects/3/repository/branches", "create_branch")
-        @branch = Gitlab.create_branch(3, "api","master")
-      end
-
-      it "should get the correct resource" do
-        expect(a_post("/projects/3/repository/branches")).to have_been_made
-      end
-
-      it "should return information about a new repository branch" do
-        expect(@branch.name).to eq("api")
-      end
+    before do
+      stub_post("/projects/3/repository/branches", "branch")
+      @branch = Gitlab.create_branch(3, "api", "master")
     end
-    context "with commit hash" do
-      before do
-        stub_post("/projects/3/repository/branches", "create_branch")
-        @branch = Gitlab.create_branch(3, "api","949b1df930bedace1dbd755aaa4a82e8c451a616")
-      end
-
-      it "should get the correct resource" do
-        expect(a_post("/projects/3/repository/branches")).to have_been_made
-      end
-
-      it "should return information about a new repository branch" do
-        expect(@branch.name).to eq("api")
-      end
+
+    it "should get the correct resource" do
+      expect(a_post("/projects/3/repository/branches")).to have_been_made
     end
-  end
 
+    it "should return information about a new repository branch" do
+      expect(@branch.name).to eq("api")
+    end
+  end
 end