Class: Puree::Project

Inherits:
Resource show all
Defined in:
lib/puree/project.rb

Overview

Project resource

Instance Attribute Summary

Attributes inherited from Resource

#response

Instance Method Summary collapse

Methods inherited from Resource

#created, #get, #locale, #modified, #set_content, #uuid

Constructor Details

#initialize(base_url: nil, username: nil, password: nil, basic_auth: nil) ⇒ Project

Returns a new instance of Project.

Parameters:

  • base_url (String) (defaults to: nil)
  • username (String) (defaults to: nil)
  • password (String) (defaults to: nil)
  • basic_auth (Boolean) (defaults to: nil) 


11
12
13
14
15
16
17
18
 
# File 'lib/puree/project.rb', line 11

def initialize(base_url: nil, username: nil, password: nil, basic_auth: nil)
  super(api: :project,
        base_url: base_url,
        username: username,
        password: password,
        bleeding: false, # stable API does not return person roles
        basic_auth: basic_auth)
end

Instance Method Details

#acronym ⇒ String

Acronym

Returns:

  • (String) 


23
24
25
 
# File 'lib/puree/project.rb', line 23

def acronym
  @metadata['acronym']
end

#description ⇒ String

Description

Returns:

  • (String) 


30
31
32
 
# File 'lib/puree/project.rb', line 30

def description
  @metadata['description']
end

#metadata ⇒ Hash

All metadata

Returns:

  • (Hash) 


93
94
95
 
# File 'lib/puree/project.rb', line 93

def metadata
  @metadata
end

#organisation ⇒ Array<Hash>

Organisation

Returns:

  • (Array<Hash>) 


37
38
39
 
# File 'lib/puree/project.rb', line 37

def organisation
  @metadata['organisation']
end

#owner ⇒ Hash

Owner

Returns:

  • (Hash) 


44
45
46
 
# File 'lib/puree/project.rb', line 44

def owner
  @metadata['owner']
end

#person ⇒ Hash<Array,Array,Array>

Person (internal, external, other)

Returns:

  • (Hash<Array,Array,Array>) 


51
52
53
 
# File 'lib/puree/project.rb', line 51

def person
  @metadata['person']
end

#status ⇒ String

Status

Returns:

  • (String) 


58
59
60
 
# File 'lib/puree/project.rb', line 58

def status
  @metadata['status']
end

#temporal ⇒ Hash

Temporal, expected and actual start and end dates as UTC datetime.

Returns:

  • (Hash) 


65
66
67
 
# File 'lib/puree/project.rb', line 65

def temporal
  @metadata['temporal']
end

#title ⇒ String

Title

Returns:

  • (String) 


72
73
74
 
# File 'lib/puree/project.rb', line 72

def title
  @metadata['title']
end

#type ⇒ String

Type

Returns:

  • (String) 


79
80
81
 
# File 'lib/puree/project.rb', line 79

def type
  @metadata['type']
end

#url ⇒ String

URL

Returns:

  • (String) 


86
87
88
 
# File 'lib/puree/project.rb', line 86

def url
  @metadata['url']
end