Class: MOCO::Project

Inherits:
BaseEntity show all
Defined in:
lib/moco/entities.rb,
lib/moco/entities/project.rb

Overview

Represents a MOCO project

Required attributes for create:

name        - String, project name (e.g., "Website Relaunch")
currency    - String, 3-letter currency code (e.g., "EUR", "USD", "CHF")
start_date  - String, "YYYY-MM-DD" format (required, must be 1st of month if retainer)
finish_date - String, "YYYY-MM-DD" format (required, must be last of month if retainer)
fixed_price - Boolean, true for fixed-price projects
retainer    - Boolean, true for retainer/recurring projects
leader_id   - Integer, user ID of the project leader
customer_id - Integer, company ID of the customer
identifier  - String, project identifier (e.g., "P-123") - only required if manual numbering

Optional attributes:

co_leader_id    - Integer, user ID of co-leader
deal_id         - Integer, associated deal ID
project_group_id - Integer, project group ID
contact_id      - Integer, primary contact ID
secondary_contact_id - Integer, secondary contact ID
billing_contact_id - Integer, billing contact ID
billing_address - String, billing address (multiline with \n)
billing_email_to - String, email for invoices
billing_email_cc - String, CC email for invoices
billing_notes   - String, notes for billing
billing_variant - String, "project", "task", or "user" (default: "project")
setting_include_time_report - Boolean, include time report with invoices
hourly_rate     - Float/Integer, hourly rate (meaning depends on billing_variant)
budget          - Float/Integer, total budget
budget_monthly  - Float/Integer, monthly budget (required if retainer: true)
budget_expenses - Float/Integer, expenses budget
tags            - Array of Strings, e.g., ["Print", "Digital"]
custom_properties - Hash, e.g., {"PO-Number": "123-ABC"}
info            - String, additional info

Read-only attributes (returned by API):

id, active, color, customer (Hash), leader (Hash), co_leader (Hash),
deal (Hash), tasks (Array), contracts (Array), project_group (Hash),
created_at, updated_at

Example:

moco.projects.create(
  name: "Website Relaunch",
  currency: "EUR",
  start_date: "2024-01-01",
  finish_date: "2024-12-31",
  fixed_price: false,
  retainer: false,
  leader_id: 123456,
  customer_id: 789012,
  budget: 50000
)

Instance Attribute Summary collapse

Attributes inherited from BaseEntity

#attributes, #client

Instance Method Summary collapse

Methods inherited from BaseEntity

#==, #association, #destroy, #eql?, #has_many, #hash, #initialize, #inspect, #reload, #save, #to_h, #to_json, #update

Constructor Details

This class inherits a constructor from MOCO::BaseEntity

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



50
51
52
 
# File 'lib/moco/entities.rb', line 50

def active
  @active
end

#customer ⇒ Object

Returns the value of attribute customer.



50
51
52
 
# File 'lib/moco/entities.rb', line 50

def customer
  @customer
end

#id ⇒ Object

Returns the value of attribute id.



50
51
52
 
# File 'lib/moco/entities.rb', line 50

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



50
51
52
 
# File 'lib/moco/entities.rb', line 50

def name
  @name
end

#tasks ⇒ Object

Fetches tasks associated with this project. Always returns a NestedCollectionProxy for consistent interface. Data is fetched lazily when accessed (e.g., .all, .first, .each). Note: Embedded tasks from projects.assigned are available via attributes but may have incomplete fields compared to the dedicated endpoint.



90
91
92
 
# File 'lib/moco/entities/project.rb', line 90

def tasks
  @tasks
end

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/moco/entities/project.rb', line 118

def active?
  status == "active"
end

#activities ⇒ Object

Fetches activities associated with this project.



73
74
75
76
 
# File 'lib/moco/entities/project.rb', line 73

def activities
  # Use the has_many method to fetch activities
  has_many(:activities)
end

#co_leader ⇒ Object 



67
68
69
70
 
# File 'lib/moco/entities/project.rb', line 67

def co_leader
  # Use the association method to fetch the co_leader
  association(:co_leader, "User")
end

#contracts ⇒ Object

Fetches contracts associated with this project.



95
96
97
 
# File 'lib/moco/entities/project.rb', line 95

def contracts
  MOCO::NestedCollectionProxy.new(client, self, :contracts, "ProjectContract")
end

#expenses ⇒ Object

Fetches expenses associated with this project.



79
80
81
82
83
 
# File 'lib/moco/entities/project.rb', line 79

def expenses
  # Don't cache the proxy - create a fresh one each time
  # This ensures we get fresh data when expenses are created/updated/deleted
  MOCO::NestedCollectionProxy.new(client, self, :expenses, "Expense")
end

#leader ⇒ Object 



62
63
64
65
 
# File 'lib/moco/entities/project.rb', line 62

def leader
  # Use the association method to fetch the leader
  association(:leader, "User")
end

#payment_schedules ⇒ Object

Fetches payment schedules associated with this project.



100
101
102
 
# File 'lib/moco/entities/project.rb', line 100

def payment_schedules
  MOCO::NestedCollectionProxy.new(client, self, :payment_schedules, "PaymentSchedule")
end

#project_group ⇒ Object

Get the project group



110
111
112
 
# File 'lib/moco/entities/project.rb', line 110

def project_group
  association(:project_group)
end

#recurring_expenses ⇒ Object

Fetches recurring expenses associated with this project.



105
106
107
 
# File 'lib/moco/entities/project.rb', line 105

def recurring_expenses
  MOCO::NestedCollectionProxy.new(client, self, :recurring_expenses, "RecurringExpense")
end

#to_s ⇒ Object 



52
53
54
 
# File 'lib/moco/entities.rb', line 52

def to_s
  [customer&.name, name].join(" / ")
end