bloomy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 783fa82ea83467cc8e6d012305831a5bfb73f43897c50b8f80a96276778004f5
+  data.tar.gz: 0e2f5b69910a85d9866d2715921ee5b27f569c466aaac16f5a4343db3bc71ca7
+SHA512:
+  metadata.gz: 42f086d17f1b29d61060629a6630a7f8380cf54cb4d993425dd44f0d859765bfbf400d3f6a42df1ec5d6f910c8a45904fd91875005aa76aff9498e50112a6f1b
+  data.tar.gz: b9ac85ecf2dc0114b1cdf92d71def98927233b103b260970f52797a728b0dd8077db04eabc68aba72c0c77df9091c327d8a2151efe2f95767139dd440975a4d1

data/.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: local
+    hooks:
+      - id: standardrb
+        name: standardrb
+        description: Enforce the community Ruby Style Guide with standardrb
+        entry: standardrb
+        language: ruby
+        types: ["ruby"]
+        args: ["--fix"]

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,127 @@
+# Bloomy
+
+The Bloomy is a 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:
+
+```ruby
+gem 'bloomy'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install bloomy
+```
+
+## Configuration
+
+### Initialize the Configuration
+
+First, you need to initialize the configuration and set up the API key.
+
+```ruby
+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 for future use.
+
+```ruby
+config.configure_api_key("your_username", "your_password", store_key: true)
+```
+
+Alternatively you can set an `API_KEY` environment variable and it will be loaded automatically for you once you initialize a client.
+
+## 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.
+
+```ruby
+client = Bloomy::Client.new
+```
+
+## Using Client Features
+
+### User Management
+
+To interact with user-related features:
+
+```ruby
+# 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:
+
+```ruby
+# 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:
+
+```ruby
+# List all todos for the current user
+todos = client.todo.list
+
+# Create a new todo
+new_todo = client.todo.create(title: "New Task", meeting_id: 1, due_date: "2024-06-15")
+```
+
+### Rock Management
+
+To interact with rock-related features:
+
+```ruby
+# List all rocks for the current user
+rocks = client.rock.list
+
+# Create a new rock
+new_rock = client.rock.create(title: "New Rock", meeting_id: 1)
+```
+
+### Measurable Management
+
+To interact with measurable-related features:
+
+```ruby
+# Get current week details
+current_week = client.measurable.current_week
+
+# Get the scorecard for the user
+scorecard = client.measurable.scorecard
+```
+
+### Issue Management
+
+To interact with issue-related features:
+
+```ruby
+# Get details of a specific issue
+issue_details = client.issue.details(issue_id)
+
+# Create a new issue
+new_issue = client.issue.create("New Issue", meeting_id)
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bloomy.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/bloomy/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "bloomy"
+  spec.version = Bloomy::VERSION
+  spec.authors = ["Franccesco Orozco"]
+  spec.email = ["franccesco@thatai.dev"]
+
+  spec.summary = "Manage your Bloom Growth account from the command line."
+  spec.homepage = "https://github.com/franccesco/bloomy"
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.licenses = ["MIT"]
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "faraday", "~> 2.9"
+  spec.add_development_dependency "rspec", "~> 3.13"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/exe/bloomy

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bloomy"

data/lib/bloomy/client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "faraday"
+require_relative "operations/users"
+require_relative "operations/todos"
+require_relative "operations/rocks"
+require_relative "operations/meetings"
+require_relative "operations/measurables"
+require_relative "operations/issues"
+
+module Bloomy
+  # The Client class is the main entry point for interacting with the Bloomy API.
+  # It provides methods for managing users, todos, rocks, meetings, measurables, and issues.
+  class Client
+    attr_reader :configuration, :user, :todo, :rock, :meeting, :measurable, :issue
+
+    # Initializes a new Client instance
+    #
+    # @example
+    #   client = Bloomy::Client.new
+    #   client.meetings.list
+    #   client.user.details
+    #   client.meeting.delete(id)
+    def initialize
+      @configuration = Configuration.new
+      @base_url = "https://app.bloomgrowth.com/api/v1"
+      @conn = Faraday.new(url: @base_url) do |faraday|
+        faraday.response :json
+        faraday.adapter Faraday.default_adapter
+        faraday.headers["Accept"] = "*/*"
+        faraday.headers["Content-Type"] = "application/json"
+        faraday.headers["Authorization"] = "Bearer #{configuration.api_key}"
+      end
+      @user = User.new(@conn)
+      @user_id = @user.default_user_id
+      @todo = Todo.new(@conn, @user_id)
+      @rock = Rock.new(@conn, @user_id)
+      @meeting = Meeting.new(@conn, @user_id)
+      @measurable = Measurable.new(@conn, @user_id)
+      @issue = Issue.new(@conn, @user_id)
+    end
+  end
+end

data/lib/bloomy/configuration.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "faraday"
+require "yaml"
+
+module Bloomy
+  # The Configuration class is responsible for managing the authentication
+  class Configuration
+    attr_accessor :api_key
+
+    # Initializes a new Configuration instance
+    #
+    # @param [String, nil] optional_parameter Pass an optional API key
+    # @example
+    #   config = Bloomy::Configuration.new(api_key)
+    def initialize(api_key = nil)
+      @api_key = api_key || ENV["API_KEY"] || load_api_key
+    end
+
+    # Configures the API key using the provided username and password
+    #
+    # @param username [String] the username for authentication
+    # @param password [String] the password for authentication
+    # @param store_key [Boolean] whether to store the API key (default: false)
+    # @return [void]
+    # @note This method only fetches and stores the API key if it is currently nil.
+    #   It saves the key under '~/.bloomy/config.yaml' if 'store_key: true' is passed.
+    # @example
+    #   config.configure_api_key("user", "pass", store_key: true)
+    #   config.api_key
+    #   # => 'xxxx...'
+    def configure_api_key(username, password, store_key: false)
+      @api_key = fetch_api_key(username, password)
+      store_api_key if store_key
+    end
+
+    private
+
+    # Fetches the API key using the provided username and password
+    #
+    # @param username [String] the username for authentication
+    # @param password [String] the password for authentication
+    # @return [String] the fetched API key
+    def fetch_api_key(username, password)
+      conn = Faraday.new(url: "https://app.bloomgrowth.com")
+      response = conn.post("/Token", "grant_type=password&userName=#{username}&password=#{password}",
+        {"Content-Type" => "application/x-www-form-urlencoded"})
+      JSON.parse(response.body)["access_token"]
+    end
+
+    # Stores the API key in a local configuration file
+    #
+    # @return [void]
+    # @raise [RuntimeError] if the API key is nil
+    # @example
+    #   config.store_api_key
+    def store_api_key
+      raise "API key is nil" if @api_key.nil?
+
+      FileUtils.mkdir_p(config_dir)
+      File.write(config_file, {version: 1, api_key: @api_key}.to_yaml)
+    end
+
+    # Loads the API key from a local configuration file
+    #
+    # @return [String, nil] the loaded API key or nil if the file does not exist
+    def load_api_key
+      return nil unless File.exist?(config_file)
+
+      YAML.load_file(config_file)[:api_key]
+    end
+
+    # Returns the directory path for the configuration file
+    #
+    # @return [String] the directory path for the configuration file
+    def config_dir
+      File.expand_path("~/.bloomy")
+    end
+
+    # Returns the file path for the configuration file
+    #
+    # @return [String] the file path for the configuration file
+    def config_file
+      File.join(config_dir, "config.yaml")
+    end
+  end
+end

data/lib/bloomy/operations/issues.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "json"
+
+# Class to handle all the operations related to issues
+class Issue
+  # Initializes a new Issue instance
+  #
+  # @param conn [Object] the connection object to interact with the API
+  # @param user_id [Integer] the ID of the user
+  def initialize(conn, user_id)
+    @conn = conn
+    @user_id = user_id
+  end
+
+  # Retrieves details of a specific issue
+  #
+  # @param issue_id [Integer] the ID of the issue
+  # @return [Hash] a hash containing issue details
+  # @example
+  #   issue.details(123)
+  #   #=> { id: 123, title: "Issue Title", notes_url: "http://details.url", ... }
+  def details(issue_id)
+    response = @conn.get("issues/#{issue_id}").body
+    {
+      id: response["Id"],
+      title: response["Name"],
+      notes_url: response["DetailsUrl"],
+      created_at: response["CreateTime"],
+      completed_at: response["CloseTime"],
+      meeting_details: {
+        id: response["OriginId"],
+        name: response["Origin"]
+      },
+      owner_details: {
+        id: response["Owner"]["Id"],
+        name: response["Owner"]["Name"]
+      }
+    }
+  end
+
+  # Lists issues for a specific user
+  #
+  # @param user_id [Integer] the ID of the user (default is the initialized user ID)
+  # @return [Array<Hash>] an array of hashes containing issues details
+  # @example
+  #   issue.list
+  #   #=> [{ id: 123, title: "Issue Title", notes_url: "http://details.url", ... }, ...]
+  def list(user_id: @user_id)
+    response = @conn.get("issues/users/#{user_id}").body
+    response.map do |issue|
+      {
+        id: issue["Id"],
+        title: issue["Name"],
+        notes_url: issue["DetailsUrl"],
+        created_at: issue["CreateTime"],
+        meeting_id: issue["OriginId"],
+        meeting_name: issue["Origin"]
+      }
+    end
+  end
+
+  # Marks an issue as complete
+  #
+  # @param issue_id [Integer] the ID of the issue
+  # @return [Boolean] true if the operation was successful, false otherwise
+  # @example
+  #   issue.complete(123)
+  #   #=> true
+  def complete(issue_id)
+    response = @conn.post("issues/#{issue_id}/complete", {complete: true}.to_json).status
+    response == 200
+  end
+
+  # Creates a new issue
+  #
+  # @param issue_title [String] the title of the new issue
+  # @param meeting_id [Integer] the ID of the meeting associated with the issue
+  # @return [Hash] a hash containing the new issue's ID and title
+  # @example
+  #   issue.create("New Issue", 456)
+  #   #=> { id: 789, title: "New Issue" }
+  def create(issue_title, meeting_id)
+    response = @conn.post("issues/create", {title: issue_title, meetingid: meeting_id}.to_json)
+    {
+      id: response.body["Id"],
+      title: response.body["Name"]
+    }
+  end
+end

data/lib/bloomy/operations/measurables.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "json"
+
+# Class to handle all the operations related to measurables
+# @note
+#   This class is already initialized via the client and usable as `client.measurable.method`
+class Measurable
+  # Initializes a new Measurable instance
+  #
+  # @param conn [Object] the connection object to interact with the API
+  # @param user_id [Integer] the ID of the user
+  def initialize(conn, user_id)
+    @conn = conn
+    @user_id = user_id
+  end
+
+  # Retrieves the current week details
+  #
+  # @return [Hash] a hash containing current week details
+  # @example
+  #   client.measurable.current_week
+  #   #=> { id: 123, week_number: 24, week_start: "2024-06-10", week_end: "2024-06-16" }
+  def current_week
+    response = @conn.get("weeks/current").body
+    {
+      id: response["Id"],
+      week_number: response["ForWeekNumber"],
+      week_start: response["LocalDate"]["Date"],
+      week_end: response["ForWeek"]
+    }
+  end
+
+  # Retrieves the scorecard for the user
+  #
+  # @param current_week_only [Boolean] whether to include only the current week's scores (default: true)
+  # @param show_empty [Boolean] whether to include scores with nil values (default: true)
+  # @return [Array<Hash>] an array of hashes containing scorecard details
+  # @example
+  #   client.measurable.scorecard
+  #   #=> [{ id: 123, title: "Sales", target: 100, value: 80, updated_at: "2024-06-12", week_number: 24 }, ...]
+  def scorecard(current_week_only: true, show_empty: true)
+    response = @conn.get("scorecard/user/mine").body
+    scorecards = response["Scores"].map do |scorecard|
+      {
+        id: scorecard["Id"],
+        title: scorecard["MeasurableName"],
+        target: scorecard["Target"],
+        value: scorecard["Measured"],
+        updated_at: scorecard["DateEntered"],
+        week_number: scorecard["ForWeek"]
+      }
+    end
+
+    if current_week_only
+      week_id = current_week[:week_number]
+      scorecards.select do |scorecard|
+        scorecard[:week_number] == week_id && (show_empty || scorecard[:value].nil?)
+      end
+    else
+      scorecards.select { |scorecard| show_empty || scorecard[:value].nil? }
+    end
+  end
+
+  # Updates a scorecard with a new measured value
+  #
+  # @param scorecard_id [Integer] the ID of the scorecard to update
+  # @param measured [Numeric] the new measured value
+  # @return [Boolean] true if the operation was successful, false otherwise
+  # @example
+  #   client.measurable.update(1, 85)
+  #   #=> true
+  def update(scorecard_id, measured)
+    response = @conn.put("scores/#{scorecard_id}", {value: measured}.to_json).status
+    response == 200
+  end
+end

data/lib/bloomy/operations/meetings.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+# Class to handle all the operations related to meeting
+# @note
+#   This class is already initialized via the client and usable as `client.measurable.method`
+class Meeting
+  # Initializes a new Meeting instance
+  #
+  # @param conn [Object] the connection object to interact with the API
+  # @param user_id [Integer] the ID of the user
+  def initialize(conn, user_id)
+    @conn = conn
+    @user_id = user_id
+  end
+
+  # Lists all meetings for a specific user
+  #
+  # @param user_id [Integer] the ID of the user (default is the initialized user ID)
+  # @return [Array<Hash>] an array of hashes containing meeting details
+  # @example
+  #   client.meeting.list
+  #   #=> [{ id: 123, name: "Team Meeting" }, ...]
+  def list(user_id: @user_id)
+    response = @conn.get("L10/#{user_id}/list").body
+    response.map { |meeting| {id: meeting["Id"], name: meeting["Name"]} }
+  end
+
+  # Lists all attendees for a specific meeting
+  #
+  # @param meeting_id [Integer] the ID of the meeting
+  # @return [Array<Hash>] an array of hashes containing attendee details
+  # @example
+  #   client.meeting.attendees(1)
+  #   #=> [{ name: "John Doe", id: 1 }, ...]
+  def attendees(meeting_id)
+    response = @conn.get("L10/#{meeting_id}/attendees").body
+    response.map { |attendee| {name: attendee["Name"], id: attendee["Id"]} }
+  end
+
+  # Lists all issues for a specific meeting
+  #
+  # @param meeting_id [Integer] the ID of the meeting
+  # @param include_closed [Boolean] whether to include closed issues (default: false)
+  # @return [Array<Hash>] an array of hashes containing issue details
+  # @example
+  #   client.meeting.issues(1)
+  #   #=> [{ id: 1, title: "Issue Title", created_at: "2024-06-10", ... }, ...]
+  def issues(meeting_id, include_closed: false)
+    response = @conn.get("L10/#{meeting_id}/issues?include_resolved=#{include_closed}").body
+    response.map do |issue|
+      {
+        id: issue["Id"],
+        title: issue["Name"],
+        created_at: issue["CreateTime"],
+        closed_at: issue["CloseTime"],
+        details_url: issue["DetailsUrl"],
+        owner: {
+          id: issue["Owner"]["Id"],
+          name: issue["Owner"]["Name"]
+        }
+      }
+    end
+  end
+
+  # Lists all todos for a specific meeting
+  #
+  # @param meeting_id [Integer] the ID of the meeting
+  # @param include_closed [Boolean] whether to include closed todos (default: false)
+  # @return [Array<Hash>] an array of hashes containing todo details
+  # @example
+  #   client.meeting.todos(1)
+  #   #=> [{ id: 1, title: "Todo Title", due_date: "2024-06-12", ... }, ...]
+  def todos(meeting_id, include_closed: false)
+    response = @conn.get("L10/#{meeting_id}/todos?INCLUDE_CLOSED=#{include_closed}").body
+    response.map do |todo|
+      {
+        id: todo["Id"],
+        title: todo["Name"],
+        due_date: todo["DueDate"],
+        details_url: todo["DetailsUrl"],
+        completed_at: todo["CompleteTime"],
+        owner: {
+          id: todo["Owner"]["Id"],
+          name: todo["Owner"]["Name"]
+        }
+      }
+    end
+  end
+
+  # Lists all metrics for a specific meeting
+  #
+  # @param meeting_id [Integer] the ID of the meeting
+  # @return [Array<Hash>] an array of hashes containing metric details
+  # @example
+  #   client.meeting.metrics(1)
+  #   #=> [{ id: 1, name: "Sales", target: 100, operator: ">", format: "currency", ... }, ...]
+  def metrics(meeting_id)
+    response = @conn.get("L10/#{meeting_id}/measurables").body
+    response.map do |measurable|
+      {
+        id: measurable["Id"],
+        name: measurable["Name"].strip,
+        target: measurable["Target"],
+        operator: measurable["Direction"],
+        format: measurable["Modifiers"],
+        owner: {
+          id: measurable["Owner"]["Id"],
+          name: measurable["Owner"]["Name"]
+        },
+        admin: {
+          id: measurable["Admin"]["Id"],
+          name: measurable["Admin"]["Name"]
+        }
+      }
+    end
+  end
+
+  # Retrieves details of a specific meeting
+  #
+  # @param meeting_id [Integer] the ID of the meeting
+  # @param include_closed [Boolean] whether to include closed issues and todos (default: false)
+  # @return [Hash] a hash containing detailed information about the meeting
+  # @example
+  #   client.meeting.details(1)
+  #   #=> { id: 1, name: "Team Meeting", attendees: [...], issues: [...], todos: [...], metrics: [...] }
+  def details(meeting_id, include_closed: false)
+    meeting = list.find { |m| m[:id] == meeting_id }
+    attendees = attendees(meeting_id)
+    issues = issues(meeting_id, include_closed: include_closed)
+    todos = todos(meeting_id, include_closed: include_closed)
+    measurables = metrics(meeting_id)
+    {
+      id: meeting[:id],
+      name: meeting[:name],
+      attendees: attendees,
+      issues: issues,
+      todos: todos,
+      metrics: measurables
+    }
+  end
+
+  # Creates a new meeting
+  #
+  # @param title [String] the title of the new meeting
+  # @param add_self [Boolean] whether to add the current user as an attendee (default: true)
+  # @param attendees [Array<Integer>] a list of user IDs to add as attendees
+  # @return [Hash] a hash containing the new meeting's ID and title, and the list of attendees
+  # @example
+  #   client.meeting.create(title: "New Meeting", attendees: [2, 3])
+  #   #=> { meeting_id: 1, title: "New Meeting", attendees: [2, 3] }
+  def create(title:, add_self: true, attendees: [])
+    payload = {title: title, addSelf: add_self}.to_json
+    response = @conn.post("L10/create", payload).body
+    meeting_id = response["meetingId"]
+    meeting_details = {meeting_id: meeting_id, title: title}
+    attendees.each do |attendee|
+      @conn.post("L10/#{meeting_id}/attendees/#{attendee}")
+    end
+    meeting_details.merge(attendees: attendees)
+  end
+
+  # Deletes a meeting
+  #
+  # @param meeting_id [Integer] the ID of the meeting to delete
+  # @example
+  #   client.meeting.delete(1)
+  def delete(meeting_id)
+    @conn.delete("L10/#{meeting_id}")
+  end
+end

data/lib/bloomy/operations/rocks.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# Class to handle all the operations related to rocks
+class Rock
+  # Initializes a new Rock instance
+  #
+  # @param conn [Object] the connection object to interact with the API
+  # @param user_id [Integer] the ID of the user
+  def initialize(conn, user_id)
+    @conn = conn
+    @user_id = user_id
+  end
+
+  # Lists all rocks for a specific user
+  #
+  # @param user_id [Integer] the ID of the user (default is the initialized user ID)
+  # @param archived [Boolean] whether to include archived rocks (default: false)
+  # @return [Array<Hash>] an array of hashes containing rock details or a hash with active and archived rocks
+  # @example
+  #  client.rock.list
+  #   #=> [{ id: 1, title: "Complete project", created_at: "2024-06-10", ... }, ...]
+  def list(user_id: @user_id, archived: false)
+    active_rocks = @conn.get("rocks/user/#{user_id}?include_origin=true").body.map do |rock|
+      {
+        id: rock["Id"],
+        title: rock["Name"],
+        created_at: rock["CreateTime"],
+        due_date: rock["DueDate"],
+        status: rock["Complete"] ? "Completed" : "Incomplete",
+        meeting_id: rock["Origins"].empty? ? nil : rock["Origins"][0]["Id"],
+        meeting_name: rock["Origins"].empty? ? nil : rock["Origins"][0]["Name"]
+      }
+    end
+
+    archived ? {active: active_rocks, archived: get_archived_rocks(user_id: @user_id)} : active_rocks
+  end
+
+  # Creates a new rock
+  #
+  # @param title [String] the title of the new rock
+  # @param meeting_id [Integer] the ID of the meeting associated with the rock
+  # @param user_id [Integer] the ID of the user responsible for the rock (default: initialized user ID)
+  # @return [Hash] a hash containing the new rock's details
+  # @example
+  #   client.rock.create(title: "New Rock", meeting_id: 1)
+  #   #=> { rock_id: 1, title: "New Rock", meeting_id: 1, ... }
+  def create(title:, meeting_id:, user_id: @user_id)
+    payload = {title: title, accountableUserId: user_id}.to_json
+    response = @conn.post("/api/v1/L10/#{meeting_id}/rocks", payload).body
+    {
+      rock_id: response["Id"],
+      title: title,
+      meeting_id: meeting_id,
+      meeting_name: response["Origins"][0]["Name"],
+      user_id: user_id,
+      user_name: response["Owner"]["Name"],
+      created_at: DateTime.parse(response["CreateTime"])
+    }
+  end
+
+  # Deletes a rock
+  #
+  # @param rock_id [Integer] the ID of the rock to delete
+  # @return [Hash] a hash containing the status of the delete operation
+  # @example
+  #   client.rock.delete(1)
+  #   #=> { status: 200 }
+  def delete(rock_id)
+    response = @conn.delete("/api/v1/rocks/#{rock_id}")
+    {status: response.status}
+  end
+
+  # Updates a rock
+  #
+  # @param rock_id [Integer] the ID of the rock to update
+  # @param title [String] the new title of the rock
+  # @param accountable_user [Integer] the ID of the user responsible for the rock (default: initialized user ID)
+  # @return [Hash] a hash containing the status of the update operation
+  # @example
+  #   client.rock.update(rock_id: 1, title: "Updated Rock")
+  #   #=> { status: 200 }
+  def update(rock_id:, title:, accountable_user: @user_id)
+    payload = {title: title, accountableUserId: accountable_user}.to_json
+    response = @conn.put("/api/v1/rocks/#{rock_id}", payload)
+    {status: response.status}
+  end
+
+  private
+
+  # Retrieves all archived rocks for a specific user (private method)
+  #
+  # @param user_id [Integer] the ID of the user (default is the initialized user ID)
+  # @return [Array<Hash>] an array of hashes containing archived rock details
+  # @example
+  #   rock.send(:get_archived_rocks)
+  #   #=> [{ id: 1, title: "Archived Rock", created_at: "2024-06-10", ... }, ...]
+  def get_archived_rocks(user_id: @user_id)
+    response = @conn.get("archivedrocks/user/#{user_id}").body
+    response.map do |rock|
+      {
+        id: rock["Id"],
+        title: rock["Name"],
+        created_at: rock["CreateTime"],
+        due_date: rock["DueDate"],
+        status: rock["Complete"] ? "Complete" : "Incomplete"
+      }
+    end
+  end
+end

data/lib/bloomy/operations/todos.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Class to handle all the operations related to todos
+class Todo
+  # Initializes a new Todo instance
+  #
+  # @param conn [Object] the connection object to interact with the API
+  # @param user_id [Integer] the ID of the user
+  def initialize(conn, user_id)
+    @conn = conn
+    @user_id = user_id
+  end
+
+  # Lists all todos for a specific user
+  #
+  # @param user_id [Integer] the ID of the user (default is the initialized user ID)
+  # @return [Array<Hash>] an array of hashes containing todo details
+  # @example
+  #   client.todo.list
+  #   #=> [{ id: 1, title: "Finish report", due_date: "2024-06-10", ... }, ...]
+  def list(user_id: @user_id)
+    response = @conn.get("todo/user/#{user_id}").body
+    response.map do |todo|
+      {
+        id: todo["Id"],
+        title: todo["Name"],
+        due_date: todo["DueDate"],
+        created_at: todo["CreateTime"],
+        completed_at: todo["CompleteTime"],
+        status: todo["Complete"] ? "Complete" : "Incomplete"
+      }
+    end
+  end
+
+  # Creates a new todo
+  #
+  # @param title [String] the title of the new todo
+  # @param meeting_id [Integer] the ID of the meeting associated with the todo
+  # @param due_date [String, nil] the due date of the todo (optional)
+  # @param user_id [Integer] the ID of the user responsible for the todo (default: initialized user ID)
+  # @return [Hash] a hash containing the new todo's details
+  # @example
+  #   client.todo.create(title: "New Todo", meeting_id: 1, due_date: "2024-06-15")
+  #   #=> { id: 1, title: "New Todo", meeting_name: "Team Meeting", ... }
+  def create(title:, meeting_id:, due_date: nil, user_id: @user_id)
+    payload = {title: title, accountableUserId: user_id}
+    payload[:dueDate] = due_date if due_date
+    response = @conn.post("/api/v1/L10/#{meeting_id}/todos", payload.to_json).body
+
+    {
+      id: response["Id"],
+      title: response["Name"],
+      meeting_name: response["Origin"],
+      meeting_id: response["OriginId"],
+      due_date: response["DueDate"]
+    }
+  end
+
+  # Marks a todo as complete
+  #
+  # @param todo_id [Integer] the ID of the todo to complete
+  # @return [Hash] a hash containing the status of the complete operation
+  # @example
+  #   todo.complete(1)
+  #   #=> { status: 200 }
+  def complete(todo_id)
+    response = @conn.post("/api/v1/todo/#{todo_id}/complete?status=true")
+    {status: response.status}
+  end
+end

data/lib/bloomy/operations/users.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# Class to handle all the operations related to users
+class User
+  attr_reader :default_user_id
+
+  # Initializes a new User instance
+  #
+  # @param conn [Object] the connection object to interact with the API
+  def initialize(conn)
+    @conn = conn
+    @default_user_id = current_user_id
+  end
+
+  # Retrieves the current user's ID
+  #
+  # @return [Integer] the ID of the current user
+  # @example
+  #   client.user.current_user_id
+  #   #=> 1
+  def current_user_id
+    response = @conn.get("users/mine").body
+    response["Id"]
+  end
+
+  # Retrieves details of a specific user
+  #
+  # @param user_id [Integer] the ID of the user (default: the current user ID)
+  # @param direct_reports [Boolean] whether to include direct reports (default: false)
+  # @param positions [Boolean] whether to include positions (default: false)
+  # @param all [Boolean] whether to include both direct reports and positions (default: false)
+  # @return [Hash] a hash containing user details
+  # @example
+  #   client.user.details
+  #   #=> {name: "John Doe", id: 1, image_url: "http://example.com/image.jpg", ...}
+  def details(user_id: @default_user_id, direct_reports: false, positions: false, all: false)
+    response = @conn.get("users/#{user_id}").body
+    user_details = {name: response["Name"], id: response["Id"], image_url: response["ImageUrl"]}
+
+    user_details[:direct_reports] = direct_reports(user_id: user_id) if direct_reports || all
+    user_details[:positions] = positions(user_id: user_id) if positions || all
+
+    user_details
+  end
+
+  # Retrieves direct reports of a specific user
+  #
+  # @param user_id [Integer] the ID of the user (default: the current user ID)
+  # @return [Array<Hash>] an array of hashes containing direct report details
+  # @example
+  #   client.user.direct_reports
+  #   #=> [{name: "Jane Smith", id: 2, image_url: "http://example.com/image.jpg"}, ...]
+  def direct_reports(user_id: @default_user_id)
+    direct_reports_response = @conn.get("users/#{user_id}/directreports").body
+    direct_reports_response.map { |report| {name: report["Name"], id: report["Id"], image_url: report["ImageUrl"]} }
+  end
+
+  # Retrieves positions of a specific user
+  #
+  # @param user_id [Integer] the ID of the user (default: the current user ID)
+  # @return [Array<Hash>] an array of hashes containing position details
+  # @example
+  #   user.positions
+  #   #=> [{name: "Manager", id: 3}, ...]
+  def positions(user_id: @default_user_id)
+    position_response = @conn.get("users/#{user_id}/seats").body
+    position_response.map do |position|
+      {name: position["Group"]["Position"]["Name"], id: position["Group"]["Position"]["Id"]}
+    end
+  end
+
+  # Searches for users based on a search term
+  #
+  # @param term [String] the search term
+  # @return [Array<Hash>] an array of hashes containing search results
+  # @example
+  #   user.search("John")
+  #   #=> [{id: 1, name: "John Doe", description: "Developer", ...}, ...]
+  def search(term)
+    response = @conn.get("search/user", term: term).body
+    response.map do |user|
+      {
+        id: user["Id"],
+        name: user["Name"],
+        description: user["Description"],
+        email: user["Email"],
+        organization_id: user["OrganizationId"],
+        image_url: user["ImageUrl"]
+      }
+    end
+  end
+end

data/lib/bloomy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bloomy
+  VERSION = "0.1.0"
+end

data/lib/bloomy.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "bloomy/version"
+require_relative "bloomy/configuration"
+require_relative "bloomy/client"
+
+module Bloomy
+  class Error < StandardError; end
+end

data/sig/bloomy.rbs

@@ -0,0 +1,4 @@
+module Bloomy
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: bloomy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Franccesco Orozco
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description:
+email:
+- franccesco@thatai.dev
+executables:
+- bloomy
+extensions: []
+extra_rdoc_files: []
+files:
+- ".pre-commit-config.yaml"
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- bloomy.gemspec
+- exe/bloomy
+- lib/bloomy.rb
+- lib/bloomy/client.rb
+- lib/bloomy/configuration.rb
+- lib/bloomy/operations/issues.rb
+- lib/bloomy/operations/measurables.rb
+- lib/bloomy/operations/meetings.rb
+- lib/bloomy/operations/rocks.rb
+- lib/bloomy/operations/todos.rb
+- lib/bloomy/operations/users.rb
+- lib/bloomy/version.rb
+- sig/bloomy.rbs
+homepage: https://github.com/franccesco/bloomy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/franccesco/bloomy
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Manage your Bloom Growth account from the command line.
+test_files: []