class Puppet::Forge

Constants

USER_AGENT

Attributes

host[R]
repository[R]

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<Semantic::Dependency::ModuleRelease>] a list of releases for

the given name

@see Semantic::Dependency::Source#fetch

# File lib/puppet/forge.rb, line 89
def fetch(input)
  name = input.tr('/', '-')
  uri = "/v3/releases?module=#{name}"
  if Puppet[:module_groups]
    uri += "&module_groups=#{Puppet[:module_groups]}"
  end
  releases = []

  while uri
    response = make_http_request(uri)

    if response.code == '200'
      response = JSON.parse(response.body)
    else
      raise ResponseError.new(:uri => URI.parse(@host).merge(uri), :response => response)
    end

    releases.concat(process(response['results']))
    uri = response['pagination']['next']
  end

  return releases
end
make_http_request(*args) click to toggle source 
# File lib/puppet/forge.rb, line 113
def make_http_request(*args)
  @repository.make_http_request(*args)
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" => "http://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, line 54
def search(term)
  matches = []
  uri = "/v3/modules?query=#{URI.escape(term)}"
  if Puppet[:module_groups]
    uri += "&module_groups=#{Puppet[:module_groups]}"
  end

  while uri
    response = make_http_request(uri)

    if response.code == '200'
      result = JSON.parse(response.body)
      uri = result['pagination']['next']
      matches.concat result['results']
    else
      raise ResponseError.new(:uri => URI.parse(@host).merge(uri), :response => response)
    end
  end

  matches.each do |mod|
    mod['author'] = mod['owner']['username']
    mod['tag_list'] = mod['current_release']['tags']
    mod['full_name'] = "#{mod['author']}/#{mod['name']}"
    mod['version'] = mod['current_release']['version']
    mod['project_url'] = mod['homepage_url']
    mod['desc'] = mod['current_release']['metadata']['summary'] || ''
  end
end

Public Class Methods

new(host = Puppet[:module_repository]) click to toggle source 
# File lib/puppet/forge.rb, line 22
def initialize(host = Puppet[:module_repository])
  @host = host
  @repository = Puppet::Forge::Repository.new(host, USER_AGENT)
end