Class: Runcible::Resources::RepositoryGroup

Inherits:
Base
  • Object
show all
Defined in:
lib/runcible/resources/repository_group.rb

Overview

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#add_http_auth_header, #add_oauth_header, #call, #combine_get_params, #config, #format_payload_json, #generate_log_message, #generate_payload, #get_response, #initialize, #lazy_config=, #log_debug, #log_exception, #logger, #path, #process_response, #required_params

Constructor Details

This class inherits a constructor from Runcible::Base

Class Method Details

.path(id = nil) ⇒ String

Generates the API path for Repository Groups

Parameters:

  • id (String) (defaults to: nil) —

    the ID of the Repository group

Returns:

  • (String) —

    the Repository group path, may contain the id if passed



34
35
36
37
 
# File 'lib/runcible/resources/repository_group.rb', line 34

def self.path(id = nil)
  groups = 'repo_groups/'
  id.nil? ? groups : groups + "#{id}/"
end

Instance Method Details

#associate(id, criteria) ⇒ RestClient::Response

Associates Repositories with a Repository Group

Parameters:

  • id (String) —

    the ID of the Repository group

  • criteria (Hash) —

    criteria based on Mongo syntax representing repos to associate

Returns:

  • (RestClient::Response) 


77
78
79
 
# File 'lib/runcible/resources/repository_group.rb', line 77

def associate(id, criteria)
  call(:post, path(id) + 'actions/associate/', :payload => {:required => criteria})
end

#create(id, optional = {}) ⇒ RestClient::Response

Creates a Repository Group

Parameters:

  • id (String) —

    the ID of the group

  • optional (Hash) (defaults to: {}) —

    container for all optional parameters

Returns:

  • (RestClient::Response) 


44
45
46
47
 
# File 'lib/runcible/resources/repository_group.rb', line 44

def create(id, optional = {})
  required = required_params(binding.send(:local_variables), binding)
  call(:post, path, :payload => { :required => required, :optional => optional })
end

#delete(id) ⇒ RestClient::Response

Deletes a Repository Group

Parameters:

  • id (String) —

    the ID of the Repository group

Returns:

  • (RestClient::Response) 


68
69
70
 
# File 'lib/runcible/resources/repository_group.rb', line 68

def delete(id)
  call(:delete, path(id))
end

#retrieve(id) ⇒ RestClient::Response

Retrieves a Repository Group

Parameters:

  • id (String) —

    the ID of the Repository group

Returns:

  • (RestClient::Response) 


53
54
55
 
# File 'lib/runcible/resources/repository_group.rb', line 53

def retrieve(id)
  call(:get, path(id))
end

#retrieve_all ⇒ RestClient::Response

Retrieves all Repository Group

Returns:

  • (RestClient::Response) 


60
61
62
 
# File 'lib/runcible/resources/repository_group.rb', line 60

def retrieve_all
  call(:get, path)
end

#unassociate(id, criteria) ⇒ RestClient::Response

Unassociates Repositories with a Repository Group

Parameters:

  • id (String) —

    the ID of the Repository group

  • criteria (Hash) —

    criteria based on Mongo syntax representing repos ta unassociate

Returns:

  • (RestClient::Response) 


86
87
88
 
# File 'lib/runcible/resources/repository_group.rb', line 86

def unassociate(id, criteria)
  call(:post, path(id) + 'actions/unassociate/', :payload => {:required => criteria})
end