civo_cli 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acd3180b6eaaf19c77c92333d99c03ca4c6718f64a9418f09efc7f3fd35733da
-  data.tar.gz: 9e5d92ca791a4c30aab31084592add09506abd00a7574aca2c881e9ea821b210
+  metadata.gz: d861f11c17a9e24b51e0853bf40c4953f9a1aa45af1b7722f922d197bbeee969
+  data.tar.gz: 7edd364cba9bebb15b74dfffff2ca5e23008599486e0b1b7f2345220b052cc60
 SHA512:
-  metadata.gz: 5d18746327d2def6e43d25585eac8a9712185f6d609fa0ebdc4e5a6b7e2b38e0ee27f601757ce05a89fdffb94ac86a0b8f4d66aa2f12395bda655d3bf88c1aaa
-  data.tar.gz: 902519bfa7cdafd3e9f246616ce4695391c70b8b3a39625728662164bd1a3ae92eb61e48db49a73077daeaedeeee59a7fb60d243816b339b81877952705a7081
+  metadata.gz: dc8151061ee863bef860070924feef1c8b740cd15269510020f62cf7335ad5d6543d2624f056698cf9c2ca9b014808613c77285278d39dcdfc104636585c6e4d
+  data.tar.gz: f08fe71cfb4fe4d892ace4caff14337fc4f1af0090fa23321db7892715e60804235011a2974fc9d85a285fcda9cd4ddbc462727c16e74c70c94143690347885b

data/CHANGELOG.md

@@ -3,7 +3,11 @@ All notable changes to the Civo CLI will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.2.5] - 2019-06-28
+## [0.2.6] - 2019-07-04
+### Fixed
+- Slightly badly named method caused confusion, clarified by renaming the method and correcting usage of it
+
+## [0.2.5] - 2019-07-04
 ### Added
 - Added support for using part of an ID instead of a whole ID
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    civo_cli (0.2.5)
+    civo_cli (0.2.6)
       civo (>= 1.2.1)
       colorize
       json

data/README.md

@@ -3,6 +3,8 @@
 ## Introduction
 Civo CLI is a tool to manage your [Civo.com](https://www.civo.com) account from the terminal. The [Civo web control panel](https://www.civo.com/account/) has a user-friendly interface for managing your account, but in case you want to automate or run scripts on your account, or have multiple complex services, the command-line interface outlined here will be useful. This guide will cover the set-up and usage of the Civo CLI tool with examples.
 
+**STATUS:** This project is currently under active development and maintainance.
+
 ## Table of contents
 - [Introduction](#introduction)
 - [Set-Up](#set-up) 

data/lib/blueprint.rb

@@ -19,7 +19,7 @@ module CivoCLI
     desc "show ID", "show the details for a single blueprint"
     def show(id)
       CivoCLI::Config.set_api_auth
-      blueprint = detect_blueprint_id(id)
+      blueprint = detect_blueprint(id)
       puts "                ID : #{blueprint.id}"
       puts "              Name : #{blueprint.name}"
       puts "       Template ID : #{blueprint.template_id}"
@@ -45,7 +45,7 @@ module CivoCLI
     desc "update ID", "update the blueprint with ID"
     def update(id)
       CivoCLI::Config.set_api_auth
-      params = {id: detect_blueprint_id(id)}
+      params = {id: detect_blueprint(id).id}
       params[:dsl_content] = File.read(options["content-file"]) unless options["content-file"].nil?
       params[:template_id] = options["template-id"] unless options["template-id"].nil?
       params[:name] = options["name"] unless options["name"].nil?
@@ -86,7 +86,7 @@ module CivoCLI
     desc "remove ID", "remove the blueprint with ID"
     def remove(id)
       CivoCLI::Config.set_api_auth
-      Civo::Blueprint.remove(detect_blueprint_id(id))
+      Civo::Blueprint.remove(detect_blueprint(id))
     rescue Flexirest::HTTPForbiddenClientException => e
       puts "Sorry, you don't have access to this feature".colorize(:red)
       exit 1
@@ -100,7 +100,7 @@ module CivoCLI
 
     private
 
-    def detect_blueprint_id(id)
+    def detect_blueprint(id)
       result = []
       Civo::Blueprint.all.items.each do |blueprint|
         result << blueprint

data/lib/civo_cli/version.rb

@@ -1,3 +1,3 @@
 module CivoCLI
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/lib/instance.rb

@@ -15,9 +15,8 @@ module CivoCLI
     if CivoCLI::Config.get_meta("admin")
       desc "high-cpu", "list high CPU using instances"
       def high_cpu
-        # {ENV["CIVO_API_VERSION"] || "1"}/instances/high_cpu"
         CivoCLI::Config.set_api_auth
-        instance = detect_instance_id(id)
+        instance = detect_instance(id)
 
         Civo::Instance.high_cpu
       end
@@ -25,10 +24,9 @@ module CivoCLI
 
     desc "show ID/HOSTNAME", "show an instance by ID or hostname"
     def show(id)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id", requires: [:id]
       CivoCLI::Config.set_api_auth
       rows = []
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
 
       sizes = Civo::Size.all(all: true).items
       ssh_keys = Civo::SshKey.all.items
@@ -141,7 +139,7 @@ module CivoCLI
     desc "tags ID/HOSTNAME 'tag1 tag2 tag3...'", "retag instance by ID (input no tags to clear all tags)"
     def tags(id, newtags = nil)
       CivoCLI::Config.set_api_auth
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
 
       Civo::Instance.tags(id: instance.id, tags: newtags)
       puts "Updated tags on #{instance.hostname.colorize(:green)}. Use 'civo instance show #{instance.hostname}' to see the current tags.'"
@@ -151,7 +149,6 @@ module CivoCLI
     end
 
     desc "update ID/HOSTNAME [--name] [--notes]", "update details of instance"
-
     option :name
     option :notes
     long_desc <<-LONGDESC
@@ -159,7 +156,7 @@ module CivoCLI
     LONGDESC
     def update(id)
       CivoCLI::Config.set_api_auth
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
 
       if options[:name]
         Civo::Instance.update(id: instance.id, hostname: options[:name])
@@ -176,9 +173,8 @@ module CivoCLI
 
     desc "remove ID/HOSTNAME", "removes an instance with ID/hostname entered (use with caution!)"
     def remove(id)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id", requires: [:id], send_delete_body: true
       CivoCLI::Config.set_api_auth
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
 
       puts "Removing instance #{instance.hostname.colorize(:red)}"
       instance.remove
@@ -190,10 +186,9 @@ module CivoCLI
 
     desc "reboot ID/HOSTNAME", "reboots instance with ID/hostname entered"
     def reboot(id)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/reboots", requires: [:id]
       CivoCLI::Config.set_api_auth
 
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
       puts "Rebooting #{instance.hostname.colorize(:red)}. Use 'civo instance show #{instance.hostname}' to see the current status."
       instance.reboot
     rescue Flexirest::HTTPException => e
@@ -204,10 +199,9 @@ module CivoCLI
 
     desc "soft-reboot ID/HOSTNAME", "soft-reboots instance with ID entered"
     def soft_reboot(id)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/soft_reboots", requires: [:id]
       CivoCLI::Config.set_api_auth
 
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
       puts "Soft-rebooting #{instance.hostname.colorize(:red)}. Use 'civo instance show #{instance.hostname}' to see the current status."
       instance.soft_reboot
     rescue Flexirest::HTTPException => e
@@ -217,9 +211,8 @@ module CivoCLI
 
     desc "console ID/HOSTNAME", "outputs a URL for a web-based console for instance with ID provided"
     def console(id)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/console", requires: [:id]
       CivoCLI::Config.set_api_auth
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
       puts "Access #{instance.hostname.colorize(:green)} at #{instance.console.url}"
     rescue Flexirest::HTTPException => e
       puts e.result.reason.colorize(:red)
@@ -228,9 +221,8 @@ module CivoCLI
 
     desc "stop ID/HOSTNAME", "shuts down the instance with ID provided"
     def stop(id)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/stop", requires: [:id]
       CivoCLI::Config.set_api_auth
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
       puts "Stopping #{instance.hostname.colorize(:red)}. Use 'civo instance show #{instance.hostname}' to see the current status."
       Civo::Instance.stop(id: instance.id)
     rescue Flexirest::HTTPException => e
@@ -240,10 +232,9 @@ module CivoCLI
 
     desc "start ID/HOSTNAME", "starts a stopped instance with ID provided"
     def start(id)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/start", requires: [:id]
       CivoCLI::Config.set_api_auth
 
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
       puts "Starting #{instance.hostname.colorize(:green)}. Use 'civo instance show #{instance.hostname}' to see the current status."
       instance.start
     rescue Flexirest::HTTPException => e
@@ -253,10 +244,9 @@ module CivoCLI
 
     desc "upgrade ID/HOSTNAME new-size", "Upgrade instance with ID to size provided (see civo sizes for size names)"
     def upgrade(id, new_size)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/resize", requires: [:size, :id]
       CivoCLI::Config.set_api_auth
 
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
 
       Civo::Instance.upgrade(id: instance.id, size: new_size)
       puts "Resizing #{instance.hostname.colorize(:green)} to #{new_size.colorize(:red)}. Use 'civo instance show #{instance.hostname}' to see the current status."
@@ -267,10 +257,9 @@ module CivoCLI
 
     desc "move-ip ID/HOSTNAME IP_Address", "move a public IP_Address to target instance"
     def move_ip(id, ip_address)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/ip/:ip", requires: [:ip, :id]
       CivoCLI::Config.set_api_auth
 
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
 
       Civo::Instance.move_ip(id: instance.id, ip: ip_address)
       puts "Moved public IP #{ip_address} to instance #{instance.hostname}"
@@ -279,22 +268,11 @@ module CivoCLI
       exit 1
     end
 
-    # desc "", ""
-    # def rescue
-    #   # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/rescue", requires: [:id]
-    # end
-
-    # desc "", ""
-    # def unrescue
-    #   # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/unrescue", requires: [:id]
-    # end
-
     desc "firewall ID/HOSTNAME firewall_id", "set instance with ID/HOSTNAME to use firewall with firewall_id"
     def firewall(id, firewall_id)
-      # {ENV["CIVO_API_VERSION"] || "1"}/instances/:id/firewall", requires: [:firewall_id, :id]
       CivoCLI::Config.set_api_auth
 
-      instance = detect_instance_id(id)
+      instance = detect_instance(id)
 
       Civo::Instance.firewall(id: instance.id, firewall_id: firewall_id)
       puts "Set #{instance.hostname.colorize(:green)} to use firewall '#{firewall_id.colorize(:yellow)}'"
@@ -307,7 +285,7 @@ module CivoCLI
 
     private
 
-    def detect_instance_id(id)
+    def detect_instance(id)
       result = []
       Civo::Instance.all.items.each do |instance|
         result << instance

data/lib/kubernetes.rb

@@ -16,7 +16,7 @@ module CivoCLI
     def show(id)
       CivoCLI::Config.set_api_auth
       rows = []
-      cluster = detect_cluster_id(id)
+      cluster = detect_cluster(id)
 
       puts "                ID : #{cluster.id}"
       puts "              Name : #{cluster.name}"
@@ -48,7 +48,7 @@ module CivoCLI
     def config(id)
       CivoCLI::Config.set_api_auth
       rows = []
-      cluster = detect_cluster_id(id)
+      cluster = detect_cluster(id)
       puts cluster.kubeconfig
     rescue Flexirest::HTTPException => e
       puts e.result.reason.colorize(:red)
@@ -98,7 +98,7 @@ module CivoCLI
     LONGDESC
     def rename(id)
       CivoCLI::Config.set_api_auth
-      cluster = detect_cluster_id(id)
+      cluster = detect_cluster(id)
 
       if options[:name]
         Civo::Kubernetes.update(id: cluster.id, name: options[:name])
@@ -116,7 +116,7 @@ module CivoCLI
     LONGDESC
     def scale(id)
       CivoCLI::Config.set_api_auth
-      cluster = detect_cluster_id(id)
+      cluster = detect_cluster(id)
 
       if options[:nodes]
         Civo::Kubernetes.update(id: cluster.id, num_target_nodes: options[:nodes])
@@ -131,7 +131,7 @@ module CivoCLI
     desc "remove ID/NAME", "removes an entire Kubernetes cluster with ID/name entered (use with caution!)"
     def remove(id)
       CivoCLI::Config.set_api_auth
-      cluster = detect_cluster_id(id)
+      cluster = detect_cluster(id)
 
       puts "Removing Kubernetes cluster #{cluster.name.colorize(:red)}"
       cluster.remove
@@ -145,7 +145,7 @@ module CivoCLI
 
     private
 
-    def detect_cluster_id(id)
+    def detect_cluster(id)
       result = []
       Civo::Kubernetes.all.items.each do |cluster|
         result << cluster

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: civo_cli
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Andy Jeffries