labclient 0.1.0

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

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectEnvironments < Common
+    doc 'Delete' do
+      desc 'Delete an environment from a project. [Project ID, Environment ID]'
+      example 'client.projects.environments.delete(16, 1)'
+    end
+
+    doc 'Delete' do
+      desc 'Via Project [Environment ID]'
+      example <<~DOC
+        project = client.projects.show(100)
+        project.environment_delete(3)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via ProjectEnvironment'
+      example <<~DOC
+        environment = client.projects.environments.show(100, 4)
+        environment.delete
+      DOC
+    end
+
+    def delete(project_id, environment_id)
+      project_id = format_id(project_id)
+      environment_id = format_id(environment_id)
+
+      client.request(:delete, "projects/#{project_id}/environments/#{environment_id}")
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectEnvironments < Common
+    doc 'List' do
+      desc 'Get all environments for a given project. [Project ID, Search (Optional)]'
+      example 'client.projects.environments.list(16)'
+
+      result <<~DOC
+        => [#<ProjectEnvironment id: 1, name: rawr>, #<ProjectEnvironment id: 2, name: rawred>, #<ProjectEnvironment id: 3, name: drawred>]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.environments
+      DOC
+    end
+
+    def list(project_id, search = nil)
+      project_id = format_id(project_id)
+
+      query = if search.nil?
+                nil
+              else
+                { search: search }
+              end
+
+      client.request(:get, "projects/#{project_id}/environments", ProjectEnvironment, query)
+    end
+  end
+end

data/lib/labclient/projects/environments/project_environment.rb

@@ -0,0 +1,44 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectEnvironment < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectEnvironment id: #{id}, name: #{name} external_url: #{external_url}>"
+    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.environments.update(project_id, id, query)
+    end
+
+    def delete
+      project_id = collect_project_id
+
+      client.projects.environments.delete(project_id, id)
+    end
+
+    def stop
+      project_id = collect_project_id
+
+      client.projects.environments.stop(project_id, id)
+    end
+
+    date_time_attrs %i[created_at]
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectEnvironment'
+      option 'project', 'Show Project'
+      option 'update', 'Update this environment [Hash]'
+      option 'delete', 'Delete this environment'
+      option 'stop', 'Stop this environment'
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectEnvironments < Common
+    doc 'Show' do
+      desc 'Get a specific environment [Project ID, Environment ID]'
+      example 'client.projects.environments.show(16, 1)'
+
+      result '=>  #<ProjectEnvironment id: 1, name: first>'
+    end
+
+    doc 'Show' do
+      desc 'Via Project [Environment ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        environment = project.environment_show(1)
+      DOC
+    end
+
+    def show(project_id, environment_id)
+      project_id = format_id(project_id)
+      environment_id = format_id(environment_id)
+
+      client.request(:get, "projects/#{project_id}/environments/#{environment_id}", ProjectEnvironment)
+    end
+  end
+end

data/lib/labclient/projects/environments/stop.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectEnvironments < Common
+    doc 'Stop' do
+      desc 'Stop an environment. [Project ID, Environment ID]'
+      example <<~DOC
+        client.projects.environments.stop(16, 2)
+      DOC
+    end
+
+    doc 'Stop' do
+      desc 'Via ProjectEnvironment'
+      example <<~DOC
+        environment = client.projects.environments.show(16, 4)
+        environment.stop
+      DOC
+    end
+
+    def stop(project_id, environment_id)
+      project_id = format_id(project_id)
+      environment_id = format_id(environment_id)
+
+      client.request(:get, "projects/#{project_id}/environments/#{environment_id}/stop", nil)
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectEnvironments < Common
+    doc 'Update' do
+      desc 'Updates an existing environment’s name and/or external_url. [Project ID, Environment ID, Params]'
+      example 'client.projects.environments.update(16, 3, name: "planet bob")'
+
+      result '=>  #<ProjectEnvironment id: 3, name: planet bob external_url: https://labclient>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute     | Type    | Required | Description                           |
+        | ------------- | ------- | -------- | ------------------------------------- |
+        | name          | string  | no       | The name of the environment           |
+        | external_url  | string  | no       | Place to link to for this environment |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project [Environment ID, Params]'
+      example <<~DOC
+        project = client.projects.show(16)
+        environment = project.environment_update(4, name: "another")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via ProjectEnvironment [Params]'
+      example <<~DOC
+        environment = client.projects.environments.show(16, 4)
+        environment.update(name: "switchy")
+      DOC
+    end
+
+    def update(project_id, environment_id, query)
+      project_id = format_id(project_id)
+      environment_id = format_id(environment_id)
+
+      client.request(:put, "projects/#{project_id}/environments/#{environment_id}", ProjectEnvironment, query)
+    end
+  end
+end

data/lib/labclient/projects/events.rb

@@ -0,0 +1,19 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Show' do
+      title 'Events'
+      desc 'See Events for additional info.'
+      example 'client.events.project(1)'
+    end
+
+    doc 'Show' do
+      desc 'Via project object'
+      example <<~DOC
+        project = client.projects.show(10)
+        project.events
+      DOC
+    end
+  end
+end

data/lib/labclient/projects/forks/existing.rb

@@ -0,0 +1,28 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    @group_name = 'Forks'
+
+    doc 'Associate' do
+      desc 'Create a forked from/to relation between existing projects [Target ID, Source ID]'
+      example 'client.projects.fork_existing(309, 10)'
+      result '#<Project id: 299 root/space>'
+    end
+
+    doc 'Associate' do
+      desc 'Via project'
+      example <<~DOC
+        project = client.projects.show(200)
+        project.fork_existing(15)
+      DOC
+    end
+
+    def fork_existing(project_id, source_id)
+      project_id = format_id(project_id)
+      source_id = format_id(source_id)
+
+      client.request(:post, "projects/#{project_id}/fork/#{source_id}", Project)
+    end
+  end
+end

data/lib/labclient/projects/forks/fork.rb

@@ -0,0 +1,44 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    @group_name = 'Forks'
+
+    doc 'Create' do
+      desc 'Forks a project into the user namespace of the authenticated user or the one provided.'
+      example 'client.projects.fork(299)'
+      result '#<Project id: 299 root/space>'
+
+      markdown <<~DOC
+
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | namespace | integer/string | yes | The ID or path of the namespace that the project will be forked to |
+        | path | string | no | The path that will be assigned to the resultant project after forking |
+        | name | string | no | The name that will be assigned to the resultant project after forking |
+
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Into specific namespace'
+      example <<~DOC
+        project = client.projects.fork(299, namespace: 'root', name: 'nonconflict', path: 'nonconflict')
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via project'
+      example <<~DOC
+        project = client.projects.show(200)
+        new_project = project.fork
+      DOC
+    end
+
+    def fork(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/fork", Project, query)
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    @group_name = 'Forks'
+    doc 'List' do
+      desc 'List the projects accessible to the calling user that have an established, forked relationship with the specified project'
+      example 'client.projects.forks(299)'
+      result <<~DOC
+        => [
+          #<Project id: 302 root/nonconflict>,
+          ...
+        ]
+      DOC
+    end
+
+    doc 'List' do
+      markdown <<~DOC
+        [See Docs for all available params](https://docs.gitlab.com/ee/api/projects.html#list-forks-of-a-project)
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(299)
+        project.forks
+      DOC
+    end
+
+    def forks(project_id, query = {})
+      project_id = format_id(project_id)
+
+      query_access_level(query, :min_access_level)
+
+      client.request(:get, "projects/#{project_id}/forks", Project, query)
+    end
+  end
+end

data/lib/labclient/projects/forks/remove.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    @group_name = 'Forks'
+    doc 'Remove' do
+      desc 'Delete an existing forked from relationship [Project ID]'
+      example 'client.projects.fork_remove(309)'
+      result '#<Project id: 299 root/space>'
+    end
+
+    doc 'Remove' do
+      desc 'Via project'
+      example <<~DOC
+        project = client.projects.show(200)
+        project.fork_remove
+      DOC
+    end
+
+    def fork_remove(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:delete, "projects/#{project_id}/fork")
+    end
+  end
+end

data/lib/labclient/projects/github_import.rb

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Github Import' do
+      desc 'Import your projects from GitHub to GitLab via the API. [Hash]'
+      example 'client.projects.github_import(personal_access_token: "123123", repo_id: 2)'
+
+      markdown <<~DOC
+        | Attribute             | Type    | Required | Description                         |
+        |---------------------- |---------|----------|------------------------------------ |
+        | personal_access_token | string  | yes      | GitHub personal access token        |
+        | repo_id               | integer | yes      | GitHub repository ID                |
+        | new_name              | string  | no       | New repository name                 |
+        | target_namespace      | string  | yes      | Namespace to import repository into |
+      DOC
+    end
+
+    def github_import(query)
+      client.request(:post, 'import/github', nil, query)
+    end
+  end
+end

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

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

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

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectHooks < Common
+    doc 'Create' do
+      desc 'Adds a hook to a specified project. [Project ID, Hash]'
+      example 'client.projects.hooks.create(16, url: "http://labclient.com")'
+
+      result '=>  #<ProjectHook id: 2, url: http://labclient.com>'
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | url | string | yes | The hook URL |
+        | push_events | boolean | no | Trigger hook on push events |
+        | push_events_branch_filter | string | no | Trigger hook on push events for matching branches only |
+        | issues_events | boolean | no | Trigger hook on issues events |
+        | confidential_issues_events | boolean | no | Trigger hook on confidential issues events |
+        | merge_requests_events | boolean | no | Trigger hook on merge requests events |
+        | tag_push_events | boolean | no | Trigger hook on tag push events |
+        | note_events | boolean | no | Trigger hook on note events |
+        | job_events | boolean | no | Trigger hook on job events |
+        | pipeline_events | boolean | no | Trigger hook on pipeline events |
+        | wiki_page_events | boolean | no | Trigger hook on wiki events |
+        | enable_ssl_verification | boolean | no | Do SSL verification when triggering the hook |
+        | token | string | no | Secret token to validate received payloads; this will not be returned in the response |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project [Hook ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        hook = project.hook_create(url: "https://dothething")
+      DOC
+    end
+
+    def create(project_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/hooks", ProjectHook, query)
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectHooks < Common
+    doc 'Delete' do
+      desc 'Removes a hook from a project. [Project ID, Hook ID]'
+      example 'client.projects.hooks.delete(16, 1)'
+    end
+
+    doc 'Delete' do
+      desc 'Via Project [Hook ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.hook_delete(1)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via ProjectHook'
+      example <<~DOC
+        hook = client.projects.hooks.show(16, 1)
+        hook.delete
+      DOC
+    end
+
+    def delete(project_id, hook_id)
+      project_id = format_id(project_id)
+      hook_id = format_id(hook_id)
+
+      client.request(:delete, "projects/#{project_id}/hooks/#{hook_id}")
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectHooks < Common
+    doc 'List' do
+      desc 'Get a list of project hooks. [Project ID]'
+      example 'client.projects.hooks.list(16)'
+
+      result <<~DOC
+        => [
+          #<ProjectHook id: 1, url: https://labclient.url>,
+          ...
+        ]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.hooks
+      DOC
+    end
+
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/hooks", ProjectHook)
+    end
+  end
+end

data/lib/labclient/projects/hooks/project_hook.rb

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectHook < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectHook id: #{id}, url: #{url}>"
+    end
+
+    def project
+      client.projects.show project_id
+    end
+
+    def update(query)
+      update_self client.projects.hooks.update(project_id, id, query)
+    end
+
+    def delete
+      client.projects.hooks.delete(project_id, id)
+    end
+
+    date_time_attrs %i[created_at]
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectHook'
+      option 'project', 'Show Project'
+      option 'update', 'Update this hook [Hash]'
+      option 'delete', 'Delete this hook'
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectHooks < Common
+    doc 'Show' do
+      desc 'Get a specific hook for a project. [Project ID, Hook ID]'
+      example 'client.projects.hooks.show(16, 1)'
+
+      result '=>  #<ProjectHook id: 1, url: https://labclient>'
+    end
+
+    doc 'Show' do
+      desc 'Via Project [Hook ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        hook = project.hook_show(1)
+      DOC
+    end
+
+    def show(project_id, hook_id)
+      project_id = format_id(project_id)
+      hook_id = format_id(hook_id)
+
+      client.request(:get, "projects/#{project_id}/hooks/#{hook_id}", ProjectHook)
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectHooks < Common
+    doc 'Update' do
+      desc 'Edits a hook for a specified project. [Project ID, Hook ID, Params]'
+      example 'client.projects.hooks.update(16, 1, url: "http://labclient.com")'
+
+      result '=>  #<ProjectHook id: 2, url: http://labclient.com>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | url | string | yes | The hook URL |
+        | push_events | boolean | no | Trigger hook on push events |
+        | push_events_branch_filter | string | no | Trigger hook on push events for matching branches only |
+        | issues_events | boolean | no | Trigger hook on issues events |
+        | confidential_issues_events | boolean | no | Trigger hook on confidential issues events |
+        | merge_requests_events | boolean | no | Trigger hook on merge requests events |
+        | tag_push_events | boolean | no | Trigger hook on tag push events |
+        | note_events | boolean | no | Trigger hook on note events |
+        | job_events | boolean | no | Trigger hook on job events |
+        | pipeline_events | boolean | no | Trigger hook on pipeline events |
+        | wiki_page_events | boolean | no | Trigger hook on wiki events |
+        | enable_ssl_verification | boolean | no | Do SSL verification when triggering the hook |
+        | token | string | no | Secret token to validate received payloads; this will not be returned in the response |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project [Hook ID, Params]'
+      example <<~DOC
+        project = client.projects.show(16)
+        hook = project.hook_update(1, url: "https://dothething")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via ProjectHook [Params]'
+      example <<~DOC
+        hook = client.projects.hooks.show(16, 1)
+        hook.update(url: "https://dothething")
+      DOC
+    end
+
+    def update(project_id, hook_id, query)
+      project_id = format_id(project_id)
+      hook_id = format_id(hook_id)
+
+      client.request(:put, "projects/#{project_id}/hooks/#{hook_id}", ProjectHook, query)
+    end
+  end
+end

data/lib/labclient/projects/housekeeping.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Update' do
+      title 'Housekeeping'
+      desc 'Start the Housekeeping task for a Project [Project ID]'
+      example 'client.projects.housekeeping(25)'
+      result <<~DOC
+        # Sidekiq Job ID
+        => "961b99cf00910af6d2e6dbdc"
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(25)
+        project.housekeeping
+      DOC
+    end
+
+    def housekeeping(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/housekeeping", nil)
+    end
+  end
+end