labclient 0.1.0

data/lib/labclient/projects/releases/project_release.rb

@@ -0,0 +1,58 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectRelease < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectRelease tag_name: #{tag_name}, name: #{name}>"
+    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.releases.update(project_id, tag_name, query)
+    end
+
+    def delete
+      project_id = collect_project_id
+
+      client.projects.releases.delete(project_id, tag_name)
+    end
+
+    def evidence
+      project_id = collect_project_id
+
+      client.projects.releases.evidence(project_id, tag_name)
+    end
+
+    def commit
+      Commit.new(@table[:commit], response, client)
+    end
+
+    def links
+      project_id = collect_project_id
+
+      client.projects.release_links.list(project_id, tag_name)
+    end
+
+    # User Fields
+    user_attrs %i[author]
+
+    date_time_attrs %i[created_at released_at]
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectRelease'
+      option 'project', 'Show Project'
+      option 'update', 'Update this release [Hash]'
+      option 'delete', 'Delete this release'
+      option 'evidence', 'Create evidence this release'
+      option 'links', 'Show release links for this release'
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectReleases < Common
+    doc 'Show' do
+      desc 'Get a Release for the given tag. [Project ID, Tag Name]'
+      example 'client.projects.releases.show(16, :release)'
+
+      result '=>  #<ProjectRelease tag_name: release, name: release>'
+    end
+
+    doc 'Show' do
+      desc 'Via Project [Tag Name]'
+      example <<~DOC
+        project = client.projects.show(16)
+        release = project.release_show(:release)
+      DOC
+    end
+
+    def show(project_id, release_id)
+      project_id = format_id(project_id)
+      release_id = format_id(release_id)
+
+      client.request(:get, "projects/#{project_id}/releases/#{release_id}", ProjectRelease)
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectReleases < Common
+    doc 'Update' do
+      desc 'Update a Release. [Project ID, Tag Name, Hash]'
+      example 'client.projects.releases.update(16, :release, name: "planet bob")'
+
+      result '=> #<ProjectRelease tag_name: release, name: planet bob>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute     | Type            | Required | Description                                                                                               |
+        | ------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------- |
+        | tag_name      | string          | yes      | The tag where the release will be created from.                                                           |
+        | name          | string          | no       | The release name.                                                                                         |
+        | description   | string          | no       | The description of the release.                                                                           |
+        | milestones    | array of string | no       | The title of each milestone to associate with the release ([] to remove all milestones from the release). |
+        | released_at   | datetime        | no       | The date when the release will be/was ready. Expected in ISO 8601 format (2019-03-15T08:00:00Z).          |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project [Tag Name, Hash]'
+      example <<~DOC
+        project = client.projects.show(16)
+        release = project.release_update(:release, name: "another")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via ProjectRelease [Params]'
+      example <<~DOC
+        release = client.projects.releases.show(16, :release)
+        release.update(name: "switchy")
+      DOC
+    end
+
+    def update(project_id, release_id, query)
+      project_id = format_id(project_id)
+      release_id = format_id(release_id)
+
+      client.request(:put, "projects/#{project_id}/releases/#{release_id}", ProjectRelease, query)
+    end
+  end
+end

data/lib/labclient/projects/resources.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Resources' do
+      desc 'There are a lot of resources for projects'
+
+      markdown <<~DOC
+        | Name | Description |
+        | ----  | ----------- |
+        | <a target="_" href="/#Project_Hooks">Hooks</a> | Project specific Hooks and Webhooks |
+        | <a target="_" href="/#Stars">Stars</a> | Stars, List all stars, and project starrers |
+        | <a target="_" href="/#Forks">Forks</a> | Forks |
+        | <a target="_" href="/#Push_Rules">Push Rules</a> | Push Rules |
+        | <a target="_" href="/#Deploy_Keys">Deploy Keys</a> | Deploy Keys |
+        | <a target="_" href="/#Project_Runners">Runners</a> | Project Specific Runners |
+        | <a target="_" href="/#Project_Mirrors">Mirrors</a> | Push Mirrors |
+        | <a target="_" href="/#Project_Hooks">Hooks</a> | Hooks |
+        | <a target="_" href="/#Project_Badges">Badges</a> | Badges |
+        | <a target="_" href="/#Project_Access_Requests">Access Requests</a> | Access Requests |
+      DOC
+    end
+  end
+end

data/lib/labclient/projects/restore.rb

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

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

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

data/lib/labclient/projects/runners/disable.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectRunners < Common
+    doc 'Disable' do
+      desc 'Disable a specific runner from the project. It works only if the project isn’t the only project associated with the specified runner. [Project ID, Runner ID]'
+      example 'client.projects.runners.disable(16, 3)'
+    end
+
+    doc 'Disable' do
+      desc 'Via Project [Runner ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.runner_enable(1)
+      DOC
+    end
+
+    def disable(project_id, runner_id)
+      project_id = format_id(project_id)
+      runner_id = format_id(runner_id)
+
+      client.request(:delete, "projects/#{project_id}/runners/#{runner_id}")
+    end
+  end
+end

data/lib/labclient/projects/runners/enable.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectRunners < Common
+    doc 'Enable' do
+      desc 'Enable an available specific runner in the project. [Project ID, Runner ID]'
+      example 'client.projects.runners.enable(16, 3)'
+
+      result '=>  #<Runner id: 1, status: online>'
+    end
+
+    doc 'Enable' do
+      desc 'Via Project [Runner ID]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.runner_enable(1)
+      DOC
+    end
+
+    def enable(project_id, runner_id)
+      project_id = format_id(project_id)
+      runner_id = format_id(runner_id)
+
+      client.request(:post, "projects/#{project_id}/runners", Runner, { runner_id: runner_id })
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectRunners < Common
+    doc 'List' do
+      desc 'List all runners (specific and shared) available in the project. Shared runners are listed if at least one shared runner is defined. [Project ID, Hash]'
+      example 'client.projects.runners.list(15)'
+      result '[#<Runner id: 1, status: online>, ... ]'
+
+      markdown <<~DOC
+
+        | Attribute  | Type           | Required | Description         |
+        |------------|----------------|----------|---------------------|
+        | scope    | string         | no       | Deprecated: Use type or status instead. The scope of specific runners to show, one of: active, paused, online, offline; showing all runners if none provided |
+        | type     | string         | no       | The type of runners to show, one of: instance_type, group_type, project_type |
+        | status   | string         | no       | The status of runners to show, one of: active, paused, online, offline |
+        | tag_list | string array   | no       | List of of the runner's tags |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project [Hash]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.runners
+      DOC
+    end
+
+    def list(project_id, query = {})
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/runners", Runner, query)
+    end
+  end
+end

data/lib/labclient/projects/search.rb

@@ -0,0 +1,91 @@
+# Top namespace
+# Uses the '/search?scope=projects' endpoint
+module LabClient
+  # Projects Specifics
+  class Projects < Common
+    doc 'Search' do
+      desc 'Search through all projects, or within a specific project'
+
+      markdown <<~DOC
+        Search within project scopes
+
+        - issues
+        - merge_requests
+        - milestones
+        - notes
+        - wiki_blobs
+        - commits
+        - blobs
+        - users
+      DOC
+    end
+
+    doc 'Search' do
+      subtitle 'Examples'
+      desc 'Search for projects'
+      example "client.projects.search('project')"
+      result '=> [#<Project id: 311 root/project-search-api>, ... ]'
+    end
+
+    doc 'Search' do
+      desc 'Search within a project with :issues scope'
+      example "client.projects.search_within(311, :issues, 'rawr')"
+      result '=> [#<Issue id: 1, title: rawr, state: opened>]'
+    end
+
+    doc 'Search' do
+      desc 'Search within a project with :notes scope'
+      example "client.projects.search_within(311, :notes, 'Sweet String')"
+      result '=> [#<Note id: 3, type: Issue>]'
+    end
+
+    doc 'Search' do
+      desc 'Search via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.search(:notes, 'sweet search')
+      DOC
+      result '=> [#<Note id: 3, type: Issue>]'
+    end
+
+    # Search All Projects
+    def search_within(project_id, scope, search_string = '')
+      project_id = format_id(project_id)
+
+      scope = scope.to_sym # Case Simplicity
+      query = { scope: scope, search: search_string }
+
+      klass = klass_type(scope)
+
+      client.request(:get, "projects/#{project_id}/search", klass, query)
+    end
+
+    # Search All Projects
+    def search(search_string = '')
+      query = {
+        scope: :projects,
+        search: search_string
+      }
+
+      client.request(:get, 'search', Project, query)
+    end
+
+    private
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # TODO - Finish Classes
+    def klass_type(scope)
+      case scope
+      when :issues then Issue
+      when :merge_requests then MergeRequest
+      when :notes then Note
+      when :wiki_blobs then nil # wiki_blobs
+      when :milestones then nil # ::Project::MileStone
+      when :blobs then nil # blobs
+      when :commits then Commit
+      when :users then User
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end

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

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectServices < Common
+    include ClassHelpers
+
+    doc '' do
+      subtitle 'Usage'
+
+      markdown <<~DOC
+        The same methods are used for configuring all of the services. The payloads and the 'slug' will be different, but each of these methods will be used universally.
+
+        See the [services](https://docs.gitlab.com/ee/api/services.html) documentation for individual options and service/slug availability.
+
+        The *Update* method is used for creating and updating service settings
+      DOC
+    end
+  end
+end
+
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    def services
+      ProjectServices.new(client)
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectServices < Common
+    doc 'Delete' do
+      desc 'Delete service for a project. [Project ID, Service Slug]'
+      example 'client.projects.services.delete(16, :asana)'
+    end
+
+    doc 'Delete' do
+      desc 'Via Project [Service Slug]'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.service_delete(:asana)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via ProjectService'
+      example <<~DOC
+        service = client.projects.services.show(100, :asana)
+        service.delete
+      DOC
+    end
+
+    def delete(project_id, service_slug)
+      project_id = format_id(project_id)
+      service_slug = format_id(service_slug)
+
+      client.request(:delete, "projects/#{project_id}/services/#{service_slug}")
+    end
+  end
+end

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

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

data/lib/labclient/projects/services/project_service.rb

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectService < Klass
+    include ClassHelpers
+    def inspect
+      "#<ProjectService slug: #{slug}, title: #{title}, active: #{active}>"
+    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.services.update(project_id, slug, query))
+    end
+
+    def delete
+      project_id = collect_project_id
+
+      client.projects.services.delete(project_id, slug)
+    end
+
+    date_time_attrs %i[created_at updated_at]
+
+    help do
+      @group_name = 'Projects'
+      subtitle 'ProjectService'
+      option 'project', 'Show Project'
+      option 'update', 'Update this service [Hash]'
+      option 'delete', 'Delete this service'
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectServices < Common
+    doc 'Show' do
+      desc 'Get service settings for a project. [Project ID, Service Slug]'
+      example 'client.projects.services.show(100, :asana)'
+
+      result '=>  #<ProjectService slug: asana, title: Asana, active: false>'
+    end
+
+    doc 'Show' do
+      desc 'Via Project [Service Slug]'
+      example <<~DOC
+        project = client.projects.show(16)
+        service = project.service_show(:asana)
+      DOC
+    end
+
+    def show(project_id, service_slug)
+      project_id = format_id(project_id)
+      service_slug = format_id(service_slug)
+
+      client.request(:get, "projects/#{project_id}/services/#{service_slug}", ProjectService)
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectServices < Common
+    doc 'Create/Update' do
+      desc 'Set service settings for a project. [Project ID, Service Slug, Params]'
+      example 'client.projects.services.update(16, :asana, api_key: "123123")'
+
+      result '=>  #<ProjectService slug: asana, title: Asana, active: true>'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        Required Parameters will be unique to the service you are configuring.
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project [Service Slug, Params]'
+      example <<~DOC
+        project = client.projects.show(16)
+        service = project.service_update(:asana, api_key: "another")
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via ProjectService [Params]'
+      example <<~DOC
+        service = client.projects.services.show(16, :asana)
+        service.update(api_key: "switchy")
+      DOC
+    end
+
+    def update(project_id, service_slug, query)
+      project_id = format_id(project_id)
+      service_slug = format_id(service_slug)
+
+      client.request(:put, "projects/#{project_id}/services/#{service_slug}", ProjectService, query)
+    end
+  end
+end

data/lib/labclient/projects/share.rb

@@ -0,0 +1,56 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Update' do
+      title 'Share'
+      desc 'Allow to share project with group. [Project ID, {group_id, :groups_access}]'
+      example 'client.projects.share(25, group_id: 78, group_access: :developer)'
+      result '{:id=>3, :project_id=>25, :group_id=>78, :group_access=>30, :expires_at=>nil}'
+    end
+
+    doc 'Update' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | id | integer/string | yes | The ID or URL-encoded path of the project|
+        | group_id | integer | yes | The ID of the group to share with |
+        | group_access | integer | yes | The [permissions level](members.md) to grant the group |
+        | expires_at | string | no | Share expiration date in ISO 8601 format: 2016-09-26 |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(25)
+        project.share(78)
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Access helper and Time Helper'
+      example 'client.projects.share(25, group_id: 5, group_access: :developer, expires_at: 1.day.from_now)'
+    end
+
+    doc 'Update' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(299)
+        project.upload("/tmp/text.txt")
+      DOC
+    end
+
+    def share(project_id, query = {})
+      project_id = format_id(project_id)
+
+      # Convert Access if needed
+      query_access_level(query, :group_access)
+
+      # Convert Time if needed
+      query_format_time(query, :expires_at)
+
+      client.request(:post, "projects/#{project_id}/share", nil, query)
+    end
+  end
+end