Class: Puppet::Forge::Repository

Inherits:
Object
  • Object
show all
Includes:
Errors
Defined in:
lib/puppet/forge/repository.rb

Overview

Repository

This class is a file for accessing remote repositories with modules.

Constant Summary collapse

NET_HTTP_EXCEPTIONS =

List of Net::HTTP exceptions to catch

[
  EOFError,
  Errno::ECONNABORTED,
  Errno::ECONNREFUSED,
  Errno::ECONNRESET,
  Errno::EINVAL,
  Errno::ETIMEDOUT,
  Net::HTTPBadResponse,
  Net::HTTPHeaderSyntaxError,
  Net::ProtocolError,
  SocketError,
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host, for_agent) ⇒ Repository

Instantiate a new repository instance rooted at the url. The library will report for_agent in the User-Agent to the repository.



41
42
43
44
45
46
 
# File 'lib/puppet/forge/repository.rb', line 41

def initialize(host, for_agent)
  @host  = host
  @agent = for_agent
  @cache = Cache.new(self)
  @uri   = URI.parse(host)
end

Instance Attribute Details

#cache ⇒ Object (readonly) 



19
20
21
 
# File 'lib/puppet/forge/repository.rb', line 19

def cache
  @cache
end

#uri ⇒ Object (readonly) 



19
20
21
 
# File 'lib/puppet/forge/repository.rb', line 19

def uri
  @uri
end

Instance Method Details

#cache_key ⇒ Object

Return the cache key for this repository, this a hashed string based on the URI.



153
154
155
156
157
158
 
# File 'lib/puppet/forge/repository.rb', line 153

def cache_key
  return @cache_key ||= [
    @host.to_s.gsub(/[^[:alnum:]]+/, '_').sub(/_$/, ''),
    Digest::SHA1.hexdigest(@host.to_s)
  ].join('-').freeze
end

#get_http_object ⇒ Net::HTTP::Proxy

Return a Net::HTTP::Proxy object constructed from the settings provided accessing the repository.

This method optionally configures SSL correctly if the URI scheme is ‘https’, including setting up the root certificate store so remote server SSL certificates can be validated.

Returns:

  • (Net::HTTP::Proxy) —

    object constructed from repo settings



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/puppet/forge/repository.rb', line 123

def get_http_object
  proxy_class = Net::HTTP::Proxy(Puppet::Util::HttpProxy.http_proxy_host, Puppet::Util::HttpProxy.http_proxy_port)
  proxy = proxy_class.new(@uri.host, @uri.port)

  if @uri.scheme == 'https'
    cert_store = OpenSSL::X509::Store.new
    cert_store.set_default_paths

    proxy.use_ssl = true
    proxy.verify_mode = OpenSSL::SSL::VERIFY_PEER
    proxy.cert_store = cert_store
  end

  proxy
end

#get_request_object(path) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/puppet/forge/repository.rb', line 55

def get_request_object(path)
  headers = {
    "User-Agent" => user_agent,
  }

  if Puppet.features.zlib? && Puppet[:zlib] && RUBY_VERSION >= "1.9"
    headers = headers.merge({
      "Accept-Encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3",
    })
  end

  request = Net::HTTP::Get.new(URI.escape(path), headers)

  unless @uri.user.nil? || @uri.password.nil?
    request.basic_auth(@uri.user, @uri.password)
  end

  return request
end

#make_http_request(path, io = nil) ⇒ Object

Return a Net::HTTPResponse read for this path.



49
50
51
52
53
 
# File 'lib/puppet/forge/repository.rb', line 49

def make_http_request(path, io = nil)
  Puppet.debug "HTTP GET #{@host}#{path}"
  request = get_request_object(path)
  return read_response(request, io)
end

#read_response(request, io = nil) ⇒ Net::HTTPResponse

Return a Net::HTTPResponse read from this HTTPRequest request.

Parameters:

  • request (Net::HTTPRequest) —

    request to make

Returns:

  • (Net::HTTPResponse) —

    response from request

Raises:



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/puppet/forge/repository.rb', line 83

def read_response(request, io = nil)
  http_object = get_http_object

  http_object.start do |http|
    response = http.request(request)

    if Puppet.features.zlib? && Puppet[:zlib]
      if response && response.key?("content-encoding")
        case response["content-encoding"]
        when "gzip"
          response.body = Zlib::GzipReader.new(StringIO.new(response.read_body), :encoding => "ASCII-8BIT").read
          response.delete("content-encoding")
        when "deflate"
          response.body = Zlib::Inflate.inflate(response.read_body)
          response.delete("content-encoding")
        end
      end
    end

    io.write(response.body) if io.respond_to? :write
    response
  end
rescue *NET_HTTP_EXCEPTIONS => e
  raise CommunicationError.new(:uri => @uri.to_s, :original => e)
rescue OpenSSL::SSL::SSLError => e
  if e.message =~ /certificate verify failed/
    raise SSLVerifyError.new(:uri => @uri.to_s, :original => e)
  else
    raise e
  end
end

#retrieve(release) ⇒ Object

Return the local file name containing the data downloaded from the repository at release (e.g. “myuser-mymodule”).



141
142
143
144
 
# File 'lib/puppet/forge/repository.rb', line 141

def retrieve(release)
  path = @host.chomp('/') + release
  return cache.retrieve(path)
end

#to_s ⇒ Object

Return the URI string for this repository.



147
148
149
 
# File 'lib/puppet/forge/repository.rb', line 147

def to_s
  "#<#{self.class} #{@host}>"
end