class Puppet::Forge

Public Class Methods

new(host = Puppet[:module_repository]) click to toggle source

   # File lib/puppet/forge.rb
26 def initialize(host = Puppet[:module_repository])
27   @host = host
28   @repository = Puppet::Forge::Repository.new(host, USER_AGENT)
29 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
 94 def fetch(input)
 95   name = input.tr('/', '-')
 96   uri = "/v3/releases?module=#{name}&sort_by=version&exclude_fields=#{MODULE_RELEASE_EXCLUSIONS}"
 97   if Puppet[:module_groups]
 98     uri += "&module_groups=#{Puppet[:module_groups].tr('+', ' ')}"
 99   end
100   releases = []
101 
102   while uri
103     # make_http_request URI encodes parameters
104     response = make_http_request(uri)
105 
106     if response.code == 200
107       response = Puppet::Util::Json.load(response.body)
108     else
109       raise ResponseError.new(:uri => response.url, :response => response)
110     end
111 
112     releases.concat(process(response['results']))
113     uri = decode_uri(response['pagination']['next'])
114   end
115 
116   return releases
117 end

make_http_request(*args) click to toggle source

    # File lib/puppet/forge.rb
119 def make_http_request(*args)
120   @repository.make_http_request(*args)
121 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
58 def search(term)
59   matches = []
60   uri = "/v3/modules?query=#{term}"
61   if Puppet[:module_groups]
62     uri += "&module_groups=#{Puppet[:module_groups].tr('+', ' ')}"
63   end
64 
65   while uri
66     # make_http_request URI encodes parameters
67     response = make_http_request(uri)
68 
69     if response.code == 200
70       result = Puppet::Util::Json.load(response.body)
71       uri = decode_uri(result['pagination']['next'])
72       matches.concat result['results']
73     else
74       raise ResponseError.new(:uri => response.url, :response => response)
75     end
76   end
77 
78   matches.each do |mod|
79     mod['author'] = mod['owner']['username']
80     mod['tag_list'] = mod['current_release']['tags']
81     mod['full_name'] = "#{mod['author']}/#{mod['name']}"
82     mod['version'] = mod['current_release']['version']
83     mod['project_url'] = mod['homepage_url']
84     mod['desc'] = mod['current_release']['metadata']['summary'] || ''
85   end
86 end

Private Instance Methods

decode_uri(uri) click to toggle source

    # File lib/puppet/forge.rb
255 def decode_uri(uri)
256   return if uri.nil?
257 
258   Puppet::Util.uri_unescape(uri.tr('+', ' '))
259 end

process(list) click to toggle source

    # File lib/puppet/forge.rb
241 def process(list)
242   l = list.map do |release|
243     metadata = release['metadata']
244     begin
245       ModuleRelease.new(self, release)
246     rescue ArgumentError => e
247       Puppet.warning _("Cannot consider release %{name}-%{version}: %{error}") % { name: metadata['name'], version: metadata['version'], error: e }
248       false
249     end
250   end
251 
252   l.select { |r| r }
253 end

Constants

Attributes

Public Class Methods

Public Instance Methods

Private Instance Methods