labclient 0.1.0

data/lib/labclient/client.rb

@@ -0,0 +1,157 @@
+# Top Namespace
+module LabClient
+  # API Specifics
+  class Client
+    # include HTTParty
+    attr_accessor :settings, :resp, :klass, :link, :http
+
+    def inspect
+      "#<LabClient::Client url: \"#{@settings[:url]}\">"
+    end
+
+    # Helper to make subclasses directly accessible
+    def subclasses
+      self.class.instance_variable_get(:@subclasses)
+    end
+
+    # ----------
+    # Alias List
+    # approvals == merge_request_approvals
+    # repo == repository
+    # ----------
+    @subclasses = {
+      appearance: Appearances,
+      application_settings: ApplicationSettings,
+      application_statistics: ApplicationStatistics,
+      applications: Applications,
+      approvals: Approvals,
+      audit_events: AuditEvents,
+      avatar: Avatars,
+      awards: Awards,
+      branches: Branches,
+      broadcast_messages: BroadcastMessages,
+      ci_lint: CiLint,
+      commits: Commits,
+      deploy_keys: DeployKeys,
+      discussions: Discussions,
+      epics: Epics,
+      events: Events,
+      files: Files,
+      groups: Groups,
+      impersonation_tokens: ImpersonationTokens,
+      issues: Issues,
+      jobs: Jobs,
+      keys: Keys,
+      license: Licenses,
+      markdown: Markdown,
+      members: Members,
+      merge_request_approvals: Approvals,
+      merge_requests: MergeRequests,
+      namespaces: Namespaces,
+      notes: Notes,
+      notifications: Notifications,
+      pipelines: Pipelines,
+      project_runners: ProjectRunners,
+      projects: Projects,
+      protected_branches: ProtectedBranches,
+      protected_tags: ProtectedTags,
+      registry: Registry,
+      repo: Repositories,
+      repository: Repositories,
+      resource_labels: ResourceLabels,
+      runners: Runners,
+      snippets: Snippets,
+      system_hooks: SystemHooks,
+      tags: Tags,
+      todos: Todos,
+      users: Users,
+      version: Version,
+      wikis: Wikis
+    }
+
+    @subclasses.each do |name, obj|
+      define_method(name) do
+        obj.new(self)
+      end
+    end
+
+    def api_methods
+      subclasses.keys.sort
+    end
+
+    def help
+      puts 'Available Methods'
+      puts " - #{subclasses.keys.sort.join(' ')}\n\n"
+      puts "See help for each specific sub-category\n"
+      puts "- client.users.help\n"
+      puts "- client.users.api_methods\n"
+
+      nil
+    end
+
+    # Default setup, pull in settings
+    def initialize(settings = nil)
+      @settings = settings
+      @settings ||= fill_configuration
+
+      # Set Unspecified Defaults
+      unspecified_defaults
+
+      raise 'LabClient Error - Missing URL!' if @settings[:url].nil?
+
+      self.http = HTTP.new(@settings)
+    end
+
+    def unspecified_defaults
+      @settings[:paginate] = true if @settings[:paginate].nil?
+      @settings[:ssl_verify] = true if @settings[:ssl_verify].nil?
+    end
+
+    def home_file
+      ENV['HOME'] + '/.gitlab-labclient'
+    end
+
+    def fill_configuration
+      if File.exist? home_file
+        Oj.load_file(home_file, { symbol_keys: true })
+      else
+        {
+          url: ENV['LABCLIENT_URL'],
+          token: ENV['LABCLIENT_TOKEN']
+        }
+      end
+    end
+
+    def request(method, path, klass = nil, body = {}, dump_json = true)
+      @klass = klass
+
+      resp = http.request(method, path, body, dump_json)
+
+      raise LabClient::Error.new(resp), resp.friendly_error unless resp.success?
+
+      # Drop in raw path
+      resp.instance_variable_set(:@path, path)
+
+      process resp
+    rescue LabClient::Error => e
+      puts e.message
+      resp
+    end
+
+    # Assume we want OpenStruct if @klass is ever nil
+    def process(resp)
+      case resp.data
+      when OpenStruct
+        klass ? klass.new(resp.data, resp, self) : resp.data
+      when Array
+        if @klass.nil?
+          resp.data
+        else
+          PaginatedResponse.new(@klass, resp, self)
+        end
+      else
+        resp.data
+      end
+    end
+  end
+end

data/lib/labclient/commits/cherry_pick.rb

@@ -0,0 +1,40 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Cherry Pick' do
+      desc 'Cherry picks a commit to a target branch.  [Project ID, Commit ID, Target Branch]'
+      example <<~DOC
+        client.commits.cherry_pick(16, '92c2b96b', 'master')
+      DOC
+
+      result <<~DOC
+        => #<Commit title: Update bar, sha: 1e64f40c>
+      DOC
+    end
+
+    doc 'Cherry Pick' do
+      desc 'Via Commit'
+      example <<~DOC
+        commit = client.commits.show(16, 'a0550a65')
+        commit.cherry_pick('new_branch')
+      DOC
+    end
+
+    doc 'Cherry Pick' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit_cherry_pick('a0550a65', 'target_branch)
+      DOC
+    end
+
+    def cherry_pick(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}/cherry_pick", Commit, { branch: branch_name })
+    end
+  end
+end

data/lib/labclient/commits/comment_create.rb

@@ -0,0 +1,67 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Comments' do
+      title 'Create'
+      desc 'Post comment to commit. [Project ID, Commit ID, Hash]'
+      example <<~DOC
+        client.commits.comment_create(16, '04d8c6be', note: 'hi there!')
+      DOC
+
+      result <<~DOC
+        => [#<CommitComment title: another!>]
+      DOC
+
+      markdown <<~DOC
+
+
+        In order to post a comment in a particular line of a particular file, you must
+        specify the full commit SHA, the `path`, the `line` and `line_type` should be
+        `new`.
+
+        The comment will be added at the end of the last commit if at least one of the
+        cases below is valid:
+
+        - the `sha` is instead a branch or a tag and the `line` or `path` are invalid
+        - the `line` number is invalid (does not exist)
+        - the `path` is invalid (does not exist)
+
+        In any of the above cases, the response of `line`, `line_type` and `path` is
+        set to `null`.
+
+
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | note      | string  | yes | The text of the comment |
+        | path      | string  | no  | The file path relative to the repository |
+        | line      | integer | no  | The line number where the comment should be placed |
+        | line_type | string  | no  | The line type. Takes new or old as arguments |
+
+      DOC
+    end
+
+    doc 'Comments' do
+      desc 'Via Commit'
+      example <<~DOC
+        commit = client.commits.show(16,)
+        commit.comments
+      DOC
+    end
+
+    doc 'Comments' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit_comments('a0550a65')
+      DOC
+    end
+
+    def comment_create(project_id, commit_id, query)
+      project_id = format_id(project_id)
+      commit_id = format_id(commit_id)
+
+      client.request(:post, "projects/#{project_id}/repository/commits/#{commit_id}/comments", CommitComment, query)
+    end
+  end
+end

data/lib/labclient/commits/comments.rb

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Comments' do
+      desc 'Get the comments of a commit in a project. [Project ID, Commit ID]'
+      example <<~DOC
+        client.commits.comments(16, '92c2b96b')
+      DOC
+
+      result <<~DOC
+        => [#<CommitComment title: another!>]
+      DOC
+    end
+
+    doc 'Comments' do
+      desc 'Via Commit'
+      example <<~DOC
+        commit = client.commits.show(16,)
+        commit.comments
+      DOC
+    end
+
+    doc 'Comments' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit_comments('a0550a65')
+      DOC
+    end
+
+    def comments(project_id, commit_id)
+      project_id = format_id(project_id)
+      commit_id = format_id(commit_id)
+
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}/comments", CommitComment)
+    end
+  end
+end

data/lib/labclient/commits/commit.rb

@@ -0,0 +1,101 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class Commit < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<Commit title: #{title}, sha: #{short_id}>"
+    end
+
+    def refs(scope = :all)
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.commits.refs(project_id, id, scope)
+    end
+
+    def cherry_pick(branch_name)
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.commits.cherry_pick(project_id, id, branch_name)
+    end
+
+    def revert(branch_name)
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.commits.revert(project_id, id, branch_name)
+    end
+
+    def diff
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.commits.diff(project_id, id)
+    end
+
+    def merge_requests
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.commits.merge_requests(project_id, id)
+    end
+
+    def comments
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.commits.comments(project_id, id)
+    end
+
+    def comment(query)
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.commits.comment_create(project_id, id, query)
+    end
+
+    def project
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.projects.show(project_id)
+    end
+
+    def web_url
+      "#{project.web_url}/-/commit/#{id}"
+    end
+
+    def status(query = {})
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.commits.status(project_id, id, query)
+    end
+
+    def status_update(query = {})
+      # If from List Project ID isn't stored
+      project_id = collect_project_id if project_id.nil?
+
+      client.commits.status_update(project_id, id, query)
+    end
+
+    date_time_attrs %i[committed_date authored_date created_at]
+
+    help do
+      subtitle 'Commit'
+      option 'refs', 'Get all references'
+      option 'cherry_pick', 'Cherry picks a commit to a target branch [Target Branch]'
+      option 'revert', 'Reverts a commit in a given branch [Target Branch]'
+      option 'diff', 'Get the diff'
+      option 'project', 'Show Commit Project'
+      option 'web_url', 'Generate project/web_url'
+      option 'comments', 'Get comments'
+      option 'comment', 'Create new comment [Hash]'
+      option 'status', 'List the statuses [Hash]'
+      option 'status_update', 'Adds or updates a build status [Hash]'
+    end
+  end
+end

data/lib/labclient/commits/commit_comment.rb

@@ -0,0 +1,14 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class CommitComment < Klass
+    include ClassHelpers
+
+    def inspect
+      "#<CommitComment title: #{note[0..9]}>"
+    end
+
+    date_time_attrs %i[created_at]
+    user_attrs %i[author]
+  end
+end

data/lib/labclient/commits/commit_diff.rb

@@ -0,0 +1,7 @@
+# Top namespace
+module LabClient
+  # Inspect Helper
+  class CommitDiff < Klass
+    include ClassHelpers
+  end
+end

data/lib/labclient/commits/create.rb

@@ -0,0 +1,83 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Create' do
+      desc 'Create a commit with multiple files and actions. [Project ID, Hash]'
+      example <<~DOC
+        payload = {
+          actions: [
+            {
+              action: 'create',
+              content: 'some content',
+              file_path: 'foo/bar'
+            }
+          ],
+          branch: 'master',
+          commit_message: 'some commit message'
+        }
+
+
+        client.commits.create(16, payload)
+      DOC
+
+      result <<~DOC
+        => #<Commit title: some commit message, sha: a0550a65>
+      DOC
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | id | integer/string | yes | The ID or [URL-encoded path of the project|
+        | branch | string | yes | Name of the branch to commit into. To create a new branch, also provide either start_branch or start_sha, and optionally start_project. |
+        | commit_message | string | yes | Commit message |
+        | start_branch | string | no | Name of the branch to start the new branch from |
+        | start_sha | string | no | SHA of the commit to start the new branch from |
+        | start_project | integer/string | no | The project ID or URL-encoded path of the project to start the new branch from. Defaults to the value of id. |
+        | actions[] | array | yes | An array of action hashes to commit as a batch. See the next table for what attributes it can take. |
+        | author_email | string | no | Specify the commit author's email address |
+        | author_name | string | no | Specify the commit author's name |
+        | stats | boolean | no | Include commit stats. Default is true |
+        | force | boolean | no | When true overwrites the target branch with a new commit based on the start_branch or start_sha |
+
+        ##### Actions
+
+        | Attribute | Type | Required | Description |
+        | --------------------- | ---- | -------- | ----------- |
+        | action | string | yes | The action to perform, create, delete, move, update, chmod|
+        | file_path | string | yes | Full path to the file. Ex. lib/class.rb |
+        | previous_path | string | no | Original full path to the file being moved. Ex. lib/class1.rb. Only considered for move action. |
+        | content | string | no | File content, required for all except delete, chmod, and move. Move actions that do not specify content will preserve the existing file content, and any other value of content will overwrite the file content. |
+        | encoding | string | no | text or base64. text is default. |
+        | last_commit_id | string | no | Last known file commit id. Will be only considered in update, move and delete actions. |
+        | execute_filemode | boolean | no | When true/false enables/disables the execute flag on the file. Only considered for chmod action. |
+      DOC
+    end
+
+    doc 'Create' do
+      desc 'Via Project'
+      example <<~DOC
+        payload = {
+          actions: [
+            {
+              action: 'create',
+              content: 'some content',
+              file_path: 'foo/bar'
+            }
+          ],
+          branch: 'master',
+          commit_message: 'some commit message'
+        }
+
+        project = client.projects.show(16)
+        project.commit_create(payload)
+      DOC
+    end
+
+    def create(project_id, query = {})
+      project_id = format_id(project_id)
+
+      client.request(:post, "projects/#{project_id}/repository/commits", Commit, query)
+    end
+  end
+end

data/lib/labclient/commits/diff.rb

@@ -0,0 +1,39 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Diff' do
+      desc 'Diffs a commit in a given branch. [Project ID, Commit ID]'
+      example <<~DOC
+        client.commits.diff(16, '92c2b96b')
+      DOC
+
+      result <<~DOC
+        => #<Commit title: Update bar, sha: 1e64f40c>
+      DOC
+    end
+
+    doc 'Diff' do
+      desc 'Via Commit'
+      example <<~DOC
+        commit = client.commits.show(16,)
+        commit.diff('new_branch')
+      DOC
+    end
+
+    doc 'Diff' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit_diff('a0550a65')
+      DOC
+    end
+
+    def diff(project_id, commit_id)
+      project_id = format_id(project_id)
+      commit_id = format_id(commit_id)
+
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}/diff", CommitDiff)
+    end
+  end
+end

data/lib/labclient/commits/list.rb

@@ -0,0 +1,54 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'List' do
+      desc 'List repository commits. [Project ID, Hash]'
+      example 'client.commits.list(16)'
+      result <<~DOC
+        => [#<Commit title: Update README.md, sha: ae5cd273>, #<Commit title: Add README.md, sha: 04d8c6be>]
+      DOC
+
+      markdown <<~DOC
+        | Attribute | Type | Required | Description |
+        | --------- | ---- | -------- | ----------- |
+        | ref_name | string | no | The name of a repository branch, tag or revision range, or if not given the default branch |
+        | since | string | no | Only commits after or on this date will be returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ |
+        | until | string | no | Only commits before or on this date will be returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ |
+        | path | string | no | The file path |
+        | all | boolean | no | Retrieve every commit from the repository |
+        | with_stats | boolean | no | Stats about each commit will be added to the response |
+        | first_parent | boolean | no | Follow only the first parent commit upon seeing a merge commit |
+        | order | string | no | List commits in order. Possible values: default, [topo](https://git-scm.com/docs/git-log#Documentation/git-log.txt---topo-order). Defaults to default, the commits are shown in reverse chronological order. |
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Filter by ref_name'
+      example 'client.commits.list(16, ref_name: :master)'
+    end
+
+    doc 'List' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commits
+      DOC
+    end
+
+    doc 'List' do
+      desc 'Since with Time Helper'
+      example 'client.commits.list(315, since: 1.month.ago)'
+    end
+
+    def list(project_id, query = {})
+      project_id = format_id(project_id)
+
+      %i[since until].each do |field|
+        query[field] = query[field].to_time.iso8601 if format_time?(query[field])
+      end
+
+      client.request(:get, "projects/#{project_id}/repository/commits", Commit, query)
+    end
+  end
+end

data/lib/labclient/commits/merge_requests.rb

@@ -0,0 +1,40 @@
+# Top namespace
+module LabClient
+  # Specifics
+  class Commits < Common
+    doc 'Show' do
+      title 'Merge Requests'
+      desc 'Get a list of Merge Requests related to the specified commit. [Project ID, Commit ID]'
+      example <<~DOC
+        client.commits.merge_requests(16, 'a0550a65')
+      DOC
+
+      result <<~DOC
+        => [#<MergeRequest id: 12, title: Update README.md, state: opened>]
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Commit'
+      example <<~DOC
+        commit = client.commits.show(16, 'a0550a65')
+        commit.merge_requests
+      DOC
+    end
+
+    doc 'Show' do
+      desc 'Via Project'
+      example <<~DOC
+        project = client.projects.show(16)
+        project.commit_merge_requests('a0550a65')
+      DOC
+    end
+
+    def merge_requests(project_id, commit_id)
+      project_id = format_id(project_id)
+      commit_id = format_id(commit_id)
+
+      client.request(:get, "projects/#{project_id}/repository/commits/#{commit_id}/merge_requests", MergeRequest)
+    end
+  end
+end

data/lib/labclient/commits/project_helpers.rb

@@ -0,0 +1,49 @@
+# Top namespace
+module LabClient
+  # Helper Methods for Projects
+  module ProjectCommits
+    def commits(query = {})
+      client.commits.list(id, query)
+    end
+
+    def commit_create(query = {})
+      client.commits.create(id, query)
+    end
+
+    def commit_refs(commit_id, scope = :all)
+      client.commits.refs(id, commit_id, scope)
+    end
+
+    def commit_cherry_pick(commit_id, branch_name)
+      client.commits.cherry_pick(id, commit_id, branch_name)
+    end
+
+    def commit_revert(commit_id, branch_name)
+      client.commits.revert(id, commit_id, branch_name)
+    end
+
+    def commit_diff(commit_id)
+      client.commits.diff(id, commit_id)
+    end
+
+    def commit_comments(commit_id)
+      client.commits.comments(id, commit_id)
+    end
+
+    def commit_comment_create(commit_id, query)
+      client.commits.comment_create(id, commit_id, query)
+    end
+
+    def commit_merge_requests(commit_id)
+      client.commits.merge_requests(id, commit_id)
+    end
+
+    def commit_status(commit_id, query = {})
+      client.commits.status(id, commit_id, query)
+    end
+
+    def commit_status_update(commit_id, query = {})
+      client.commits.status_update(id, commit_id, query)
+    end
+  end
+end