terraform-enterprise-client 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 006ecb0aac424adcf47e1318668b6bcbf0e9c44f
-  data.tar.gz: fb7e5b66c2143088e6768f63518a4488c2525877
+  metadata.gz: e9ea07941d8b0d4ae1c8c1046700cedc4d82c8b4
+  data.tar.gz: 05db114c2173ce71d68ef2784c725f42c8736ba8
 SHA512:
-  metadata.gz: 19e5964e0c33f4df21285d0ae17f0dd544c18a7f9e15beb2352ec62de422c9ff8b255618bf3f61c97579c62ffa3ff1d22c6be286e488e76a5d08df2b2bf7954e
-  data.tar.gz: 7f51d4076fa08f805492b05f4fdf8c1b512acc5e49d9067c708ee60bf26a95573664b737d3f90cf33ba746c1336c3891dc10691061adecebfc229170853394a2
+  metadata.gz: 344147995b1f01268bee781f5d90f7e797f8f73455fbe777091e06ac90b56525bbc21375b6f17e2f68a26625ff5b7d99365ce86fa4021ed5398332dd85bdf564
+  data.tar.gz: 09bb42afd3600006c0005e61da47a41cd6977f4f0418dbbf05d199ff8565fac0a7236261f42a18866c57e7d69a2879fd5281563c238d99858752311283d167db

data/README.md

@@ -14,6 +14,7 @@ This gem depends on these other gems for usage at runtime:
 - [rest-client](https://github.com/rest-client/rest-client)
 - [colorize](https://github.com/fazibear/colorize)
 - [thor](https://github.com/erikhuda/thor)
+- [terminal-table](https://github.com/tj/terminal-table)
 
 ## API Client
 
@@ -70,6 +71,7 @@ Installing the gem installs the `tfe` command line tool. Running `tfe help` prov
 All of the resources, actions and paraeters are documented in the tool and available through the `help` subcommand.
 
 #### Basic Usage
+
 ```shell
 ➭ tfe help
 Commands:
@@ -79,11 +81,17 @@ Commands:
   tfe workspaces <subcommand>     # Manage workspaces
 ```
 
+### Authentication
+
+There are two methods for authenticating the CLI with the Terraform Enterprise API. The first is to use the `TERRAFORM_ENTERPRISE_TOKEN` environment variable. The second is to pass in the token on the command line using the `--token` option. The command line option takes precendence over the environment variable.
+
 ### Scripting
+
 The CLI is designed to be easy to call from other scripts. A few command line options exist to control the output format to minimize the string parsing needed to extract the desired data from the output:
 
-- `no-color` (Boolean, default: false): Removes ANSI color codes from output
-- `except` (Array): Exclude particular fields from the output from being returned. This is a space-separated list of fields to be excluded from the output.
-- `only` (Array): Only return the fields selected in this space-separated list of field keys.
-- `all` (Boolean, default: false): By default most commands only return a subset of fields. Many of the APIs return additional attributes which are used by the UI and likely have little value to you. As such, they are excluded by default. This option will return all of the fields, not just the subset.
-- `value` (Boolean, default: false): The output text by default shows the key and values for each field. If this option is enabled only the value of the fields will be returned. This is particularly useful if you would like to obtain the id of a newly created resource (e.g. `tfe workspcaces create new-ws --organization my-organization --only name --value` would return only the name of the created workspace)
+- `--no-color` (Boolean, default: false): Removes ANSI color codes from output
+- `--except` (Array): Exclude particular fields from the output from being returned. This is a space-separated list of fields to be excluded from the output.
+- `--only` (Array): Only return the fields selected in this space-separated list of field keys.
+- `--all` (Boolean, default: false): By default most commands only return a subset of fields. Many of the APIs return additional attributes which are used by the UI and likely have little value to you. As such, they are excluded by default. This option will return all of the fields, not just the subset.
+- `--value` (Boolean, default: false): The output text by default shows the key and values for each field. If this option is enabled only the value of the fields will be returned. This is particularly useful if you would like to obtain the id of a newly created resource (e.g. `tfe workspcaces create new-ws --organization my-organization --only name --value` would return only the name of the created workspace)
+- `--no-table` (Boolean, default: false): For `list` subcommands format the output as a list of key/value paris instead of formatting the list in a table. 

data/lib/terraform-enterprise-client.rb

@@ -5,6 +5,8 @@ require 'terraform-enterprise/client/request'
 require 'terraform-enterprise/resource_requests/organizations'
 require 'terraform-enterprise/resource_requests/oauth-tokens'
 require 'terraform-enterprise/resource_requests/workspaces'
+require 'terraform-enterprise/resource_requests/teams'
+require 'terraform-enterprise/resource_requests/variables'
 
 module TerraformEnterprise
   class Client
@@ -14,16 +16,24 @@ module TerraformEnterprise
       @request = TerraformEnterprise::API::Request.new(options)
     end
 
-    def workspaces
-      TerraformEnterprise::API::Workspaces.new(@request)
+    def oauth_tokens
+      TerraformEnterprise::API::OAuthTokens.new(@request)
     end
 
     def organizations
       TerraformEnterprise::API::Organizations.new(@request)
     end
 
-    def oauth_tokens
-      TerraformEnterprise::API::OAuthTokens.new(@request)
+    def teams
+      TerraformEnterprise::API::Teams.new(@request)
+    end
+
+    def variables
+      TerraformEnterprise::API::Variables.new(@request)
+    end
+
+    def workspaces
+      TerraformEnterprise::API::Workspaces.new(@request)
     end
   end
 end

data/lib/terraform-enterprise-command-line.rb

@@ -4,6 +4,8 @@ require 'terraform-enterprise/version'
 require 'terraform-enterprise/commands/organizations_command'
 require 'terraform-enterprise/commands/workspaces_command'
 require 'terraform-enterprise/commands/oauth_tokens_command'
+require 'terraform-enterprise/commands/teams_command'
+require 'terraform-enterprise/commands/variables_command'
 
 module TerraformEnterprise
   class CommandLine < Thor
@@ -15,6 +17,12 @@ module TerraformEnterprise
 
     desc 'oauth_tokens <subcommand>', 'Manage OAuth tokens'
     subcommand 'oauth_tokens', TerraformEnterprise::Commands::OAuthTokensCommand
+
+    desc 'teams <subcommand>', 'Manage teams'
+    subcommand 'teams', TerraformEnterprise::Commands::TeamsCommand
+
+    desc 'variables <subcommand>', 'Manage variables'
+    subcommand 'variables', TerraformEnterprise::Commands::VariablesCommand
   end
 end
 

data/lib/terraform-enterprise/client/request.rb

@@ -5,9 +5,10 @@ module TerraformEnterprise
     class Request
       attr_accessor :base
 
-      def initialize(api_key:, host: 'https://app.terraform.io/api/v2')
+      def initialize(api_key:, host: 'https://app.terraform.io/api/v2', debug: false)
         @base    = host
         @api_key = api_key
+        @debug   = debug
         @headers = {
           'Authorization' => "Bearer #{@api_key}",
           'Content-Type' => 'application/vnd.api+json'
@@ -59,6 +60,14 @@ module TerraformEnterprise
           ex.response
         end
 
+        if @debug
+          puts "[DEBUG] [REQUEST:METHOD]  #{request[:method].to_s.upcase} #{request[:url]}"
+          puts "[DEBUG] [REQUEST:HEADERS] #{request[:headers]}"
+          puts "[DEBUG] [REQUEST:PAYLOAD] #{data}"
+          puts "[DEBUG] [RESPONSE:CODE]   #{response.code}" 
+          puts "[DEBUG] [RESPONSE:BODY]   #{response.body}" 
+        end
+
         TerraformEnterprise::API::Response.new(response)
       end
 

data/lib/terraform-enterprise/commands/command.rb

@@ -14,6 +14,7 @@ module TerraformEnterprise
       class_option :only, type: :array, desc: 'List of fields that should be displayed'
       class_option :all, type: :boolean, default: false, desc: "Return all fields, not just summary"
       class_option :value, type: :boolean, default: false, desc: 'Only return the value; i.e. do not show keys'
+      class_option :debug, type: :boolean, default: false, desc: 'Show debug logs'
 
       no_commands do
         def render(obj, default_options={})
@@ -29,6 +30,7 @@ module TerraformEnterprise
           settings           = { }
           settings[:api_key] = options[:token] || ENV['TERRAFORM_ENTERPRISE_TOKEN']
           settings[:host]    = options[:host] if options[:host]
+          settings[:debug]   = options[:debug] if options[:debug]
           TerraformEnterprise::Client.new(settings)
         end
 

data/lib/terraform-enterprise/commands/formatter.rb

@@ -20,7 +20,11 @@ module TerraformEnterprise
             end
           elsif obj.has_errors?
             obj.errors.each do |error|
-              puts "Error (#{error['status']}): #{error['title']}".red
+              if error['status'] && error['title']
+                puts "Error (#{error['status']}): #{error['title']}".red
+              else
+                puts "Error (#{obj.code}): #{error}".red
+              end
             end
           else
             puts "Unknown server response (#{obj.code})".yellow

data/lib/terraform-enterprise/commands/strings.rb

@@ -37,6 +37,17 @@ module TerraformEnterprise
         },
         attributes: { }
       },
+      teams: {
+        commands: {
+          create: 'Create a new team',
+          delete: 'Delete the team by ID',
+          list: 'List teams in organization',
+          get: 'Get team details'
+        },
+        attributes: {
+          organization: 'Organization to which this Team belongs to.'
+        }
+      },
       oauth_tokens: {
         commands: {
           list: 'List the OAuth tokens in the organization'
@@ -44,7 +55,25 @@ module TerraformEnterprise
         attributes: {
           organization: 'Organization to which this OAuth Token belongs to.'
         }
-      }
+      },
+      variables: {
+        commands: {
+          create: 'Create a new variable',
+          delete: 'Delete the variable by ID',
+          get: 'Get variable details',
+          list: 'List variables in organization',
+          update: 'Update a variable by ID',
+        },
+        attributes: {
+          organization: 'Organization to which this Variable belongs to.',
+          workspace: 'Workspace to which this Variable belongs to.',
+          category: 'The type of cateogry, probably "terrafomr" or "environment"',
+          hcl: 'Variable should be parsed using HCL',
+          sensitive:'Variable should be marked as sensitive',
+          value: 'Variable value',
+          key: 'Variable key',
+        }
+      },
     }
   end
 end

data/lib/terraform-enterprise/commands/teams_command.rb

@@ -0,0 +1,33 @@
+require 'terraform-enterprise/commands/command'
+
+module TerraformEnterprise
+  module Commands
+    class TeamsCommand < TerraformEnterprise::Commands::Command
+      ATTR_STR = STRINGS[:teams][:attributes]
+      CMD_STR = STRINGS[:teams][:commands]
+
+      desc 'list', CMD_STR[:list]
+      option :table, type: :boolean, default: true, desc: STRINGS[:options][:table]
+      option :organization, required: true, type: :string, desc: ATTR_STR[:organization]
+      def list
+        render client.teams.list(organization: options[:organization]), except: [:permissions]
+      end
+
+      desc 'create <name>', CMD_STR[:create]
+      option :organization, required: true, type: :string, desc: ATTR_STR[:organization]
+      def create(name)
+        render client.teams.create(name: name, organization: options[:organization])
+      end
+
+      desc 'get <id>', CMD_STR[:get]
+      def get(id)
+        render client.teams.get(id:id), except: [:permissions]
+      end
+
+      desc 'delete <id>', CMD_STR[:delete]
+      def delete(id)
+        render client.teams.delete(id: id), except: [:permissions]
+      end
+    end
+  end
+end

data/lib/terraform-enterprise/commands/variables_command.rb

@@ -0,0 +1,61 @@
+require 'terraform-enterprise/commands/command'
+
+module TerraformEnterprise
+  module Commands
+    class VariablesCommand < TerraformEnterprise::Commands::Command
+      ATTR_STR = STRINGS[:variables][:attributes]
+      CMD_STR = STRINGS[:variables][:commands]
+
+      desc 'list', CMD_STR[:list]
+      option :table, type: :boolean, default: true, desc: STRINGS[:options][:table]
+      option :organization, required: true, type: :string, desc: ATTR_STR[:organization]
+      option :workspace, type: :string, desc: ATTR_STR[:workspace]
+      def list
+        render client.variables.list(options)
+      end
+
+      desc 'create <key> <value>', CMD_STR[:create]
+      option :organization, required: true, type: :string, desc: ATTR_STR[:organization]
+      option :workspace, required: true, type: :string, desc: ATTR_STR[:workspace]
+      option :category, default: 'terraform', type: :string, desc: ATTR_STR[:category]
+      option :hcl, default: false, type: :boolean, desc: ATTR_STR[:hcl]
+      option :sensitive, default: false, type: :boolean, desc: ATTR_STR[:sensitive]
+      def create(key, value)
+        params = {
+          category: options[:category],
+          hcl: options[:hcl],
+          key: key,
+          organization: options[:organization],
+          sensitive: options[:sensitive],
+          value: value,
+          workspace: options[:workspace],
+        }
+        render client.variables.create(params)
+      end
+
+      desc 'update <id>', CMD_STR[:update]
+      option :hcl, type: :boolean, desc: ATTR_STR[:hcl]
+      option :sensitive, type: :boolean, desc: ATTR_STR[:sensitive]
+      option :key, type: :string, desc: ATTR_STR[:key]
+      option :value, type: :string, desc: ATTR_STR[:value]
+      def update(id)
+        params             = {id: id}
+        params[:hcl]       = options[:hcl] if options.include?('hcl')
+        params[:key]       = options[:key] if options[:key]
+        params[:sensitive] = options[:sensitive] if options.include?('sensitive')
+        params[:value]     = options[:value] if options[:value]
+        render client.variables.update(params)
+      end
+
+      desc 'get <id>', CMD_STR[:get]
+      def get(id)
+        render client.variables.get(id:id)
+      end
+
+      desc 'delete <id>', CMD_STR[:delete]
+      def delete(id)
+        render client.variables.delete(id: id)
+      end
+    end
+  end
+end

data/lib/terraform-enterprise/commands/workspaces_command.rb

@@ -28,12 +28,12 @@ module TerraformEnterprise
           name: name,
           'working-directory' => options[:working_directory] || '',
         }
-        if options[:branch] || options[:repo] || options[:oauth_token] || options[:ingress_submodules]
+        if options[:repo] && options[:oauth_token]
           repo = {}
-          repo['branch']             = options[:branch] if options[:branch]
-          repo['identifier']         = options[:repo] if options[:repo]
-          repo['oauth-token-id']     = options[:oauth_token] if options[:oauth_token]
-          repo['ingress-submodules'] = options[:ingress_submodules] if options[:ingress_submodules]
+          repo['branch']             = options[:branch] || ''
+          repo['identifier']         = options[:repo]
+          repo['oauth-token-id']     = options[:oauth_token]
+          repo['ingress-submodules'] = options[:ingress_submodules] || false
           params['vcs-repo'] = repo
         end
 

data/lib/terraform-enterprise/resource_requests/teams.rb

@@ -0,0 +1,30 @@
+require "terraform-enterprise/client/resource_request"
+
+module TerraformEnterprise  
+  module API
+    class Teams < TerraformEnterprise::API::ResourceRequest
+      
+      def list(params={})
+        @request.get(:organizations, params[:organization], :teams)
+      end
+
+      def get(params={})
+        @request.get(:teams, params[:id])
+      end
+
+      def create(params={})
+        org = params.delete(:organization)
+        data = {
+          attributes: params,
+          type: 'teams'
+        }
+
+        @request.post(:organizations, org, :teams, data: data)
+      end
+
+      def delete(params={})
+        @request.delete(:teams, params[:id])
+      end
+    end
+  end
+end

data/lib/terraform-enterprise/resource_requests/variables.rb

@@ -0,0 +1,48 @@
+require "terraform-enterprise/client/resource_request"
+
+module TerraformEnterprise  
+  module API
+    class Variables < TerraformEnterprise::API::ResourceRequest
+      
+      def list(params={})
+        filter = {}
+        filter[:workspace] = {name: params[:workspace]} if params[:workspace]
+        filter[:organization] = {name: params[:organization]} if params[:organization]
+        @request.get(:vars, {filter:filter})
+      end
+
+      def get(params={})
+        @request.get(:vars, params[:id])
+      end
+
+      def create(params={})
+        org = params.delete(:organization)
+        workspace = params.delete(:workspace)
+        data = {
+          attributes: params,
+          type: 'vars',
+        }
+        filter = {
+          organization: {name: org},
+          workspace: {name: workspace}
+        }
+
+        @request.post(:vars, {data: data, filter: filter})
+      end
+
+      def update(params={})
+        id = params.delete(:id)
+        data = {
+          attributes: params,
+          type: 'vars',
+        }
+
+        @request.patch(:vars, id, data: data)
+      end
+
+      def delete(params={})
+        @request.delete(:vars, params[:id])
+      end
+    end
+  end
+end

data/lib/terraform-enterprise/version.rb

@@ -1,3 +1,3 @@
 module TerraformEnterprise  
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terraform-enterprise-client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Maciej Skierkowski
@@ -113,9 +113,13 @@ files:
 - lib/terraform-enterprise/commands/oauth_tokens_command.rb
 - lib/terraform-enterprise/commands/organizations_command.rb
 - lib/terraform-enterprise/commands/strings.rb
+- lib/terraform-enterprise/commands/teams_command.rb
+- lib/terraform-enterprise/commands/variables_command.rb
 - lib/terraform-enterprise/commands/workspaces_command.rb
 - lib/terraform-enterprise/resource_requests/oauth-tokens.rb
 - lib/terraform-enterprise/resource_requests/organizations.rb
+- lib/terraform-enterprise/resource_requests/teams.rb
+- lib/terraform-enterprise/resource_requests/variables.rb
 - lib/terraform-enterprise/resource_requests/workspaces.rb
 - lib/terraform-enterprise/version.rb
 homepage: http://github.com/skierkowski/terraform-enterprise-client