labclient 0.1.0

data/lib/labclient/projects/show.rb

@@ -0,0 +1,47 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Show' do
+      desc 'Get a specific project..'
+      example 'client.projects.show(16)'
+      markdown <<~DOC
+
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | id | integer/string | yes | The ID or URL-encoded path of the project |
+        | statistics | boolean | no | Include project statistics |
+        | license | boolean | no | Include project license data |
+        | with_custom_attributes | boolean | no | Include custom attributes in response (admins only) |
+
+      DOC
+
+      result <<~DOC
+        project = client.projects.show(16)
+
+        => <Project id: 16 dimensionc137/cleanse>
+        project.web_url
+        => "https://labclient/dimensionc137/cleanse"
+        project.keys
+        => [:_links,
+          :approvals_before_merge,
+          :archived,
+          :auto_cancel_pending_pipelines,
+          :auto_devops_deploy_strategy,
+          :auto_devops_enabled,
+          :avatar_url,
+          :build_coverage_regex,
+          :external_authorization_classification_label,
+          ...
+        ]
+
+      DOC
+    end
+
+    def show(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}", Project, query)
+    end
+  end
+end

data/lib/labclient/projects/snapshot.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Snapshot' do
+      desc 'Download a snapshot of the project (or wiki, if requested) Git repository [Project ID, Local File Path, Wiki]'
+      example 'client.projects.snapshot(310, "output.tar")'
+    end
+
+    doc 'Snapshot' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(25)
+        project.snapshot('output.tar')
+      DOC
+    end
+
+    def snapshot(project_id, file_name, wiki = false)
+      project_id = format_id(project_id)
+
+      raw = client.request(:get, "projects/#{project_id}/snapshot"), { wiki: wiki }
+      File.write(file_name, raw)
+    end
+  end
+end

data/lib/labclient/projects/snippets/agent_detail.rb

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectSnippets < Common
+    doc 'Show' do
+      title 'Agent Details'
+      desc 'Get user agent details [Project ID, Snippet ID]'
+      example 'client.projects.snippets.agent_detail(16, 2)'
+      result <<~DOC
+        => {:user_agent=>"Mozilla/5.0 (X11; Linux x86_64; rv:72.0) Gecko/20100101 Firefox/72.0", :ip_address=>"10.0.0.14", :akismet_submitted=>false}
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'via ProjectSnippet'
+      example <<~DOC
+        snippet = client.projects.snippets.show(16,2)
+        snippet.agent_detail
+      DOC
+    end
+
+    # Show Specific
+    def agent_detail(project_id, snippet_id)
+      snippet_id = format_id(snippet_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/user_agent_detail")
+    end
+  end
+end

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

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

data/lib/labclient/projects/snippets/content.rb

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectSnippets < Common
+    doc 'Show' do
+      title 'Content'
+      desc 'Returns the raw project snippet as plain text.  [Project ID, Snippet ID]'
+      example 'client.projects.snippets.raw(16, 2)'
+      result <<~DOC
+        => "Here's the special content"
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'via the Project Snippet'
+      example <<~DOC
+        snippet = client.snippets.raw(2)
+        snippet.raw
+      DOC
+    end
+
+    # Show Specific
+    def raw(project_id, snippet_id)
+      snippet_id = format_id(snippet_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}/raw")
+    end
+
+    alias content raw
+  end
+end

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

@@ -0,0 +1,40 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectSnippets < Common
+    doc 'Create' do
+      desc 'Creates a new project snippet. [Project ID, Hash]'
+
+      example <<~DOC
+        client.projects.snippets.create(16,
+          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
+        => #<ProjectSnippet id: 1, title: Sweet Code>
+      DOC
+    end
+
+    doc 'Create' do
+      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
+
+    def create(project_id, query = {})
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/snippets", ProjectSnippet, query)
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectSnippets < Common
+    doc 'Delete' do
+      desc 'Deletes an existing project snippet. [Project ID, Snippet ID]'
+      example <<~DOC
+        client.projects.snippets.delete(16,4)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Delete through Snippet object'
+      example <<~DOC
+        snippet = client.projects.snippets.show(16,1)
+        snippet.delete
+      DOC
+    end
+
+    def delete(project_id, snippet_id)
+      snippet_id = format_id(snippet_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/snippets/#{snippet_id}")
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectSnippets < Common
+    doc 'List' do
+      desc 'Get a list of project snippets. [Project ID]'
+      example 'client.projects.snippets.list(16)'
+      result <<~DOC
+        => [#<ProjectSnippet id: 1, title: Sweet Code>, ...]
+      DOC
+    end
+
+    # List
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/snippets", ProjectSnippet)
+    end
+  end
+end

data/lib/labclient/projects/snippets/project_snippet.rb

@@ -0,0 +1,50 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class ProjectSnippet < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<ProjectSnippet id: #{id}, title: #{title}>"
+    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.snippets.update(project_id, id, query)
+    end
+
+    def raw
+      project_id = collect_project_id
+      client.projects.snippets.raw(project_id, id)
+    end
+
+    alias content raw
+
+    def agent_detail
+      project_id = collect_project_id
+      client.projects.snippets.agent_detail(project_id, id)
+    end
+
+    def delete
+      project_id = collect_project_id
+      client.projects.snippets.delete(project_id, id)
+    end
+
+    date_time_attrs %i[updated_at created_at]
+
+    user_attrs %i[author]
+
+    help do
+      subtitle 'Project 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/projects/snippets/show.rb

@@ -0,0 +1,20 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectSnippets < Common
+    doc 'Show' do
+      desc 'Get a single project snippet. [Project ID, Snippet ID]'
+      example 'client.projects.snippets.show(16, 1)'
+      result <<~DOC
+        => #<ProjectSnippet id: 1, title: Sweet Code>
+      DOC
+    end
+
+    # Show Specific
+    def show(project_id, snippet_id)
+      snippet_id = format_id(snippet_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/snippets/#{snippet_id}", ProjectSnippet)
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectSnippets < Common
+    doc 'Update' do
+      desc 'Updates an existing project snippet [Project ID, Snippet ID, Hash]'
+
+      example <<~DOC
+        client.projects.snippets.update(16, 4, title: 'One Snippet', description: "One Snippet to rule them all")
+      DOC
+
+      result <<~DOC
+        => #<ProjectSnippet id: 1, title: One Snippet>
+      DOC
+    end
+
+    doc 'Update' do
+      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
+      desc 'Via Project Snippet'
+      example <<~DOC
+        snippet.update(title: 'One Snippet to find them!')
+      DOC
+    end
+
+    def update(project_id, snippet_id, query = {})
+      snippet_id = format_id(snippet_id)
+      project_id = format_id(project_id)
+      client.request(:put, "projects/#{project_id}/snippets/#{snippet_id}", ProjectSnippet, query)
+    end
+  end
+end

data/lib/labclient/projects/stars/star.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    @group_name = 'Stars'
+
+    doc 'Star' do
+      desc 'Stars a given project'
+      example 'client.projects.star(10)'
+      result <<~DOC
+        => #<Project id: 30 valenwood/frosttroll>
+      DOC
+    end
+
+    doc 'Star' do
+      desc 'Via project'
+      example <<~DOC
+        project = client.projects.show(10)
+        project.star
+      DOC
+    end
+
+    doc 'Star' do
+      subtitle 'Unstars'
+      desc 'Unstars a given project'
+      example 'client.projects.star(10)'
+    end
+
+    doc 'Star' do
+      desc 'Via project'
+      example <<~DOC
+        project = client.projects.show(10)
+        project.unstar
+      DOC
+    end
+
+    def star(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/star", Project)
+    end
+
+    def unstar(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/unstar", Project)
+    end
+  end
+end

data/lib/labclient/projects/stars/starred_projects.rb

@@ -0,0 +1,51 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    @group_name = 'Stars'
+
+    doc 'List' do
+      desc 'Get a list of projects starred by the given user. [user id]'
+      example 'client.projects.starred(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 starred(user_id, query = {})
+      query_access_level(query, :min_access_level)
+
+      client.request(:get, "users/#{user_id}/starred_projects", Project, query)
+    end
+  end
+end

data/lib/labclient/projects/stars/starrers.rb

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    @group_name = 'Stars'
+
+    doc 'Starrers' do
+      desc 'List the users who starred the specified project. [user id]'
+      example 'client.projects.starrers(5)'
+      result <<~DOC
+        => [#<User id: 1, username: root>, ...]
+
+        # Additional `starred_since` on User
+        users = client.projects.starrers(5)
+        users.first.starred_since
+        => 2020-02-26 14:31:02 -0700
+      DOC
+    end
+
+    doc 'Starrers' do
+      markdown <<~DOC
+        Note: starrers `User` response will include `starred_since`
+
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | search | string | no | Search for specific users. |
+
+      DOC
+    end
+
+    def starrers(project_id, search = '')
+      project_id = format_id(project_id)
+
+      results = if search.empty?
+                  client.request(:get, "projects/#{project_id}/starrers", nil)
+                else
+                  client.request(:get, "projects/#{project_id}/starrers", nil, search: search)
+                end
+
+      results.map do |star_data|
+        star_data.user[:starred_since] = Time.parse star_data.starred_since
+        User.new star_data.user
+      end
+    end
+  end
+end

data/lib/labclient/projects/submodule.rb

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Update' do
+      title 'Submodule'
+      desc 'Update existing submodule reference in repository [Project ID, Submodule, Hash]'
+      example 'client.projects.submodule(16, "module/path", branch: "master", commit_sha: "123123")'
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | `submodule` | string | yes | URL encoded full path to the submodule. For example, `lib%2Fclass%2Erb` |
+        | `branch` | string | yes | Name of the branch to commit into |
+        | `commit_sha` | string | yes | Full commit SHA to update the submodule to |
+        | `commit_message` | string | no | Commit message. If no message is provided, a default one will be set |
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(25)
+        project.housekeeping
+      DOC
+    end
+
+    def submodule(project_id, submodule_id, query)
+      project_id = format_id(project_id)
+
+      client.request(:put, "projects/#{project_id}/repository/submodules/#{submodule_id}", Commit, query)
+    end
+  end
+end

data/lib/labclient/projects/transfer.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Projects < Common
+    doc 'Update' do
+      title 'Transfer'
+      desc 'Transfer a project to a new namespace [Project ID ,Namespace Name/ID]'
+      example 'client.projects.transfer(25, "root")'
+      result '=> #<Project id: 25 badlands/chaurushunter>'
+    end
+
+    doc 'Update' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(25)
+        project.transfer('root')
+      DOC
+    end
+
+    def transfer(project_id, namespace_id)
+      project_id = format_id(project_id)
+      namespace_id = format_id(namespace_id)
+
+      client.request(:put, "projects/#{project_id}/transfer", Project, { namespace: namespace_id })
+    end
+  end
+end

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

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

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

@@ -0,0 +1,37 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectTriggers < Common
+    doc 'Create' do
+      desc 'Adds a trigger to a group. [Project ID, String]'
+      example <<~DOC
+        client.projects.triggers.create(16, 'sweet description')
+      DOC
+
+      result '=>  #<ProjectTrigger id: 1>'
+    end
+
+    doc 'Create' do
+      markdown <<~DOC
+        | Attribute   | Type    | required | Description              |
+        |-------------|---------|----------|--------------------------|
+        | description | string  | yes      | The trigger name         |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        trigger = project.trigger_create('sweet description')
+      DOC
+    end
+
+    def create(project_id, description)
+      project_id = format_id(project_id)
+      query = { description: description }
+
+      client.request(:post, "projects/#{project_id}/triggers", ProjectTrigger, query)
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProjectTriggers < Common
+    doc 'Delete' do
+      desc 'Removes a trigger from a project. [Project ID, Trigger ID]'
+      example 'client.projects.triggers.delete(16, 1)'
+    end
+
+    doc 'Delete' do
+      desc 'Via Project [Trigger ID]'
+      example <<~DOC
+        project = client.projects.show(100)
+        project.trigger_delete(3)
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via ProjectTrigger'
+      example <<~DOC
+        trigger = client.projects.triggers.show(100, 4)
+        trigger.delete
+      DOC
+    end
+
+    def delete(project_id, trigger_id)
+      project_id = format_id(project_id)
+      trigger_id = format_id(trigger_id)
+
+      client.request(:delete, "projects/#{project_id}/triggers/#{trigger_id}")
+    end
+  end
+end