gitlab-akerl 4.0.0

data/lib/gitlab/cli_helpers.rb

@@ -0,0 +1,241 @@
+require 'yaml'
+require 'json'
+require 'base64'
+
+class Gitlab::CLI
+  # Defines methods related to CLI output and formatting.
+  module Helpers
+    extend self
+
+    # Returns actions available to CLI & Shell
+    #
+    # @return [Array]
+    def actions
+      @actions ||= Gitlab.actions
+    end
+
+    # Returns Gitlab::Client instance
+    #
+    # @return [Gitlab::Client]
+    def client
+      @client ||= Gitlab::Client.new(endpoint: (Gitlab.endpoint || ''))
+    end
+
+    # Returns method names and their owners
+    #
+    # @return [Array<Hash>]
+    def method_owners
+      @method_owners ||= actions.map do |action|
+        {
+          name: action.to_s,
+          owner: client.method(action).owner.to_s
+        }
+      end
+    end
+
+    # Returns filtered required fields.
+    #
+    # @return [Array]
+    def required_fields(args)
+      if args.any? && args.last.is_a?(String) && args.last.start_with?('--only=')
+        args.last.gsub('--only=', '').split(',')
+      else
+        []
+      end
+    end
+
+    # Returns filtered excluded fields.
+    #
+    # @return [Array]
+    def excluded_fields(args)
+      if args.any? && args.last.is_a?(String) && args.last.start_with?('--except=')
+        args.last.gsub('--except=', '').split(',')
+      else
+        []
+      end
+    end
+
+    # Confirms command is valid.
+    #
+    # @return [Boolean]
+    def valid_command?(cmd)
+      command = cmd.is_a?(Symbol) ? cmd : cmd.to_sym
+      Gitlab.actions.include?(command)
+    end
+
+    # Confirms command with a desctructive action.
+    #
+    # @return [String]
+    def confirm_command(cmd)
+      if cmd.start_with?('remove_') || cmd.start_with?('delete_')
+        puts "Are you sure? (y/n)"
+        if %w(y yes).include?($stdin.gets.to_s.strip.downcase)
+          puts 'Proceeding..'
+        else
+          puts 'Command aborted.'
+          exit(1)
+        end
+      end
+    end
+
+    # Gets defined help for a specific command/action.
+    #
+    # @return [String]
+    def help(cmd=nil, &block)
+      if cmd.nil? || Gitlab::Help.help_map.key?(cmd)
+        Gitlab::Help.actions_table(cmd)
+      else
+        Gitlab::Help.get_help(cmd, &block)
+      end
+    end
+
+    # Outputs a nicely formatted table or error msg.
+    def output_table(cmd, args, data)
+      case data
+      when Gitlab::ObjectifiedHash, Gitlab::FileResponse
+        puts record_table([data], cmd, args)
+      when Gitlab::PaginatedResponse
+        puts record_table(data, cmd, args)
+      else # probably just an error msg
+        puts data
+      end
+    end
+
+    def output_json(cmd, args, data)
+      if data.empty?
+        puts '{}'
+      else
+        hash_result = case data
+                      when Gitlab::ObjectifiedHash,Gitlab::FileResponse
+                        record_hash([data], cmd, args, true)
+                      when Gitlab::PaginatedResponse
+                        record_hash(data, cmd, args)
+                      else
+                        { cmd: cmd, data: data, args: args }
+        end
+        puts JSON.pretty_generate(hash_result)
+      end
+    end
+
+    # Table to display records.
+    #
+    # @return [Terminal::Table]
+    def record_table(data, cmd, args)
+      return 'No data' if data.empty?
+
+      arr, keys = get_keys(args, data)
+
+      table do |t|
+        t.title = "Gitlab.#{cmd} #{args.join(', ')}"
+        t.headings = keys
+
+        arr.each_with_index do |hash, index|
+          values = []
+
+          keys.each do |key|
+            case value = hash[key]
+            when Hash
+              value = value.has_key?('id') ? value['id'] : 'Hash'
+            when StringIO
+              value = 'File'
+            when nil
+              value = 'null'
+            end
+
+            values << value
+          end
+
+          t.add_row values
+          t.add_separator unless arr.size - 1 == index
+        end
+      end
+    end
+
+    # Renders the result of given commands and arguments into a Hash
+    #
+    # @param  [Array]  data         Resultset from the API call
+    # @param  [String] cmd          The command passed to the API
+    # @param  [Array]  args         Options passed to the API call
+    # @param  [bool]   single_value If set to true, a single result should be returned
+    # @return [Hash]   Result hash
+    def record_hash(data, cmd, args, single_value=false)
+      if data.empty?
+        result = nil
+      else
+        arr, keys = get_keys(args, data)
+        result = []
+        arr.each do |hash|
+          row = {}
+
+          keys.each do |key|
+            case hash[key]
+            when Hash
+              row[key] = 'Hash'
+            when StringIO
+              row[key] = Base64.encode64(hash[key].read)
+            when nil
+              row[key] = nil
+            else
+              row[key] = hash[key]
+            end
+          end
+
+          result.push row
+        end
+        result = result[0] if single_value && result.count > 0
+      end
+
+      {
+        cmd: "Gitlab.#{cmd} #{args.join(', ')}".strip,
+        result: result
+      }
+    end
+
+    # Helper function to get rows and keys from data returned from API call
+    def get_keys(args, data)
+      arr = data.map(&:to_h)
+      keys = arr.first.keys.sort { |x, y| x.to_s <=> y.to_s }
+      keys &= required_fields(args) if required_fields(args).any?
+      keys -= excluded_fields(args)
+      [arr, keys]
+    end
+
+    # Helper function to call Gitlab commands with args.
+    def gitlab_helper(cmd, args=[])
+      begin
+        data = args.any? ? Gitlab.send(cmd, *args) : Gitlab.send(cmd)
+      rescue => e
+        puts e.message
+        yield if block_given?
+      end
+
+      data
+    end
+
+    # Convert a hash (recursively) to use symbol hash keys
+    # @return [Hash]
+    def symbolize_keys(hash)
+      if hash.is_a?(Hash)
+        hash = hash.each_with_object({}) do |(key, value), newhash|
+          begin
+            newhash[key.to_sym] = symbolize_keys(value)
+          rescue NoMethodError
+            raise "error: cannot convert hash key to symbol: #{key}"
+          end
+        end
+      end
+
+      hash
+    end
+
+    # YAML::load on a single argument
+    def yaml_load(arg)
+      begin
+        yaml = YAML.load(arg)
+      rescue Psych::SyntaxError
+        raise "error: Argument is not valid YAML syntax: #{arg}"
+      end
+      yaml
+    end
+  end
+end

data/lib/gitlab/client.rb

@@ -0,0 +1,48 @@
+module Gitlab
+  # Wrapper for the Gitlab REST API.
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+
+    include Branches
+    include Builds
+    include BuildTriggers
+    include BuildVariables
+    include Commits
+    include Groups
+    include Issues
+    include Labels
+    include MergeRequests
+    include Milestones
+    include Namespaces
+    include Notes
+    include Pipelines
+    include Projects
+    include Repositories
+    include RepositoryFiles
+    include Runners
+    include Services
+    include Snippets
+    include SystemHooks
+    include Tags
+    include Users
+
+    # Text representation of the client, masking private token.
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+
+      if @private_token
+        inspected = inspected.sub! @private_token, only_show_last_four_chars(@private_token)
+      end
+
+      inspected
+    end
+
+    private
+
+    def only_show_last_four_chars(token)
+      "#{'*'*(token.size - 4)}#{token[-4..-1]}"
+    end
+  end
+end

data/lib/gitlab/client/branches.rb

@@ -0,0 +1,91 @@
+class Gitlab::Client
+  # Defines methods related to repositories.
+  # @see https://docs.gitlab.com/ce/api/branches.html
+  module Branches
+    # Gets a list of project repositiory branches.
+    #
+    # @example
+    #   Gitlab.branches(42)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [Integer] :page The page number.
+    # @option options [Integer] :per_page The number of results per page.
+    # @return [Array<Gitlab::ObjectifiedHash>]
+    def branches(project, options={})
+      get("/projects/#{project}/repository/branches", query: options)
+    end
+    alias_method :repo_branches, :branches
+
+    # Gets information about a repository branch.
+    #
+    # @example
+    #   Gitlab.branch(3, 'api')
+    #   Gitlab.repo_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def branch(project, branch)
+      get("/projects/#{project}/repository/branches/#{branch}")
+    end
+    alias_method :repo_branch, :branch
+
+    # Protects a repository branch.
+    #
+    # @example
+    #   Gitlab.protect_branch(3, 'api')
+    #   Gitlab.repo_protect_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def protect_branch(project, branch)
+      put("/projects/#{project}/repository/branches/#{branch}/protect")
+    end
+    alias_method :repo_protect_branch, :protect_branch
+
+    # Unprotects a repository branch.
+    #
+    # @example
+    #   Gitlab.unprotect_branch(3, 'api')
+    #   Gitlab.repo_unprotect_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch.
+    # @return [Gitlab::ObjectifiedHash]
+    def unprotect_branch(project, branch)
+      put("/projects/#{project}/repository/branches/#{branch}/unprotect")
+    end
+    alias_method :repo_unprotect_branch, :unprotect_branch
+
+    # Creates a repository branch.  Requires Gitlab >= 6.8.x
+    #
+    # @example
+    #   Gitlab.create_branch(3, 'api')
+    #   Gitlab.repo_create_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the new branch.
+    # @param  [String] ref Create branch from commit sha or existing branch
+    # @return [Gitlab::ObjectifiedHash]
+    def create_branch(project, branch, ref)
+      post("/projects/#{project}/repository/branches", body: { branch_name: branch, ref: ref })
+    end
+    alias_method :repo_create_branch, :create_branch
+
+    # Deletes a repository branch.  Requires Gitlab >= 6.8.x
+    #
+    # @example
+    #   Gitlab.delete_branch(3, 'api')
+    #   Gitlab.repo_delete_branch(5, 'master')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] branch The name of the branch to delete
+    # @return [Gitlab::ObjectifiedHash]
+    def delete_branch(project, branch)
+      delete("/projects/#{project}/repository/branches/#{branch}")
+    end
+    alias_method :repo_delete_branch, :delete_branch
+  end
+end

data/lib/gitlab/client/build_triggers.rb

@@ -0,0 +1,51 @@
+class Gitlab::Client
+  # Defines methods related to builds.
+  # @see https://docs.gitlab.com/ce/api/build_triggers.html
+  module BuildTriggers
+    # Gets a list of the project's build triggers
+    #
+    # @example
+    #   Gitlab.triggers(5)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] The list of triggers.
+    def triggers(project)
+      get("/projects/#{project}/triggers")
+    end
+
+    # Gets details of project's build trigger.
+    #
+    # @example
+    #   Gitlab.trigger(5, '7b9148c158980bbd9bcea92c17522d')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] token The token of a trigger.
+    # @return [Gitlab::ObjectifiedHash] The trigger.
+    def trigger(project, token)
+      get("/projects/#{project}/triggers/#{token}")
+    end
+
+    # Create a build trigger for a project.
+    #
+    # @example
+    #   Gitlab.create_trigger(5)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @return [Gitlab::ObjectifiedHash] The trigger.
+    def create_trigger(project)
+      post("/projects/#{project}/triggers")
+    end
+
+    # Remove a project's build trigger.
+    #
+    # @example
+    #   Gitlab.remove_trigger(5, '7b9148c158980bbd9bcea92c17522d')
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] token The token of a trigger.
+    # @return [Gitlab::ObjectifiedHash] The trigger.
+    def remove_trigger(project, token)
+      delete("/projects/#{project}/triggers/#{token}")
+    end
+  end
+end

data/lib/gitlab/client/build_variables.rb

@@ -0,0 +1,66 @@
+class Gitlab::Client
+  # Defines methods related to builds.
+  # @see https://docs.gitlab.com/ce/api/build_variables.html
+  module BuildVariables
+    # Gets a list of the project's build variables
+    #
+    # @example
+    #   Gitlab.variables(5)
+    #
+    # @param  [Integer] project The ID of a project.
+    # @return [Array<Gitlab::ObjectifiedHash>] The list of variables.
+    def variables(project)
+      get("/projects/#{project}/variables")
+    end
+
+    # Gets details of a project's specific build variable.
+    #
+    # @example
+    #   Gitlab.build(5, "TEST_VARIABLE_1")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def variable(project, key)
+      get("/projects/#{project}/variables/#{key}")
+    end
+
+    # Create a build variable for a project.
+    #
+    # @example
+    #   Gitlab.create_variable(5, "NEW_VARIABLE", "new value")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] key The key of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9` and `_` are allowed
+    # @param  [String] value The value of a variable
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def create_variable(project, key, value)
+      post("/projects/#{project}/variables", body: { key: key, value: value })
+    end
+
+    # Update a project's build variable.
+    #
+    # @example
+    #   Gitlab.create_variable(5, "NEW_VARIABLE", "updated value")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] key The key of a variable
+    # @param  [String] value The value of a variable
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def update_variable(project, key, value)
+      put("/projects/#{project}/variables/#{key}", body: { value: value })
+    end
+
+    # Remove a project's build variable.
+    #
+    # @example
+    #   Gitlab.remove_variable(5, "VARIABLE_1")
+    #
+    # @param  [Integer] project The ID of a project.
+    # @param  [String] key The key of a variable.
+    # @return [Gitlab::ObjectifiedHash] The variable.
+    def remove_variable(project, key)
+      delete("/projects/#{project}/variables/#{key}")
+    end
+  end
+end