puppet-blacksmith 6.1.1 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e245b9c1dd5511577bfdee9a4b13d43747755d360ff6489fa87251033819e823
-  data.tar.gz: 67b1f15dddd35faeb8d86a70e255cae13cbeaf20e6fff840f2ef6c8a187281fd
+  metadata.gz: 7c7bee48c6c7f0c798b04eaa62ff7cc324f86bf3680669d6a7439e21f57a9af5
+  data.tar.gz: 469cf79ee47215247d6b6a7c4becff05d468aa2322cb7b167ed6018ffce78737
 SHA512:
-  metadata.gz: 602fa94091986550141377a0fd867b9a999c865cbfcd74ee98d804d69f4ee983d5883a59e34b1739355a5120531c68294787b85b11a7d1c2247d861588974a05
-  data.tar.gz: d04eafeeb3507cf89af8ef28ac2cbe0efd0ade986c165e8eb68ba9b0edafaba6c2c81c42149abe9f669ddb919f7130e67731f36822ecbe7441dc8b51298c3a55
+  metadata.gz: a3070761a6409076d8ef4881e18b228fd2cb8b7245d9be6f5b39099cb3bbdbd5c97f7ff36865938c916fbb78995bd3dbd7c8356666b858a2c4730dad1d9db9a8
+  data.tar.gz: 901a0e0891af8a24780728a6346f7218720f8057a436c7314f6b01e6998cee10a94b0fb37eace37e25953b3732f0a510a67149a4b898e8119cbad5b840cb5bdc

data/lib/puppet_blacksmith/forge.rb

@@ -5,9 +5,8 @@ require 'base64'
 
 module Blacksmith
   class Forge
-
-    PUPPETLABS_FORGE = "https://forgeapi.puppetlabs.com"
-    CREDENTIALS_FILE_HOME = "~/.puppetforge.yml"
+    PUPPETLABS_FORGE = 'https://forgeapi.puppetlabs.com'
+    CREDENTIALS_FILE_HOME = '~/.puppetforge.yml'
     CREDENTIALS_FILE_PROJECT = '.puppetforge.yml'
     FORGE_TYPE_PUPPET = 'puppet'
     FORGE_TYPE_ARTIFACTORY = 'artifactory'
@@ -15,18 +14,17 @@ module Blacksmith
     DEFAULT_CREDENTIALS = { 'url' => PUPPETLABS_FORGE, 'forge_type' => FORGE_TYPE_PUPPET }
     HEADERS = { 'User-Agent' => "Blacksmith/#{Blacksmith::VERSION} Ruby/#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE}; #{RUBY_PLATFORM})" }
 
-    attr_accessor :username, :password, :url, :client_id, :client_secret, :forge_type, :token, :api_key
+    attr_accessor :username, :password, :url, :forge_type, :token, :api_key
 
     def initialize(username = nil, password = nil, url = nil, forge_type = nil, token = nil, api_key = nil)
       self.username = username
       self.password = password
       self.token = token
       self.api_key = api_key
-      RestClient.proxy = ENV['http_proxy']
+      RestClient.proxy = ENV.fetch('http_proxy', nil)
       load_credentials
-      load_client_credentials_from_file
       self.url = url unless url.nil?
-      if self.url =~ %r{http(s)?://forge.puppetlabs.com}
+      if %r{http(s)?://forge.puppetlabs.com}.match?(self.url)
         puts "Ignoring url entry in .puppetforge.yml: must point to the api server at #{PUPPETLABS_FORGE}, not the Forge webpage"
         self.url = PUPPETLABS_FORGE
       end
@@ -39,12 +37,13 @@ module Blacksmith
       unless package
         v = version ? Regexp.escape(version) : '.*'
         regex = /^#{user}-#{name}-#{v}\.tar\.gz$/
-        pkg = File.expand_path("pkg")
-        f = Dir.new(pkg).select{|fn| fn.match(regex)}.last
+        pkg = File.expand_path('pkg')
+        f = Dir.new(pkg).select { |fn| fn.match(regex) }.last
         raise Errno::ENOENT, "File not found in #{pkg} with regex #{regex}" if f.nil?
+
         package = File.join(pkg, f)
       end
-      raise Errno::ENOENT, "File does not exist: #{package}" unless File.exists?(package)
+      raise Errno::ENOENT, "File does not exist: #{package}" unless File.exist?(package)
 
       upload(user, name, package)
     end
@@ -55,9 +54,9 @@ module Blacksmith
       url = http_url(author, name, file)
       case forge_type
       when FORGE_TYPE_ARTIFACTORY
-        RestClient::Request.execute(:method => :put, :url => url, :payload => File.new(file, 'rb'), :headers => http_headers)
+        RestClient::Request.execute(method: :put, url: url, payload: File.new(file, 'rb'), headers: http_headers)
       else
-        RestClient::Request.execute(:method => :post, :url => url, :payload => {:file => File.new(file, 'rb')}, :headers => http_headers)
+        RestClient::Request.execute(method: :post, url: url, payload: { file: File.new(file, 'rb') }, headers: http_headers)
       end
     rescue RestClient::Exception => e
       raise Blacksmith::Error, "Error uploading #{name} to the forge #{url} [#{e.message}]: #{e.response}"
@@ -68,7 +67,7 @@ module Blacksmith
       when FORGE_TYPE_ARTIFACTORY
         "#{url}/#{author}/#{name}/#{File.basename(file)}"
       else
-        "#{url}/v2/releases"
+        "#{url}/v3/releases"
       end
     end
 
@@ -76,31 +75,15 @@ module Blacksmith
       case forge_type
       when FORGE_TYPE_ARTIFACTORY
         if api_key
-          HEADERS.merge({'X-JFrog-Art-Api' => api_key})
+          HEADERS.merge({ 'X-JFrog-Art-Api' => api_key })
         elsif token
-          HEADERS.merge({'Authorization' => "Bearer #{token}"})
+          HEADERS.merge({ 'Authorization' => "Bearer #{token}" })
         else
-          HEADERS.merge({'Authorization' => "Basic " + Base64.strict_encode64("#{username}:#{password}")})
+          HEADERS.merge({ 'Authorization' => 'Basic ' + Base64.strict_encode64("#{username}:#{password}") })
         end
       else
-        HEADERS.merge({'Authorization' => "Bearer #{api_key || token || oauth_access_token}"})
-      end
-    end
-
-    def oauth_access_token
-      begin
-        response = RestClient.post("#{url}/oauth/token", {
-          'client_id' => client_id,
-          'client_secret' => client_secret,
-          'username' => username,
-          'password' => password,
-          'grant_type' => 'password'
-        }, HEADERS)
-      rescue RestClient::Exception => e
-        raise Blacksmith::Error, "Error login to the forge #{url} as #{username} [#{e.message}]: #{e.response}"
+        HEADERS.merge({ 'Authorization' => "Bearer #{api_key || token}" })
       end
-      login_data = JSON.parse(response)
-      login_data['access_token']
     end
 
     def load_credentials
@@ -122,83 +105,56 @@ module Blacksmith
       self.url = credentials['url'] if credentials['url']
       self.forge_type = credentials['forge_type'] if credentials['forge_type']
 
-      unless (self.username && self.password) || self.token || self.api_key
-        raise Blacksmith::Error, <<-eos
-Could not find Puppet Forge credentials!
+      unless (username && password) || token || api_key
+        raise Blacksmith::Error, <<~EOS
+          Could not find Puppet Forge credentials!
 
-Please set the environment variables
-BLACKSMITH_FORGE_URL
-BLACKSMITH_FORGE_TYPE
-BLACKSMITH_FORGE_USERNAME
-BLACKSMITH_FORGE_PASSWORD
-BLACKSMITH_FORGE_TOKEN
-BLACKSMITH_FORGE_API_KEY
+          Please set the environment variables
+          BLACKSMITH_FORGE_URL
+          BLACKSMITH_FORGE_TYPE
+          BLACKSMITH_FORGE_USERNAME
+          BLACKSMITH_FORGE_PASSWORD
+          BLACKSMITH_FORGE_TOKEN
+          BLACKSMITH_FORGE_API_KEY
 
-or create the file '#{CREDENTIALS_FILE_PROJECT}' or '#{CREDENTIALS_FILE_HOME}'
-with content similiar to:
+          or create the file '#{CREDENTIALS_FILE_PROJECT}' or '#{CREDENTIALS_FILE_HOME}'
+          with content similiar to:
 
----
-url: https://forgeapi.puppetlabs.com
-username: myuser
-password: mypassword
+          ---
+          url: https://forgeapi.puppetlabs.com
+          username: myuser
+          password: mypassword
 
-    eos
+        EOS
       end
     end
 
     def load_credentials_from_file
-      credentials_file = [
-          File.join(Dir.pwd, CREDENTIALS_FILE_PROJECT),
-          File.expand_path(CREDENTIALS_FILE_HOME)
-      ]
-                             .select { |file| File.exists?(file) }
-                             .first
+      credentials_file = [File.join(Dir.pwd, CREDENTIALS_FILE_PROJECT), File.expand_path(CREDENTIALS_FILE_HOME)].select { |file| File.exist?(file) }.first
 
       if credentials_file
-        credentials = YAML.load_file(credentials_file)
+        YAML.load_file(credentials_file)
       else
-        credentials = Hash.new
+        {}
       end
-
-      return credentials
     end
 
     def load_credentials_from_env
-      credentials = Hash.new
+      credentials = {}
 
-      if ENV['BLACKSMITH_FORGE_USERNAME']
-        credentials['username'] = ENV['BLACKSMITH_FORGE_USERNAME']
-      end
+      credentials['username'] = ENV['BLACKSMITH_FORGE_USERNAME'] if ENV['BLACKSMITH_FORGE_USERNAME']
 
-      if ENV['BLACKSMITH_FORGE_PASSWORD']
-        credentials['password'] = ENV['BLACKSMITH_FORGE_PASSWORD']
-      end
+      credentials['password'] = ENV['BLACKSMITH_FORGE_PASSWORD'] if ENV['BLACKSMITH_FORGE_PASSWORD']
 
-      if ENV['BLACKSMITH_FORGE_URL']
-        credentials['url'] = ENV['BLACKSMITH_FORGE_URL']
-      end
+      credentials['url'] = ENV['BLACKSMITH_FORGE_URL'] if ENV['BLACKSMITH_FORGE_URL']
 
-      if ENV['BLACKSMITH_FORGE_TYPE']
-        credentials['forge_type'] = ENV['BLACKSMITH_FORGE_TYPE']
-      end
+      credentials['forge_type'] = ENV['BLACKSMITH_FORGE_TYPE'] if ENV['BLACKSMITH_FORGE_TYPE']
 
-      if ENV['BLACKSMITH_FORGE_TOKEN']
-        credentials['token'] = ENV['BLACKSMITH_FORGE_TOKEN']
-      end
+      credentials['token'] = ENV['BLACKSMITH_FORGE_TOKEN'] if ENV['BLACKSMITH_FORGE_TOKEN']
 
-      if ENV['BLACKSMITH_FORGE_API_KEY']
-        credentials['api_key'] = ENV['BLACKSMITH_FORGE_API_KEY']
-      end
+      credentials['api_key'] = ENV['BLACKSMITH_FORGE_API_KEY'] if ENV['BLACKSMITH_FORGE_API_KEY']
 
-      return credentials
-    end
-
-    def load_client_credentials_from_file
-      credentials_file = File.expand_path(File.join(__FILE__, "..", "credentials.yml"))
-      credentials = YAML.load_file(credentials_file)
-      self.client_id = credentials['client_id']
-      self.client_secret = credentials['client_secret']
+      credentials
     end
   end
-
 end

data/lib/puppet_blacksmith/git.rb

@@ -2,28 +2,19 @@ require 'open3'
 
 module Blacksmith
   class Git
-
-    attr_accessor :path, :tag_pattern, :tag_message_pattern, :tag_sign, :commit_message_pattern
-    attr_writer :tag_pattern, :tag_message_pattern, :tag_sign, :commit_message_pattern
+    attr_accessor :path, :tag_message_pattern, :tag_sign
+    attr_writer :tag_pattern, :commit_message_pattern
 
     # Pattern to use for tags, %s is replaced with the actual version
     def commit_message_pattern
-      @commit_message_pattern || "[blacksmith] Bump version to %s"
+      @commit_message_pattern || '[blacksmith] Bump version to %s'
     end
 
     def tag_pattern
       @tag_pattern || 'v%s'
     end
 
-    def tag_message_pattern
-      @tag_message_pattern
-    end
-
-    def tag_sign
-      @tag_sign
-    end
-
-    def initialize(path = ".")
+    def initialize(path = '.')
       @path = File.expand_path(path)
     end
 
@@ -38,53 +29,57 @@ module Blacksmith
 
     def tag!(version)
       tag = tag_pattern % version
-      command = ["tag", tag]
+      command = ['tag', tag]
       if tag_message_pattern
         tag_message = tag_message_pattern % version
-        command += ["-m", tag_message]
+        command += ['-m', tag_message]
       end
       if tag_sign
         raise Blacksmith::Error, 'Signed tags require messages - set tag_message_pattern' unless tag_message_pattern
-        command += ["-s"]
+
+        command += ['-s']
       end
       exec_git command
     end
 
     def commit_modulefile!(version)
-      files = Blacksmith::Modulefile::FILES.select {|f| File.exists?(File.join(@path,f))}
+      files = Blacksmith::Modulefile::FILES.select { |f| File.exist?(File.join(@path, f)) }
       message = commit_message_pattern % version
-      s = exec_git ["add"] + files
-      s += exec_git ["commit", "-m", message]
+      s = exec_git ['add'] + files
+      s += exec_git ['commit', '-m', message]
       s
     end
 
     def push!
-      s = exec_git ["push"]
-      s += exec_git ["push", "--tags"]
+      s = exec_git ['push']
+      s += exec_git ['push', '--tags']
       s
     end
 
     private
 
     def exec_git(cmd)
-      out = ""
-      err = ""
+      out = ''
+      err = ''
       exit_status = nil
-      new_cmd = ["git", "--git-dir", File.join(@path, '.git'), "--work-tree", @path] + cmd
+      new_cmd = ['git', '--git-dir', File.join(@path, '.git'), '--work-tree', @path] + cmd
       # wait_thr is nil in JRuby < 1.7.5 see http://jira.codehaus.org/browse/JRUBY-6409
-      Open3.popen3(*new_cmd) do |stdin, stdout, stderr, wait_thr|
+      Open3.popen3(*new_cmd) do |_stdin, stdout, stderr, wait_thr|
         out = stdout.read
         err = stderr.read
         exit_status = wait_thr.nil? ? nil : wait_thr.value
       end
       if exit_status.nil?
-        raise Blacksmith::Error, "Command #{new_cmd} failed with stderr:\n#{err}#{"\nstdout:\n" + out unless out.empty?}" unless err.empty?
+        unless err.empty?
+          raise Blacksmith::Error,
+                "Command #{new_cmd} failed with stderr:\n#{err}#{"\nstdout:\n" + out unless out.empty?}"
+        end
       elsif !exit_status.success?
         msg = err.empty? ? out : err
         msg = "\n#{msg}" unless msg.empty?
         raise Blacksmith::Error, "Command #{new_cmd} failed with exit status #{exit_status}#{msg}"
       end
-      return out
+      out
     end
   end
 end

data/lib/puppet_blacksmith/modulefile.rb

@@ -2,31 +2,33 @@ require 'puppet_blacksmith/version_helper'
 
 module Blacksmith
   class Modulefile
-
-    FILES = ["metadata.json"]
+    FILES = ['metadata.json']
 
     attr_reader :path
 
     def initialize(path = nil)
-      @path = path.nil? ? FILES.find {|f| File.exists? f} : path
+      @path = path.nil? ? FILES.find { |f| File.exist? f } : path
       raise Blacksmith::Error, "Unable to find any of #{FILES}" unless @path
     end
 
     def metadata
-      @metadata = JSON.parse(File.read(path)) unless @metadata
+      @metadata ||= JSON.parse(File.read(path))
       @metadata
     end
 
     # name in metadata.json is author-modulename
     def name
-      metadata['name'].split('-',2)[1]
+      metadata['name'].split('-', 2)[1]
     end
+
     def namespace
-      metadata['name'].split('-',2)[0]
+      metadata['name'].split('-', 2)[0]
     end
+
     def author
       metadata['author'] || namespace
     end
+
     def version
       metadata['version']
     end
@@ -34,7 +36,7 @@ module Blacksmith
     def bump_to_version!(new_version)
       text = File.read(path)
       text = replace_version(text, new_version)
-      File.open(path,"w") { |file| file.puts text }
+      File.open(path, 'w') { |file| file.puts text }
       new_version
     end
 
@@ -43,14 +45,14 @@ module Blacksmith
       bump_to_version!(new_version)
     end
 
-    [:major, :minor, :patch, :full].each do |level|
+    %i[major minor patch full].each do |level|
       define_method("bump_#{level}!") { bump!(level) }
     end
 
     def bump_dep!(module_name, version)
       text = File.read(path)
       text = replace_dependency_version(text, module_name, version)
-      File.open(path, "w") {|file| file.puts text}
+      File.open(path, 'w') { |file| file.puts text }
     end
 
     def replace_version(text, version)
@@ -65,7 +67,7 @@ module Blacksmith
     end
 
     def replace_dependency_version(text, module_name, version)
-      module_name = module_name.sub(/\//, '-')
+      module_name = module_name.sub(%r{/}, '-')
       json = JSON.parse(text)
       new_dep_list = []
       json['dependencies'].each do |dep|

data/lib/puppet_blacksmith/rake_tasks.rb

@@ -4,13 +4,12 @@ require 'puppet_blacksmith'
 
 module Blacksmith
   class RakeTask < ::Rake::TaskLib
-
     attr_accessor :tag_pattern, :tag_message_pattern, :tag_sign, :commit_message_pattern, :build
 
     def initialize(*args, &task_block)
       @build = true
-      @task_name = args.shift || "blacksmith"
-      @desc = args.shift || "Puppet Forge utilities"
+      @task_name = args.shift || 'blacksmith'
+      @desc = args.shift || 'Puppet Forge utilities'
       define(args, &task_block)
     end
 
@@ -25,8 +24,7 @@ module Blacksmith
     end
 
     def define(args, &task_block)
-
-      task_block.call(*[self, args].slice(0, task_block.arity)) if task_block
+      yield(*[self, args].slice(0, task_block.arity)) if task_block
 
       # clear any (auto-)pre-existing task
       [
@@ -50,13 +48,12 @@ module Blacksmith
         :push,
         :clean,
         :release,
-        :dependency
+        :dependency,
       ].each do |t|
         Rake::Task.task_defined?("module:#{t}") && Rake::Task["module:#{t}"].clear
       end
 
       namespace :module do
-
         desc 'Build the module using puppet-modulebuilder'
         task :build do
           require 'puppet/modulebuilder'
@@ -66,7 +63,7 @@ module Blacksmith
         end
 
         namespace :bump do
-          [:major, :minor, :patch, :full].each do |level|
+          %i[major minor patch full].each do |level|
             desc "Bump module version to the next #{level.upcase} version"
             task level do
               m = Blacksmith::Modulefile.new
@@ -76,34 +73,34 @@ module Blacksmith
           end
         end
 
-        desc "Bump module to specific version number"
-        task :bump_to_version, [:new_version] do |t, targs|
+        desc 'Bump module to specific version number'
+        task :bump_to_version, [:new_version] do |_t, targs|
           m = Blacksmith::Modulefile.new
           m.bump_to_version!(targs[:new_version])
           puts "Bumping version to #{targs[:new_version]}"
         end
 
-        desc "Bump module version to the next patch"
+        desc 'Bump module version to the next patch'
         task :bump do
           m = Blacksmith::Modulefile.new
           v = m.bump_patch!
           puts "Bumping version from #{m.version} to #{v}"
         end
 
-        desc "Git tag with the current module version"
+        desc 'Git tag with the current module version'
         task :tag do
           m = Blacksmith::Modulefile.new
           git.tag!(m.version)
         end
 
         namespace :version do
-          desc "Get next module version"
+          desc 'Get next module version'
           task :next do
             m = Blacksmith::Modulefile.new
             puts m.increase_version(m.version, 'patch')
           end
 
-          [:major, :minor, :patch].each do |level|
+          %i[major minor patch].each do |level|
             desc "Get the next #{level.upcase} version"
             task "next:#{level}".to_sym do
               m = Blacksmith::Modulefile.new
@@ -112,14 +109,14 @@ module Blacksmith
           end
         end
 
-        desc "Get current module version"
+        desc 'Get current module version'
         task :version do
           m = Blacksmith::Modulefile.new
           puts m.version
         end
 
         namespace :bump_commit do
-          [:major, :minor, :patch, :full].each do |level|
+          %i[major minor patch full].each do |level|
             desc "Bump module version to the next #{level.upcase} version and git commit"
             task level => "bump:#{level}".to_sym do
               m = Blacksmith::Modulefile.new
@@ -128,25 +125,25 @@ module Blacksmith
           end
         end
 
-        desc "Bump version and git commit"
-        task :bump_commit => :bump do
+        desc 'Bump version and git commit'
+        task bump_commit: :bump do
           m = Blacksmith::Modulefile.new
           git.commit_modulefile!(m.version)
         end
 
-        desc "Push module to the Puppet Forge"
-        task :push => :'module:build' do
+        desc 'Push module to the Puppet Forge'
+        task push: :'module:build' do
           m = Blacksmith::Modulefile.new
           forge = Blacksmith::Forge.new
           puts "Uploading to Puppet Forge #{m.namespace}/#{m.name}"
           forge.push!(m.name, nil, m.namespace, m.version)
         end
 
-        desc "Runs clean again"
+        desc 'Runs clean again'
         task :clean do
-          puts "Cleaning for module build"
-          if Rake::Task::task_defined?(:clean)
-            Rake::Task["clean"].execute
+          puts 'Cleaning for module build'
+          if Rake::Task.task_defined?(:clean)
+            Rake::Task['clean'].execute
           else
             # identical to the clean task in puppetlabs_spec_helper on 2021-07-30
             # https://github.com/puppetlabs/puppetlabs_spec_helper/blob/24d7b21280a26cc682146839f41dbf1c0793e494/lib/puppetlabs_spec_helper/rake_tasks.rb#L165-L168
@@ -155,15 +152,20 @@ module Blacksmith
           end
         end
 
-        desc "Release the Puppet module, doing a clean, build, bump_commit, tag, push and git push."
-        release_dependencies = @build ? [:clean, :'module:build', :bump_commit, :tag, :push] : [:clean, :bump_commit, :tag]
-        task :release => release_dependencies do
-          puts "Pushing to remote git repo"
+        desc 'Release the Puppet module, doing a clean, build, bump_commit, tag, push and git push.'
+        release_dependencies = if @build
+                                 %i[clean module:build bump_commit tag
+                                    push]
+                               else
+                                 %i[clean bump_commit tag]
+                               end
+        task release: release_dependencies do
+          puts 'Pushing to remote git repo'
           git.push!
         end
 
-        desc "Set specific module dependency version"
-        task :dependency, [:module_name, :version] do |t, targs|
+        desc 'Set specific module dependency version'
+        task :dependency, [:module_name, :version] do |_t, targs|
           mn = targs[:module_name]
           mv = targs[:version]
           m = Blacksmith::Modulefile.new

data/lib/puppet_blacksmith/version.rb

@@ -1,3 +1,3 @@
 module Blacksmith
-  VERSION = '6.1.1'
+  VERSION = '7.0.0'
 end