fs-gitlab 4.18.1

data/lib/gitlab/paginated_response.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Gitlab
+  # Wrapper class of paginated response.
+  class PaginatedResponse
+    attr_accessor :client
+
+    def initialize(array)
+      @array = array
+    end
+
+    def ==(other)
+      @array == other
+    end
+
+    def inspect
+      @array.inspect
+    end
+
+    def method_missing(name, *args, &block)
+      if @array.respond_to?(name)
+        @array.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      super || @array.respond_to?(method_name, include_private)
+    end
+
+    def parse_headers!(headers)
+      @links = PageLinks.new headers
+    end
+
+    def each_page
+      current = self
+      yield current
+      while current.has_next_page?
+        current = current.next_page
+        yield current
+      end
+    end
+
+    def lazy_paginate
+      to_enum(:each_page).lazy.flat_map(&:to_ary)
+    end
+
+    def auto_paginate(&block)
+      return lazy_paginate.to_a unless block
+
+      lazy_paginate.each(&block)
+    end
+
+    def paginate_with_limit(limit, &block)
+      return lazy_paginate.take(limit).to_a unless block
+
+      lazy_paginate.take(limit).each(&block)
+    end
+
+    def last_page?
+      !(@links.nil? || @links.last.nil?)
+    end
+    alias has_last_page? last_page?
+
+    def last_page
+      return nil if @client.nil? || !has_last_page?
+
+      @client.get(client_relative_path(@links.last))
+    end
+
+    def first_page?
+      !(@links.nil? || @links.first.nil?)
+    end
+    alias has_first_page? first_page?
+
+    def first_page
+      return nil if @client.nil? || !has_first_page?
+
+      @client.get(client_relative_path(@links.first))
+    end
+
+    def next_page?
+      !(@links.nil? || @links.next.nil?)
+    end
+    alias has_next_page? next_page?
+
+    def next_page
+      return nil if @client.nil? || !has_next_page?
+
+      @client.get(client_relative_path(@links.next))
+    end
+
+    def prev_page?
+      !(@links.nil? || @links.prev.nil?)
+    end
+    alias has_prev_page? prev_page?
+
+    def prev_page
+      return nil if @client.nil? || !has_prev_page?
+
+      @client.get(client_relative_path(@links.prev))
+    end
+
+    def client_relative_path(link)
+      client_endpoint_path = URI.parse(@client.endpoint).request_uri # api/v4
+      URI.parse(link).request_uri.sub(client_endpoint_path, '')
+    end
+  end
+end

data/lib/gitlab/request.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+
+module Gitlab
+  # @private
+  class Request
+    include HTTParty
+    format :json
+    maintain_method_across_redirects true
+    headers 'Accept' => 'application/json', 'Content-Type' => 'application/x-www-form-urlencoded'
+    parser(proc { |body, _| parse(body) })
+
+    attr_accessor :private_token, :endpoint
+
+    # Converts the response body to an ObjectifiedHash.
+    def self.parse(body)
+      body = decode(body)
+
+      if body.is_a? Hash
+        ObjectifiedHash.new body
+      elsif body.is_a? Array
+        PaginatedResponse.new(body.collect! { |e| ObjectifiedHash.new(e) })
+      elsif body
+        true
+      elsif !body
+        false
+      else
+        raise Error::Parsing, "Couldn't parse a response body"
+      end
+    end
+
+    # Decodes a JSON response into Ruby object.
+    def self.decode(response)
+      response ? JSON.load(response) : {}
+    rescue JSON::ParserError
+      raise Error::Parsing, 'The response is not a valid JSON'
+    end
+
+    %w[get post put delete].each do |method|
+      define_method method do |path, options = {}|
+        params = options.dup
+
+        httparty_config(params)
+
+        unless params[:unauthenticated]
+          params[:headers] ||= {}
+          params[:headers].merge!(authorization_header)
+        end
+
+        retries_left = params[:ratelimit_retries] || 3
+        begin
+          response = self.class.send(method, endpoint + path, params)
+          validate response
+        rescue Gitlab::Error::TooManyRequests => e
+          retries_left -= 1
+          raise e if retries_left.zero?
+
+          wait_time = response.headers['Retry-After'] || 2
+          sleep(wait_time.to_i)
+          retry
+        end
+      end
+    end
+
+    # Checks the response code for common errors.
+    # Returns parsed response for successful requests.
+    def validate(response)
+      error_klass = Error.klass(response)
+      raise error_klass, response if error_klass
+
+      parsed = response.parsed_response
+      parsed.client = self if parsed.respond_to?(:client=)
+      parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
+      parsed
+    end
+
+    # Sets a base_uri and default_params for requests.
+    # @raise [Error::MissingCredentials] if endpoint not set.
+    def request_defaults(sudo = nil)
+      raise Error::MissingCredentials, 'Please set an endpoint to API' unless endpoint
+
+      self.class.default_params sudo: sudo
+      self.class.default_params.delete(:sudo) if sudo.nil?
+    end
+
+    private
+
+    # Returns an Authorization header hash
+    #
+    # @raise [Error::MissingCredentials] if private_token and auth_token are not set.
+    def authorization_header
+      raise Error::MissingCredentials, 'Please provide a private_token or auth_token for user' unless private_token
+
+      if private_token.size < 21
+        { 'PRIVATE-TOKEN' => private_token }
+      else
+        { 'Authorization' => "Bearer #{private_token}" }
+      end
+    end
+
+    # Set HTTParty configuration
+    # @see https://github.com/jnunemaker/httparty
+    def httparty_config(options)
+      options.merge!(httparty) if httparty
+    end
+  end
+end

data/lib/gitlab/shell.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'gitlab'
+require 'gitlab/help'
+require 'gitlab/cli_helpers'
+require 'gitlab/shell_history'
+require 'readline'
+require 'shellwords'
+
+class Gitlab::Shell
+  extend Gitlab::CLI::Helpers
+
+  class << self
+    attr_reader :arguments, :command
+
+    def start
+      trap('INT') { quit_shell } # capture ctrl-c
+      setup
+
+      while (buffer = Readline.readline('gitlab> '))
+        begin
+          parse_input buffer
+
+          @arguments.map! { |arg| symbolize_keys(yaml_load(arg)) }
+
+          case buffer
+          when nil, ''
+            next
+          when 'exit'
+            quit_shell
+          when /^\bhelp\b+/
+            puts help(arguments[0]) { |out| out.gsub!(/Gitlab\./, 'gitlab> ') }
+          else
+            history << buffer
+
+            data = execute command, arguments
+            output_table command, arguments, data
+          end
+        rescue StandardError => e
+          puts e.message
+        end
+      end
+
+      quit_shell # save history if user presses ctrl-d
+    end
+
+    def parse_input(buffer)
+      buf = Shellwords.shellwords(buffer)
+
+      @command = buf.shift
+      @arguments = buf.count.positive? ? buf : []
+    end
+
+    def setup
+      history.load
+
+      Readline.completion_proc = completion
+      Readline.completion_append_character = ' '
+    end
+
+    # Gets called when user hits TAB key to do completion
+    def completion
+      proc { |str| actions.map(&:to_s).grep(/^#{Regexp.escape(str)}/) }
+    end
+
+    # Execute a given command with arguements
+    def execute(cmd = command, args = arguments)
+      raise "Unknown command: #{cmd}. See the 'help' for a list of valid commands." unless actions.include?(cmd.to_sym)
+
+      confirm_command(cmd)
+      gitlab_helper(cmd, args)
+    end
+
+    def quit_shell
+      history.save
+      exit
+    end
+
+    def history
+      @history ||= History.new
+    end
+  end
+end

data/lib/gitlab/shell_history.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Gitlab::Shell
+  class History
+    DEFAULT_HISTFILESIZE = 200
+    DEFAULT_FILE_PATH = File.join(Dir.home, '.gitlab_shell_history')
+
+    def initialize(options = {})
+      @file_path = options[:file_path] || DEFAULT_FILE_PATH
+      Readline::HISTORY.clear
+    end
+
+    def load
+      read_from_file { |line| Readline::HISTORY << line.chomp }
+    end
+
+    def save
+      lines.each { |line| history_file&.puts line }
+    end
+
+    def push(line)
+      Readline::HISTORY << line
+    end
+    alias << push
+
+    def lines
+      Readline::HISTORY.to_a.last(max_lines)
+    end
+
+    private
+
+    def history_file
+      @history_file ||= File.open(history_file_path, 'w', 0o600).tap do |file|
+        file.sync = true
+      end
+    rescue Errno::EACCES
+      warn 'History not saved; unable to open your history file for writing.'
+      @history_file = false
+    end
+
+    def history_file_path
+      File.expand_path(@file_path)
+    end
+
+    def read_from_file(&block)
+      path = history_file_path
+
+      File.foreach(path, &block) if File.exist?(path)
+    rescue StandardError => e
+      warn "History file not loaded: #{e.message}"
+    end
+
+    def max_lines
+      (ENV['GITLAB_HISTFILESIZE'] || DEFAULT_HISTFILESIZE).to_i
+    end
+  end
+end

data/lib/gitlab/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gitlab
+  VERSION = '4.18.1'
+end

data/lib/gitlab.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'gitlab/version'
+require 'gitlab/objectified_hash'
+require 'gitlab/configuration'
+require 'gitlab/error'
+require 'gitlab/page_links'
+require 'gitlab/paginated_response'
+require 'gitlab/file_response'
+require 'gitlab/request'
+require 'gitlab/api'
+require 'gitlab/client'
+
+module Gitlab
+  extend Configuration
+
+  # Alias for Gitlab::Client.new
+  #
+  # @return [Gitlab::Client]
+  def self.client(options = {})
+    Gitlab::Client.new(options)
+  end
+
+  if Gem::Version.new(RUBY_VERSION).release >= Gem::Version.new('3.0.0')
+    def self.method_missing(method, *args, **keywargs, &block)
+      return super unless client.respond_to?(method)
+
+      client.send(method, *args, **keywargs, &block)
+    end
+  else
+    def self.method_missing(method, *args, &block)
+      return super unless client.respond_to?(method)
+
+      client.send(method, *args, &block)
+    end
+  end
+
+  # Delegate to Gitlab::Client
+  def self.respond_to_missing?(method_name, include_private = false)
+    client.respond_to?(method_name) || super
+  end
+
+  # Delegate to HTTParty.http_proxy
+  def self.http_proxy(address = nil, port = nil, username = nil, password = nil)
+    Gitlab::Request.http_proxy(address, port, username, password)
+  end
+
+  # Returns an unsorted array of available client methods.
+  #
+  # @return [Array<Symbol>]
+  def self.actions
+    hidden =
+      /endpoint|private_token|auth_token|user_agent|sudo|get|post|put|\Adelete\z|validate\z|request_defaults|httparty/
+    (Gitlab::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: fs-gitlab
+version: !ruby/object:Gem::Version
+  version: 4.18.1
+platform: ruby
+authors:
+- Nihad Abbasov
+- Sean Edge
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client and CLI for GitLab API
+email:
+- nihad@42na.in
+- asedge@gmail.com
+executables:
+- gitlab
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/gitlab
+- lib/gitlab.rb
+- lib/gitlab/api.rb
+- lib/gitlab/cli.rb
+- lib/gitlab/cli_helpers.rb
+- lib/gitlab/client.rb
+- lib/gitlab/client/access_requests.rb
+- lib/gitlab/client/application_settings.rb
+- lib/gitlab/client/avatar.rb
+- lib/gitlab/client/award_emojis.rb
+- lib/gitlab/client/boards.rb
+- lib/gitlab/client/branches.rb
+- lib/gitlab/client/broadcast_messages.rb
+- lib/gitlab/client/build_variables.rb
+- lib/gitlab/client/builds.rb
+- lib/gitlab/client/commits.rb
+- lib/gitlab/client/container_registry.rb
+- lib/gitlab/client/deployments.rb
+- lib/gitlab/client/environments.rb
+- lib/gitlab/client/epic_issues.rb
+- lib/gitlab/client/epics.rb
+- lib/gitlab/client/events.rb
+- lib/gitlab/client/features.rb
+- lib/gitlab/client/group_badges.rb
+- lib/gitlab/client/group_boards.rb
+- lib/gitlab/client/group_labels.rb
+- lib/gitlab/client/group_milestones.rb
+- lib/gitlab/client/groups.rb
+- lib/gitlab/client/issue_links.rb
+- lib/gitlab/client/issues.rb
+- lib/gitlab/client/jobs.rb
+- lib/gitlab/client/keys.rb
+- lib/gitlab/client/labels.rb
+- lib/gitlab/client/lint.rb
+- lib/gitlab/client/markdown.rb
+- lib/gitlab/client/merge_request_approvals.rb
+- lib/gitlab/client/merge_requests.rb
+- lib/gitlab/client/milestones.rb
+- lib/gitlab/client/namespaces.rb
+- lib/gitlab/client/notes.rb
+- lib/gitlab/client/packages.rb
+- lib/gitlab/client/pipeline_schedules.rb
+- lib/gitlab/client/pipeline_triggers.rb
+- lib/gitlab/client/pipelines.rb
+- lib/gitlab/client/project_badges.rb
+- lib/gitlab/client/project_clusters.rb
+- lib/gitlab/client/project_release_links.rb
+- lib/gitlab/client/project_releases.rb
+- lib/gitlab/client/projects.rb
+- lib/gitlab/client/protected_tags.rb
+- lib/gitlab/client/remote_mirrors.rb
+- lib/gitlab/client/repositories.rb
+- lib/gitlab/client/repository_files.rb
+- lib/gitlab/client/repository_submodules.rb
+- lib/gitlab/client/resource_label_events.rb
+- lib/gitlab/client/resource_state_events.rb
+- lib/gitlab/client/runners.rb
+- lib/gitlab/client/search.rb
+- lib/gitlab/client/services.rb
+- lib/gitlab/client/sidekiq.rb
+- lib/gitlab/client/snippets.rb
+- lib/gitlab/client/system_hooks.rb
+- lib/gitlab/client/tags.rb
+- lib/gitlab/client/templates.rb
+- lib/gitlab/client/todos.rb
+- lib/gitlab/client/user_snippets.rb
+- lib/gitlab/client/users.rb
+- lib/gitlab/client/versions.rb
+- lib/gitlab/client/wikis.rb
+- lib/gitlab/configuration.rb
+- lib/gitlab/error.rb
+- lib/gitlab/file_response.rb
+- lib/gitlab/help.rb
+- lib/gitlab/objectified_hash.rb
+- lib/gitlab/page_links.rb
+- lib/gitlab/paginated_response.rb
+- lib/gitlab/request.rb
+- lib/gitlab/shell.rb
+- lib/gitlab/shell_history.rb
+- lib/gitlab/version.rb
+homepage: https://github.com/NARKOZ/gitlab
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/NARKOZ/gitlab
+  source_code_uri: https://github.com/NARKOZ/gitlab
+  bug_tracker_uri: https://github.com/NARKOZ/gitlab/issues
+  changelog_uri: https://github.com/NARKOZ/gitlab/releases
+  funding_uri: https://github.com/NARKOZ/SponsorMe
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper and CLI for the GitLab API
+test_files: []