bloomy 0.10.0 → 0.11.4

data/lib/bloomy/operations/scorecard.rb

@@ -3,108 +3,106 @@
 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
+module Bloomy
+  # 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
-  def initialize(conn)
-    @conn = conn
-  end
+    # Initializes a new Scorecard instance
+    #
+    # @param conn [Object] the connection object to interact with the API
+    def initialize(conn)
+      @conn = conn
+    end
 
-  # Retrieves the current week details
-  #
-  # @return [Hash] a hash containing current week details
-  # @example
-  #   client.scorecard.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 current week details
+    #
+    # @return [Types::WeekItem] an object containing current week details
+    # @example
+    #   client.scorecard.current_week
+    #   #=> #<Types::WeekItem @id=123, @week_number=24, @week_start="2024-06-10", @week_end="2024-06-16">
+    def current_week
+      response = @conn.get("weeks/current").body
+      Types::WeekItem.new(
+        id: response["Id"],
+        week_number: response["ForWeekNumber"],
+        week_start: response["LocalDate"]["Date"],
+        week_end: response["ForWeek"]
+      )
+    end
 
-  # Retrieves the scorecards 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
-  # @param show_empty [Boolean] whether to include scores with nil values (default: false)
-  # @param week_offset [Integer, nil] offset for the week number to filter scores
-  # @raise [ArgumentError] if both `user_id` and `meeting_id` are provided
-  # @return [Array<Hash>] an array of hashes containing scorecard details
-  # @example
-  #   # Fetch scorecards for the current user
-  #   client.scorecard.list
-  #
-  #   # Fetch scorecards for a specific user
-  #   client.scorecard.list(user_id: 42)
-  #
-  #   # Fetch scorecards for a specific meeting
-  #   client.scorecard.list(meeting_id: 99)
-  # @note
-  #  The `week_offset` parameter is useful when fetching scores for previous or future weeks.
-  #  For example, to fetch scores for the previous week, you can set `week_offset` to -1.
-  #  To fetch scores for a future week, you can set `week_offset` to a positive value.
-  def list(user_id: nil, meeting_id: nil, show_empty: false, week_offset: nil)
-    raise ArgumentError, "Please provide either `user_id` or `meeting_id`, not both." if user_id && meeting_id
+    # Retrieves the scorecards 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
+    # @param show_empty [Boolean] whether to include scores with nil values (default: false)
+    # @param week_offset [Integer, nil] offset for the week number to filter scores
+    # @raise [ArgumentError] if both `user_id` and `meeting_id` are provided
+    # @return [Array<Types::ScorecardItem>] an array of scorecard items
+    # @example
+    #   # Fetch scorecards for the current user
+    #   client.scorecard.list
+    #
+    #   # Fetch scorecards for a specific user
+    #   client.scorecard.list(user_id: 42)
+    #
+    #   # Fetch scorecards for a specific meeting
+    #   client.scorecard.list(meeting_id: 99)
+    # @note
+    #  The `week_offset` parameter is useful when fetching scores for previous or future weeks.
+    #  For example, to fetch scores for the previous week, you can set `week_offset` to -1.
+    #  To fetch scores for a future week, you can set `week_offset` to a positive value.
+    def list(user_id: nil, meeting_id: nil, show_empty: false, week_offset: nil)
+      raise ArgumentError, "Please provide either `user_id` or `meeting_id`, not both." if user_id && meeting_id
 
-    if meeting_id
-      response = @conn.get("scorecard/meeting/#{meeting_id}").body
-    else
-      user_id ||= self.user_id
-      response = @conn.get("scorecard/user/#{user_id}").body
-    end
+      if meeting_id
+        response = @conn.get("scorecard/meeting/#{meeting_id}").body
+      else
+        user_id ||= self.user_id
+        response = @conn.get("scorecard/user/#{user_id}").body
+      end
+
+      scorecards = response["Scores"].map do |scorecard|
+        Types::ScorecardItem.new(
+          id: scorecard["Id"],
+          measurable_id: scorecard["MeasurableId"],
+          accountable_user_id: scorecard["AccountableUserId"],
+          title: scorecard["MeasurableName"],
+          target: scorecard["Target"],
+          value: scorecard["Measured"],
+          week: scorecard["Week"],
+          week_id: scorecard["ForWeek"],
+          updated_at: scorecard["DateEntered"]
+        )
+      end
 
-    scorecards = response["Scores"].map do |scorecard|
-      {
-        id: scorecard["Id"],
-        measurable_id: scorecard["MeasurableId"],
-        accountable_user_id: scorecard["AccountableUserId"],
-        title: scorecard["MeasurableName"],
-        target: scorecard["Target"],
-        value: scorecard["Measured"],
-        week: scorecard["Week"],
-        week_id: scorecard["ForWeek"],
-        updated_at: scorecard["DateEntered"]
-      }
+      if week_offset
+        week_data = current_week
+        week_id = week_data.week_number + week_offset
+        scorecards.select! { |scorecard| scorecard.week_id == week_id }
+      end
+
+      scorecards.select! { |scorecard| scorecard.value || show_empty } unless show_empty
+      scorecards
     end
 
-    if week_offset
+    # Updates the score for a measurable item for a specific week.
+    #
+    # @param measurable_id [Integer] the ID of the measurable item
+    # @param score [Numeric] the score to be assigned to the measurable item
+    # @param week_offset [Integer] the number of weeks to offset from the current week (default: 0)
+    # @return [Boolean] true if the score was successfully updated
+    # @example
+    #   client.scorecard.score(measurable_id: 123, score: 5)
+    #   #=> true
+    def score(measurable_id:, score:, week_offset: 0)
       week_data = current_week
       week_id = week_data[:week_number] + week_offset
-      scorecards.select! { |scorecard| scorecard[:week_id] == week_id }
-    end
-
-    scorecards.select! { |scorecard| scorecard[:value] || show_empty } unless show_empty
-    scorecards
-  end
 
-  # Updates the score for a measurable item for a specific week.
-  #
-  # @param measurable_id [Integer] the ID of the measurable item.
-  # @param score [Numeric] the score to be assigned to the measurable item.
-  # @param week_offset [Integer] the number of weeks to offset from the current week (default is 0).
-  # @return [Boolean] true if the score was successfully updated, false otherwise.
-  # @example
-  #  client.scorecard.score(measurable_id: 123, score: 5)
-  #  #=> true
-  # @note
-  #  The `week_offset` parameter is useful when updating scores for previous weeks.
-  #  For example, to update the score for the previous week, you can set `week_offset` to -1.
-  #  To update a future week's score, you can set `week_offset` to a positive value.
-  def score(measurable_id:, score:, week_offset: 0)
-    week_data = current_week
-    week_id = week_data[:week_number] + week_offset
-
-    response = @conn.put("measurables/#{measurable_id}/week/#{week_id}", {value: score}.to_json)
-    response.success?
+      response = @conn.put("measurables/#{measurable_id}/week/#{week_id}", {value: score}.to_json)
+      response.success?
+    end
   end
 end

data/lib/bloomy/operations/todos.rb

@@ -1,148 +1,143 @@
 # frozen_string_literal: true
 
 require "date"
-require_relative "../utils/get_user_id"
+require "bloomy/utils/get_user_id"
 
-# Class to handle all the operations related to todos
-class Todo
-  include Bloomy::Utilities::UserIdUtility
+module Bloomy
+  # 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
-  def initialize(conn)
-    @conn = conn
-  end
+    # Initializes a new Todo instance
+    #
+    # @param conn [Object] the connection object to interact with the API
+    def initialize(conn)
+      @conn = conn
+    end
 
-  # Lists all todos for a specific user or meeting
-  #
-  # @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: "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)
-    raise ArgumentError, "Please provide either `user_id` or `meeting_id`, not both." if user_id && meeting_id
+    # Lists all todos for a specific user or meeting
+    #
+    # @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<TodoItem>] an array of TodoItem objects
+    # @raise [ArgumentError] if both `user_id` and `meeting_id` are provided
+    # @example
+    #   # Fetch todos for the current user
+    #   client.todo.list
+    #   #=> [#<TodoItem id: 1, title: "New Todo", due_date: "2024-06-15", ...>]
+    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("l10/#{meeting_id}/todos").body
-    else
-      user_id ||= self.user_id
-      response = @conn.get("todo/user/#{user_id}").body
-    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"],
-        status: todo["Complete"] ? "Complete" : "Incomplete"
-      }
+      response.map do |todo|
+        Types::TodoItem.new(
+          id: todo["Id"],
+          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
-  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)
-  # @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: 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
+    # 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)
+    # @param notes [String, nil] additional notes for the todo (optional)
+    # @return [TodoItem] the newly created todo item
+    # @example
+    #   client.todo.create(title: "New Todo", meeting_id: 1, due_date: "2024-06-15")
+    #   #=> #<TodoItem id: 1, title: "New Todo", due_date: "2024-06-15", ...>
+    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
 
-    {
-      id: response["Id"],
-      title: response["Name"],
-      meeting_title: response["Origin"],
-      meeting_id: response["OriginId"],
-      due_date: response["DueDate"],
-      notes_url: response["DetailsUrl"]
-    }
-  end
+      Types::TodoItem.new(
+        id: response["Id"],
+        title: response["Name"],
+        notes_url: response["DetailsUrl"],
+        due_date: response["DueDate"],
+        created_at: DateTime.now.to_s,
+        status: "Incomplete"
+      )
+    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")
-    response.success?
-  end
+    # Marks a todo as complete
+    #
+    # @param todo_id [Integer] the ID of the todo to complete
+    # @return [Boolean] true if the operation was successful
+    # @example
+    #   todo.complete(1)
+    #   #=> true
+    def complete(todo_id)
+      response = @conn.post("/api/v1/todo/#{todo_id}/complete?status=true")
+      response.success?
+    end
 
-  # Updates an existing todo
-  #
-  # @param todo_id [Integer] the ID of the todo to update
-  # @param title [String, nil] the new title of the todo (optional)
-  # @param due_date [String, nil] the new due date of the todo (optional)
-  # @return [Hash] a hash containing the updated todo's details
-  # @example
-  #   todo.update(1, title: "Updated Todo", due_date: "2024-11-01T01:41:41.528Z")
-  #   #=> { id: 1, title: "Updated Todo", due_date: "2024-11-01T01:41:41.528Z", ... }
-  def update(todo_id:, title: nil, due_date: nil)
-    payload = {}
-    payload[:title] = title if title
-    payload[:dueDate] = due_date if due_date
+    # Updates an existing todo
+    #
+    # @param todo_id [Integer] the ID of the todo to update
+    # @param title [String, nil] the new title of the todo (optional)
+    # @param due_date [String, nil] the new due date of the todo (optional)
+    # @return [TodoItem] the updated todo item
+    # @raise [ArgumentError] if no update fields are provided
+    # @raise [RuntimeError] if the update request fails
+    # @example
+    #   todo.update(todo_id: 1, title: "Updated Todo", due_date: "2024-11-01")
+    #   #=> #<TodoItem id: 1, title: "Updated Todo", due_date: "2024-11-01", ...>
+    def update(todo_id:, title: nil, due_date: nil)
+      payload = {}
+      payload[:title] = title if title
+      payload[:dueDate] = due_date if due_date
 
-    raise ArgumentError, "At least one field must be provided" if payload.empty?
+      raise ArgumentError, "At least one field must be provided" if payload.empty?
 
-    response = @conn.put("/api/v1/todo/#{todo_id}", payload.to_json)
-    raise "Failed to update todo. Status: #{response.status}" unless response.status == 200
+      response = @conn.put("/api/v1/todo/#{todo_id}", payload.to_json)
+      raise "Failed to update todo. Status: #{response.status}" unless response.status == 200
 
-    {
-      id: todo_id,
-      title: title,
-      due_date: due_date,
-      updated_at: DateTime.now.to_s
-    }
-  end
+      Types::TodoItem.new(
+        id: todo_id,
+        title: title,
+        due_date: due_date,
+        created_at: nil,
+        status: "Incomplete"
+      )
+    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?
+    # Retrieves the details of a specific todo item by its ID.
+    #
+    # @param todo_id [Integer] The ID of the todo item to retrieve.
+    # @return [TodoItem] The requested todo item
+    # @raise [RuntimeError] If the request to retrieve the todo details fails.
+    # @example
+    #   client.todo.details(1)
+    #   #=> #<TodoItem id: 1, title: "Updated Todo", due_date: "2024-11-01", ...>
+    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"],
-      meeting_title: todo["Origin"],
-      title: todo["Name"],
-      notes_url: todo["DetailsUrl"],
-      due_date: todo["DueDate"],
-      created_at: todo["CreateTime"],
-      completed_at: todo["CompleteTime"],
-      status: todo["Complete"] ? "Complete" : "Incomplete"
-    }
+      todo = response.body
+      Types::TodoItem.new(
+        id: todo["Id"],
+        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
 end