bloomy 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 492d10b82ab6034c0113b74c8d70352ef604039018f9fcfeca60924ded9414da
-  data.tar.gz: 2ff5fe5f2e515ee6949ed33caaa67112a24caf47a07cada9c2dfaf88edceaedd
+  metadata.gz: 787640980ef91fe249c30313f21be2230cc0671de398f714f38e1200fc104a6f
+  data.tar.gz: 6c2bb8a0b8e78371674fe5f18bc66ab44d91629d03484863442f4d3953c59707
 SHA512:
-  metadata.gz: 7414ba3b18b68878812929e5b82ce23253051d1f04a1ee2dbfcec418871db4255c44253d7497b6305cf86b7b60398affe0eade73bd16838fbb4a4d31bf2c1858
-  data.tar.gz: 067e2ab5d9b5f92a8da3c9489c8bb3318bd5818a9adeb21e867fd05e7357bf3e24ce986c8250c31128435e8e084ede3199aeee3cbab749fa1922cb4dbbd69ce7
+  metadata.gz: da4639a0e6e6e633f972d31df14818ed64e3b690f565c7308f49ae53a08c061b74d944f4d7088f8ab024ed54b4301d4186a9747802c34b24c2b7f476afdab77a
+  data.tar.gz: 6f4674b867eec7d42f5735c1c7a6725ff173ee2c8f7a1c8b22ef329ed8aa9f384e40632235a578e4d1efe654bccdda75255abbc9ab35313c11375d1815944dcb

data/lib/bloomy/client.rb

@@ -3,7 +3,7 @@
 require "faraday"
 require_relative "operations/users"
 require_relative "operations/todos"
-require_relative "operations/rocks"
+require_relative "operations/goals"
 require_relative "operations/meetings"
 require_relative "operations/scorecard"
 require_relative "operations/issues"
@@ -13,7 +13,7 @@ module Bloomy
   # The Client class is the main entry point for interacting with the Bloomy API.
   # It provides methods for managing Bloom Growth features.
   class Client
-    attr_reader :configuration, :user, :todo, :rock, :meeting, :scorecard, :issue, :headline
+    attr_reader :configuration, :user, :todo, :goal, :meeting, :scorecard, :issue, :headline
 
     # Initializes a new Client instance
     #
@@ -36,7 +36,7 @@ module Bloomy
       @user = User.new(@conn)
       @user_id = @user.default_user_id
       @todo = Todo.new(@conn, @user_id)
-      @rock = Rock.new(@conn, @user_id)
+      @goal = Goal.new(@conn, @user_id)
       @meeting = Meeting.new(@conn, @user_id)
       @scorecard = Scorecard.new(@conn, @user_id)
       @issue = Issue.new(@conn, @user_id)

data/lib/bloomy/operations/goals.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# Class to handle all the operations related to goals
+class Goal
+  # Initializes a new Goal 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 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: @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_name: goal["Origins"].empty? ? nil : goal["Origins"][0]["Name"]
+      }
+    end
+
+    archived ? {active: active_goals, archived: get_archived_goals(user_id: @user_id)} : active_goals
+  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: @user_id)
+    payload = {title: title, accountableUserId: user_id}.to_json
+    response = @conn.post("/api/v1/L10/#{meeting_id}/rocks", payload).body
+    {
+      goal_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 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("/api/v1/rocks/#{goal_id}")
+    {status: response.status}
+  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)
+  # @return [Hash] a hash containing the status of the update operation
+  # @example
+  #   client.goal.update(goal_id: 1, title: "Updated Goal")
+  #   #=> { status: 200 }
+  def update(goal_id:, title:, accountable_user: @user_id)
+    payload = {title: title, accountableUserId: accountable_user}.to_json
+    response = @conn.put("/api/v1/rocks/#{goal_id}", payload)
+    {status: response.status}
+  end
+
+  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: @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"
+      }
+    end
+  end
+end

data/lib/bloomy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bloomy
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Franccesco Orozco
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-03 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -57,10 +57,10 @@ files:
 - lib/bloomy.rb
 - lib/bloomy/client.rb
 - lib/bloomy/configuration.rb
+- lib/bloomy/operations/goals.rb
 - lib/bloomy/operations/headlines.rb
 - lib/bloomy/operations/issues.rb
 - lib/bloomy/operations/meetings.rb
-- lib/bloomy/operations/rocks.rb
 - lib/bloomy/operations/scorecard.rb
 - lib/bloomy/operations/todos.rb
 - lib/bloomy/operations/users.rb

data/lib/bloomy/operations/rocks.rb

@@ -1,109 +0,0 @@
-# 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