terraform-enterprise-client 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8caf7297375b0e1c572b31e0bb298da08e51eb73
-  data.tar.gz: eb3d6a9a8b143f1dc67c4446e2f666e7a29ab17b
+SHA256:
+  metadata.gz: 7415a893ed2fafcf00c51edaf233a85de15b5f435121b3ed728d427e1d9c135f
+  data.tar.gz: 913f4bed946e14b29d2308ac6bd297da6262c6332214d35b5ee75cccfedd7cc3
 SHA512:
-  metadata.gz: 41a04fbd7f45997ad85f8f13bc27d8a6c2b86369df17cd001f763198340353e3ae80441b9e4b796bc8876e1647e05587dffc9aa83639b70a3b72e5761ccc456a
-  data.tar.gz: 41615f92de594de92c6dd8224e6d82a73eb21f6c2d93cda01b2295eb2fb7c31edabc9d7f88f544b0c3f15e2350b42444081694a391b36acf01068d9e433f4f0a
+  metadata.gz: 318ac9fd413f452d4275ffacfcb482880b73554134536ff9009a54a73c19579b7e9f1a40b17f9445cb2f6d604adf6cf30e74e4385b33ec48ae3b351668aca35d
+  data.tar.gz: 8b5d7f675667ed6679b97ca11c3663d297a2daeb4f8d91fe50b5685ecd307b18e85d1dd99356610332d97e8a9af804e0bc189c4d05def7e54f2dd3447c63e3fe

data/README.md

@@ -1,20 +1,20 @@
-# Terraform Enterprise API Client & Command Line Tool
-A simple Ruby API client library and command line tool for the [Terraform Enterprise API](https://www.terraform.io/docs/enterprise/api/index.html).
+# Terraform Enterprise API Client
+A simple Ruby API client library for the [Terraform Enterprise API](https://www.terraform.io/docs/enterprise/api/index.html).
 
+[![Gem Version](https://badge.fury.io/rb/terraform-enterprise-client.svg)](https://badge.fury.io/rb/terraform-enterprise-client)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1fd90e8dda31d1d402e8/maintainability)](https://codeclimate.com/github/skierkowski/terraform-enterprise-client/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/1fd90e8dda31d1d402e8/test_coverage)](https://codeclimate.com/github/skierkowski/terraform-enterprise-client/test_coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/skierkowski/terraform-enterprise-client.svg)](https://gemnasium.com/github.com/skierkowski/terraform-enterprise-client)
+[![Inline docs](http://inch-ci.org/github/skierkowski/terraform-enterprise-client.svg?branch=master)](http://inch-ci.org/github/skierkowski/terraform-enterprise-client)
 
 
 ## Requirements
 
-MRI Ruby 2.0 and newer are supported. Alternative interpreters compatible with 2.0+ should work as well.
-
-Earlier Ruby versions such as 1.8.7, 1.9.2, and 1.9.3 may work but are not supported.
+MRI Ruby 2.3 and newer are supported. Alternative interpreters compatible with 2.3+ should work as well.
 
 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
 
@@ -27,8 +27,8 @@ This gem depends on these other gems for usage at runtime:
 ```ruby
 require 'terraform-enterprise-client'
 
-api_key = ENV['TERRAFORM_ENTERPRISE_TOKEN']
-client = TerraformEnterprise::Client.new(api_key: api_key)
+token = ENV['TFE_TOKEN']
+client = TerraformEnterprise::API::Client.new(token: token)
 
 # Create a new organization
 org = client.organizations.create(name:'my-org',email:'maciej@skierkowski.com')
@@ -51,47 +51,5 @@ client.organizations.delete(name:'my-org')
 
 There are two main settings that can be modified on initialization:
 
-- `:api_key` (required) - which specifies the API key (formerly called ATLAS_TOKEN)
+- `:token` (required) - which specifies the API key (formerly called ATLAS_TOKEN)
 - `:host` - a hostname other than the default (`app.terraform.io`) for usage with private installs
-
-### Resources
-
-The number of supported resources is a subset of the resources exposed via the Terraform Enterprise API. Additional resources will be added in future releases. Current supported resources include:
-
-- `Client#workspaces`
-- `Client#organizations`
-- `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
-```
-
-### 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-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

@@ -1,39 +1 @@
-require 'json'
-require 'rest-client'
-
-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
-    attr_accessor :base
-
-    def initialize(options={})
-      @request = TerraformEnterprise::API::Request.new(options)
-    end
-
-    def oauth_tokens
-      TerraformEnterprise::API::OAuthTokens.new(@request)
-    end
-
-    def organizations
-      TerraformEnterprise::API::Organizations.new(@request)
-    end
-
-    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
+require 'terraform_enterprise'

data/lib/terraform-enterprise.rb

@@ -0,0 +1 @@
+require 'terraform_enterprise'

data/lib/terraform_enterprise.rb

@@ -0,0 +1,2 @@
+require_relative 'terraform_enterprise/api/client'
+require_relative 'terraform_enterprise/api/version'

data/lib/terraform_enterprise/api/client.rb

@@ -0,0 +1,62 @@
+require 'json'
+require 'rest-client'
+
+require_relative 'request'
+require_relative 'resource_requests/configuration_versions'
+require_relative 'resource_requests/oauth_tokens'
+require_relative 'resource_requests/organizations'
+require_relative 'resource_requests/policies'
+require_relative 'resource_requests/policy_checks'
+require_relative 'resource_requests/runs'
+require_relative 'resource_requests/teams'
+require_relative 'resource_requests/variables'
+require_relative 'resource_requests/workspaces'
+
+module TerraformEnterprise
+  module API
+    # The Terraform Enterprise Client class
+    class Client
+      attr_accessor :base
+
+      def initialize(options = {})
+        @request = TerraformEnterprise::API::Request.new(options)
+      end
+
+      def configuration_versions
+        TerraformEnterprise::API::ConfigurationVersions.new(@request)
+      end
+
+      def oauth_tokens
+        TerraformEnterprise::API::OAuthTokens.new(@request)
+      end
+
+      def organizations
+        TerraformEnterprise::API::Organizations.new(@request)
+      end
+
+      def teams
+        TerraformEnterprise::API::Teams.new(@request)
+      end
+
+      def variables
+        TerraformEnterprise::API::Variables.new(@request)
+      end
+
+      def workspaces
+        TerraformEnterprise::API::Workspaces.new(@request)
+      end
+
+      def policies
+        TerraformEnterprise::API::Policies.new(@request)
+      end
+
+      def policy_checks
+        TerraformEnterprise::API::PolicyChecks.new(@request)
+      end
+
+      def runs
+        TerraformEnterprise::API::Runs.new(@request)
+      end
+    end
+  end
+end

data/lib/terraform_enterprise/api/request.rb

@@ -0,0 +1,97 @@
+require_relative 'response'
+
+module TerraformEnterprise
+  module API
+    # A wrapper for HTTP JSON-API requests to provide convenience request
+    # method wrappers.
+    class Request
+      DEFAULT_DEBUG = false
+      DEFAULT_HOST = 'https://app.terraform.io'.freeze
+
+      def initialize(options = {})
+        @host    = options[:host] || DEFAULT_HOST
+        @token   = options[:token]
+        @debug   = options[:debug] || DEFAULT_DEBUG
+      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, path, data)
+      end
+
+      def patch(*path)
+        data = path.pop if path.last.is_a?(Hash)
+        request(:patch, path, data)
+      end
+
+      def request(method, path, data = {}, extra_headers = {})
+        request_options = define_request(method, path, data, extra_headers)
+        response        = execute(request_options)
+        debug(request_options, response, data) if @debug
+        TerraformEnterprise::API::Response.new(response)
+      end
+
+      private
+
+      def base
+        "#{@host}/api/v2"
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{@token}",
+          'Content-Type' => 'application/vnd.api+json'
+        }
+      end
+
+      def define_request(method, path, data = {}, extra_headers = {})
+        request_options = {
+          method:  method,
+          url:     uri(path),
+          headers: headers.merge(extra_headers)
+        }
+        if %i[get delete].include?(method)
+          request_options[:headers][:params] = data
+        else
+          request_options[:payload] = data.is_a?(String) ? data : data.to_json
+        end
+        request_options
+      end
+
+      def execute(request_params)
+        RestClient::Request.execute(request_params)
+      rescue RestClient::ExceptionWithResponse => ex
+        ex.response
+      end
+
+      def debug(http_request, http_response, data)
+        http_method = http_request[:method].to_s.upcase
+        puts "[DEBUG] [REQUEST:METHOD]  #{http_method} #{http_request[:url]}"
+        puts "[DEBUG] [REQUEST:HEADERS] #{http_request[:headers]}"
+        puts "[DEBUG] [REQUEST:PAYLOAD] #{data}"
+        puts "[DEBUG] [RESPONSE:CODE]   #{http_response.code}"
+        puts "[DEBUG] [RESPONSE:BODY]   #{http_response.body}"
+      end
+
+      def uri(path = [])
+        return path if path.is_a?(String) && path.start_with?('http')
+        "#{base}/#{path.map(&:to_s).join('/')}"
+      end
+    end
+  end
+end

data/lib/terraform_enterprise/api/resource.rb

@@ -0,0 +1,48 @@
+module TerraformEnterprise
+  module API
+    # A class wrapper for JSON-API resources
+    class Resource
+      attr_reader :body
+
+      def initialize(body)
+        @body = body
+      end
+
+      def errors?
+        !errors.empty?
+      end
+
+      def data
+        @body['data']
+      end
+
+      def id
+        data['id']
+      end
+
+      def type
+        data['type']
+      end
+
+      def attributes
+        data['attributes'] || {}
+      end
+
+      def relationships
+        data['relationships'] || {}
+      end
+
+      def links
+        data['links'] || []
+      end
+
+      def errors
+        data['errors'] || []
+      end
+
+      def included
+        (body['included'] || []).map{ |resource| Resource.new('data' => resource)}
+      end
+    end
+  end
+end

data/lib/terraform_enterprise/api/resource_request.rb

@@ -0,0 +1,12 @@
+module TerraformEnterprise
+  module API
+    # Class is used to get access to the request and parameters for each
+    # resource request from the client
+    class ResourceRequest
+      def initialize(request, params = {})
+        @request = request
+        @params  = params
+      end
+    end
+  end
+end

data/lib/terraform_enterprise/api/resource_requests/configuration_versions.rb

@@ -0,0 +1,28 @@
+require 'terraform_enterprise/api/resource_request'
+
+module TerraformEnterprise
+  module API
+    # Variables resource request
+    class ConfigurationVersions < TerraformEnterprise::API::ResourceRequest
+      def list(params = {})
+        @request.get(:workspaces, params[:workspace], 'configuration-versions')
+      end
+
+      def get(params = {})
+        @request.get('configuration-versions', params[:id])
+      end
+
+      def create(params = {})
+        data = {
+          type: 'configuration-versions'
+        }
+        @request.post(:workspaces, params[:workspace], 'configuration-versions', data: data)
+      end
+
+      def upload(params = {})
+        headers = { 'Content-Type' => 'application/octet-stream' }
+        @request.request(:put, params[:url], params[:content], headers)
+      end
+    end
+  end
+end

data/lib/{terraform-enterprise/resource_requests/oauth-tokens.rb → terraform_enterprise/api/resource_requests/oauth_tokens.rb}

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

data/lib/{terraform-enterprise → terraform_enterprise/api}/resource_requests/organizations.rb

@@ -1,17 +1,18 @@
-require "terraform-enterprise/client/resource_request"
+require 'terraform_enterprise/api/resource_request'
 
-module TerraformEnterprise  
+module TerraformEnterprise
   module API
+    # Organization resource request
     class Organizations < TerraformEnterprise::API::ResourceRequest
-      def list(params={})
+      def list
         @request.get(:organizations)
       end
 
-      def get(params={})
+      def get(params = {})
         @request.get(:organizations, params[:name])
       end
 
-      def create(params={})
+      def create(params = {})
         data = {
           attributes: params,
           type: 'organizations'
@@ -20,9 +21,9 @@ module TerraformEnterprise
         @request.post(:organizations, data: data)
       end
 
-      def delete(params={})
+      def delete(params = {})
         @request.delete(:organizations, params[:name])
       end
     end
   end
-end
+end