ActiveCollab Ruby SDK

gem 'active_collab-ruby-sdk', '~> 0.3'

require 'active_collab'

client = ActiveCollab::Client.new(
  account_id: '12345',
  token: 'your-api-token'
)

client = ActiveCollab::Client.new(
  account_id: '12345',
  username: 'user@example.com',
  password: 'your-password',
  client_vendor: 'YourCompany',
  client_name: 'YourApp'
)

# Authenticates and stores the token on the client
client.request_token!

# List all projects (returns a Hash by default)
client.projects.all

# Get projects as a JSON string
client.projects.all(format: 'json')

# Get projects as an OpenStruct
client.projects.all(format: 'object')

tasks = client.projects.tasks(project_id)

# All tasks (active + archived, sorted by created_on desc)
tasks.all

# Active tasks only
tasks.active

# Archived tasks (auto-paginates through all pages)
tasks.archived

# Archived tasks for a specific page (no auto-pagination)
tasks.archived('page' => 2)

# Find a single task - includes comments!
tasks.find(task_id)

# Update a task
tasks.update(task_id, name: 'New name')

# Time records for a specific task
tasks.time_records(task_id)

client.projects.task_lists(project_id).all

time_records = client.projects.time_records(project_id)

# List all time records for a project
time_records.all

# Create a new time record
time_records.create(value: 1.5, user_id: 10, job_type_id: 1)

# List all users
users = client.users.all

client.projects.all(format: 'json')   # => '{"projects": [...]}'
client.projects.all(format: 'object') # => #<OpenStruct projects=[...]>

token = client.token
token.value        # => "your-api-token"
token.auth_header  # => { "X-Angie-AuthApiToken": "your-api-token" }

# Build an app URL (for linking to the ActiveCollab web UI)
client.app_url('/projects/3') # => URI("https://next-app.activecollab.com/12345/projects/3")

begin
  client.projects.all
rescue ActiveCollab::AuthenticationError => e
  # 401 - invalid or expired token
  puts e.message # => "API request failed with status 401"
  puts e.status  # => 401
  puts e.body    # => raw response body
rescue ActiveCollab::NotFoundError => e
  # 404
rescue ActiveCollab::RateLimitError => e
  # 429
rescue ActiveCollab::APIError => e
  # Any other 4xx/5xx
rescue ActiveCollab::ParseError => e
  # Response body was not valid JSON
  puts e.body # => the raw unparseable body
end