labclient 0.1.0

data/lib/labclient/commits/refs.rb

@@ -0,0 +1,44 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Show' do
+      title 'Refs'
+      desc 'Get all references (from branches or tags) a commit is pushed to.  [Project ID, Commit ID, Scope]'
+      example <<~DOC
+        client.commits.refs(16, 'a0550a65')
+      DOC
+
+      result <<~DOC
+        => [{:type=>"branch", :name=>"master"}]
+      DOC
+
+      markdown <<~DOC
+        - Possible Scopes: `branch`, `tag`, and `all`. Default is `all`
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Commit'
+      example <<~DOC
+        commit = client.commits.show(16, 'a0550a65')
+        commit.refs
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit_refs('a0550a65')
+      DOC
+    end
+
+    def refs(project_id, commit_id, scope = :all)
+      project_id = format_id(project_id)
+      commit_id = format_id(commit_id)
+
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}/refs", nil, { scope: scope })
+    end
+  end
+end

data/lib/labclient/commits/revert.rb

@@ -0,0 +1,40 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Revert' do
+      desc 'Reverts a commit in a given branch. [Project ID, Commit ID, Target Branch]'
+      example <<~DOC
+        client.commits.revert(16, '92c2b96b', 'master')
+      DOC
+
+      result <<~DOC
+        => #<Commit title: Update bar, sha: 1e64f40c>
+      DOC
+    end
+
+    doc 'Revert' do
+      desc 'Via Commit'
+      example <<~DOC
+        commit = client.commits.show(16, 'a0550a65')
+        commit.revert('new_branch')
+      DOC
+    end
+
+    doc 'Revert' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit_revert('a0550a65', 'target_branch)
+      DOC
+    end
+
+    def revert(project_id, commit_id, branch_name)
+      project_id = format_id(project_id)
+      commit_id = format_id(commit_id)
+      branch_name = format_id(branch_name)
+
+      client.request(:post, "projects/#{project_id}/repository/commits/#{commit_id}/revert", Commit, { branch: branch_name })
+    end
+  end
+end

data/lib/labclient/commits/show.rb

@@ -0,0 +1,25 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Show' do
+      desc 'Get a specific commit identified by the commit hash or name of a branch or tag.'
+      example 'client.commits.show(343, "b539e5d3")'
+      result <<~DOC
+        => #<Commit title: Update README.md, sha: b539e5d3>
+      DOC
+
+      markdown <<~DOC
+        | Attribute | Type | Description |
+        | --------- | ---- | ----------- |
+        | stats | boolean | Include commit stats. Default is true |
+      DOC
+    end
+
+    # Show
+    def show(project_id, commit_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}", Commit)
+    end
+  end
+end

data/lib/labclient/commits/status/list.rb

@@ -0,0 +1,57 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Status' do
+      title 'List'
+      desc 'List the statuses of a commit in a project. [Project ID, Commit ID, Hash]'
+      example <<~DOC
+        client.commits.status(16, '2a3ae164d43b9f7b32d887d6ac7e125f40fd3958')
+      DOC
+
+      result <<~DOC
+        => [#<CommitStatus id: 213, status: success>, #<CommitStatus id: 214, status: success>, ... ]
+      DOC
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | ref     | string  | no  | The name of a repository branch or tag or, if not given, the default branch
+        | stage   | string  | no  | Filter by build stage. e.g., test
+        | name    | string  | no  | Filter by job name, e.g., bundler:audit
+        | all     | boolean | no  | Return all statuses, not only the latest ones
+      DOC
+    end
+
+    doc 'Status' do
+      desc 'Via Commit'
+      example <<~DOC
+        commit = client.commits.show(16, '2a3ae164')
+        commit.status
+      DOC
+    end
+
+    doc 'Status' do
+      desc 'Filter by Stage'
+      example <<~DOC
+        commit = client.commits.show(16, 'a0550a65')
+        commit.status(stage: :test)
+      DOC
+    end
+
+    doc 'Status' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit_status('a0550a65')
+      DOC
+    end
+
+    def status(project_id, commit_id, query = {})
+      project_id = format_id(project_id)
+      commit_id = format_id(commit_id)
+
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}/statuses", CommitStatus, query)
+    end
+  end
+end

data/lib/labclient/commits/status/status.rb

@@ -0,0 +1,14 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class CommitStatus < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<CommitStatus id: #{id}, name: #{name}, status: #{status}>"
+    end
+
+    date_time_attrs %i[created_at started_at finished_at]
+    user_attrs %i[author]
+  end
+end

data/lib/labclient/commits/status/update.rb

@@ -0,0 +1,53 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Status' do
+      title 'Update'
+      desc 'Adds or updates a build status of a commit. [Project ID, Commit ID, Hash]'
+      example <<~DOC
+        client.commits.status_update(16, '2a3ae164d43b9f7b32d887d6ac7e125f40fd3958', state: :running)
+      DOC
+
+      result <<~DOC
+        => #<CommitStatus id: 217, name: default, status: running>
+      DOC
+
+      markdown <<~DOC
+
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | state   | string  | yes   | The state of the status. Can be one of the following: pending, running, success, failed, canceled
+        | ref     | string  | no    | The ref (branch or tag) to which the status refers
+        | name or context | string  | no | The label to differentiate this status from the status of other systems. Default value is default
+        | target_url |  string  | no  | The target URL to associate with this status
+        | description | string  | no  | The short description of the status
+        | coverage | float  | no    | The total code coverage
+        | pipeline_id |  integer  | no  | The ID of the pipeline to set status. Use in case of several pipeline on same SHA.
+      DOC
+    end
+
+    doc 'Status' do
+      desc 'Via Commit'
+      example <<~DOC
+        commit = client.commits.status_update(16, '2a3ae164', state: :success)
+        commit.status
+      DOC
+    end
+
+    doc 'Status' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit_status_update('a0550a65', state: :failed)
+      DOC
+    end
+
+    def status_update(project_id, commit_id, query = {})
+      project_id = format_id(project_id)
+      commit_id = format_id(commit_id)
+
+      client.request(:post, "projects/#{project_id}/statuses/#{commit_id}", CommitStatus, query)
+    end
+  end
+end

data/lib/labclient/common.rb

@@ -0,0 +1,110 @@
+# Top Namesapce
+module LabClient
+  # Shared Methods
+  class Common
+    extend Docs
+    include AccessLevel
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def api_methods
+      public_methods(false)
+    end
+
+    def help
+      api_methods_help
+
+      LabClient::Docs.docs[group_name].each do |key, group|
+        puts "\n=====[ #{key} ]====="
+        group.select { |x| x[:example] }.each { |x| puts "#{x[:example]}\n" }
+      end
+
+      nil
+    end
+
+    def api_methods_help
+      puts group_name
+      puts '  Available Methods'
+      puts "      #{api_methods.sort.join(' ')}\n"
+    end
+
+    # Helper to get docs
+    def klass
+      self.class.name.split('::', 2).last.split(/(?=[A-Z])/).join(' ')
+    end
+
+    # Category and Primary Key for docs
+    def group_name
+      self.class.instance_variable_get('@group_name') || klass
+    end
+
+    def inspect
+      api_methods_help
+      "#<LabClient::Client url: \"#{client.settings[:url]}\">"
+    end
+
+    # =======================
+    # Query Helpers
+    # =======================
+    # URL Encoding Object ID Transformation
+    # "1" == 1, 1 => 1, "1" => 1
+    # nil => nil
+    # 'group/name' => group%F2name
+    # LabClient::Class => id
+
+    def format_id(obj_id)
+      # Return if Empty
+      return nil if obj_id.nil?
+
+      # Already a Integer
+      return obj_id if obj_id.class == Integer
+
+      # If LabClient Object, send ID
+      return obj_id.id if obj_id.class.module_parent_name == 'LabClient'
+
+      # Valid Integer in String
+      return obj_id if /\A\d+\z/.match(obj_id)
+
+      CGI.escape obj_id.to_s
+    end
+
+    def format_query_ids(key, query)
+      query[key] = query[key].map { |x| format_id(x) } if query.key? key
+
+      query[key.to_s] = query[key.to_s].map { |x| format_id(x) } if query.key? key.to_s
+    end
+
+    # Formatting Time Helper
+    def format_time?(time)
+      time.respond_to?(:to_time)
+    end
+
+    def query_format_time(query, key)
+      return false unless query.key?(key) && format_time?(query[key])
+
+      query[key] = query[key].to_time.utc.iso8601
+    end
+
+    # Convert Symbol to Integer Numbers
+    # :developer => 30
+    # :owner => 50
+    def query_access_level(query, key = :group_access)
+      query[key] = machine_access_level query[key] if query.key?(key) && query[key].class == Symbol
+    end
+
+    # TODO: See if these are even needed
+    # Protected Branches
+    # Convert Symbol to Integer Numbers
+    # 0  => No access
+    # 30 => Developer access
+    # 40 => Maintainer access
+    # 60 => Admin access
+    def protected_query_access_level(query, key = :push_access_level)
+      query[key] = machine_protected_access_level query[key] if query.key?(key) && query[key].class == Symbol
+    end
+  end
+end

data/lib/labclient/curl.rb

@@ -0,0 +1,27 @@
+# Generate a curl example
+module CurlHelper
+  # rubocop:disable Metrics/AbcSize
+  def curl
+    output = 'curl '
+    output += '-k ' unless client.settings[:ssl_verify]
+
+    method = response.request.options[:method]
+    output += "-X #{method.upcase} "
+
+    # output = "-H "
+    response.request.options[:headers].each do |key, value|
+      # Hide JSON if GET
+      next if key == 'User-Agent' # Don't bother with agent
+      next if key == 'Expect' # Typheous Specific
+      next if key == 'Content-Type' && method == :get
+
+      output += "-H \"#{key}: #{value}\" "
+    end
+
+    output += "-d '#{response.request.options[:body]}' " if method != :get
+
+    output += "\"#{response.request.url}\""
+    puts output
+  end
+  # rubocop:enable Metrics/AbcSize
+end

data/lib/labclient/deploy_keys/add.rb

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class DeployKeys < Common
+    doc 'Add' do
+      desc 'Creates a new deploy key for a project.'
+      markdown <<~DOC
+        | Attribute  | Type | Required | Description |
+        | ---------  | ---- | -------- | ----------- |
+        | id       | integer/string | yes | The ID or URL-encoded path of the project owned by the authenticated user |
+        | title    | string  | yes | New deploy key's title |
+        | key      | string  | yes | New deploy key |
+        | can_push | boolean | no  | Can deploy key push to the project's repository |
+      DOC
+    end
+
+    doc 'Add' do
+      example <<~DOC
+        client.deploy_keys.add(330,
+          title: "Special Key",
+          key: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDHTAOsjGAI4ZGW5QZQSXhq...'
+        )
+      DOC
+      result <<~DOC
+        => #<Deploy Key id: 3, title: Special Key>
+      DOC
+    end
+
+    doc 'Add' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.deploy_key_add(
+          title: "Special Key",
+          key: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDHTAOsjGAI4ZGW5QZQSXhq...'
+        )
+      DOC
+    end
+
+    # Add
+    def add(project_id, query = {})
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/deploy_keys", DeployKey, query)
+    end
+  end
+end

data/lib/labclient/deploy_keys/delete.rb

@@ -0,0 +1,46 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class DeployKeys < Common
+    doc 'Delete' do
+      desc 'Removes a deploy key from the project. If the deploy key is used only for this project, it will be deleted from the system.'
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | id      | integer/string | yes | The ID or URL-encoded path of the project owned by the authenticated user |
+        | key_id  | integer | yes | The ID of the deploy key |
+      DOC
+    end
+
+    doc 'Delete' do
+      example <<~DOC
+        client.deploy_keys.delete(330, 2)
+      DOC
+      result <<~DOC
+        => nil
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Delete through DeployKey object'
+      example <<~DOC
+        key = client.deploy_keys.show(330,2)
+        key.delete
+      DOC
+    end
+
+    doc 'Delete' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.deploy_key_delete(2)
+      DOC
+    end
+
+    # Delete
+    def delete(project_id, deploy_key_id)
+      project_id = format_id(project_id)
+      client.request(:delete, "projects/#{project_id}/deploy_keys/#{deploy_key_id}", DeployKey)
+    end
+  end
+end

data/lib/labclient/deploy_keys/deploy_key.rb

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class DeployKey < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Deploy Key id: #{id}, title: #{title}>"
+    end
+
+    date_time_attrs %i[created_at]
+
+    def update(query = {})
+      project_id = collect_project_id
+
+      update_self client.deploy_keys.update(project_id, id, query)
+    end
+
+    def delete
+      project_id = collect_project_id
+      client.deploy_keys.delete(project_id, id)
+    end
+
+    help do
+      subtitle 'Deploy Key'
+      option 'delete', 'Delete this deploy key.'
+      option 'update', 'Update this this deploy key.'
+    end
+  end
+end

data/lib/labclient/deploy_keys/enable.rb

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class DeployKeys < Common
+    doc 'Enable' do
+      desc 'Enables a deploy key for a project so this can be used. Returns the enabled key, with a status code 201 when successful.'
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | id      | integer/string | yes | The ID or URL-encoded path of the project owned by the authenticated user |
+        | key_id  | integer | yes | The ID of the deploy key |
+      DOC
+    end
+
+    doc 'Enable' do
+      example <<~DOC
+        client.deploy_keys.enable(330, 2)
+      DOC
+      result <<~DOC
+        => nil
+      DOC
+    end
+
+    doc 'Enable' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.deploy_key_enable(2)
+      DOC
+    end
+
+    # Enable
+    def enable(project_id, deploy_key_id)
+      project_id = format_id(project_id)
+      client.request(:post, "projects/#{project_id}/deploy_keys/#{deploy_key_id}/enable", DeployKey)
+    end
+  end
+end

data/lib/labclient/deploy_keys/list.rb

@@ -0,0 +1,38 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class DeployKeys < Common
+    doc 'List' do
+      desc 'Get a list of all deploy keys across all projects of the GitLab instance. This endpoint requires admin access.'
+      example 'client.deploy_keys.list'
+      result <<~DOC
+        => [#<DeployKey id: 2, title: Special Title>, #<DeployKey id: 1, title: HereWeGo>]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Get a list of a project’s deploy keys.'
+      example 'client.deploy_keys.list(330)'
+      result <<~DOC
+        => [#<DeployKey id: 2, title: Special Title>, #<DeployKey id: 1, title: HereWeGo>]
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.deploy_keys(2)
+      DOC
+    end
+
+    # List
+    def list(deploy_key_id = nil)
+      if deploy_key_id
+        client.request(:get, "projects/#{deploy_key_id}/deploy_keys", DeployKey)
+      else
+        client.request(:get, 'deploy_keys', DeployKey)
+      end
+    end
+  end
+end

data/lib/labclient/deploy_keys/project_helpers.rb

@@ -0,0 +1,29 @@
+# Top namespace
+module LabClient
+  # Helpers for Projects
+  module ProjectDeployKey
+    def deploy_keys
+      client.deploy_keys.list(id)
+    end
+
+    def deploy_key_add(query)
+      client.deploy_keys.add(id, query)
+    end
+
+    def deploy_key_show(key_id)
+      client.deploy_keys.show(id, key_id)
+    end
+
+    def deploy_key_update(key_id, query)
+      client.deploy_keys.update(id, key_id, query)
+    end
+
+    def deploy_key_delete(key_id)
+      client.deploy_keys.delete(id, key_id)
+    end
+
+    def deploy_key_enable(key_id)
+      client.deploy_keys.enable(id, key_id)
+    end
+  end
+end

data/lib/labclient/deploy_keys/show.rb

@@ -0,0 +1,30 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class DeployKeys < Common
+    doc 'Show' do
+      desc 'Get a single key.'
+      example <<~DOC
+        client.deploy_keys.show(330, 2)
+      DOC
+
+      result <<~DOC
+        => #<Deploy Key id: 2, title: Special Key>
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.deploy_key_show(2)
+      DOC
+    end
+
+    # Show
+    def show(project_id, deploy_key_id)
+      project_id = format_id(project_id)
+      client.request(:get, "projects/#{project_id}/deploy_keys/#{deploy_key_id}", DeployKey)
+    end
+  end
+end

data/lib/labclient/deploy_keys/update.rb

@@ -0,0 +1,53 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class DeployKeys < Common
+    doc 'Update' do
+      desc 'Updates a deploy key for a project.'
+      markdown <<~DOC
+        | Attribute  | Type | Required | Description |
+        | ---------  | ---- | -------- | ----------- |
+        | id       | integer/string | yes | The ID or URL-encoded path of the project owned by the authenticated user |
+        | title    | string  | no | New deploy key's title |
+        | can_push | boolean | no  | Can deploy key push to the project's repository |
+      DOC
+    end
+
+    doc 'Update' do
+      example <<~DOC
+        client.deploy_keys.update(330, 2, title: "Very Special Key")
+      DOC
+      result <<~DOC
+        => #<Deploy Key id: 3, title: Very Special Key>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via DeployKey'
+      example <<~DOC
+        key = client.deploy_keys.show(330,2)
+        key.update(title "Moar Special")
+      DOC
+      result <<~DOC
+        => #<Deploy Key id: 2, title: Moar Special>
+      DOC
+    end
+
+    doc 'Update' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.deploy_key_update(2,
+          title: "Special Key",
+          key: 'ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDHTAOsjGAI4ZGW5QZQSXhq...'
+        )
+      DOC
+    end
+
+    # Update
+    def update(project_id, deploy_key_id, query = {})
+      project_id = format_id(project_id)
+      client.request(:put, "projects/#{project_id}/deploy_keys/#{deploy_key_id}", DeployKey, query)
+    end
+  end
+end