bloomy 0.5.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5967a74a2cb5758a74e4877ab46a57eeba59f85a023039c1252d47087007bfd7
-  data.tar.gz: 6ded65188a434b4a3fa47cb9007b5c1e10e97b88266c6442e4e74684b7f7f552
+  metadata.gz: 4a147716e1b8f4ccad09501b59a7bc2ad58b38995f1aaeb4ef6f951707c35a10
+  data.tar.gz: 6aed3b2ecf2622a802aa3e010308675175e1f5376b375208893e19483476d879
 SHA512:
-  metadata.gz: d5eaeb394ba3edbd99e433ab9760f510a9a0e219c5b0de8cf2fe3ef0cac7a03a12fbf3325515e3485629186d600724e7e8001d32070baf400a23b9453fd64476
-  data.tar.gz: 9298429c7361153eb4f58e35604defb752362add6f43bb253413c21abe11e2ae4f6d4997c03df337e2f12dcc8097685333ab68c7f0b12656b8f3594804f773fa
+  metadata.gz: b94e517996379058516393a91851d4ff6c7a3fc3cd2d6612dbe78bf9a183ce1372fac6b2ddadc63d9b296c878ba787e74e4359441b01b2c450cd985f4160ac5b
+  data.tar.gz: 86b457f7ae1b198f8acd350e272e23a5a180875bd82da202ea246a93b03750083dde02a7ac29a18f24abd00527dd60081c782dfe73465884ad9926b4288ba969

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,96 @@
+# Contributing to Bloomy
+
+Thank you for your interest in contributing to Bloomy! This document outlines the guidelines for contributing to the project.
+
+## Did you find a bug?
+
+- Before creating an issue, please ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/franccesco/bloomy/issues)
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/franccesco/bloomy/issues/new). Be sure to include a title and clear description, as much relevant information as possible. A code sample or a screenshot would be helpful.
+- You can also write issues if you want to discuss a feature request or a general question about the project.
+
+## Do you want to contribute to the Bloomy project?
+
+PR's are welcome! Just make sure you have discussed the changes you want to make with the project maintainer before you start working on them. Before getting started, make sure you are not submitting a PR that's purely cosmetic (linting changes, whitespace, etc.)
+
+If you want to contribute to the project, please follow these steps:
+
+### Development Setup
+
+1. Fork and clone the repository:
+
+```sh
+git clone https://github.com/your-username/bloomy.git
+```
+
+2. Install the dependencies:
+
+```sh
+bundle install
+```
+
+3. Set up pre-commit hooks:
+
+```sh
+pre-commit install
+```
+
+4. Add your Bloom Growth username and password to an `.env` file. I use [direnv](https://direnv.net/) to manage my environment variables.
+
+```sh
+export USERNAME=your_username
+export PASSWORD=your_password
+```
+
+5. Run the tests:
+
+```sh
+bundle exec rspec
+```
+
+### Making Changes
+
+Once everything is green, you can start making changes. Make sure to write tests for your changes and run the tests before submitting a PR.
+
+As for coding style guidelines make sure you:
+
+- Follow the Ruby Style Guide enforced by [StandardRB](https://github.com/standardrb/standard)
+- Use [YARD](https://yardoc.org) documentation for classes and methods
+- Include `@examples` in method documentation
+
+### Pull Request Process
+
+1. Make sure your PR is up-to-date with the `main` branch.
+2. Make sure your PR passes the CI checks.
+3. Make sure your PR has a clear title and description.
+4. Update the version according to [Semantic Versioning](https://semver.org/).
+5. Optionally, use [Conventional Commits](https://www.conventionalcommits.org/) for your commit messages.
+
+Make sure to follow these guidelines to ensure your PR is accepted and merged quickly. Rinse and repeat! 🚀
+
+## Comments on Test Structure
+
+When developing new features, make sure to add a test. Tests will usually have the following basic structure:
+
+```ruby
+RSpec.describe "Feature" do
+
+  # Your setup and teardown code here
+  before(:all) do
+    @client = Bloomy::Client.new
+    @meeting = @client.meeting.create("Meeting Name")
+  end
+
+  after(:all) do
+    @client.meeting.delete(@meeting[:meeting_id])
+  end
+
+  # Your tests here
+  context "when using the feature" do
+    it "performs the expected action" do
+      # Test implementation
+    end
+  end
+end
+```
+
+In the `before(:all)` block, you can set up any necessary objects or variables that will be used in the tests. For example, creating a meeting object that will be used in the tests which will be deleted in the `after(:all)` block.

data/README.md

@@ -2,13 +2,13 @@
 
 [![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.
+Bloomy is an **_unofficial_** 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
+```sh
 bundle add bloomy
 ```
 
@@ -88,19 +88,19 @@ To interact with todo-related features:
 todos = client.todo.list
 
 # Create a new todo
-new_todo = client.todo.create(title: "New Task", meeting_id: 1, due_date: "2024-06-15")
+new_todo = client.todo.create(meeting_id: 1, title: "New Task", due_date: "2024-06-15")
 ```
 
-### Rock Management
+### Goal Management
 
-To interact with rock-related features:
+To interact with goal-related features:
 
 ```ruby
-# List all rocks for the current user
-rocks = client.rock.list
+# List all goals for the current user
+goals = client.goal.list
 
-# Create a new rock
-new_rock = client.rock.create(title: "New Rock", meeting_id: 1)
+# Create a new goal
+new_goal = client.goal.create(meeting_id: 1, title: "New Goal")
 ```
 
 ### Scorecard Management
@@ -124,5 +124,5 @@ To interact with issue-related features:
 issue_details = client.issue.details(issue_id)
 
 # Create a new issue
-new_issue = client.issue.create("New Issue", meeting_id)
+new_issue = client.issue.create(meeting_id: 1, title: "New Issue")
 ```

data/lib/bloomy/operations/goals.rb

@@ -47,7 +47,7 @@ class Goal
   #   #=> { goal_id: 1, title: "New Goal", meeting_id: 1, ... }
   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
+    response = @conn.post("L10/#{meeting_id}/rocks", payload).body
     {
       goal_id: response["Id"],
       title: title,
@@ -67,7 +67,7 @@ class Goal
   #   client.goal.delete(1)
   #   #=> { status: 200 }
   def delete(goal_id)
-    response = @conn.delete("/api/v1/rocks/#{goal_id}")
+    response = @conn.delete("rocks/#{goal_id}")
     response.success?
   end
 
@@ -76,13 +76,45 @@ class 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
+  # @param status [String, nil] the status value ('on', 'off', or 'complete')
+  # @return [Boolean] true if the update was successful
+  # @raise [ArgumentError] if an invalid status value is provided
   # @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)
+  #   client.goal.update(goal_id: 1, title: "Updated Goal", status: 'on')
+  #   #=> true
+  def update(goal_id:, title:, accountable_user: user_id, status: nil)
+    if status
+      valid_status = {on: "OnTrack", off: "AtRisk", complete: "Complete"}
+      status_key = status.downcase.to_sym
+      unless valid_status.key?(status_key)
+        raise ArgumentError, "Invalid status value. Must be 'on', 'off', or 'complete'."
+      end
+      status = valid_status[status_key]
+    end
+    payload = {title: title, accountableUserId: accountable_user, completion: status}.to_json
+    response = @conn.put("rocks/#{goal_id}", payload)
+    response.success?
+  end
+
+  # Archives a rock with the specified goal ID.
+  #
+  # @param goal_id [Integer] The ID of the goal/rock to archive
+  # @return [Boolean] Returns true if the archival was successful, false otherwise
+  # @example
+  #  goals.archive(123) #=> true
+  def archive(goal_id)
+    response = @conn.put("rocks/#{goal_id}/archive")
+    response.success?
+  end
+
+  # Restores a previously archived goal identified by the provided goal ID.
+  #
+  # @param [String, Integer] goal_id The unique identifier of the goal to restore
+  # @return [Boolean] true if the restore operation was successful, false otherwise
+  # @example Restoring a goal
+  #   goals.restore("123") #=> true
+  def restore(goal_id)
+    response = @conn.put("rocks/#{goal_id}/restore")
     response.success?
   end
 

data/lib/bloomy/operations/headlines.rb

@@ -18,14 +18,14 @@ class Headline
   # @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
 
     {
       id: response.body["Id"],
-      title: response.body["Title"],
+      title: response.body["Name"],
       owner_id: response.body["OwnerId"],
       notes_url: response.body["DetailsUrl"]
     }
@@ -36,7 +36,7 @@ class 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)
+  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
@@ -114,8 +114,8 @@ class 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}")
+  def delete(headline_id)
+    response = @conn.delete("/api/v1/headline/#{headline_id}")
     response.success?
   end
 end

data/lib/bloomy/operations/issues.rb

@@ -78,14 +78,14 @@ class Issue
     end
   end
 
-  # Marks an issue as complete
+  # Marks an issue as solved
   #
   # @param issue_id [Integer] the ID of the issue
   # @return [Boolean] true if the operation was successful, false otherwise
   # @example
-  #   issue.complete(123)
+  #   issue.solve(123)
   #   #=> true
-  def complete(issue_id)
+  def solve(issue_id)
     response = @conn.post("issues/#{issue_id}/complete", {complete: true}.to_json)
     response.success?
   end

data/lib/bloomy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bloomy
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Franccesco Orozco
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -49,6 +49,8 @@ files:
 - ".pre-commit-config.yaml"
 - ".rspec"
 - ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE
 - README.md
 - Rakefile
@@ -88,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Manage your Bloom Growth account from the command line.