labclient 0.1.0

data/lib/labclient/projects/triggers/list.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectTriggers < Common
+    doc 'List' do
+      desc 'Gets a list of a project triggers. [Project ID]'
+      example 'client.projects.triggers.list(16)'
+
+      result <<~DOC
+        =>  [#<ProjectTrigger id: 2>]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.triggers
+      DOC
+    end
+
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/triggers", ProjectTrigger)
+    end
+  end
+end

data/lib/labclient/projects/triggers/project_trigger.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectTrigger < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectTrigger id: #{id}>"
+    end
+
+    def project
+      project_id = collect_project_id
+      client.projects.show project_id
+    end
+
+    def delete
+      project_id = collect_project_id
+
+      client.projects.triggers.delete(project_id, id)
+    end
+
+    date_time_attrs %i[created_at updated_at last_used]
+    user_attrs %i[owner]
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectTrigger'
+      option 'project', 'Show Project'
+      option 'update', 'Update this variable [Hash]'
+      option 'delete', 'Delete this variable'
+      option 'show', 'Get the details'
+    end
+  end
+end

data/lib/labclient/projects/triggers/show.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectTriggers < Common
+    doc 'Show' do
+      desc 'Gets a trigger of a project. [Project ID, Trigger ID]'
+      example 'client.projects.triggers.show(16, 2)'
+
+      result '=>  #<ProjectTrigger id: 2>'
+    end
+
+    doc 'Show' do
+      desc 'Via Project [Trigger ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        trigger = project.trigger_show(1)
+      DOC
+    end
+
+    def show(project_id, trigger_id)
+      project_id = format_id(project_id)
+      trigger_id = format_id(trigger_id)
+
+      client.request(:get, "projects/#{project_id}/triggers/#{trigger_id}", ProjectTrigger)
+    end
+  end
+end

data/lib/labclient/projects/unarchive.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Update' do
+      title 'Unarchive'
+      example 'client.projects.unarchive(25)'
+      result '#<Project id: 25 badlands/chaurushunter>'
+    end
+
+    doc 'Update' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(299)
+        project.unarchive
+      DOC
+    end
+
+    def unarchive(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/unarchive", Project)
+    end
+  end
+end

data/lib/labclient/projects/unshare.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Update' do
+      subtitle 'Remove Share'
+      desc 'Unshare the project from the group. [Project ID, Group ID]'
+      example 'client.projects.unshare(25, 78)'
+      result '=> nil'
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(25)
+        project.unshare(78)
+      DOC
+    end
+
+    def unshare(project_id, group_id)
+      project_id = format_id(project_id)
+      group_id = format_id(group_id)
+
+      client.request(:delete, "projects/#{project_id}/share/#{group_id}", nil)
+    end
+  end
+end

data/lib/labclient/projects/update.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Update' do
+      desc 'Updates an existing project.'
+      example 'client.projects.update(299, name: "Space")'
+      result '#<Project id: 299 root/space>'
+
+      markdown <<~DOC
+        [See official docs for all possible params](https://docs.gitlab.com/ee/api/projects.html#edit-project)
+
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name | string | yes if path is not provided | The name of the new project. Equals path if not provided. |
+        | path | string | yes if name is not provided | Repository name for new project. Generated based on name if not provided (generated lowercased with dashes). |
+        | description | string | no | Short project description |
+        | default_branch | string | no | master by default |
+
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via project'
+      example <<~DOC
+        project = client.projects.show(299)
+        project.update(description: "Dodge this")
+      DOC
+    end
+
+    def update(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:put, "projects/#{project_id}", Project, query)
+    end
+  end
+end

data/lib/labclient/projects/upload.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Update' do
+      title 'Upload'
+      desc 'Uploads a file to the specified project to be used in an issue or merge request description, or a comment. [ Project ID, File Path'
+      example 'client.projects.upload(25, "/tmp/text.txt")'
+      result '{:alt=>"text.txt", :url=>"/uploads/123123/text.txt", :markdown=>"[text.txt](/uploads/123123/text.txt)"}'
+    end
+
+    doc 'Update' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(299)
+        project.upload("/tmp/text.txt")
+      DOC
+    end
+
+    def upload(project_id, path)
+      project_id = format_id(project_id)
+
+      file = File.open(path, 'r')
+
+      client.request(:post, "projects/#{project_id}/uploads", nil, { file: file }, false)
+    end
+  end
+end

data/lib/labclient/projects/user.rb

@@ -0,0 +1,52 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'List' do
+      title 'User'
+      desc 'Get a list of visible projects owned by the given user. [user id]'
+      example 'client.projects.user(5)'
+      result <<~DOC
+        => [
+         #<Project id: 318, "root/middleman">,
+         #<Project id: 317, "skyrim/dwarvencenturion">,
+         #<Project id: 303, "pawnshopplanet/pibbles">,
+        ]
+      DOC
+    end
+
+    doc 'List' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | archived | boolean | no | Limit by archived status |
+        | visibility | string | no | Limit by visibility public, internal, or private |
+        | order_by | string | no | Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields. Default is created_at |
+        | sort | string | no | Return projects sorted in asc or desc order. Default is desc |
+        | search | string | no | Return list of projects matching the search criteria |
+        | simple | boolean | no | Return only limited fields for each project. This is a no-op without authentication as then _only_ simple fields are returned. |
+        | owned | boolean | no | Limit by projects explicitly owned by the current user |
+        | membership | boolean | no | Limit by projects that the current user is a member of |
+        | starred | boolean | no | Limit by projects starred by the current user |
+        | statistics | boolean | no | Include project statistics |
+        | with_custom_attributes | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) |
+        | with_issues_enabled | boolean | no | Limit by enabled issues feature |
+        | with_merge_requests_enabled | boolean | no | Limit by enabled merge requests feature |
+        | with_programming_language | string | no | Limit by projects which use the given programming language |
+        | min_access_level | integer | no | Limit by current user minimal [access level](members.md) |
+        | id_after                    | integer | no | Limit results to projects with IDs greater than the specified ID |
+        | id_before                   | integer | no | Limit results to projects with IDs less than the specified ID |
+
+      DOC
+    end
+
+    # List/Search users
+    def user(user_id, query = {})
+      user_id = format_id(user_id)
+
+      query_access_level(query, :min_access_level)
+
+      client.request(:get, "users/#{user_id}/projects", Project, query)
+    end
+  end
+end

data/lib/labclient/projects/users.rb

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Show' do
+      title 'Users'
+      desc 'Get the users list of a project.'
+      example 'client.projects.users(10)'
+      result <<~DOC
+        => [
+          #<User id: 2, username: veigar>,
+          #<User id: 3, username: janna>,
+          #<User id: 5, username: denethor>, ...
+        ]
+      DOC
+
+      markdown <<~DOC
+        | Attribute    | Type          | Required | Description |
+        | ------------ | ------------- | -------- | ----------- |
+        | search     | string        | no       | Search for specific users |
+        | skip_users | integer array | no       | Filter out users with the specified IDs |
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via project object'
+      example <<~DOC
+        project = client.projects.show(10)
+        project.users
+      DOC
+    end
+
+    def users(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/users", User, query)
+    end
+  end
+end

data/lib/labclient/projects/variables/client.rb

@@ -0,0 +1,17 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectVariables < Common
+    include ClassHelpers
+  end
+end
+
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    def variables
+      ProjectVariables.new(client)
+    end
+  end
+end

data/lib/labclient/projects/variables/create.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectVariables < Common
+    doc 'Create' do
+      desc 'Adds a variable to a group. [Project ID, Hash]'
+      example <<~DOC
+        client.projects.variables.create(
+          16,
+          key: :rawr,
+          value: :text
+        )
+      DOC
+
+      result '=>  #<ProjectVariable key: rawr>'
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+
+        | Attribute         | Type    | required | Description           |
+        |-------------------|---------|----------|-----------------------|
+        | key               | string  | yes      | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed |
+        | value             | string  | yes      | The value of a variable |
+        | variable_type     | string  | no       | The type of a variable. Available types are: env_var (default) and file |
+        | protected         | boolean | no       | Whether the variable is protected |
+        | masked            | boolean | no       | Whether the variable is masked |
+        | environment_scope | string  | no       | The environment_scope of the variable |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(100)
+        variable = project.variable_create(
+          key: :rawr,
+          value: :text
+        )
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/variables", ProjectVariable, query)
+    end
+  end
+end

data/lib/labclient/projects/variables/delete.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectVariables < Common
+    doc 'Delete' do
+      desc 'Removes a variable from a project. [Project ID, Variable Key]'
+      example 'client.projects.variables.delete(16, :rawr)'
+    end
+
+    doc 'Delete' do
+      desc 'Via Project [Variable ID]'
+      example <<~DOC
+        project = client.projects.show(100)
+        project.variable_delete(3)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via ProjectVariable'
+      example <<~DOC
+        variable = client.projects.variables.show(100, 4)
+        variable.delete
+      DOC
+    end
+
+    def delete(project_id, variable_id)
+      project_id = format_id(project_id)
+      variable_id = format_id(variable_id)
+
+      client.request(:delete, "projects/#{project_id}/variables/#{variable_id}")
+    end
+  end
+end

data/lib/labclient/projects/variables/list.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectVariables < Common
+    doc 'List' do
+      desc 'Gets a list of a project variables. [Project ID]'
+      example 'client.projects.variables.list(16)'
+
+      result <<~DOC
+        => [#<ProjectVariable key: 2, name: first >, #<ProjectVariable key: 3, name: rawr>]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.variables
+      DOC
+    end
+
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/variables", ProjectVariable)
+    end
+  end
+end

data/lib/labclient/projects/variables/project_variable.rb

@@ -0,0 +1,42 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectVariable < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectVariable key: #{key}>"
+    end
+
+    def project
+      project_id = collect_project_id
+      client.projects.show project_id
+    end
+
+    def update(query)
+      project_id = collect_project_id
+
+      update_self client.projects.variables.update(project_id, key, query)
+    end
+
+    def delete
+      project_id = collect_project_id
+
+      client.projects.variables.delete(project_id, key)
+    end
+
+    def show
+      project_id = collect_project_id
+
+      client.projects.variables.show(project_id, key)
+    end
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectVariable'
+      option 'project', 'Show Project'
+      option 'update', 'Update this variable [Hash]'
+      option 'delete', 'Delete this variable'
+      option 'show', 'Get the details'
+    end
+  end
+end

data/lib/labclient/projects/variables/show.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectVariables < Common
+    doc 'Show' do
+      desc 'Gets a variable of a project. [Project ID, Variable Key]'
+      example 'client.projects.variables.show(16, :rawr)'
+
+      result '=>  #<ProjectVariable key: 3, name: rawr>'
+    end
+
+    doc 'Show' do
+      desc 'Via Project [Variable ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        variable = project.variable_show(1)
+      DOC
+    end
+
+    def show(project_id, variable_id)
+      project_id = format_id(project_id)
+      variable_id = format_id(variable_id)
+
+      client.request(:get, "projects/#{project_id}/variables/#{variable_id}", ProjectVariable)
+    end
+  end
+end

data/lib/labclient/projects/variables/update.rb

@@ -0,0 +1,47 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectVariables < Common
+    doc 'Update' do
+      desc 'Updates a variable of a group. [Project ID, Variable Key, Params]'
+      example 'client.projects.variables.update(16, :rawr, value: "planet bob")'
+
+      result '=> #<ProjectVariable id: rawr>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute         | Type    | required | Description             |
+        |-------------------|---------|----------|-------------------------|
+        | value             | string  | yes      | The value of a variable |
+        | variable_type     | string  | no       | The type of a variable. Available types are: env_var (default) and file |
+        | protected         | boolean | no       | Whether the variable is protected |
+        | masked            | boolean | no       | Whether the variable is masked |
+        | environment_scope | string  | no       | The environment_scope of the variable |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project [Variable ID, Params]'
+      example <<~DOC
+        project = client.projects.show(16)
+        variable = project.variable_update(4, value: "switchy")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via ProjectVariable [Params]'
+      example <<~DOC
+        variable = client.projects.variables.show(100, 4)
+        variable.update(value: "switchy")
+      DOC
+    end
+
+    def update(project_id, variable_id, query)
+      project_id = format_id(project_id)
+      variable_id = format_id(variable_id)
+
+      client.request(:put, "projects/#{project_id}/variables/#{variable_id}", ProjectVariable, query)
+    end
+  end
+end

data/lib/labclient/protected_branches/code_owner_approval.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedBranches < Common
+    doc 'Approval' do
+      desc 'Update the “code owner approval required” option for the given protected branch protected branch. [Project ID, Branch]'
+      example 'client.protected_branches.code_owner_approval(264, :other, true)'
+      result '#<Branch name: feature>'
+    end
+
+    doc 'Unprotect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.branch_code_owner_approval(:other, true)
+      DOC
+    end
+
+    def code_owner_approval(project_id, branch_id, approv_id = true)
+      query = { code_owner_approval_required: approv_id }
+
+      project_id = format_id(project_id)
+      client.request(:patch, "projects/#{project_id}/protected_branches/#{branch_id}", Branch, query)
+    end
+  end
+end

data/lib/labclient/protected_branches/list.rb

@@ -0,0 +1,35 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedBranches < Common
+    doc 'List' do
+      desc 'Gets a list of protected branches from a project. [Project ID, String]'
+      example 'client.protected_branches.list(264)'
+      result '[#<Branch name: feature>, #<Branch name: master>]'
+
+      markdown <<~DOC
+        Search: You can use ^term and term$ to find branches that begin and end with term respectively.
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protected_branches
+      DOC
+    end
+
+    def list(project_id, search = nil)
+      query = if search.nil?
+                nil
+              else
+                { search: search }
+              end
+
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/protected_branches", Branch, query)
+    end
+  end
+end

data/lib/labclient/protected_branches/protect.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedBranches < Common
+    doc 'Protect' do
+      desc 'Protects a single repository branch or several project repository branches using a wildcard protected branch. [Project ID, Hash]'
+      example 'client.protected_branches.protect(264, name: :master)'
+      result '#<Branch name: master>'
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name                          | string         | yes | The name of the branch or wildcard |
+        | push_access_level             | string         | no  | Access levels allowed to push (defaults: 40, maintainer access level) |
+        | merge_access_level            | string         | no  | Access levels allowed to merge (defaults: 40, maintainer access level) |
+        | unprotect_access_level        | string         | no  | Access levels allowed to unprotect (defaults: 40, maintainer access level) |
+        | allowed_to_push               | array          | no  | **(STARTER)** Array of access levels allowed to push, with each described by a hash |
+        | allowed_to_merge              | array          | no  | **(STARTER)** Array of access levels allowed to merge, with each described by a hash |
+        | allowed_to_unprotect          | array          | no  | **(STARTER)** Array of access levels allowed to unprotect, with each described by a hash |
+        | code_owner_approval_required  | boolean        | no  | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the CODEOWNERS file (defaults: false) |
+
+        *Valid access levels*
+        0  => No access, :none
+        30 => Developer access, :developer
+        40 => Maintainer access, :maintainer
+        60 => Admin access, :admin
+
+      DOC
+    end
+
+    doc 'Protect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protect_branch(name: :other, push_access_level: :admin)
+      DOC
+    end
+
+    def protect(project_id, query)
+      protected_query_access_level(query, :push_access_level)
+      protected_query_access_level(query, :merge_access_level)
+      protected_query_access_level(query, :unprotect_access_level)
+      # POST /projects/:id/protected_branches
+
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/protected_branches", Branch, query)
+    end
+  end
+end