train-digitalocean 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e05cb718b32c0df695a406df5e36b7e44d03f3c1
+  data.tar.gz: 4ae64fe0705e82d9eb5e1bd339bcba0b41e79b83
+SHA512:
+  metadata.gz: 75ab53e959b99382ebd54141bcfe3ba73369bc33af73587c24d81d92b137f0ffc74c2e0145df841aeba7076540d7671e8959cb4bc1c2712b843815764183bf79
+  data.tar.gz: 49b597f3965293a1d51faac2ecc17032249f604e5b86cebe26036cf59de6a6b7de828aaa27419a3cc39bd751e5992bec16f2aa92fd7ebd07a7b5eff7675c922a

data/Gemfile

@@ -0,0 +1,13 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+gemspec
+
+# Remaining group is only used for development.
+group :development do
+  gem 'bundler'
+  gem 'byebug'
+  gem 'inspec', '>= 2.2.112' # We need InSpec for the test harness while developing.
+  gem 'minitest'
+  gem 'rake'
+  gem 'rubocop', '= 0.49.1' # Need to keep in sync with main InSpec project, so config files will work
+end

data/README.md

@@ -0,0 +1,69 @@
+# Digitalocean transport plugin for Train
+
+This plugin allows applications that rely on Train to communicate with the Digitalocean API.  For example, InSpec uses this to perform compliance checks against Digitalocean infrastructure. Train plugins are managed by InSpec CLI.
+
+## Usage
+
+When used in combination with the [InSpec Digitalocean resource pack](https://github.com/chris-rock/inspec-digitalocean) you can e.g. verify droplets:
+
+```ruby
+describe digitalocean_droplet(id: '123456') do
+  it { should exist }
+  its('name') { should eq 'nginx-web-ams3' }
+  its('image') { should eq 'ubuntu-16-04-x64' }
+  its('region') { should eq 'ams3' }
+  its('size') { should eq 's-1vcpu-1gb' }
+end
+```
+
+## Preconditions
+
+- InSpec 3 or later.
+- [Digitalocean API key](https://cloud.digitalocean.com/account/api/tokens)
+
+
+## Installation
+
+Train plugins are distributed as gems.  You may choose to manage the gem yourself, but if you are an InSpec user, InSPec can handle it for you.
+
+Simply run:
+
+```
+$ inspec plugin install train-digitalocean
+```
+
+In order to use this example, you need to create a [DigitalOcean API Token](https://cloud.digitalocean.com/account/api/tokens) and export it as an environment variable.
+
+```bash
+export DIGITALOCEAN_TOKEN="Put Your Token Here" 
+```
+
+Verify the plugin and the connection to Digitalocean
+
+```
+$ inspec detect -t digitalocean://
+
+== Platform Details
+
+Name:      digitalocean
+Families:  cloud, api
+Release:   0.1.0
+```
+
+## Authenticating to Digitalocean
+
+You need to set the `DIGITALOCEAN_TOKEN` environment variable with your credentials.
+
+## Reporting Issues
+
+Bugs, typos, limitations, and frustrations are welcome to be reported through the [GitHub issues page for the train-digitalocean project](https://github.com/chris-rock/train-digitalocean/issues).
+
+You may also ask questions in the #inspec channel of the CHef Community Slack team.  However, for an issue to get traction, please report it as a github issue.
+
+### Development Process
+
+If you wish to contribute to this plugin, please use the usual fork-branch-push-PR cycle.  All functional changes need new tests, and bugfixes are expected to include a new test that demonstrates the bug.
+
+### Reference Information
+
+[Plugin Development](https://github.com/inspec/train/blob/master/docs/dev/plugins.md) is documented on the `train` project on GitHub.

data/lib/train-digitalocean.rb

@@ -0,0 +1,7 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+
+require 'train-digitalocean/version'
+require 'train-digitalocean/transport'
+require 'train-digitalocean/platform'
+require 'train-digitalocean/connection'

data/lib/train-digitalocean/connection.rb

@@ -0,0 +1,44 @@
+require 'droplet_kit'
+require 'train-digitalocean/platform'
+
+module TrainPlugins
+  module Digitalocean
+    class Connection < Train::Plugins::Transport::BaseConnection
+      include TrainPlugins::Digitalocean::Platform
+
+      def initialize(options)
+        msg = 'You need to set the Digitalocean access token via \'export DIGITALOCEAN_TOKEN=.\''
+        if options.nil? || options[:access_token].nil?
+          raise Train::TransportError, msg
+        end
+
+        super(options)
+
+        # check account to verify authentication
+        begin
+          @uuid = droplet_client.account.info.uuid
+        rescue DropletKit::Error
+          raise Train::TransportError, msg
+        end
+      end
+
+      def local?
+        false
+      end
+
+      def uri
+        "digitalocean://"
+      end
+
+      def droplet_client
+        klass = ::DropletKit::Client
+        return klass.new(access_token: @options[:access_token]) unless cache_enabled?(:api_call)
+        @cache[:api_call][klass.to_s.to_sym] ||= klass.new(access_token: @options[:access_token])
+      end
+
+      def unique_identifier
+        @uuid
+      end
+    end
+  end
+end

data/lib/train-digitalocean/platform.rb

@@ -0,0 +1,8 @@
+module TrainPlugins::Digitalocean
+  module Platform
+    def platform
+      Train::Platforms.name('digitalocean').in_family('cloud')
+      force_platform!('digitalocean', release: TrainPlugins::Digitalocean::VERSION)
+    end
+  end
+end

data/lib/train-digitalocean/transport.rb

@@ -0,0 +1,13 @@
+require 'train-digitalocean/connection'
+
+module TrainPlugins
+  module Digitalocean
+    class Transport < Train.plugin(1)
+      name 'digitalocean'
+      option :access_token, default: ENV['DIGITALOCEAN_TOKEN']
+      def connection(_instance_opts = nil)
+        @connection ||= TrainPlugins::Digitalocean::Connection.new(@options)
+      end
+    end
+  end
+end

data/lib/train-digitalocean/version.rb

@@ -0,0 +1,5 @@
+module TrainPlugins
+  module Digitalocean
+    VERSION = '0.1.0'.freeze
+  end
+end

data/train-digitalocean.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'train-digitalocean/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'train-digitalocean'
+  spec.version       = TrainPlugins::Digitalocean::VERSION
+  spec.authors       = ['Christoph Hartmann']
+  spec.email         = ['chris@lollyrock.com']
+  spec.summary       = "Digitalocean plugin for InSpec's Backend"
+  spec.description   = 'This plugin provides the backend handling for InSpec to talk to digitalocean'
+  spec.homepage      = 'https://github.com/chris-rock/train-digitaloceann'
+  spec.license       = 'Apache-2.0'
+  spec.files = %w{
+    README.md train-digitalocean.gemspec Gemfile
+  } + Dir.glob(
+    'lib/**/*', File::FNM_DOTMATCH
+  ).reject { |f| File.directory?(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency 'droplet_kit', '~> 2.4'
+  spec.add_dependency 'train', '~> 1.4'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: train-digitalocean
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christoph Hartmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: droplet_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: train
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: This plugin provides the backend handling for InSpec to talk to digitalocean
+email:
+- chris@lollyrock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- lib/train-digitalocean.rb
+- lib/train-digitalocean/connection.rb
+- lib/train-digitalocean/platform.rb
+- lib/train-digitalocean/transport.rb
+- lib/train-digitalocean/version.rb
+- train-digitalocean.gemspec
+homepage: https://github.com/chris-rock/train-digitaloceann
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Digitalocean plugin for InSpec's Backend
+test_files: []