gitlab 4.2.0 → 4.3.0

data/spec/gitlab/error_spec.rb

@@ -1,45 +1,72 @@
 require "spec_helper"
+require "stringio"
 
 describe Gitlab::Error do
-  describe "#handle_message" do
-		require "stringio"
+  let(:request_object)  { HTTParty::Request.new(Net::HTTP::Get, '/') }
+  let(:response_object) { Net::HTTPOK.new('1.1', 200, 'OK') }
+  let(:body)            { StringIO.new("{foo:'bar'}") }
+  let(:parsed_response) { -> { body } }
 
-    before do
-      request_object  = HTTParty::Request.new(Net::HTTP::Get, '/')
-      response_object = Net::HTTPOK.new('1.1', 200, 'OK')
-      body = StringIO.new("{foo:'bar'}")
-      def body.message; self.string; end
+  let(:response) do
+    HTTParty::Response.new(
+      request_object,
+      response_object,
+      parsed_response,
+      body: body
+    )
+  end
 
-      parsed_response = lambda { body }
-      response_object['last-modified'] = Date.new(2010, 1, 15).to_s
-      response_object['content-length'] = "1024"
+  let(:error) { Gitlab::Error::ResponseError.new(response) }
+  let(:date)  { Date.new(2010, 1, 15).to_s }
 
-      response = HTTParty::Response.new(request_object, response_object, parsed_response, body: body)
-      @error = Gitlab::Error::ResponseError.new(response)
+  before do
+    def body.message
+      string
+    end
+
+    response_object['last-modified']  = date
+    response_object['content-length'] = "1024"
+  end
 
-      @array = Array.new(['First message.', 'Second message.'])
-      @obj_h = Gitlab::ObjectifiedHash.new(user: ['not set'],
-                                           password: ['too short'],
-                                           embed_entity: { foo: ['bar'], sna: ['fu'] })
+  describe "#handle_message" do
+    let(:array) { Array.new(['First message.', 'Second message.']) }
+    let(:obj_h) do
+      Gitlab::ObjectifiedHash.new(
+        user:         ['not set'],
+        password:     ['too short'],
+        embed_entity: { foo: ['bar'], sna: ['fu'] }
+      )
     end
 
     context "when passed an ObjectifiedHash" do
-      it "should return a joined string of error messages sorted by key" do
-        expect(@error.send(:handle_message, @obj_h)).to eq("'embed_entity' (foo: bar) (sna: fu), 'password' too short, 'user' not set")
+      it "returns a joined string of error messages sorted by key" do
+        expect(error.send(:handle_message, obj_h)).
+          to eq(
+            "'embed_entity' (foo: bar) (sna: fu), 'password' too short, 'user' not set"
+          )
       end
     end
 
     context "when passed an Array" do
-      it "should return a joined string of messages" do
-        expect(@error.send(:handle_message, @array)).to eq("First message. Second message.")
+      it "returns a joined string of messages" do
+        expect(error.send(:handle_message, array)).
+          to eq("First message. Second message.")
       end
     end
 
     context "when passed a String" do
-      it "should return the String untouched" do
-        error = 'this is an error string'
-        expect(@error.send(:handle_message, error)).to eq('this is an error string')
+      it "returns the String untouched" do
+        error_str = 'this is an error string'
+
+        expect(error.send(:handle_message, error_str)).
+          to eq(error_str)
       end
     end
   end
+
+  describe "#response_message" do
+    it "returns the message of the parsed_response" do
+      expect(error.response_message).to eq(body.string)
+    end
+  end
 end

data/spec/gitlab/file_response_spec.rb

@@ -6,26 +6,26 @@ describe Gitlab::FileResponse do
   end
 
   context '.empty?' do
-    it "shoudl return false" do
+    it "returns false" do
       expect(@file_response.empty?).to be false
     end
   end
 
   context '.to_hash' do
-    it "should have `filename` key and `data` key" do
+    it "has `filename` key and `data` key" do
       h = @file_response.to_hash
-      expect(h.has_key?(:filename)).to be_truthy
-      expect(h.has_key?(:data)).to be_truthy
+      expect(h.key?(:filename)).to be_truthy
+      expect(h.key?(:data)).to be_truthy
     end
   end
 
   context '.parse_headers!' do
-    it "should parse headers" do
+    it "parses headers" do
       @file_response.parse_headers!('Content-Disposition' => 'attachment; filename=artifacts.zip')
       expect(@file_response.filename).to eq "artifacts.zip"
     end
 
-    it "should handle quoted filenames" do
+    it "handles quoted filenames" do
       @file_response.parse_headers!('Content-Disposition' => 'attachment; filename="artifacts.zip"')
       expect(@file_response.filename).to eq "artifacts.zip"
     end

data/spec/gitlab/help_spec.rb

@@ -3,14 +3,14 @@ require 'spec_helper'
 describe Gitlab::Help do
   describe ".ri_cmd" do
     context "ri command found" do
-      it "should return the path to RI" do
+      it "returns the path to RI" do
         allow(Gitlab::Help).to receive(:`).with(/which ri/).and_return('/usr/bin/ri')
         expect(Gitlab::Help.ri_cmd).to eq('/usr/bin/ri')
       end
     end
 
     context "ri command NOT found" do
-      it "should raise" do
+      it "raises RuntimeError" do
         allow(Gitlab::Help).to receive(:`).with(/which ri/).and_return('')
         expect { Gitlab::Help.ri_cmd }.to raise_error RuntimeError
       end
@@ -23,11 +23,11 @@ describe Gitlab::Help do
       @help_output = "Gitlab.#{@cmd}(4, 'new-branch', 'master')"
       @help_output_with_options = "Gitlab.groups({ per_page: 3 })"
     end
-    it "should return a String of modified output" do
+    it "returns a String of modified output" do
       Gitlab::Help.change_help_output! @cmd, @help_output
       expect(@help_output).to eq("Gitlab.create_branch 4 'new-branch' 'master'")
     end
-    it "should format options hash and return a String of modified output" do
+    it "formats options hash and return a String of modified output" do
       Gitlab::Help.change_help_output! 'groups', @help_output_with_options
       expect(@help_output_with_options).to eq("Gitlab.groups \"{ per_page: 3 }\"")
     end
@@ -38,7 +38,7 @@ describe Gitlab::Help do
       @cmd = 'create_tag'
       @namespace = Gitlab::Help.namespace @cmd
     end
-    it "should return the full namespace for a command" do
+    it "returns the full namespace for a command" do
       expect(@namespace).to be_a String
       expect(@namespace).to eq("Gitlab::Client::Tags.#{@cmd}")
     end

data/spec/gitlab/objectified_hash_spec.rb

@@ -6,42 +6,42 @@ describe Gitlab::ObjectifiedHash do
     @oh = Gitlab::ObjectifiedHash.new @hash
   end
 
-  it "should objectify hash" do
+  it "objectifies a hash" do
     expect(@oh.a).to eq(@hash[:a])
     expect(@oh.b).to eq(@hash[:b])
   end
 
   describe "#to_hash" do
-    it "should return an original hash" do
+    it "returns an original hash" do
       expect(@oh.to_hash).to eq(@hash)
     end
 
-    it "should have an alias #to_h" do
+    it "has an alias #to_h" do
       expect(@oh.respond_to?(:to_h)).to be_truthy
     end
   end
 
   describe "#inspect" do
-    it "should return a formatted string" do
+    it "returns a formatted string" do
       pretty_string = "#<#{@oh.class.name}:#{@oh.object_id} {hash: #{@hash}}"
       expect(@oh.inspect).to eq(pretty_string)
     end
   end
 
   describe "#respond_to" do
-    it "should return true for methods this object responds to through method_missing as sym" do
+    it "returns true for methods this object responds to through method_missing as sym" do
       expect(@oh.respond_to?(:a)).to be_truthy
     end
 
-    it "should return true for methods this object responds to through method_missing as string" do
+    it "returns true for methods this object responds to through method_missing as string" do
       expect(@oh.respond_to?('string')).to be_truthy
     end
 
-    it "should not care if you use a string or symbol to reference a method" do
+    it "does not care if you use a string or symbol to reference a method" do
       expect(@oh.respond_to?(:string)).to be_truthy
     end
 
-    it "should not care if you use a string or symbol to reference a method" do
+    it "does not care if you use a string or symbol to reference a method" do
       expect(@oh.respond_to?('symbol')).to be_truthy
     end
   end

data/spec/gitlab/page_links_spec.rb

@@ -6,7 +6,7 @@ describe Gitlab::PageLinks do
   end
 
   context '.extract_links' do
-    it 'should extract link header appropriately' do
+    it 'extracts link header appropriately' do
       expect(@page_links.last).to eql 'http://example.com/api/v3/projects?page=20&per_page=5'
       expect(@page_links.first).to eql 'http://example.com/api/v3/projects?page=1&per_page=5'
       expect(@page_links.next).to eql 'http://example.com/api/v3/projects?page=9&per_page=5'

data/spec/gitlab/paginated_response_spec.rb

@@ -6,7 +6,7 @@ describe Gitlab::PaginatedResponse do
     @paginated_response = Gitlab::PaginatedResponse.new array
   end
 
-  it "should respond to *_page and has_*_page methods" do
+  it "responds to *_page and has_*_page methods" do
     expect(@paginated_response).to respond_to :first_page
     expect(@paginated_response).to respond_to :last_page
     expect(@paginated_response).to respond_to :next_page
@@ -18,7 +18,7 @@ describe Gitlab::PaginatedResponse do
   end
 
   context '.parse_headers!' do
-    it "should parse headers" do
+    it "parses headers" do
       @paginated_response.parse_headers!('Link' => "<http://example.com/api/v3/projects?page=1&per_page=5>; rel=\"first\", <http://example.com/api/v3/projects?page=20&per_page=5>; rel=\"last\"")
       client = @paginated_response.client = double('client')
       first_page_response = double('first_page_response')
@@ -38,7 +38,7 @@ describe Gitlab::PaginatedResponse do
   end
 
   context '.each_page' do
-    it "should iterate pages" do
+    it "iterates pages" do
       next_page = double('next_page')
       allow(@paginated_response).to receive(:has_next_page?).and_return(true)
       allow(@paginated_response).to receive(:next_page).and_return(next_page)
@@ -48,7 +48,7 @@ describe Gitlab::PaginatedResponse do
   end
 
   context '.auto_paginate' do
-    it "should returns an array if block is not given" do
+    it "returns an array if block is not given" do
       next_page = double('next_page')
       allow(@paginated_response).to receive(:has_next_page?).and_return(true)
       allow(@paginated_response).to receive(:next_page).and_return(next_page)

data/spec/gitlab/request_spec.rb

@@ -1,16 +1,16 @@
 require 'spec_helper'
 
 describe Gitlab::Request do
-  it { should respond_to :get }
-  it { should respond_to :post }
-  it { should respond_to :put }
-  it { should respond_to :delete }
+  it { is_expected.to respond_to :get }
+  it { is_expected.to respond_to :post }
+  it { is_expected.to respond_to :put }
+  it { is_expected.to respond_to :delete }
   before do
     @request = Gitlab::Request.new
   end
 
   describe ".default_options" do
-    it "should have default values" do
+    it "has default values" do
       default_options = Gitlab::Request.default_options
       expect(default_options).to be_a Hash
       expect(default_options[:parser]).to be_a Proc
@@ -21,7 +21,7 @@ describe Gitlab::Request do
   end
 
   describe ".parse" do
-    it "should return ObjectifiedHash" do
+    it "returns ObjectifiedHash" do
       body = JSON.unparse(a: 1, b: 2)
       expect(Gitlab::Request.parse(body)).to be_an Gitlab::ObjectifiedHash
       expect(Gitlab::Request.parse("true")).to be true
@@ -31,43 +31,43 @@ describe Gitlab::Request do
     end
   end
 
-  describe "#set_request_defaults" do
+  describe "#request_defaults" do
     context "when endpoint is not set" do
-      it "should raise Error::MissingCredentials" do
+      it "raises Error::MissingCredentials" do
         @request.endpoint = nil
         expect do
-          @request.set_request_defaults
+          @request.request_defaults
         end.to raise_error(Gitlab::Error::MissingCredentials, 'Please set an endpoint to API')
       end
     end
 
     context "when endpoint is set" do
       before(:each) do
-        @request.endpoint = 'http://rabbit-hole.example.org'
+        @request.endpoint = 'http://rabbit-hole.example.com'
       end
 
-      it "should set default_params" do
-        @request.set_request_defaults('sudoer')
+      it "sets default_params" do
+        @request.request_defaults('sudoer')
         expect(Gitlab::Request.default_params).to eq(sudo: 'sudoer')
       end
     end
   end
 
-  describe "#set_authorization_header" do
-    it "should raise MissingCredentials when auth_token and private_token are not set" do
+  describe "#authorization_header" do
+    it "raises MissingCredentials when auth_token and private_token are not set" do
       expect do
-        @request.send(:set_authorization_header, {})
+        @request.send(:authorization_header, {})
       end.to raise_error(Gitlab::Error::MissingCredentials)
     end
 
-    it "should set the correct header when given a private_token" do
+    it "sets the correct header when given a private_token" do
       @request.private_token = 'ys9BtunN3rDKbaJCYXaN'
-      expect(@request.send(:set_authorization_header, {})).to eq("PRIVATE-TOKEN" => 'ys9BtunN3rDKbaJCYXaN')
+      expect(@request.send(:authorization_header, {})).to eq("PRIVATE-TOKEN" => 'ys9BtunN3rDKbaJCYXaN')
     end
 
-    it "should set the correct header when setting an auth_token via the private_token config option" do
+    it "sets the correct header when setting an auth_token via the private_token config option" do
       @request.private_token = '3225e2804d31fea13fc41fc83bffef00cfaedc463118646b154acc6f94747603'
-      expect(@request.send(:set_authorization_header, {})).to eq("Authorization" => "Bearer 3225e2804d31fea13fc41fc83bffef00cfaedc463118646b154acc6f94747603")
+      expect(@request.send(:authorization_header, {})).to eq("Authorization" => "Bearer 3225e2804d31fea13fc41fc83bffef00cfaedc463118646b154acc6f94747603")
     end
   end
 end

data/spec/gitlab/shell_spec.rb

@@ -7,7 +7,7 @@ describe Gitlab::Shell do
 
   describe ".execute" do
     context "invalid command" do
-      it "should raise" do
+      it "raises RuntimeError" do
         expect { Gitlab::Shell.execute 'foobar', [] }.to raise_error(RuntimeError)
       end
     end
@@ -18,27 +18,27 @@ describe Gitlab::Shell do
       @history = Gitlab::Shell.history
     end
 
-    it "should return a Gitlab::Shell::History instance" do
+    it "returns a Gitlab::Shell::History instance" do
       expect(@history).to be_a Gitlab::Shell::History
     end
-    it "should respond to :save" do
+    it "responds to :save" do
       expect(@history).to respond_to :save
     end
-    it "should respond to :load" do
+    it "responds to :load" do
       expect(@history).to respond_to :load
     end
-    it "should respond to :<<" do
+    it "responds to :<<" do
       expect(@history).to respond_to :<<
     end
   end
 
   describe ".setup" do
-    it "should set the Readline completion_proc" do
+    it "sets the Readline completion_proc" do
       completion = Readline.completion_proc
       expect(completion).to be_truthy
       expect(completion).to be_a Proc
     end
-    it "should set the Readline completion_append_character" do
+    it "sets the Readline completion_append_character" do
       completion_character = Readline.completion_append_character
       expect(completion_character).to eq(' ')
     end
@@ -48,21 +48,21 @@ describe Gitlab::Shell do
     before do
       @comp = Gitlab::Shell.completion
     end
-    it "should return a Proc object" do
+    it "returns a Proc object" do
       expect(@comp).to be_a Proc
     end
     context "called with an argument" do
-      it "should return an Array of matching commands" do
+      it "returns an Array of matching commands" do
         completed_cmds = @comp.call 'group'
         expect(completed_cmds).to be_a Array
-        expect(completed_cmds.sort).to eq(%w(group group_members group_projects group_search groups))
+        expect(completed_cmds.sort).to eq(%w(group group_member group_members group_projects group_search group_subgroups group_variable group_variables groups))
       end
     end
   end
 
   describe ".parse_input" do
     context "with arguments" do
-      it "should set command & arguments" do
+      it "sets command & arguments" do
         Gitlab::Shell.parse_input('create_branch 1 "api" "master"')
         expect(Gitlab::Shell.command).to eq('create_branch')
         expect(Gitlab::Shell.arguments).to eq(%w(1 api master))
@@ -70,7 +70,7 @@ describe Gitlab::Shell do
     end
 
     context "without arguments" do
-      it 'should set command & empty arguments' do
+      it 'sets command & empty arguments' do
         Gitlab::Shell.parse_input('exit')
         expect(Gitlab::Shell.command).to eq('exit')
         expect(Gitlab::Shell.arguments).to be_empty

data/spec/gitlab_spec.rb

@@ -4,11 +4,11 @@ describe Gitlab do
   after { Gitlab.reset }
 
   describe ".client" do
-    it "should be a Gitlab::Client" do
+    it "is a Gitlab::Client" do
       expect(Gitlab.client).to be_a Gitlab::Client
     end
 
-    it "should not override each other" do
+    it "does not override each other" do
       client1 = Gitlab.client(endpoint: 'https://api1.example.com', private_token: '001')
       client2 = Gitlab.client(endpoint: 'https://api2.example.com', private_token: '002')
       expect(client1.endpoint).to eq('https://api1.example.com')
@@ -17,14 +17,14 @@ describe Gitlab do
       expect(client2.private_token).to eq('002')
     end
 
-    it "should set private_token to the auth_token when provided" do
+    it "sets private_token to the auth_token when provided" do
       client = Gitlab.client(endpoint: 'https://api2.example.com', auth_token: '3225e2804d31fea13fc41fc83bffef00cfaedc463118646b154acc6f94747603')
       expect(client.private_token).to eq('3225e2804d31fea13fc41fc83bffef00cfaedc463118646b154acc6f94747603')
     end
   end
 
   describe ".actions" do
-    it "should return an array of client methods" do
+    it "returns an array of client methods" do
       actions = Gitlab.actions
       expect(actions).to be_an Array
       expect(actions.first).to be_a Symbol
@@ -33,41 +33,41 @@ describe Gitlab do
   end
 
   describe ".endpoint=" do
-    it "should set endpoint" do
+    it "sets endpoint" do
       Gitlab.endpoint = 'https://api.example.com'
       expect(Gitlab.endpoint).to eq('https://api.example.com')
     end
   end
 
   describe ".private_token=" do
-    it "should set private_token" do
+    it "sets private_token" do
       Gitlab.private_token = 'secret'
       expect(Gitlab.private_token).to eq('secret')
     end
   end
 
   describe ".auth_token=" do
-    it "should set auth_token", focus: true do
+    it "sets auth_token", focus: true do
       Gitlab.auth_token = 'auth_secret'
       expect(Gitlab.private_token).to eq('auth_secret')
     end
   end
 
   describe ".sudo=" do
-    it "should set sudo" do
+    it "sets sudo" do
       Gitlab.sudo = 'user'
       expect(Gitlab.sudo).to eq('user')
     end
   end
 
   describe ".user_agent" do
-    it "should return default user_agent" do
+    it "returns default user_agent" do
       expect(Gitlab.user_agent).to eq(Gitlab::Configuration::DEFAULT_USER_AGENT)
     end
   end
 
   describe ".user_agent=" do
-    it "should set user_agent" do
+    it "sets user_agent" do
       Gitlab.user_agent = 'Custom User Agent'
       expect(Gitlab.user_agent).to eq('Custom User Agent')
     end
@@ -75,7 +75,7 @@ describe Gitlab do
 
   describe ".configure" do
     Gitlab::Configuration::VALID_OPTIONS_KEYS.each do |key|
-      it "should set #{key}" do
+      it "sets #{key}" do
         Gitlab.configure do |config|
           config.send("#{key}=", key)
           expect(Gitlab.send(key)).to eq(key)
@@ -89,9 +89,8 @@ describe Gitlab do
       Gitlab.endpoint = 'https://api.example.com'
       request = class_spy(Gitlab::Request).as_stubbed_const
 
-      Gitlab.http_proxy('fazbearentertainment.com', 1987, 'ffazbear', 'itsme')
-      expect(request).to have_received(:http_proxy).
-        with('fazbearentertainment.com', 1987, 'ffazbear', 'itsme')
+      Gitlab.http_proxy('proxy.example.net', 1987, 'user', 'pass')
+      expect(request).to have_received(:http_proxy).with('proxy.example.net', 1987, 'user', 'pass')
     end
   end
 end