bloomy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 783fa82ea83467cc8e6d012305831a5bfb73f43897c50b8f80a96276778004f5
-  data.tar.gz: 0e2f5b69910a85d9866d2715921ee5b27f569c466aaac16f5a4343db3bc71ca7
+  metadata.gz: b0d0f6f6172769244a6783a916bebd1543662f84f6e53af17437c2f09484f1cf
+  data.tar.gz: 7ad965fcfbcac1501e16c2431a2e91c88f16f5854ea3b3be9eebdaf2ec222baf
 SHA512:
-  metadata.gz: 42f086d17f1b29d61060629a6630a7f8380cf54cb4d993425dd44f0d859765bfbf400d3f6a42df1ec5d6f910c8a45904fd91875005aa76aff9498e50112a6f1b
-  data.tar.gz: b9ac85ecf2dc0114b1cdf92d71def98927233b103b260970f52797a728b0dd8077db04eabc68aba72c0c77df9091c327d8a2151efe2f95767139dd440975a4d1
+  metadata.gz: 37ef8b9fb6ee8bb2f13e8ba0481a0b4ea40d1c24fe944df8dae8dbbcf37c8734f7d05c2a3267699466e2a8955e4f0424fe73ba80e1e3e25ca3b9848e6aae045d
+  data.tar.gz: bb9965e3a7701ba7d0fd3ec5566f1e516e172cde06d6d7fe65c294e4f6be5da88fde0cedba512f5ec93cc95d8cf9289fbc15cc94e004999ec1c9361d7a7e6de6

data/README.md

@@ -1,6 +1,7 @@
 # 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)
 
-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.
+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
 
@@ -36,20 +37,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

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

@@ -21,15 +21,16 @@ 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

data/lib/bloomy/configuration.rb

@@ -15,7 +15,7 @@ module Bloomy
     # @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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bloomy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Franccesco Orozco
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -67,7 +67,7 @@ files:
 - 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'