bloomy 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 783fa82ea83467cc8e6d012305831a5bfb73f43897c50b8f80a96276778004f5
-  data.tar.gz: 0e2f5b69910a85d9866d2715921ee5b27f569c466aaac16f5a4343db3bc71ca7
+  metadata.gz: 492d10b82ab6034c0113b74c8d70352ef604039018f9fcfeca60924ded9414da
+  data.tar.gz: 2ff5fe5f2e515ee6949ed33caaa67112a24caf47a07cada9c2dfaf88edceaedd
 SHA512:
-  metadata.gz: 42f086d17f1b29d61060629a6630a7f8380cf54cb4d993425dd44f0d859765bfbf400d3f6a42df1ec5d6f910c8a45904fd91875005aa76aff9498e50112a6f1b
-  data.tar.gz: b9ac85ecf2dc0114b1cdf92d71def98927233b103b260970f52797a728b0dd8077db04eabc68aba72c0c77df9091c327d8a2151efe2f95767139dd440975a4d1
+  metadata.gz: 7414ba3b18b68878812929e5b82ce23253051d1f04a1ee2dbfcec418871db4255c44253d7497b6305cf86b7b60398affe0eade73bd16838fbb4a4d31bf2c1858
+  data.tar.gz: 067e2ab5d9b5f92a8da3c9489c8bb3318bd5818a9adeb21e867fd05e7357bf3e24ce986c8250c31128435e8e084ede3199aeee3cbab749fa1922cb4dbbd69ce7

data/.rubocop.yml

@@ -25,3 +25,6 @@ Naming/AccessorMethodName:
 
 Gemspec/DevelopmentDependencies:
   Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/README.md

@@ -1,28 +1,26 @@
 # Bloomy
 
-The Bloomy is a Ruby library for interacting with the Bloom Growth API. It provides convenient methods for getting user details, todos, rocks, meetings, measurables, and issues.
+[![Gem Version](https://badge.fury.io/rb/bloomy.svg)](https://badge.fury.io/rb/bloomy)[![RSpec Tests](https://github.com/franccesco/bloomy/actions/workflows/main.yml/badge.svg)](https://github.com/franccesco/bloomy/actions/workflows/main.yml) [![Deploy Docs](https://github.com/franccesco/bloomy/actions/workflows/deploy_docs.yml/badge.svg)](https://github.com/franccesco/bloomy/actions/workflows/deploy_docs.yml)
+
+Bloomy is a Ruby library for interacting with the Bloom Growth API. It provides convenient methods for getting user details, todos, rocks, meetings, measurables, and issues.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'bloomy'
+bundle add bloomy
 ```
 
-And then execute:
-
-```sh
-bundle install
-```
-
-Or install it yourself as:
+Or install it to your system:
 
 ```sh
 gem install bloomy
 ```
 
-## Configuration
+## Get Started
+
+You can find the [full docs here](https://franccesco.github.io/bloomy/) but here's a quick overview to get you started.
 
 ### Initialize the Configuration
 
@@ -36,20 +34,23 @@ config = Bloomy::Configuration.new
 
 ### Configure the API Key
 
-You can configure the API key using your username and password. Optionally, you can store the API key locally for future use.
+You can configure the API key using your username and password. Optionally, you can store the API key locally under `~/.bloomy/config.yaml` for future use.
 
 ```ruby
 config.configure_api_key("your_username", "your_password", store_key: true)
 ```
 
-Alternatively you can set an `API_KEY` environment variable and it will be loaded automatically for you once you initialize a client.
+You can also set an `BG_API_KEY` environment variable and it will be loaded automatically for you once you initialize a client. A configuration is useful if you plan to use a fixed API key for your operations. However, you can also pass an API key when initializing a client without doing any configuration.
 
 ## Client Initialization
 
 Once the configuration is set up, you can initialize the client. The client provides access to various features such as managing users, todos, rocks, meetings, measurables, and issues.
 
+> [!NOTE]
+> Passing an API key is entirely optional and only useful if you plan to use different API keys to manage different organizations. This will bypass the regular configuration process.
+
 ```ruby
-client = Bloomy::Client.new
+client = Bloomy::Client.new(api_key: "abc...")
 ```
 
 ## Using Client Features
@@ -102,16 +103,16 @@ rocks = client.rock.list
 new_rock = client.rock.create(title: "New Rock", meeting_id: 1)
 ```
 
-### Measurable Management
+### Scorecard Management
 
 To interact with measurable-related features:
 
 ```ruby
-# Get current week details
-current_week = client.measurable.current_week
+# Get user scorecard
+user_scorecard = client.scorecard.list(user_id: 1)
 
-# Get the scorecard for the user
-scorecard = client.measurable.scorecard
+# Get a meeting scorecard
+meeting_scorecard = client.scorecard.list(meeting_id: 1)
 ```
 
 ### Issue Management

data/bloomy.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Manage your Bloom Growth account from the command line."
   spec.homepage = "https://github.com/franccesco/bloomy"
   spec.required_ruby_version = ">= 2.6.0"
-  spec.licenses = ["MIT"]
+  spec.licenses = ["Apache-2.0"]
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 

data/lib/bloomy/client.rb

@@ -5,14 +5,15 @@ require_relative "operations/users"
 require_relative "operations/todos"
 require_relative "operations/rocks"
 require_relative "operations/meetings"
-require_relative "operations/measurables"
+require_relative "operations/scorecard"
 require_relative "operations/issues"
+require_relative "operations/headlines"
 
 module Bloomy
   # The Client class is the main entry point for interacting with the Bloomy API.
-  # It provides methods for managing users, todos, rocks, meetings, measurables, and issues.
+  # It provides methods for managing Bloom Growth features.
   class Client
-    attr_reader :configuration, :user, :todo, :rock, :meeting, :measurable, :issue
+    attr_reader :configuration, :user, :todo, :rock, :meeting, :scorecard, :issue, :headline
 
     # Initializes a new Client instance
     #
@@ -21,23 +22,25 @@ module Bloomy
     #   client.meetings.list
     #   client.user.details
     #   client.meeting.delete(id)
-    def initialize
-      @configuration = Configuration.new
+    def initialize(api_key = nil)
+      @configuration = Configuration.new unless api_key
+      @api_key = api_key || @configuration.api_key
       @base_url = "https://app.bloomgrowth.com/api/v1"
       @conn = Faraday.new(url: @base_url) do |faraday|
         faraday.response :json
         faraday.adapter Faraday.default_adapter
         faraday.headers["Accept"] = "*/*"
         faraday.headers["Content-Type"] = "application/json"
-        faraday.headers["Authorization"] = "Bearer #{configuration.api_key}"
+        faraday.headers["Authorization"] = "Bearer #{@api_key}"
       end
       @user = User.new(@conn)
       @user_id = @user.default_user_id
       @todo = Todo.new(@conn, @user_id)
       @rock = Rock.new(@conn, @user_id)
       @meeting = Meeting.new(@conn, @user_id)
-      @measurable = Measurable.new(@conn, @user_id)
+      @scorecard = Scorecard.new(@conn, @user_id)
       @issue = Issue.new(@conn, @user_id)
+      @headline = Headline.new(@conn, @user_id)
     end
   end
 end

data/lib/bloomy/configuration.rb

@@ -11,11 +11,11 @@ module Bloomy
 
     # Initializes a new Configuration instance
     #
-    # @param [String, nil] optional_parameter Pass an optional API key
+    # @param [String, nil] api_key Pass an optional API key
     # @example
     #   config = Bloomy::Configuration.new(api_key)
     def initialize(api_key = nil)
-      @api_key = api_key || ENV["API_KEY"] || load_api_key
+      @api_key = api_key || ENV["BG_API_KEY"] || load_api_key
     end
 
     # Configures the API key using the provided username and password

data/lib/bloomy/operations/headlines.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+class Headline
+  # 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)
+    @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 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
+
+    {
+      id: response.body["Id"],
+      title: response.body["Title"],
+      owner_id: response.body["OwnerId"],
+      notes: response.body["Notes"]
+    }
+  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
+
+  # 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
+
+    {
+      id: response.body["Id"],
+      title: response.body["Name"],
+      meeting_details: {
+        id: response.body["OriginId"],
+        name: 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
+
+  # Get user headlines
+  #
+  # @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
+    response.body.map do |headline|
+      {
+        id: headline["Id"],
+        title: headline["Name"],
+        meeting_details: {
+          id: headline["OriginId"],
+          name: headline["Origin"]
+        },
+        owner_details: {
+          id: headline["Owner"]["Id"],
+          name: headline["Owner"]["Name"]
+        },
+        archived: headline["Archived"],
+        created_at: headline["CreateTime"],
+        closed_at: headline["CloseTime"]
+      }
+    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(meeting_id, headline_id)
+    response = @conn.delete("/api/v1/L10/#{meeting_id}/headlines/#{headline_id}")
+
+    # Raise an issue if response.status != 200
+    raise "Failed to delete headline" unless response.status == 200
+    true
+  end
+end

data/lib/bloomy/operations/issues.rb

@@ -74,17 +74,21 @@ class Issue
 
   # Creates a new issue
   #
-  # @param issue_title [String] the title of the new issue
+  # @param title [String] the title of the new issue
   # @param meeting_id [Integer] the ID of the meeting associated with the issue
   # @return [Hash] a hash containing the new issue's ID and title
   # @example
   #   issue.create("New Issue", 456)
   #   #=> { id: 789, title: "New Issue" }
-  def create(issue_title, meeting_id)
-    response = @conn.post("issues/create", {title: issue_title, meetingid: meeting_id}.to_json)
+  def create(meeting_id:, title:, user_id: @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"],
-      title: response.body["Name"]
+      meeting_id: response.body["OriginId"],
+      meeting_title: response.body["Origin"],
+      title: response.body["Name"],
+      user_id: response.body["Owner"]["Id"],
+      details_url: response.body["DetailsUrl"]
     }
   end
 end

data/lib/bloomy/operations/scorecard.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "json"
+
+# 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
+  # 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)
+    @conn = conn
+    @user_id = user_id
+  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 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)
+  def list(user_id: nil, meeting_id: nil, show_empty: false, week_offset: 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("scorecard/meeting/#{meeting_id}").body
+    else
+      user_id ||= @user_id
+      response = @conn.get("scorecard/user/#{user_id}").body
+    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"],
+        updated_at: scorecard["DateEntered"]
+      }
+    end
+
+    if week_offset
+      week_data = current_week
+      week_id = week_data[:week_number] - week_offset
+      scorecards.select! { |scorecard| scorecard[:week] == 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 negative 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?
+  end
+end

data/lib/bloomy/operations/todos.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "date"
+
 # Class to handle all the operations related to todos
 class Todo
   # Initializes a new Todo instance
@@ -67,4 +69,31 @@ class Todo
     response = @conn.post("/api/v1/todo/#{todo_id}/complete?status=true")
     {status: response.status}
   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
+
+    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
+
+    {
+      id: todo_id,
+      title: title,
+      due_date: due_date,
+      updated_at: DateTime.now.to_s
+    }
+  end
 end

data/lib/bloomy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bloomy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Franccesco Orozco
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -57,17 +57,18 @@ files:
 - lib/bloomy.rb
 - lib/bloomy/client.rb
 - lib/bloomy/configuration.rb
+- lib/bloomy/operations/headlines.rb
 - lib/bloomy/operations/issues.rb
-- lib/bloomy/operations/measurables.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
 - lib/bloomy/version.rb
 - sig/bloomy.rbs
 homepage: https://github.com/franccesco/bloomy
 licenses:
-- MIT
+- Apache-2.0
 metadata:
   homepage_uri: https://github.com/franccesco/bloomy
   rubygems_mfa_required: 'true'
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Manage your Bloom Growth account from the command line.

data/lib/bloomy/operations/measurables.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-# Class to handle all the operations related to measurables
-# @note
-#   This class is already initialized via the client and usable as `client.measurable.method`
-class Measurable
-  # Initializes a new Measurable 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
-
-  # Retrieves the current week details
-  #
-  # @return [Hash] a hash containing current week details
-  # @example
-  #   client.measurable.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 scorecard for the user
-  #
-  # @param current_week_only [Boolean] whether to include only the current week's scores (default: true)
-  # @param show_empty [Boolean] whether to include scores with nil values (default: true)
-  # @return [Array<Hash>] an array of hashes containing scorecard details
-  # @example
-  #   client.measurable.scorecard
-  #   #=> [{ id: 123, title: "Sales", target: 100, value: 80, updated_at: "2024-06-12", week_number: 24 }, ...]
-  def scorecard(current_week_only: true, show_empty: true)
-    response = @conn.get("scorecard/user/mine").body
-    scorecards = response["Scores"].map do |scorecard|
-      {
-        id: scorecard["Id"],
-        title: scorecard["MeasurableName"],
-        target: scorecard["Target"],
-        value: scorecard["Measured"],
-        updated_at: scorecard["DateEntered"],
-        week_number: scorecard["ForWeek"]
-      }
-    end
-
-    if current_week_only
-      week_id = current_week[:week_number]
-      scorecards.select do |scorecard|
-        scorecard[:week_number] == week_id && (show_empty || scorecard[:value].nil?)
-      end
-    else
-      scorecards.select { |scorecard| show_empty || scorecard[:value].nil? }
-    end
-  end
-
-  # Updates a scorecard with a new measured value
-  #
-  # @param scorecard_id [Integer] the ID of the scorecard to update
-  # @param measured [Numeric] the new measured value
-  # @return [Boolean] true if the operation was successful, false otherwise
-  # @example
-  #   client.measurable.update(1, 85)
-  #   #=> true
-  def update(scorecard_id, measured)
-    response = @conn.put("scores/#{scorecard_id}", {value: measured}.to_json).status
-    response == 200
-  end
-end