bloomy 0.9.0 → 0.11.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c974efd56ac66961c3bd6bbc23cbb9132f4de67faeb6fcfb30f91c86600bda1
-  data.tar.gz: '083bd19e9f8a1186f4b9eb593357743fe5bb58245cf6a01ebad54333d0374996'
+  metadata.gz: 54194503af40ece6bf43213c629ef356ace57155c5a2e8a482b0fe6aee05db3d
+  data.tar.gz: 331f8e7ee2c8b8a81430e8189637516f0de6749ebe015c4088bb5891722b645b
 SHA512:
-  metadata.gz: 43efae27d859f9d1f4e4e693d4ce4f9b47f085b74e6afe9a87b9869dd59fc90d26b4aee2a4f1d3b9714566a74a7687bcd40c29c24c599f9fb5b2c34f0e433e87
-  data.tar.gz: 7f501d471e49608f68cf748083640926c336a7fb1b005cddc4a57eac2d7277be10375e95d8a7d4641bcc4386c9f067d4a3b957d36eb1563d14466fc64f708a57
+  metadata.gz: 6edf8e382af72ec5ad3fe708958437c9e5af9cf84029453002c42a0237bcc327f544642e748da56d0d5fffd50c96722807fd7db6a11393754c8a1bae0986cc44
+  data.tar.gz: c2e67dfc490dc5cedf8f3994989ff57c30f0e60161d7a6673e40678b24e091277a4a58d8cedd93f702dfe1e7123031b4d55473a33d7706debeb46e66657034c8

data/CONTRIBUTING.md

@@ -16,6 +16,9 @@ If you want to contribute to the project, please follow these steps:
 
 ### Development Setup
 
+> [!IMPORTANT]
+> Make sure you have a Bloom Growth account and that you're using a user that won't disrupt the experience of other users. The tests will create and delete meetings, so make sure you're not using a user that has important meetings scheduled.
+
 1. Fork and clone the repository:
 
 ```sh
@@ -28,7 +31,7 @@ git clone https://github.com/your-username/bloomy.git
 bundle install
 ```
 
-3. Set up pre-commit hooks:
+3. Set up [pre-commit](https://pre-commit.com) hooks:
 
 ```sh
 pre-commit install
@@ -41,10 +44,10 @@ export USERNAME=your_username
 export PASSWORD=your_password
 ```
 
-5. Run the tests:
+5. Run the tests to make sure everything is green:
 
 ```sh
-bundle exec rspec
+bundle exec rspec --fail-fast
 ```
 
 ### Making Changes
@@ -63,7 +66,7 @@ As for coding style guidelines make sure you:
 2. Make sure your PR passes the CI checks.
 3. Make sure your PR has a clear title and description.
 4. Update the version according to [Semantic Versioning](https://semver.org/).
-5. Optionally, use [Conventional Commits](https://www.conventionalcommits.org/) for your commit messages.
+5. Use [Conventional Commits](https://www.conventionalcommits.org/) for your commit messages.
 
 Make sure to follow these guidelines to ensure your PR is accepted and merged quickly. Rinse and repeat! 🚀
 

data/lib/bloomy/client.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
 require "faraday"
-require_relative "operations/users"
-require_relative "operations/todos"
-require_relative "operations/goals"
-require_relative "operations/meetings"
-require_relative "operations/scorecard"
-require_relative "operations/issues"
-require_relative "operations/headlines"
-require_relative "utils/plugin_loader"
+
+require "bloomy/types/items"
+require "bloomy/operations/users"
+require "bloomy/operations/todos"
+require "bloomy/operations/goals"
+require "bloomy/operations/meetings"
+require "bloomy/operations/scorecard"
+require "bloomy/operations/issues"
+require "bloomy/operations/headlines"
+require "bloomy/utils/plugin_loader"
 
 module Bloomy
   # The Client class is the main entry point for interacting with the Bloomy API.

data/lib/bloomy/operations/goals.rb

@@ -2,141 +2,158 @@
 
 require "bloomy/utils/get_user_id"
 
-# Class to handle all the operations related to goals
-class Goal
-  include Bloomy::Utilities::UserIdUtility
-  # Initializes a new Goal instance
-  #
-  # @param conn [Object] the connection object to interact with the API
-  def initialize(conn)
-    @conn = conn
-  end
+module Bloomy
+  # Class to handle all the operations related to goals (also known as "rocks")
+  # @note This class is already initialized via the client and usable as `client.goal.method`
+  class Goal
+    include Bloomy::Utilities::UserIdUtility
 
-  # Lists all goals 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 goals (default: false)
-  # @return [Array<Hash>] an array of hashes containing goal details or a hash with active and archived goals
-  # @example
-  #  client.goal.list
-  #   #=> [{ id: 1, title: "Complete project", created_at: "2024-06-10", ... }, ...]
-  def list(user_id = self.user_id, archived: false)
-    active_goals = @conn.get("rocks/user/#{user_id}?include_origin=true").body.map do |goal|
-      {
-        id: goal["Id"],
-        title: goal["Name"],
-        created_at: goal["CreateTime"],
-        due_date: goal["DueDate"],
-        status: goal["Complete"] ? "Completed" : "Incomplete",
-        meeting_id: goal["Origins"].empty? ? nil : goal["Origins"][0]["Id"],
-        meeting_title: goal["Origins"].empty? ? nil : goal["Origins"][0]["Name"]
-      }
+    # Initializes a new Goal instance
+    #
+    # @param conn [Object] the connection object to interact with the API
+    def initialize(conn)
+      @conn = conn
     end
 
-    archived ? {active: active_goals, archived: get_archived_goals(self.user_id)} : active_goals
-  end
+    # Lists all goals 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 goals (default: false)
+    # @return [Array<GoalItem>, Hash] Returns either:
+    #   - An array of GoalItem objects if archived is false
+    #   - A hash with :active and :archived arrays of GoalItem objects if archived is true
+    # @example List active goals
+    #   client.goal.list
+    #   #=> [#<GoalItem id: 1, title: "Complete project", ...>]
+    #
+    # @example List both active and archived goals
+    #   client.goal.list(archived: true)
+    #   #=> {
+    #     active: [#<GoalItem id: 1, ...>],
+    #     archived: [#<GoalItem id: 2, ...>]
+    #   }
+    def list(user_id = self.user_id, archived: false)
+      active_goals = @conn.get("rocks/user/#{user_id}?include_origin=true").body.map do |goal|
+        Types::GoalItem.new(
+          id: goal["Id"],
+          user_id: goal["Owner"]["Id"],
+          user_name: goal["Owner"]["Name"],
+          title: goal["Name"],
+          created_at: goal["CreateTime"],
+          due_date: goal["DueDate"],
+          status: goal["Complete"] ? "Completed" : "Incomplete",
+          meeting_id: goal["Origins"].empty? ? nil : goal["Origins"][0]["Id"],
+          meeting_title: goal["Origins"].empty? ? nil : goal["Origins"][0]["Name"]
+        )
+      end
 
-  # Creates a new goal
-  #
-  # @param title [String] the title of the new goal
-  # @param meeting_id [Integer] the ID of the meeting associated with the goal
-  # @param user_id [Integer] the ID of the user responsible for the goal (default: initialized user ID)
-  # @return [Hash] a hash containing the new goal's details
-  # @example
-  #   client.goal.create(title: "New Goal", meeting_id: 1)
-  #   #=> { goal_id: 1, title: "New Goal", meeting_id: 1, ... }
-  def create(title:, meeting_id:, user_id: self.user_id)
-    payload = {title: title, accountableUserId: user_id}.to_json
-    response = @conn.post("L10/#{meeting_id}/rocks", payload).body
-    {
-      goal_id: response["Id"],
-      title: title,
-      meeting_id: meeting_id,
-      meeting_title: response["Origins"][0]["Name"],
-      user_id: user_id,
-      user_name: response["Owner"]["Name"],
-      created_at: response["CreateTime"]
-    }
-  end
+      archived ? {active: active_goals, archived: get_archived_goals(user_id)} : active_goals
+    end
 
-  # Deletes a goal
-  #
-  # @param goal_id [Integer] the ID of the goal to delete
-  # @return [Hash] a hash containing the status of the delete operation
-  # @example
-  #   client.goal.delete(1)
-  #   #=> { status: 200 }
-  def delete(goal_id)
-    response = @conn.delete("rocks/#{goal_id}")
-    response.success?
-  end
+    # Creates a new goal
+    #
+    # @param title [String] the title of the new goal
+    # @param meeting_id [Integer] the ID of the meeting associated with the goal
+    # @param user_id [Integer] the ID of the user responsible for the goal (default: initialized user ID)
+    # @return [GoalItem] the newly created goal
+    # @example
+    #   client.goal.create(title: "New Goal", meeting_id: 1)
+    #   #=> { goal_id: 1, title: "New Goal", meeting_id: 1, ... }
+    def create(title:, meeting_id:, user_id: self.user_id)
+      payload = {title: title, accountableUserId: user_id}.to_json
+      response = @conn.post("L10/#{meeting_id}/rocks", payload).body
+
+      Types::GoalItem.new(
+        id: response["Id"],
+        user_id: user_id,
+        user_name: response["Owner"]["Name"],
+        title: title,
+        meeting_id: meeting_id,
+        meeting_title: response["Origins"][0]["Name"],
+        status: {complete: 2, on: 1, off: 0}.key(response["Completion"]).to_s,
+        created_at: response["CreateTime"]
+      )
+    end
 
-  # Updates a goal
-  #
-  # @param goal_id [Integer] the ID of the goal to update
-  # @param title [String] the new title of the goal
-  # @param accountable_user [Integer] the ID of the user responsible for the goal (default: initialized user ID)
-  # @param status [String, nil] the status value ('on', 'off', or 'complete')
-  # @return [Boolean] true if the update was successful
-  # @raise [ArgumentError] if an invalid status value is provided
-  # @example
-  #   client.goal.update(goal_id: 1, title: "Updated Goal", status: 'on')
-  #   #=> true
-  def update(goal_id:, title:, accountable_user: user_id, status: nil)
-    if status
-      valid_status = {on: "OnTrack", off: "AtRisk", complete: "Complete"}
-      status_key = status.downcase.to_sym
-      unless valid_status.key?(status_key)
-        raise ArgumentError, "Invalid status value. Must be 'on', 'off', or 'complete'."
+    # Deletes a goal
+    #
+    # @param goal_id [Integer] the ID of the goal to delete
+    # @return [Hash] a hash containing the status of the delete operation
+    # @example
+    #   client.goal.delete(1)
+    #   #=> { status: 200 }
+    def delete(goal_id)
+      response = @conn.delete("rocks/#{goal_id}")
+      response.success?
+    end
+
+    # Updates a goal
+    #
+    # @param goal_id [Integer] the ID of the goal to update
+    # @param title [String] the new title of the goal
+    # @param accountable_user [Integer] the ID of the user responsible for the goal (default: initialized user ID)
+    # @param status [String, nil] the status value ('on', 'off', or 'complete')
+    # @return [Boolean] true if the update was successful
+    # @raise [ArgumentError] if an invalid status value is provided
+    # @example
+    #   client.goal.update(goal_id: 1, title: "Updated Goal", status: 'on')
+    #   #=> true
+    def update(goal_id:, title: nil, accountable_user: user_id, status: nil)
+      if status
+        valid_status = {on: "OnTrack", off: "AtRisk", complete: "Complete"}
+        status_key = status.downcase.to_sym
+        unless valid_status.key?(status_key)
+          raise ArgumentError, "Invalid status value. Must be 'on', 'off', or 'complete'."
+        end
+        status = valid_status[status_key]
       end
-      status = valid_status[status_key]
+      payload = {title: title, accountableUserId: accountable_user, completion: status}.to_json
+      response = @conn.put("rocks/#{goal_id}", payload)
+      response.success?
     end
-    payload = {title: title, accountableUserId: accountable_user, completion: status}.to_json
-    response = @conn.put("rocks/#{goal_id}", payload)
-    response.success?
-  end
 
-  # Archives a rock with the specified goal ID.
-  #
-  # @param goal_id [Integer] The ID of the goal/rock to archive
-  # @return [Boolean] Returns true if the archival was successful, false otherwise
-  # @example
-  #  goals.archive(123) #=> true
-  def archive(goal_id)
-    response = @conn.put("rocks/#{goal_id}/archive")
-    response.success?
-  end
+    # Archives a rock with the specified goal ID.
+    #
+    # @param goal_id [Integer] The ID of the goal/rock to archive
+    # @return [Boolean] Returns true if the archival was successful, false otherwise
+    # @example
+    #  goals.archive(123) #=> true
+    def archive(goal_id)
+      response = @conn.put("rocks/#{goal_id}/archive")
+      response.success?
+    end
 
-  # Restores a previously archived goal identified by the provided goal ID.
-  #
-  # @param [String, Integer] goal_id The unique identifier of the goal to restore
-  # @return [Boolean] true if the restore operation was successful, false otherwise
-  # @example Restoring a goal
-  #   goals.restore("123") #=> true
-  def restore(goal_id)
-    response = @conn.put("rocks/#{goal_id}/restore")
-    response.success?
-  end
+    # Restores a previously archived goal identified by the provided goal ID.
+    #
+    # @param [String, Integer] goal_id The unique identifier of the goal to restore
+    # @return [Boolean] true if the restore operation was successful, false otherwise
+    # @example Restoring a goal
+    #   goals.restore("123") #=> true
+    def restore(goal_id)
+      response = @conn.put("rocks/#{goal_id}/restore")
+      response.success?
+    end
 
-  private
+    private
 
-  # Retrieves all archived goals 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 goal details
-  # @example
-  #   goal.send(:get_archived_goals)
-  #   #=> [{ id: 1, title: "Archived Goal", created_at: "2024-06-10", ... }, ...]
-  def get_archived_goals(user_id = self.user_id)
-    response = @conn.get("archivedrocks/user/#{user_id}").body
-    response.map do |goal|
-      {
-        id: goal["Id"],
-        title: goal["Name"],
-        created_at: goal["CreateTime"],
-        due_date: goal["DueDate"],
-        status: goal["Complete"] ? "Complete" : "Incomplete"
-      }
+    # Retrieves all archived goals for a specific user (private method)
+    #
+    # @param user_id [Integer] the ID of the user (default is the initialized user ID)
+    # @return [Array<GoalItem>] an array of GoalItem objects containing archived goal details
+    # @example
+    #   goal.send(:get_archived_goals)
+    #   #=> [{ id: 1, title: "Archived Goal", created_at: "2024-06-10", ... }, ...]
+    def get_archived_goals(user_id = self.user_id)
+      response = @conn.get("archivedrocks/user/#{user_id}").body
+      response.map do |goal|
+        Types::GoalItem.new(
+          id: goal["Id"],
+          title: goal["Name"],
+          created_at: goal["CreateTime"],
+          due_date: goal["DueDate"],
+          status: goal["Complete"] ? "Complete" : "Incomplete"
+        )
+      end
     end
   end
 end

data/lib/bloomy/operations/headlines.rb

@@ -2,120 +2,138 @@
 
 require "bloomy/utils/get_user_id"
 
-class Headline
-  include Bloomy::Utilities::UserIdUtility
-  # Initializes a new headline instance
-  #
-  # @param conn [Object] the connection object to interact with the API
-  def initialize(conn)
-    @conn = conn
-  end
+module Bloomy
+  class Headline
+    include Bloomy::Utilities::UserIdUtility
+    # Initializes a new headline instance
+    #
+    # @param conn [Object] the connection object to interact with the API
+    def initialize(conn)
+      @conn = conn
+    end
 
-  # Creates a new headline
-  #
-  # @param meeting_id [Integer] the ID of the meeting
-  # @param title [String] the title of the headline
-  # @param owner_id [Integer] the ID of the headline owner
-  # @param notes [String] additional notes for the headline
-  # @return [Hash] the created headline details
-  def create(meeting_id:, title:, owner_id: user_id, notes: nil)
-    response = @conn.post("/api/v1/L10/#{meeting_id}/headlines",
-      {title: title, ownerId: owner_id, notes: notes}.to_json)
-    raise "Failed to create headline" unless response.status == 200
+    # Creates a new headline
+    #
+    # @param meeting_id [Integer] the ID of the meeting
+    # @param title [String] the title of the headline
+    # @param owner_id [Integer] the ID of the headline owner
+    # @param notes [String] additional notes for the headline
+    # @return [HeadlineItem] containing id, title, owner_details, and notes_url
+    def create(meeting_id:, title:, owner_id: user_id, notes: nil)
+      response = @conn.post("/api/v1/L10/#{meeting_id}/headlines",
+        {title: title, ownerId: owner_id, notes: notes}.to_json)
+      raise "Failed to create headline" unless response.status == 200
 
-    {
-      id: response.body["Id"],
-      title: response.body["Name"],
-      owner_id: response.body["OwnerId"],
-      notes_url: response.body["DetailsUrl"]
-    }
-  end
+      Types::HeadlineItem.new(
+        id: response.body["Id"],
+        title: response.body["Name"],
+        owner_details: Types::UserItem.new(id: response.body["OwnerId"]),
+        notes_url: response.body["DetailsUrl"]
+      )
+    end
 
-  # Updates a headline
-  #
-  # @param headline_id [Integer] the ID of the headline to update
-  # @param title [String] the new title of the headline
-  # @return [Hash] the updated headline details
-  def update(headline_id:, title:)
-    response = @conn.put("/api/v1/headline/#{headline_id}", {title: title}.to_json)
-    raise "Failed to update headline" unless response.status == 200
-    true
-  end
+    # Updates a headline
+    #
+    # @param headline_id [Integer] the ID of the headline to update
+    # @param title [String] the new title of the headline
+    # @return [Boolean] true if update was successful
+    def update(headline_id:, title:)
+      response = @conn.put("/api/v1/headline/#{headline_id}", {title: title}.to_json)
+      raise "Failed to update headline" unless response.status == 200
+      true
+    end
 
-  # Get headline details
-  #
-  # @param headline_id [Integer] the ID of the headline
-  # @return [Hash] the details of the headline
-  def details(headline_id)
-    response = @conn.get("/api/v1/headline/#{headline_id}?Include_Origin=true")
-    raise "Failed to get headline details" unless response.status == 200
+    # Get headline details
+    #
+    # @param headline_id [Integer] the ID of the headline
+    # @return [HeadlineItem] containing id, title, notes_url, meeting_details,
+    #                        owner_details, archived, created_at, and closed_at
+    def details(headline_id)
+      response = @conn.get("/api/v1/headline/#{headline_id}?Include_Origin=true")
+      raise "Failed to get headline details" unless response.status == 200
 
-    {
-      id: response.body["Id"],
-      title: response.body["Name"],
-      notes_url: response.body["DetailsUrl"],
-      meeting_details: {
-        id: response.body["OriginId"],
-        title: response.body["Origin"]
-      },
-      owner_details: {
-        id: response.body["Owner"]["Id"],
-        name: response.body["Owner"]["Name"]
-      },
-      archived: response.body["Archived"],
-      created_at: response.body["CreateTime"],
-      closed_at: response.body["CloseTime"]
-    }
-  end
+      Types::HeadlineItem.new(
+        id: response.body["Id"],
+        title: response.body["Name"],
+        notes_url: response.body["DetailsUrl"],
+        meeting_details: Types::MeetingItem.new(
+          id: response.body["OriginId"],
+          title: response.body["Origin"]
+        ),
+        owner_details: Types::UserItem.new(
+          id: response.body["Owner"]["Id"],
+          name: response.body["Owner"]["Name"]
+        ),
+        archived: response.body["Archived"],
+        created_at: response.body["CreateTime"],
+        closed_at: response.body["CloseTime"]
+      )
+    end
 
-  # Get headlines for a user or a meeting.
-  #
-  # @param user_id [Integer, nil] the ID of the user (defaults to initialized user_id)
-  # @param meeting_id [Integer, nil] the ID of the meeting
-  # @raise [ArgumentError] if both `user_id` and `meeting_id` are provided
-  # @return [Array<Hash>] the list of headlines
-  # @example
-  #  # Fetch headlines for a user
-  #  client.headline.list
-  #  #=> [{ id: 1, title: "Headline Title", meeting_details: { id: 1, name: "Team Meeting" }, ... }, ...]
-  def list(user_id: nil, meeting_id: nil)
-    raise ArgumentError, "Please provide either `user_id` or `meeting_id`, not both." if user_id && meeting_id
+    # Get headlines for a user or a meeting.
+    #
+    # @param user_id [Integer, nil] the ID of the user (defaults to initialized user_id)
+    # @param meeting_id [Integer, nil] the ID of the meeting
+    # @raise [ArgumentError] if both `user_id` and `meeting_id` are provided
+    # @return [Array<HeadlineItem>] a list of headlines containing:
+    #   - id
+    #   - title
+    #   - meeting_details
+    #   - owner_details
+    #   - archived
+    #   - created_at
+    #   - closed_at
+    # @example
+    #   client.headline.list
+    #   #=> [
+    #     #<HeadlineItem
+    #       id: 1,
+    #       title: "Headline Title",
+    #       meeting_details: #<MeetingItem id: 1, title: "Team Meeting">,
+    #       owner_details: #<UserItem id: 1, name: "John Doe">,
+    #       archived: false,
+    #       created_at: "2023-01-01",
+    #       closed_at: nil
+    #     >
+    #   ]
+    def list(user_id: nil, meeting_id: nil)
+      raise ArgumentError, "Please provide either `user_id` or `meeting_id`, not both." if user_id && meeting_id
 
-    if meeting_id
-      response = @conn.get("/api/v1/l10/#{meeting_id}/headlines")
-    else
-      user_id ||= self.user_id
-      response = @conn.get("/api/v1/headline/users/#{user_id}")
-    end
+      if meeting_id
+        response = @conn.get("/api/v1/l10/#{meeting_id}/headlines")
+      else
+        user_id ||= self.user_id
+        response = @conn.get("/api/v1/headline/users/#{user_id}")
+      end
 
-    raise "Failed to list headlines" unless response.success?
+      raise "Failed to list headlines" unless response.success?
 
-    response.body.map do |headline|
-      {
-        id: headline["Id"],
-        title: headline["Name"],
-        meeting_details: {
-          id: headline["OriginId"],
-          title: headline["Origin"]
-        },
-        owner_details: {
-          id: headline["Owner"]["Id"],
-          name: headline["Owner"]["Name"]
-        },
-        archived: headline["Archived"],
-        created_at: headline["CreateTime"],
-        closed_at: headline["CloseTime"]
-      }
+      response.body.map do |headline|
+        Types::HeadlineItem.new(
+          id: headline["Id"],
+          title: headline["Name"],
+          meeting_details: Types::MeetingItem.new(
+            id: headline["OriginId"],
+            title: headline["Origin"]
+          ),
+          owner_details: Types::UserItem.new(
+            id: headline["Owner"]["Id"],
+            name: headline["Owner"]["Name"]
+          ),
+          archived: headline["Archived"],
+          created_at: headline["CreateTime"],
+          closed_at: headline["CloseTime"]
+        )
+      end
     end
-  end
 
-  # Deletes a headline
-  #
-  # @param meeting_id [Integer] the ID of the meeting
-  # @param headline_id [Integer] the ID of the headline to delete
-  # @return [Boolean] true if the deletion was successful
-  def delete(headline_id)
-    response = @conn.delete("/api/v1/headline/#{headline_id}")
-    response.success?
+    # Deletes a headline
+    #
+    # @param headline_id [Integer] the ID of the headline to delete
+    # @return [Boolean] true if the deletion was successful
+    def delete(headline_id)
+      response = @conn.delete("/api/v1/headline/#{headline_id}")
+      response.success?
+    end
   end
 end