class Runcible::Resources::Content

@see docs.pulpproject.org/dev-guide/integration/rest-api/content/index.html

Public Instance Methods

create_upload_request() click to toggle source

Creates an Upload Request

Request Body Contents: None @return [RestClient::Response] Pulp returns the upload_id which is used for subsequent operations

# File lib/runcible/resources/content.rb, line 19
def create_upload_request
  call(:post, upload_path)
end
delete_upload_request(upload_id) click to toggle source

Delete an upload request

@param [String] upload_id the id of the upload_request returned by #create_upload_request Query Parameters: None @return [RestClient::Response] none

# File lib/runcible/resources/content.rb, line 53
def delete_upload_request(upload_id)
  call(:delete, upload_path("#{upload_id}/"))
end
import_into_repo(repo_id, unit_type_id, upload_id, unit_key, optional = {}) click to toggle source

Import into a repository

@param [String] repo_id identifies the associated repository @param [String] unit_type_id identifies the type of unit the upload represents @param [String] upload_id the id of the upload_request returned by #create_upload_request @param [Object] unit_key unique identifier for the new unit; the contents are contingent

on the type of unit being uploaded

@param [Hash] optional container for all optional parameters @return [RestClient::Response] none

# File lib/runcible/resources/content.rb, line 42
def import_into_repo(repo_id, unit_type_id, upload_id, unit_key, optional = {})
  required = required_params(binding.send(:local_variables), binding)
  call(:post, Repository.path("#{repo_id}/actions/import_upload/"),
                              :payload => { :required => required, :optional => optional })
end
list_all_requests() click to toggle source

List all upload requests

Query Parameters: None @return [RestClient::Response] the list of IDs for all upload requests

on the server; empty list if there are none
# File lib/runcible/resources/content.rb, line 62
def list_all_requests
  call(:get, upload_path)
end
list_orphans(type_id = nil) click to toggle source

List all orphaned content optionally by type

@param type_id content unit type (rpm, puppet_module, etc.) @return list of orphaned content

# File lib/runcible/resources/content.rb, line 80
def list_orphans(type_id = nil)
  call(:get, orphan_path(type_id))
end
orphan_path(type_id = nil) click to toggle source

Generates an api path for orphaned content

@param [String] type_id the type id of the orphaned content @return [String] the content path, may contain the type_id if passed

# File lib/runcible/resources/content.rb, line 70
def orphan_path(type_id = nil)
  path = 'content/orphans/'
  path << "#{type_id}/" if type_id
  path
end
remove_orphans(type_id = nil) click to toggle source

Delete all orphaned content optionally by type

@param type_id content unit type (rpm, puppet_module, etc.) @return list of orphaned content

# File lib/runcible/resources/content.rb, line 88
def remove_orphans(type_id = nil)
  call(:delete, orphan_path(type_id))
end
upload_bits(upload_id, offset, content) click to toggle source

Upload bits

@param [String] upload_id the id of the upload_request returned by #create_upload_request @param [Numeric] offset offset for file assembly @param [File] content content of the file being uploaded to the server @return [RestClient::Response] none

# File lib/runcible/resources/content.rb, line 29
def upload_bits(upload_id, offset, content)
  call(:put, upload_path("#{upload_id}/#{offset}/"), :payload => content, :no_log_payload => true)
end
upload_path(upload_id = nil) click to toggle source

Generates the API path for Contents

@param [String] upload_id the id of the upload_request @return [String] the content path, may contain the upload_id if passed

# File lib/runcible/resources/content.rb, line 11
def upload_path(upload_id = nil)
  upload_id.nil? ? 'content/uploads/' : "content/uploads/#{upload_id}/"
end