labclient 0.1.0

data/lib/labclient/protected_branches/show.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedBranches < Common
+    doc 'Show' do
+      desc 'Gets a single protected branch or wildcard protected branch. [Project ID, Branch]'
+      example 'client.protected_branches.show(264, :master)'
+      result '#<Branch name: master>'
+    end
+
+    doc 'Show' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protected_branch(:master)
+      DOC
+    end
+
+    def show(project_id, branch_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/protected_branches/#{branch_id}", Branch)
+    end
+  end
+end

data/lib/labclient/protected_branches/unprotect.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedBranches < Common
+    doc 'Unprotect' do
+      desc 'Unprotects the given protected branch or wildcard protected branch [Project ID, Branch]'
+      example 'client.protected_branches.unprotect(264, :other)'
+      result '#<Branch name: master>'
+    end
+
+    doc 'Unprotect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.unprotect_branch(:other)
+      DOC
+    end
+
+    def unprotect(project_id, branch_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/protected_branches/#{branch_id}", Branch)
+    end
+  end
+end

data/lib/labclient/protected_tags/list.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedTags < Common
+    doc 'List' do
+      desc 'Gets a list of protected tags from a project. [Project ID]'
+      example 'client.protected_tags.list(16)'
+      result '[#<Tag name: feature>, #<Tag name: master>]'
+
+      markdown <<~DOC
+        Search: 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(16)
+        project.protected_tags
+      DOC
+    end
+
+    def list(project_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/protected_tags", Tag)
+    end
+  end
+end

data/lib/labclient/protected_tags/protect.rb

@@ -0,0 +1,44 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedTags < Common
+    doc 'Protect' do
+      desc 'Protects a single repository tag or several project repository tags using a wildcard protected tag. [Project ID, Hash]'
+      example 'client.protected_tags.protect(16, name: :release)'
+      result '#<Tag name: master>'
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name | string | yes | The name of the tag or wildcard |
+        | create_access_level | string | no | Access levels allowed to create (defaults: 40, maintainer access level) |
+
+          *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_tag(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, :create_access_level)
+      # POST /projects/:id/protected_tags
+
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/protected_tags", Tag, query)
+    end
+  end
+end

data/lib/labclient/protected_tags/show.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedTags < Common
+    doc 'Show' do
+      desc 'Gets a single protected tag or wildcard protected tag. [Project ID, Tag]'
+      example 'client.protected_tags.show(16, :release)'
+      result '#<Tag name: release>'
+    end
+
+    doc 'Show' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.protected_tag(:master)
+      DOC
+    end
+
+    def show(project_id, tag_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/protected_tags/#{tag_id}", Tag)
+    end
+  end
+end

data/lib/labclient/protected_tags/unprotect.rb

@@ -0,0 +1,24 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class ProtectedTags < Common
+    doc 'Unprotect' do
+      desc 'Unprotects the given protected tag or wildcard protected tag [Project ID, Tag]'
+      example 'client.protected_tags.unprotect(16, :release)'
+      result '#<Tag name: master>'
+    end
+
+    doc 'Unprotect' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.unprotect_tag(:other)
+      DOC
+    end
+
+    def unprotect(project_id, tag_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/protected_tags/#{tag_id}", Tag)
+    end
+  end
+end

data/lib/labclient/registry/delete.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Registry < Common
+    doc 'Delete' do
+      desc 'Delete a repository in registry. [Project ID, Registry Repository ID]'
+      example 'client.registry.delete(16, 1)'
+    end
+
+    doc 'Delete' do
+      desc 'via Registry Repository'
+      example <<~DOC
+        repo = client.registry.list(16).first
+        repo.delete
+      DOC
+    end
+
+    def delete(project_id, repository_id)
+      repository_id = format_id(repository_id)
+      project_id = format_id(project_id)
+
+      client.request(:delete, "projects/#{project_id}/registry/repositories/#{repository_id}")
+    end
+  end
+end

data/lib/labclient/registry/group.rb

@@ -0,0 +1,33 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Registry < Common
+    doc 'List' do
+      title 'Group'
+      desc 'Get a list of registry repositories in a group. [Group ID]'
+      example 'client.registry.group(59)'
+      result '[#<RegistryRepository id: 1>, #<RegistryRepository id: 2>]'
+
+      markdown <<~DOC
+        | Attribute | Type    | Required | Description |
+        | --------- | ----    | -------- | ----------- |
+        | tags      | boolean | no | If the parameter is included as true, each repository will include an array of "tags" in the response. |
+        | name      | string  | no | Returns a list of repositories with a name that matches the value. |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Group'
+      example <<~DOC
+        group = client.groups.show(59)
+        group.registry_repositories
+      DOC
+    end
+
+    def group(group_id, query = {})
+      group_id = format_id(group_id)
+
+      client.request(:get, "groups/#{group_id}/registry/repositories", RegistryRepository, query)
+    end
+  end
+end

data/lib/labclient/registry/list.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Registry < Common
+    doc 'List' do
+      title 'Project'
+      desc 'Get a list of registry repositories in a project. [Project ID, Hash]'
+      example 'client.registry.list_repository(16)'
+      result '[#<RegistryRepository id: 1>, #<RegistryRepository id: 2>]'
+
+      markdown <<~DOC
+        | Attribute | Type    | Required | Description |
+        | --------- | ----    | -------- | ----------- |
+        | tags      | boolean | no | If the parameter is included as true, each repository will include an array of "tags" in the response. |
+        | name      | string  | no | Returns a list of repositories with a name that matches the value. |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.registry_repositories
+      DOC
+    end
+
+    def list(project_id, query = {})
+      client.request(:get, "projects/#{project_id}/registry/repositories", RegistryRepository, query)
+    end
+  end
+end

data/lib/labclient/registry/repository.rb

@@ -0,0 +1,26 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class RegistryRepository < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<RegistryRepository id: #{id}>"
+    end
+
+    def project
+      client.projects.show(project_id)
+    end
+
+    def tags
+      project_id = collect_project_id
+      client.registry.tags(project_id, id)
+    end
+
+    help do
+      @group_name = 'Registry'
+      subtitle 'Registry Repository'
+      option 'tags', 'List Tags'
+    end
+  end
+end

data/lib/labclient/registry/tags/bulk.rb

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Registry < Common
+    doc 'Delete' do
+      title 'Bulk'
+      desc 'Delete registry repository tags in bulk based on given criteria. [Project ID, Registry Repository ID, Params]'
+      example 'client.registry.bulk(16, 7, name_regex_delete: "*" )'
+    end
+
+    doc 'Delete' do
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | name_regex_delete | string | yes | The [re2](https://github.com/google/re2/wiki/Syntax) regex of the name to delete. To delete all tags specify .*.|
+        | name_regex_keep | string | no | The [re2](https://github.com/google/re2/wiki/Syntax) regex of the name to keep. This value will override any matches from name_regex_delete. Note: setting to .* will result in a no-op. |
+        | keep_n | integer | no | The amount of latest tags of given name to keep. |
+        | older_than | string | no | Tags to delete that are older than the given time, written in human readable form 1h, 1d, 1month. |
+
+      DOC
+    end
+
+    def bulk(project_id, repository_id, query)
+      repository_id = format_id(repository_id)
+      project_id = format_id(project_id)
+
+      client.request(:delete, "projects/#{project_id}/registry/repositories/#{repository_id}/tags", nil, query)
+    end
+  end
+end

data/lib/labclient/registry/tags/delete.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Registry < Common
+    doc 'Delete' do
+      title 'Tag'
+      desc 'Delete a registry repository tag. [Project ID, Registry Repository ID, Tag Name]'
+      example 'client.registry.delete_tag(16, 7, :name)'
+    end
+
+    doc 'Delete' do
+      desc 'via Registry Tag'
+      example <<~DOC
+        tag = client.registry.details(264, 7, :name)
+        tag.delete
+      DOC
+    end
+
+    def delete_tag(project_id, repository_id, tag_name)
+      project_id = format_id(project_id)
+      repository_id = format_id(repository_id)
+      tag_name = format_id(tag_name)
+
+      client.request(:delete, "projects/#{project_id}/registry/repositories/#{repository_id}/tags/#{tag_name}")
+    end
+  end
+end

data/lib/labclient/registry/tags/details.rb

@@ -0,0 +1,20 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Registry < Common
+    doc 'Show' do
+      title 'Tag'
+      desc 'Get details of a registry repository tag. [Project ID, Registry Repository ID, Tag Name]'
+      example 'client.registry.details(16, 1, :name)'
+      result '#=> #<RegistryTag name: name>'
+    end
+
+    def details(project_id, repository_id, tag_name)
+      project_id = format_id(project_id)
+      repository_id = format_id(repository_id)
+      tag_name = format_id(tag_name)
+
+      client.request(:get, "projects/#{project_id}/registry/repositories/#{repository_id}/tags/#{tag_name}", RegistryTag)
+    end
+  end
+end

data/lib/labclient/registry/tags/list.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Registry < Common
+    doc 'List' do
+      title 'Tags'
+      desc 'Get details of a registry repository tag. [Project ID, Registry Repository ID]'
+      example 'client.registry.tags(16, 1)'
+      result '[#<RegistryTag name: name>, #<RegistryTag name: name>]'
+    end
+
+    doc 'List' do
+      desc 'via Registry Repository'
+      example <<~DOC
+        repo = client.registry.list(16).first
+        repo.tags
+      DOC
+    end
+
+    def tags(project_id, repository_id)
+      repository_id = format_id(repository_id)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/registry/repositories/#{repository_id}/tags", RegistryTag)
+    end
+  end
+end

data/lib/labclient/registry/tags/tag.rb

@@ -0,0 +1,23 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class RegistryTag < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<RegistryTag name: #{name}>"
+    end
+
+    def delete
+      project_id = collect_project_id
+      repository_id = collect_repository_id
+      client.registry.delete_tag(project_id, repository_id, name)
+    end
+
+    help do
+      @group_name = 'Registry'
+      subtitle 'Registry Tag'
+      option 'delete', 'Delete tag'
+    end
+  end
+end

data/lib/labclient/repository/alias.rb

@@ -0,0 +1,14 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Repositories < Common
+    @group_name = 'Repository'
+    doc '' do
+      markdown <<~DOC
+        ##### Aliases
+
+        `repository` and `repo` are aliases and be inter-exchanged
+      DOC
+    end
+  end
+end

data/lib/labclient/repository/archive.rb

@@ -0,0 +1,34 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Repositories < Common
+    @group_name = 'Repository'
+    doc 'Archive' do
+      desc 'Get an archive of the repository [Project ID, File Path, Format]'
+      example 'client.repository.archive(264)'
+
+      markdown <<~DOC
+        File Path defaults to local directory '\#{project_id}\#{format}'
+
+        format is an optional suffix for the archive format. Default is tar.gz. Options are tar.gz, tar.bz2, tbz, tbz2, tb2, bz2, tar, and zip. For example, specifying archive.zip would send an archive in ZIP format.
+      DOC
+    end
+
+    doc 'Archive' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.download_archive
+      DOC
+    end
+
+    def archive(project_id, file_path = nil, format = '.tar.gz')
+      project_id = format_id(project_id)
+      file_path ||= "#{Dir.pwd}/#{project_id}#{format}"
+
+      output = client.request(:get, "projects/#{project_id}/repository/archive#{format}", nil)
+
+      File.write(file_path, output)
+    end
+  end
+end

data/lib/labclient/repository/blob.rb

@@ -0,0 +1,32 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Repositories < Common
+    @group_name = 'Repository'
+    doc 'Blob' do
+      desc 'Allows you to receive information about blob in repository like size and content [Project ID, Sha]'
+      example 'client.repository.blob(264, "a3c86df3f")'
+      result '{:size=>6, :encoding=>"base64", :content=>"123", :sha=>"a3c86df3f"}'
+    end
+
+    doc 'Blob' do
+      desc 'Get Raw Blob'
+      example 'client.repository.blob(264, "a3c86df3f", true)'
+    end
+
+    doc 'Blob' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.blob('a3c86df3f')
+      DOC
+    end
+
+    def blob(project_id, sha, raw = nil)
+      project_id = format_id(project_id)
+
+      raw = '/raw' if raw
+      client.request(:get, "projects/#{project_id}/repository/blobs/#{sha}#{raw}", nil)
+    end
+  end
+end

data/lib/labclient/repository/compare.rb

@@ -0,0 +1,31 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Repositories < Common
+    @group_name = 'Repository'
+    doc 'Compare' do
+      desc 'Compare branches, tags or commits [Project ID, Hash]'
+      example 'client.repository.archive(264)'
+
+      markdown <<~DOC
+        **Parameters:**
+
+        * from (required) - the commit SHA or branch name
+        * to (required) - the commit SHA or branch name
+        * straight (optional) - comparison method, true for direct comparison between from and to (from..to), false to compare using merge base (from…to)’. Default is false.
+      DOC
+    end
+
+    doc 'Compare' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.compare(from: :master, to: :feature)
+      DOC
+    end
+
+    def compare(project_id, query)
+      client.request(:get, "projects/#{project_id}/repository/compare", CommitDiff, query)
+    end
+  end
+end

data/lib/labclient/repository/contributors.rb

@@ -0,0 +1,45 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Repositories < Common
+    @group_name = 'Repository'
+    doc 'Contributors' do
+      desc 'Get repository contributors list [Project ID, Hash]'
+      example 'client.repository.contributors(264)'
+      result <<~DOC
+        [{
+          "name": "Example User",
+          "email": "example@labclient",
+          "commits": 117,
+          "additions": 2097,
+          "deletions": 517
+        }, {
+          "name": "Sample User",
+          "email": "sample@labclient",
+          "commits": 33,
+          "additions": 338,
+          "deletions": 244
+        }]
+      DOC
+
+      markdown <<~DOC
+        **Parameters:**
+
+        * order_by (optional) - Return contributors ordered by name, email, or commits (orders by commit date) fields. Default is commits
+        * sort (optional) - Return contributors sorted in asc or desc order. Default is asc
+      DOC
+    end
+
+    doc 'Contributors' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.contributors
+      DOC
+    end
+
+    def contributors(project_id, query = {})
+      client.request(:get, "projects/#{project_id}/repository/contributors", nil, query)
+    end
+  end
+end

data/lib/labclient/repository/merge_base.rb

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Repositories < Common
+    @group_name = 'Repository'
+    doc 'Merge Base' do
+      desc 'Get the common ancestor for 2 or more refs [Project ID, Array(Refs)]'
+      example 'client.repository.merge_base(264, [:master, :feature])'
+      result <<~DOC
+        [{
+          "name": "Example User",
+          "email": "example@labclient",
+          "commits": 117,
+          "additions": 2097,
+          "deletions": 517
+        }, {
+          "name": "Sample User",
+          "email": "sample@labclient",
+          "commits": 33,
+          "additions": 338,
+          "deletions": 244
+        }]
+      DOC
+    end
+
+    doc 'Merge Base' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.merge_base(:master, :feature)
+      DOC
+    end
+
+    def merge_base(project_id, refs)
+      client.request(:get, "projects/#{project_id}/repository/merge_base", nil, refs: refs)
+    end
+  end
+end

data/lib/labclient/repository/raw_blob.rb

@@ -0,0 +1,27 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Repositories < Common
+    @group_name = 'Repository'
+    doc 'Blob' do
+      title 'Raw'
+      desc 'Allows you to receive information about blob in repository like size and content [Project ID, Sha]'
+      example 'client.repository.blob(264, "a3c86df3f")'
+      result '{:size=>6, :encoding=>"base64", :content=>"123", :sha=>"a3c86df3f"}'
+    end
+
+    doc 'Blob' do
+      desc 'via Project'
+      example <<~DOC
+        project = client.projects.show(264)
+        project.blob('a3c86df3f')
+      DOC
+    end
+
+    def blob(project_id, sha)
+      project_id = format_id(project_id)
+
+      client.request(:get, "projects/#{project_id}/repository/blobs/#{sha}", nil)
+    end
+  end
+end