gitlab 4.1.0 → 4.2.0

data/lib/gitlab/client/repository_files.rb

@@ -45,17 +45,19 @@ class Gitlab::Client
     #   Gitlab.create_file(42, "path", "branch", "content", "commit message")
     #
     # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] full path to new file.
-    # @param  [String] the name of the branch.
-    # @param  [String] file content.
-    # @param  [String] commit message.
+    # @param  [String] path full path to new file.
+    # @param  [String] branch the name of the branch.
+    # @param  [String] content file content.
+    # @param  [String] commit_message ...commit message.
+    # @param  [Hash] options Optional additional details for commit
+    # @option options [String] :author_name Commit author's name
+    # @option options [String] :author_email Commit author's email address
     # @return [Gitlab::ObjectifiedHash]
-    def create_file(project, path, branch, content, commit_message)
-      post("/projects/#{url_encode project}/repository/files", body: {
-        file_path: path,
-        branch_name: branch,
+    def create_file(project, path, branch, content, commit_message, options = {})
+      post("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
+        branch: branch,
         commit_message: commit_message
-      }.merge(encoded_content_attributes(content)))
+      }.merge(options).merge(encoded_content_attributes(content)))
     end
 
     # Edits an existing repository file.
@@ -64,17 +66,19 @@ class Gitlab::Client
     #   Gitlab.edit_file(42, "path", "branch", "content", "commit message")
     #
     # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] full path to new file.
-    # @param  [String] the name of the branch.
-    # @param  [String] file content.
-    # @param  [String] commit message.
+    # @param  [String] path full path of file to update.
+    # @param  [String] branch the name of the branch to commit changes to.
+    # @param  [String] content new file content.
+    # @param  [String] commit_message ...commit message.
+    # @param  [Hash] options Optional additional details for commit
+    # @option options [String] :author_name Commit author's name
+    # @option options [String] :author_email Commit author's email address
     # @return [Gitlab::ObjectifiedHash]
-    def edit_file(project, path, branch, content, commit_message)
-      put("/projects/#{url_encode project}/repository/files", body: {
-        file_path: path,
-        branch_name: branch,
+    def edit_file(project, path, branch, content, commit_message, options = {})
+      put("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
+        branch: branch,
         commit_message: commit_message
-      }.merge(encoded_content_attributes(content)))
+      }.merge(options).merge(encoded_content_attributes(content)))
     end
 
     # Removes an existing repository file.
@@ -83,16 +87,18 @@ class Gitlab::Client
     #   Gitlab.remove_file(42, "path", "branch", "commit message")
     #
     # @param  [Integer, String] project The ID or name of a project.
-    # @param  [String] full path to new file.
-    # @param  [String] the name of the branch.
-    # @param  [String] commit message.
+    # @param  [String] path full path of file to delete.
+    # @param  [String] branch the name of the branch to commit the deletion to.
+    # @param  [String] commit_message ...a commit message ;)
+    # @param  [Hash] options Optional additional details for commit
+    # @option options [String] :author_name Commit author's name
+    # @option options [String] :author_email Commit author's email address
     # @return [Gitlab::ObjectifiedHash]
-    def remove_file(project, path, branch, commit_message)
-      delete("/projects/#{url_encode project}/repository/files", body: {
-               file_path: path,
-               branch_name: branch,
+    def remove_file(project, path, branch, commit_message, options = {})
+      delete("/projects/#{url_encode project}/repository/files/#{url_encode path}", body: {
+               branch: branch,
                commit_message: commit_message
-             })
+             }.merge(options))
     end
 
     private

data/lib/gitlab/client/system_hooks.rb

@@ -24,9 +24,12 @@ class Gitlab::Client
     #   Gitlab.add_system_hook('https://api.example.net/v1/hook')
     #
     # @param  [String] url The hook URL.
+    # @param  [Hash] options Additional options, as allowed by Gitlab API, including but not limited to:
+    # @option options [String] :token A secret token for Gitlab to send in the `X-Gitlab-Token` header for authentication.
+    # @option options [boolean] :enable_ssl_verification `false` will cause Gitlab to ignore invalid/unsigned certificate errors (default is `true`)
     # @return [Gitlab::ObjectifiedHash]
-    def add_hook(url)
-      post("/hooks", body: { url: url })
+    def add_hook(url, options = {})
+      post("/hooks", body: options.merge(url: url))
     end
     alias_method :add_system_hook, :add_hook
 

data/lib/gitlab/client/todos.rb

@@ -0,0 +1,44 @@
+class Gitlab::Client
+  # Defines methods related to todos
+  # @see https://docs.gitlab.com/ce/api/todos.html 
+  module Todos
+    # Gets a list of todos.
+    #
+    # @example
+    #   Gitlab.todos
+    #   Gitlab.todos({ action: 'assigned' })
+    #   Gitlab.todos({ state: 'pending' })
+    #
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :action The action to be filtered. Can be `assigned`, `mentioned`, `build_failed`, `marked`, or `approval_required`.
+    # @option options [Integer] :author_id The ID of an author
+    # @option options [Integer] :project_id The ID of a project
+    # @option options [Integer] :state The state of the todo. Can be either `pending` or `done`
+    # @option options [Integer] :type The type of a todo. Can be either `Issue` or `MergeRequest`
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def todos(options={})
+      get("/todos", query: options)
+    end
+
+    # Marks a single pending todo for the current user as done.
+    #
+    # @example
+    #   Gitlab.mark_todo_as_done(42)
+    #
+    # @param  [Integer] id The ID of the todo.
+    # @return [Gitlab::ObjectifiedHash]
+    def mark_todo_as_done(id)
+      post("/todos/#{id}/mark_as_done")
+    end
+
+    # Marks all todos for the current user as done
+    #
+    # @example
+    #   Gitlab.mark_all_todos_as_done
+    #
+    # @return [void] This API call returns an empty response body.
+    def mark_all_todos_as_done
+      post("/todos/mark_as_done")
+    end
+  end
+end

data/lib/gitlab/version.rb

@@ -1,3 +1,3 @@
 module Gitlab
-  VERSION = "4.1.0"
+  VERSION = "4.2.0"
 end

data/spec/fixtures/board_list.json

@@ -0,0 +1 @@
+{ "id" : 1, "label" : { "name" : "Testing", "color" : "#F0AD4E", "description" : null }, "position" : 1 }

data/spec/fixtures/board_lists.json

@@ -0,0 +1 @@
+[ { "id" : 1, "label" : { "name" : "Testing", "color" : "#F0AD4E", "description" : null }, "position" : 1 }, { "id" : 2, "label" : { "name" : "Ready", "color" : "#FF0000", "description" : null }, "position" : 2 }, { "id" : 3, "label" : { "name" : "Production", "color" : "#FF5F00", "description" : null }, "position" : 3 } ]

data/spec/fixtures/boards.json

@@ -0,0 +1 @@
+[ { "id" : 1, "lists" : [ { "id" : 1, "label" : { "name" : "Testing", "color" : "#F0AD4E", "description" : null }, "position" : 1 }, { "id" : 2, "label" : { "name" : "Ready", "color" : "#FF0000", "description" : null }, "position" : 2 }, { "id" : 3, "label" : { "name" : "Production", "color" : "#FF5F00", "description" : null }, "position" : 3 } ] } ]

data/spec/fixtures/environment.json

@@ -0,0 +1,6 @@
+{
+  "id": 12,
+  "name": "staging",
+  "slug": "staging-cb247rv",
+  "external_url": "https://staging.example.gitlab.com"
+}

data/spec/fixtures/environments.json

@@ -0,0 +1,14 @@
+[
+  {
+    "id": 1,
+    "name": "review/fix-foo",
+    "slug": "review-fix-foo-dfjre3",
+    "external_url": "https://review-fix-foo-dfjre3.example.gitlab.com"
+  },
+  {
+    "id": 12,
+    "name": "review/fix-bar",
+    "slug": "review-fix-bar-dbwr18",
+    "external_url": "https://review-fix-bar-dbwr18.example.gitlab.com"
+  }
+]

data/spec/fixtures/issue_award_emoji.json

@@ -0,0 +1,16 @@
+{
+  "id": 4,
+  "name": "blowfish",
+  "user": {
+    "name": "Administrator",
+    "username": "root",
+    "id": 1,
+    "state": "active",
+    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+    "web_url": "http://gitlab.example.com/root"
+  },
+  "created_at": "2016-06-15T10:09:34.206Z",
+  "updated_at": "2016-06-15T10:09:34.206Z",
+  "awardable_id": 80,
+  "awardable_type": "Issue"
+}

data/spec/fixtures/issue_award_emojis.json

@@ -0,0 +1,34 @@
+[
+  {
+    "id": 4,
+    "name": "1234",
+    "user": {
+      "name": "Administrator",
+      "username": "root",
+      "id": 1,
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+      "web_url": "http://gitlab.example.com/root"
+    },
+    "created_at": "2016-06-15T10:09:34.206Z",
+    "updated_at": "2016-06-15T10:09:34.206Z",
+    "awardable_id": 80,
+    "awardable_type": "Issue"
+  },
+  {
+    "id": 1,
+    "name": "microphone",
+    "user": {
+      "name": "User 4",
+      "username": "user4",
+      "id": 26,
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
+      "web_url": "http://gitlab.example.com/user4"
+    },
+    "created_at": "2016-06-15T10:09:34.177Z",
+    "updated_at": "2016-06-15T10:09:34.177Z",
+    "awardable_id": 80,
+    "awardable_type": "Issue"
+  }
+]

data/spec/fixtures/label.json

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

data/spec/fixtures/label_unsubscribe.json

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

data/spec/fixtures/merge_request_award_emoji.json

@@ -0,0 +1,16 @@
+{
+  "id": 4,
+  "name": "blowfish",
+  "user": {
+    "name": "Administrator",
+    "username": "root",
+    "id": 1,
+    "state": "active",
+    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+    "web_url": "http://gitlab.example.com/root"
+  },
+  "created_at": "2016-06-15T10:09:34.206Z",
+  "updated_at": "2016-06-15T10:09:34.206Z",
+  "awardable_id": 80,
+  "awardable_type": "MergeRequest"
+}

data/spec/fixtures/merge_request_award_emojis.json

@@ -0,0 +1,34 @@
+[
+  {
+    "id": 4,
+    "name": "1234",
+    "user": {
+      "name": "Administrator",
+      "username": "root",
+      "id": 1,
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+      "web_url": "http://gitlab.example.com/root"
+    },
+    "created_at": "2016-06-15T10:09:34.206Z",
+    "updated_at": "2016-06-15T10:09:34.206Z",
+    "awardable_id": 80,
+    "awardable_type": "MergeRequest"
+  },
+  {
+    "id": 1,
+    "name": "microphone",
+    "user": {
+      "name": "User 4",
+      "username": "user4",
+      "id": 26,
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
+      "web_url": "http://gitlab.example.com/user4"
+    },
+    "created_at": "2016-06-15T10:09:34.177Z",
+    "updated_at": "2016-06-15T10:09:34.177Z",
+    "awardable_id": 80,
+    "awardable_type": "MergeRequest"
+  }
+]

data/spec/fixtures/note_award_emoji.json

@@ -0,0 +1,16 @@
+{
+  "id": 4,
+  "name": "mood_bubble_lightning",
+  "user": {
+    "name": "User 4",
+    "username": "user4",
+    "id": 26,
+    "state": "active",
+    "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
+    "web_url": "http://gitlab.example.com/user4"
+  },
+  "created_at": "2016-06-15T10:09:34.197Z",
+  "updated_at": "2016-06-15T10:09:34.197Z",
+  "awardable_id": 1,
+  "awardable_type": "Note"
+}

data/spec/fixtures/note_award_emojis.json

@@ -0,0 +1,18 @@
+[
+  {
+    "id": 2,
+    "name": "mood_bubble_lightning",
+    "user": {
+      "name": "User 4",
+      "username": "user4",
+      "id": 26,
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
+      "web_url": "http://gitlab.example.com/user4"
+    },
+    "created_at": "2016-06-15T10:09:34.197Z",
+    "updated_at": "2016-06-15T10:09:34.197Z",
+    "awardable_id": 1,
+    "awardable_type": "Note"
+  }
+]

data/spec/fixtures/snippet_award_emoji.json

@@ -0,0 +1,16 @@
+{
+  "id": 4,
+  "name": "blowfish",
+  "user": {
+    "name": "Administrator",
+    "username": "root",
+    "id": 1,
+    "state": "active",
+    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+    "web_url": "http://gitlab.example.com/root"
+  },
+  "created_at": "2016-06-15T10:09:34.206Z",
+  "updated_at": "2016-06-15T10:09:34.206Z",
+  "awardable_id": 80,
+  "awardable_type": "Snippet"
+}

data/spec/fixtures/snippet_award_emojis.json

@@ -0,0 +1,34 @@
+[
+  {
+    "id": 4,
+    "name": "1234",
+    "user": {
+      "name": "Administrator",
+      "username": "root",
+      "id": 1,
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+      "web_url": "http://gitlab.example.com/root"
+    },
+    "created_at": "2016-06-15T10:09:34.206Z",
+    "updated_at": "2016-06-15T10:09:34.206Z",
+    "awardable_id": 80,
+    "awardable_type": "Snippet"
+  },
+  {
+    "id": 1,
+    "name": "microphone",
+    "user": {
+      "name": "User 4",
+      "username": "user4",
+      "id": 26,
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/7e65550957227bd38fe2d7fbc6fd2f7b?s=80&d=identicon",
+      "web_url": "http://gitlab.example.com/user4"
+    },
+    "created_at": "2016-06-15T10:09:34.177Z",
+    "updated_at": "2016-06-15T10:09:34.177Z",
+    "awardable_id": 80,
+    "awardable_type": "Snippet"
+  }
+]

data/spec/fixtures/todo.json

@@ -0,0 +1,73 @@
+{
+    "id": 102,
+    "project": {
+      "id": 2,
+      "name": "Gitlab Ce",
+      "name_with_namespace": "Gitlab Org / Gitlab Ce",
+      "path": "gitlab-ce",
+      "path_with_namespace": "gitlab-org/gitlab-ce"
+    },
+    "author": {
+      "name": "Administrator",
+      "username": "root",
+      "id": 1,
+      "state": "active",
+      "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+      "web_url": "https://gitlab.example.com/root"
+    },
+    "action_name": "marked",
+    "target_type": "MergeRequest",
+    "target": {
+      "id": 34,
+      "iid": 7,
+      "project_id": 2,
+      "title": "Dolores in voluptatem tenetur praesentium omnis repellendus voluptatem quaerat.",
+      "description": "Et ea et omnis illum cupiditate. Dolor aspernatur tenetur ducimus facilis est nihil. Quo esse cupiditate molestiae illo corrupti qui quidem dolor.",
+      "state": "opened",
+      "created_at": "2016-06-17T07:49:24.419Z",
+      "updated_at": "2016-06-17T07:52:43.484Z",
+      "target_branch": "tutorials_git_tricks",
+      "source_branch": "DNSBL_docs",
+      "upvotes": 0,
+      "downvotes": 0,
+      "author": {
+        "name": "Maxie Medhurst",
+        "username": "craig_rutherford",
+        "id": 12,
+        "state": "active",
+        "avatar_url": "http://www.gravatar.com/avatar/a0d477b3ea21970ce6ffcbb817b0b435?s=80&d=identicon",
+        "web_url": "https://gitlab.example.com/craig_rutherford"
+      },
+      "assignee": {
+        "name": "Administrator",
+        "username": "root",
+        "id": 1,
+        "state": "active",
+        "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
+        "web_url": "https://gitlab.example.com/root"
+      },
+      "source_project_id": 2,
+      "target_project_id": 2,
+      "labels": [],
+      "work_in_progress": false,
+      "milestone": {
+        "id": 32,
+        "iid": 2,
+        "project_id": 2,
+        "title": "v1.0",
+        "description": "Assumenda placeat ea voluptatem voluptate qui.",
+        "state": "active",
+        "created_at": "2016-06-17T07:47:34.163Z",
+        "updated_at": "2016-06-17T07:47:34.163Z",
+        "due_date": null
+      },
+      "merge_when_pipeline_succeeds": false,
+      "merge_status": "cannot_be_merged",
+      "subscribed": true,
+      "user_notes_count": 7
+    },
+    "target_url": "https://gitlab.example.com/gitlab-org/gitlab-ce/merge_requests/7",
+    "body": "Dolores in voluptatem tenetur praesentium omnis repellendus voluptatem quaerat.",
+    "state": "done",
+    "created_at": "2016-06-17T07:52:35.225Z"
+}