gitlab 4.2.0 → 4.3.0

data/lib/gitlab/client/deployments.rb

@@ -0,0 +1,32 @@
+class Gitlab::Client
+  # Defines methods related to deployments.
+  # @see https://docs.gitlab.com/ce/api/deployments.html
+  module Deployments
+    # Gets a list of project deployments.
+    #
+    # @example
+    #   Gitlab.deployments(5)
+    #   Gitlab.deployments(5, { per_page: 10, page:  2 })
+    #
+    # @param  [Integer, String] project The ID or name 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 deployments(project, options={})
+      get("/projects/#{url_encode project}/deployments", query: options)
+    end
+
+    # Gets a single deployment.
+    #
+    # @example
+    #   Gitlab.deployment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an deployment.
+    # @return [Gitlab::ObjectifiedHash]
+    def deployment(project, id)
+      get("/projects/#{url_encode project}/deployments/#{id}")
+    end
+  end
+end

data/lib/gitlab/client/groups.rb

@@ -66,6 +66,18 @@ class Gitlab::Client
       get("/groups/#{id}/members", query: options)
     end
 
+    # Get details of a single group member.
+    #
+    # @example
+    #   Gitlab.group_member(1, 10)
+    #
+    # @param  [Integer] team_id The ID of the group to find a member in.
+    # @param  [Integer] user_id The user id of the member to find.
+    # @return [Gitlab::ObjectifiedHash] (id, username, name, email, state, access_level ...)
+    def group_member(team_id, user_id)
+      get("/groups/#{team_id}/members/#{user_id}")
+    end
+
     # Adds a user to group.
     #
     # @example
@@ -140,5 +152,42 @@ class Gitlab::Client
     def group_projects(id, options={})
       get("/groups/#{id}/projects", query: options)
     end
+
+    # Get a list of subgroups under a group
+    # @example
+    #   Gitlab.group_subgroups(1)
+    #
+    # @param [Integer] id the ID of a group
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :skip_groups Skip the group IDs passed.
+    # @option options [String] :all_available Show all the groups you have access to (defaults to false for authenticated users).
+    # @option options [String] :search Return the list of authorized groups matching the search criteria.
+    # @option options [String] :order_by Order groups by name or path. Default is name.
+    # @option options [String] :sort Order groups in asc or desc order. Default is asc.
+    # @option options [String] :statistics Include group statistics (admins only).
+    # @option options [String] :owned Limit to groups owned by the current user.
+    # @return [Array<Gitlab::ObjectifiedHash>] List of subgroups under a group
+    def group_subgroups(id, options={})
+      get("/groups/#{id}/subgroups", query: options)
+    end
+
+    # Updates an existing group.
+    #
+    # @example
+    #   Gitlab.edit_group(42)
+    #   Gitlab.edit_group(42, { name: 'Group Name' })
+    #
+    # @param  [Integer] group The ID.
+    # @param  [Hash] options A customizable set of options
+    # @option options [String] :name The name of the group.
+    # @option options [String] :path The path of the group.
+    # @option options [String] :description The description of the group.
+    # @option options [String] :visibility The visibility level of the group. Can be private, internal, or public
+    # @option options [String] :lfs_enabled Enable/disable Large File Storage (LFS) for the projects in this groupr.
+    # @option options [String] :request_access_enabled Allow users to request member access.
+    # @return [Gitlab::ObjectifiedHash] Information about the edited group.
+    def edit_group(id, options={})
+      put("/groups/#{id}", body: options)
+    end
   end
 end

data/lib/gitlab/client/issues.rb

@@ -133,5 +133,76 @@ class Gitlab::Client
     def delete_issue(project, id)
       delete("/projects/#{url_encode project}/issues/#{id}")
     end
+
+    # Move an issue.
+    #
+    # @example
+    #   Gitlab.move_issue(3, 42, { to_project_id: '4' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @option options [String] :to_project_id The ID of the new project.
+    # @return [Gitlab::ObjectifiedHash] Information about moved issue.
+    def move_issue(project, id, options={})
+      post("/projects/#{url_encode project}/issues/#{id}/move", body: options)
+    end
+    
+    # Sets an estimated time of work for an issue.
+    #
+    # @example
+    #   Gitlab.estimate_time_of_issue(3, 42, '3h30m')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @param  [String] duration The duration in human format. e.g: 3h30m
+    def estimate_time_of_issue(project, id, duration)
+      post("/projects/#{url_encode project}/issues/#{id}/time_estimate", body: { duration: url_encode(duration) })
+    end
+    
+    # Resets the estimated time for an issue to 0 seconds.  
+    #
+    # @example
+    #   Gitlab.reset_time_estimate_of_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    def reset_time_estimate_of_issue(project, id)
+      post("/projects/#{url_encode project}/issues/#{id}/reset_time_estimate")
+    end
+    
+    # Adds spent time for an issue
+    #
+    # @example
+    #   Gitlab.estimate_time_of_issue(3, 42, '3h30m')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    # @param  [String] duration The time spent in human format. e.g: 3h30m
+    def add_time_spent_on_issue(project, id, duration)
+      post("/projects/#{url_encode project}/issues/#{id}/add_spent_time", body: { duration: url_encode(duration) })
+    end
+    
+    # Resets the total spent time for this issue to 0 seconds.
+    #
+    # @example
+    #   Gitlab.reset_time_spent_on_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    def reset_time_spent_on_issue(project, id)
+      post("/projects/#{url_encode project}/issues/#{id}/reset_spent_time")
+    end
+    
+    # Get time tracking stats for an issue
+    #
+    # @example
+    #   @gitlab.time_stats_for_issue(3, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an issue.
+    def time_stats_for_issue(project, id)
+      get("/projects/#{url_encode project}/issues/#{id}/time_stats")
+    end
+    
   end
 end

data/lib/gitlab/client/merge_requests.rb

@@ -44,6 +44,7 @@ class Gitlab::Client
     # @option options [String] :target_branch (required) The target branch name.
     # @option options [Integer] :assignee_id (optional) The ID of a user to assign merge request.
     # @option options [Integer] :target_project_id (optional) The target project ID.
+    # @option options [String] :labels (optional) Labels as a comma-separated list.
     # @return [Gitlab::ObjectifiedHash] Information about created merge request.
     def create_merge_request(project, title, options={})
       body = { title: title }.merge(options)

data/lib/gitlab/client/pipeline_schedules.rb

@@ -0,0 +1,133 @@
+class Gitlab::Client
+  # Defines methods related to pipeline schedules.
+  # @see https://docs.gitlab.com/ce/api/pipeline_schedules.html
+  module PipelineSchedules
+    # Gets a list of project pipeline schedules.
+    #
+    # @example
+    #   Gitlab.pipeline_schedules(5)
+    #   Gitlab.pipeline_schedules(5, { scope: 'active' })
+    #
+    # @param   [Integer, String] project the ID or name of a project.
+    # @param   [Hash] options A customizable set of options.
+    # @options options [String] :scope The scope of pipeline schedules, one of a 'active' or 'inactive'.
+    # @return  [Array<Gitlab::ObjectifiedHash>]
+    def pipeline_schedules(project, options={})
+      get("/projects/#{url_encode project}/pipeline_schedules", query: options)
+    end
+
+    # Gets a single pipeline schedule.
+    #
+    # @example
+    #   Gitlab.pipeline_schedule(5, 3)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of the pipeline schedule.
+    # @return [Gitlab::ObjectifiedHash]
+    def pipeline_schedule(project, id)
+      get("/projects/#{url_encode project}/pipeline_schedules/#{id}")
+    end
+
+    # Create a pipeline schedule.
+    #
+    # @example
+    #   Gitlab.create_pipeline_schedule(5, { description: 'example' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of pipeline scehdule.
+    # @option options [String] :ref The branch/tag name will be triggered.
+    # @option options [String] :cron The cron (e.g. 0 1 * * *).
+    # @option options [String] :cron_timezone The timezone supproted by ActiveSupport::TimeZone (e.g. Pacific Time (US & Canada)) (default: 'UTC').
+    # @option options [Boolean] :active The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true).
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def create_pipeline_schedule(project, options={})
+      post("/projects/#{url_encode project}/pipeline_schedules", query: options)
+    end
+
+    # Updates the pipeline schedule of a project.
+    #
+    # @example
+    #   Gitlab.edit_pipeline_schedule(3, 2, { description: 'example2' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] The pipeline schedule ID.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :description The description of pipeline scehdule.
+    # @option options [String] :ref The branch/tag name will be triggered.
+    # @option options [String] :cron The cron (e.g. 0 1 * * *).
+    # @option options [String] :cron_timezone The timezone supproted by ActiveSupport::TimeZone (e.g. Pacific Time (US & Canada)) (default: 'UTC').
+    # @option options [Boolean] :active The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: true).
+    # @return [Array<Gitlab::ObjectifiedHash>] The updated pipeline schedule.
+    def edit_pipeline_schedule(project, pipeline_schedule_id, options={})
+      put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}", query: options)
+    end
+
+    # Take ownership of a pipeline schedule.
+    #
+    # @example
+    #   Gitlab.pipeline_schedule_take_ownership(5, 1)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] trigger_id The pipeline schedule ID.
+    # @return [Gitlab::ObjectifiedHash] The updated pipeline schedule.
+    def pipeline_schedule_take_ownership(project, pipeline_schedule_id)
+      post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/take_ownership")
+    end
+
+    # Delete a pipeline schedule.
+    #
+    # @example
+    #   Gitlab.delete_pipeline_schedule(5, 1)
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] trigger_id The pipeline schedule ID.
+    # @return [Gitlab::ObjectifiedHash] The deleted pipeline schedule.
+    def delete_pipeline_schedule(project, pipeline_schedule_id)
+      delete("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}")
+    end
+
+    # Create a pipeline schedule variable.
+    #
+    # @example
+    #   Gitlab.create_pipeline_schedule_variable(5, 1, { key: 'foo', value: 'bar' })
+    #
+    # @param [Integer, String] project The ID or name of a project.
+    # @param [Integer] trigger_id The pipeline schedule ID.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :key The key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed.
+    # @option options [String] :value The value of a variable
+    # @return [Array<Gitlab::ObjectifiedHash>] The created pipeline schedule variable.
+    def create_pipeline_schedule_variable(project, pipeline_schedule_id, options={})
+      post("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables", query: options)
+    end
+
+    # Updates the variable of a pipeline schedule.
+    #
+    # @example
+    #   Gitlab.edit_pipeline_schedule_variable(3, 2, "foo" { value: 'bar' })
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] The pipeline schedule ID.
+    # @param  [String] The key of a variable.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :value The value of a variable.
+    # @return [Array<Gitlab::ObjectifiedHash>] The updated pipeline schedule variable.
+    def edit_pipeline_schedule_variable(project, pipeline_schedule_id, key, options={})
+      put("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables/#{url_encode key}", query: options)
+    end
+
+    # Delete the variable of a pipeline schedule
+    #
+    # @example
+    #   Gitlab.delete_pipeline_schedule_variable(3, 2, "foo")
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] The pipeline schedule ID.
+    # @param  [String] The key of a variable.
+    # @return [Array<Gitlab::ObjectifiedHash>] The deleted pipeline schedule variable.
+    def delete_pipeline_schedule_variable(project, pipeline_schedule_id, key, options={})
+      delete("/projects/#{url_encode project}/pipeline_schedules/#{pipeline_schedule_id}/variables/#{url_encode key}")
+    end
+  end
+end

data/lib/gitlab/client/pipeline_triggers.rb

@@ -80,8 +80,8 @@ class Gitlab::Client
     # Run the given project pipeline trigger.
     #
     # @example
-    #   Gitlab.trigger_build(5, '7b9148c158980bbd9bcea92c17522d', 'master')
-    #   Gitlab.trigger_build(5, '7b9148c158980bbd9bcea92c17522d', 'master', { variable1: "value", variable2: "value2" })
+    #   Gitlab.run_trigger(5, '7b9148c158980bbd9bcea92c17522d', 'master')
+    #   Gitlab.run_trigger(5, '7b9148c158980bbd9bcea92c17522d', 'master', { variable1: "value", variable2: "value2" })
     #
     # @see https://docs.gitlab.com/ce/ci/triggers/README.html
     #

data/lib/gitlab/client/projects.rb

@@ -298,7 +298,7 @@ class Gitlab::Client
     #
     # @param  [Integer] id The ID of a project.
     # @return [Gitlab::ObjectifiedHash] Information about deleted push rule.
-    def delete_push_rule(id, options={})
+    def delete_push_rule(id)
       delete("/projects/#{url_encode id}/push_rule")
     end
 

data/lib/gitlab/client/repository_files.rb

@@ -15,7 +15,6 @@ class Gitlab::Client
     # @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')
-      ref = URI.encode(ref, /\W/)
       get "/projects/#{url_encode project}/repository/files/#{url_encode filepath}/raw",
           query: { ref: ref},
           format: nil,
@@ -95,7 +94,8 @@ class Gitlab::Client
     # @option options [String] :author_email Commit author's email address
     # @return [Gitlab::ObjectifiedHash]
     def remove_file(project, path, branch, commit_message, options = {})
-      delete("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
+      delete("/projects/#{url_encode project}/repository/files/#{url_encode path}",
+             body: {
                branch: branch,
                commit_message: commit_message
              }.merge(options))

data/lib/gitlab/client/users.rb

@@ -49,11 +49,11 @@ class Gitlab::Client
     # @return [Gitlab::ObjectifiedHash] Information about created user.
     def create_user(*args)
       options = Hash === args.last ? args.pop : {}
-      if args[2]
-        body = { email: args[0], password: args[1], username: args[2] }
-      else
-        body = { email: args[0], password: args[1], name: args[0] }
-      end
+      body = if args[2]
+               { email: args[0], password: args[1], username: args[2] }
+             else
+               { email: args[0], password: args[1], name: args[0] }
+             end
       body.merge!(options)
       post('/users', body: body)
     end

data/lib/gitlab/configuration.rb

@@ -3,7 +3,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, :httparty].freeze
+    VALID_OPTIONS_KEYS = %i(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
@@ -48,7 +48,7 @@ module Gitlab
 
       httparty = Gitlab::CLI::Helpers.yaml_load(options)
 
-      raise ArgumentError, "HTTParty config should be a Hash." unless httparty.is_a? Hash
+      raise ArgumentError, 'HTTParty config should be a Hash.' unless httparty.is_a? Hash
       Gitlab::CLI::Helpers.symbolize_keys httparty
     end
   end

data/lib/gitlab/error.rb

@@ -16,13 +16,20 @@ module Gitlab
         super(build_error_message)
       end
 
-      # Status code returned in the http response.
+      # Status code returned in the HTTP response.
       #
       # @return [Integer]
       def response_status
         @response.code
       end
 
+      # Body content returned in the HTTP response
+      #
+      # @return [String]
+      def response_message
+        @response.parsed_response.message
+      end
+
       private
 
       # Human friendly message.
@@ -30,7 +37,8 @@ module Gitlab
       # @return [String]
       def build_error_message
         parsed_response = @response.parsed_response
-        message = parsed_response.message || parsed_response.error
+        message = parsed_response.respond_to?(:message) ? parsed_response.message : parsed_response['message']
+        message = parsed_response.respond_to?(:error) ? parsed_response.error : parsed_response['error'] unless message
 
         "Server responded with code #{@response.code}, message: " \
         "#{handle_message(message)}. " \

data/lib/gitlab/file_response.rb

@@ -39,7 +39,7 @@ module Gitlab
 
     # Parse filename from the 'Content Disposition' header.
     def parse_headers!(headers)
-      @filename = headers[HEADER_CONTENT_DISPOSITION].split("filename=")[1]
+      @filename = headers[HEADER_CONTENT_DISPOSITION].split('filename=')[1]
       @filename = @filename[1...-1] if @filename[0] == '"' # Unquote filenames
     end
   end

data/lib/gitlab/help.rb

@@ -33,7 +33,7 @@ module Gitlab::Help
     def ri_cmd
       which_ri = `which ri`.chomp
       if which_ri.empty?
-        fail "'ri' tool not found in $PATH. Please install it to use the help."
+        raise "'ri' tool not found in $PATH. Please install it to use the help."
       end
 
       which_ri
@@ -61,7 +61,7 @@ module Gitlab::Help
     def actions_table(topic=nil)
       rows = topic ? help_map[topic] : help_map.keys
       table do |t|
-        t.title = topic || "Help Topics"
+        t.title = topic || 'Help Topics'
 
         # add_row expects an array and we have strings hence the map.
         rows.sort.map { |r| [r] }.each_with_index do |row, index|
@@ -73,7 +73,7 @@ module Gitlab::Help
 
     # Returns full namespace of a command (e.g. Gitlab::Client::Branches.cmd)
     def namespace(cmd)
-      method_owners.select { |method| method[:name] === cmd }.
+      method_owners.select { |method| method[:name] == cmd }.
         map { |method| method[:owner] + '.' + method[:name] }.
         shift
     end
@@ -82,14 +82,13 @@ module Gitlab::Help
     def change_help_output!(cmd, output_str)
       output_str.gsub!(/#{cmd}\((.*?)\)/m, cmd + ' \1')
       output_str.gsub!(/\,[\s]*/, ' ')
-      
+
       # Ensure @option descriptions are on a single line
       output_str.gsub!(/\n\[/, " \[")
       output_str.gsub!(/\s(@)/, "\n@")
       output_str.gsub!(/(\])\n(\:)/, '\1 \2')
       output_str.gsub!(/(\:.*)(\n)(.*\.)/, '\1 \3')
       output_str.gsub!(/\{(.+)\}/, '"{\1}"')
-      
     end
-  end # class << self
+  end
 end