gitlab 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 495b1042cb1c31a952e20736b66c03ff91503e55
-  data.tar.gz: b1d768d0e57f2687e947d10e9401742d15815b18
+  metadata.gz: 2fd8bd1d12fdceba122d4fd99e3df259c399e629
+  data.tar.gz: dd195a082fc9a572a22ff4074306891ccc9553a1
 SHA512:
-  metadata.gz: 9478123ca2e7e8bbb1a2ea4cc7a0bcea6675f3dcf54c40033e7d30512eb29b3ed2af07a8e92d940c2f7295b8c319dd70fe2a0e7ef2d344f1e566303704653e42
-  data.tar.gz: 976085a5f7b15f55ea2f2fe6a6ffc67c63d1b0c6d2417320b74e17bdad310f3401e6fe82efb8f3b06f52010d9fc561e92e3e4d3295ce5ee5f004eca836f7fef1
+  metadata.gz: 0edc2245a554decf8c18723979c256e6e7926d67521fa9ffeef11508b3bad1501e31ea3fe7ba91c1e9a5efe98a66149e6be3f2adcb25199c3118e5e6bde9b847
+  data.tar.gz: 12aa581f975cd5bbc7cebe3fb75eef20d1fb87eab9119af485c3a2158779a673cd0c1da74ee4a0d91f05adfe582a35f906e7679f2fd4650f65b5c04167926c28

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 ### Unreleased
 
+### 4.2.0 (13/07/2017)
+- Use `url_encode` in all `Commit` resources (@grodowski)
+- Fix `project_search` path for APIv4 (@edaubert)
+- Add options to `Labels#create_label` (@hlidotbe)
+- Add `Board` API support (@hlidotbe)
+- `Award Emoji` API (@akkee)
+- Subscribe and unsubscribe actions for labels (@akkee)
+- Add `options` hash to `add_hook` method (@mltsy)
+- Update repository files endpoint APIv4 (@mltsy)
+- Update `Branch` docs and add `options` param to `protect_branch` (@mltsy)
+- Fix and clarify `edit_project` option docs (@mltsy)
+- Add `TODO` API (@akkee)
+- Use `body` parameter to send POST data (@sr189)
+- Add `Environments` module (@mltsy)
+- Edit and Delete methods for `Notes` API (@akkee)
+- Rename `branch_name` parameter to `branch` in `create_branch` & `create_commit` methods (@sr189)
+
 ### 4.1.0 (26/05/2017)
 - Add appropriate Content-Type header (@mltsy)
 - Add `Jobs` endpoint methods (@hjanuschka)

data/lib/gitlab/client.rb

@@ -3,10 +3,13 @@ module Gitlab
   class Client < API
     Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
 
+    include AwardEmojis
+    include Boards
     include Branches
     include Builds
     include BuildVariables
     include Commits
+    include Environments
     include Groups
     include Issues
     include Keys
@@ -25,6 +28,7 @@ module Gitlab
     include Snippets
     include SystemHooks
     include Tags
+    include Todos
     include Users
     include Jobs
 

data/lib/gitlab/client/award_emojis.rb

@@ -0,0 +1,135 @@
+class Gitlab::Client
+  # Defines methods related to Award Emojis.
+  # @see https://docs.gitlab.com/ce/api/award_emoji.html
+  module AwardEmojis
+    # Gets a list of all award emoji for an awardable(issue, merge request or snippet)
+    #
+    # @example
+    #   Gitlab.award_emojis(1, 80, 'issue')
+    #   Gitlab.award_emojis(1, 60, 'merge_request')
+    #   Gitlab.award_emojis(1, 40, 'snippet')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def award_emojis(project, awardable_id, awardable_type)
+      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji")
+    end
+
+    # Gets a list of all award emoji for a single note on an awardable(issue, merge request or snippet)
+    #
+    # @example
+    #   Gitlab.note_award_emojis(1, 80, 'issue', 1)
+    #   Gitlab.note_award_emojis(1, 60, 'merge_request', 1)
+    #   Gitlab.note_award_emojis(1, 40, 'snippet', 1)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+    # @param [Integer] note_id The ID of a note.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def note_award_emojis(project, awardable_id, awardable_type, note_id)
+      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji")
+    end
+
+    # Gets a single award emoji for an awardable(issue, merge request or snippet)
+    #
+    # @example
+    #   Gitlab.award_emoji(1, 80, 'issue', 4)
+    #   Gitlab.award_emoji(1, 60, 'merge_request', 4)
+    #   Gitlab.award_emoji(1, 40, 'snippet', 4)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+    # @param [Integer] award_id The ID of an award emoji.
+    # @return [Gitlab::ObjectifiedHash]
+    def award_emoji(project, awardable_id, awardable_type, award_id)
+      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji/#{award_id}")
+    end
+
+    # Gets a single award emoji from a single note on an awardable(issue, merge request or snippet)
+    #
+    # @example
+    #   Gitlab.note_award_emoji(1, 80, 'issue', 1, 4)
+    #   Gitlab.note_award_emoji(1, 60, 'merge_request', 1, 4)
+    #   Gitlab.note_award_emoji(1, 40, 'snippet', 1, 4)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+    # @param [Integer] note_id The ID of a note.
+    # @param [Integer] award_id The ID of an award emoji.
+    # @return [Gitlab::ObjectifiedHash]
+    def note_award_emoji(project, awardable_id, awardable_type, note_id, award_id)
+      get("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
+    end
+
+    # Awards a new emoji to an awardable(issue, merge request or snippet)
+    #
+    # @example
+    #   Gitlab.create_award_emoji(1, 80, 'issue', 'blowfish')
+    #   Gitlab.create_award_emoji(1, 80, 'merge_request', 'blowfish')
+    #   Gitlab.create_award_emoji(1, 80, 'snippet', 'blowfish')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+    # @param [String] emoji_name The name of the emoji, without colons.
+    # @return [Gitlab::ObjectifiedHash]
+    def create_award_emoji(project, awardable_id, awardable_type, emoji_name)
+      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji", body: {name: emoji_name})
+    end
+
+    # Awards a new emoji to a note on an awardable(issue, merge request or snippet)
+    #
+    # @example
+    #   Gitlab.create_note_award_emoji(1, 80, 'issue', 1, 'blowfish')
+    #   Gitlab.create_note_award_emoji(1, 80, 'merge_request', 1, 'blowfish')
+    #   Gitlab.create_note_award_emoji(1, 80, 'snippet', 1, 'blowfish')
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+    # @param [Integer] note_id The ID of a note.
+    # @param [String] emoji_name The name of the emoji, without colons.
+    # @return [Gitlab::ObjectifiedHash]
+    def create_note_award_emoji(project, awardable_id, awardable_type, note_id, emoji_name)
+      post("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji", body: {name: emoji_name})
+    end
+
+    # Deletes a single award emoji from an awardable(issue, merge request or snippet)
+    #
+    # @example
+    #   Gitlab.delete_award_emoji(1, 80, 'issue', 4)
+    #   Gitlab.delete_award_emoji(1, 60, 'merge_request', 4)
+    #   Gitlab.delete_award_emoji(1, 40, 'snippet', 4)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+    # @param [Integer] award_id The ID of an award emoji.
+    # @return [void] This API call returns an empty response body.
+    def delete_award_emoji(project, awardable_id, awardable_type, award_id)
+      delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/award_emoji/#{award_id}")
+    end
+
+    # Deletes a single award emoji from a single note on an awardable(issue, merge request or snippet)
+    #
+    # @example
+    #   Gitlab.delete_note_award_emoji(1, 80, 'issue', 1, 4)
+    #   Gitlab.delete_note_award_emoji(1, 60, 'merge_request', 1, 4)
+    #   Gitlab.delete_note_award_emoji(1, 40, 'snippet', 1, 4)
+    #
+    # @param [Integer] project The ID of a project.
+    # @param [Integer] awardable_id The ID of an awardable(issue, merge request or snippet).
+    # @param [String] awardable_type The type of the awardable(can be 'issue', 'merge_request' or 'snippet')
+    # @param [Integer] note_id The ID of a note.
+    # @param [Integer] award_id The ID of an award emoji.
+    # @return [void] This API call returns an empty response body.
+    def delete_note_award_emoji(project, awardable_id, awardable_type, note_id, award_id)
+      delete("/projects/#{url_encode project}/#{awardable_type}s/#{awardable_id}/notes/#{note_id}/award_emoji/#{award_id}")
+    end
+  end
+end

data/lib/gitlab/client/boards.rb

@@ -0,0 +1,88 @@
+class Gitlab::Client
+  # Defines methods related to issue boards.
+  # @see https://docs.gitlab.com/ce/api/boards.html
+  module Boards
+    # Gets a list of project's boards.
+    #
+    # @example
+    #   Gitlab.boards(5)
+    #   Gitlab.boards({ per_page: 40 })
+    #
+    # @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 boards(project, options={})
+      get("/projects/#{url_encode project}/boards", query: options)
+    end
+
+    # Gets a board lists
+    #
+    # @example
+    #   Gitlab.board_lists(5, 42)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @return [Gitlab::ObjectifiedHash]
+    def board_lists(project, id)
+      get("/projects/#{url_encode project}/boards/#{id}/lists")
+    end
+    #
+    # Gets a single board list
+    #
+    # @example
+    #   Gitlab.board_list(5, 42, 25)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] board_id The ID of a board.
+    # @param  [Integer] id The ID of a list.
+    # @return [Gitlab::ObjectifiedHash]
+    def board_list(project, board_id, id)
+      get("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}")
+    end
+
+    # Creates a new board list.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.create_board_list(5, 42, 25)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of a board.
+    # @param  [Integer] label_id The ID of a label.
+    # @return [Gitlab::ObjectifiedHash] Information about created list.
+    def create_board_list(project, board_id, label_id)
+      post("/projects/#{url_encode project}/boards/#{board_id}/lists", body: {label_id: label_id})
+    end
+
+    # Updates a board list.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.edit_board_list(6, 1, 12, 5)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] board_id The ID of a board.
+    # @param  [Integer] id The ID of a list.
+    # @return [Gitlab::ObjectifiedHash] Information about updated board list.
+    def edit_board_list(project, board_id, id, position)
+      put("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}", body: {position: position})
+    end
+
+    # Deletes  a board list.
+    # Only for admins and project owners
+    #
+    # @example
+    #   Gitlab.delete_board_list(3, 42, 32)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] board_id The ID of a board.
+    # @param  [Integer] id The ID of a list.
+    # @return [Gitlab::ObjectifiedHash] Information about deleted board list.
+    def delete_board_list(project, board_id, id)
+      delete("/projects/#{url_encode project}/boards/#{board_id}/lists/#{id}")
+    end
+  end
+end
+

data/lib/gitlab/client/branches.rb

@@ -36,12 +36,18 @@ class Gitlab::Client
     # @example
     #   Gitlab.protect_branch(3, 'api')
     #   Gitlab.repo_protect_branch(5, 'master')
+    #   Gitlab.protect_branch(5, 'api', developers_can_push: true)
+    #
+    # To update options, call `protect_branch` again with new options (i.e. `developers_can_push: false`)
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the branch.
-    # @return [Gitlab::ObjectifiedHash]
-    def protect_branch(project, branch)
-      put("/projects/#{url_encode project}/repository/branches/#{branch}/protect")
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Boolean] :developers_can_push True to allow developers to push to the branch (default = false)
+    # @option options [Boolean] :developers_can_merge True to allow developers to merge into the branch (default = false)
+    # @return [Gitlab::ObjectifiedHash] Details about the branch
+    def protect_branch(project, branch, options = {})
+      put("/projects/#{url_encode project}/repository/branches/#{branch}/protect", body: options)
     end
     alias_method :repo_protect_branch, :protect_branch
 
@@ -53,7 +59,7 @@ class Gitlab::Client
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the branch.
-    # @return [Gitlab::ObjectifiedHash]
+    # @return [Gitlab::ObjectifiedHash] Details about the branch
     def unprotect_branch(project, branch)
       put("/projects/#{url_encode project}/repository/branches/#{branch}/unprotect")
     end
@@ -68,9 +74,9 @@ class Gitlab::Client
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the new branch.
     # @param  [String] ref Create branch from commit sha or existing branch
-    # @return [Gitlab::ObjectifiedHash]
+    # @return [Gitlab::ObjectifiedHash] Details about the branch
     def create_branch(project, branch, ref)
-      post("/projects/#{url_encode project}/repository/branches", body: { branch_name: branch, ref: ref })
+      post("/projects/#{url_encode project}/repository/branches", body: { branch: branch, ref: ref })
     end
     alias_method :repo_create_branch, :create_branch
 
@@ -82,7 +88,6 @@ class Gitlab::Client
     #
     # @param  [Integer, String] project The ID or name of a project.
     # @param  [String] branch The name of the branch to delete
-    # @return [Gitlab::ObjectifiedHash]
     def delete_branch(project, branch)
       delete("/projects/#{url_encode project}/repository/branches/#{branch}")
     end

data/lib/gitlab/client/commits.rb

@@ -94,8 +94,8 @@ class Gitlab::Client
     # @option options [String] :stage Filter by stage
     # @option options [String] :name Filter 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)
+    def commit_status(project, sha, options={})
+      get("/projects/#{url_encode project}/repository/commits/#{sha}/statuses", query: options)
     end
     alias_method :repo_commit_status, :commit_status
 
@@ -113,8 +113,8 @@ class Gitlab::Client
     # @option options [String] :ref The ref (branch or tag) to which the status refers
     # @option options [String] :name Filter 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))
+    def update_commit_status(project, sha, state, options={})
+      post("/projects/#{url_encode project}/statuses/#{sha}", query: options.merge(state: state))
     end
     alias_method :repo_update_commit_status, :update_commit_status
 
@@ -136,11 +136,11 @@ class Gitlab::Client
     # @return [Gitlab::ObjectifiedHash] hash of commit related data
     def create_commit(project, branch, message, actions, options={})
       payload = {
-          branch_name: branch,
+          branch: branch,
           commit_message: message,
           actions: actions,
       }.merge(options)
-      post("/projects/#{url_encode project}/repository/commits", query: payload)
+      post("/projects/#{url_encode project}/repository/commits", body: payload)
     end
   end
 end

data/lib/gitlab/client/environments.rb

@@ -0,0 +1,87 @@
+class Gitlab::Client
+  # Defines methods related to environments.
+  # @see https://docs.gitlab.com/ce/api/environments.html
+  module Environments
+    # Gets a list of project environments.
+    #
+    # @example
+    #   Gitlab.environments(5)
+    #   Gitlab.environments(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 environments(project, options={})
+      get("/projects/#{url_encode project}/environments", query: options)
+    end
+
+    # Gets a single environment.
+    #
+    # @example
+    #   Gitlab.environment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @return [Gitlab::ObjectifiedHash]
+    def environment(project, id)
+      get("/projects/#{url_encode project}/environments/#{id}")
+    end
+
+    # Create an environment.
+    #
+    # @examples
+    #   Gitlab.create_environment(5, 'test-branch')
+    #   Gitlab.create_environment(5, 'test-branch', external_url: 'https://test-branch.example.host.com')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [String] env_name Name for the environment
+    # @option options [String] :external_url Optional URL for viewing the deployed project in this environment
+    # @return [Gitlab::ObjectifiedHash] The updated environment.
+    def create_environment(project, env_name, options = {})
+      body = {name: env_name}.merge(options)
+      post("/projects/#{url_encode project}/environments", body: body)
+    end
+
+    # Update an environment.
+    #
+    # @examples
+    #   Gitlab.edit_environment(5, 36, name: 'test-branch')
+    #   Gitlab.edit_environment(5, 36, external_url: 'https://test-branch.example.host.com')
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @param  [Hash] options A hash of the attribute keys & values to update.
+    # @option options [String] env_name Name for the environment
+    # @option options [String] external_url Optional URL for viewing the deployed project in this environment
+    # @return [Gitlab::ObjectifiedHash] The updated environment.
+    def edit_environment(project, id, options={})
+      put("/projects/#{url_encode project}/environments/#{id}", body: options)
+    end
+
+    # Deletes an environment.
+    #
+    # @example
+    #   Gitlab.delete_environment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @return [Gitlab::ObjectifiedHash] Information about the deleted environment.
+    def delete_environment(project, id)
+      delete("/projects/#{url_encode project}/environments/#{id}")
+    end
+
+    # Stop an environment.
+    #
+    # @example
+    #   Gitlab.stop_environment(5, 36)
+    #
+    # @param  [Integer, String] project The ID or name of a project.
+    # @param  [Integer] id The ID of an environment.
+    # @return [Array<Gitlab::ObjectifiedHash>] The stopped environment.
+    def stop_environment(project, id)
+      post("/projects/#{url_encode project}/environments/#{id}/stop")
+    end
+  end
+end