terraform-enterprise-client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2572998533d43f6cb6c2ae8101d9d32ed3b6eabd5f43840ec44cb8b591e60c0d
-  data.tar.gz: d2879313a717aeecbe4823176e20dd41b54a5908bc4c43341222c04a362d7e6e
+SHA1:
+  metadata.gz: 006ecb0aac424adcf47e1318668b6bcbf0e9c44f
+  data.tar.gz: fb7e5b66c2143088e6768f63518a4488c2525877
 SHA512:
-  metadata.gz: 6a84339b00360c9013a07ab06d318906a92f539bb80e56a37086d9506615b132c50f454fd6c96273f6f28e77bbfb0b4382b6d57d620ad21abf9fd8480a92cfe1
-  data.tar.gz: a14aa20dc4558da50e66b0b5e732a45c5caa52bcda69afd5d903055934d633336df7294035cecad0572bdedc5630eb201c6e5bd163b698ee4fa646516d88f7fc
+  metadata.gz: 19e5964e0c33f4df21285d0ae17f0dd544c18a7f9e15beb2352ec62de422c9ff8b255618bf3f61c97579c62ffa3ff1d22c6be286e488e76a5d08df2b2bf7954e
+  data.tar.gz: 7f51d4076fa08f805492b05f4fdf8c1b512acc5e49d9067c708ee60bf26a95573664b737d3f90cf33ba746c1336c3891dc10691061adecebfc229170853394a2

data/README.md

@@ -15,11 +15,13 @@ This gem depends on these other gems for usage at runtime:
 - [colorize](https://github.com/fazibear/colorize)
 - [thor](https://github.com/erikhuda/thor)
 
-## Usage
+## API Client
 
+### Usage
 
 
-### Basic Example
+
+#### Basic Example
 
 ```ruby
 require 'terraform-enterprise-client'
@@ -57,4 +59,31 @@ The number of supported resources is a subset of the resources exposed via the T
 
 - `Client#workspaces`
 - `Client#organizations`
-- `Client#oauth_tokens`
+- `Client#oauth_tokens`
+
+## Command Line Tool
+
+Installing the gem installs the `tfe` command line tool. Running `tfe help` provides the help information and list of available subcomands.
+
+### Usage
+
+All of the resources, actions and paraeters are documented in the tool and available through the `help` subcommand.
+
+#### Basic Usage
+```shell
+➭ tfe help
+Commands:
+  tfe help [COMMAND]              # Describe available commands or one specific command
+  tfe oauth_tokens <subcommand>   # Manage OAuth tokens
+  tfe organizations <subcommand>  # Manage organizations
+  tfe workspaces <subcommand>     # Manage workspaces
+```
+
+### 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)

data/lib/terraform-enterprise-client.rb

@@ -1,93 +1,29 @@
 require 'json'
 require 'rest-client'
 
-require 'terraform-enterprise/resources/organizations'
-require 'terraform-enterprise/resources/oauth-tokens'
-require 'terraform-enterprise/resources/workspaces'
+require 'terraform-enterprise/client/request'
+require 'terraform-enterprise/resource_requests/organizations'
+require 'terraform-enterprise/resource_requests/oauth-tokens'
+require 'terraform-enterprise/resource_requests/workspaces'
 
 module TerraformEnterprise
   class Client
     attr_accessor :base
 
-    def initialize(api_key:, host: 'https://app.terraform.io/api/v2')
-      @base    = host
-      @api_key = api_key
-      @headers = {
-        'Authorization' => "Bearer #{@api_key}",
-        'Content-Type' => 'application/vnd.api+json'
-      }
+    def initialize(options={})
+      @request = TerraformEnterprise::API::Request.new(options)
     end
 
     def workspaces
-      TerraformEnterprise::Workspaces.new(self)
+      TerraformEnterprise::API::Workspaces.new(@request)
     end
 
     def organizations
-      TerraformEnterprise::Organizations.new(self)
+      TerraformEnterprise::API::Organizations.new(@request)
     end
 
     def oauth_tokens
-      TerraformEnterprise::OAuthTokens.new(self)
-    end
-
-    def get(*path)
-      data = path.pop if path.last.is_a?(Hash)
-      request(:get, path, data)
-    end
-
-    def delete(*path)
-      data = path.pop if path.last.is_a?(Hash)
-      request(:delete, path,data)
-    end
-
-    def post(*path)
-      data = path.pop if path.last.is_a?(Hash)
-      request(:post, path, data)
-    end
-
-    def put(*path)
-      data = path.pop if path.last.is_a?(Hash)
-      request(:put,data,data)
-    end
-
-    def patch(*path)
-      data = path.pop if path.last.is_a?(Hash)
-      request(:patch,path,data)
-    end
-
-    def request(method, path, data={}, headers={})
-      request = {
-        method:  method,
-        url:     uri(path),
-        headers: @headers.merge(headers || {})
-      }
-      if data
-        if method==:get || method==:delete
-          request[:headers][:params] = data
-        else
-          request[:payload] = data.is_a?(String) ? data : data.to_json
-        end
-      end
-
-      response = begin
-        RestClient::Request.execute(request)
-      rescue RestClient::ExceptionWithResponse => ex
-        ex.response
-      end
-
-      if response.headers[:content_type] && response.headers[:content_type].include?('json')
-        return_data = JSON.parse(response) || {}
-      else
-        return_data = response.body
-      end
-      {'code' => response.code, 'body' => return_data}
-    end
-
-    private
-
-    def uri(path=[])
-      return path if path.is_a?(String) && path.start_with?("http")
-      "#{@base}/#{path.map{|p| p.to_s}.join('/')}"
+      TerraformEnterprise::API::OAuthTokens.new(@request)
     end
   end
 end

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

@@ -0,0 +1,73 @@
+require 'terraform-enterprise/client/response'
+
+module TerraformEnterprise
+  module API
+    class Request
+      attr_accessor :base
+
+      def initialize(api_key:, host: 'https://app.terraform.io/api/v2')
+        @base    = host
+        @api_key = api_key
+        @headers = {
+          'Authorization' => "Bearer #{@api_key}",
+          'Content-Type' => 'application/vnd.api+json'
+        }
+      end
+
+      def get(*path)
+        data = path.pop if path.last.is_a?(Hash)
+        request(:get, path, data)
+      end
+
+      def delete(*path)
+        data = path.pop if path.last.is_a?(Hash)
+        request(:delete, path,data)
+      end
+
+      def post(*path)
+        data = path.pop if path.last.is_a?(Hash)
+        request(:post, path, data)
+      end
+
+      def put(*path)
+        data = path.pop if path.last.is_a?(Hash)
+        request(:put,data,data)
+      end
+
+      def patch(*path)
+        data = path.pop if path.last.is_a?(Hash)
+        request(:patch,path,data)
+      end
+
+      def request(method, path, data={}, headers={})
+        request = {
+          method:  method,
+          url:     uri(path),
+          headers: @headers.merge(headers || {})
+        }
+        if data
+          if method==:get || method==:delete
+            request[:headers][:params] = data
+          else
+            request[:payload] = data.is_a?(String) ? data : data.to_json
+          end
+        end
+
+        response = begin
+          RestClient::Request.execute(request)
+        rescue RestClient::ExceptionWithResponse => ex
+          ex.response
+        end
+
+        TerraformEnterprise::API::Response.new(response)
+      end
+
+      private
+
+      def uri(path=[])
+        return path if path.is_a?(String) && path.start_with?("http")
+        "#{@base}/#{path.map{|p| p.to_s}.join('/')}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module TerraformEnterprise
+  module API
+    class Resource
+      attr_accessor :type, :attributes, :id, :relationships, :links, :errors, :success
+      def initialize(data)
+        @id               = data['id']
+        @type             = data['type']
+        @attributes       = data['attributes'] || {}
+        @relationships    = data['relationships'] || {}
+        @links            = data['links'] || []
+        @errors           = data['errors'] || []
+      end
+
+      def has_errors?
+        !@errors.empty?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module TerraformEnterprise
+  module API
+    class ResourceRequest
+      def initialize(request, params={})
+        @request = request
+        @params  = params
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'terraform-enterprise/client/resource'
+
+module TerraformEnterprise
+  module API
+    class Response
+      attr_reader :code, :body, :data, :resource, :resources, :errors
+      def initialize(rest_client_response)
+        @code = rest_client_response.code
+        @body = parse(rest_client_response.body)
+        @data = (@body.is_a?(Hash) && @body['data']) ? @body['data'] : @body
+        if @data.is_a?(Hash)
+          @resource = TerraformEnterprise::API::Resource.new(@data) 
+        end
+        if @data.is_a?(Array) && @data.all?{|a| a.is_a?(Hash)}
+          @resources = @data.map do |item|
+            TerraformEnterprise::API::Resource.new(item)
+          end
+        end
+        if has_errors?
+          @errors = @body['errors']
+        end
+      end
+
+      def has_errors?
+        @body.is_a?(Hash) && @body['errors'] && @body['errors'].is_a?(Array)
+      end
+
+      private
+
+      def parse(str)
+        JSON.parse(str)
+      rescue JSON::ParserError
+        str
+      end
+    end
+  end
+end

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

@@ -1,33 +1,28 @@
-require 'yaml'
-require 'colorize'
+require 'json'
 
 require 'terraform-enterprise-client'
+require 'terraform-enterprise/commands/formatter'
+require 'terraform-enterprise/commands/strings'
 
 module TerraformEnterprise
   module Commands
     class Command < Thor
-      class_option :color, type: :boolean, default: true
+      class_option :host, type: :string, desc: 'Set host address for private Terraform Enterprise'
+      class_option :token, type: :string, desc: 'Set the auth token, defaults to TERRAFORM_ENTERPRISE_TOKEN environment variable'
+      class_option :color, type: :boolean, default: true, desc: 'If disabled the ANSI color codes will not be used'
+      class_option :except, type: :array, desc: 'List of fields that should not be displayed'
+      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'
 
       no_commands do
-        def render(obj)
-          String.disable_colorization = !options['color']
-
-          if obj['code'] && obj['body']
-            if obj['code'] == 200
-              puts "Success".green
-              data = obj['body']['data'] ? obj['body']['data'] : obj['body']
-              puts data.to_yaml
-            elsif
-              if obj['body']['errors']
-                obj['body']['errors'].each do |error|
-                  puts "Error (#{error['status']}): #{error['title']}".red
-                end
-              else
-              end
-            end
+        def render(obj, default_options={})
+          calculated_options = if(options[:all])
+            symbolize_keys(options.to_h)
           else
-            puts obj.to_yaml
+            symbolize_keys(default_options).merge(symbolize_keys(options.to_h))
           end
+          TerraformEnterprise::Commands::Formatter.render obj, calculated_options
         end
 
         def client
@@ -36,6 +31,13 @@ module TerraformEnterprise
           settings[:host]    = options[:host] if options[:host]
           TerraformEnterprise::Client.new(settings)
         end
+
+        private
+
+        def symbolize_keys(hash)
+          JSON.parse(JSON[hash], symbolize_names: true)
+        end
+
       end
     end
   end

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

@@ -0,0 +1,86 @@
+require 'yaml'
+require 'colorize'
+require 'terminal-table'
+
+require 'terraform-enterprise-client'
+
+module TerraformEnterprise
+  module Commands
+    module Formatter
+      def self.render(obj, options={})
+        String.disable_colorization = !options[:color]
+        if obj.is_a?(TerraformEnterprise::API::Response)
+          if obj.code >= 200 && obj.code < 300
+            if obj.resources
+              puts render_resource_table(obj.resources, options)
+            elsif obj.resource
+              puts render_resource(obj.resource, options) 
+            else
+              puts "Success (#{obj.code})".green
+            end
+          elsif obj.has_errors?
+            obj.errors.each do |error|
+              puts "Error (#{error['status']}): #{error['title']}".red
+            end
+          else
+            puts "Unknown server response (#{obj.code})".yellow
+            puts obj.body
+          end
+        else
+          puts "Unknown content".yellow
+          puts obj
+        end
+      end
+
+      private
+
+      def self.parse_resource(resource, options)
+        parsed_resource = flatten_dotted_hash(resource.attributes)
+        parsed_resource = {'id' => resource.id}.merge(parsed_resource) if resource.id
+        (options[:except] || []).each do |excluded|
+          parsed_resource.delete_if {|key,value| key.to_s.start_with?(excluded.to_s) }
+        end
+        if options[:only] && options[:only].length > 0
+          parsed_resource.select! do |key, value|
+            options[:only].any?{ |included| key.to_s.start_with?(included.to_s) }
+          end
+        end
+        parsed_resource
+      end
+
+      def self.render_resource(resource, options)
+        parsed_resource = parse_resource(resource, options)
+        parsed_resource.keys.map do |key|
+          value = parsed_resource[key]
+          options[:value] ? value : "#{key.bold}: #{value}"
+        end.join("\n")
+      end
+
+      def self.render_resource_table(resources, options)
+        if options[:table] && !options[:value]
+          parsed_resources = resources.map{|resource| parse_resource(resource,options)}
+          keys = parsed_resources.map{|resource| resource.keys }.flatten.uniq
+          rows = parsed_resources.map do |resource|
+            keys.map{|key| resource[key]}
+          end
+          table = Terminal::Table.new headings: keys, rows: rows
+          table
+        else
+          out = resources.map{|resource| render_resource(resource, options)}.join("\n#{'-' * 10}\n")
+        end
+      end
+
+      def self.flatten_hash(h,f=[],g={})
+        return g.update({ f=>h }) unless h.is_a?(Hash) || h.is_a?(Array)
+        h.each { |k,r| flatten_hash(r,f+[k],g) } if h.is_a?(Hash)
+        h.each_with_index { |r, k| flatten_hash(r,f+[k],g) } if h.is_a?(Array)
+        g
+      end
+
+      def self.flatten_dotted_hash(source)
+        flat = flatten_hash(source)
+        flat.keys.each_with_object({}) { |key, h| h[key.join('.')] = flat[key] }  
+      end
+    end
+  end
+end

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

@@ -4,11 +4,10 @@ require 'terraform-enterprise-client'
 module TerraformEnterprise
   module Commands
     class OAuthTokensCommand < TerraformEnterprise::Commands::Command
-      class_option :host, type: :string
-      class_option :token, type: :string
-      class_option :organization, required: true, type: :string, desc: 'Organization name'
+      class_option :organization, required: true, type: :string, desc: STRINGS[:oauth_tokens][:attributes][:organization]
 
-      desc 'list', 'Lists all OAuth Tokens'
+      desc 'list', STRINGS[:oauth_tokens][:commands][:list]
+      option :table, type: :boolean, default: true, desc: STRINGS[:options][:table]
       def list
         render client.oauth_tokens.list(options)
       end

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

@@ -3,25 +3,25 @@ require 'terraform-enterprise/commands/command'
 module TerraformEnterprise
   module Commands
     class OrganizationsCommand < TerraformEnterprise::Commands::Command
-      class_option :host, type: :string
-      class_option :token, type: :string
+      CMD_STR = STRINGS[:organizations][:commands]
 
-      desc 'list', 'Lists all organizations'
+      desc 'list', CMD_STR[:list]
+      option :table, type: :boolean, default: true, desc: STRINGS[:options][:table]
       def list
-        render client.organizations.list
+        render client.organizations.list, only: [:id, :name, 'created-at', :email]
       end
 
-      desc 'create <name> <email>', 'Creates a new organization'
+      desc 'create <name> <email>', CMD_STR[:create]
       def create(name, email)
         render client.organizations.create(name: name, email: email)
       end
 
-      desc 'get <name>', 'Gets the organization details'
+      desc 'get <name>', CMD_STR[:get]
       def get(name)
         render client.organizations.get(name:name)
       end
 
-      desc 'delete <name>', 'Deletes the organization'
+      desc 'delete <name>', CMD_STR[:delete]
       def delete(name)
         render client.organizations.delete(name:name)
       end

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

@@ -0,0 +1,50 @@
+
+
+module TerraformEnterprise
+  module Commands
+    STRINGS = {
+      options: {
+        table: 'Format list output as a table'
+      },
+      workspaces: {
+        attributes: {
+          terraform_version: 'Version of Terraform to use for this workspace.',
+          working_directory: 'Relative path that Terraform will execute within.',
+          oauth_token: 'VCS Connection (OAuth Conection + Token) to use as identified; obtained from the oauth_tokens subcommand.',
+          branch: 'Repository branch that Terraform will execute from.',
+          ingress_submodules: 'Submodules should be fetched when cloning the VCS repository.',
+          repo: 'Reference to VCS repository in the format :org/:repo.',
+          import_legacy: 'Specifies the legacy Environment to use as the source of the migration/',
+          organization: 'Organization to which this workspaces belongs to.',
+          auto_apply: 'Auto-apply enabled',
+        },
+        commands: {
+          create: 'Create a new workspace',
+          list: 'List worksapces in the organization',
+          get: 'Get workspace details by name',
+          delete: 'Delete the workspace',
+          update: 'Update the workspace',
+          lock: 'Lock the workspace by workspace ID',
+          unlock: 'Unlock the workspace by workspace ID'
+        }
+      },
+      organizations: {
+        commands: {
+          create: 'Create a new organization',
+          list: 'List all the organizations',
+          get: 'Get organization details by name',
+          delete: 'Delete the organization',
+        },
+        attributes: { }
+      },
+      oauth_tokens: {
+        commands: {
+          list: 'List the OAuth tokens in the organization'
+        },
+        attributes: {
+          organization: 'Organization to which this OAuth Token belongs to.'
+        }
+      }
+    }
+  end
+end

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

@@ -3,78 +3,84 @@ require 'terraform-enterprise/commands/command'
 module TerraformEnterprise
   module Commands
     class WorkspacesCommand < TerraformEnterprise::Commands::Command
-      class_option :host, type: :string, desc: 'Hostname of private Terraform Enterprise'
-      class_option :token, type: :string, desc: 'Access token'
-      class_option :organization, required: true, type: :string, desc: 'Organization name'
+      ATTR_STR = STRINGS[:workspaces][:attributes]
+      CMD_STR = STRINGS[:workspaces][:commands]
 
-      desc 'list', 'Lists all workspaces in the organization'
+      desc 'list', CMD_STR[:list]
+      option :organization, required: true, type: :string, desc: ATTR_STR[:organization]
+      option :table, type: :boolean, default: true, desc: STRINGS[:options][:table]
       def list
-        render client.workspaces.list(options)
+        render client.workspaces.list(options), except:[:permissions, :actions, :environment, 'created-at']
       end
 
-      desc 'create <name>', 'Creates a new organization'
-      option :terraform_version, type: :string, desc: "Version of Terraform to use for this workspace."
-      option :working_directory, type: :string, desc: "Relative path that Terraform will execute within."
-      option :oauth_token, type: :string, desc: 'VCS Connection (OAuth Conection + Token) to use as identified; obtained from the oauth_tokens subcommand.'
-      option :branch, type: :string, desc: "Repository branch that Terraform will execute from."
-      option :ingress_submodules, type: :boolean, default: false, desc: "Submodules should be fetched when cloning the VCS repository."
-      option :repo, type: :string, desc: 'Reference to VCS repository in the format :org/:repo'
-      option :import_repo, type: :string, desc: ''
+      desc 'create <name>', CMD_STR[:create]
+      option :terraform_version, type: :string, desc: ATTR_STR[:terraform_version]
+      option :working_directory, type: :string, desc: ATTR_STR[:working_directory]
+      option :oauth_token, type: :string, desc: ATTR_STR[:oauth_token]
+      option :branch, type: :string, desc: ATTR_STR[:branch]
+      option :ingress_submodules, type: :boolean, desc: ATTR_STR[:ingress_submodules]
+      option :repo, type: :string, desc: ATTR_STR[:repos]
+      option :import_legacy_environment, type: :string, desc: ATTR_STR[:import_legacy]
+      option :organization, required: true, type: :string, desc: ATTR_STR[:organization]
       def create(name)
         params = {
           organization: options[:organization],
           name: name,
           'working-directory' => options[:working_directory] || '',
-          'vcs-repo' => {
-            'branch'             => options[:branch] || '',
-            'identifier'         => options[:repo] || '',
-            'oauth-token-id'     => options[:oauth_token] || '',
-            'ingress-submodules' => options[:ingress_submodules]
-          }
         }
+        if options[:branch] || options[:repo] || options[:oauth_token] || options[:ingress_submodules]
+          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]
+          params['vcs-repo'] = repo
+        end
 
-        params['migration-environment'] = options[:import_repo] if options[:import_repo]
+        params['migration-environment'] = options[:import_legacy_environment] if options[:import_legacy_environment]
         params['terraform_version']     = options[:terraform_version] if options[:terraform_version]
-        
-        render client.workspaces.create(params)
+        render client.workspaces.create(params), except:[:permissions, :actions, :environment]
       end
 
-      desc 'get <name>', 'Gets the workspace details'
+      desc 'get <name>', CMD_STR[:get]
+      option :organization, required: true, type: :string, desc: ATTR_STR[:organization]
       def get(name)
         params = {
           organization: options[:organization],
           workspace: name
         }
-        render client.workspaces.get(params)
+        render client.workspaces.get(params), except:[:permissions, :actions, :environment]
       end
 
-      desc 'delete <name>', 'Deletes the workspace'
+      desc 'delete <name>', CMD_STR[:delete]
+      option :organization, required: true, type: :string, desc: ATTR_STR[:organization]
       def delete(name)
         params = {
           organization: options[:organization],
           workspace: name
         }
-        render client.workspaces.delete(params)
+        render client.workspaces.delete(params), except:[:permissions, :actions, :environment]
       end
 
-      desc 'update <name>', 'Update the workspace'
-      option :working_directory, type: :string, desc: "Relative path that Terraform will execute within."
-      option :terraform_version, type: :string, desc: "Version of Terraform to use for this workspace."
-      option :auto_apply, type: :boolean, desc: 'Auto-apply enabled'
+      desc 'update <name>', CMD_STR[:update]
+      option :working_directory, type: :string, desc: ATTR_STR[:working_directory]
+      option :terraform_version, type: :string, desc: ATTR_STR[:terraform_version]
+      option :auto_apply, type: :boolean, desc: ATTR_STR[:auto_apply]
+      option :organization, required: true, type: :string, desc: ATTR_STR[:organization]
       def update(name)
         params = options
         params[:workspace] = name
-        render client.workspaces.update(params)
+        render client.workspaces.update(params), except:[:permissions, :actions, :environment]
       end
 
-      desc 'lock <id>', "Locks the workspace"
+      desc 'lock <id>', CMD_STR[:lock]
       def lock(id)
-        render client.workspaces.action(action: :lock, id: id)
+        render client.workspaces.action(action: :lock, id: id), except:[:permissions, :actions, :environment]
       end
 
-      desc 'unlock <id>', 'Unlocks the workspace'
+      desc 'unlock <id>', CMD_STR[:unlock]
       def unlock(id)
-        render client.workspaces.action(action: :unlock, id: id)
+        render client.workspaces.action(action: :unlock, id: id), except:[:permissions, :actions, :environment]
       end
     end
   end

data/lib/terraform-enterprise/resource_requests/oauth-tokens.rb

@@ -0,0 +1,11 @@
+require "terraform-enterprise/client/resource_request"
+
+module TerraformEnterprise  
+  module API
+    class OAuthTokens < TerraformEnterprise::API::ResourceRequest
+      def list(params={})
+        @request.get(:organizations, params[:organization], 'oauth-tokens')
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,45 @@
+require "terraform-enterprise/client/resource_request"
+
+module TerraformEnterprise  
+  module API
+    class Workspaces < TerraformEnterprise::API::ResourceRequest
+      def list(params={})
+        @request.get(:organizations, params[:organization], :workspaces)
+      end
+
+      def get(params={})
+        @request.get(:organizations, params[:organization], :workspaces, params[:workspace])
+      end
+
+      def create(params={})
+        org = params.delete(:organization)
+        data = {
+          attributes: params,
+          type: 'workspaces'
+        }
+
+        @request.post(:organizations, org, :workspaces, data: data)
+      end
+
+      def update(params={})
+        org = params.delete(:organization)
+        id  = params.delete(:workspace)
+
+        data = {
+          attributes: params,
+          type: 'workspaces'
+        }
+
+        @request.patch(:organizations, org, :workspaces, id, data: data)
+      end
+
+      def delete(params={})
+        @request.delete(:organizations, params[:organization], :workspaces, params[:workspace])
+      end
+
+      def action(params={})
+        @request.post(:workspaces, params[:id], :actions, params[:action].to_sym)
+      end
+    end
+  end
+end

data/lib/terraform-enterprise/version.rb

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

metadata

@@ -1,20 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: terraform-enterprise-client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Maciej Skierkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
   type: :runtime
@@ -22,6 +25,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
 - !ruby/object:Gem::Dependency
@@ -29,6 +35,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
   type: :runtime
@@ -36,6 +45,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
 - !ruby/object:Gem::Dependency
@@ -43,6 +55,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.20.0
   type: :runtime
@@ -50,8 +65,31 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 description: " Ruby client that supports all of the Terraform Enterprise API methods. "
 email: maciej@skierkowski.com
 executables:
@@ -66,17 +104,23 @@ files:
 - bin/tfe
 - lib/terraform-enterprise-client.rb
 - lib/terraform-enterprise-command-line.rb
+- lib/terraform-enterprise/client/request.rb
+- lib/terraform-enterprise/client/resource.rb
+- lib/terraform-enterprise/client/resource_request.rb
+- lib/terraform-enterprise/client/response.rb
 - lib/terraform-enterprise/commands/command.rb
+- lib/terraform-enterprise/commands/formatter.rb
 - 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/workspaces_command.rb
-- lib/terraform-enterprise/resources/oauth-tokens.rb
-- lib/terraform-enterprise/resources/organizations.rb
-- lib/terraform-enterprise/resources/workspaces.rb
-- lib/terraform-enterprise/resources_client.rb
+- lib/terraform-enterprise/resource_requests/oauth-tokens.rb
+- lib/terraform-enterprise/resource_requests/organizations.rb
+- lib/terraform-enterprise/resource_requests/workspaces.rb
 - lib/terraform-enterprise/version.rb
 homepage: http://github.com/skierkowski/terraform-enterprise-client
-licenses: []
+licenses:
+- MPL-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -94,8 +138,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for the official Terraform Enterprise API
 test_files: []
+has_rdoc: 

data/lib/terraform-enterprise/resources/oauth-tokens.rb

@@ -1,9 +0,0 @@
-require "terraform-enterprise/resources_client"
-
-module TerraformEnterprise  
-  class OAuthTokens < ResourcesClient
-    def list(params={})
-      @client.get(:organizations, params[:organization], 'oauth-tokens')
-    end
-  end
-end

data/lib/terraform-enterprise/resources/organizations.rb

@@ -1,26 +0,0 @@
-require "terraform-enterprise/resources_client"
-
-module TerraformEnterprise  
-  class Organizations < ResourcesClient
-    def list(params={})
-      @client.get(:organizations)
-    end
-
-    def get(params={})
-      @client.get(:organizations, params[:name])
-    end
-
-    def create(params={})
-      data = {
-        attributes: params,
-        type: 'organizations'
-      }
-
-      @client.post(:organizations, data: data)
-    end
-
-    def delete(params={})
-      @client.delete(:organizations, params[:name])
-    end
-  end
-end

data/lib/terraform-enterprise/resources/workspaces.rb

@@ -1,43 +0,0 @@
-require "terraform-enterprise/resources_client"
-
-module TerraformEnterprise  
-  class Workspaces < ResourcesClient
-    def list(params={})
-      @client.get(:organizations, params[:organization], :workspaces)
-    end
-
-    def get(params={})
-      @client.get(:organizations, params[:organization], :workspaces, params[:workspace])
-    end
-
-    def create(params={})
-      org = params.delete(:organization)
-      data = {
-        attributes: params,
-        type: 'workspaces'
-      }
-
-      @client.post(:organizations, org, :workspaces, data: data)
-    end
-
-    def update(params={})
-      org = params.delete(:organization)
-      id  = params.delete(:workspace)
-
-      data = {
-        attributes: params,
-        type: 'workspaces'
-      }
-
-      @client.patch(:organizations, org, :workspaces, id, data: data)
-    end
-
-    def delete(params={})
-      @client.delete(:organizations, params[:organization], :workspaces, params[:workspace])
-    end
-
-    def action(params={})
-      @client.post(:workspaces, params[:id], :actions, params[:action].to_sym)
-    end
-  end
-end

data/lib/terraform-enterprise/resources_client.rb

@@ -1,8 +0,0 @@
-module TerraformEnterprise  
-  class ResourcesClient
-    def initialize(client, params={})
-      @client = client
-      @params = params
-    end
-  end
-end