bloomy

Bloomy

Bloomy is an unofficial Ruby library for interacting with the Bloom Growth API. It provides convenient methods for getting user details, todos, rocks, meetings, measurables, and issues.

Installation

Add this line to your application's Gemfile:

bundle add bloomy

Or install it to your system:

gem install bloomy

Get Started

You can find the full docs here but here's a quick overview to get you started.

Initialize the Configuration

First, you need to initialize the configuration and set up the API key.

require 'bloomy'

config = Bloomy::Configuration.new

Configure the API Key

You can configure the API key using your username and password. Optionally, you can store the API key locally under ~/.bloomy/config.yaml for future use.

config.configure_api_key("your_username", "your_password", store_key: true)

You can also set an BG_API_KEY environment variable and it will be loaded automatically for you once you initialize a client. A configuration is useful if you plan to use a fixed API key for your operations. However, you can also pass an API key when initializing a client without doing any configuration.

Client Initialization

Once the configuration is set up, you can initialize the client. The client provides access to various features such as managing users, todos, rocks, meetings, measurables, and issues.

[!NOTE] Passing an API key is entirely optional and only useful if you plan to use different API keys to manage different organizations. This will bypass the regular configuration process.

client = Bloomy::Client.new(api_key: "abc...")

Using Client Features

User Management

To interact with user-related features:

# Fetch current user details
current_user_details = client.user.details

# Search for users
search_results = client.user.search("John Doe")

Meeting Management

To interact with meeting-related features:

# List all meetings for the current user
meetings = client.meeting.list

# Get details of a specific meeting
meeting_details = client.meeting.details(meeting_id)

Todo Management

To interact with todo-related features:

# List all todos for the current user
todos = client.todo.list

# Create a new todo
new_todo = client.todo.create(meeting_id: 1, title: "New Task", due_date: "2024-06-15")

Goal Management

To interact with goal-related features:

# List all goals for the current user
goals = client.goal.list

# Create a new goal
new_goal = client.goal.create(meeting_id: 1, title: "New Goal")

Scorecard Management

To interact with measurable-related features:

# Get user scorecard
user_scorecard = client.scorecard.list(user_id: 1)

# Get a meeting scorecard
meeting_scorecard = client.scorecard.list(meeting_id: 1)

Issue Management

To interact with issue-related features:

# Get details of a specific issue
issue_details = client.issue.details(issue_id)

# Create a new issue
new_issue = client.issue.create(meeting_id: 1, title: "New Issue")