Step by Step Guide to Building a Wrike API Integration in Ruby

Aug 16, 2024 • 5 minute read

Introduction

Hey there, fellow developer! Ready to supercharge your project management workflow with Wrike's API? You're in the right place. We'll be using the nifty wrike3 package to make our lives easier. Buckle up!

Prerequisites

Before we dive in, make sure you've got:

A Ruby environment up and running
A Wrike account with an API token (if you don't have one, hop over to your Wrike account settings to generate it)

Installation

Let's kick things off by installing the wrike3 gem. It's as simple as:

gem install wrike3

Authentication

Now, let's get you authenticated. It's pretty straightforward:

require 'wrike3'

client = Wrike3::Client.new(access_token: 'YOUR_API_TOKEN')

Replace 'YOUR_API_TOKEN' with your actual Wrike API token. Easy peasy!

Basic API Requests

Time to make some requests! Let's start with fetching workspaces and tasks:

# Get all workspaces
workspaces = client.workspaces

# Get tasks from a specific workspace
tasks = client.tasks(workspace_id: workspaces.first.id)

Creating and Updating Data

Creating and updating tasks is a breeze:

# Create a new task
new_task = client.create_task(title: 'My New Task', description: 'This is a test task')

# Update a task
updated_task = client.update_task(id: new_task.id, title: 'Updated Task Title')

Advanced Operations

Want to work with custom fields or handle attachments? We've got you covered:

# Working with custom fields
task_with_custom_fields = client.create_task(
  title: 'Task with Custom Fields',
  custom_fields: { 'Custom Field ID': 'Custom Field Value' }
)

# Handling attachments
client.create_attachment(task_id: task.id, file: File.open('path/to/file.pdf'))

Error Handling and Best Practices

Don't forget to handle those pesky errors and respect rate limits:

begin
  result = client.some_api_call
rescue Wrike3::Error => e
  puts "Oops! Something went wrong: #{e.message}"
end

# Respect rate limits by adding delays between requests
sleep 1 # Add a 1-second delay between requests

Example Use Case

Let's put it all together with a simple task management script:

require 'wrike3'

client = Wrike3::Client.new(access_token: 'YOUR_API_TOKEN')

# Get all tasks due today
today = Date.today.to_s
due_today = client.tasks(dates: { due: { start: today, end: today } })

puts "Tasks due today:"
due_today.each do |task|
  puts "- #{task.title}"
  
  # Mark task as completed
  client.update_task(id: task.id, status: 'Completed')
  puts "  Marked as completed!"
end

Conclusion

And there you have it! You're now equipped to build some awesome Wrike integrations using Ruby. Remember, this is just scratching the surface - there's so much more you can do with the Wrike API.

Keep exploring, keep coding, and most importantly, have fun! If you want to dive deeper, check out the Wrike API documentation and the wrike3 gem documentation.

Happy coding!