uffizzi-cli 0.14.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7a27f279e964f07491f920557722194d65c8a9259487a5a717707f6075d164b
-  data.tar.gz: d9825fe3425b0dde3dbe1e4528686100c6ca22f30aed4aa7a332cf991bbb6480
+  metadata.gz: ac2d58dae4db13ed788532732a92f9d4a317780cb4b80ef07d185f899d10749d
+  data.tar.gz: a1b4b37db41936eabb930febe701186027a80d0684ca371ed442168caecea779
 SHA512:
-  metadata.gz: 179a75d66bd89efc1ad9b3decf5ebc6c5526b2fe0fdd02e616940b4f12544505c956874a0649a99a2c5d1e14fce6e1dcda305a9028e08d8e9c2b8b5f63955fb5
-  data.tar.gz: a8d2637bef4250c33bb1cc8725556a2758384c9115938865e8acd70b92fce515ccd94b691913341c6b6f64a29f6d9ff34e99148fd62cacf8d6551d72a1222508
+  metadata.gz: c2420a93b4b17a5efb2de11ed5a998070da7eb2f8f22a2d09bf2598b4eb88841f428f0a87cf7de7c5b49e289f12f2d85413aa96600ca3726b71b5ec962e6b68c
+  data.tar.gz: 2dff8bd8e614d8ffaad6a2b42f528844c5a6d1232c2327bcb756c8ae6d4b014e3b310965f01fd86dc2d6eb40cb9aaab10755ef707a0dc808538620581b1f09cb

data/lib/uffizzi/cli/connect.rb

@@ -10,7 +10,8 @@ module Uffizzi
     desc 'list-credentials', 'List existing credentials for an account'
     def list_credentials
       server = ConfigFile.read_option(:server)
-      response = fetch_credentials(server)
+      account_id = ConfigFile.read_option(:account_id)
+      response = fetch_credentials(server, account_id)
       if ResponseHelper.ok?(response)
         handle_list_credentials_success(response)
       else
@@ -37,11 +38,12 @@ module Uffizzi
         type: type,
       }
       server = ConfigFile.read_option(:server)
+      account_id = ConfigFile.read_option(:account_id)
 
       response = if credential_exists
-        update_credential(server, params, type)
+        update_credential(server, account_id, params, type)
       else
-        create_credential(server, params)
+        create_credential(server, account_id, params)
       end
 
       handle_result_for('Docker Hub', response)
@@ -68,11 +70,12 @@ module Uffizzi
         type: type,
       }
       server = ConfigFile.read_option(:server)
+      account_id = ConfigFile.read_option(:account_id)
 
       response = if credential_exists
-        update_credential(server, params, type)
+        update_credential(server, account_id, params, type)
       else
-        create_credential(server, params)
+        create_credential(server, account_id, params)
       end
 
       handle_result_for('Docker Registry', response)
@@ -99,11 +102,12 @@ module Uffizzi
         type: type,
       }
       server = ConfigFile.read_option(:server)
+      account_id = ConfigFile.read_option(:account_id)
 
       response = if credential_exists
-        update_credential(server, params, type)
+        update_credential(server, account_id, params, type)
       else
-        create_credential(server, params)
+        create_credential(server, account_id, params)
       end
 
       handle_result_for('ACR', response)
@@ -130,11 +134,12 @@ module Uffizzi
         type: type,
       }
       server = ConfigFile.read_option(:server)
+      account_id = ConfigFile.read_option(:account_id)
 
       response = if credential_exists
-        update_credential(server, params, type)
+        update_credential(server, account_id, params, type)
       else
-        create_credential(server, params)
+        create_credential(server, account_id, params)
       end
 
       handle_result_for('ECR', response)
@@ -156,11 +161,12 @@ module Uffizzi
         type: type,
       }
       server = ConfigFile.read_option(:server)
+      account_id = ConfigFile.read_option(:account_id)
 
       response = if credential_exists
-        update_credential(server, params, type)
+        update_credential(server, account_id, params, type)
       else
-        create_credential(server, params)
+        create_credential(server, account_id, params)
       end
 
       handle_result_for('GCR', response)
@@ -185,11 +191,12 @@ module Uffizzi
         type: type,
       }
       server = ConfigFile.read_option(:server)
+      account_id = ConfigFile.read_option(:account_id)
 
       response = if credential_exists
-        update_credential(server, params, type)
+        update_credential(server, account_id, params, type)
       else
-        create_credential(server, params)
+        create_credential(server, account_id, params)
       end
 
       handle_result_for('GHCR', response)
@@ -221,8 +228,15 @@ module Uffizzi
 
     def credential_exists?(type)
       server = ConfigFile.read_option(:server)
-      response = check_credential(server, type)
-      !ResponseHelper.ok?(response)
+      account_id = ConfigFile.read_option(:account_id)
+      response = check_credential(server, account_id, type)
+      return false if ResponseHelper.ok?(response)
+      return true if ResponseHelper.unprocessable_entity?(response)
+
+      if ResponseHelper.forbidden?(response)
+        Uffizzi.ui.say('Unauthorized. Skipping credentials action.')
+        exit(true)
+      end
     end
 
     def handle_existing_credential_options(credential_type_slug)

data/lib/uffizzi/cli/disconnect.rb

@@ -24,7 +24,7 @@ module Uffizzi
                           raise Uffizzi::Error.new('Unsupported credential type.')
       end
 
-      response = delete_credential(ConfigFile.read_option(:server), connection_type)
+      response = delete_credential(ConfigFile.read_option(:server), ConfigFile.read_option(:account_id), connection_type)
 
       if ResponseHelper.no_content?(response)
         Uffizzi.ui.say("Successfully disconnected from #{connection_name(credential_type)}.")

data/lib/uffizzi/cli/login.rb

@@ -61,6 +61,7 @@ module Uffizzi
     end
 
     def handle_succeed_response(response, server, username)
+      # TODO Choose a personal account
       account = response[:body][:user][:accounts].first
       return Uffizzi.ui.say('No account related to this email') unless account_valid?(account)
 
@@ -95,9 +96,11 @@ module Uffizzi
       end
       all_choices = choices + [{ name: 'Create a new project', value: nil }]
       answer = Uffizzi.prompt.select(question, all_choices)
-      return ConfigFile.write_option(:project, answer) if answer
+      return create_new_project(server) unless answer
 
-      create_new_project(server)
+      account_id = projects.detect { |project| project[:slug] == answer }[:account_id]
+      ConfigFile.write_option(:project, answer)
+      ConfigFile.write_option(:account_id, account_id)
     end
 
     def create_new_project(server)
@@ -116,7 +119,8 @@ module Uffizzi
         },
       }
 
-      response = create_project(server, params)
+      account_id = ConfigFile.read_option(:account_id)
+      response = create_project(server, account_id, params)
 
       if ResponseHelper.created?(response)
         handle_create_project_succeess(response)
@@ -139,6 +143,7 @@ module Uffizzi
       project = response[:body][:project]
 
       ConfigFile.write_option(:project, project[:slug])
+      ConfigFile.write_option(:account_id, project[:account_id])
 
       Uffizzi.ui.say("Project #{project[:name]} was successfully created")
     end

data/lib/uffizzi/cli/login_by_identity_token.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'uffizzi'
+require 'uffizzi/response_helper'
+require 'uffizzi/clients/api/api_client'
+
+module Uffizzi
+  class Cli::LoginByIdentityToken
+    include ApiClient
+
+    def initialize(options)
+      @options = options
+    end
+
+    def run
+      token = @options[:token]
+      server = @options[:server]
+      params = prepare_request_params(token)
+      response = create_ci_session(server, params)
+
+      if ResponseHelper.created?(response)
+        handle_succeed_response(response, server)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    private
+
+    def prepare_request_params(token)
+      {
+        user: {
+          token: token,
+        },
+      }
+    end
+
+    def handle_succeed_response(response, server)
+      ConfigFile.write_option(:server, server)
+      ConfigFile.write_option(:cookie, response[:headers])
+      ConfigFile.write_option(:account_id, response[:body][:account_id])
+      ConfigFile.write_option(:project, response[:body][:project_slug])
+
+      Uffizzi.ui.say('Successful Login by Identity Token')
+    end
+  end
+end

data/lib/uffizzi/cli/project.rb

@@ -102,12 +102,13 @@ module Uffizzi
       raise Uffizzi::Error.new('Slug must not content spaces or special characters') unless slug.match?(/^[a-zA-Z0-9\-_]+\Z/i)
 
       server = ConfigFile.read_option(:server)
+      account_id = ConfigFile.read_option(:account_id)
       params = {
         name: name,
         description: options[:description],
         slug: slug,
       }
-      response = create_project(server, params)
+      response = create_project(server, account_id, params)
 
       if ResponseHelper.created?(response)
         handle_create_success_response(response)
@@ -165,6 +166,7 @@ module Uffizzi
 
     def set_default_project(project)
       ConfigFile.write_option(:project, project[:slug])
+      ConfigFile.write_option(:account_id, project[:account_id])
     end
   end
 end

data/lib/uffizzi/cli.rb

@@ -24,6 +24,14 @@ module Uffizzi
       Login.new(options).run
     end
 
+    desc 'login_by_identity_token [OPTIONS]', 'Login or register to Uffizzi to view and manage your previews'
+    method_option :server, required: true, aliases: '-s'
+    method_option :token, required: true, aliases: '-t'
+    def login_by_identity_token
+      require_relative 'cli/login_by_identity_token'
+      LoginByIdentityToken.new(options).run
+    end
+
     desc 'logout', 'Log out of a Uffizzi user account'
     def logout
       require_relative 'cli/logout'

data/lib/uffizzi/clients/api/api_client.rb

@@ -13,6 +13,13 @@ module ApiClient
     build_response(response)
   end
 
+  def create_ci_session(server, params = {})
+    uri = ci_session_uri(server)
+    response = http_client.make_post_request(uri, params)
+
+    build_response(response)
+  end
+
   def destroy_session(server)
     uri = session_uri(server)
     response = http_client.make_delete_request(uri)
@@ -27,16 +34,16 @@ module ApiClient
     build_response(response)
   end
 
-  def fetch_credentials(server)
-    uri = credentials_uri(server)
+  def fetch_credentials(server, account_id)
+    uri = credentials_uri(server, account_id)
 
     response = http_client.make_get_request(uri)
 
     build_response(response)
   end
 
-  def check_credential(server, type)
-    uri = check_credential_uri(server, type)
+  def check_credential(server, account_id, type)
+    uri = check_credential_uri(server, account_id, type)
     response = http_client.make_get_request(uri)
 
     build_response(response)
@@ -49,8 +56,8 @@ module ApiClient
     build_response(response)
   end
 
-  def create_project(server, params)
-    uri = projects_uri(server)
+  def create_project(server, account_id, params)
+    uri = create_projects_uri(server, account_id)
     response = http_client.make_post_request(uri, params)
 
     build_response(response)
@@ -63,15 +70,15 @@ module ApiClient
     build_response(response)
   end
 
-  def create_credential(server, params)
-    uri = credentials_uri(server)
+  def create_credential(server, account_id, params)
+    uri = credentials_uri(server, account_id)
     response = http_client.make_post_request(uri, params)
 
     build_response(response)
   end
 
-  def update_credential(server, params, type)
-    uri = credential_uri(server, type)
+  def update_credential(server, account_id, params, type)
+    uri = credential_uri(server, account_id, type)
     response = http_client.make_put_request(uri, params)
 
     build_response(response)
@@ -84,8 +91,8 @@ module ApiClient
     build_response(response)
   end
 
-  def delete_credential(server, credential_type)
-    uri = credential_uri(server, credential_type)
+  def delete_credential(server, account_id, credential_type)
+    uri = credential_uri(server, account_id, credential_type)
     response = http_client.make_delete_request(uri)
 
     build_response(response)

data/lib/uffizzi/clients/api/api_routes.rb

@@ -15,6 +15,10 @@ module ApiRoutes
     "#{server}/api/cli/v1/projects"
   end
 
+  def create_projects_uri(server, account_id)
+    "#{server}/api/cli/v1/accounts/#{account_id}/projects"
+  end
+
   def secret_uri(server, project_slug, id)
     path_id = CGI.escape(id)
     "#{server}/api/cli/v1/projects/#{project_slug}/secrets/#{path_id}"
@@ -28,6 +32,10 @@ module ApiRoutes
     "#{server}/api/cli/v1/session"
   end
 
+  def ci_session_uri(server)
+    "#{server}/api/cli/v1/ci/session"
+  end
+
   def validate_compose_file_uri(server, project_slug)
     "#{compose_files_uri(server, project_slug)}/validate"
   end
@@ -54,20 +62,20 @@ module ApiRoutes
     "#{server}/api/cli/v1/projects/#{project_slug}/deployments/#{deployment_id}/events"
   end
 
-  def check_credential_uri(server, type)
-    "#{server}/api/cli/v1/account/credentials/#{type}/check_credential"
+  def check_credential_uri(server, account_id, type)
+    "#{server}/api/cli/v1/accounts/#{account_id}/credentials/#{type}/check_credential"
   end
 
-  def credentials_uri(server)
-    "#{server}/api/cli/v1/account/credentials"
+  def credentials_uri(server, account_id)
+    "#{server}/api/cli/v1/accounts/#{account_id}/credentials"
   end
 
   def preview_services_uri(server, project_slug, deployment_id)
     "#{server}/api/cli/v1/projects/#{project_slug}/deployments/#{deployment_id}/containers"
   end
 
-  def credential_uri(server, credential_type)
-    "#{server}/api/cli/v1/account/credentials/#{credential_type}"
+  def credential_uri(server, account_id, credential_type)
+    "#{server}/api/cli/v1/accounts/#{account_id}/credentials/#{credential_type}"
   end
 
   def preview_service_logs_uri(server, project_slug, deployment_id, container_name)

data/lib/uffizzi/services/project_service.rb

@@ -24,6 +24,7 @@ class ProjectService
       Uffizzi.ui.say("Project name: #{project[:name]}")
       Uffizzi.ui.say("Project slug: #{project[:slug]}")
       Uffizzi.ui.say("Description: #{project[:description]}".strip)
+      Uffizzi.ui.say("Account name: #{project[:account][:name]}".strip)
       Uffizzi.ui.say("Created: #{project[:created_at]}")
       default_compose = project[:default_compose].nil? ? nil : project[:default_compose][:source]
       Uffizzi.ui.say("Default compose: #{default_compose}".strip)

data/lib/uffizzi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uffizzi
-  VERSION = '0.14.0'
+  VERSION = '1.0.0'
 end

data/man/uffizzi-login-by-identity-token

@@ -0,0 +1,29 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-LOGIN\-BY\-IDENTITY\-TOKEN" "" "August 2022" ""
+.SH "NAME"
+\fBuffizzi\-login\-by\-identity\-token\fR \- login to Uffizzi using a OIDC token provided by a CI/CD pipeline
+.SH "SYNOPSIS"
+.nf
+uffizzi uffizzi\-login\-by\-identity\-token [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline\.
+If a user/account do not exist, Uffizzi will create them based on token payload\.
+
+For more information on authentication and credential types, see:
+https://github\.com/UffizziCloud/uffizzi_cli
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+To login from the CI/CD pipeline, run:
+
+    $ uffizzi uffizzi\-login\-by\-identity\-token \-\-server=uffizzi\.example\.com \-\-token=[$CI_JOB_TOKEN]
+.fi
+

data/man/uffizzi-login-by-identity-token.html

@@ -0,0 +1,106 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' content='text/html;charset=utf8'>
+  <meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
+  <title>login to Uffizzi using a OIDC token provided by a CI/CD pipeline</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>uffizzi-login-by-identity-token</li>
+    <li class='tc'></li>
+    <li class='tr'>uffizzi-login-by-identity-token</li>
+  </ol>
+
+  
+
+<h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>uffizzi-login-by-identity-token</code> - <span class="man-whatis">login to Uffizzi using a OIDC token provided by a CI/CD pipeline</span>
+</p>
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+<pre><code>uffizzi uffizzi-login-by-identity-token [UFFIZZI_WIDE_FLAG ...]
+</code></pre>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<pre><code>The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline.
+If a user/account do not exist, Uffizzi will create them based on token payload.
+
+For more information on authentication and credential types, see:
+https://github.com/UffizziCloud/uffizzi_cli
+</code></pre>
+
+<h2 id="UFFIZZI-WIDE-FLAGS">UFFIZZI WIDE FLAGS</h2>
+<pre><code>These flags are available to all commands: --project. Run $ uffizzi 
+help for details.
+</code></pre>
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+<pre><code>To login from the CI/CD pipeline, run:
+
+    $ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --token=[$CI_JOB_TOKEN]
+</code></pre>
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>August 2022</li>
+    <li class='tr'>uffizzi-login-by-identity-token</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/uffizzi-login-by-identity-token.ronn

@@ -0,0 +1,21 @@
+  uffizzi-login-by-identity-token - login to Uffizzi using a OIDC token provided by a CI/CD pipeline
+================================================================
+
+## SYNOPSIS
+    uffizzi uffizzi-login-by-identity-token [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    The uffizzi login command lets you authenticate with Uffizzi from a CI/CD pipeline.
+    If a user/account do not exist, Uffizzi will create them based on token payload.
+
+    For more information on authentication and credential types, see:
+    https://github.com/UffizziCloud/uffizzi_cli
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    To login from the CI/CD pipeline, run:
+
+        $ uffizzi uffizzi-login-by-identity-token --server=uffizzi.example.com --token=[$CI_JOB_TOKEN]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-22 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -325,6 +325,7 @@ files:
 - lib/uffizzi/cli/connect.rb
 - lib/uffizzi/cli/disconnect.rb
 - lib/uffizzi/cli/login.rb
+- lib/uffizzi/cli/login_by_identity_token.rb
 - lib/uffizzi/cli/logout.rb
 - lib/uffizzi/cli/preview.rb
 - lib/uffizzi/cli/preview/service.rb
@@ -368,6 +369,9 @@ files:
 - man/uffizzi-disconnect
 - man/uffizzi-disconnect.ronn
 - man/uffizzi-login
+- man/uffizzi-login-by-identity-token
+- man/uffizzi-login-by-identity-token.html
+- man/uffizzi-login-by-identity-token.ronn
 - man/uffizzi-login.ronn
 - man/uffizzi-logout
 - man/uffizzi-logout.ronn