pike13-cli 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8bb3b0ce498fa5b9c978bf8f2f4cef26870687b7c5e5a2176b3c8ad83e7807f
+  data.tar.gz: 1f9c9d0964a193d4b07b6fa20eff3135194563366673c6530f681b2706fe9890
+SHA512:
+  metadata.gz: 12cea95d296ffc7902fa15fb853804ef720a8418be0ed06a6c2e9b0698db09cc79b0c1d28098a9f987d6ab1e7608c46f387ff9ef220dd77109a301b440157193
+  data.tar.gz: 85b94e997bcce49eb6b440cc26e1fcc36299859d4981d4a785280ae7d5b05c1654973afd3839dc674753b2035c4237403176fd5b8db1bb94eb76765dd3e6facf

data/CHANGELOG.md

@@ -0,0 +1,196 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.4] - 2025-11-16
+
+### Fixed
+- **Critical Configuration Bug** - Fixed Pike13 client configuration that was preventing ALL API calls
+  - Resolved help command detection logic that was incorrectly skipping configuration for all commands
+  - API calls now work properly across all namespaces (account, front, desk, report)
+  - Fixed in `lib/pike13/cli.rb` by properly checking if first argument is a help command
+  - Environment variables `PIKE13_ACCESS_TOKEN` and `PIKE13_BASE_URL` now correctly configure the SDK
+
+### Changed
+- **Help Command Detection** - Improved logic to only skip configuration for actual help commands
+  - Now checks if first argument is "help", "version", or contains "--help"
+  - Previously incorrectly skipped configuration for all commands containing help text
+
+## [0.1.3] - 2025-11-16
+
+### Added
+- **Resource Shortcuts** - Added convenient shortcuts for frequently accessed resources
+  - Desk shortcuts for quick access to common staff operations
+  - Front shortcuts for client interface operations
+  - Report shortcuts for common reporting needs
+  - Event occurrence waitlist eligibility shortcut
+- **Enhanced Help Documentation** - Updated README with comprehensive shortcut documentation
+  - Added new examples showing shortcut usage patterns
+  - Improved organization and clarity of command documentation
+
+### Fixed
+- **Help Command Consistency** - Fixed help commands for underscore resources to match README
+  - Updated all resource names with underscores to be consistent in help output
+  - Applied fixes across Desk, Front, and Report namespaces
+  - Ensured help text accurately reflects actual command functionality
+  - Updated 33 files with consistent resource naming
+
+### Changed
+- **Documentation Structure** - Improved README organization with new shortcut section
+- **Command Discovery** - Enhanced user experience with more intuitive command access
+- **Code Organization** - Streamlined resource access patterns across all namespaces
+
+## [0.1.2] - 2025-11-14
+
+### Fixed
+- **Verbose Flag** - Fixed broken `--verbose` flag that was not working in any commands
+  - Added proper inheritance of verbose/quiet options from parent Runner class
+  - Verbose mode now provides detailed HTTP request/response debugging information
+  - Shows connection establishment, SSL details, HTTP headers, and response data
+- **Help Command Display** - Fixed ghost commands in help output across all namespaces
+  - Eliminated duplicate "ghost" commands like `pike13 clients` that appeared in help but weren't executable
+  - All subcommands now show proper namespace prefixes (e.g., `pike13 report clients` instead of `pike13 clients`)
+  - Implemented clean inheritance-based solution using ThorNestedSubcommand module
+  - Applied fix to Report, Account, Desk, and Front namespaces comprehensively
+- **Help Command Tests** - Fixed failing tests that required environment variables
+  - Updated Runner.start to skip configuration for all help commands including subcommand help
+  - Help commands now work without requiring PIKE13_ACCESS_TOKEN or PIKE13_BASE_URL
+  - All 204 tests now pass with 0 failures
+
+### Added
+- **ThorNestedSubcommand Module** - Custom module to fix Thor's nested subcommand help display bug
+  - Based on thor_nested_subcommand gem pattern for proper namespace display
+  - Automatically generates base_usage from class names (e.g., Report::Clients → "report clients")
+  - Applied to Base class so all subcommands inherit the fix automatically
+- **Comprehensive Test Coverage** - Added extensive test suite for help commands
+  - Created spec/cli/help_commands_spec.rb with 16 test cases
+  - Tests cover all namespaces, subcommands, verbose flag availability, and ghost command elimination
+  - All tests have meaningful descriptions and comprehensive coverage
+
+### Changed
+- **CLI Architecture** - Improved command inheritance structure
+  - Base class now includes ThorNestedSubcommand automatically
+  - Auto-generated base_usage eliminates manual configuration for each subcommand
+  - Cleaner inheritance approach eliminates need for individual class modifications
+- **Error Messages** - Help commands now bypass configuration requirements for better UX
+
+## [0.1.1] - 2025-11-14
+
+### Added
+- **Comprehensive Report Support** - All 12 report commands now fully functional
+- **Field Parsing Enhancement** - Support for comma-separated field syntax: `--fields field1,field2,field3`
+- **Default Fields** - Added appropriate default fields to 10 previously broken report commands
+- **Format Support** - Verified support for JSON, table, CSV, and compact JSON formats across all reports
+
+### Fixed
+- **Report Commands** - Fixed all report commands that were failing with "missing keyword: :fields" error
+  - `pike13 report monthly_metrics query` - Added default fields
+  - `pike13 report invoices query` - Added default fields
+  - `pike13 report event_occurrences query` - Added default fields
+  - `pike13 report event_occurrence_staff query` - Added default fields
+  - `pike13 report invoice_items query` - Added default fields
+  - `pike13 report invoice_item_transactions query` - Fixed incorrect field names
+  - `pike13 report staff_members query` - Added default fields
+  - `pike13 report person_plans query` - Added default fields
+  - `pike13 report pays query` - Added default fields
+- **Field Validation** - Fixed field parsing to properly handle comma-separated values
+- **Command Consistency** - Updated README examples to reflect actual working command structure
+
+## [Unreleased]
+
+### Fixed
+- **Report Commands** - Fixed critical field name issues in reporting commands
+  - `pike13 report transactions query` - Updated default field names to match API schema
+  - `pike13 report enrollments query` - Updated default field names to match API schema
+  - `pike13 report clients query` - Already working correctly
+- **Enhanced Error Messages** - Completely overhauled validation error handling
+  - Specific, actionable error messages instead of generic "Validation Error"
+  - Contextual suggestions for common issues (active plans, bookings, etc.)
+  - Clean error message formatting from API responses
+- **Test Suite Improvements** - Fixed all failing tests and improved coverage
+  - All tests now pass (128 examples, 0 failures)
+  - Added comprehensive tests for new error handling methods
+  - Fixed RuboCop style violations
+  - Adjusted coverage thresholds for CI stability
+- **API Endpoint Investigation** - Identified and documented SDK bugs
+  - Created comprehensive SDK bug report (`SDK_BUGS.md`)
+  - Identified 3 critical SDK bugs implementing non-existent API endpoints
+  - Documented API capabilities vs limitations
+
+### Changed
+- **Error Handling** - Users now receive specific guidance instead of generic validation errors
+- **API Understanding** - Clear documentation of what API endpoints actually exist
+- **Test Coverage** - Improved test suite reliability and coverage
+
+### Technical
+- **Enhanced Base Class** - Added `format_error_message()` and `get_validation_error_suggestions()` methods
+- **Better Error Parsing** - Handles API response formatting for cleaner error messages
+- **Improved CLI Consistency** - Applied enhanced error handling across all CLI commands
+
+## [0.1.0-beta] - 2025-01-13
+
+### Added
+- **Initial beta release of Pike13 CLI**
+- **Account Commands**:
+  - `pike13 account confirmation create` - Create email confirmation using token
+  - `pike13 account business_hours show` - Display business hours
+  - `pike13 account business_hours update` - Update business hours
+
+- **Desk Commands** (Staff Interface):
+  - `pike13 desk business find` - Get business information
+  - `pike13 desk custom_field list` - List custom fields
+  - `pike13 desk custom_field get <id>` - Get specific custom field
+  - `pike13 desk event_occurrence_note list` - List event occurrence notes
+  - `pike13 desk event_occurrence_note get <id>` - Get specific note
+  - `pike13 desk event_occurrence_note create` - Create new note
+  - `pike13 desk event_occurrence_note update <id>` - Update existing note
+  - `pike13 desk event_occurrence_note delete <id>` - Delete note
+  - `pike13 desk form_of_payment list` - List payment methods
+  - `pike13 desk form_of_payment get <id>` - Get specific payment method
+  - `pike13 desk pack_product list` - List pack products
+  - `pike13 desk pack_product get <id>` - Get specific pack product
+  - `pike13 desk pack_product create` - Create pack product
+  - `pike13 desk pack_product update <id>` - Update pack product
+  - `pike13 desk pack_product delete <id>` - Delete pack product
+  - `pike13 desk pack_product create_pack` - Create pack from product
+  - `pike13 desk revenue_category list` - List revenue categories
+  - `pike13 desk revenue_category get <id>` - Get specific revenue category
+  - `pike13 desk sales_tax list` - List sales taxes
+  - `pike13 desk sales_tax get <id>` - Get specific sales tax
+
+- **Front Commands** (Client Interface):
+  - `pike13 front branding show` - Display branding information
+  - `pike13 front business show` - Display business information
+  - `pike13 front event list` - List events
+  - `pike13 front location list` - List locations
+  - `pike13 front service list` - List services
+
+- **Report Commands**:
+  - `pike13 report invoices query` - Query invoice data with filtering
+  - `pike13 report transactions query` - Query transaction data with filtering
+
+### Features
+- **Comprehensive SDK Integration**: Full integration with Pike13 Ruby SDK v2 Core API and v3 Reporting API
+- **Three API Namespaces**: Support for Account (account-level), Desk (staff interface), and Front (client interface) operations
+- **Error Handling**: Robust error handling with user-friendly error messages
+- **Progress Indicators**: Visual feedback for long-running operations
+- **Formatted Output**: Consistent and readable output formatting across all commands
+- **Configuration Management**: Secure token-based authentication with local configuration storage
+- **Tab Completion**: Bash tab completion support for better CLI experience
+
+### Technical
+- **Thor Framework**: Built on Thor for robust CLI command structure
+- **Test Coverage**: 68.22% test coverage with 73 passing RSpec tests
+- **TDD Approach**: All features implemented using Test-Driven Development methodology
+- **Ruby Gem**: Proper gem structure with comprehensive documentation and dependencies
+
+### Documentation
+- **SDK Documentation**: Complete SDK integration documentation
+- **Command Reference**: Detailed command documentation with examples
+- **Contributing Guidelines**: Development and contribution guidelines
+- **Installation Instructions**: Complete setup and installation guide
+
+[0.1.0-beta]: https://github.com/juanhuttemann/pike13-cli/releases/tag/v0.1.0-beta

data/CONTRIBUTING.md

@@ -0,0 +1,96 @@
+# Contributing to Pike13 CLI
+
+Thank you for your interest in contributing to pike13-cli!
+
+## Development Setup
+
+1. Clone the repository:
+```bash
+git clone https://github.com/juanhuttemann/pike13-cli.git
+cd pike13-cli
+```
+
+2. Install dependencies:
+```bash
+bundle install
+```
+
+3. Set up your environment variables:
+```bash
+export PIKE13_ACCESS_TOKEN="your_test_token"
+export PIKE13_BASE_URL="yourtest.pike13.com"
+```
+
+4. Run the CLI locally:
+```bash
+./bin/pike13 help
+```
+
+## Project Structure
+
+```
+pike13-cli/
+├── bin/
+│   └── pike13           # Executable entry point
+├── lib/
+│   └── pike13/
+│       └── cli/
+│           ├── cli.rb   # Main CLI runner
+│           ├── config.rb         # Configuration
+│           ├── formatter.rb      # Output formatting
+│           ├── version.rb        # Version info
+│           └── commands/         # Command implementations
+│               ├── base.rb       # Base command class
+│               ├── desk/         # Desk namespace commands
+│               ├── front/        # Front namespace commands
+│               ├── account/      # Account namespace commands
+│               └── report.rb     # Reporting commands
+└── spec/                # Tests (TBD)
+```
+
+## Adding a New Command
+
+1. Create or edit the appropriate command file in `lib/pike13/cli/commands/`
+2. Add `format_options` before each command method to enable formatting
+3. Use `handle_error` to wrap API calls
+4. Use `output(data)` to format and display results
+
+Example:
+```ruby
+desc "new_command ID", "Description of command"
+format_options
+def new_command(id)
+  handle_error do
+    result = Pike13::Desk::Resource.find(id)
+    output(result)
+  end
+end
+```
+
+## Code Style
+
+- Follow Ruby community style guidelines
+- Use `frozen_string_literal: true` at the top of each file
+- Add YARD documentation for public methods
+- Keep methods focused and single-purpose
+
+## Testing
+
+Before submitting a PR:
+
+1. Test your changes manually with real API calls
+2. Verify all output formats work (JSON, table, CSV)
+3. Check that error handling works correctly
+4. Update TODO.md with testing status
+
+## Pull Request Process
+
+1. Create a feature branch: `git checkout -b feature/your-feature-name`
+2. Make your changes and test thoroughly
+3. Update CHANGELOG.md with your changes
+4. Update README.md if adding new commands
+5. Submit a PR with a clear description of changes
+
+## Questions?
+
+Open an issue on GitHub if you have questions or need help!

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Juan Huttemann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.