packer-binary 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d610905638a3f77ae5f74ac0de28dde44057af1d
-  data.tar.gz: aaa280ab1dc68c53d90c4ce9424ffc70cd3d536e
+  metadata.gz: 5873799b8897ad2c339a83886a1761188d62995c
+  data.tar.gz: 71c9bfff2134207674d6b8b66ede36c8725d4fe6
 SHA512:
-  metadata.gz: d06c34d31c2be35258a9f410f9f12e209b4450ea7eba669a2d9b7d02003dd8ae5ab966279d6a526bc93ce3aa5d46c339d81e56c34851a37c478d7ae441c0f811
-  data.tar.gz: 7d04816457e70b0aa7e5013e4106fba1664d7700cffa557dba2f1807dea0d1b51e8da5392ea74609556a6b3d078bfb122d164db7c02149e709f2511478b70a14
+  metadata.gz: 01b015e3e484fd0243b7355a6efe2f8c71af312b635e6030058d390a1074f1ec7e4ddda35c73e56e1049981f2c1f7c80bbad4064456e35008ceff6522a663204
+  data.tar.gz: 6b86a57a41bf451eb50017bbf6e872331d2d8cb114dec579ae4c209c794dcbe26ffcb622989e4dd77c87d656fc073368e7e1807f39aa0a5e34c8fe390ee514f0

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_from:
+  - .rubocop_todo.yml
+
+Style/MethodName:
+  Exclude:
+    - lib/packer/binary.rb

data/.rubocop_todo.yml

@@ -0,0 +1,18 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-09-05 13:53:42 -0400 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 15
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 113
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13

data/.yardopts

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

data/Gemfile

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

data/README.md

@@ -1,7 +1,7 @@
 [![Gem Version](https://badge.fury.io/rb/packer-binary.svg)](https://badge.fury.io/rb/packer-binary)
 [![Build Status](https://travis-ci.org/NathanTCz/packer-binary.svg?branch=master)](https://travis-ci.org/NathanTCz/packer-binary)
 [![Coverage Status](https://coveralls.io/repos/github/NathanTCz/packer-binary/badge.svg?branch=master)](https://coveralls.io/github/NathanTCz/packer-binary?branch=master)
-[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/packer-binary/0.1.0)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/packer-binary)
 
 # Packer::Binary
 
@@ -35,18 +35,14 @@ Packer::Binary.configure do |config|
 end
 ```
 
-### Convenience Methods
-{Packer::Binary.Build} - Run the `build` command. Optionally pass any arguments supported by Packer.
+### Dynamic Methods
+The {Packer::Binary} module will automagically map method calls to `packer` commands. This serves to better support future versions of `packer` and potentially new commands. For example, the equivalent of `packer build test.json` in Ruby:
 
-{Packer::Binary.Fix} - Run the `fix` command. Optionally pass any arguments supported by Packer.
-
-{Packer::Binary.Inspect} - Run the `inspect` command. Optionally pass any arguments supported by Packer.
-
-{Packer::Binary.Push} - Run the `push` command. Optionally pass any arguments supported by Packer.
-
-{Packer::Binary.Validate} - Run the `validate` command. Optionally pass any arguments supported by Packer.
+```ruby
+Packer::Binary.build('test.json')
+```
 
-{Packer::Binary.Version} - Run the `version` command. Optionally pass any arguments supported by Packer.
+If you call a method not supported by the `packer` binary, you will get a {Packer::Binary::Command::CommandFailure} exception.
 
 ## Development
 

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "packer/binary"
+require 'bundler/setup'
+require 'packer/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.
@@ -10,5 +10,5 @@ require "packer/binary"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/packer/binary.rb

@@ -1,55 +1,86 @@
 require 'os'
 
-require "packer/binary/version"
+require 'packer/binary/version'
 require 'packer/binary/helpers'
 require 'packer/binary/compressor'
 require 'packer/binary/executable'
 require 'packer/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 Packer
+  # The Binary namespace handles sub-commands using {#method_missing} metaprogramming
+  # as well as the global configuration object
   module Binary
-    module_function
-
+    # @!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
 
-    def Build(opts = '')
-      Command.run("build #{opts}")
+    # This method maps Packer::Binary method calls to Packer sub-commands
+    # Ex. to run `packer build test.json -machine-readable`:
+    #
+    # ```ruby
+    # Packer::Binary.build('test.json -machine-readable')
+    # ```
+    #
+    # @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+)/
+        Command.run("#{method.to_s.downcase} #{args}")
+      else
+        super
+      end
     end
 
-    def Fix(opts = '')
-      Command.run("fix #{opts}")
+    def respond_to_missing?(method, *)
+      method =~ /(\w+)/ || super
     end
 
-    def Inspect(opts = '')
-      Command.run("inspect #{opts}")
-    end
+    # @deprecated Use {#method_missing} dynamic method handling for
+    #   binary sub-commands
+    def Build; end
 
-    def Push(opts = '')
-      Command.run("push #{opts}")
-    end
+    # @deprecated Use {#method_missing} dynamic method handling for
+    #   binary sub-commands
+    def Fix; end
 
-    def Validate(opts = '')
-      Command.run("validate #{opts}")
-    end
+    # @deprecated Use {#method_missing} dynamic method handling for
+    #   binary sub-commands
+    def Inspect; end
 
-    def Version(opts = '')
-      Command.run("version #{opts}")
-    end
+    # @deprecated Use {#method_missing} dynamic method handling for
+    #   binary sub-commands
+    def Push; end
+
+    # @deprecated Use {#method_missing} dynamic method handling for
+    #   binary sub-commands
+    def Validate; end
+
+    # @deprecated Use {#method_missing} dynamic method handling for
+    #   binary sub-commands
+    def Version; end
 
+    # This class holds the global configuration items
     class Configuration
       attr_accessor :version
       attr_accessor :download_path
 
       def initialize
-        @version = '1.0.4'
+        @version = PACKER_VERSION
         @download_path = '/tmp'
       end
     end

data/lib/packer/binary/command.rb

@@ -1,15 +1,26 @@
 module Packer
   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}")
+        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

data/lib/packer/binary/compressor.rb

@@ -1,30 +1,24 @@
-# This is a simple example which uses rubyzip to
-# recursively generate a zip file from the contents of
-# a specified directory. The directory itself is not
-# included in the archive, rather just its contents.
-#
-# Usage:
-#   directoryToZip = "/tmp/input"
-#   output_file = "/tmp/out.zip"
-#   zf = Zip.new(directoryToZip, output_file)
-#   zf.write()
 require 'zip'
 
 module Packer
   module Binary
+    # This class is used to zip and unzip files and directories
     class Compressor
       class << self
         include Packer::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);
+          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();
+          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
@@ -41,19 +35,20 @@ module Packer
 
         # A helper method to make the recursion work.
         def write_entries(entries, path, io, input_dir, output_file)
-
-          entries.each { |e|
-            zip_file_path = path == "" ? e : File.join(path, e)
+          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)
+            if File.directory?(disk_file_path)
               io.mkdir(zip_file_path)
-              subdir =Dir.entries(disk_file_path); subdir.delete("."); subdir.delete("..")
+              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())}
+              io.get_output_stream(zip_file_path) { |f| f.puts(File.open(disk_file_path, 'rb').read) }
             end
-          }
+          end
         end
       end
     end

data/lib/packer/binary/executable.rb

@@ -1,8 +1,18 @@
 module Packer
   module Binary
+    # This class handles downloading, extracting, and saving the associated
+    # binary file
     class Executable
       include Packer::Binary::Helpers
 
+      # Raised when the current platform is unsupported
+      class PlatformUnsupported < StandardError; end
+
+      # The download URI for the binary package
+      PACKER_DOWNLOAD_URI = 'releases.hashicorp.com'.freeze
+
+      # Loads global config values and creates the download directory if the
+      # current platform is supported
       def initialize
         @packer_version = Packer::Binary.config.version
         @download_path = "#{Packer::Binary.config.download_path.chomp('/')}/packer-binary/#{@packer_version}/bin"
@@ -10,28 +20,36 @@ module Packer
 
         FileUtils.mkdir_p @download_path
 
-        raise 'Your OS is not supported' unless supported?
+        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}/packer*"][0]
       end
 
+      # Downloads the zipfile from the origin
       def download
-        return "#{binary} already exists" if binary_exist?
+        return if binary_exist?
 
         msg("Downloading https://#{download_domain}/#{download_uri}")
 
         require 'open-uri'
 
-        File.open("#{@download_path}/#{@download_filename}", "wb") do |saved_file|
+        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|
+          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?
 
-        extract
+        Compressor.extract("#{@download_path}/#{@download_filename}", @download_path)
         make_exe
       end
 
@@ -49,10 +67,6 @@ module Packer
         FileUtils.chmod('a+x', binary) if binary_exist?
       end
 
-      def extract
-        Compressor::extract("#{@download_path}/#{@download_filename}", @download_path)
-      end
-
       def download_uri
         "packer/#{@packer_version}/packer_#{@packer_version}_freebsd_amd64.zip" if OS.freebsd?
         "packer/#{@packer_version}/packer_#{@packer_version}_darwin_amd64.zip" if OS.mac?
@@ -61,9 +75,8 @@ module Packer
       end
 
       def download_domain
-        'releases.hashicorp.com'
+        PACKER_DOWNLOAD_URI
       end
-
     end
   end
 end

data/lib/packer/binary/helpers.rb

@@ -1,29 +1,33 @@
 module Packer
   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
 
+      private
+
       def stdout
         $stdout
       end

data/lib/packer/binary/version.rb

@@ -1,5 +1,9 @@
 module Packer
   module Binary
-    VERSION = "0.1.1"
+    # Gem Version
+    VERSION = '0.2.0'.freeze
+
+    # The version number of the Packer binary to download and use
+    PACKER_VERSION = '1.0.4'.freeze
   end
 end

data/packer-binary.gemspec

@@ -1,28 +1,30 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "packer/binary/version"
+require 'packer/binary/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "packer-binary"
+  spec.name          = 'packer-binary'
   spec.version       = Packer::Binary::VERSION
-  spec.authors       = ["Nathan Cazell"]
-  spec.email         = ["nathan.cazell@imageapi.com"]
+  spec.authors       = ['Nathan Cazell']
+  spec.email         = ['nathan.cazell@imageapi.com']
 
-  spec.summary       = %q{A gem to install and interface with HashiCorp's Packer utility}
-  spec.homepage      = "https://github.com/nathantcz/packer-binary"
-  spec.license       = "MIT"
+  spec.summary       = "A gem to install and interface with HashiCorp's Packer utility"
+  spec.homepage      = 'https://github.com/nathantcz/packer-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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  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 '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'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packer-binary
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Nathan Cazell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-31 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !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
@@ -131,7 +145,10 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -165,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A gem to install and interface with HashiCorp's Packer utility