uffizzi-cli 0.1.4.3 → 0.2.0

data/lib/uffizzi.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 require 'uffizzi/shell'
-require_relative 'uffizzi/version'
-require_relative 'uffizzi/clients/api/api_client'
-require_relative 'uffizzi/clients/api/api_routes'
-require_relative 'uffizzi/config_file'
+require 'uffizzi/version'
+require 'uffizzi/clients/api/api_client'
+require 'uffizzi/clients/api/api_routes'
+require 'uffizzi/config_file'
 
 module Uffizzi
   class Error < StandardError; end
+
   class << self
     def ui
       @ui ||= Uffizzi::UI::Shell.new

data/man/uffizzi-create

@@ -0,0 +1,50 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "CREATE" "" "February 2022" ""
+.SH "NAME"
+\fBcreate\fR \- create a preview
+.SH "SYNOPSIS"
+.nf
+uffizzi preview create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Creates a new preview\. If no COMPOSE_FILE is specified, the preview
+is created with the project\'s default compose file\.
+
+This command can fail for the following reasons:
+    \- The project does not have a default compose file set\. Run
+      $ uffizzi compose \-\-help for details\.
+    \- The alternate compose file is invalid\.
+
+For more information on Uffizzi previews, see:
+https://docs\.uffizzi\.com/cli/preview
+.fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[COMPOSE_FILE]
+    An alternate compose file to the default compose\.
+
+    You can pass a compose file to this command to create an ad hoc
+    preview of an alternate compose configuration\. The file passed
+    via this argument does not replace the default compose file for
+    the project\. Alternate compose files share the same lifecyle as
+    the previews they create: when the preview is deleted, the
+    alternate compose is deleted by the Uffizzi API\.
+.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 preview with the project\'s default compose file, run:
+
+    $ uffizzi preview create
+
+To create a preview with an alternate compose file, run:
+
+    $ uffizzi preview create docker\-compose\.uffizzi\.alt\.yml
+.fi
+

data/man/uffizzi-create.ronn

@@ -0,0 +1,41 @@
+uffizzi preview create - create a preview
+================================================================
+
+## SYNOPSIS
+    uffizzi preview create [COMPOSE_FILE] [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    Creates a new preview. If no COMPOSE_FILE is specified, the preview 
+    is created with the project's default compose file.
+
+    This command can fail for the following reasons: 
+        - The project does not have a default compose file set. Run 
+          $ uffizzi compose --help for details.  
+        - The alternate compose file is invalid.  
+
+    For more information on Uffizzi previews, see:
+    https://docs.uffizzi.com/cli/preview
+
+## POSITIONAL ARGUMENTS
+    [COMPOSE_FILE]
+        An alternate compose file to the default compose.
+
+        You can pass a compose file to this command to create an ad hoc 
+        preview of an alternate compose configuration. The file passed 
+        via this argument does not replace the default compose file for 
+        the project. Alternate compose files share the same lifecyle as 
+        the previews they create: when the preview is deleted, the 
+        alternate compose is deleted by the Uffizzi API. 
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    To create a preview with the project's default compose file, run:
+
+        $ uffizzi preview create
+
+    To create a preview with an alternate compose file, run:
+
+        $ uffizzi preview create docker-compose.uffizzi.alt.yml

data/man/uffizzi-delete

@@ -0,0 +1,37 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "DELETE" "" "February 2022" ""
+.SH "NAME"
+\fBdelete\fR \- delete a preview
+.SH "SYNOPSIS"
+.nf
+uffizzi preview delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Deletes a preview with the given preview ID\.
+
+This command can fail for the following reasons:
+    \- The preview specified does not exist\.
+    \- The preview specified belongs to a different project\.
+
+For more information on Uffizzi previews, see:
+https://docs\.uffizzi\.com/cli/preview
+.fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[PREVIEW_ID]
+    ID for the preview you want to delete\.
+.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 deletes the preview with ID deployment\-213:
+
+    $ uffizzi preview delete deployment\-213
+.fi
+

data/man/uffizzi-delete.ronn

@@ -0,0 +1,28 @@
+uffizzi preview delete - delete a preview
+================================================================
+
+## SYNOPSIS
+    uffizzi preview delete [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    Deletes a preview with the given preview ID. 
+
+    This command can fail for the following reasons:
+        - The preview specified does not exist.
+        - The preview specified belongs to a different project.
+    
+    For more information on Uffizzi previews, see:
+    https://docs.uffizzi.com/cli/preview
+
+## POSITIONAL ARGUMENTS
+    [PREVIEW_ID]
+        ID for the preview you want to delete.  
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command deletes the preview with ID deployment-213:
+
+        $ uffizzi preview delete deployment-213

data/man/uffizzi-describe

@@ -0,0 +1,38 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "DESCRIBE" "" "February 2022" ""
+.SH "NAME"
+\fBdescribe\fR \- show metadata for a preview
+.SH "SYNOPSIS"
+.nf
+uffizzi preview describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Shows metadata for a project given a valid preview ID\.
+
+This command can fail for the following reasons:
+    \- The preview specified does not exist\.
+    \- The preview specified belongs to a different project\.
+
+For more information on Uffizzi previews, see:
+https://docs\.uffizzi\.com/cli/preview
+.fi
+.SH "POSITIONAL ARGUMENTS"
+.nf
+[PREVIEW_ID]
+    ID for the preview you want to describe\.
+.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 for the preview with ID
+deployment\-213:
+
+    $ uffizzi preview describe deployment\-213
+.fi
+

data/man/uffizzi-describe.ronn

@@ -0,0 +1,29 @@
+uffizzi preview describe - show metadata for a preview
+================================================================
+
+## SYNOPSIS
+    uffizzi preview describe [PREVIEW_ID] [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    Shows metadata for a project given a valid preview ID. 
+
+    This command can fail for the following reasons:
+        - The preview specified does not exist.
+        - The preview specified belongs to a different project.
+    
+    For more information on Uffizzi previews, see:
+    https://docs.uffizzi.com/cli/preview
+
+## POSITIONAL ARGUMENTS
+    [PREVIEW_ID]
+        ID for the preview you want to describe.  
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    The following command prints metadata for the preview with ID 
+    deployment-213:
+
+        $ uffizzi preview describe deployment-213

data/man/uffizzi-list

@@ -0,0 +1,33 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "LIST" "" "February 2022" ""
+.SH "NAME"
+\fBuffizzi preview list\fR \- list previews in a project
+.SH "SYNOPSIS"
+.nf
+uffizzi preview list [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Lists all previews for a project, including active, building,
+deploying and failed previews\.
+
+For more information on Uffizzi previews, see:
+https://docs\.uffizzi\.com/cli/preview
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+.nf
+To list all previews in the default project, run:
+
+    $ uffizzi preview list
+
+To list all previews in a project with name my_project, run:
+
+    $ uffizzi preview list \-\-project="my_project"
+.fi
+

data/man/uffizzi-list.ronn

@@ -0,0 +1,25 @@
+uffizzi preview list - list previews in a project
+================================================================
+
+## SYNOPSIS
+    uffizzi preview list [UFFIZZI_WIDE_FLAG ...] 
+
+## DESCRIPTION
+    Lists all previews for a project, including active, building, 
+    deploying and failed previews. 
+    
+    For more information on Uffizzi previews, see:
+    https://docs.uffizzi.com/cli/preview
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## EXAMPLES
+    To list all previews in the default project, run:
+
+        $ uffizzi preview list
+
+    To list all previews in a project with name my_project, run:
+
+        $ uffizzi preview list --project="my_project"

data/man/uffizzi-preview

@@ -0,0 +1,39 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "PREVIEW" "" "February 2022" ""
+.SH "NAME"
+\fBpreview\fR \- manage previews
+.SH "SYNOPSIS"
+.nf
+uffizzi preview COMMAND [UFFIZZI_WIDE_FLAG \|\.\|\.\|\.]
+.fi
+.SH "DESCRIPTION"
+.nf
+Manage Uffizzi previews
+
+For more information on Uffizzi previews, see:
+https://docs\.uffizzi\.com/cli/preview
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "COMMANDS"
+.nf
+COMMAND is one of the following:
+
+ create
+    Create a preview
+
+ delete
+    Delete a preview
+
+ describe
+    Display details of a preview
+
+ list
+    List all previews
+.fi
+.SH "Run \'uffizzi preview COMMAND \-\-help\' for more information on a command\."
+

data/man/uffizzi-preview.ronn

@@ -0,0 +1,33 @@
+uffizzi preview - manage previews
+================================================================
+
+## SYNOPSIS
+    uffizzi preview COMMAND [UFFIZZI_WIDE_FLAG ...]
+
+## DESCRIPTION
+    Manage Uffizzi previews
+
+    For more information on Uffizzi previews, see:
+    https://docs.uffizzi.com/cli/preview
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi 
+    help for details.
+
+## COMMANDS
+    COMMAND is one of the following:
+
+     create
+        Create a preview
+
+     delete
+        Delete a preview
+
+     describe
+        Display details of a preview
+
+     list
+        List all previews
+
+## 
+Run 'uffizzi preview COMMAND --help' for more information on a command.

data/uffizzi.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-minitest'
   spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'tty-spinner'
   spec.add_development_dependency 'webmock'
 
   spec.add_dependency 'thor'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.4.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-04 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -207,6 +207,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  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
@@ -254,6 +268,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/config.rb
 - config/uffizzi.rb
 - docker-compose.yml
 - exe/uffizzi
@@ -264,16 +279,30 @@ files:
 - lib/uffizzi/cli/config.rb
 - lib/uffizzi/cli/login.rb
 - lib/uffizzi/cli/logout.rb
-- lib/uffizzi/cli/projects.rb
+- lib/uffizzi/cli/preview.rb
+- lib/uffizzi/cli/project.rb
+- lib/uffizzi/cli/project/compose.rb
 - lib/uffizzi/clients/api/api_client.rb
 - lib/uffizzi/clients/api/api_routes.rb
 - lib/uffizzi/clients/api/http_client.rb
 - lib/uffizzi/config_file.rb
 - lib/uffizzi/response_helper.rb
+- lib/uffizzi/services/compose_file_service.rb
+- lib/uffizzi/services/env_variables_service.rb
 - lib/uffizzi/shell.rb
 - lib/uffizzi/version.rb
+- man/uffizzi-create
+- man/uffizzi-create.ronn
+- man/uffizzi-delete
+- man/uffizzi-delete.ronn
+- man/uffizzi-describe
+- man/uffizzi-describe.ronn
+- man/uffizzi-list
+- man/uffizzi-list.ronn
 - man/uffizzi-logout
 - man/uffizzi-logout.ronn
+- man/uffizzi-preview
+- man/uffizzi-preview.ronn
 - uffizzi.gemspec
 homepage: https://uffizzi.com
 licenses:

data/lib/uffizzi/cli/projects.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'io/console'
-require 'uffizzi'
-require 'uffizzi/auth_helper'
-
-module Uffizzi
-  class CLI::Projects
-    include ApiClient
-
-    def run
-      return 'You are not logged in' unless Uffizzi::AuthHelper.signed_in?
-
-      hostname = ConfigFile.read_option(:hostname)
-      response = fetch_projects(hostname)
-
-      if response[:code] == Net::HTTPOK
-        handle_succeed_response(response)
-      else
-        handle_failed_response(response)
-      end
-    end
-
-    private
-
-    def handle_failed_response(response)
-      ApiClient.print_errors(response[:body][:errors])
-    end
-
-    def handle_succeed_response(response)
-      projects = response[:body][:projects]
-      if projects.empty?
-        puts 'No projects related to this email'
-        return
-      end
-      if projects.size == 1
-        ConfigFile.write_option(:project, projects.first[:slug])
-      end
-      print_projects(projects)
-    end
-
-    def print_projects(projects)
-      projects.each do |project|
-        puts (project[:slug]).to_s
-      end
-    end
-  end
-end