class Puppet::Forge
Constants
- MODULE_RELEASE_EXCLUSIONS
- USER_AGENT
Attributes
host[R]
repository[R]
Public Class Methods
new(host = Puppet[:module_repository])
click to toggle source
# File lib/puppet/forge.rb 25 def initialize(host = Puppet[:module_repository]) 26 @host = host 27 @repository = Puppet::Forge::Repository.new(host, USER_AGENT) 28 end
Public Instance Methods
fetch(input)
click to toggle source
Fetches {ModuleRelease} entries for each release of the named module.
@param input [String] the module name to look up @return [Array<SemanticPuppet::Dependency::ModuleRelease>] a list of releases for
the given name
@see SemanticPuppet::Dependency::Source#fetch
# File lib/puppet/forge.rb 93 def fetch(input) 94 name = input.tr('/', '-') 95 uri = "/v3/releases?module=#{name}&sort_by=version&exclude_fields=#{MODULE_RELEASE_EXCLUSIONS}" 96 if Puppet[:module_groups] 97 uri += "&module_groups=#{Puppet[:module_groups].tr('+', ' ')}" 98 end 99 releases = [] 100 101 while uri 102 # make_http_request URI encodes parameters 103 response = make_http_request(uri) 104 105 if response.code == 200 106 response = Puppet::Util::Json.load(response.body) 107 else 108 raise ResponseError.new(:uri => response.url, :response => response) 109 end 110 111 releases.concat(process(response['results'])) 112 uri = decode_uri(response['pagination']['next']) 113 end 114 115 return releases 116 end
make_http_request(*args)
click to toggle source
# File lib/puppet/forge.rb 118 def make_http_request(*args) 119 @repository.make_http_request(*args) 120 end
search(term)
click to toggle source
Return a list of module metadata hashes that match the search query. This return value is used by the module_tool face install search, and displayed to on the console.
Example return value:
[
{ "author" => "puppetlabs", "name" => "bacula", "tag_list" => ["backup", "bacula"], "releases" => [{"version"=>"0.0.1"}, {"version"=>"0.0.2"}], "full_name" => "puppetlabs/bacula", "version" => "0.0.2", "project_url" => "https://github.com/puppetlabs/puppetlabs-bacula", "desc" => "bacula" }
]
@param term [String] search term @return [Array] modules found @raise [Puppet::Forge::Errors::CommunicationError] if there is a network
related error
@raise [Puppet::Forge::Errors::SSLVerifyError] if there is a problem
verifying the remote SSL certificate
@raise [Puppet::Forge::Errors::ResponseError] if the repository returns a
bad HTTP response
# File lib/puppet/forge.rb 57 def search(term) 58 matches = [] 59 uri = "/v3/modules?query=#{term}" 60 if Puppet[:module_groups] 61 uri += "&module_groups=#{Puppet[:module_groups].tr('+', ' ')}" 62 end 63 64 while uri 65 # make_http_request URI encodes parameters 66 response = make_http_request(uri) 67 68 if response.code == 200 69 result = Puppet::Util::Json.load(response.body) 70 uri = decode_uri(result['pagination']['next']) 71 matches.concat result['results'] 72 else 73 raise ResponseError.new(:uri => response.url, :response => response) 74 end 75 end 76 77 matches.each do |mod| 78 mod['author'] = mod['owner']['username'] 79 mod['tag_list'] = mod['current_release']['tags'] 80 mod['full_name'] = "#{mod['author']}/#{mod['name']}" 81 mod['version'] = mod['current_release']['version'] 82 mod['project_url'] = mod['homepage_url'] 83 mod['desc'] = mod['current_release']['metadata']['summary'] || '' 84 end 85 end
Private Instance Methods
decode_uri(uri)
click to toggle source
# File lib/puppet/forge.rb 254 def decode_uri(uri) 255 return if uri.nil? 256 257 Puppet::Util.uri_unescape(uri.tr('+', ' ')) 258 end
process(list)
click to toggle source
# File lib/puppet/forge.rb 240 def process(list) 241 l = list.map do |release| 242 metadata = release['metadata'] 243 begin 244 ModuleRelease.new(self, release) 245 rescue ArgumentError => e 246 Puppet.warning _("Cannot consider release %{name}-%{version}: %{error}") % { name: metadata['name'], version: metadata['version'], error: e } 247 false 248 end 249 end 250 251 l.select { |r| r } 252 end