Class: OpenBuildServiceAPI::API::Projects

Inherits:
Object
  • Object
show all
Defined in:
lib/api/projects.rb

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Projects

Returns a new instance of Projects.



4
5
6
 
# File 'lib/api/projects.rb', line 4

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(name, meta = nil) ⇒ Object

Raises:



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/api/projects.rb', line 8

def create(name, meta = nil)
  raise ProjectAlreadyExistsError.new("Project name '#{name}' has already been taken.") if exists?(name)

  meta = meta ? meta : meta_for_new_project(name)

  begin
    response = @connection.send_request(:put, "/source/#{CGI.escape(name)}/_meta", request_body: meta)
  rescue RequestError => err
    raise ProjectCreationPermissionError.new(err.error_summary) if err.error_code == 'create_project_no_permission'
    raise
  end

  return Project.new(projects: self, connection: @connection, name: name) if response.is_a?(Net::HTTPOK)
  raise ProjectCreationFailedError.new("could not create project. API responded with '#{response.code}': #{response.body}")
end

#exists?(name) ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/api/projects.rb', line 29

def exists?(name)
  !!find(name)
end

#find(name) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/api/projects.rb', line 33

def find(name)
  begin
    project_data = Nokogiri::XML(@connection.send_request(:get, "/source/#{CGI.escape(name)}").body)
    packages = project_data.xpath('//entry').map { |package| package.attr('name') }

    Project.new(projects: self, name: name, packages: packages, connection: @connection)
  rescue RequestError => err
    return if err.error_code == 'unknown_project'
    raise
  end
end

#find!(name) ⇒ Object

Raises:



45
46
47
48
49
50
 
# File 'lib/api/projects.rb', line 45

def find!(name)
  project = find(name)

  raise ProjectNotFoundError.new("Project '#{name}' does not exist.") unless project
  project
end

#list ⇒ Object 



24
25
26
27
 
# File 'lib/api/projects.rb', line 24

def list
  projects = Nokogiri::XML(@connection.send_request(:get, '/source').body)
  projects.xpath('//entry').map {|project| Project.new(projects: self, connection: @connection, name: project.attr('name')) }
end