renuo-cli 3.1.7 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d0c7cb1b6bb3792c2b43d510487bb7e876070c6cdf83e7e4d41d96a556ab782
-  data.tar.gz: 851fe36fa4258b8a15a4bfe47186776e20638c453913df29549bb1d90c38398a
+  metadata.gz: 32e7195714b090ac3c9288984191e946e2f19b23b8edbc4dd996acb48861cc4f
+  data.tar.gz: b39a490ac91d15099381d980591b49704ebfe3d3e33b27f31021cef89a1cfc54
 SHA512:
-  metadata.gz: cd6b422735e525fe3f408ca5f30b65af4cb0f8a88b8b6c2d70b4cbc3db3bb077fc1e27b0af776b48b47d2e7590accf68e681d1c676aeb954bc7aae032a9b7a3a
-  data.tar.gz: f0989fe4f8c88dbbaf52f944c1aeb8053ae2d3199456e742941cd3cbdf2ce15d2f1cb5ba4edad6cabf51de438cc87d5b4580f8ce34f27d816a53600a646d99cd
+  metadata.gz: 1f002ed372032ca450b89f2ac6049bcac0a66d77cd219cbac72df50a6f35926e9d175fdb7df22cdfa4dca3c2fdbff0a702e6a31379ab8c4cbf0655b4f1a7727d
+  data.tar.gz: d720553fad38e6c1ecfde475823e3535e7e003505bb9d27db6ce1bdd8bd74b2d3d4a12755a483438afb7e2edd8749e0daef276262371350ef1895d9866910021

data/.rubocop.yml

@@ -1,43 +1,10 @@
-AllCops:
-  Include:
-    - 'lib/**/*.rb'
-    - 'spec/**/*'
-    - '*.gemspec'
-  Exclude:
-    - 'bin/**/*'
-    - 'lib/renuo/cli.rb'
-    - 'lib/renuo/cli/app/heroku_users'
-    - 'lib/renuo/cli/app/fetch_all_emails'
-    - 'lib/renuo/cli/app/create_heroku_app'
-    - 'vendor/**/*'
+inherit_gem:
+  renuocop: config/base.yml
 
-Layout/LineLength:
-  Max: 120
-
-Naming/FileName:
-  Exclude:
-  - 'Gemfile'
-  - 'Rakefile'
-
-Metrics/BlockLength:
-  Exclude:
-  - 'Rakefile'
-  - '**/*.rake'
-  - 'spec/**/*.rb'
-
-Metrics/ClassLength:
-  Max: 160
-
-Style/Documentation:
-  Enabled: false
-
-Style/NonNilCheck:
-  IncludeSemanticChanges: true
-
-Style/FormatStringToken:
+RSpec/MessageSpies:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
+Rails/Output:
   Enabled: false
 
 Style/GlobalVars:

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+3.3.0

data/.semaphore/main-deploy.yml

@@ -3,7 +3,7 @@ name: main-deploy
 agent:
   machine:
     type: e1-standard-2
-    os_image: ubuntu1804
+    os_image: ubuntu2004
 
 blocks:
   - name: main-deploy

data/.semaphore/semaphore.yml

@@ -3,7 +3,7 @@ name: renuo-cli
 agent:
   machine:
     type: e1-standard-2
-    os_image: ubuntu1804
+    os_image: ubuntu2004
 auto_cancel:
   running:
     when: "true"
@@ -28,7 +28,7 @@ blocks:
       jobs:
         - name: tests
           commands:
-            - bin/check
+            - ENV=CI bin/check
 promotions:
   - name: main
     pipeline_file: main-deploy.yml

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.3

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # Renuo CLI
 
-The [Renuo](http://renuo.ch) command line. Used for various Renuo tasks
+The [Renuo](https://www.renuo.ch) command line. Used for various Renuo tasks
 
 ## Installation
 
@@ -49,8 +49,8 @@ gem push renuo-cli-*.gem
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/renuo/renuo-cli>. This project is intended to
 be a safe, welcoming space for collaboration, and contributors are expected to adhere to
-the [Contributor Covenant](contributor-covenant.org) code of conduct.
+the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/license/MIT).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'cucumber/rake/task'

data/lib/renuo/cli/app/command_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CommandHelper
   def run_command(command)
     say "\n#{command.yellow}"

data/lib/renuo/cli/app/commit_leaderboard.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+class CommitLeaderboard
+  attr_accessor :queue_file_path, :author_username, :auhor_avatar_url
+
+  def run(args)
+    abort 'No author username given.' if args[0].nil?
+    abort 'No author avatar url given.' if args[1].nil?
+
+    @author_username = args[0]
+    @author_avatar_url = args[1]
+
+    @queue_file_path = args[2] || '~/.renuo-commit-leaderboard.json'
+    @queue_file_path = File.expand_path(@queue_file_path)
+
+    check_required_tools
+    check_if_repository_is_present
+    check_if_commit_is_present
+
+    append_to_queue(build_commit_payload)
+  end
+
+  private
+
+  def check_required_tools
+    return if system('git --version', out: File::NULL)
+
+    abort('>> Git is not installed. Please install it first.')
+  end
+
+  def check_if_repository_is_present
+    return if system('git rev-parse --is-inside-work-tree', out: File::NULL)
+
+    abort('>> Not a git repository. Please run this command in a git repository.')
+  end
+
+  def check_if_commit_is_present
+    return if system('git rev-parse --verify HEAD', out: File::NULL)
+
+    abort('>> No commits found. Please commit your changes first.')
+  end
+
+  def build_commit_payload
+    {
+      sha: `git rev-parse HEAD`.strip,
+      message: `git log -1 --pretty=%B`.strip,
+      repository: `basename $(git rev-parse --show-toplevel)`.strip,
+      branch: `git rev-parse --abbrev-ref HEAD`.strip,
+      author: {
+        username: @author_username,
+        avatar_url: @author_avatar_url
+      }
+    }
+  end
+
+  def append_to_queue(payload)
+    `echo [] > #{@queue_file_path}` unless File.exist?(@queue_file_path)
+
+    commits = read_commits_from_queue(payload)
+
+    puts '>> Adding commit to the queue:'
+
+    print_queue_item(payload)
+    File.open(@queue_file_path, 'w') do |file|
+      commits << payload
+      file.write(JSON.generate(commits))
+    end
+  end
+
+  def read_commits_from_queue(payload)
+    commits = nil
+
+    File.open(@queue_file_path, 'r') do |file|
+      commits = JSON.parse(file.read)
+
+      if commits.any? { |commit| commit['sha'] == payload[:sha] }
+        abort('>> Commit has already been added to the queue')
+      end
+    rescue JSON::ParserError
+      abort('>> Invalid JSON format in the queue file.')
+    end
+
+    commits
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  def print_queue_item(payload)
+    sha        = format_text_truncate(payload[:sha], COLOR_CODES[:green], 6)
+    repository = format_text("#{payload[:repository]}##{payload[:branch]}", COLOR_CODES[:blue])
+    message    = format_text_elipsis(payload[:message], COLOR_CODES[:yellow], 50)
+    username   = format_text(payload[:author][:username], COLOR_CODES[:magenta])
+    avatar_url = format_text(payload[:author][:avatar_url], COLOR_CODES[:cyan])
+
+    puts "#{sha} #{repository} - #{username} (#{avatar_url}) - #{message}"
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  def format_text(text, color)
+    "\e[#{color}m#{text}\e[0m"
+  end
+
+  def wrap_in_color(text, color)
+    "\e[#{color}m#{text}\e[0m"
+  end
+
+  def format_text_truncate(text, color, truncate_length)
+    format_text(text[0..truncate_length], color)
+  end
+
+  def format_text_elipsis(text, color, truncate_length)
+    if text.length > truncate_length
+      format_text("#{truncate_text(text, truncate_length)}...", color)
+    else
+      format_text(text, color)
+    end
+  end
+
+  def truncate_text(text, truncate_length)
+    text[0..truncate_length]
+  end
+end
+
+COLOR_CODES = {
+  red: 31,
+  green: 32,
+  yellow: 33,
+  blue: 34,
+  magenta: 35,
+  cyan: 36
+}.freeze

data/lib/renuo/cli/app/commit_leaderboard_sync.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+class SyncError < StandardError; end
+
+class CommitLeaderboardSync
+  attr_accessor :queue_file_path, :leaderboard_api_url, :api_secret
+
+  def run(args)
+    process_args(args)
+
+    unless File.exist?(@queue_file_path)
+      abort('>> Commit queue file does not exist.')
+    end
+
+    unless @leaderboard_api_url.match?(URI::DEFAULT_PARSER.make_regexp)
+      abort('>> Invalid API URL.')
+    end
+
+    commits = JSON.parse(File.read(@queue_file_path))
+    send_commits(commits)
+  end
+
+  private
+
+  def process_args(args)
+    if args[0].blank?
+      abort('>> No API secret given.')
+    end
+
+    @api_secret = args[0]
+    @queue_file_path = File.expand_path(args[1] || '~/.renuo_commit_leaderboard.json')
+    @leaderboard_api_url = args[2] || 'https://dashboard.renuo.ch/api/v1/add_commits'
+  end
+
+  def print_configuration
+    puts 'Running commit leaderboard sync with:'
+    puts '-----------------------------'
+    puts "API secret: #{@api_secret}"
+    puts "Queue file path: #{@queue_file_path}"
+    puts "Leaderboard API URL: #{@leaderboard_api_url}"
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def send_commits(commits)
+    next_queue = []
+
+    until commits.empty?
+      commit = commits.shift
+      payload = { commit: commit }.to_json
+
+      puts 'Sending commit to leaderboard...'
+      print_payload(payload)
+
+      begin
+        handle_response(send_commit(payload))
+      rescue SyncError => e
+        puts e.message
+        next_queue << commit
+      end
+    end
+
+    File.write(@queue_file_path, JSON.generate(next_queue))
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def send_commit(payload)
+    uri = URI(@leaderboard_api_url)
+    http = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Post.new(uri.path, { 'Content-Type' => 'application/json', 'Accept' => 'application/json' })
+    request['LEADERBOARD_SIGNATURE'] = generate_signature_for_payload(@api_secret, payload)
+    request.body = payload
+
+    http.request(request)
+  end
+
+  def print_payload(payload)
+    puts JSON.pretty_generate(payload)
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def handle_response(response)
+    case response.code.to_i
+    when 200
+      puts '>> Successfully sent commits to the leaderboard.'
+    when 401
+      abort('>> Unauthorized. Please check your secret.')
+    when 403
+      abort('>> Forbidden. Please check your secret.')
+    when 404
+      abort('>> Not found. Please check the URL.')
+    else
+      raise SyncError, "Failed to send commits to the leaderboard:\n#{response.code} - #{response.body}"
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def clear_queue
+    File.write(@queue_file_path, '[]')
+  end
+
+  def generate_signature_for_payload(secret_key, payload)
+    signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), secret_key, payload)
+    "sig=#{signature}"
+  end
+end

data/lib/renuo/cli/app/configure_semaphore.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'commander'
-require_relative './environments'
+require_relative 'environments'
 
 class ConfigureSemaphore
   attr_accessor :project_name, :environment
@@ -24,6 +26,7 @@ class ConfigureSemaphore
 
     create_semaphore_notification
     create_semaphore_secrets
+    create_semaphore_deployment_targets
   end
   # rubocop:enable Metrics/MethodLength
 
@@ -36,15 +39,20 @@ class ConfigureSemaphore
   end
 
   def create_semaphore_notification
-    system("sem create notifications #{project_name} "\
-           "--projects #{project_name} "\
-           '--branches "main,develop" '\
-           "--slack-channels \"#project-#{project_name}\" "\
+    system("sem create notifications #{project_name} " \
+           "--projects #{project_name} " \
+           '--branches "main,develop" ' \
+           "--slack-channels \"#project-#{project_name}\" " \
            '--slack-endpoint "https://hooks.slack.com/services/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"')
   end
 
   def create_semaphore_secrets
-    system("sem create secret #{project_name}")
+    system("sem create secret -p #{project_name} #{project_name}")
+  end
+
+  def create_semaphore_deployment_targets
+    system("sem create dt main -p #{project_name}")
+    system("sem create dt develop -p #{project_name}")
   end
 
   def render(template_file)

data/lib/renuo/cli/app/configure_sentry.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 require 'commander'
-require_relative './environments'
+require_relative 'environments'
 
 class ConfigureSentry
-  ADMIN_EMAIL = 'admin@renuo.ch'.freeze
-
-  def initialize; end
+  ADMIN_EMAIL = 'admin@renuo.ch'
 
   def run(args)
     project_name = args[0]

data/lib/renuo/cli/app/create_aws_project.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'renuo/cli/app/services/cloudfront_config_service'
 
 class CreateAwsProject
@@ -39,7 +41,7 @@ class CreateAwsProject
   end
 
   def collect_cloudfront_information
-    @setup_cloudfront = agree('Would you like to setup also AWS CloudFront? '\
+    @setup_cloudfront = agree('Would you like to setup also AWS CloudFront? ' \
                               '(Default: yes, if you want to deliver assets/images from S3)')
   end
 
@@ -52,7 +54,7 @@ class CreateAwsProject
   def ensure_aws_profile_existing?
     ensure_is_setup?('aws configure --profile renuo-app-setup list > /dev/null',
                      'aws configure --profile renuo-app-setup',
-                     'Would you like set up a profile for AWS '\
+                     'Would you like set up a profile for AWS ' \
                      '`aws configure --profile renuo-app-setup`? (User/Password in keystore)')
   end
 
@@ -105,7 +107,7 @@ class CreateAwsProject
   end
 
   def aws_cloudfront_setup(profile, bucket, redmine_project)
-    tags = [{ "Key": 'redmine_project', "Value": redmine_project }]
+    tags = [{ Key: 'redmine_project', Value: redmine_project }]
     cloudfront_config_string = CloudfrontConfigService.new(bucket, tags).to_s
 
     <<~CLOUDFRONT_COMMANDS

data/lib/renuo/cli/app/create_heroku_app.rb

@@ -1,7 +1,7 @@
-class CreateHerokuApp
-  ADMIN_EMAIL = 'operations@renuo.ch'.freeze
+# frozen_string_literal: true
 
-  def initialize; end
+class CreateHerokuApp
+  ADMIN_EMAIL = 'operations@renuo.ch'
 
   def run(args)
     project_name = args[0]

data/lib/renuo/cli/app/create_new_logins.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateNewLogins
   include CommandHelper
 

data/lib/renuo/cli/app/create_slidev_presentation.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'commander'
+
+class CreateSlidevPresentation
+  EXAMPLE_SLIDES_URL = 'https://raw.githubusercontent.com/renuo/slidev-theme-renuo/main/example.md'
+  SLIDEV_THEME_NAME = 'renuo'
+  TEMPLATE_DIRECTORY = 'templates/slidev'
+
+  attr_accessor :presentation_name, :presentation_author
+
+  def initialize
+    @presentation_name = nil
+    @presentation_author = nil
+  end
+
+  def run(args)
+    presentation_name = args[0]
+    abort('>> No presentation name given.') unless presentation_name
+
+    say '# Commands to setup Slidev project with the Renuo theme:'.colorize :green
+    @presentation_name = presentation_name
+    @presentation_author = args[1] || 'Renuo AG'
+    print_slidev_project_commands
+  end
+
+  private
+
+  def print_slidev_project_commands
+    say "mkdir #{@presentation_name}"
+    say "cd #{@presentation_name}"
+    say "curl -o slides.md #{EXAMPLE_SLIDES_URL}"
+    say "echo '#{render('README.md.erb')}' > README.md"
+    say "sed -ig 's/theme: .\\//theme: renuo/' slides.md"
+    say "echo '#{render('package.json.erb')}' > package.json"
+    say 'npm install'
+    say 'npm run dev'
+  end
+
+  def render(filename)
+    file_path = File.join(File.dirname(__FILE__), TEMPLATE_DIRECTORY, filename)
+    template = File.read(file_path)
+    renderer = ERB.new(template)
+    renderer.result(binding)
+  end
+end

data/lib/renuo/cli/app/environments.rb

@@ -1,4 +1,6 @@
-MAIN = 'main'.freeze
-MASTER = 'master'.freeze
-DEVELOP = 'develop'.freeze
+# frozen_string_literal: true
+
+MAIN = 'main'
+MASTER = 'master'
+DEVELOP = 'develop'
 ENVIRONMENTS = [MAIN, DEVELOP].freeze

data/lib/renuo/cli/app/fetch_emails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'uri'
 
@@ -30,6 +32,6 @@ class FetchEmails
   end
 
   def format_response(response)
-    response.body.gsub(/\r\n/, "\n").split("\n").reject { |add| add == 'n/a' }
+    response.body.gsub("\r\n", "\n").split("\n").reject { |add| add == 'n/a' }
   end
 end

data/lib/renuo/cli/app/generate_password.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 class GeneratePassword

data/lib/renuo/cli/app/heroku_apps.rb

@@ -1,8 +1,8 @@
-class HerokuApps
-  def initialize; end
+# frozen_string_literal: true
 
+class HerokuApps
   def run
-    JSON.parse(run_command).map { |app| app['name'] }
+    JSON.parse(run_command).pluck('name')
   end
 
   private

data/lib/renuo/cli/app/heroku_users.rb

@@ -1,8 +1,8 @@
-require_relative './heroku_apps'
+# frozen_string_literal: true
 
-class HerokuUsers
-  def initialize; end
+require_relative 'heroku_apps'
 
+class HerokuUsers
   def run(args)
     action, email_address = args
     abort('>> action is either add or remove') unless %w[add remove].include? action

data/lib/renuo/cli/app/list_large_git_files.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class ListLargeGitFiles
   def run
-    cmd = 'bash -c "join -o \'1.1 1.2 2.3\' <(git rev-list --objects --all | sort) '\
-    '<(git verify-pack -v objects/pack/*.idx | sort -k3 -n | tail -5 | sort) | sort -k3 -n"'
+    cmd = 'bash -c "join -o \'1.1 1.2 2.3\' <(git rev-list --objects --all | sort) ' \
+          '<(git verify-pack -v objects/pack/*.idx | sort -k3 -n | tail -5 | sort) | sort -k3 -n"'
     puts `#{cmd}`
   end
 end

data/lib/renuo/cli/app/local_storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 class LocalStorage

data/lib/renuo/cli/app/name_display.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'command_helper'
 
 class NameDisplay
@@ -15,11 +17,11 @@ class NameDisplay
 
   private
 
-  HEROKU_APP_NAME = '-a renuo-dashboard-main'.freeze
-  HEROKU_CLI = 'heroku run'.freeze
-  RENUO_CLI = 'rails renuo:welcome'.freeze
-  SLIDES = 'https://docs.google.com/presentation/d/1mPhQjArZnlUWUa2ik5R9IlGmdCKCwc2_H8Qq-AWgV-A/edit'.freeze
-  WELCOME_MESSAGE = 'Welcome to Renuo'.freeze
+  HEROKU_APP_NAME = '-a renuo-dashboard-main'
+  HEROKU_CLI = 'heroku run'
+  RENUO_CLI = 'rails renuo:welcome'
+  SLIDES = 'https://docs.google.com/presentation/d/1mPhQjArZnlUWUa2ik5R9IlGmdCKCwc2_H8Qq-AWgV-A/edit'
+  WELCOME_MESSAGE = 'Welcome to Renuo'
 
   def display_name(name)
     text_message = [WELCOME_MESSAGE, name, '🥳🔥'].compact.join(' ')

data/lib/renuo/cli/app/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "app",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/renuo/renuo-cli.git"
+  },
+  "private": true
+}

data/lib/renuo/cli/app/redmine/csv_base_service.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'csv'
 
 module Redmine
   class CsvBaseService
-    API_LOCATION = 'https://redmine.renuo.ch'.freeze
+    API_LOCATION = 'https://redmine.renuo.ch'
 
     def initialize(token)
       @token = token
@@ -40,7 +42,7 @@ module Redmine
       separated_csv_entries = CSV.parse(body, col_sep: ',')
       keys = separated_csv_entries.shift[1..-2]
       entries = separated_csv_entries.shift[1..-2]
-      Hash[keys.zip(entries)]
+      keys.zip(entries).to_h
     rescue CSV::MalformedCSVError
       raise_bad_data_error
     end