r10k 1.5.1 → 2.0.0

data/lib/r10k/module_repository/forge.rb

@@ -69,12 +69,9 @@ class R10K::ModuleRepository::Forge
   private
 
   def make_conn
-    # Force use of json_pure with multi_json on Ruby 1.8.7
-    multi_json_opts = (RUBY_VERSION == "1.8.7" ? {:adapter => :json_pure} : {})
-
     Faraday.new(:url => "https://#{@forge}") do |builder|
-      builder.request(:multi_json, multi_json_opts)
-      builder.response(:multi_json, multi_json_opts)
+      builder.request(:multi_json)
+      builder.response(:multi_json)
 
       # This needs to be _after_ request/response configuration for testing
       # purposes. Without this ordering the tests get badly mangled.

data/lib/r10k/puppetfile.rb

@@ -111,7 +111,7 @@ class Puppetfile
       @librarian = librarian
     end
 
-    def mod(name, args = [])
+    def mod(name, args = nil)
       @librarian.add_module(name, args)
     end
 

data/lib/r10k/util/license.rb

@@ -0,0 +1,20 @@
+require 'r10k/errors'
+require 'rubygems'
+
+module R10K
+  module Util
+    module License
+      def self.load
+        if Gem::Specification::find_all_by_name('pe-license').any?
+          begin
+            return PELicense.load_license_key
+          rescue PELicense::InvalidLicenseError => e
+            raise R10K::Error.wrap(e, "Invalid PE license detected: #{e.message}")
+          end
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/r10k/version.rb

@@ -1,3 +1,3 @@
 module R10K
-  VERSION = '1.5.1'
+  VERSION = '2.0.0'
 end

data/lib/shared/puppet_forge/connection.rb

@@ -0,0 +1,62 @@
+require 'shared/puppet_forge/version'
+
+require 'faraday'
+require 'faraday_middleware'
+
+module PuppetForge
+  # Provide a common mixin for adding a HTTP connection to classes.
+  #
+  # This module provides a common method for creating HTTP connections as well
+  # as reusing a single connection object between multiple classes. Including
+  # classes can invoke #conn to get a reasonably configured HTTP connection.
+  # Connection objects can be passed with the #conn= method.
+  #
+  # @example
+  #   class HTTPThing
+  #     include PuppetForge::Connection
+  #   end
+  #   thing = HTTPThing.new
+  #   thing.conn = thing.make_connection('https://non-standard-forge.site')
+  #
+  # @api private
+  module Connection
+
+    attr_writer :conn
+
+    USER_AGENT = "PuppetForge/#{PuppetForge::VERSION} Faraday/#{Faraday::VERSION} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} (#{RUBY_PLATFORM})"
+
+    def self.authorization=(token)
+      @authorization = token
+    end
+
+    def self.authorization
+      @authorization
+    end
+
+    # @return [Faraday::Connection] An existing Faraday connection if one was
+    #   already set, otherwise a new Faraday connection.
+    def conn
+      @conn ||= make_connection('https://forgeapi.puppetlabs.com')
+    end
+
+    # Generate a new Faraday connection for the given URL.
+    #
+    # @param url [String] the base URL for this connection
+    # @return [Faraday::Connection]
+    def make_connection(url, adapter_args = nil)
+      adapter_args ||= [Faraday.default_adapter]
+      options = { :headers => { :user_agent => USER_AGENT }}
+
+      if token = PuppetForge::Connection.authorization
+        options[:headers][:authorization] = token
+      end
+
+      Faraday.new(url, options) do |builder|
+        builder.response(:json, :content_type => /\bjson$/)
+        builder.response(:raise_error)
+
+        builder.adapter(*adapter_args)
+      end
+    end
+  end
+end

data/lib/shared/puppet_forge/error.rb

@@ -0,0 +1,28 @@
+module PuppetForge
+  class Error < RuntimeError
+    attr_accessor :original
+    def initialize(message, original=nil)
+      super(message)
+      @original = original
+    end
+  end
+
+  class ExecutionFailure < PuppetForge::Error
+  end
+
+  class InvalidPathInPackageError < PuppetForge::Error
+    def initialize(options)
+      @entry_path = options[:entry_path]
+      @directory  = options[:directory]
+      super "Attempt to install file into #{@entry_path.inspect} under #{@directory.inspect}"
+    end
+
+    def multiline
+      <<-MSG.strip
+Could not install package
+  Package attempted to install file into
+  #{@entry_path.inspect} under #{@directory.inspect}.
+      MSG
+    end
+  end
+end

data/lib/shared/puppet_forge/tar.rb

@@ -0,0 +1,10 @@
+
+module PuppetForge
+  class Tar
+    require 'shared/puppet_forge/tar/mini'
+
+    def self.instance
+      Mini.new
+    end
+  end
+end

data/lib/shared/puppet_forge/tar/mini.rb

@@ -0,0 +1,81 @@
+require 'zlib'
+require 'archive/tar/minitar'
+
+module PuppetForge
+  class Tar
+    class Mini
+
+      SYMLINK_FLAGS = [2]
+      VALID_TAR_FLAGS = (0..7)
+
+      # @return [Hash{:symbol => Array<String>}] a hash with file-category keys pointing to lists of filenames.
+      def unpack(sourcefile, destdir)
+        # directories need to be changed outside of the Minitar::unpack because directories don't have a :file_done action
+        dirlist = []
+        file_lists = {}
+        Zlib::GzipReader.open(sourcefile) do |reader|
+          file_lists = validate_files(reader)
+          Archive::Tar::Minitar.unpack(reader, destdir, file_lists[:valid]) do |action, name, stats|
+            case action
+            when :file_done
+              FileUtils.chmod('u+rw,g+r,a-st', "#{destdir}/#{name}")
+            when :file_start
+              validate_entry(destdir, name)
+            when :dir
+              validate_entry(destdir, name)
+              dirlist << "#{destdir}/#{name}"
+            end
+          end
+        end
+        dirlist.each {|d| File.chmod(0755, d)}
+        file_lists
+      end
+
+      def pack(sourcedir, destfile)
+        Zlib::GzipWriter.open(destfile) do |writer|
+          Archive::Tar::Minitar.pack(sourcedir, writer)
+        end
+      end
+
+      private
+
+      # Categorize all the files in tarfile as :valid, :invalid, or :symlink.
+      #
+      # :invalid files include 'x' and 'g' flags from the PAX standard but and any other non-standard tar flags.
+      #   tar format info: http://pic.dhe.ibm.com/infocenter/zos/v1r13/index.jsp?topic=%2Fcom.ibm.zos.r13.bpxa500%2Ftaf.htm
+      #   pax format info: http://pic.dhe.ibm.com/infocenter/zos/v1r13/index.jsp?topic=%2Fcom.ibm.zos.r13.bpxa500%2Fpxarchfm.htm
+      # :symlinks are not supported in Puppet modules
+      # :valid files are any of those that can be used in modules
+      # @param tarfile name of the tarfile
+      # @return [Hash{:symbol => Array<String>}] a hash with file-category keys pointing to lists of filenames.
+      def validate_files(tarfile)
+        file_lists = {:valid => [], :invalid => [], :symlinks => []}
+        Archive::Tar::Minitar.open(tarfile).each do |entry|
+          flag = entry.typeflag
+          if flag.nil? || flag =~ /[[:digit:]]/ && SYMLINK_FLAGS.include?(flag.to_i)
+            file_lists[:symlinks] << entry.name
+          elsif flag.nil? || flag =~ /[[:digit:]]/ && VALID_TAR_FLAGS.include?(flag.to_i)
+            file_lists[:valid] << entry.name
+          else
+            file_lists[:invalid] << entry.name 
+          end
+        end
+        file_lists
+      end
+
+      def validate_entry(destdir, path)
+        if Pathname.new(path).absolute?
+          raise PuppetForge::InvalidPathInPackageError, :entry_path => path, :directory => destdir
+        end
+
+        path = File.expand_path File.join(destdir, path)
+
+        if path !~ /\A#{Regexp.escape destdir}/
+          raise PuppetForge::InvalidPathInPackageError, :entry_path => path, :directory => destdir
+        end
+      end
+    end
+  end
+
+end
+

data/lib/shared/puppet_forge/unpacker.rb

@@ -0,0 +1,68 @@
+require 'pathname'
+require 'shared/puppet_forge/error'
+require 'shared/puppet_forge/tar'
+
+module PuppetForge
+  class Unpacker
+    # Unpack a tar file into a specified directory
+    #
+    # @param filename [String] the file to unpack
+    # @param target [String] the target directory to unpack into
+    # @return [Hash{:symbol => Array<String>}] a hash with file-category keys pointing to lists of filenames.
+    #   The categories are :valid, :invalid and :symlink
+    def self.unpack(filename, target, tmpdir)
+      inst = self.new(filename, target, tmpdir)
+      file_lists = inst.unpack
+      inst.move_into(Pathname.new(target))
+      file_lists
+    end
+
+    # Set the owner/group of the target directory to those of the source
+    # Note: don't call this function on Microsoft Windows
+    #
+    # @param source [Pathname] source of the permissions
+    # @param target [Pathname] target of the permissions change
+    def self.harmonize_ownership(source, target)
+        FileUtils.chown_R(source.stat.uid, source.stat.gid, target)
+    end
+
+    # @param filename [String] the file to unpack
+    # @param target [String] the target directory to unpack into
+    def initialize(filename, target, tmpdir)
+      @filename = filename
+      @target = target
+      @tmpdir = tmpdir
+    end
+
+    # @api private
+    def unpack
+      begin
+        PuppetForge::Tar.instance.unpack(@filename, @tmpdir)
+      rescue PuppetForge::ExecutionFailure => e
+        raise RuntimeError, "Could not extract contents of module archive: #{e.message}"
+      end
+    end
+
+    # @api private
+    def move_into(dir)
+      dir.rmtree if dir.exist?
+      FileUtils.mv(root_dir, dir)
+    ensure
+      FileUtils.rmtree(@tmpdir)
+    end
+
+    # @api private
+    def root_dir
+      return @root_dir if @root_dir
+
+      # Grab the first directory containing a metadata.json file
+      metadata_file = Dir["#{@tmpdir}/**/metadata.json"].sort_by(&:length)[0]
+
+      if metadata_file
+        @root_dir = Pathname.new(metadata_file).dirname
+      else
+        raise "No valid metadata.json found!"
+      end
+    end
+  end
+end

data/lib/shared/puppet_forge/v3.rb

@@ -0,0 +1,13 @@
+module PuppetForge
+  module V3
+    # Normalize a module name to use a hyphen as the separator between the
+    # author and module.
+    #
+    # @example
+    #   PuppetForge::V3.normalize_name('my/module') #=> 'my-module'
+    #   PuppetForge::V3.normalize_name('my-module') #=> 'my-module'
+    def self.normalize_name(name)
+      name.tr('/', '-')
+    end
+  end
+end

data/lib/shared/puppet_forge/v3/module.rb

@@ -0,0 +1,66 @@
+require 'shared/puppet_forge/v3'
+require 'shared/puppet_forge/v3/module_release'
+require 'shared/puppet_forge/connection'
+
+module PuppetForge
+  module V3
+    # Represents metadata for a single Forge module and provides access to
+    # the releases of a module.
+    class Module
+
+      include PuppetForge::Connection
+
+      # @!attribute [r] full_name
+      #   @return [String] The hyphen separated full name of this module
+      attr_reader :full_name
+
+      # @param full_name [String] The name of this module, will be normalized to
+      #   a hyphen separated name.
+      def initialize(full_name)
+        @full_name = PuppetForge::V3.normalize_name(full_name)
+      end
+
+      # Get all released versions of this module
+      #
+      # @example
+      #   mod = PuppetForge::V3::Module.new('timmy-boolean')
+      #   mod.versions
+      #   #=> ["0.9.0-rc1", "0.9.0", "1.0.0", "1.0.1"]
+      #
+      # @return [Array<String>] All published versions of the given module
+      def versions
+        path = "/v3/modules/#{@full_name}"
+        response = conn.get(path)
+
+        releases = []
+
+        response.body['releases'].each do |release|
+          if !release['deleted_at']
+            releases << release['version']
+          end
+        end
+
+        releases.reverse
+      end
+
+      # Get all released versions of this module
+      #
+      # @example
+      #   mod = PuppetForge::V3::Module.new('timmy-boolean')
+      #   mod.latest_version
+      #   #=> "1.0.1"
+      #
+      # @return [String] The latest published version of the given module
+      def latest_version
+        versions.last
+      end
+
+      # Get a specific release of this module off of the forge.
+      #
+      # @return [ModuleRelease] a release object of the given version for this module.
+      def release(version)
+        PuppetForge::V3::ModuleRelease.new(@full_name, version).tap { |mr| mr.conn = conn }
+      end
+    end
+  end
+end

data/lib/shared/puppet_forge/v3/module_release.rb

@@ -0,0 +1,73 @@
+require 'shared/puppet_forge/v3'
+require 'shared/puppet_forge/connection'
+
+module PuppetForge
+  module V3
+    # Access metadata and downloads for a specific module release.
+    class ModuleRelease
+
+      include PuppetForge::Connection
+
+      # @!attribute [r] full_name
+      #   @return [String] The hyphen delimited name of this module
+      attr_reader :full_name
+
+      # @!attribute [r] version
+      #   @return [String] The version of this module
+      attr_reader :version
+
+      # @param full_name [String] The name of the module, will be normalized
+      #   to a hyphen delimited name.
+      # @param version [String]
+      def initialize(full_name, version)
+        @full_name = PuppetForge::V3.normalize_name(full_name)
+        @version   = version
+      end
+
+      # @return [Hash] The complete Forge resposne for this release.
+      def data
+        @data ||= conn.get(resource_url).body
+      end
+
+      # @return [String] The unique identifier for this module release.
+      def slug
+        "#{full_name}-#{version}"
+      end
+
+      # Download this module release to the specified path.
+      #
+      # @param path [Pathname]
+      # @return [void]
+      def download(path)
+        resp = conn.get(file_url)
+        path.open('wb') { |fh| fh.write(resp.body) }
+      end
+
+      # Verify that a downloaded module matches the checksum in the metadata for this release.
+      #
+      # @param path [Pathname]
+      # @return [void]
+      def verify(path)
+        expected_md5 = data['file_md5']
+        file_md5     = Digest::MD5.file(path).hexdigest
+        if expected_md5 != file_md5
+          raise ChecksumMismatch.new("Expected #{path} checksum to be #{expected_md5}, got #{file_md5}")
+        end
+      end
+
+      private
+
+      def file_url
+        "/v3/files/#{slug}.tar.gz"
+      end
+
+      def resource_url
+        "/v3/releases/#{slug}"
+      end
+
+      class ChecksumMismatch < StandardError
+
+      end
+    end
+  end
+end