labclient 0.1.0

data/lib/labclient/snippets/create.rb

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Snippets < Common
+    doc 'Create' do
+      desc 'Create a new snippet.'
+      markdown <<~DOC
+        | Attribute    | Type   | Required | Description                                        |
+        |--------------|------- |--------- |--------------------------------------------------- |
+        | title        | string | yes      | Title of a snippet.                                |
+        | file_name    | string | yes      | Name of a snippet file.                            |
+        | content      | string | yes      | Content of a snippet.                              |
+        | description  | string | no       | Description of a snippet.                          |
+        | visibility   | string | no       | Snippet's [visibility](#snippet-visibility-level). |
+      DOC
+    end
+
+    doc 'Create' do
+      example <<~DOC
+        client.snippets.create(
+          title: "Sweet Code",
+          file_name: 'script.rb',
+          content: 'puts "All your snippet are belong to us!"',
+          description: "The one snippet",
+          visibility: :private
+        )
+      DOC
+      result <<~DOC
+        => #<Snippet id: 3, Sweet Code>
+      DOC
+    end
+
+    # Create
+    def create(query = {})
+      client.request(:post, 'snippets', Snippet, query)
+    end
+  end
+end

data/lib/labclient/snippets/delete.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Snippets < Common
+    doc 'Delete' do
+      markdown 'You can delete broadcast messages via the `snippets` method or via the `Snippet` object'
+    end
+
+    doc 'Delete' do
+      desc 'Delete an existing snippet.'
+      example <<~DOC
+        client.snippets.delete(4)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Delete through Snippet object'
+      example <<~DOC
+        snippet.delete
+      DOC
+
+      result <<~DOC
+        snippet = client.snippets.show(4)
+        => #<Snippet id: 4, One Snippet to find them!>
+        snippet.delete
+        => nil
+      DOC
+    end
+
+    # Delete
+    def delete(snippet_id = nil)
+      client.request(:delete, "snippets/#{snippet_id}")
+    end
+  end
+end

data/lib/labclient/snippets/list.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Snippets < Common
+    doc 'List' do
+      desc 'Get a list of the current user’s snippets.'
+      example 'client.snippets.list'
+      result <<~DOC
+        => [#<Snippet id: 2, title: Special Title>, #<Snippet id: 1, title: HereWeGo>]
+      DOC
+    end
+
+    # List
+    def list
+      client.request(:get, 'snippets', Snippet)
+    end
+  end
+end

data/lib/labclient/snippets/public.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Snippets < Common
+    doc 'List' do
+      title 'List all public snippets.'
+
+      markdown <<~DOC
+        | Attribute  | Type    | Required | Description                            |
+        | -----------| --------| ---------| ---------------------------------------|
+        | per_page | integer | no       | Number of snippets to return per page. |
+        | page     | integer | no       | Page to retrieve.                      |
+
+      DOC
+
+      example 'client.snippets.public'
+      result <<~DOC
+        => [#<Snippet id: 2, Special Title>]
+      DOC
+    end
+
+    def public(query = {})
+      client.request(:get, 'snippets/public', Snippet, query)
+    end
+  end
+end

data/lib/labclient/snippets/show.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Snippets < Common
+    doc 'Show' do
+      desc 'Get a single snippet.'
+      example 'client.snippets.show(2)'
+      result <<~DOC
+        => #<Snippet id: 2, Special Title>
+      DOC
+    end
+
+    # Show Specific
+    def show(snippet_id = nil)
+      client.request(:get, "snippets/#{snippet_id}", Snippet)
+    end
+  end
+end

data/lib/labclient/snippets/snippet.rb

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Snippet < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Snippet id: #{id}, title: #{title}>"
+    end
+
+    def update(query = {})
+      update_self client.snippets.update(id, query)
+    end
+
+    def raw
+      client.snippets.raw(id)
+    end
+
+    def agent_detail
+      client.snippets.agent_detail(id)
+    end
+
+    date_time_attrs %i[updated_at created_at]
+
+    user_attrs %i[author]
+
+    def delete
+      client.snippets.delete id
+    end
+
+    help do
+      subtitle 'Snippet'
+      option 'raw', 'Retrieves the raw snippet content.'
+      option 'agent_detail', 'Hash of user agent details.'
+      option 'delete', 'Delete this deploy key.'
+      option 'update', 'Update this this deploy key.'
+    end
+  end
+end

data/lib/labclient/snippets/update.rb

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Snippets < Common
+    doc 'Update' do
+      desc 'Update an existing snippet.'
+      markdown <<~DOC
+        | Attribute    | Type   | Required | Description                                        |
+        |--------------|------- |--------- |--------------------------------------------------- |
+        | title        | string | no       | Title of a snippet.                                |
+        | file_name    | string | no       | Name of a snippet file.                            |
+        | content      | string | no       | Content of a snippet.                              |
+        | description  | string | no       | Description of a snippet.                          |
+        | visibility   | string | no       | Snippet's [visibility](#snippet-visibility-level). |
+      DOC
+    end
+
+    doc 'Update' do
+      example <<~DOC
+        client.snippets.update(4, title: 'One Snippet', description: "One Snippet to rule them all")
+      DOC
+      result <<~DOC
+        => #<Snippet id: 4, title: One Snippet>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Update through Snippet object'
+      example <<~DOC
+        snippet.update(title: 'One Snippet to find them!')
+      DOC
+
+      result <<~DOC
+        snippet = client.snippets.show(4)
+        => #<Snippet id: 4, One Snippet>
+        snippet.update(title: 'Two Snippet!')
+        => #<Snippet id: 4, title: Two Snippet!>
+      DOC
+    end
+
+    # Update
+    def update(snippet_id = nil, query = {})
+      client.request(:put, "snippets/#{snippet_id}", Snippet, query)
+    end
+  end
+end

data/lib/labclient/system_hooks/add.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class SystemHooks < Common
+    doc 'Add' do
+      desc 'Add a new system hook. [Hash]'
+      example 'client.system_hooks.add(url: "http://labclient")'
+      result <<~DOC
+        => #<SystemHook id: 6, url: http://labclient>
+      DOC
+    end
+
+    doc 'Add' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | url | string | yes | The hook URL |
+        | token | string | no | Secret token to validate received payloads; this will not be returned in the response |
+        | push_events | boolean |  no | When true, the hook will fire on push events |
+        | tag_push_events | boolean | no | When true, the hook will fire on new tags being pushed |
+        | merge_requests_events | boolean | no | Trigger hook on merge requests events |
+        | repository_update_events | boolean | no | Trigger hook on repository update events |
+        | enable_ssl_verification | boolean | no | Do SSL verification when triggering the hook |
+
+      DOC
+    end
+
+    # Add
+    def add(query = {})
+      client.request(:post, 'hooks', SystemHook, query)
+    end
+  end
+end

data/lib/labclient/system_hooks/delete.rb

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class SystemHooks < Common
+    doc 'Delete' do
+      desc 'Deletes a system hook. [System Hook ID]'
+      example 'client.system_hooks.delete(1)'
+    end
+
+    doc 'Delete' do
+      desc 'via System Hook'
+      example <<~DOC
+        hook = client.system_hooks.list.first
+        hook.delete
+      DOC
+    end
+
+    def delete(system_hook_id)
+      system_hook_id = format_id(system_hook_id)
+      client.request(:delete, "hooks/#{system_hook_id}")
+    end
+  end
+end

data/lib/labclient/system_hooks/list.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class SystemHooks < Common
+    doc 'List' do
+      desc 'Get a list of all system hooks.'
+      example 'client.system_hooks.list'
+      result <<~DOC
+        => [#<SystemHook id: 5, url: http://labclient>, ...]
+      DOC
+    end
+
+    def list
+      client.request(:get, 'hooks', SystemHook)
+    end
+  end
+end

data/lib/labclient/system_hooks/system_hook.rb

@@ -0,0 +1,19 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class SystemHook < Klass
+    include ClassHelpers
+    def inspect
+      "#<SystemHook id: #{id}, url: #{url}>"
+    end
+
+    def delete
+      client.system_hooks.delete(id)
+    end
+
+    help do
+      subtitle 'System Hook'
+      option 'delete', 'Delete this hook'
+    end
+  end
+end

data/lib/labclient/system_hooks/test.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class SystemHooks < Common
+    doc 'Test' do
+      desc 'Test System Hook [System Hook ID]'
+      example 'client.system_hooks.test(1)'
+      result <<~DOC
+         {
+           "project_id" : 1,
+           "owner_email" : "labclient",
+           "owner_name" : "Someone",
+           "name" : "Ruby",
+           "path" : "ruby",
+           "event_name" : "project_create"
+        }
+      DOC
+    end
+
+    def test(system_hook_id)
+      system_hook_id = format_id(system_hook_id)
+      client.request(:get, "hooks/#{system_hook_id}")
+    end
+  end
+end

data/lib/labclient/tags/create.rb

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Tags < Common
+    doc 'Create' do
+      desc 'Creates a new tag in the repository that points to the supplied ref. [Project ID, Hash]'
+      example 'client.tags.create(298, tag_name: :new, ref: :master)'
+      result '#<Tag name: initial>'
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | tag_name | string | yes | The name of a tag |
+        | ref | string | yes | Create tag using commit SHA, another tag name, or branch name. |
+        | message | string | no |Creates annotated tag.|
+        | release_description | string | no |Add release notes to the Git tag and store it in the GitLab database.|
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(298)
+        project.tag_create(:initial)
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/repository/tags", Tag, query)
+    end
+  end
+end

data/lib/labclient/tags/delete.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Tags < Common
+    doc 'Delete' do
+      desc 'Deletes a tag of a repository with given name. [Project ID, Tag Name]'
+      example 'client.tags.create(298, :other)'
+    end
+
+    doc 'Delete' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(298)
+        project.tag_delete(:other)
+      DOC
+    end
+
+    def delete(project_id, tag_id)
+      project_id = format_id(project_id)
+      tag_id = format_id(tag_id)
+
+      client.request(:delete, "projects/#{project_id}/repository/tags/#{tag_id}", Tag)
+    end
+  end
+end

data/lib/labclient/tags/list.rb

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Tags < Common
+    doc 'List' do
+      desc 'Get a list of repository tags from a project. [Project ID, Hash]'
+      example 'client.tags.list(298)'
+      result '[#<Tag name: initial>]'
+
+      markdown <<~DOC
+
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | order_by | string | no | Return tags ordered by name or updated fields. Default is updated |
+        | sort | string | no | Return tags sorted in asc or desc order. Default is desc |
+        | search | string | no | Return list of tags matching the search criteria. You can use ^term and term$ to find tags that begin and end with term respectively. |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(298)
+        project.tags
+      DOC
+    end
+
+    def list(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/repository/tags", Tag, query)
+    end
+  end
+end

data/lib/labclient/tags/release.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Tags < Common
+    doc 'Release' do
+      title 'Create'
+      desc 'Add release notes to the existing Git tag. [Project ID, Tag Name, Description]'
+      example 'client.tags.release(298, :initial, "Special release notes!")'
+      result '{:tag_name=>"initial", :description=>"Special release notes!"}'
+    end
+
+    doc 'Release' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(298)
+        project.tag_release(:initial, 'Special release notes!')
+      DOC
+    end
+
+    def release(project_id, tag_id, description)
+      project_id = format_id(project_id)
+      tag_id = format_id(tag_id)
+
+      client.request(:post, "projects/#{project_id}/repository/tags/#{tag_id}/release", nil, description: description)
+    end
+  end
+end

data/lib/labclient/tags/show.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Tags < Common
+    doc 'Show' do
+      desc 'Get a specific repository tag determined by its name. [Project ID, String]'
+      example 'client.tags.show(298, :initial)'
+      result '#<Tag name: initial>'
+    end
+
+    doc 'Show' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(298)
+        project.tag(:initial)
+      DOC
+    end
+
+    def show(project_id, tag_id)
+      project_id = format_id(project_id)
+      tag_id = format_id(tag_id)
+
+      client.request(:get, "projects/#{project_id}/repository/tags/#{tag_id}", Tag)
+    end
+  end
+end

data/lib/labclient/tags/tag.rb

@@ -0,0 +1,16 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Tag < Klass
+    include ClassHelpers
+    date_time_attrs %i[authored_date committed_date created_at]
+
+    def inspect
+      "#<Tag name: #{name}>"
+    end
+
+    def commit
+      Commit.new(@table[:commit], response, client)
+    end
+  end
+end

data/lib/labclient/tags/update.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Tags < Common
+    doc 'Release' do
+      title 'Update'
+      desc 'Updates the release notes of a given release. [Project ID, Tag Name, Description]'
+      example 'client.tags.update(298, :initial, "Special notes!!!")'
+      result '{:tag_name=>"initial", :description=>"Special notes!!!"}'
+    end
+
+    doc 'Release' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(298)
+        project.tag_update(:initial, 'Special release notes!')
+      DOC
+    end
+
+    def update(project_id, tag_id, description)
+      project_id = format_id(project_id)
+      tag_id = format_id(tag_id)
+
+      client.request(:put, "projects/#{project_id}/repository/tags/#{tag_id}/release", nil, description: description)
+    end
+  end
+end

data/lib/labclient/todos/list.rb

@@ -0,0 +1,36 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Todos < Common
+    doc 'List' do
+      desc 'Returns a list of todos. When no filter is applied, it returns all pending todos for the current user. Different filters allow the user to precise the request..'
+      example 'client.todos.list'
+      result <<~DOC
+        => [#<Todo id: 7, state: pending>]
+      DOC
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | action    | string | no | The action to be filtered. Can be assigned, mentioned, build_failed, marked, approval_required, unmergeable or directly_addressed. |
+        | author_id | integer| no | The ID of an author |
+        | project_id| integer| no | The ID of a project |
+        | group_id  | integer| no | The ID of a group |
+        | state     | string | no | The state of the todo. Can be either pending or done |
+        | type      | string | no | The type of a todo. Can be either Issue or MergeRequest |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Filter by todos state'
+      example 'client.todos.list(state: :done)'
+      result <<~DOC
+        => [#<Todo id: 8, state: done>, #<Todo id: 6, state: done>, ...]
+      DOC
+    end
+
+    # List
+    def list(query = {})
+      client.request(:get, 'todos', Todo, query)
+    end
+  end
+end

data/lib/labclient/todos/mark_all_done.rb

@@ -0,0 +1,18 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Todos < Common
+    doc 'Mark all todos as done' do
+      desc 'Marks all pending todos for the current user as done. It returns the HTTP status code 204 with an empty response.'
+      example 'client.todos.mark_all_done'
+      result <<~DOC
+        =>  nil
+      DOC
+    end
+
+    # Mark all as Done
+    def mark_all_done
+      client.request(:post, 'todos/mark_as_done')
+    end
+  end
+end

data/lib/labclient/todos/mark_done.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Todos < Common
+    doc 'Mark a todo as done' do
+      desc 'Marks a single pending todo given by its ID for the current user as done. The todo marked as done is returned in the response.'
+      example 'client.todos.mark_as_done(10)'
+      result <<~DOC
+        => #<Todo id: 10, state: done>
+      DOC
+    end
+
+    doc 'Mark a todo as done' do
+      desc 'Update through todo object'
+      example <<~DOC
+        todo = client.todos.list.first
+        todo.mark_as_done
+      DOC
+      result <<~DOC
+        => #<Todo id: 17, state: done>
+      DOC
+    end
+
+    # Mark as Done
+    def mark_as_done(todo_id)
+      client.request(:post, "todos/#{todo_id}/mark_as_done", Todo)
+    end
+  end
+end

data/lib/labclient/todos/todo.rb

@@ -0,0 +1,22 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Todo < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Todo id: #{id}, state: #{state}>"
+    end
+
+    date_time_attrs %i[created_at]
+
+    def mark_as_done
+      update_self client.todos.mark_as_done(id)
+    end
+
+    help do
+      subtitle 'Todo'
+      option 'mark_as_done', 'Mark this todo as done.'
+    end
+  end
+end

data/lib/labclient/users/activate.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Users < Common
+    doc 'Update' do
+      title 'Block'
+      desc 'Activates the specified user [User ID]'
+      example 'client.users.activate(57)'
+    end
+
+    doc 'Update' do
+      desc 'Via User'
+      example <<~DOC
+        user = client.users.show(57)
+        user.activate
+      DOC
+    end
+
+    def activate(user_id)
+      user_id = format_id(user_id)
+
+      client.request(:post, "users/#{user_id}/activate")
+    end
+  end
+end