bloomy 0.10.0 → 0.11.4

data/lib/bloomy/operations/users.rb

@@ -2,103 +2,118 @@
 
 require "bloomy/utils/get_user_id"
 
-# Class to handle all the operations related to users
-class User
-  include Bloomy::Utilities::UserIdUtility
+module Bloomy
+  # Class to handle all the operations related to users
+  class User
+    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
-  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 = 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"]}
+    # Initializes a new User instance
+    #
+    # @param conn [Object] the connection object to interact with the API
+    def initialize(conn)
+      @conn = conn
+    end
 
-    user_details[:direct_reports] = direct_reports(user_id) if direct_reports || all
-    user_details[:positions] = positions(user_id) if positions || all
-    user_details
-  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 [Types::UserItem] a UserItem object containing user details
+    # @example
+    #   client.user.details
+    #   #=> #<Types::UserItem id: 1, name: "John Doe", image_url: "http://example.com/image.jpg">
+    def details(user_id = self.user_id, direct_reports: false, positions: false, all: false)
+      response = @conn.get("users/#{user_id}").body
+      user_details = Types::UserItem.new(
+        id: response["Id"],
+        name: response["Name"],
+        image_url: response["ImageUrl"]
+      )
 
-  # 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 = 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
+      user_details.direct_reports = direct_reports(user_id) if direct_reports || all
+      user_details.positions = positions(user_id) if positions || all
+      user_details
+    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 = 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"]}
+    # Retrieves direct reports of a specific user
+    #
+    # @param user_id [Integer] the ID of the user (default: the current user ID)
+    # @return [Array<Types::UserItem>] an array of UserItem objects containing direct report details
+    # @example
+    #   client.user.direct_reports
+    #   #=> [#<Types::UserItem name: "Jane Smith", id: 2, image_url: "http://example.com/image.jpg">, ...]
+    def direct_reports(user_id = self.user_id)
+      direct_reports_response = @conn.get("users/#{user_id}/directreports").body
+      direct_reports_response.map do |report|
+        Types::UserItem.new(
+          name: report["Name"],
+          id: report["Id"],
+          image_url: report["ImageUrl"]
+        )
+      end
     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"]
-      }
+    # Retrieves positions of a specific user
+    #
+    # @param user_id [Integer] the ID of the user (default: the current user ID)
+    # @return [Array<Types::UserItem>] an array of UserItem objects containing position details
+    # @example
+    #   user.positions
+    #   #=> [#<Types::UserItem name: "Manager", id: 3>, ...]
+    def positions(user_id = self.user_id)
+      position_response = @conn.get("users/#{user_id}/seats").body
+      position_response.map do |position|
+        Types::UserItem.new(
+          name: position["Group"]["Position"]["Name"],
+          id: position["Group"]["Position"]["Id"]
+        )
+      end
     end
-  end
 
-  # Retrieves all users in the system
-  #
-  # @param include_placeholders [Boolean] whether to include users
-  # @return [Array<Hash>] an array of hashes containing user details
-  # @example
-  #   user.all
-  #   #=> [{id: 1, name: "John Doe", email: "john@example.com", ...}, ...]
-  def all(include_placeholders: false)
-    users = @conn.get("search/all", term: "%").body
-    users
-      .select { |user| user["ResultType"] == "User" }
-      .reject { |user| !include_placeholders && user["ImageUrl"] == "/i/userplaceholder" }
-      .map do |user|
-        {
+    # Searches for users based on a search term
+    #
+    # @param term [String] the search term
+    # @return [Array<Types::UserItem>] an array of UserItem objects containing search results
+    # @example
+    #   user.search("John")
+    #   #=> [#<Types::UserItem id: 1, name: "John Doe", description: "Developer", ...>, ...]
+    def search(term)
+      response = @conn.get("search/user", term: term).body
+      response.map do |user|
+        Types::UserItem.new(
           id: user["Id"],
           name: user["Name"],
+          description: user["Description"],
           email: user["Email"],
-          position: user["Description"],
+          organization_id: user["OrganizationId"],
           image_url: user["ImageUrl"]
-        }
+        )
       end
+    end
+
+    # Retrieves all users in the system
+    #
+    # @param include_placeholders [Boolean] whether to include placeholder users (default: false)
+    # @return [Array<Types::UserItem>] an array of UserItem objects containing user details
+    # @example
+    #   user.all
+    #   #=> [#<Types::UserItem id: 1, name: "John Doe", email: "john@example.com", ...>, ...]
+    def all(include_placeholders: false)
+      users = @conn.get("search/all", term: "%").body
+      users
+        .select { |user| user["ResultType"] == "User" }
+        .reject { |user| !include_placeholders && user["ImageUrl"] == "/i/userplaceholder" }
+        .map do |user|
+          Types::UserItem.new(
+            id: user["Id"],
+            name: user["Name"],
+            email: user["Email"],
+            position: user["Description"],
+            image_url: user["ImageUrl"]
+          )
+        end
+    end
   end
 end

data/lib/bloomy/types/items.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Bloomy
+  module Types
+    TodoItem = Struct.new(
+      :id,
+      :title,
+      :notes_url,
+      :due_date,
+      :created_at,
+      :completed_at,
+      :status,
+      :user_name,
+      :user_id,
+      keyword_init: true
+    )
+
+    HeadlineItem = Struct.new(
+      :id,
+      :title,
+      :notes_url,
+      :meeting_details,
+      :owner_details,
+      :archived,
+      :created_at,
+      :closed_at,
+      keyword_init: true
+    )
+
+    MeetingItem = Struct.new(
+      :id,
+      :title,
+      keyword_init: true
+    )
+
+    MeetingDetails = Struct.new(
+      :id,
+      :title,
+      :attendees,
+      :issues,
+      :todos,
+      :metrics,
+      keyword_init: true
+    )
+
+    MetricItem = Struct.new(
+      :id,
+      :title,
+      :target,
+      :operator,
+      :format,
+      :user_id,
+      :user_name,
+      :admin_id,
+      :admin_name,
+      keyword_init: true
+    )
+
+    UserItem = Struct.new(
+      :id,
+      :name,
+      :image_url,
+      :email,
+      :description,
+      :organization_id,
+      :position,
+      :direct_reports,
+      :positions,
+      keyword_init: true
+    )
+
+    GoalItem = Struct.new(
+      :id,
+      :title,
+      :created_at,
+      :due_date,
+      :status,
+      :meeting_id,
+      :meeting_title,
+      :user_id,
+      :user_name,
+      keyword_init: true
+    )
+
+    IssueItem = Struct.new(
+      :id,
+      :title,
+      :notes_url,
+      :created_at,
+      :completed_at,
+      :meeting_id,
+      :meeting_title,
+      :user_id,
+      :user_name,
+      keyword_init: true
+    )
+
+    WeekItem = Struct.new(
+      :id,
+      :week_number,
+      :week_start,
+      :week_end,
+      keyword_init: true
+    )
+
+    ScorecardItem = Struct.new(
+      :id,
+      :measurable_id,
+      :accountable_user_id,
+      :title,
+      :target,
+      :value,
+      :week,
+      :week_id,
+      :updated_at,
+      keyword_init: true
+    )
+  end
+end

data/lib/bloomy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bloomy
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.4
 platform: ruby
 authors:
 - Franccesco Orozco
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,7 @@ files:
 - lib/bloomy/operations/scorecard.rb
 - lib/bloomy/operations/todos.rb
 - lib/bloomy/operations/users.rb
+- lib/bloomy/types/items.rb
 - lib/bloomy/utils/get_user_id.rb
 - lib/bloomy/utils/plugin_loader.rb
 - lib/bloomy/version.rb