uffizzi-cli 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aca9ee61a74b9ee91500b97af8f476eaac87bec45004666cc530ae126ec5e805
-  data.tar.gz: 7e5dbaf9b1f1f83290131462001abce49beb00672c6f64e4149f8d712dcdc9c6
+  metadata.gz: 3cfd80a4b633de1e4fbf267b1b575c9d73b6ce32bc158201466f6e3b6b8f9891
+  data.tar.gz: 5a47e507b7b44baaa3d036e322f3899eff115d9ce676943cbca273792d034000
 SHA512:
-  metadata.gz: d849aef9e9351c04857da29352c8c9844baa3e4893cbe92a4d81993969de1d42aa3c83337d81585a88ec0dcf5502480c296abae714d3ef3946026f81cb9ca0f0
-  data.tar.gz: 6547b542070250bd421b88cdd3eca67e1eb84f49ad43664f18db2ca977c7098842146b5ffd30e373bb45e0a92c53defe32727bc097555881a4e0af04b37bd4ad
+  metadata.gz: 7ccd893a0ab267f0748f1052c9986c39d8f02f0bf9cd1357ffd42cd486bd8a8cf0186d32319a1e19f88acbad59046d3912195276427ecf230050e82f03884db7
+  data.tar.gz: 8c327421849e91c77388feb5fee7e67544beb7b7301d11d334e187b27ab14296e8c688611745af7ed0316274f6c72f0ba5af2fab103864e54622338f73e74c50

data/Dockerfile

@@ -2,7 +2,7 @@ FROM ruby:3.0.2-alpine3.14
 
 RUN apk update && apk upgrade
 RUN apk add bash
-RUN apk add curl-dev ruby-dev build-base git curl ruby-json openssl
+RUN apk add curl-dev ruby-dev build-base git curl ruby-json openssl groff mandoc man-pages
 
 RUN mkdir -p /gem
 WORKDIR /gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    uffizzi-cli (0.1.2)
+    uffizzi-cli (0.1.3)
       thor
 
 GEM
@@ -26,12 +26,18 @@ GEM
     hashdiff (1.0.1)
     i18n (1.8.11)
       concurrent-ruby (~> 1.0)
+    kramdown (2.3.1)
+      rexml
     method_source (1.0.0)
     minitest (5.14.4)
     minitest-power_assert (0.3.1)
       minitest
       power_assert (>= 1.1)
     mocha (1.13.0)
+    mustache (0.99.8)
+    nokogiri (1.13.1-x86_64-linux)
+      racc (~> 1.4)
+    open3 (0.1.1)
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
@@ -46,10 +52,15 @@ GEM
       pry (> 0.10.0)
       unicode (~> 0.4.4)
     public_suffix (4.0.6)
+    racc (1.6.0)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
+    ronn-ng (0.9.1)
+      kramdown (~> 2.1)
+      mustache (~> 0.7, >= 0.7.0)
+      nokogiri (~> 1.9, >= 1.9.0)
     rubocop (1.22.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -87,9 +98,11 @@ DEPENDENCIES
   minitest
   minitest-power_assert
   mocha
+  open3
   pry-byebug
   pry-inline
   rake
+  ronn-ng
   rubocop
   rubocop-minitest
   rubocop-rake

data/README.md

@@ -108,6 +108,37 @@ $ uffizzi config delete OPTION
 
 Deletes specified option.
 
+## Git workflow for the app:
+
+1. Clone the repository and checkout to `develop` branch
+
+2. Pull repository to ensure you have the latest changes
+```
+git pull --rebase develop
+```
+
+3. Start new branch from `develop`
+```
+git checkout -b feature/short_issue_description (e.g. feature/add_domain_settings)
+```
+
+4. Make changes you need for the feature, commit them to the repo
+```
+git add .
+git commit -m 'short commit description' (e.g. git commit -m 'added domain settings')
+git push origin FEATURE_NAME
+```
+
+4. You already can create PR with develop branch as a target. Once the feature is ready let us know in the channel - we will review
+
+5. Merge your feature to `qa` branch and push. Ensure your pipeline is successful
+```
+git checkout qa
+git pull --rebase qa
+git merge --no-ff FEATURE_NAME
+git push origin qa
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/UffizziCloud/uffizzi_cli.

data/Rakefile

@@ -14,3 +14,8 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
 task default: [:test, :rubocop]
+
+desc 'Generate roff output files from ronn format'
+task :generate_docs do
+  sh 'ronn --roff man/*.ronn'
+end

data/lib/uffizzi/auth_helper.rb

@@ -4,14 +4,10 @@ module Uffizzi
   module AuthHelper
     class << self
       def signed_in?
-        logged_in = ConfigFile.exists? &&
+        ConfigFile.exists? &&
           ConfigFile.option_exists?(:account_id) &&
           ConfigFile.option_exists?(:cookie) &&
           ConfigFile.option_exists?(:hostname)
-
-        puts 'You are not logged in.' unless logged_in
-
-        logged_in
       end
     end
   end

data/lib/uffizzi/cli/common.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Cli
+  class Common
+    class << self
+      def show_manual(method_name)
+        manual_doc_path = "man/uffizzi-#{method_name}"
+
+        Open3.pipeline("man #{manual_doc_path}")
+      end
+    end
+  end
+end

data/lib/uffizzi/cli/login.rb

@@ -2,6 +2,7 @@
 
 require 'io/console'
 require 'uffizzi'
+require 'uffizzi/response_helper'
 
 module Uffizzi
   class CLI::Login
@@ -13,12 +14,10 @@ module Uffizzi
 
     def run
       password = IO::console.getpass('Enter Password: ')
-
       params = prepare_request_params(password)
-
       response = create_session(@options[:hostname], params)
 
-      if response[:code] == Net::HTTPCreated
+      if Uffizzi::ResponseHelper.created?(response)
         handle_succeed_response(response)
       else
         handle_failed_response(response)
@@ -41,12 +40,10 @@ module Uffizzi
     end
 
     def handle_succeed_response(response)
-      unless account_valid?(response[:body][:user][:accounts].first)
-        puts 'No account related to this email'
-        return
-      end
-      account_id = response[:body][:user][:accounts].first[:id]
-      ConfigFile.create(account_id, response[:headers], @options[:hostname])
+      account = response[:body][:user][:accounts].first
+      return Uffizzi.ui.say('No account related to this email') unless account_valid?(account)
+
+      ConfigFile.create(account[:id], response[:headers], @options[:hostname])
     end
 
     def account_valid?(account)

data/lib/uffizzi/cli/logout.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'io/console'
+require 'uffizzi'
+require 'uffizzi/auth_helper'
+
+module Uffizzi
+  class CLI::Logout
+    include ApiClient
+
+    def run
+      return Uffizzi.ui.say('You are not logged in') unless Uffizzi::AuthHelper.signed_in?
+
+      hostname = ConfigFile.read_option(:hostname)
+      destroy_session(hostname)
+
+      ConfigFile.delete
+      Uffizzi.ui.say('You have been successfully logged out')
+    end
+  end
+end

data/lib/uffizzi/cli/projects.rb

@@ -9,7 +9,7 @@ module Uffizzi
     include ApiClient
 
     def run
-      return unless Uffizzi::AuthHelper.signed_in?
+      return 'You are not logged in' unless Uffizzi::AuthHelper.signed_in?
 
       hostname = ConfigFile.read_option(:hostname)
       response = fetch_projects(hostname)

data/lib/uffizzi/cli.rb

@@ -4,13 +4,17 @@ require 'thor'
 
 module Uffizzi
   class CLI < Thor
-    desc 'version', 'show version'
+    require_relative 'cli/common'
+
+    class_option :help, type: :boolean, aliases: HELP_MAPPINGS
+
+    desc 'version', 'Show Version'
     def version
       require_relative 'version'
       puts Uffizzi::VERSION
     end
 
-    desc 'login', 'login'
+    desc 'login', 'Login into Uffizzi'
     method_option :user, required: true, aliases: '-u'
     method_option :hostname, required: true, aliases: '-h'
     def login
@@ -18,6 +22,14 @@ module Uffizzi
       Login.new(options).run
     end
 
+    desc 'logout', 'Logout from Uffizzi'
+    def logout(help = nil)
+      return Cli::Common.show_manual(:logout) if help || options[:help]
+
+      require_relative 'cli/logout'
+      Logout.new.run
+    end
+
     desc 'projects', 'projects'
     def projects
       require_relative 'cli/projects'

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

@@ -12,6 +12,13 @@ module ApiClient
     build_response(response)
   end
 
+  def destroy_session(hostname)
+    uri = session_uri(hostname)
+    response = Uffizzi::HttpClient.make_request(uri, :delete, true)
+
+    build_response(response)
+  end
+
   def fetch_projects(hostname)
     uri = projects_uri(hostname)
     response = Uffizzi::HttpClient.make_request(uri, :get, true)

data/lib/uffizzi/response_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Uffizzi
+  module ResponseHelper
+    class << self
+      def created?(response)
+        response[:code] == Net::HTTPCreated
+      end
+
+      def unprocessable_entity?(response)
+        response[:code] == Net::HTTPUnprocessableEntity
+      end
+
+      def not_found?(response)
+        response[:code] == Net::HTTPNotFound
+      end
+
+      def forbidden?(response)
+        response[:code] == Net::HTTPForbidden
+      end
+
+      def no_content?(response)
+        response[:code] == Net::HTTPNoContent
+      end
+    end
+  end
+end

data/lib/uffizzi/shell.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Uffizzi
+  module UI
+    class Shell
+      def initialize
+        @shell = Thor::Shell::Basic.new
+      end
+
+      def say(msg)
+        @shell.say(msg)
+      end
+
+      def last_message
+        @shell.send(:stdout).string.strip
+      end
+    end
+  end
+end

data/lib/uffizzi/version.rb

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

data/lib/uffizzi.rb

@@ -1,5 +1,6 @@
 # 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'
@@ -7,4 +8,9 @@ require_relative 'uffizzi/config_file'
 
 module Uffizzi
   class Error < StandardError; end
+  class << self
+    def ui
+      @ui ||= Uffizzi::UI::Shell.new
+    end
+  end
 end

data/man/uffizzi-logout

@@ -0,0 +1,21 @@
+.\" generated with Ronn-NG/v0.9.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
+.TH "UFFIZZI\-LOGOUT" "" "February 2022" ""
+.SH "NAME"
+\fBuffizzi\-logout\fR \- log out of a Uffizzi user account
+.SH "SYNOPSIS"
+\fBuffizzi logout\fR
+.SH "DESCRIPTION"
+.nf
+The uffizzi logout command logs out of a Uffizzi user account\.
+
+For more information on logout, see:
+https://docs\.uffizzi\.com/references/cli
+.fi
+.SH "UFFIZZI WIDE FLAGS"
+.nf
+These flags are available to all commands: \-\-project\. Run $ uffizzi
+help for details\.
+.fi
+.SH "EXAMPLES"
+uffizzi logout

data/man/uffizzi-logout.ronn

@@ -0,0 +1,19 @@
+uffizzi-logout - log out of a Uffizzi user account
+================================================================
+
+## SYNOPSIS
+
+`uffizzi logout`
+
+## DESCRIPTION
+    The uffizzi logout command logs out of a Uffizzi user account.
+
+    For more information on logout, see:
+    https://docs.uffizzi.com/references/cli
+
+## UFFIZZI WIDE FLAGS
+    These flags are available to all commands: --project. Run $ uffizzi
+    help for details.
+
+## EXAMPLES
+   uffizzi logout

data/uffizzi.gemspec

@@ -33,9 +33,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'minitest-power_assert'
   spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'open3'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'pry-inline'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'ronn-ng'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-minitest'
   spec.add_development_dependency 'rubocop-rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uffizzi-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Josh Thurman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: open3
+  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: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +151,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ronn-ng
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -232,14 +260,20 @@ files:
 - lib/uffizzi.rb
 - lib/uffizzi/auth_helper.rb
 - lib/uffizzi/cli.rb
+- lib/uffizzi/cli/common.rb
 - lib/uffizzi/cli/config.rb
 - lib/uffizzi/cli/login.rb
+- lib/uffizzi/cli/logout.rb
 - lib/uffizzi/cli/projects.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/shell.rb
 - lib/uffizzi/version.rb
+- man/uffizzi-logout
+- man/uffizzi-logout.ronn
 - uffizzi.gemspec
 homepage: https://uffizzi.com
 licenses: