terraform-binary 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d1f9f99440bc5f77ef5a9eb1392ec230e5eb8d1
+  data.tar.gz: c98f3853e5d569c41d5db0defcb73f0ebf98e0c6
+SHA512:
+  metadata.gz: cda26dc2f9eda741b959511a68100bb34a1750b70c95582f44fc66943c715d6624bb8dc756e6f62e171213efe08456a08e2372c868c344baa9e4739340a074e3
+  data.tar.gz: 7cd81d61c9c60b1103faf951d63d4c462a854c4a9c741212b76d329f0a88928b701ee3590fb8a43302e202c82257925302abdda22aff6290cbbcda664802c28c

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4
+deploy:
+  provider: rubygems
+  api_key:
+    secure: r43ZO/TYFG+0JKl2422Gv7PGNTP4sQQE6+91GTXAZ27ctkv51sNggeJTHYFVW4Ogju3w3QALz6p1G1hbs1abit6egFokiCLPAffr+ltsJRFdwJeSMpGXWoQIEdVmJM0FkIu9ujhd3RNWGzYC/lS3K8grBd/zyPGqYuayjkuIGL7QURWPLyTdYFIYMreRf+8/fYXDRUbNGCpIy0RlV4SpPyQzj4NKRjr1CBfSVjF3ke/edWW3ktMufHsZ5fIW4kvxSzkkGl9wHJsP2OO+ZaJ6xyLq7bsY49NcqHX5hs3GTKgRrisp8pTWckdAdFEPtoPefZFR5a+kyyuZBR1Z9rDKmJW2Deh/4xN74pfUY+FCrNoVS7uYi3XteGE0U8Fyb+eJcvseQrJcm1xd1FbCTTFiwhOPCjEXyUASzhrjrM2i8CZATxrg/2+8VQuH5UP7ET0z/cpB4dudkGecnjanWiL0nQbmRHc/DnhEn3maA94qscIrwUdz45OwaJyuD4gaxo5UDxX0xK4U1C1tyQisaZaLOAhEaLbHM5JEkoB5RGa+K3r2x+WqZVaeE65t/rXhJfVManzVU82zrhIg2aAm+sMIatpWgt949zCnNXctOSXIhyoOrsCOfuyRLQJB6cQFgDIIsA2JqJLRl/C8VAKYc4tQLJyJzBxmjC/l3SGSJUebXoo=
+  on:
+    tags: true

data/.yardopts

@@ -0,0 +1,3 @@
+-m markdown
+-
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in terraform-binary.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nathan Cazell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+[![Gem Version](https://badge.fury.io/rb/terraform-binary.svg)](https://badge.fury.io/rb/terraform-binary)
+[![Build Status](https://travis-ci.org/NathanTCz/terraform-binary.svg?branch=master)](https://travis-ci.org/NathanTCz/terraform-binary)
+[![Coverage Status](https://coveralls.io/repos/github/NathanTCz/terraform-binary/badge.svg?branch=master)](https://coveralls.io/github/NathanTCz/terraform-binary?branch=master)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/terraform-binary)
+# Terraform::Binary
+
+A gem to install and interface with HashiCorp's Terraform utility
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'terraform-binary'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install terraform-binary
+
+## Usage
+
+You need to specify which version of [HashiCorp Terraform](https://www.terraform.io/downloads.html) to use. You can also specify where to save the binary file.
+
+```ruby
+require 'terraform/binary'
+
+Terraform::Binary.configure do |config|
+  config.version = '1.0.4'
+  config.download_path = '/tmp'
+end
+```
+
+### Dynamic Methods
+
+The {Terraform::Binary} module will automagically map method calls to `terraform` commands. This serves to better support future versions of `terraform` and potentially new commands. For example, the equivalent of `terraform plan test/dir` in Ruby:
+
+```ruby
+Terraform::Binary.plan('test/dir')
+```
+
+If you call a method not supported by the `terraform` binary, you will get a {Terraform::Binary::Command::CommandFailure} exception.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/terraform-binary.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "terraform/binary"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/terraform/binary.rb

@@ -0,0 +1,66 @@
+require 'os'
+
+require 'terraform/binary/version'
+require 'terraform/binary/helpers'
+require 'terraform/binary/compressor'
+require 'terraform/binary/executable'
+require 'terraform/binary/command'
+
+# This module handles downloading and extracting of the associated binary as well
+# as providing a dynamic namespace and ruby client for sub-commands of said binary
+module Terraform
+  # The Binary namespace handles sub-commands using {#method_missing} metaprogramming
+  # as well as the global configuration object
+  module Binary
+
+    # @!attribute config
+    #   @return [Configuration] the global configuration object
+    attr_writer :config
+
+    module_function
+
+    # defines the @config class variable
+    def config
+      @config ||= Configuration.new
+    end
+
+    # Set the global settings. See the {file:README.md README} for more information
+    def configure
+      yield(config)
+    end
+
+    # This method maps Terraform::Binary method calls to Terraform sub-commands
+    # Ex. to run `terraform plan -machine-readable test/dir`:
+    #
+    # ```ruby
+    # Terraform::Binary.plan('-machine-readable test/dir')
+    # ```
+    #
+    # @note if the method is an invalid sub-command or if the command fails
+    #   you will get a {Command::CommandFailure} exception
+    # @since 0.2.0
+    def method_missing(method, *args, &block)
+      if method.to_s =~ /(\w+)/
+        Terraform::Binary::Helpers.debug("#{method.to_s.downcase} #{args.join(' ')}")
+        Command.run("#{method.to_s.downcase} #{args.join(' ')}")
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, *)
+      method =~ /(\w+)/ || super
+    end
+
+    # This class holds the global configuration items
+    class Configuration
+      attr_accessor :version
+      attr_accessor :download_path
+
+      def initialize
+        @version = TERRAFORM_VERSION
+        @download_path = '/tmp'
+      end
+    end
+  end
+end

data/lib/terraform/binary/command.rb

@@ -0,0 +1,28 @@
+module Terraform
+  module Binary
+    # This module handles running the actual CLI commands
+    module Command
+      module_function
+
+      # Raised when a command either fails or is invalid
+      class CommandFailure < StandardError; end
+
+      # Runs the given command with `Core::Kernel.system`
+      # Example `run('sub-command -var "key=value" -machine-readable')`
+      # @param [String] command the full sub-command to run (including cli arguments)
+      # @return [String] true or {CommandFailure}
+      def run(command)
+        system("#{binary} #{command}") || (raise CommandFailure)
+      end
+
+      # Downloads, extracts and returns the path to the binary
+      # @return [String] absolute path of the binary
+      def binary
+        e = Executable.new
+        e.download
+        e.extract
+        e.binary
+      end
+    end
+  end
+end

data/lib/terraform/binary/compressor.rb

@@ -0,0 +1,56 @@
+require 'zip'
+
+module Terraform
+  module Binary
+    # This class is used to zip and unzip files and directories
+    class Compressor
+      class << self
+        include Terraform::Binary::Helpers
+
+        # Zip the input directory.
+        def write(input_dir, output_file)
+          entries = Dir.entries(input_dir)
+          entries.delete('.')
+          entries.delete('..')
+          io = Zip::File.open(output_file, Zip::File::CREATE)
+
+          write_entries(entries, '', io, input_dir, output_file)
+          io.close
+        end
+
+        # Unzip the input zipfile
+        def extract(input_file, output_dir)
+          Zip::File.open(input_file) do |zip_file|
+            # Handle entries one by one
+            zip_file.each do |entry|
+              # Extract to file/directory/symlink
+              dest_file = "#{output_dir}/#{entry.name}"
+              debug("Extracting to #{dest_file}")
+              entry.extract(dest_file)
+            end
+          end
+        end
+
+        private
+
+        # A helper method to make the recursion work.
+        def write_entries(entries, path, io, input_dir, output_file)
+          entries.each do |e|
+            zip_file_path = path == '' ? e : File.join(path, e)
+            disk_file_path = File.join(input_dir, zip_file_path)
+
+            if File.directory?(disk_file_path)
+              io.mkdir(zip_file_path)
+              subdir = Dir.entries(disk_file_path)
+              subdir.delete('.')
+              subdir.delete('..')
+              write_entries(subdir, zip_file_path, io, input_dir, output_file)
+            else
+              io.get_output_stream(zip_file_path) { |f| f.puts(File.open(disk_file_path, 'rb').read) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/terraform/binary/executable.rb

@@ -0,0 +1,82 @@
+module Terraform
+  module Binary
+    # This class handles downloading, extracting, and saving the associated
+    # binary file
+    class Executable
+      include Terraform::Binary::Helpers
+
+      # Raised when the current platform is unsupported
+      class PlatformUnsupported < StandardError; end
+
+      # The download URI for the binary package
+      TERRAFORM_DOWNLOAD_URI = 'releases.hashicorp.com'.freeze
+
+      # Loads global config values and creates the download directory if the
+      # current platform is supported
+      def initialize
+        @terraform_version = Terraform::Binary.config.version
+        @download_path = "#{Terraform::Binary.config.download_path.chomp('/')}/terraform-binary/#{@terraform_version}/bin"
+        @download_filename = "#{@terraform_version}-terraform.zip"
+
+        FileUtils.mkdir_p @download_path
+
+        raise PlatformUnsupported unless supported?
+      end
+
+      # Returns the path to the binary if it exists
+      # @return [String] absolute path of the binary
+      def binary
+        Dir["#{@download_path}/terraform*"][0]
+      end
+
+      # Downloads the zipfile from the origin
+      def download
+        return if binary_exist?
+
+        msg("Downloading https://#{download_domain}/#{download_uri}")
+
+        require 'open-uri'
+
+        File.open("#{@download_path}/#{@download_filename}", 'wb') do |saved_file|
+          # the following "open" is provided by open-uri
+          open("https://#{download_domain}/#{download_uri}", 'rb') do |read_file|
+            saved_file.write(read_file.read)
+          end
+        end
+      end
+
+      # Extracts the binary from the zipfile and makes it executable
+      def extract
+        return if binary_exist?
+
+        Compressor.extract("#{@download_path}/#{@download_filename}", @download_path)
+        make_exe
+      end
+
+      private
+
+      def binary_exist?
+        !binary.nil?
+      end
+
+      def supported?
+        OS.freebsd? || OS.mac? || OS.windows? || OS.linux?
+      end
+
+      def make_exe
+        FileUtils.chmod('a+x', binary) if binary_exist?
+      end
+
+      def download_uri
+        "terraform/#{@terraform_version}/terraform_#{@terraform_version}_freebsd_amd64.zip" if OS.freebsd?
+        "terraform/#{@terraform_version}/terraform_#{@terraform_version}_darwin_amd64.zip" if OS.mac?
+        "terraform/#{@terraform_version}/terraform_#{@terraform_version}_windows_amd64.zip" if OS.windows?
+        "terraform/#{@terraform_version}/terraform_#{@terraform_version}_linux_amd64.zip" if OS.linux?
+      end
+
+      def download_domain
+        TERRAFORM_DOWNLOAD_URI
+      end
+    end
+  end
+end

data/lib/terraform/binary/helpers.rb

@@ -0,0 +1,38 @@
+module Terraform
+  module Binary
+    # Generic helper methods
+    module Helpers
+      module_function
+
+      # Runs given commands using mixlib-shellout
+      def system_command(*command_args)
+        cmd = Mixlib::ShellOut.new(*command_args)
+        cmd.run_command
+        cmd
+      end
+
+      # prints to `stderr`
+      def err(message)
+        stderr.print("#{message}\n")
+      end
+
+      # prints to `stdout`
+      def msg(message)
+        stdout.print("#{message}\n")
+      end
+
+      # prints to `stfout` if `ENV['DEBUG']` is set
+      def debug(message)
+        stdout.print("#{message}\n") if ENV['DEBUG']
+      end
+
+      def stdout
+        $stdout
+      end
+
+      def stderr
+        $stderr
+      end
+    end
+  end
+end

data/lib/terraform/binary/version.rb

@@ -0,0 +1,9 @@
+module Terraform
+  module Binary
+    # Gem Version
+    VERSION = '0.1.0'.freeze
+
+    # The version number of the Terraform binary to download and use
+    TERRAFORM_VERSION = '0.10.3'.freeze
+  end
+end

data/terraform-binary.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "terraform/binary/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "terraform-binary"
+  spec.version       = Terraform::Binary::VERSION
+  spec.authors       = ["Nathan Cazell"]
+  spec.email         = ["nathan.cazell@imageapi.com"]
+
+  spec.summary       = "A gem to install and interface with HashiCorp's Terraform utility"
+  spec.homepage      = 'https://github.com/nathantcz/terraform-binary'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'coveralls'
+
+  spec.add_runtime_dependency 'rubyzip'
+  spec.add_runtime_dependency 'os'
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: terraform-binary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Cazell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- nathan.cazell@imageapi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/terraform/binary.rb
+- lib/terraform/binary/command.rb
+- lib/terraform/binary/compressor.rb
+- lib/terraform/binary/executable.rb
+- lib/terraform/binary/helpers.rb
+- lib/terraform/binary/version.rb
+- terraform-binary.gemspec
+homepage: https://github.com/nathantcz/terraform-binary
+licenses:
+- MIT
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A gem to install and interface with HashiCorp's Terraform utility
+test_files: []