Add support for headers parameter in ruby provider

Author: ananace

lib/puppet/provider/archive/ruby.rb

@@ -214,6 +214,7 @@ def download(location, filepath)
       filepath,
       username: resource[:username],
       password: resource[:password],
+      headers: resource[:headers],
       cookie: resource[:cookie],
       proxy_server: resource[:proxy_server],
       proxy_type: resource[:proxy_type],

lib/puppet_x/bodeco/util.rb

@@ -70,6 +70,7 @@ class HTTP
       def initialize(_url, options)
         @username = options[:username]
         @password = options[:password]
+        @headers = options[:headers]
         @cookie = options[:cookie]
         @insecure = options[:insecure]
 
@@ -84,9 +85,11 @@ def initialize(_url, options)
       end
 
       def generate_request(uri)
-        header = @cookie && { 'Cookie' => @cookie }
+        headers = {}
+        headers.merge!(@headers.to_h { |hdr| hdr.split(':', 2).map(&:strip) }) if @headers
+        headers['Cookie'] = @cookie if @cookie
 
-        request = Net::HTTP::Get.new(uri.request_uri, header)
+        request = Net::HTTP::Get.new(uri.request_uri, headers)
         request.basic_auth(@username, @password) if @username && @password
         request
       end

spec/unit/puppet/provider/archive/ruby_spec.rb

@@ -150,6 +150,82 @@
         expect { provider.transfer_download(name) }.to raise_error(Puppet::Error, %r{Download file checksum mismatch})
       end
     end
+
+    describe 'header specified' do
+      let(:source_location) { 'http://example.com' }
+      let(:resource_properties) do
+        {
+          name: name,
+          source: source_location,
+          headers: ['Authorization: OAuth 123ABC']
+        }
+      end
+
+      it 'downloads with header' do
+        http_dbl = double
+        allow(http_dbl).to receive(:request) do |request|
+          expect(request['Authorization']).to eq('OAuth 123ABC')
+        end
+        allow(Net::HTTP).to receive(:start).and_yield(http_dbl)
+
+        provider.download(source_location, name)
+
+        expect(Net::HTTP).to have_received(:start)
+        expect(http_dbl).to have_received(:request)
+      end
+    end
+
+    describe 'multiple headers specified' do
+      let(:source_location) { 'http://example.com' }
+      let(:resource_properties) do
+        {
+          name: name,
+          source: source_location,
+          headers: ['Authorization: OAuth 123ABC', 'Accept: application/json']
+        }
+      end
+
+      it 'downloads with headers' do
+        http_dbl = double
+        allow(http_dbl).to receive(:request) do |request|
+          expect(request['Authorization']).to eq('OAuth 123ABC')
+          expect(request['Accept']).to eq('application/json')
+        end
+        allow(Net::HTTP).to receive(:start).and_yield(http_dbl)
+
+        provider.download(source_location, name)
+
+        expect(Net::HTTP).to have_received(:start)
+        expect(http_dbl).to have_received(:request)
+      end
+    end
+
+    describe 'headers and cookie specified' do
+      let(:source_location) { 'http://example.com' }
+      let(:resource_properties) do
+        {
+          name: name,
+          source: source_location,
+          headers: ['Authorization: OAuth 123ABC', 'Accept: application/json'],
+          cookie: 'something'
+        }
+      end
+
+      it 'downloads with headers and cookie' do
+        http_dbl = double
+        allow(http_dbl).to receive(:request) do |request|
+          expect(request['Authorization']).to eq('OAuth 123ABC')
+          expect(request['Accept']).to eq('application/json')
+          expect(request['Cookie']).to eq('something')
+        end
+        allow(Net::HTTP).to receive(:start).and_yield(http_dbl)
+
+        provider.download(source_location, name)
+
+        expect(Net::HTTP).to have_received(:start)
+        expect(http_dbl).to have_received(:request)
+      end
+    end
   end
 end
 # rubocop:enable RSpec/MultipleMemoizedHelpers