uffizzi-cli 0.7.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9ab52c8638dc3d5a8f6245ba337da95fcf986e39040458add0c1128857014f8
-  data.tar.gz: b897ce235bc887bd161a7262fecddc28228b523b167338b599051ba370b704d3
+  metadata.gz: 135c59012b429afe86c2ba348e8d2e5e73562b7a10531d8e2ed329c7eac09929
+  data.tar.gz: 8865727d98b597fc622324e7b9d3afdf410bedb00e0b2203448e4023e8896da3
 SHA512:
-  metadata.gz: a2976d6389a9a1d5c9d53ab66e34de98c391b250e2b4e5ebf636189b12f7e7a366e5140ef1c8583ce952d68fd8734600945402b6e38b10dea28700b71eb2bcf6
-  data.tar.gz: 78aa15c2dd0f21febc64c73c2a77e86de98ccda9a90278069ced243f3264f74240d5530aa67828515a4e03f858fb3e2d1d5d1713eca63127d027cbd4b3ea89ac
+  metadata.gz: 6cd3dd4875c77bf331f4ab5934f5f6f347288b2c9d0a144e79a943bfca8b54bee4a7ccfb1ddab2e782e83555e085f685547cffedeb03df7221bfc9505cbbe01d
+  data.tar.gz: e48f80757a18e246145b4d08dd4d33b8736db90228d9206026f61dc00a46bdf0c0899fb35d7301f0fff09ec391f7f6611f5a6cf7feae42e28a1baafff81c7b85

data/README.md

@@ -177,3 +177,9 @@ Supported credential types - `docker-hub`, `acr`, `ecr`, `gcr`
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/UffizziCloud/uffizzi_cli. See `CONTRIBUTING.md` in this repository.
+
+## License
+
+This project is licensed under the terms of the Apache-2.0 license.
+
+See this license at [`LICENSE`](LICENSE).

data/config/uffizzi.rb

@@ -18,7 +18,7 @@ module Uffizzi
       azure: 'UffizziCore::Credential::Azure',
       google: 'UffizziCore::Credential::Google',
       amazon: 'UffizziCore::Credential::Amazon',
-      github_container_registry: 'UffizziCore::Credential::GithubContainerRegistry',
+      github_registry: 'UffizziCore::Credential::GithubContainerRegistry',
     }
     config.default_server = 'app.uffizzi.com'
   end

data/lib/uffizzi/cli/connect.rb

@@ -18,12 +18,14 @@ module Uffizzi
     end
 
     desc 'docker-hub', 'Connect to Docker Hub (hub.docker.com)'
+    method_option :skip_raise_existence_error, type: :boolean, default: false,
+                                               desc: 'Skip raising an error within check the credential'
     def docker_hub
       type = Uffizzi.configuration.credential_types[:dockerhub]
-      check_credential_existance(type, 'docker-hub')
+      check_credential_existence(type, 'docker-hub')
 
-      username = Uffizzi.ui.ask('Username: ')
-      password = Uffizzi.ui.ask('Password: ', echo: false)
+      username = ENV['DOCKERHUB_USERNAME'] || Uffizzi.ui.ask('Username: ')
+      password = ENV['DOCKERHUB_PASSWORD'] || Uffizzi.ui.ask('Password: ', echo: false)
 
       params = {
         username: username,
@@ -42,18 +44,20 @@ module Uffizzi
     end
 
     desc 'acr', 'Connect to Azure Container Registry (azurecr.io)'
+    method_option :skip_raise_existence_error, type: :boolean, default: false,
+                                               desc: 'Skip raising an error within check the credential'
     def acr
       type = Uffizzi.configuration.credential_types[:azure]
-      check_credential_existance(type, 'acr')
+      check_credential_existence(type, 'acr')
 
-      registry_url = prepare_registry_url(Uffizzi.ui.ask('Registry Domain: '))
-      username = Uffizzi.ui.ask('Docker ID: ')
-      password = Uffizzi.ui.ask('Password/Access Token: ', echo: false)
+      registry_url = ENV['ACR_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain: ')
+      username = ENV['ACR_USERNAME'] || Uffizzi.ui.ask('Docker ID: ')
+      password = ENV['ACR_PASSWORD'] || Uffizzi.ui.ask('Password/Access Token: ', echo: false)
 
       params = {
         username: username,
         password: password,
-        registry_url: registry_url,
+        registry_url: prepare_registry_url(registry_url),
         type: type,
       }
 
@@ -68,18 +72,20 @@ module Uffizzi
     end
 
     desc 'ecr', 'Connect to Amazon Elastic Container Registry'
+    method_option :skip_raise_existence_error, type: :boolean, default: false,
+                                               desc: 'Skip raising an error within check the credential'
     def ecr
       type = Uffizzi.configuration.credential_types[:amazon]
-      check_credential_existance(type, 'ecr')
+      check_credential_existence(type, 'ecr')
 
-      registry_url = prepare_registry_url(Uffizzi.ui.ask('Registry Domain: '))
-      username = Uffizzi.ui.ask('Access key ID: ')
-      password = Uffizzi.ui.ask('Secret access key: ', echo: false)
+      registry_url = ENV['AWS_REGISTRY_URL'] || Uffizzi.ui.ask('Registry Domain: ')
+      access_key = ENV['AWS_ACCESS_KEY_ID'] || Uffizzi.ui.ask('Access key ID: ')
+      secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || Uffizzi.ui.ask('Secret access key: ', echo: false)
 
       params = {
-        username: username,
-        password: password,
-        registry_url: registry_url,
+        username: access_key,
+        password: secret_access_key,
+        registry_url: prepare_registry_url(registry_url),
         type: type,
       }
 
@@ -94,17 +100,13 @@ module Uffizzi
     end
 
     desc 'gcr', 'Connect to Google Container Registry (gcr.io)'
+    method_option :skip_raise_existence_error, type: :boolean, default: false,
+                                               desc: 'Skip raising an error within check the credential'
     def gcr(credential_file_path = nil)
       type = Uffizzi.configuration.credential_types[:google]
-      check_credential_existance(type, 'gcr')
+      check_credential_existence(type, 'gcr')
 
-      return Uffizzi.ui.say('Path to google service account key file wasn\'t specified.') if credential_file_path.nil?
-
-      begin
-        credential_content = File.read(credential_file_path)
-      rescue Errno::ENOENT => e
-        return Uffizzi.ui.say(e)
-      end
+      credential_content = google_service_account_content(credential_file_path)
 
       params = {
         password: credential_content,
@@ -122,12 +124,14 @@ module Uffizzi
     end
 
     desc 'ghcr', 'Connect to GitHub Container Registry (ghcr.io)'
+    method_option :skip_raise_existence_error, type: :boolean, default: false,
+                                               desc: 'Skip raising an error within check the credential'
     def ghcr
-      type = Uffizzi.configuration.credential_types[:github_container_registry]
-      check_credential_existance(type, 'gchr')
+      type = Uffizzi.configuration.credential_types[:github_registry]
+      check_credential_existence(type, 'ghcr')
 
-      username = Uffizzi.ui.ask('Github Username: ')
-      password = Uffizzi.ui.ask('Access Token: ', echo: false)
+      username = ENV['GITHUB_USERNAME'] || Uffizzi.ui.ask('Github Username: ')
+      password = ENV['GITHUB_ACCESS_TOKEN'] || Uffizzi.ui.ask('Access Token: ', echo: false)
 
       params = {
         username: username,
@@ -160,14 +164,19 @@ module Uffizzi
       Uffizzi.ui.say("Successfully connected to #{connection_name}")
     end
 
-    def check_credential_existance(type, connection_name)
+    def check_credential_existence(type, connection_name)
       server = ConfigFile.read_option(:server)
       response = check_credential(server, type)
       return if ResponseHelper.ok?(response)
 
-      message = "Credentials of type #{connection_name} already exist for this account. " \
-      "To remove them, run $ uffizzi disconnect #{connection_name}."
-      raise Uffizzi::Error.new(message)
+      if options.skip_raise_existence_error?
+        Uffizzi.ui.say("Credentials of type #{connection_name} already exist for this account.")
+        exit(true)
+      else
+        message = "Credentials of type #{connection_name} already exist for this account. " \
+        "To remove them, run $ uffizzi disconnect #{connection_name}."
+        raise Uffizzi::Error.new(message)
+      end
     end
 
     def handle_list_credentials_success(response)
@@ -189,5 +198,19 @@ module Uffizzi
 
       map[credential]
     end
+
+    def google_service_account_content(credential_file_path = nil)
+      return ENV['GCLOUD_SERVICE_KEY'] if ENV['GCLOUD_SERVICE_KEY']
+
+      return Uffizzi.ui.say('Path to google service account key file wasn\'t specified.') if credential_file_path.nil?
+
+      begin
+        credential_content = File.read(credential_file_path)
+      rescue Errno::ENOENT => e
+        raise Uffizzi::Error.new(e.message)
+      end
+
+      credential_content
+    end
   end
 end

data/lib/uffizzi/cli/disconnect.rb

@@ -17,7 +17,7 @@ module Uffizzi
                         when 'gcr'
                           Uffizzi.configuration.credential_types[:google]
                         when 'ghcr'
-                          Uffizzi.configuration.credential_types[:github_container_registry]
+                          Uffizzi.configuration.credential_types[:github_registry]
                         else
                           raise Uffizzi::Error.new('Unsupported credential type.')
       end

data/lib/uffizzi/cli/preview.rb

@@ -23,7 +23,7 @@ module Uffizzi
       run('create', file_path: file_path)
     end
 
-    desc 'uffizzi preview update [DEPLOYMENT_ID] [COMPOSE_FILE]', 'create'
+    desc 'uffizzi preview update [DEPLOYMENT_ID] [COMPOSE_FILE]', 'Update a preview'
     method_option :output, required: false, type: :string, aliases: '-o', enum: ['json', 'github-action']
     def update(deployment_name, file_path)
       run('update', deployment_name: deployment_name, file_path: file_path)
@@ -86,33 +86,39 @@ module Uffizzi
       params = file_path.nil? ? {} : prepare_params(file_path)
       response = create_deployment(ConfigFile.read_option(:server), project_slug, params)
 
-      if ResponseHelper.created?(response)
-        deployment = response[:body][:deployment]
-        success_message = "Preview created with name deployment-#{deployment[:id]}"
-        PreviewService.start_deploy_containers(project_slug, deployment, success_message)
-      else
+      if !ResponseHelper.created?(response)
         ResponseHelper.handle_failed_response(response)
       end
+
+      deployment = response[:body][:deployment]
+      Uffizzi.ui.say("Preview created with name deployment-#{deployment[:id]}")
+
+      success = PreviewService.run_containers_deploy(project_slug, deployment)
+
+      display_deployment_data(deployment, success)
     rescue SystemExit, Interrupt, SocketError
       deployment_id = response[:body][:deployment][:id]
-      handle_preview_interruption(deployment_id, hostname, project_slug)
+      handle_preview_interruption(deployment_id, ConfigFile.read_option(:server), project_slug)
     end
 
     def handle_update_command(deployment_name, file_path, project_slug)
       deployment_id = PreviewService.read_deployment_id(deployment_name)
 
-      return Uffizzi.ui.say("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
+      raise Uffizzi::Error.new("Preview should be specified in 'deployment-PREVIEW_ID' format") if deployment_id.nil?
 
       params = prepare_params(file_path)
       response = update_deployment(ConfigFile.read_option(:server), project_slug, deployment_id, params)
 
-      if ResponseHelper.ok?(response)
-        deployment = response[:body][:deployment]
-        success_message = "Preview with ID deployment-#{deployment_id} was successfully updated."
-        PreviewService.start_deploy_containers(project_slug, deployment, success_message)
-      else
+      if !ResponseHelper.ok?(response)
         ResponseHelper.handle_failed_response(response)
       end
+
+      deployment = response[:body][:deployment]
+      Uffizzi.ui.say("Preview with ID deployment-#{deployment_id} was successfully updated.")
+
+      success = PreviewService.run_containers_deploy(project_slug, deployment)
+
+      display_deployment_data(deployment, success)
     end
 
     def handle_events_command(deployment_name, project_slug)
@@ -218,8 +224,8 @@ module Uffizzi
       }
     end
 
-    def handle_preview_interruption(deployment_id, hostname, project_slug)
-      deletion_response = delete_deployment(hostname, project_slug, deployment_id)
+    def handle_preview_interruption(deployment_id, server, project_slug)
+      deletion_response = delete_deployment(server, project_slug, deployment_id)
       deployment_name = "deployment-#{deployment_id}"
       preview_deletion_message = if ResponseHelper.no_content?(deletion_response)
         "The preview #{deployment_name} has been disabled."
@@ -229,5 +235,23 @@ module Uffizzi
 
       raise Uffizzi::Error.new("The preview creation was interrupted. #{preview_deletion_message}")
     end
+
+    def display_deployment_data(deployment, success)
+      if Uffizzi.ui.output_format.nil?
+        Uffizzi.ui.say('Done')
+        preview_url = "https://#{deployment[:preview_url]}"
+        Uffizzi.ui.say(preview_url) if success
+      else
+        deployment_data = build_deployment_data(deployment)
+        Uffizzi.ui.output(deployment_data)
+      end
+    end
+
+    def build_deployment_data(deployment)
+      {
+        id: "deployment-#{deployment[:id]}",
+        url: "https://#{deployment[:preview_url]}",
+      }
+    end
   end
 end

data/lib/uffizzi/cli/project.rb

@@ -3,6 +3,8 @@
 require 'uffizzi'
 require 'uffizzi/auth_helper'
 require 'uffizzi/response_helper'
+require 'uffizzi/helpers/project_helper'
+require 'uffizzi/services/project_service'
 
 module Uffizzi
   class Cli::Project < Thor
@@ -27,8 +29,27 @@ module Uffizzi
       run('set-default', project_slug: project_slug)
     end
 
+    desc 'describe [PROJECT_SLUG]', 'describe'
+    method_option :output, type: :string, aliases: '-o', enum: ['json', 'pretty'], default: 'json'
+    def describe(project_slug)
+      run('describe', project_slug: project_slug)
+    end
+
     map('set-default' => :set_default)
 
+    method_option :name, required: true
+    method_option :slug, default: ''
+    method_option :description, required: false
+    desc 'create', 'Create a project'
+    def create
+      run('create')
+    end
+
+    desc 'delete [PROJECT_SLUG]', 'Delete a project'
+    def delete(project_slug)
+      run('delete', project_slug: project_slug)
+    end
+
     private
 
     def run(command, project_slug: nil)
@@ -39,21 +60,74 @@ module Uffizzi
         handle_list_command
       when 'set-default'
         handle_set_default_command(project_slug)
+      when 'create'
+        handle_create_command
+      when 'delete'
+        handle_delete_command(project_slug)
+      when 'describe'
+        handle_describe_command(project_slug)
       end
     end
 
+    def handle_describe_command(project_slug)
+      response = describe_project(ConfigFile.read_option(:server), project_slug)
+
+      if ResponseHelper.ok?(response)
+        handle_succeed_describe_response(response)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_succeed_describe_response(response)
+      project = response[:body][:project]
+      project[:deployments] = ProjectService.select_active_deployments(project)
+      ProjectService.describe_project(project, options[:output])
+    end
+
     def handle_list_command
       server = ConfigFile.read_option(:server)
       response = fetch_projects(server)
 
       if ResponseHelper.ok?(response)
-        handle_succeed_response(response)
+        handle_list_success_response(response)
       else
         ResponseHelper.handle_failed_response(response)
       end
     end
 
-    def handle_succeed_response(response)
+    def handle_create_command
+      name = options[:name]
+      slug = options[:slug].empty? ? Uffizzi::ProjectHelper.generate_slug(name) : options[:slug]
+      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)
+      params = {
+        name: name,
+        description: options[:description],
+        slug: slug,
+      }
+      response = create_project(server, params)
+
+      if ResponseHelper.created?(response)
+        handle_create_success_response(response)
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_delete_command(project_slug)
+      server = ConfigFile.read_option(:server)
+      response = delete_project(server, project_slug)
+
+      if ResponseHelper.no_content?(response)
+        Uffizzi.ui.say("Project with slug #{project_slug} was deleted successfully")
+      else
+        ResponseHelper.handle_failed_response(response)
+      end
+    end
+
+    def handle_list_success_response(response)
       projects = response[:body][:projects]
       return Uffizzi.ui.say('No projects related to this email') if projects.empty?
 
@@ -76,6 +150,12 @@ module Uffizzi
       Uffizzi.ui.say('Default project has been updated.')
     end
 
+    def handle_create_success_response(response)
+      project_name = response[:body][:project][:name]
+
+      Uffizzi.ui.say("Project #{project_name} was successfully created")
+    end
+
     def print_projects(projects)
       projects_list = projects.reduce('') do |acc, project|
         "#{acc}#{project[:slug]}\n"

data/lib/uffizzi/cli.rb

@@ -62,8 +62,10 @@ module Uffizzi
         return Common.show_manual(filename(args)) if show_help?(args, opts)
 
         super
-      rescue SystemExit, Interrupt, SocketError
+      rescue Interrupt
         raise Uffizzi::Error.new('The command was interrupted')
+      rescue SocketError
+        raise Uffizzi::Error.new('A request was not sent to Uffizzi app')
       end
 
       private

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

@@ -44,7 +44,21 @@ module ApiClient
 
   def describe_project(server, project_slug)
     uri = project_uri(server, project_slug)
-    response = Uffizzi::HttpClient.make_get_request(uri)
+    response = http_client.make_get_request(uri)
+
+    build_response(response)
+  end
+
+  def create_project(server, params)
+    uri = projects_uri(server)
+    response = http_client.make_post_request(uri, params)
+
+    build_response(response)
+  end
+
+  def delete_project(server, project_slug)
+    uri = project_uri(server, project_slug)
+    response = http_client.make_delete_request(uri)
 
     build_response(response)
   end

data/lib/uffizzi/config_file.rb

@@ -8,17 +8,21 @@ module Uffizzi
     CONFIG_PATH = "#{Dir.home}/.config/uffizzi/config_default.json"
 
     class << self
+      def config_path
+        CONFIG_PATH
+      end
+
       def create(account_id, cookie, server)
         data = prepare_config_data(account_id, cookie, server)
         data.each_pair { |key, value| write_option(key, value) }
       end
 
       def delete
-        File.delete(CONFIG_PATH) if exists?
+        File.delete(config_path) if exists?
       end
 
       def exists?
-        File.exist?(CONFIG_PATH)
+        File.exist?(config_path)
       end
 
       def read_option(option)
@@ -79,7 +83,7 @@ module Uffizzi
       end
 
       def read
-        data = File.read(CONFIG_PATH)
+        data = File.read(config_path)
         options = data.split("\n")
         options.reduce({}) do |acc, option|
           key, value = option.split('=', 2)
@@ -112,11 +116,11 @@ module Uffizzi
       end
 
       def create_file
-        dir = File.dirname(CONFIG_PATH)
+        dir = File.dirname(config_path)
 
         FileUtils.mkdir_p(dir) unless File.directory?(dir)
 
-        File.new(CONFIG_PATH, 'w')
+        File.new(config_path, 'w')
       end
     end
   end

data/lib/uffizzi/helpers/project_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Uffizzi
+  module ProjectHelper
+    SLUG_ENDING_LENGTH = 6
+    class << self
+      def generate_slug(name)
+        formatted_name = name.downcase.gsub(/ /, '-').gsub(/[^\w-]+/, '')
+        slug_ending = generate_random_string(SLUG_ENDING_LENGTH)
+
+        "#{formatted_name}-#{slug_ending}"
+      end
+
+      private
+
+      def generate_random_string(length)
+        hexatridecimal_base = 36
+        rand(hexatridecimal_base**length).to_s(hexatridecimal_base)
+      end
+    end
+  end
+end

data/lib/uffizzi/services/preview_service.rb

@@ -5,6 +5,7 @@ require 'uffizzi/clients/api/api_client'
 class PreviewService
   class << self
     include ApiClient
+
     def read_deployment_id(deployment_name)
       return nil unless deployment_name.start_with?('deployment-')
       return nil unless deployment_name.split('-').size == 2
@@ -15,23 +16,23 @@ class PreviewService
       deployment_id
     end
 
-    def start_deploy_containers(project_slug, deployment, success_message)
+    def run_containers_deploy(project_slug, deployment)
       deployment_id = deployment[:id]
       params = { id: deployment_id }
 
       response = deploy_containers(Uffizzi::ConfigFile.read_option(:server), project_slug, deployment_id, params)
 
-      if Uffizzi::ResponseHelper.no_content?(response)
-        Uffizzi.ui.say(success_message)
-        create_deployment(deployment, project_slug)
-      else
+      if !Uffizzi::ResponseHelper.no_content?(response)
         Uffizzi::ResponseHelper.handle_failed_response(response)
       end
+
+      activity_items = wait_containers_creation(deployment, project_slug)
+      wait_containers_deploy(deployment, project_slug, activity_items)
     end
 
     private
 
-    def create_deployment(deployment, project_slug)
+    def wait_containers_creation(deployment, project_slug)
       spinner = TTY::Spinner.new('[:spinner] Creating containers...', format: :dots)
       spinner.auto_spin
 
@@ -49,10 +50,10 @@ class PreviewService
 
       Uffizzi.ui.say('Done')
 
-      display_containers_deploying_status(deployment, project_slug, activity_items)
+      activity_items
     end
 
-    def display_containers_deploying_status(deployment, project_slug, activity_items)
+    def wait_containers_deploy(deployment, project_slug, activity_items)
       spinner = TTY::Spinner::Multi.new('[:spinner] Deploying preview...', format: :dots, style: {
                                           middle: '  ',
                                           bottom: '  ',
@@ -64,20 +65,13 @@ class PreviewService
         response = get_activity_items(Uffizzi::ConfigFile.read_option(:server), project_slug, deployment[:id])
         handle_activity_items_response(response, spinner)
         activity_items = response[:body][:activity_items]
-        check_activity_items_state(activity_items, containers_spinners)
+        update_containers_spinners!(activity_items, containers_spinners)
         break if activity_items.all? { |activity_item| activity_item[:state] == 'deployed' || activity_item[:state] == 'failed' }
 
         sleep(5)
       end
 
-      if Uffizzi.ui.output_format.nil?
-        Uffizzi.ui.say('Done')
-        preview_url = "https://#{deployment[:preview_url]}"
-        Uffizzi.ui.say(preview_url) if spinner.success?
-      else
-        output_data = build_output_data(deployment)
-        Uffizzi.ui.output(output_data)
-      end
+      spinner.success?
     end
 
     def create_containers_spinners(activity_items, spinner)
@@ -91,10 +85,11 @@ class PreviewService
       end
     end
 
-    def check_activity_items_state(activity_items, containers_spinners)
+    def update_containers_spinners!(activity_items, containers_spinners)
       finished_activity_items = activity_items.filter do |activity_item|
         activity_item[:state] == 'deployed' || activity_item[:state] == 'failed'
       end
+
       finished_activity_items.each do |activity_item|
         container_spinner = containers_spinners.detect { |spinner| spinner[:name] == activity_item[:name] }
         spinner = container_spinner[:spinner]
@@ -113,12 +108,5 @@ class PreviewService
         Uffizzi::ResponseHelper.handle_failed_response(response)
       end
     end
-
-    def build_output_data(output_data)
-      {
-        id: "deployment-#{output_data[:id]}",
-        url: "https://#{output_data[:preview_url]}",
-      }
-    end
   end
 end

data/lib/uffizzi/services/project_service.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+class ProjectService
+  class << self
+    def describe_project(project, output_format)
+      json_format?(output_format) ? output_in_json(project) : output_in_pretty_format(project)
+    end
+
+    def select_active_deployments(project)
+      project[:deployments].select { |deployment| deployment[:state] == 'active' }
+    end
+
+    private
+
+    def json_format?(output_format)
+      output_format == 'json'
+    end
+
+    def output_in_json(data)
+      Uffizzi.ui.say(data.to_json)
+    end
+
+    def output_in_pretty_format(project)
+      Uffizzi.ui.say("Project name: #{project[:name]}")
+      Uffizzi.ui.say("Project slug: #{project[:slug]}")
+      Uffizzi.ui.say("Description: #{project[:description]}".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)
+      Uffizzi.ui.say('Previews:')
+      project[:deployments].each do |deployment|
+        Uffizzi.ui.say("  - deployment-#{deployment[:id]} (https://#{deployment[:preview_url]})")
+      end
+      Uffizzi.ui.say('Secrets:')
+      project[:secrets].each do |secret|
+        Uffizzi.ui.say("  - #{secret}")
+      end
+    end
+  end
+end

data/lib/uffizzi/version.rb

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

data/man/uffizzi-config

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "CONFIG" "" "April 2022" ""
+.TH "CONFIG" "" "May 2022" ""
 .SH "NAME"
 \fBconfig\fR \- configure the Uffizzi command\-line interface (CLI)
 .SH "SYNOPSIS"

data/man/uffizzi-login

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-LOGIN" "" "April 2022" ""
+.TH "UFFIZZI\-LOGIN" "" "May 2022" ""
 .SH "NAME"
 \fBuffizzi\-login\fR \- login to Uffizzi to view and manage your previews\.
 .SH "SYNOPSIS"

data/man/uffizzi-logout

@@ -1,6 +1,6 @@
 .\" generated with Ronn-NG/v0.9.1
 .\" http://github.com/apjanke/ronn-ng/tree/0.9.1
-.TH "UFFIZZI\-LOGOUT" "" "March 2022" ""
+.TH "UFFIZZI\-LOGOUT" "" "May 2022" ""
 .SH "NAME"
 \fBuffizzi\-logout\fR \- log out of a Uffizzi user account
 .SH "SYNOPSIS"

data/man/uffizzi-project-create

@@ -0,0 +1,50 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-CREATE" "" "May 2022" ""
+.SH "NAME"
+\fBuffizzi\-project\-create\fR \- create a new project
+.SH "SYNOPSIS"
+.nf
+uffizzi project create [\-\-name=NAME] [\-\-slug=SLUG]
+     [\-\-description=DESCRIPTION] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Create new project\.
+
+This command can fail for the following reasons:
+    \- The project \-\-description is too long\.
+    \- The project \-\-name flag is not specified\.
+    \- The project \-\-slug is malformed or used by another project\.
+
+For more information on the uffizzi project command, see:
+https:/github\.com/UffizziCloud/uffizzi_cli
+.fi
+.SH "FLAGS"
+.nf
+\-\-description=DESCRIPTION
+   Description for the project you want to create\. Max of 256
+   characters\.
+
+\-\-name=NAME
+   Name for the project you want to create\.
+
+\-\-slug=SLUG
+   A URL\-compatible name\. Do not include whitespaces or special characters\.
+   Project slugs must be globally unique across all Uffizzi projects\.
+   If a slug is not provided, Uffizzi will automatically generate one\.
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+To create a new project with name My App, project slug my\-app, and
+description "My first project", run:
+
+    $ uffizzi project create \-\-name="My App" \-\-slug="my\-app" \e
+      \-\-description="My first project"
+.fi
+

data/man/uffizzi-project-create.ronn

@@ -0,0 +1,41 @@
+uffizzi-project-create - create a new project
+================================================================
+
+## SYNOPSIS
+    uffizzi project create [--name=NAME] [--slug=SLUG]
+         [--description=DESCRIPTION] [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    Create new project.
+
+    This command can fail for the following reasons:  
+        - The project --description is too long.
+        - The project --name flag is not specified.
+        - The project --slug is malformed or used by another project. 
+
+    For more information on the uffizzi project command, see:
+    https:/github.com/UffizziCloud/uffizzi_cli
+
+## FLAGS
+    --description=DESCRIPTION
+       Description for the project you want to create. Max of 256 
+       characters.
+
+    --name=NAME
+       Name for the project you want to create. 
+
+    --slug=SLUG
+       A URL-compatible name. Do not include whitespaces or special characters.
+       Project slugs must be globally unique across all Uffizzi projects.
+       If a slug is not provided, Uffizzi will automatically generate one.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    To create a new project with name My App, project slug my-app, and
+    description "My first project", run:
+
+        $ uffizzi project create --name="My App" --slug="my-app" \
+          --description="My first project"

data/man/uffizzi-project-delete

@@ -0,0 +1,32 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-PROJECT\-DELETE" "" "May 2022" ""
+.SH "NAME"
+\fBuffizzi\-project\-delete\fR \- delete a project
+.SH "SYNOPSIS"
+.nf
+uffizzi project delete PROJECT_SLUG [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Deletes a project with the given project slug\.
+
+This command can fail for the following reasons:
+  \- There is no project with the given project slug
+  \- The active account does not have permission to delete the project
+
+For more information on Uffizzi projects, 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 delete a project with project slug my\-app\-xc8fw, run:
+
+    $ uffizzi project delete my\-app\-xc8fw
+.fi
+

data/man/uffizzi-project-delete.ronn

@@ -0,0 +1,24 @@
+uffizzi-project-delete - delete a project
+================================================================
+
+## SYNOPSIS
+    uffizzi project delete PROJECT_SLUG [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Deletes a project with the given project slug. 
+
+    This command can fail for the following reasons:
+      - There is no project with the given project slug
+      - The active account does not have permission to delete the project
+
+    For more information on Uffizzi projects, 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 delete a project with project slug my-app-xc8fw, run:
+
+        $ uffizzi project delete my-app-xc8fw

data/man/uffizzi-project-describe

@@ -0,0 +1,43 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "DESCRIBE" "" "May 2022" ""
+.SH "NAME"
+\fBuffizzi project describe\fR \- show metadata for a project
+.SH "SYNOPSIS"
+.nf
+uffizzi project describe PROJECT_SLUG [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Shows metadata for a project given a valid project slug\.
+
+This command can fail for the following reasons:
+  \- There is no project with the given project slug
+
+For more information on Uffizzi projects, see:
+https://github\.com/UffizziCloud/uffizzi_cli
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+\-\-output FORMAT
+   Output format\. FORMAT is one of the following: json, pretty
+   Default is json\.
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+The following command prints metadata in json format for a project with the
+project slug my\-app\-xc8fw:
+
+    $ uffizzi project describe my\-app\-xc8fw
+
+The following command pretty prints metadata for a project with the project
+slug my\-app\-xc8fw:
+
+    $ uffizzi project describe my\-app\-xc8fw \-\-output pretty
+.fi
+

data/man/uffizzi-project-describe.ronn

@@ -0,0 +1,34 @@
+  uffizzi project describe - show metadata for a project
+================================================================
+
+## SYNOPSIS
+    uffizzi project describe PROJECT_SLUG [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Shows metadata for a project given a valid project slug. 
+
+    This command can fail for the following reasons:
+      - There is no project with the given project slug
+
+    For more information on Uffizzi projects, see:
+    https://github.com/UffizziCloud/uffizzi_cli
+
+## UFFIZZI WIDE FLAGS
+    --output FORMAT
+       Output format. FORMAT is one of the following: json, pretty 
+       Default is json.
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command prints metadata in json format for a project with the 
+    project slug my-app-xc8fw:
+
+        $ uffizzi project describe my-app-xc8fw
+
+    The following command pretty prints metadata for a project with the project
+    slug my-app-xc8fw:
+
+        $ uffizzi project describe my-app-xc8fw --output pretty 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-13 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -323,11 +323,13 @@ files:
 - lib/uffizzi/config_file.rb
 - lib/uffizzi/date_helper.rb
 - lib/uffizzi/error.rb
+- lib/uffizzi/helpers/project_helper.rb
 - lib/uffizzi/response_helper.rb
 - lib/uffizzi/services/command_service.rb
 - lib/uffizzi/services/compose_file_service.rb
 - lib/uffizzi/services/env_variables_service.rb
 - lib/uffizzi/services/preview_service.rb
+- lib/uffizzi/services/project_service.rb
 - lib/uffizzi/shell.rb
 - lib/uffizzi/version.rb
 - man/uffizzi
@@ -394,6 +396,12 @@ files:
 - man/uffizzi-project-compose-unset.ronn
 - man/uffizzi-project-compose.html
 - man/uffizzi-project-compose.ronn
+- man/uffizzi-project-create
+- man/uffizzi-project-create.ronn
+- man/uffizzi-project-delete
+- man/uffizzi-project-delete.ronn
+- man/uffizzi-project-describe
+- man/uffizzi-project-describe.ronn
 - man/uffizzi-project-secret
 - man/uffizzi-project-secret-create
 - man/uffizzi-project-secret-create.html