Merge branch 'main' into web_socket

Author: ashitaprasad

CONTRIBUTING.md

@@ -11,12 +11,18 @@ You can contribute to the project in any or all of the following ways:
 - Add documentation
 - Add a new feature, resolve an existing issue or add a new test to the project. (Goto [Code Contribution Guidelines](#code-contribution-guidelines)).
 
-### I have not contributed to any open source project before. Will I get any guidance?
+## Resources for New Contributors
 
-In case you are new to the open source ecosystem, we would be more than happy to guide you through the entire process. Just join our [Discord server](https://bit.ly/heyfoss) and drop a message in the **#foss** channel.
+- API Dash Code Walkthrough - [Video](https://www.youtube.com/live/rIlwCTKNz-A?si=iMxTxzkpY_ySo4Ow&t=339)
+- Getting Started with Flutter - [Video](https://www.youtube.com/watch?v=8K2gV1P6ZHI)
+- API Dash Developer Guide - [Read](https://github.com/foss42/apidash/blob/main/doc/dev_guide/README.md)
 
 ## Code Contribution Guidelines
 
+### I have not contributed to any open source project before. Will I get any guidance?
+
+In case you are new to the open source ecosystem, we would be more than happy to guide you through the entire process. Just join our [Discord server](https://bit.ly/heyfoss) and drop a message in the **#foss** channel.
+
 ### Some things to keep in mind before opening a PR
 
 > PRs with precise changes (like adding a new test, resolving a bug/issue, adding a new feature) are always preferred over a single PR with a ton of file changes as they are easier to review and merge.

README.md

@@ -254,10 +254,15 @@ Just click on the [Issue tab](https://github.com/foss42/apidash/issues) to raise
 
 Please find the Roadmap for API Dash [here](https://github.com/foss42/apidash/blob/main/ROADMAP.md).
 
-## Documentation
+## Documentation (User Guide & Developer Guide)
 
 All docs are currently available in the [doc](https://github.com/foss42/apidash/blob/main/doc/) folder.
 
+## Resources for New Contributors
+
+- Developer Guide - [Read](https://github.com/foss42/apidash/blob/main/doc/dev_guide/README.md)
+- Code Walkthrough - [Video](https://www.youtube.com/live/rIlwCTKNz-A?si=iMxTxzkpY_ySo4Ow&t=339)
+
 ## Contribute to API Dash
 
 You can contribute to API Dash in any or all of the following ways:

doc/dev_guide/README.md

@@ -8,3 +8,7 @@
 6. [Packaging API Dash](https://github.com/foss42/apidash/blob/main/doc/dev_guide/packaging.md)
 7. Other Topics
     - [Flutter Rust Bridge Experiment for Parsing Hurl](https://github.com/foss42/apidash/blob/main/doc/dev_guide/flutter_rust_bridge_experiment.md)
+
+## Code Walkthrough for New Contributors
+
+[Video](https://www.youtube.com/live/rIlwCTKNz-A?t=339)

doc/dev_guide/images/choco_chocolateyinstall_ps1.png

@@ -1,5 +1,14 @@
 # Packaging API Dash
 
+- [Windows](#windows)
+- [macOS](#macos)
+- [Linux Debian (.deb) & RPM (.rpm)](#linux-debian-deb--rpm-rpm)
+- [Arch Linux (PKGBUILD)](#arch-linux-pkgbuild)
+- [FlatHub (Flatpak)](#flathub-flatpak)
+- [Homebrew](#homebrew)
+- [Chocolatey](#chocolatey)
+- [WinGet](#winget)
+
 ## Windows
 
 [Packaging and Distributing Flutter Desktop Apps : Creating Windows .exe installer](https://medium.com/@fluttergems/packaging-and-distributing-flutter-desktop-apps-the-missing-guide-for-open-source-indie-0b468d5e9e70)
@@ -22,11 +31,172 @@ TODO Instructions
 
 ## Homebrew
 
-TODO Instructions
+Homebrew Formula Submission
+
+### 1. Prepare Tap Repository
+
+```
+# Create Homebrew tap
+gh repo create homebrew-tap --public --clone
+mkdir -p homebrew-tap/Formula
+cd homebrew-tap
+```
+
+### 2. Package apidash
+
+```
+# Build macOS bundle
+flutter build macos
+
+# Create versioned tarball
+tar -czvf apidash-v1.0.0.tar.gz \
+  -C build/macos/Build/Products/Release/ \
+  Apidash.app
+
+# Generate SHA256 checksum
+shasum -a 256 apidash-v1.0.0.tar.gz
+```
+
+### 3. Create Formula File
+
+`Formula/apidash.rb`:
+
+```
+class Apidash < Formula
+  desc "Modern API dashboard for developers"
+  homepage "https://apidash.dev"
+  url "https://github.com/<user>/<repo>/releases/download/v1.0.0/apidash-v1.0.0.tar.gz"
+  sha256 "PASTE_YOUR_SHA256_HERE"
+
+  def install
+    prefix.install "Apidash.app"
+    bin.write_exec_script prefix/"Apidash.app/Contents/MacOS/Apidash"
+  end
+
+  test do
+    system "#{bin}/Apidash", "--version"
+  end
+end
+```
+
+### 4. Local Validation
+
+```
+# Check formula syntax
+brew audit --strict Formula/apidash.rb
+
+# Test installation
+brew install --build-from-source Formula/apidash.rb
+
+# Verify execution
+brew test apidash
+```
+
+### 5. Custom Tap Submission
+
+```
+# Commit formula to your tap repo
+git add Formula/Apidash.rb
+git commit -m "added apidash formula"
+git push
+
+# Create release for tarball
+gh release create v1.0.0 apidash-v1.0.0.tar.gz
+```
+
+### 6. Installation
+
+```
+brew tap homebrew-tap/Formula
+brew install apidash
+```
 
 ## Chocolatey
 
-TODO Instructions
+### Step 1: Setup Skeleton
+
+First step towards making a choco package is initializing a base.
+
+The command `choco new -h` can teach you more about the `new` command, its usage, options, switches, and exit codes.
+
+Run the following command to setup the base
+
+```powershell
+choco new --name="apidash" --version="0.3.0" maintainername="foss42" maintainerrepo="https://github.com/foss42/apidash" --built-in-template
+```
+
+![choco folder structure](images/choco_create_structure.png)
+
+This creates the following folder structure
+
+```
+apidash
+├── ReadMe.md
+├── _TODO.txt
+├── apidash.nuspec
+└── tools
+    ├── chocolateybeforemodify.ps1
+    ├── chocolateyinstall.ps1
+    ├── chocolateyuninstall.ps1
+    ├── LICENSE.txt
+    └── VERIFICATION.txt
+```
+
+The files `ReadMe.md` and `_TODO.md` can be deleted before pushing.
+
+The files of our main interest are `chocolateyinstall.ps1` and `apidash.nuspec`.
+
+### Step 2: Editing `chocolateyinstall.ps1`
+
+Take a look at `chocolateyinstall.ps1` file. There are many comments stating the use case of each line itself.
+![chocolatelyinstall.ps1](images/choco_chocolateyinstall_ps1.png)
+
+Comments can bre remoed using the following command.
+```powershell
+$f='apidash\tools\chocolateyinstall.ps1'
+gc $f | ? {$_ -notmatch "^\s*#"} | % {$_ -replace '(^.*?)\s*? [^``]#.*','$1'} | Out-File $f+".~" -en utf8; mv -fo $f+".~" $f
+```
+
+Now our `chocolateyinstall.ps1` file is ready.
+
+### Step 3: Editing `apidash.nuspec`
+
+![final apidash.nuspec](images/choco_nuspec.png)
+
+### Step 4: Build the package
+
+All our files are ready, we just need to pack out files in a choco package with the extension `.nupkg`.
+
+Run the following command from the root of your directory:
+```powershell
+choco pack 
+```
+This command generates the `apidash.0.3.0.nupkg` file.
+
+### Step 5: Test the Package Locally
+
+Install the package locally using Chocolatey:
+```powershell
+choco install apidash -s .
+```
+Ensure the application installs correctly.
+
+![Shell output](images/choco_shell_output.png)
+
+### Step 6: Pre-Publishing - Update `LICENSE.txt` & `VERIFICATION.txt`
+
+Update `LICENSE.txt` with the actual **LICENSE **and `VERIFICATION.txt` accordingly.
+
+### Step 7: Publish the Package (Optional)
+
+To share the package, you can push it to a Chocolatey repository. For the official Chocolatey Community Repository, follow these steps:
+
+1. Create an account on the Chocolatey Community.
+2. Get an API key by navigating to your profile.
+3. Use the following command to push your package:
+```powershell
+choco push apidash.0.3.0.nupkg --source="https://push.chocolatey.org/" --api-key="YOUR_API_KEY"
+```
 
 ## WinGet
 

doc/dev_guide/images/choco_create_structure.png

@@ -434,6 +434,7 @@ const kLabelSend = "Send";
 const kLabelSending = "Sending..";
 const kLabelBusy = "Busy";
 const kLabelCopy = "Copy";
+const kLabelShare = "Share";
 const kLabelSave = "Save";
 const kLabelDownload = "Download";
 const kLabelSaving = "Saving";
@@ -490,3 +491,10 @@ const kMsgNoContent = "No content";
 const kMsgUnknowContentType = "Unknown Response Content-Type";
 // Workspace Selector
 const kMsgSelectWorkspace = "Create your workspace";
+// History Page
+const kTitleClearHistory = 'Clear History';
+const kMsgClearHistory =
+    'Clearing History is permanent. Do you want to continue?';
+const kMsgClearHistorySuccess = 'History cleared successfully';
+const kMsgClearHistoryError = 'Error clearing history';
+const kMsgShareError = "Unable to share";

doc/dev_guide/images/choco_nuspec.png

@@ -25,15 +25,14 @@ final requestSequenceProvider = StateProvider<List<String>>((ref) {
   return ids ?? [];
 });
 
-final httpClientManager = HttpClientManager();
+
 final WebSocketManager webSocketManager = WebSocketManager();
 
 final StateNotifierProvider<CollectionStateNotifier, Map<String, RequestModel>?>
     collectionStateNotifierProvider =
     StateNotifierProvider((ref) => CollectionStateNotifier(
           ref,
           hiveHandler,
-          httpClientManager,
           webSocketManager
   ));
 
@@ -42,7 +41,6 @@ class CollectionStateNotifier
   CollectionStateNotifier(
     this.ref,
     this.hiveHandler,
-    this.httpClientManager,
     this.webSocketManager
   ) : super(null) {
     var status = loadData();
@@ -60,10 +58,8 @@ class CollectionStateNotifier
   final Ref ref;
   final HiveHandler hiveHandler;
   final baseHttpResponseModel = const HttpResponseModel();
-  final HttpClientManager httpClientManager;
   final WebSocketManager webSocketManager;
 
-
   bool hasId(String id) => state?.keys.contains(id) ?? false;
 
   RequestModel? getRequestModel(String id) {
@@ -123,6 +119,7 @@ class CollectionStateNotifier
     final rId = id ?? ref.read(selectedIdStateProvider);
     var itemIds = ref.read(requestSequenceProvider);
     int idx = itemIds.indexOf(rId!);
+    cancelHttpRequest(rId);
     itemIds.remove(rId);
     ref.read(requestSequenceProvider.notifier).state = [...itemIds];
 
@@ -327,7 +324,7 @@ class CollectionStateNotifier
     state = map;
 
     bool noSSL = ref.read(settingsProvider).isSSLDisabled;
-    (HttpResponse?, Duration?, String?)? responseRec = await request(
+    var responseRec = await sendHttpRequest(
       requestId,
       apiType,
       substitutedHttpRequestModel,
@@ -385,7 +382,7 @@ class CollectionStateNotifier
 
   void cancelRequest() {
     final id = ref.read(selectedIdStateProvider);
-    httpClientManager.cancelRequest(id);
+    cancelHttpRequest(id);
     unsave();
   }