mixlib-install 3.11.5 → 3.11.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d850766fa7c4d79a4f76479938b337a4c574cffddd3ae03656f76769b23dd3d6
-  data.tar.gz: 7050b957d09ca7a9dee51ba33456fb6e4cd26f5abd7dd5fffc71d4380fb2068b
+  metadata.gz: 329b4dcdda0b764ae109f7cc9390cde578b9bf596056a122348d10bc74377c04
+  data.tar.gz: f32cf482c8887ae1710b026973a5213e3a54fd08d1d20a3785787e88a9846649
 SHA512:
-  metadata.gz: 7e3606a15f01ce5f49f124fe1dfa7ba08cd9f77bd41ca33dc8cd7b1bfacbb841d9cf4ca6e113252fb13096aa093d0ea8dd91513b3fba7a10a30d4e9100ff781a
-  data.tar.gz: 4d319ceea262f9ce4a6c7ff96ea94766bad936578e4436cc5efcdf1598ce1d7802da15bd163d53827487110cce1428835451869fcfa7e0c9401e7caeee0ac431
+  metadata.gz: ec45ceaa034479c334e8ae7865ec844da5422d0598b223985c4c9ce2734eb5c1d67f104bcebcc3d6a41ad46ee78a1f1ab441ec1cdee19ae86b1f535cfc646430
+  data.tar.gz: b1b010a0366ac54aeaa48ecef92926415e10a2d7a903e66790a324b61ddcbefeeedd41901b59b826419df834f0f677b1963b0a5c76088b0d14edf8e91fb765f2

data/Gemfile

@@ -2,7 +2,13 @@ source "https://rubygems.org"
 
 gemspec
 
-group :test, :development do
+group :docs do
+  gem "yard"
+  gem "redcarpet"
+  gem "github-markup"
+end
+
+group :test do
   gem "rake"
   gem "rspec"
   gem "vcr"
@@ -19,8 +25,15 @@ if RUBY_VERSION =~ /^2/
   end
 end
 
+group :development do
+  gem "pry"
+  gem "pry-byebug"
+  gem "pry-stack_explorer"
+  gem "rb-readline"
+end
+
 instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
 
 # If you want to load debugging tools into the bundle exec sandbox,
 # add these additional dependencies into Gemfile.local
-eval(IO.read(__FILE__ + ".local"), binding) if File.exist?(__FILE__ + ".local")
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/Rakefile

@@ -14,18 +14,13 @@ end
 begin
   require "chefstyle"
   require "rubocop/rake_task"
-  RuboCop::RakeTask.new(:chefstyle) do |task|
-    task.options << "--display-cop-names"
+  RuboCop::RakeTask.new(:style) do |task|
+    task.options += ["--display-cop-names", "--no-color"]
   end
 rescue LoadError
   puts "chefstyle gem is not installed"
 end
 
-namespace :travis do
-  desc "Run tests on Travis CI"
-  task ci: %w{chefstyle unit functional}
-end
-
 desc "Render product matrix documentation"
 task "matrix" do
   require "mixlib/install/product"
@@ -45,6 +40,13 @@ task "matrix" do
   end
 end
 
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new(:docs)
+rescue LoadError
+  puts "yard is not available. bundle install first to make sure all dependencies are installed."
+end
+
 task :console do
   require "irb"
   require "irb/completion"
@@ -53,4 +55,4 @@ task :console do
   IRB.start
 end
 
-task default: %w{travis:ci}
+task default: %w{style unit functional}

data/lib/mixlib/install.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Thom May (<thom@chef.io>)
 # Author:: Patrick Wright (<patrick@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/artifact_info.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Patrick Wright (<patrick@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/backend.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Patrick Wright (<patrick@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/backend/base.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Patrick Wright (<patrick@chef.io>)
-# Copyright:: Copyright (c) 2016 Chef, Inc.
+# Copyright:: Copyright (c) 2016-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -174,19 +174,12 @@ EOF
           artifact_64 = artifacts.find { |a| a.platform == "windows" && a.architecture == "x86_64" }
           artifact_32 = artifacts.find { |a| a.platform == "windows" && a.architecture == "i386" }
 
-          # Attempt to clone windows artifacts only when a Windows 32 bit artifact exists
-          if artifact_32
-            new_artifacts.concat(clone_windows_desktop_artifacts(artifact_32))
-
-            # Clone an existing 64 bit artifact
-            if artifact_64
-              new_artifacts.concat(clone_windows_desktop_artifacts(artifact_64))
-
-            # Clone the 32 bit artifact when 64 bit doesn't exist
-            else
-              new_artifacts.concat(clone_windows_desktop_artifacts(artifact_32, architecture: "x86_64"))
-            end
-          end
+          # Clone an existing 64-bit artifact
+          new_artifacts.concat(clone_windows_desktop_artifacts(artifact_64)) if artifact_64
+          # Clone an existing 32-bit artifact
+          new_artifacts.concat(clone_windows_desktop_artifacts(artifact_32)) if artifact_32
+          # Clone the 32 bit artifact when 64 bit doesn't exist
+          new_artifacts.concat(clone_windows_desktop_artifacts(artifact_32, architecture: "x86_64")) if artifact_32 && !artifact_64
 
           # Now discard the cloned artifacts if we find an equivalent native
           # artifact

data/lib/mixlib/install/backend/package_router.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Patrick Wright (<patrick@chef.io>)
-# Copyright:: Copyright (c) 2015-2016 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/cli.rb

@@ -1,3 +1,17 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 require "mixlib/install"
 require "thor"
 

data/lib/mixlib/install/generator.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/generator/base.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/generator/bourne.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/generator/bourne/scripts/fetch_package.sh

@@ -1,6 +1,6 @@
 # fetch_package.sh
 ############
-# This section fetchs a package from $download_url and verifies its metadata.
+# This section fetches a package from $download_url and verifies its metadata.
 #
 # Inputs:
 # $download_url:
@@ -26,7 +26,7 @@ else
   download_filename="$tmp_dir/$filename"
 fi
 
-# ensure the parent directory where to download the installer always exists
+# ensure the parent directory where we download the installer always exists
 download_dir=`dirname $download_filename`
 (umask 077 && mkdir -p $download_dir) || exit 1
 

data/lib/mixlib/install/generator/bourne/scripts/helpers.sh.erb

@@ -4,7 +4,7 @@
 # - must run on /bin/sh on solaris 9
 # - must run on /bin/sh on AIX 6.x
 #
-# Copyright:: Copyright (c) 2010-2015 Chef Software, Inc.
+# Copyright:: Copyright (c) 2010-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -326,7 +326,7 @@ if test "x$TMPDIR" = "x"; then
 else
   tmp=$TMPDIR
 fi
-# secure-ish temp dir creation without having mktemp available (DDoS-able but not expliotable)
+# secure-ish temp dir creation without having mktemp available (DDoS-able but not exploitable)
 tmp_dir="$tmp/install.sh.$$"
 (umask 077 && mkdir $tmp_dir) || exit 1
 

data/lib/mixlib/install/generator/bourne/scripts/install_package.sh

@@ -12,7 +12,7 @@ if test "x$version" = "x" -a "x$CI" != "xtrue"; then
   echo
   echo "WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING"
   echo
-  echo "You are installing an omnibus package without a version pin.  If you are installing"
+  echo "You are installing a package without a version pin.  If you are installing"
   echo "on production servers via an automated process this is DANGEROUS and you will"
   echo "be upgraded without warning on new releases, even to new major releases."
   echo "Letting the version float is only appropriate in desktop, test, development or"

data/lib/mixlib/install/generator/bourne/scripts/platform_detection.sh

@@ -12,9 +12,9 @@
 #
 # Platform and Platform Version detection
 #
-# NOTE: This should now match ohai platform and platform_version matching.
-# do not invented new platform and platform_version schemas, just make this behave
-# like what ohai returns as platform and platform_version for the server.
+# NOTE: This logic should match ohai platform and platform_version matching.
+# do not invent new platform and platform_version schemas, just make this behave
+# like what ohai returns as platform and platform_version for the system.
 #
 # ALSO NOTE: Do not mangle platform or platform_version here.  It is less error
 # prone and more future-proof to do that in the server, and then all omnitruck clients
@@ -97,7 +97,7 @@ elif test -f "/etc/SuSE-release"; then
       platform="sles"
       platform_version=`awk '/^VERSION/ {V = $3}; /^PATCHLEVEL/ {P = $3}; END {print V "." P}' /etc/SuSE-release`
   else
-      platform="suse"
+      platform="opensuseleap"
       platform_version=`awk '/^VERSION =/ { print $3 }' /etc/SuSE-release`
   fi
 elif test "x$os" = "xFreeBSD"; then
@@ -124,7 +124,7 @@ if test "x$platform" = "x"; then
 fi
 
 #
-# NOTE: platform manging in the install.sh is DEPRECATED
+# NOTE: platform mangling in the install.sh is DEPRECATED
 #
 # - install.sh should be true to ohai and should not remap
 #   platform or platform versions.
@@ -156,7 +156,7 @@ case $platform in
   "sles")
     platform_version=$major_version
     ;;
-  "suse")
+  "opensuseleap")
     platform_version=$major_version
     ;;
 esac

data/lib/mixlib/install/generator/powershell.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/options.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Patrick Wright (<patrick@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/product.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/script_generator.rb

@@ -1,7 +1,7 @@
 #
 # Author:: Thom May (<thom@chef.io>)
 # Author:: Patrick Wright (<patrick@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/util.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Thom May (<thom@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright (c) 2015-2018 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/mixlib/install/version.rb

@@ -1,5 +1,5 @@
 module Mixlib
   class Install
-    VERSION = "3.11.5"
+    VERSION = "3.11.11"
   end
 end

data/mixlib-install.gemspec

@@ -11,9 +11,9 @@ Gem::Specification.new do |spec|
   spec.license       = "Apache-2.0"
 
   spec.summary       = "A library for interacting with Chef Software Inc's software distribution systems."
-  spec.homepage      = "https://chef.io"
+  spec.homepage      = "https://github.com/chef/mixlib-install"
 
-  spec.files         = %w{LICENSE PRODUCT_MATRIX.md README.md Gemfile Rakefile} + Dir.glob("*.gemspec") + Dir.glob("{bin,lib,support}/**/*")
+  spec.files         = %w{LICENSE Gemfile Rakefile} + Dir.glob("*.gemspec") + Dir.glob("{bin,lib,support}/**/*")
   spec.executables   = ["mixlib-install"]
   spec.require_paths = ["lib"]
 

data/support/install_command.ps1

@@ -65,7 +65,7 @@ Function Verify-SHA256($path, $sha256) {
 }
 
 Function Install-Chef($msi, $chef_omnibus_root) {
-  Log "Installing Chef Omnibus package $msi"
+  Log "Installing Chef package $msi"
   $installingChef = $True
   $installAttempts = 0
   while ($installingChef) {
@@ -194,7 +194,7 @@ Function Unresolve-Path($p) {
 $chef_omnibus_root = Unresolve-Path $chef_omnibus_root
 
 if (Check-UpdateChef $chef_omnibus_root $version) {
-  Write-Host "-----> Installing Chef Omnibus ($pretty_version)"
+  Write-Host "-----> Installing Chef $pretty_version package"
   if ($chef_metadata_url -ne $null) {
     $url, $sha256 = Get-ChefMetadata "$chef_metadata_url"
   } else {
@@ -210,5 +210,5 @@ if (Check-UpdateChef $chef_omnibus_root $version) {
   }
   Install-Chef $msi $chef_omnibus_root
 } else {
-  Write-Host "-----> Chef Omnibus installation detected ($pretty_version)"
+  Write-Host "-----> Chef installation detected ($pretty_version)"
 }

data/support/install_command.sh

@@ -206,7 +206,7 @@ unable_to_download() {
 main() {
   should_update_chef "$chef_omnibus_root" "$version"
   if test $? -eq 0; then
-    echo "-----> Installing Chef Omnibus (${pretty_version})";
+    echo "-----> Installing Chef ${pretty_version} package";
 
     # solaris 10 lacks recent enough credentials, so http url is used
     platform="`/usr/bin/uname -s 2>/dev/null`";
@@ -218,7 +218,7 @@ main() {
     do_download "$chef_omnibus_url" /tmp/install.sh;
     $sudo_sh /tmp/install.sh $install_flags;
   else
-    echo "-----> Chef Omnibus installation detected (${pretty_version})";
+    echo "-----> Chef installation detected (${pretty_version})";
   fi
 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixlib-install
 version: !ruby/object:Gem::Version
-  version: 3.11.5
+  version: 3.11.11
 platform: ruby
 authors:
 - Thom May
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2019-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -64,8 +64,6 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - LICENSE
-- PRODUCT_MATRIX.md
-- README.md
 - Rakefile
 - bin/mixlib-install
 - lib/mixlib/install.rb
@@ -98,7 +96,7 @@ files:
 - mixlib-install.gemspec
 - support/install_command.ps1
 - support/install_command.sh
-homepage: https://chef.io
+homepage: https://github.com/chef/mixlib-install
 licenses:
 - Apache-2.0
 metadata: {}

data/PRODUCT_MATRIX.md

@@ -1,28 +0,0 @@
-| Product | Product Key  |
-| ------- | ------------ |
-| Analytics Platform | analytics |
-| Angry Omnibus Toolchain | angry-omnibus-toolchain |
-| Angry Chef Client | angrychef |
-| Chef Automate | automate |
-| Chef Client | chef |
-| Chef Backend | chef-backend |
-| Chef Server | chef-server |
-| Chef Server HA Provisioning for AWS | chef-server-ha-provisioning |
-| Chef Workstation | chef-workstation |
-| Chef Development Kit | chefdk |
-| Chef Compliance | compliance |
-| Delivery | delivery |
-| Chef Server High Availability addon | ha |
-| Harmony - Omnibus Integration Internal Test Project | harmony |
-| InSpec | inspec |
-| Management Console | manage |
-| Chef Cloud Marketplace addon | marketplace |
-| Omnibus Toolchain | omnibus-toolchain |
-| Enterprise Chef (legacy) | private-chef |
-| Chef Push Client | push-jobs-client |
-| Chef Push Server | push-jobs-server |
-| Chef Server Reporting addon | reporting |
-| Supermarket | supermarket |
-| Chef Server Replication addon | sync |
-
-Do not modify this file manually. It is automatically rendered via a rake task.

data/README.md

@@ -1,258 +0,0 @@
-[![Build Status](https://travis-ci.org/chef/mixlib-install.svg?branch=master)](https://travis-ci.org/chef/mixlib-install)
-
-# Mixlib::Install
-
-## Supports
-
-- Ruby 1.9.3+
-- Chef 11.6.2+ chef-client upgrades
-
-## Command Line Usage
-```
-$ gem install mixlib-install
-```
-
-```
-# Download latest stable chef for current platform
-$ mixlib-install download chef
-```
-
-Run `$ mixlib-install help` for additional commands and options.
-
-## API Usage
-
-### Load mixlib-install
-```ruby
-require 'mixlib/install'
-```
-
-### Get URL for specific platform and package version
-```ruby
-options = {
-  channel: :current,
-  product_name: 'chef',
-  product_version: :latest,
-  platform: 'mac_os_x',
-  platform_version: '10.9',
-  architecture: 'x86_64'
-}
-
-artifact = Mixlib::Install.new(options).artifact_info
-# => #<Mixlib::Install::ArtifactInfo>
-
-artifact.url
-# => "https://packages.chef.io/files/current/chef/12.14.90/mac_os_x/10.9/chef-12.14.90-1.dmg"
-```
-
-### Get list of artifacts for all platforms given a package version
-```ruby
-options = {
-  channel: :current,
-  product_name: 'chef'
-}
-# product_version: :latest is the default
-
-artifacts = Mixlib::Install.new(options).artifact_info
-# => [#<Mixlib::Install::ArtifactInfo>, ...]
-
-artifacts.first.url
-# => => "https://packages.chef.io/files/current/chef/12.14.90/mac_os_x/10.11/chef-12.14.90-1.dmg"
-```
-
-### Get latest artifacts for a partial version
-```ruby
-options = {
-  channel: :current,
-  product_name: 'chef',
-  product_version: '12.14'
-}
-
-artifacts = Mixlib::Install.new(options).artifact_info
-# => [#<Mixlib::Install::ArtifactInfo>]
-
-artifacts.first.version
-# => "12.14.89"
-```
-
-### Get latest artifact for a partial version
-```ruby
-options = {
-  channel: :current,
-  product_name: 'chef',
-  product_version: '12',
-  platform: 'mac_os_x',
-  platform_version: '10.9',
-  architecture: 'x86_64'
-}
-
-artifact = Mixlib::Install.new(options).artifact_info
-# => #<Mixlib::Install::ArtifactInfo>
-
-artifact.version
-# => "12.19.36"
-```
-
-### Detect platform information
-```ruby
-options = {
-  channel: :current,
-  product_name: 'chef',
-  product_version: :latest
-}
-
-artifact = Mixlib::Install.new(options).detect_platform
-
-artifact.platform # => "mac_os_x"
-artifact.platform_version # => "10.10"
-```
-
-### Use an artifact released for an earlier version of the platform
-```ruby
-options = {
-  channel: :current,
-  product_name: 'chef',
-  product_version: :latest,
-  platform: 'ubuntu',
-  platform_version: '15.04',
-  architecture: 'x86_64',
-  platform_version_compatibility_mode: true
-}
-
-artifact = Mixlib::Install.new(options).artifact_info
-
-artifact.platform # => "ubuntu"
-artifact.platform_version # => "14.04"
-```
-
-`platform_version_compatibility_mode` will automatically be enabled if platform options are not specified.
-
-If running on Ubuntu 15.04...
-```ruby
-options = {
-  channel: :current,
-  product_name: 'chef',
-}
-
-artifact = Mixlib::Install.new(options).artifact_info
-
-artifact.platform # => "ubuntu"
-artifact.platform_version # => "14.04"
-```
-
-### List the available versions for a product and channel
-#### Instance method
-```ruby
-options = {
-  channel: :stable,
-  product_name: 'chef',
-}
-
-Mixlib::Install.new(options).available_versions
-
-# => ["12.13.3", "12.13.7"]
-```
-
-#### Class method
-```ruby
-Mixlib::Install.available_versions("chef", "stable")
-
-# => ["12.13.3", "12.13.7"]
-```
-
-### Download an artifact
-Download a specific artifact to a configurable location. All platform options (platform, platform_version, architecture) are required  in order to filter a single artifact.
-```ruby
-# detect platform and download to the operating system’s temporary file path
-Mixlib::Install.new(product_name: "chefdk", channel: :stable).detect_platform.download_artifact(Dir.tmpdir)
-# => "/tmp/chefdk-2.3.4-1.deb"
-
-# specify platform options and download to current directory
-Mixlib::Install.new(product_name: "chefdk", channel: :stable, platform: "ubuntu", platform_version: "14.04", architecture: "x86_64").download_artifact
-# => "~/chefdk-2.3.4-1.deb"
-
-```
-
-### User-Agent Request Headers
-By default, all requests made by `mixlib-install` will include a `User-Agent` request header as `mixlib-install/<version>`.
-Additional `User-Agent` request headers can be added by setting the `user_agent_headers` option.
-When you want to identify a product using mixlib-install as a dependency we recommend the format `product/version`.
-```ruby
-options = {
-  channel: :stable,
-  product_name: 'chef',
-  user_agent_headers: ["my_product/1.2.3", "somethingelse"],
-}
-```
-
-### Collecting Software Dependencies and License Content
-Collecting software dependencies and license content for ArtifactInfo instances
-requires additional requests to the repository server. By default, collection is disabled.
-To return data for instance methods `software_dependencies` and `license_content`, the `include_metadata` option must be enabled.
-```ruby
-options = {
-  channel: :current,
-  product_name: 'chef',
-  product_version: :latest,
-  platform: 'mac_os_x',
-  platform_version: '10.9',
-  architecture: 'x86_64',
-  include_metadata: true,
-}
-
-artifact = Mixlib::Install.new(options).artifact_info
-
-artifact.license_content.class
-# => String
-artifact.software_dependencies.class
-# => Hash
-
-# By default, the instance methods return nil
-
-```
-
-
-### Install Scripts
-mixlib-install generates the bootstrap installation scripts known as install.sh and install.ps1. The associated install script will be returned when calling `#install_command` on the Mixlib::Install instance.
-
-Mixlib::Install instantiation option `install_command_options` can accept variables (bourne) or parameters (powershell) to modify the behavior of the install scripts.
-
-Some of the more common options include:
-
-`download_url_override`: Use the provided URL instead of fetching the metadata URL from Chef Software Inc's software distribution systems.  
-`checksum`: SHA256 value associated to the directed file for the download_url_override option. This setting is optional. Not setting this will download the file even if a cached file is detected.  
-`install_strategy`: Set to "once" to have the script exit if the product being installed is detected.  
-
-```ruby
-options = {
-  product_name: 'chef',
-  install_command_options: {
-    download_url_override: "https://file/path",
-    checksum: "OPTIONAL",
-    install_strategy: "once",
-  }
-}
-
-Mixlib::Install.new(options).install_command
-```
-
-#### Proxies
-The API uses Ruby's OpenURI module to load proxy environment variables (`http_proxy`, `https_proxy`, `ftp_proxy`, `no_proxy`).
-
-When `install.sh` and `install.ps1` are executed as standalone scripts the will rely on environment variables to configure proxy settings. The install scripts will not configure proxy settings by default.
-
-In order to customize the proxy environment variables for generated install scripts they must be set by the `install_command_options` option. Setting these options will override session environment variables.
-
-Bourne install script (`install.sh`) supports `http_proxy`, `https_proxy`, `ftp_proxy`, and `no_proxy` passed as keys to `install_command_options`.
-
-Powershell install script (`install.ps1`) supports `http_proxy` passed as a key to `install_command_options`.
-
-## Development
-VCR is a tool that helps cache and replay http responses. When these responses change or when you add more tests you might need to update cached responses. Check out [spec_helper.rb](https://github.com/chef/mixlib-install/blob/master/spec/spec_helper.rb) for instructions on how to do this.
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/mixlib-install/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request