jfh-gitlab-cli 1.0.0.pre.rc.6

data/lib/jfh/gitlab/cli.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "cli/version"
+require_relative "projects/projects"
+
+##
+# Main module for all GEMs
+module Jfh
+  ##
+  # This is the main module for this project
+  module Gitlab
+    ##
+    # The commandline modul
+    #
+    # It provide the public interface, with following member
+    # * version
+    # * list_projects_obj
+    # * list_my_projects
+    #
+    module Cli
+      ##
+      # Generic exception class
+      class Error < StandardError; end
+
+      ##
+      # This class provides the complete functionality of the CLI
+      #
+      class GitlabClient
+        # Instance variable to hold an instance of
+        # {Jfh::Gitlab::Projects::ListProjects}[rdoc-ref:Jfh::Gitlab::Projects::ListProjects]
+        attr_accessor :obj_list_projects
+
+        def initialize # :nodoc:
+          @obj_list_projects = nil
+        end
+
+        # Returns the version string from {Jfh::Gitlab::Cli::VERSION}[rdoc-ref:Jfh::Gitlab::Cli]
+        def version
+          Jfh::Gitlab::Cli::VERSION
+        end
+
+        # Returns a list of all projects, on +STDOUT+, to which the account is assigned as owner.
+        #
+        # Determined the Account via +GITLAB_API_PRIVATE_TOKEN+ from the +.env+ file.
+        #
+        # How many projects are displayed per list side is set via +PAGINATE_PER_PAGE+.
+        #
+        # The following information is returned per project:
+        # * \Gitlab Namespace
+        # * Project name
+        # * Project ID
+        # * Description
+        # * \Gitlab SSH uri to the project
+        #
+        # see also
+        # {Jfh::Gitlab::Projects::ListProjects.list_my_projects}[rdoc-ref:Jfh::Gitlab::Projects::ListProjects#list_my_projects]
+        #
+        # ==== Parameter
+        #
+        # * +input+ - an object of +IO+, default value is +stdin+
+        # * +gitlab_client+ - optionally an object of the class (Gitlab::client)[https://rubygems.org/gems/gitlab]
+        #
+        def list_my_projects(input: $stdin, gitlab_client: nil)
+          @obj_list_projects = Jfh::Gitlab::Projects::ListProjects.new(input:, gitlab_client:) if obj_list_projects.nil?
+          obj_list_projects.list_my_projects
+        end
+      end
+    end
+  end
+end

data/lib/jfh/gitlab/projects/projects.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require "colorize"
+require "console_table"
+require "dotenv"
+require "gitlab"
+require "io/console"
+require "wrapomatic"
+
+module Jfh
+  module Gitlab
+    ##
+    # This is the Projects modul
+    module Projects
+      ##
+      # Class to list \Gitlab projects
+      class ListProjects # rubocop:disable Metrics/ClassLength
+        # Holds the obj of {Gitlab::Client}[https://rubygems.org/gitlab]
+        attr_accessor :gitlab_client
+        # Defines the count of projects per page, default is 5
+        attr_accessor :paginate_per_page
+        # Defines the configuration of {ConsoleTable}[https://rubygems.org/gems/console_table]
+        attr_accessor :table_config
+
+        # Initialize the object and setup the attributes
+        # * {gitlab_client}[rdoc-ref:Jfh::Gitlab::Projects::ListProjects#gitlab_client]
+        # * {paginate_perpage}[rdoc-ref:Jfh::Gitlab::Projects::ListProjects#paginate_per_page]
+        # * {table_config}[rdoc-ref:Jfh::Gitlab::Projects::ListProjects#table_config]
+        #
+        # The configuration can be done with a +.env+ file and environment variables
+        #   GITLAB_API_ENDPOINT=https://gitlab.com/api/v4
+        #   GITLAB_API_PRIVATE_TOKEN=[your rubygems API key]
+        #   PAGINATE_PER_PAGE=15
+        #
+        # === Parameter
+        #
+        # * +input+ - an object of +IO+, default value is +stdin+
+        # * +gitlab_client+ - optionally an object of the class (Gitlab::client)[https://rubygems.org/gems/gitlab]
+        #
+        # Default of +table_config+:
+        #   @table_config = [
+        #     { key: :namespace, size: 40, title: "Namespace" },
+        #     { key: :project, size: 25, title: "Project" },
+        #     { key: :project_id, size: 10, title: "Project#", justify: :right },
+        #     { key: :description, size: 20, title: "Description" },
+        #     { key: :ssh, size: "*", title: "SSH" },
+        #   ]
+        #
+        def initialize(input: $stdin, gitlab_client: nil) # rubocop:disable Metrics/MethodLength
+          # :nocov:
+          if ENV.fetch("IS_RUNNING_MINITEST", "false") != "true" && !(input.instance_of? IO)
+            raise "Expected instance of IO as input parameter"
+          end
+          # :nocov:
+
+          @input = input
+
+          ::Dotenv.load(".env", "~/.jfh-gitlab-cli.env", "/etc/jfh-gitlab-cli.env")
+
+          init_gitlab_client(gitlab_client)
+
+          @paginate_per_page = ENV.fetch("PAGINATE_PER_PAGE", "5").to_i if paginate_per_page.nil?
+
+          return unless table_config.nil?
+
+          @table_config = [
+            { key: :namespace, size: 40, title: "Namespace" },
+            { key: :project, size: 25, title: "Project" },
+            { key: :project_id, size: 10, title: "Project#", justify: :right },
+            { key: :description, size: 20, title: "Description" },
+            { key: :ssh, size: "*", title: "SSH" },
+          ]
+        end
+
+        # Returns a list of all projects, on +STDOUT+, to which the account is assigned as owner.
+        #
+        # Determined the Account via +GITLAB_API_PRIVATE_TOKEN+ from the +.env+ file.
+        #
+        # How many projects are displayed per list side is set via +PAGINATE_PER_PAGE+.
+        #
+        # The following information is returned per project:
+        # * \Gitlab Namespace
+        # * Project name
+        # * Project ID
+        # * Description
+        # * \Gitlab SSH uri to the project
+        #
+        # see also
+        # {Jfh::Gitlab::Cli::GitlabClient.list_my_projects}[rdoc-ref:Jfh::Gitlab::Cli::GitlabClient#list_my_projects]
+        #
+        # ==== Parameter
+        #
+        # * +input+ - an object of +IO+, default value is +stdin+
+        # * +gitlab_client+ - optionally an object of the class (Gitlab::client)[https://rubygems.org/gems/gitlab]
+        #
+        def list_my_projects
+          g = gitlab_client
+
+          projects = g.projects(per_page: paginate_per_page, owned: true)
+
+          if projects.has_first_page?
+            table_title = "List projects owned by #{g.user.to_h["name"]}"
+            paginate_display(projects, table_title)
+          else
+            puts "No projects owned by #{g.user.to_h["name"]} found.\n\n"
+          end
+        end
+
+        private
+
+        # :nocov:
+        def continue_display
+          print "press any key or 'q' for quit"
+          ch = input.getch
+          print "                            \r"
+
+          ch == "q" ? "break" : "continue"
+        end
+        # :nocov:
+
+        def paginate_display(projects, table_title)
+          page = projects.first_page
+          loop do
+            display_page(page, table_title)
+            break if page.has_next_page? == false
+
+            # FIXME: Test still has to be covered
+            # :nocov:
+            response = continue_display
+            break if response == "break"
+
+            page = page.next_page
+            # :nocov:
+          end
+        end
+
+        def display_page(page, table_title)
+          formatted_title = table_title.bold.green.underline
+          ConsoleTable.define(table_config, left_margin: 5, right_margin: 10, title: formatted_title) do |table|
+            page.each do |project|
+              get_line(project).each do |line|
+                table << line
+              end
+            end
+          end
+        end
+
+        def get_line(project) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+          p = project.to_h
+          lines = []
+          desc = p["description"].nil? ? "" : p["description"].to_s
+          if desc.length > table_config[3][:size]
+            wrapped = Wrapomatic.wrap(desc, columns: table_config[3][:size]).split("\n", -1)
+            lines << build_row(p, wrapped[0])
+            i = 1
+            while i < wrapped.length
+              lines << build_row(p, wrapped[1], only_desc: true)
+              i += 1
+            end
+
+            lines
+          else
+            lines << build_row(p, desc)
+          end
+          lines
+        end
+
+        def build_row(p_hash, desc, only_desc: false)
+          {
+            namespace: only_desc ? "" : p_hash["path_with_namespace"].to_s,
+            project: only_desc ? "" : p_hash["name"].to_s.colorize(:yellow),
+            project_id: only_desc ? "" : p_hash["id"].to_s.colorize(:green),
+            description: desc.colorize(:gray),
+            ssh: only_desc ? "" : p_hash["ssh_url_to_repo"].to_s.colorize(:blue),
+          }
+        end
+
+        def init_gitlab_client(gitlab_client) # rubocop:disable Metrics/MethodLength
+          if gitlab_client.nil?
+            @gitlab_client = ::Gitlab.client(
+              endpoint: ENV.fetch("GITLAB_API_ENDPOINT", nil),
+              private_token: ENV.fetch("GITLAB_API_PRIVATE_TOKEN", nil),
+              httparty: {
+                options: "{verfiy: false}",
+              },
+            )
+          else
+            # :nocov:
+            if ENV.fetch("IS_RUNNING_MINITEST", "false") != "true" && !(gitlab_client.instance_of? ::Gitlab::Client)
+              raise "Expected instance of Gitlab::Client as gitlab_client parameter"
+            end
+            # :nocov:
+
+            @gitlab_client = gitlab_client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/get_gemfile_name.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# :nocov:
+namespace :release do
+  gemspec = Bundler.load_gemspec(Dir.glob("*.gemspec").first)
+  package = "#{gemspec.name}-#{gemspec.version}.gem"
+
+  desc "Display the gemfile name: #{package}"
+  task :gemfile do
+    puts package
+  end
+end
+# :nocov:

data/lib/tasks/release_push.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rubygems/commands/push_command"
+
+# :nocov:
+namespace :release do
+  gemspec = Bundler.load_gemspec(Dir.glob("*.gemspec").first)
+  package = "#{gemspec.name}-#{gemspec.version}.gem"
+  package_fullpath = "pkg/#{package}"
+
+  desc "Build and push #{package} to rubygems.org, CREATES NO TAG!"
+  task :push do
+    Rake::Task["build"].execute
+    Rake::Task["build:checksum"].execute
+
+    cmd = Gem::Commands::PushCommand.new
+    cmd.invoke package_fullpath
+  end
+end
+# :nocov: