bloomy 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 787640980ef91fe249c30313f21be2230cc0671de398f714f38e1200fc104a6f
-  data.tar.gz: 6c2bb8a0b8e78371674fe5f18bc66ab44d91629d03484863442f4d3953c59707
+  metadata.gz: 453b980c92f83f6acf3d9a1191dcf94484a9a3acbc57811509f534964d0d15d7
+  data.tar.gz: 2c1e08c2351256c4d16b37729ce8173f144ed3680cbdd2e46f55c2a7e57b23f7
 SHA512:
-  metadata.gz: da4639a0e6e6e633f972d31df14818ed64e3b690f565c7308f49ae53a08c061b74d944f4d7088f8ab024ed54b4301d4186a9747802c34b24c2b7f476afdab77a
-  data.tar.gz: 6f4674b867eec7d42f5735c1c7a6725ff173ee2c8f7a1c8b22ef329ed8aa9f384e40632235a578e4d1efe654bccdda75255abbc9ab35313c11375d1815944dcb
+  metadata.gz: 2ae681b285f824f3ee6c5f5a9806a205d86d2c01fefe84263aa0b1d1d34bd1a3996b17dc98330051125a1b79d0f9e868ed79d7dc015294ba39a5fb71e3032ede
+  data.tar.gz: 9a7710243dc62d7bb21e6b1fb0f2795c44dbb034b0fab8f787a5b3d93c942be7ff9d25ed9bde6552e10859bfd52565d090d8b0d3f576dda31afe4da440a88707

data/lib/bloomy/client.rb

@@ -34,13 +34,12 @@ module Bloomy
         faraday.headers["Authorization"] = "Bearer #{@api_key}"
       end
       @user = User.new(@conn)
-      @user_id = @user.default_user_id
-      @todo = Todo.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)
-      @headline = Headline.new(@conn, @user_id)
+      @todo = Todo.new(@conn)
+      @goal = Goal.new(@conn)
+      @meeting = Meeting.new(@conn)
+      @scorecard = Scorecard.new(@conn)
+      @issue = Issue.new(@conn)
+      @headline = Headline.new(@conn)
     end
   end
 end

data/lib/bloomy/operations/goals.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
+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
-  # @param user_id [Integer] the ID of the user
-  def initialize(conn, user_id)
+  def initialize(conn)
     @conn = conn
-    @user_id = user_id
   end
 
   # Lists all goals for a specific user
@@ -19,7 +20,7 @@ class Goal
   # @example
   #  client.goal.list
   #   #=> [{ id: 1, title: "Complete project", created_at: "2024-06-10", ... }, ...]
-  def list(user_id: @user_id, archived: false)
+  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"],
@@ -32,7 +33,7 @@ class Goal
       }
     end
 
-    archived ? {active: active_goals, archived: get_archived_goals(user_id: @user_id)} : active_goals
+    archived ? {active: active_goals, archived: get_archived_goals(self.user_id)} : active_goals
   end
 
   # Creates a new goal
@@ -44,7 +45,7 @@ class 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: @user_id)
+  def create(title:, meeting_id:, user_id: self.user_id)
     payload = {title: title, accountableUserId: user_id}.to_json
     response = @conn.post("/api/v1/L10/#{meeting_id}/rocks", payload).body
     {
@@ -79,7 +80,7 @@ class Goal
   # @example
   #   client.goal.update(goal_id: 1, title: "Updated Goal")
   #   #=> { status: 200 }
-  def update(goal_id:, title:, accountable_user: @user_id)
+  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}
@@ -94,7 +95,7 @@ class Goal
   # @example
   #   goal.send(:get_archived_goals)
   #   #=> [{ id: 1, title: "Archived Goal", created_at: "2024-06-10", ... }, ...]
-  def get_archived_goals(user_id: @user_id)
+  def get_archived_goals(user_id = self.user_id)
     response = @conn.get("archivedrocks/user/#{user_id}").body
     response.map do |goal|
       {

data/lib/bloomy/operations/headlines.rb

@@ -1,23 +1,24 @@
 # frozen_string_literal: true
 
+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
-  # @param user_id [Integer] the ID of the user
-  def initialize(conn, user_id)
+  def initialize(conn)
     @conn = conn
-    @user_id = user_id
   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 owner
+  # @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)
+  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
@@ -26,7 +27,7 @@ class Headline
       id: response.body["Id"],
       title: response.body["Title"],
       owner_id: response.body["OwnerId"],
-      notes: response.body["Notes"]
+      notes_url: response.body["DetailsUrl"]
     }
   end
 
@@ -52,6 +53,7 @@ class Headline
     {
       id: response.body["Id"],
       title: response.body["Name"],
+      notes_url: response.body["DetailsUrl"],
       meeting_details: {
         id: response.body["OriginId"],
         name: response.body["Origin"]
@@ -66,13 +68,30 @@ class Headline
     }
   end
 
-  # Get user headlines
+  # Get headlines for a user or a meeting.
   #
-  # @param user_id [Integer] the ID of the user
-  # @return [Array] the list of headlines for the user
-  def user_headlines(user_id: @user_id)
-    response = @conn.get("/api/v1/headline/users/#{user_id}")
-    raise "Failed to list headlines" unless response.status == 200
+  # @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)
+    if user_id && meeting_id
+      raise ArgumentError, "Please provide either `user_id` or `meeting_id`, not both."
+    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?
+
     response.body.map do |headline|
       {
         id: headline["Id"],

data/lib/bloomy/operations/issues.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 require "json"
+require "bloomy/utils/get_user_id"
 
 # Class to handle all the operations related to issues
 class Issue
+  include Bloomy::Utilities::UserIdUtility
   # 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)
+  def initialize(conn)
     @conn = conn
-    @user_id = user_id
   end
 
   # Retrieves details of a specific issue
@@ -39,15 +39,33 @@ class Issue
     }
   end
 
-  # Lists issues for a specific user
+  # Lists issues for a specific user or meeting
   #
-  # @param user_id [Integer] the ID of the user (default is the initialized user ID)
+  # @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>] an array of hashes containing issues details
   # @example
+  #   # Fetch issues for the current user
   #   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
+  #
+  #   # Fetch issues for a specific user
+  #   issue.list(user_id: 42)
+  #
+  #   # Fetch issues for a specific meeting
+  #   issue.list(meeting_id: 99)
+  def list(user_id: nil, meeting_id: nil)
+    if user_id && meeting_id
+      raise ArgumentError, "Please provide either `user_id` or `meeting_id`, not both."
+    end
+
+    if meeting_id
+      response = @conn.get("l10/#{meeting_id}/issues").body
+    else
+      user_id ||= self.user_id
+      response = @conn.get("issues/users/#{user_id}").body
+    end
+
     response.map do |issue|
       {
         id: issue["Id"],
@@ -74,13 +92,15 @@ class Issue
 
   # Creates a new issue
   #
-  # @param title [String] the title of the new issue
   # @param meeting_id [Integer] the ID of the meeting associated with the issue
+  # @param title [String] the title of the new issue
+  # @param user_id [Integer] the ID of the user responsible for the issue (default: initialized user ID)
+  # @param notes [String, nil] the notes for the issue (optional)
   # @return [Hash] a hash containing the new issue's ID and title
   # @example
-  #   issue.create("New Issue", 456)
+  #   issue.create(meeting_id: 123, title: "New Issue")
   #   #=> { id: 789, title: "New Issue" }
-  def create(meeting_id:, title:, user_id: @user_id, notes: nil)
+  def create(meeting_id:, title:, user_id: self.user_id, notes: nil)
     response = @conn.post("issues/create", {title: title, meetingid: meeting_id, ownerid: user_id, notes: notes}.to_json)
     {
       id: response.body["Id"],
@@ -88,7 +108,7 @@ class Issue
       meeting_title: response.body["Origin"],
       title: response.body["Name"],
       user_id: response.body["Owner"]["Id"],
-      details_url: response.body["DetailsUrl"]
+      notes_url: response.body["DetailsUrl"]
     }
   end
 end

data/lib/bloomy/operations/meetings.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
+require "bloomy/utils/get_user_id"
+
 # 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
+  include Bloomy::Utilities::UserIdUtility
   # 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)
+  def initialize(conn)
     @conn = conn
-    @user_id = user_id
   end
 
   # Lists all meetings for a specific user
@@ -20,7 +21,7 @@ class Meeting
   # @example
   #   client.meeting.list
   #   #=> [{ id: 123, name: "Team Meeting" }, ...]
-  def list(user_id: @user_id)
+  def list(user_id = self.user_id)
     response = @conn.get("L10/#{user_id}/list").body
     response.map { |meeting| {id: meeting["Id"], name: meeting["Name"]} }
   end
@@ -148,7 +149,7 @@ class Meeting
   # @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: [])
+  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"]

data/lib/bloomy/operations/scorecard.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
 require "json"
+require "bloomy/utils/get_user_id"
 
 # Class to handle all the operations related to scorecards
 # @note
 #   This class is already initialized via the client and usable as `client.scorecard.method`
 class Scorecard
+  include Bloomy::Utilities::UserIdUtility
+
   # Initializes a new Scorecard 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)
+  def initialize(conn)
     @conn = conn
-    @user_id = user_id
   end
 
   # Retrieves the current week details
@@ -56,7 +57,7 @@ class Scorecard
     if meeting_id
       response = @conn.get("scorecard/meeting/#{meeting_id}").body
     else
-      user_id ||= @user_id
+      user_id ||= self.user_id
       response = @conn.get("scorecard/user/#{user_id}").body
     end
 

data/lib/bloomy/operations/todos.rb

@@ -1,31 +1,54 @@
 # frozen_string_literal: true
 
 require "date"
+require_relative "../utils/get_user_id"
 
 # Class to handle all the operations related to todos
 class Todo
+  include Bloomy::Utilities::UserIdUtility
+
   # 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)
+  def initialize(conn)
     @conn = conn
-    @user_id = user_id
   end
 
-  # Lists all todos for a specific user
+  # Lists all todos for a specific user or meeting
   #
-  # @param user_id [Integer] the ID of the user (default is the initialized user ID)
+  # @param user_id [Integer, nil] the ID of the user (default is the initialized user ID)
+  # @param meeting_id [Integer, nil] the ID of the meeting
   # @return [Array<Hash>] an array of hashes containing todo details
+  # @raise [ArgumentError] if both `user_id` and `meeting_id` are provided
   # @example
+  #   # Fetch todos for the current user
   #   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
+  #   #=> [{ id: 1, title: "New Todo", due_date: "2024-06-15", ... }]
+  #
+  #   # Fetch todos for a specific user
+  #   client.todo.list(user_id: 42)
+  #   # => [{ id: 1, title: "New Todo", due_date: "2024-06-15", ... }]
+  #
+  #   # Fetch todos for a specific meeting
+  #   client.todo.list(meeting_id: 99)
+  #   # => [{ id: 1, title: "New Todo", due_date: "2024-06-15", ... }]
+  def list(user_id: nil, meeting_id: nil)
+    if user_id && meeting_id
+      raise ArgumentError, "Please provide either `user_id` or `meeting_id`, not both."
+    end
+
+    if meeting_id
+      response = @conn.get("l10/#{meeting_id}/todos").body
+    else
+      user_id ||= self.user_id
+      response = @conn.get("todo/user/#{user_id}").body
+    end
+
     response.map do |todo|
       {
         id: todo["Id"],
         title: todo["Name"],
+        notes_url: todo["DetailsUrl"],
         due_date: todo["DueDate"],
         created_at: todo["CreateTime"],
         completed_at: todo["CompleteTime"],
@@ -40,12 +63,13 @@ class 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)
+  # @param notes [String, nil] additional notes for the todo (optional)
   # @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}
+  def create(title:, meeting_id:, due_date: nil, user_id: self.user_id, notes: nil)
+    payload = {title: title, accountableUserId: user_id, notes: notes}
     payload[:dueDate] = due_date if due_date
     response = @conn.post("/api/v1/L10/#{meeting_id}/todos", payload.to_json).body
 
@@ -54,7 +78,8 @@ class Todo
       title: response["Name"],
       meeting_name: response["Origin"],
       meeting_id: response["OriginId"],
-      due_date: response["DueDate"]
+      due_date: response["DueDate"],
+      notes_url: response["DetailsUrl"]
     }
   end
 
@@ -96,4 +121,29 @@ class Todo
       updated_at: DateTime.now.to_s
     }
   end
+
+  # Retrieves the details of a specific todo item by its ID.
+  #
+  # @param todo_id [String] The ID of the todo item to retrieve.
+  # @return [Hash] A hash containing the details of the todo item.
+  # @raise [RuntimeError] If the request to retrieve the todo details fails.
+  # @example
+  #  client.todo.details(1)
+  #  #=> { id: 1, title: "Updated Todo", due_date: "2024-11-01T01:41:41.528Z", ... }
+  def details(todo_id)
+    response = @conn.get("/api/v1/todo/#{todo_id}")
+    raise "Failed to get todo details. Status: #{response.status}" unless response.success?
+
+    todo = response.body
+    {
+      id: todo["Id"],
+      meeting_id: todo["OriginId"],
+      title: todo["Name"],
+      notes_url: todo["DetailsUrl"],
+      due_date: todo["DueDate"],
+      created_at: todo["CreateTime"],
+      completed_at: todo["CompleteTime"],
+      status: todo["Complete"] ? "Complete" : "Incomplete"
+    }
+  end
 end

data/lib/bloomy/operations/users.rb

@@ -1,26 +1,16 @@
 # frozen_string_literal: true
 
+require "bloomy/utils/get_user_id"
+
 # Class to handle all the operations related to users
 class User
-  attr_reader :default_user_id
+  include Bloomy::Utilities::UserIdUtility
 
   # 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
@@ -33,13 +23,12 @@ class User
   # @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)
+  def details(user_id = self.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[:direct_reports] = direct_reports(user_id) if direct_reports || all
+    user_details[:positions] = positions(user_id) if positions || all
     user_details
   end
 
@@ -50,7 +39,7 @@ class User
   # @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)
+  def direct_reports(user_id = self.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
@@ -62,7 +51,7 @@ class User
   # @example
   #   user.positions
   #   #=> [{name: "Manager", id: 3}, ...]
-  def positions(user_id: @default_user_id)
+  def positions(user_id = self.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"]}

data/lib/bloomy/utils/get_user_id.rb

@@ -0,0 +1,22 @@
+module Bloomy
+  module Utilities
+    module UserIdUtility
+      # Lazy loads the user_id of the default user
+      #
+      # @return [String] the user_id of the default user
+      def user_id
+        @user_id ||= default_user_id
+      end
+
+      private
+
+      # Returns the user_id of the default user
+      #
+      # @return [String] The user_id of the default user
+      def default_user_id
+        response = @conn.get("users/mine").body
+        response["Id"]
+      end
+    end
+  end
+end

data/lib/bloomy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bloomy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Franccesco Orozco
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-04 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -64,6 +64,7 @@ files:
 - lib/bloomy/operations/scorecard.rb
 - lib/bloomy/operations/todos.rb
 - lib/bloomy/operations/users.rb
+- lib/bloomy/utils/get_user_id.rb
 - lib/bloomy/version.rb
 - sig/bloomy.rbs
 homepage: https://github.com/franccesco/bloomy