gitlab 3.3.0 → 3.4.0

data/lib/gitlab/objectified_hash.rb

@@ -11,11 +11,17 @@ module Gitlab
       end
     end
 
+    # @return [Hash] The original hash.
     def to_hash
       @hash
     end
     alias_method :to_h, :to_hash
 
+    # @return [String] Formatted string with the class name, object id and original hash.
+    def inspect
+      "#<#{self.class}:#{object_id} {hash: #{@hash.inspect}}"
+    end
+
     # Delegate to ObjectifiedHash.
     def method_missing(key)
       @data.key?(key.to_s) ? @data[key.to_s] : nil

data/lib/gitlab/request.rb

@@ -19,6 +19,8 @@ module Gitlab
         ObjectifiedHash.new body
       elsif body.is_a? Array
         body.collect! { |e| ObjectifiedHash.new(e) }
+      elsif body.nil?
+        false
       else
         raise Error::Parsing.new "Couldn't parse a response body"
       end
@@ -35,25 +37,25 @@ module Gitlab
 
     def get(path, options={})
       set_httparty_config(options)
-      set_private_token_header(options)
+      set_authorization_header(options)
       validate self.class.get(@endpoint + path, options)
     end
 
     def post(path, options={})
       set_httparty_config(options)
-      set_private_token_header(options, path)
+      set_authorization_header(options, path)
       validate self.class.post(@endpoint + path, options)
     end
 
     def put(path, options={})
       set_httparty_config(options)
-      set_private_token_header(options)
+      set_authorization_header(options)
       validate self.class.put(@endpoint + path, options)
     end
 
     def delete(path, options={})
       set_httparty_config(options)
-      set_private_token_header(options)
+      set_authorization_header(options)
       validate self.class.delete(@endpoint + path, options)
     end
 
@@ -77,23 +79,24 @@ module Gitlab
 
     # Sets a base_uri and default_params for requests.
     # @raise [Error::MissingCredentials] if endpoint not set.
-    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
-
+    def set_request_defaults(sudo=nil)
+      raise Error::MissingCredentials.new("Please set an endpoint to API") unless @endpoint
       self.class.default_params :sudo => sudo
       self.class.default_params.delete(:sudo) if sudo.nil?
     end
 
     private
 
-    # Sets a PRIVATE-TOKEN header for requests.
-    # @raise [Error::MissingCredentials] if private_token not set.
-    def set_private_token_header(options, path=nil)
+    # Sets a PRIVATE-TOKEN or Authorization header for requests.
+    # @raise [Error::MissingCredentials] if private_token and auth_token are not set.
+    def set_authorization_header(options, path=nil)
       unless path == '/session'
-        raise Error::MissingCredentials.new("Please set a private_token for user") unless @private_token
-        options[:headers] = {'PRIVATE-TOKEN' => @private_token}
+        raise Error::MissingCredentials.new("Please provide a private_token or auth_token for user") unless @private_token
+        if @private_token.length <= 20
+          options[:headers] = {'PRIVATE-TOKEN' => @private_token}
+        else
+          options[:headers] = {'Authorization' => "Bearer #{@private_token}"}
+        end
       end
     end
 
@@ -106,8 +109,21 @@ module Gitlab
     end
 
     def error_message(response)
-      "Server responded with code #{response.code}, message: #{response.parsed_response.message}. " \
+      "Server responded with code #{response.code}, message: " \
+      "#{handle_error(response.parsed_response.message)}. " \
       "Request URI: #{response.request.base_uri}#{response.request.path}"
     end
+
+    # Handle error response message in case of nested hashes
+    def handle_error(message)
+      if message.is_a? Gitlab::ObjectifiedHash
+        message.to_h.sort.map do |key, val|
+          "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k,v| "(#{k}: #{v.join(' ')})"} : val).join(' ')}"
+        end.join(', ')
+      else
+        message
+      end
+    end
+
   end
 end

data/lib/gitlab/shell.rb

@@ -8,80 +8,79 @@ 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
+  class << self
+    attr_reader :arguments, :command
 
-    comp = proc { |s| actions.map(&:to_s).grep(/^#{Regexp.escape(s)}/) }
-
-    Readline.completion_proc = comp
-    Readline.completion_append_character = ' '
-
-    client = Gitlab::Client.new(endpoint: '')
-
-    while buf = Readline.readline('gitlab> ')
+    def start
       trap('INT') { quit_shell } # capture ctrl-c
-
-      next if buf.nil? || buf.empty?
-      quit_shell if buf == 'exit'
-
-      history << buf
-
-      begin
-        buf = Shellwords.shellwords(buf)
-      rescue ArgumentError => e
-        puts e.message
-        next
+      setup
+
+      while buffer = Readline.readline('gitlab> ')
+        begin
+          parse_input buffer
+
+          yaml_load_arguments! @arguments
+          @arguments.map! { |arg| symbolize_keys arg }
+
+          case buffer
+          when nil, ''
+            next
+          when 'exit'
+            quit_shell
+          when /^\bhelp\b+/
+            puts help(arguments[0]) { |out| out.gsub!(/Gitlab\./, 'gitlab> ') }
+          else
+            history << buffer
+
+            data = execute command, arguments
+            output_table command, arguments, data
+          end
+        rescue => e
+          puts e.message
+        end
       end
 
-      cmd = buf.shift
-      args = buf.count > 0 ? buf : []
+      quit_shell # save history if user presses ctrl-d
+    end
 
-      if cmd == 'help'
-        methods = []
+    def parse_input(buffer)
+      buf = Shellwords.shellwords(buffer)
 
-        actions.each do |action|
-          methods << {
-            name: action.to_s,
-            owner: client.method(action).owner.to_s
-          }
-        end
-
-        args[0].nil? ? Gitlab::Help.get_help(methods) :
-                       Gitlab::Help.get_help(methods, args[0])
-        next
-      end
+      @command = buf.shift
+      @arguments = buf.count > 0 ? buf : []
+    end
 
-      syntax_errors = false
+    def setup
+      history.load
 
-      begin
-        yaml_load_and_symbolize_hash!(args)
-      rescue
-        syntax_errors = true
-      end
+      Readline.completion_proc = completion
+      Readline.completion_append_character = ' '
+    end
 
-      # errors have been displayed, return to the prompt
-      next if syntax_errors 
+    # Gets called when user hits TAB key to do completion
+    def completion
+      proc { |str| actions.map(&:to_s).grep(/^#{Regexp.escape(str)}/) }
+    end
 
-      data = if actions.include?(cmd.to_sym)
+    # Execute a given command with arguements
+    def execute(cmd = command, args = arguments)
+      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."
+        raise "Unknown command: #{cmd}. " +
+              "See the 'help' for a list of valid commands."
       end
+    end
 
-      output_table(cmd, args, data)
+    def quit_shell
+      history.save
+      exit
     end
-  end
 
-  def self.quit_shell
-    history.save
-    exit
-  end
+    def history
+      @history ||= History.new
+    end
 
-  def self.history
-    @history ||= History.new
-  end
+  end  # class << self
 end

data/lib/gitlab/version.rb

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

data/spec/fixtures/branch_delete.json

@@ -0,0 +1,3 @@
+{
+  "branch_name": "api"
+}

data/spec/fixtures/merge_request_changes.json

@@ -0,0 +1 @@
+{"id":2,"iid":5,"project_id":3,"title":"Uncovered","description":"","state":"opened","created_at":"2015-03-15T23:15:13.292+01:00","updated_at":"2015-03-15T23:15:14.132+01:00","target_branch":"master","source_branch":"uncovered","upvotes":0,"downvotes":0,"author":{"name":"Dominik Sander","username":"dsander","id":1,"state":"active","avatar_url":"https://secure.gravatar.com/avatar/7f01734389dd6730d076ddee04838bd3?s=40\u0026d=identicon"},"assignee":null,"source_project_id":6,"target_project_id":6,"labels":[],"milestone":null,"changes":[{"old_path":"lib/omniauth/builder.rb","new_path":"lib/omniauth/builder.rb","a_mode":"100644","b_mode":"100644","diff":"--- a/lib/omniauth/builder.rb\n+++ b/lib/omniauth/builder.rb\n@@ -7,11 +7,13 @@ module OmniAuth\n       else\n         @app = app\n         super(\u0026block)\n+        two = 1 # woah! uncovered\n         @ins \u003c\u003c @app\n       end\n     end\n \n     def rack14?\n+      one = 2 # thats oke!\n       Rack.release.split('.')[1].to_i \u003e= 4\n     end\n ","new_file":false,"renamed_file":false,"deleted_file":false}]}

data/spec/fixtures/milestone_issues.json

@@ -0,0 +1 @@
+[{"id":1,"project_id":3,"title":"Culpa eius recusandae suscipit autem distinctio dolorum.","description":null,"labels":[],"milestone":{"id": 1},"assignee":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"author":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"closed":false,"updated_at":"2012-09-17T09:42:20Z","created_at":"2012-09-17T09:42:20Z"},{"id":6,"project_id":3,"title":"Ut in dolorum omnis sed sit aliquam.","description":null,"labels":[],"milestone":{"id": 1},"assignee":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"author":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"closed":false,"updated_at":"2012-09-17T09:42:20Z","created_at":"2012-09-17T09:42:20Z"},{"id":12,"project_id":3,"title":"Veniam et tempore quidem eum reprehenderit cupiditate non aut velit eaque.","description":null,"labels":[],"milestone":{"id": 1},"assignee":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"author":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"closed":false,"updated_at":"2012-09-17T09:42:20Z","created_at":"2012-09-17T09:42:20Z"},{"id":21,"project_id":3,"title":"Vitae ea aliquam et quo eligendi sapiente voluptatum labore hic nihil culpa.","description":null,"labels":[],"milestone":{"id": 1},"assignee":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"author":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"closed":false,"updated_at":"2012-09-17T09:42:20Z","created_at":"2012-09-17T09:42:20Z"},{"id":26,"project_id":3,"title":"Quo enim est nihil atque placeat voluptas neque eos voluptas.","description":null,"labels":[],"milestone":{"id": 1},"assignee":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"author":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"closed":false,"updated_at":"2012-09-17T09:42:20Z","created_at":"2012-09-17T09:42:20Z"},{"id":32,"project_id":3,"title":"Deserunt tenetur impedit est beatae voluptas voluptas quaerat quisquam.","description":null,"labels":[],"milestone":{"id": 1},"assignee":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"author":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"closed":false,"updated_at":"2012-09-17T09:42:20Z","created_at":"2012-09-17T09:42:20Z"}]

data/spec/fixtures/project_search.json

@@ -0,0 +1 @@
+[{"id":3,"code":"gitlab","name":"Gitlab","description":null,"path":"gitlab","default_branch":null,"owner":{"id":1,"email":"john@example.com","name":"John Smith","blocked":false,"created_at":"2012-09-17T09:41:56Z"},"private":true,"issues_enabled":true,"merge_requests_enabled":true,"wall_enabled":true,"wiki_enabled":true,"created_at":"2012-09-17T09:41:58Z"}]

data/spec/fixtures/repository_file.json

@@ -0,0 +1 @@
+{"file_path":"path","branch_name":"branch","encoding":"base64","content":"Y29udGVudA==","commit_message":"commit message"}

data/spec/gitlab/cli_helpers_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Gitlab::CLI::Helpers do
+  describe ".method_owners" do
+    before do
+      @methods = Gitlab::CLI::Helpers.method_owners
+    end
+    it "should return Array of Hashes containing method names and owners" do
+      expect(@methods).to be_a Array
+      expect(@methods.all? { |m| m.is_a? Hash} ).to be true
+      expect(@methods.all? { |m| m.keys.sort === [:name, :owner]} ).to be true
+    end
+  end
+
+  describe ".valid_command?" do
+    it "should return true when command is valid" do
+      expect(Gitlab::CLI::Helpers.valid_command? 'merge_requests').to be_truthy
+    end
+    it "should return false when command is NOT valid" do
+      expect(Gitlab::CLI::Helpers.valid_command? 'mmmmmerge_requests').to be_falsy
+    end
+  end
+
+  describe ".symbolize_keys" do
+    context "when input is a Hash" do
+      it "should return a Hash with symbols for keys" do
+        hash = {'key1' => 'val1', 'key2' => 'val2'}
+        symbolized_hash = Gitlab::CLI::Helpers.symbolize_keys(hash)
+        expect(symbolized_hash).to eq({key1: 'val1', key2: 'val2'})
+      end
+    end
+    context "when input is NOT a Hash" do
+      it "should return input untouched" do
+        array = [1, 2, 3]
+        new_array = Gitlab::CLI::Helpers.symbolize_keys(array) 
+        expect(new_array).to eq([1, 2, 3])
+      end
+    end
+  end
+
+  describe ".yaml_load_arguments!" do
+    context "when arguments are YAML" do
+      it "should return Ruby objects" do
+        arguments = ["{foo: bar, sna: fu}"] 
+        Gitlab::CLI::Helpers.yaml_load_arguments! arguments
+        expect(arguments).to eq([{'foo' => 'bar', 'sna' => 'fu'}])
+      end
+    end
+
+    context "when input is NOT valid YAML" do
+      it "should raise" do
+        ruby_array = [1, 2, 3, 4]
+        expect { Gitlab::CLI::Helpers.yaml_load_arguments! ruby_array}.to raise_exception
+      end
+    end
+  end
+
+end

data/spec/gitlab/cli_spec.rb

@@ -22,9 +22,8 @@ describe Gitlab::CLI do
     context "when command is help" do
       it "should show available actions" do
         output = capture_output { Gitlab::CLI.run('help') }
-        expect(output).to include('Available commands')
+        expect(output).to include('Help Topics')
         expect(output).to include('MergeRequests')
-        expect(output).to include('team_members')
       end
     end
 

data/spec/gitlab/client/branches_spec.rb

@@ -81,4 +81,19 @@ describe Gitlab::Client do
       expect(@branch.name).to eq("api")
     end
   end
+
+  describe ".delete_branch" do
+    before do
+      stub_delete("/projects/3/repository/branches/api", "branch_delete")
+      @branch = Gitlab.delete_branch(3, "api")
+    end
+
+    it "should get the correct resource" do
+      expect(a_delete("/projects/3/repository/branches/api")).to have_been_made
+    end
+
+    it "should return information about the deleted repository branch" do
+      expect(@branch.branch_name).to eq("api")
+    end
+  end
 end

data/spec/gitlab/client/merge_requests_spec.rb

@@ -38,18 +38,6 @@ describe Gitlab::Client do
       stub_post("/projects/3/merge_requests", "merge_request")
     end
 
-    it "should fail if it doesn't have a source_branch" do
-      expect {
-        Gitlab.create_merge_request(3, 'New merge request', :target_branch => 'master')
-      }.to raise_error Gitlab::Error::MissingAttributes
-    end
-
-    it "should fail if it doesn't have a target_branch" do
-      expect {
-        Gitlab.create_merge_request(3, 'New merge request', :source_branch => 'dev')
-      }.to raise_error Gitlab::Error::MissingAttributes
-    end
-
     it "should return information about a merge request" do
       @merge_request = Gitlab.create_merge_request(3, 'New feature',
         :source_branch => 'api',
@@ -143,4 +131,24 @@ describe Gitlab::Client do
       expect(@merge_request.author.id).to eq(1)
     end
   end
+
+  describe ".merge_request_changes" do
+    before do
+      stub_get("/projects/3/merge_request/2/changes", "merge_request_changes")
+      @mr_changes = Gitlab.merge_request_changes(3, 2)
+    end
+
+    it "should get the correct resource" do
+      expect(a_get("/projects/3/merge_request/2/changes")).to have_been_made
+    end
+
+    it "should return the merge request changes" do
+      expect(@mr_changes.changes).to be_a Array
+      expect(@mr_changes.changes.first['old_path']).to eq('lib/omniauth/builder.rb')
+      expect(@mr_changes.id).to eq(2)
+      expect(@mr_changes.project_id).to eq(3)
+      expect(@mr_changes.source_branch).to eq('uncovered')
+      expect(@mr_changes.target_branch).to eq('master')
+    end
+  end
 end

data/spec/gitlab/client/milestones_spec.rb

@@ -31,6 +31,22 @@ describe Gitlab::Client do
       expect(@milestone.project_id).to eq(3)
     end
   end
+  
+  describe ".milestone_issues" do
+    before do
+      stub_get("/projects/3/milestones/1/issues", "milestone_issues")
+      @milestone_issues = Gitlab.milestone_issues(3, 1)
+    end
+    
+    it "should get the correct resource" do
+      expect(a_get("/projects/3/milestones/1/issues")).to have_been_made
+    end
+
+    it "should return an array of milestone's issues" do
+      expect(@milestone_issues).to be_an Array
+      expect(@milestone_issues.first.milestone.id).to eq(1)
+    end
+  end
 
   describe ".create_milestone" do
     before do

data/spec/gitlab/client/notes_spec.rb

@@ -152,5 +152,22 @@ describe Gitlab::Client do
         expect(@note.author.name).to eq("John Smith")
       end
     end
+
+    context "when merge_request note" do
+      before do
+        stub_post("/projects/3/merge_requests/7/notes", "note")
+        @note = Gitlab.create_merge_request_note(3, 7, "The solution is rather tricky")
+      end
+
+      it "should get the correct resource" do
+        expect(a_post("/projects/3/merge_requests/7/notes").
+          with(:body => {:body => 'The solution is rather tricky'})).to have_been_made
+      end
+
+      it "should return information about a created note" do
+        expect(@note.body).to eq("The solution is rather tricky")
+        expect(@note.author.name).to eq("John Smith")
+      end
+    end
   end
 end