RaptorSheets.Gig 1.1.2

RaptorSheets

Badge Name	Status	Site
Latest Build Status		GitHub Repo
RaptorSheets.Gig NuGet		Raptor Sheets - Gig
RaptorSheets.Stock NuGet		-
Test Coverage		SonarCloud
Code Quality		SonarCloud
License		-

🚀 Quick Start

# Install the package for your use case
dotnet add package RaptorSheets.Gig      # For gig work tracking
dotnet add package RaptorSheets.Stock    # For stock portfolio management
# dotnet add package RaptorSheets.Core   # Core library (coming soon)

using RaptorSheets.Gig.Managers;

// Initialize with credentials
var manager = new GoogleSheetManager(accessToken, spreadsheetId);

// Create sheets with predefined layouts
await manager.CreateSheets();

// Retrieve all data
var data = await manager.GetSheets();

📚 Project Description

RaptorSheets is a comprehensive .NET 8 library suite that simplifies interactions between custom API services and the Google Sheets API. Built for developers who need powerful spreadsheet integration without the complexity, featuring extensive test coverage and production-ready reliability.

✨ Key Features

• 📋 Header Management: Extension methods for column and index assignments with automatic processing
• 🎨 Column Formatting: Apply data formatting, configure drop-downs, and set cell protection
• 🎯 Sheet Styling: Alternating row colors, full sheet protection, and custom tab colors
• ⚡ Batch Operations: Efficient bulk operations for large datasets with automatic batching
• 🔒 Type Safety: Strongly typed entities and enums for all operations
• ✅ Auto Validation: Automatic header validation with detailed error reporting
• 🛠️ Error Handling: Comprehensive message system for operation feedback
• 🧪 Well Tested: Extensive unit and integration test coverage

🏗️ Architecture

Your Application
       ↓
Package-Specific Manager (Gig, Stock, etc.)
       ↓
RaptorSheets.Core (GoogleSheetService)
       ↓
SheetServiceWrapper (API abstraction)
       ↓
Google Sheets API v4

💼 Use Cases

• Gig Work Tracking: Track trips, shifts, expenses, and earnings across platforms
• Stock Portfolio: Manage accounts, tickers, and performance data
• Business Operations: Handle addresses, contacts, regions, and services
• Data Analytics: Generate daily, weekly, monthly, and yearly reports
• Custom Integrations: Build your own sheet types using the Core library

📖 Documentation

Choose the documentation that matches your needs:

📦 Available Packages

Package	Version	Purpose	Dependencies	Documentation
RaptorSheets.Gig		Gig work and freelance tracking	Google.Apis.Sheets.v4, Google.Apis.Drive.v3	💼 Gig Docs
RaptorSheets.Stock		Stock market data management	Google.Apis.Sheets.v4	📈 Stock Docs
RaptorSheets.Core	Coming Soon	Core functionality for custom implementations	Google.Apis.Sheets.v4	🔧 Core Docs
RaptorSheets.Common	-	Shared utilities (included in packages)	-	-

🔐 Authentication

RaptorSheets supports multiple authentication methods. Here's a quick example:

Service Account (Recommended)

var credentials = new Dictionary<string, string>
{
    ["type"] = "service_account",
    ["private_key_id"] = "your-key-id",
    ["private_key"] = "your-private-key", 
    ["client_email"] = "service@project.iam.gserviceaccount.com",
    ["client_id"] = "your-client-id"
};

var manager = new GoogleSheetManager(credentials, spreadsheetId);

?? Complete Authentication Guide

?? Usage Examples

Gig Work Tracking

using RaptorSheets.Gig.Managers;
using RaptorSheets.Gig.Entities;

var manager = new GoogleSheetManager(credentials, spreadsheetId);

// Record a trip
var trip = new TripEntity
{
    Date = "2024-01-15",
    Service = "DoorDash",
    Pay = 8.50m,
    Tip = 3.00m,
    Distance = 2.5m
};

var result = await manager.ChangeSheetData(["Trips"], new SheetEntity { Trips = [trip] });

Stock Portfolio Management

using RaptorSheets.Stock.Managers;
using RaptorSheets.Stock.Entities;

var manager = new GoogleSheetManager(credentials, spreadsheetId);

// Record a stock transaction
var account = new AccountEntity
{
    Account = "Brokerage-401k",
    Stocks = 10,
    Shares = 100,
    AverageCost = 50.25m
};

var result = await manager.ChangeSheetData(["Accounts"], new SheetEntity { Accounts = [account] });

Custom Implementation (Using Core)

using RaptorSheets.Core.Services;
using RaptorSheets.Core.Models.Google;

var service = new GoogleSheetService(credentials, spreadsheetId);

// Create custom sheet structure
var sheetModel = new SheetModel
{
    Name = "CustomSheet",
    Headers = new List<SheetCellModel>
    {
        new() { Name = "ID", Format = FormatEnum.NUMBER },
        new() { Name = "Description", Format = FormatEnum.TEXT }
    }
};

// Generate and execute requests (see Core docs for details)

??? Development Setup

Prerequisites

• .NET 8.0 SDK or later
• Google Cloud Project with Sheets API enabled
• Service Account credentials (recommended) or OAuth2 setup

Quick Setup

git clone https://github.com/khanjal/RaptorSheets.git
cd RaptorSheets
dotnet restore
dotnet build
dotnet test

?? Complete Development Guide

?? Testing

The library includes comprehensive test coverage across all packages:

# Run all tests
dotnet test

# Run package-specific tests
dotnet test RaptorSheets.Core.Tests/
dotnet test RaptorSheets.Gig.Tests/
dotnet test RaptorSheets.Stock.Tests/

# Run with coverage
dotnet test --collect:"XPlat Code Coverage"

Test Coverage Areas:

• ? Core functionality and services
• ? Package-specific implementations
• ? Authentication methods
• ? Error handling and validation
• ? Extension methods and utilities
• ? Real Google Sheets API integration

?? Performance & API Limits

Google Sheets API Quotas

• Read/Write requests: 100 requests per 100 seconds per user
• Daily requests: 50,000 requests per day

Library Optimizations

• ? Automatic request batching
• ? Efficient data retrieval strategies
• ? Smart caching mechanisms
• ? Rate limit handling with retries

?? Contributing

We welcome contributions to any package in the RaptorSheets suite!

Development Workflow

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Choose your focus area:
   • Core Library: Enhance base functionality
   • Gig Package: Add gig work features
   • Stock Package: Improve portfolio management
   • New Package: Create a new domain-specific package
4. Write comprehensive tests
5. Update relevant documentation
6. Ensure all tests pass (dotnet test)
7. Submit a Pull Request

Code Standards

• Follow existing patterns within each package
• Maintain backward compatibility for Core library
• Add package-specific tests for new features
• Update package-specific documentation
• Use appropriate XML documentation

?? License

This project is licensed under the MIT License - see the LICENSE file for details.

?? Support & Resources

Documentation

• ?? Complete Guide - Overview and getting started
• ?? Core Library - Core functionality reference
• ?? Gig Package - Gig work tracking guide
• ?? Stock Package - Portfolio management guide
• ?? Authentication - Setup instructions

Community & Support

• ?? Report Issues - Bug reports and feature requests
• ?? Discussions - Community support and questions
• ?? Google Sheets API Reference - Official API documentation
• ?? Project Homepage - Additional resources and examples

?? Roadmap

Core Library

• ?? Independent NuGet package release
• ?? Enhanced authentication flows
• ?? Plugin architecture for custom packages

Package Ecosystem

• ?? Advanced analytics across all packages
• ?? Multi-language localization support
• ?? Mobile-optimized implementations
• ?? Enterprise features and compliance

New Packages

• ?? Business expense tracking
• ?? Project management and time tracking
• ?? Real estate portfolio management
• ?? Inventory management systems

Made with ?? by Iron Raptor Digital

API Documentation

For details on the underlying Google Sheets API concepts used in this project, see the official documentation:

• Google Sheets API Concepts Guide