pike13-cli 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8bb3b0ce498fa5b9c978bf8f2f4cef26870687b7c5e5a2176b3c8ad83e7807f
-  data.tar.gz: 1f9c9d0964a193d4b07b6fa20eff3135194563366673c6530f681b2706fe9890
+  metadata.gz: 1fb670799c8613bf30e57bc2a27f67fa56688013c81040d2f99b0a831ec5b12e
+  data.tar.gz: 7723a7b7bc57df97147dc8ead89751d7913881e6a24282000df4ff69d56b1963
 SHA512:
-  metadata.gz: 12cea95d296ffc7902fa15fb853804ef720a8418be0ed06a6c2e9b0698db09cc79b0c1d28098a9f987d6ab1e7608c46f387ff9ef220dd77109a301b440157193
-  data.tar.gz: 85b94e997bcce49eb6b440cc26e1fcc36299859d4981d4a785280ae7d5b05c1654973afd3839dc674753b2035c4237403176fd5b8db1bb94eb76765dd3e6facf
+  metadata.gz: e02eefafc87f6fc027c13c162e5c8a76bf27a6688297ddaa5c70739174d9040535889aa2def7a65f6d860b2a5b09392640a4bb83896037c0505b217559c1c050
+  data.tar.gz: 15a52cd46b1aacd85c79bf925ce7f44e05c3a4e2b873ef8f9d970119fd3d4752b49bcb719d014cad83969c87d6c9b7ae99e0d3a77e35a3e48081db843b65a619

data/CHANGELOG.md

@@ -5,6 +5,95 @@ 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.2.1] - 2025-11-18
+
+### Fixed
+- **Help Command Display Issue** - Fixed help commands showing incorrect singular forms instead of intended plural forms
+  - `pike13 desk people --help` now shows `pike13 desk people create/list/get/delete/me/search/update` instead of `pike13 desk person create/list/get/delete/me/search/update`
+  - `pike13 desk staff --help` now shows `pike13 desk staff get/list/help/me` instead of `pike13 desk staffmember get/list/help/me`
+  - `pike13 front plan_products --help` now shows `pike13 front plan_products get/list/help` instead of `pike13 front planproduct get/list/help`
+  - `pike13 account people --help` now shows `pike13 account people help/list` instead of `pike13 account person help/list`
+  - Applied `base_usage` overrides to ensure help commands display correct plural naming
+
+## [0.2.0] - 2025-11-18
+
+### Added
+- **Comprehensive Parameter Support** - Added extensive filtering and query parameters to major endpoints
+- **Desk People List Parameters**:
+  - `--created_since` - Filter to people created since given timestamp (ISO 8601)
+  - `--updated_since` - Filter to people updated since given timestamp (ISO 8601)
+  - `--is-member` - Filter to people with current membership (true/false)
+  - `--include-relationships` - Include providers and dependents for each person
+  - `--include-balances` - Include balances for each person
+  - `--sort` - Sort results by attributes (updated_at, created_at, id). Use - for descending
+- **Desk Events List Parameters**:
+  - `--from` - Start date (YYYY-MM-DD or timestamp)
+  - `--to` - End date (YYYY-MM-DD or timestamp, max 120 days from from)
+  - `--ids` - Comma-separated event IDs
+  - `--service-ids` - Comma-separated service IDs
+- **Desk Event Occurrences List Parameters**:
+  - `--from` - Start date (YYYY-MM-DD)
+  - `--to` - End date (YYYY-MM-DD)
+  - `--ids` - Comma-separated event occurrence IDs
+  - `--state` - Comma-separated states (active,canceled,reserved,deleted)
+  - `--staff-member-ids` - Comma-separated staff member IDs
+  - `--service-ids` - Comma-separated service IDs
+  - `--event-ids` - Comma-separated event IDs
+  - `--location-ids` - Comma-separated location IDs
+  - `--group-by` - Group results by (day,hour)
+- **Front Events List Parameters**:
+  - Same parameters as desk events (from, to, ids, service_ids)
+- **Front Event Occurrences List Parameters**:
+  - Same parameters as desk event occurrences (from, to, ids, state, staff_member_ids, service_ids, event_ids, location_ids)
+- **Person Visits Parameters**:
+  - `--from` - Start date for visit time range (YYYY-MM-DD or timestamp)
+  - `--to` - End date for visit time range (YYYY-MM-DD or timestamp)
+  - `--event-occurrence-id` - Scope to a specific event occurrence
+- **Event Occurrence Eligibilities Parameters**:
+  - `--person-ids` - Comma-separated person IDs for enrollment eligibility checking
+
+### Changed
+- **Pike13 SDK Integration** - Updated to use Pike13 SDK v0.1.4 with enhanced parameter support
+- **Improved Code Organization** - Refactored parameter building logic for better maintainability
+  - Extracted complex parameter building into separate helper methods
+  - Reduced method complexity and improved code readability
+  - Applied functional programming patterns for cleaner parameter handling
+- **Enhanced Command Structure** - Improved error handling and date validation across all parameterized commands
+- **Updated API Usage** - Fixed visits command structure to match actual API endpoints
+
+### Fixed
+- **Broken Visit List Command** - Removed non-functional `desk visits list` command that used non-existent API endpoint
+  - Updated to use proper `desk person_visits list PERSON_ID` pattern instead
+  - Added comprehensive parameter support to person visits endpoint
+- **SDK Compatibility Issues** - Updated SDK method signatures to support new parameter passing
+  - Modified `Pike13::Desk::Person.all()` to accept `**params`
+  - Modified `Pike13::Desk::Event.all()` to accept `**params`
+  - Modified `Pike13::Front::Event.all()` to accept `**params`
+- **Code Quality** - Resolved all RuboCop style and complexity violations
+  - Fixed 13 RuboCop offenses including line length, method complexity, and style issues
+  - All 129 files now pass style checks with zero violations
+
+### Examples
+```bash
+# Filter people by membership status
+pike13 desk people list --is-member=true
+
+# Sort people by most recently updated
+pike13 desk people list --sort="-updated_at"
+
+# Filter events by date range
+pike13 desk events list --from="2025-01-01" --to="2025-01-31"
+
+# Filter event occurrences by state and service
+pike13 desk event_occurrences list --state="active" --service-ids="123,456"
+
+# Get person's visits within date range
+pike13 desk person_visits list 12345 --from="2025-01-01" --to="2025-01-31"
+
+# Check enrollment eligibility for specific people
+pike13 desk event_occurrences eligibilities 789 --person-ids="111,222,333"
+```
+
 ## [0.1.4] - 2025-11-16
 
 ### Fixed

data/README.md

@@ -91,6 +91,84 @@ pike13 desk people update 123 --first-name "Jane"
 pike13 desk people delete 123
 ```
 
+#### Advanced Filtering and Parameters
+
+The CLI now supports comprehensive filtering and query parameters for major endpoints:
+
+##### People List Parameters
+
+```bash
+# Filter people by membership status
+pike13 desk people list --is-member=true
+pike13 desk people list --is-member=false
+
+# Filter by creation/update time
+pike13 desk people list --created-since="2025-01-01T00:00:00Z"
+pike13 desk people list --updated-since="2025-01-01T00:00:00Z"
+
+# Include additional data
+pike13 desk people list --include-relationships
+pike13 desk people list --include-balances
+
+# Sort results
+pike13 desk people list --sort="updated_at"
+pike13 desk people list --sort="-updated_at"  # descending
+pike13 desk people list --sort="created_at"
+pike13 desk people list --sort="id"
+
+# Combine multiple filters
+pike13 desk people list --is-member=true --sort="-updated_at" --include-relationships
+```
+
+##### Events List Parameters
+
+```bash
+# Filter by date range
+pike13 desk events list --from="2025-01-01" --to="2025-01-31"
+
+# Filter by specific IDs
+pike13 desk events list --ids="123,456,789"
+pike13 desk events list --service-ids="111,222"
+```
+
+##### Event Occurrences List Parameters
+
+```bash
+# Filter by date range
+pike13 desk event_occurrences list --from="2025-01-01" --to="2025-01-31"
+
+# Filter by state
+pike13 desk event_occurrences list --state="active"
+pike13 desk event_occurrences list --state="active,canceled"
+
+# Filter by staff, services, events, or locations
+pike13 desk event_occurrences list --staff-member-ids="111,222"
+pike13 desk event_occurrences list --service-ids="333,444"
+pike13 desk event_occurrences list --event-ids="555,666"
+pike13 desk event_occurrences list --location-ids="777,888"
+
+# Group results
+pike13 desk event_occurrences list --group-by="day"
+pike13 desk event_occurrences list --group-by="hour"
+```
+
+##### Person Visits Parameters
+
+```bash
+# Get visits for a specific person within date range
+pike13 desk person_visits list 12345 --from="2025-01-01" --to="2025-01-31"
+
+# Filter by specific event occurrence
+pike13 desk person_visits list 12345 --event-occurrence-id=67890
+```
+
+##### Enrollment Eligibility Parameters
+
+```bash
+# Check eligibility for specific people
+pike13 desk event_occurrences eligibilities 789 --person-ids="111,222,333"
+```
+
 #### Business
 
 ```bash
@@ -107,14 +185,24 @@ pike13 desk events list
 # Get an event
 pike13 desk events get 100
 
-# List event occurrences
+# List events with filtering
+pike13 desk events list --from "2025-01-01" --to "2025-01-31"
+pike13 desk events list --service-ids="123,456"
+
+# Get an event
+pike13 desk events get 100
+
+# List event occurrences with advanced filtering
 pike13 desk event_occurrences list --from "2025-01-01" --to "2025-01-31"
+pike13 desk event_occurrences list --state="active" --service-ids="123"
+pike13 desk event_occurrences list --staff-member-ids="456" --group-by="day"
 
 # Get event occurrence
 pike13 desk event_occurrences get 789
 
-# Get enrollment eligibilities
+# Get enrollment eligibilities with person filtering
 pike13 desk event_occurrences eligibilities 789
+pike13 desk event_occurrences eligibilities 789 --person-ids="111,222,333"
 ```
 
 #### Event Occurrence Notes
@@ -285,8 +373,13 @@ Client-facing interface with limited read-only access:
 # Get authenticated client user (only)
 pike13 front people me
 
-# List events (client view)
-pike13 front events list
+# List events (client view) with filtering
+pike13 front events list --from="2025-01-01" --to="2025-01-31"
+pike13 front events list --service-ids="123,456"
+
+# List event occurrences (client view) with filtering
+pike13 front event_occurrences list --from="2025-01-01" --to="2025-01-31"
+pike13 front event_occurrences list --state="active" --service-ids="123"
 
 # List locations (client view)
 pike13 front locations list

data/lib/pike13/cli/commands/account/person.rb

@@ -5,6 +5,10 @@ module Pike13
     module Commands
       class Account < Base
         class Person < Base
+          # Override the command name display to use "people" instead of "person"
+          def self.base_usage
+            "account people"
+          end
           desc "list", "List all people across businesses"
           format_options
           def list

data/lib/pike13/cli/commands/desk/event.rb

@@ -8,10 +8,16 @@ module Pike13
           desc "list", "List all events"
           map "ls" => :list
           format_options
+          option :from, type: :string, desc: "Start date (YYYY-MM-DD or timestamp)"
+          option :to, type: :string, desc: "End date (YYYY-MM-DD or timestamp, max 120 days from from)"
+          option :ids, type: :string, desc: "Comma-separated event IDs"
+          option :service_ids, type: :string, desc: "Comma-separated service IDs"
           def list
+            validate_event_date_formats
             handle_error do
+              params = build_event_params
               result = with_progress("Fetching events") do
-                Pike13::Desk::Event.all
+                Pike13::Desk::Event.all(**params)
               end
               output(result)
             end
@@ -25,6 +31,22 @@ module Pike13
               output(result)
             end
           end
+
+          private
+
+          def validate_event_date_formats
+            validate_date_format(options[:from], "from") if options[:from]
+            validate_date_format(options[:to], "to") if options[:to]
+          end
+
+          def build_event_params
+            params = {}
+            params[:from] = options[:from] if options[:from]
+            params[:to] = options[:to] if options[:to]
+            params[:ids] = options[:ids] if options[:ids]
+            params[:service_ids] = options[:service_ids] if options[:service_ids]
+            params
+          end
         end
       end
     end

data/lib/pike13/cli/commands/desk/event_occurrence.rb

@@ -14,16 +14,17 @@ module Pike13
           format_options
           option :from, type: :string, desc: "Start date (YYYY-MM-DD)"
           option :to, type: :string, desc: "End date (YYYY-MM-DD)"
+          option :ids, type: :string, desc: "Comma-separated event occurrence IDs"
+          option :state, type: :string, desc: "Comma-separated states (active,canceled,reserved,deleted)"
+          option :staff_member_ids, type: :string, desc: "Comma-separated staff member IDs"
+          option :service_ids, type: :string, desc: "Comma-separated service IDs"
+          option :event_ids, type: :string, desc: "Comma-separated event IDs"
+          option :location_ids, type: :string, desc: "Comma-separated location IDs"
+          option :group_by, type: :string, desc: "Group results by (day,hour)"
           def list
-            # Validate date formats
-            validate_date_format(options[:from], "from") if options[:from]
-            validate_date_format(options[:to], "to") if options[:to]
-
+            validate_event_occurrence_date_formats
             handle_error do
-              params = {}
-              params[:from] = options[:from] if options[:from]
-              params[:to] = options[:to] if options[:to]
-
+              params = build_event_occurrence_params
               result = with_progress("Fetching event occurrences") do
                 Pike13::Desk::EventOccurrence.all(**params)
               end
@@ -51,12 +52,28 @@ module Pike13
 
           desc "eligibilities ID", "Get enrollment eligibilities for an event occurrence"
           format_options
+          option :person_ids, type: :string, desc: "Comma-separated person IDs"
           def eligibilities(id)
             handle_error do
-              result = Pike13::Desk::EventOccurrence.enrollment_eligibilities(id: id)
+              params = { id: id }
+              params[:person_ids] = options[:person_ids] if options[:person_ids]
+
+              result = Pike13::Desk::EventOccurrence.enrollment_eligibilities(**params)
               output(result)
             end
           end
+
+          private
+
+          def validate_event_occurrence_date_formats
+            validate_date_format(options[:from], "from") if options[:from]
+            validate_date_format(options[:to], "to") if options[:to]
+          end
+
+          def build_event_occurrence_params
+            %i[from to ids state staff_member_ids service_ids event_ids location_ids group_by]
+              .each_with_object({}) { |key, params| params[key] = options[key] if options[key] }
+          end
         end
       end
     end

data/lib/pike13/cli/commands/desk/person.rb

@@ -5,13 +5,25 @@ module Pike13
     module Commands
       class Desk < Base
         class Person < Base
+          # Override the command name display to use "people" instead of "person"
+          def self.base_usage
+            "desk people"
+          end
           desc "list", "List all people"
           map "ls" => :list
           format_options
+          option :created_since, type: :string, desc: "Filter to people created since given timestamp (ISO 8601)"
+          option :updated_since, type: :string, desc: "Filter to people updated since given timestamp (ISO 8601)"
+          option :is_member, type: :boolean, desc: "Filter to people with current membership"
+          option :include_relationships, type: :boolean, desc: "Include providers and dependents for each person"
+          option :include_balances, type: :boolean, desc: "Include balances for each person"
+          option :sort, type: :string,
+                        desc: "Sort results by attributes (updated_at, created_at, id). Use - for descending"
           def list
             handle_error do
+              params = build_person_params
               result = with_progress("Fetching people") do
-                Pike13::Desk::Person.all
+                Pike13::Desk::Person.all(**params)
               end
               output(result)
             end
@@ -91,6 +103,21 @@ module Pike13
               success_message "Person #{id} deleted successfully"
             end
           end
+
+          private
+
+          def build_person_params
+            params = {}
+            params[:created_since] = options[:created_since] if options[:created_since]
+            params[:updated_since] = options[:updated_since] if options[:updated_since]
+            params[:is_member] = options[:is_member] unless options[:is_member].nil?
+            [
+              [:include_relationships, options[:include_relationships]],
+              [:include_balances, options[:include_balances]],
+              [:sort, options[:sort]]
+            ].each { |key, value| params[key] = value if value }
+            params
+          end
         end
       end
     end

data/lib/pike13/cli/commands/desk/person_visit.rb

@@ -12,10 +12,21 @@ module Pike13
           desc "list PERSON_ID", "List visits for a person"
           map "ls" => :list
           format_options
+          option :from, type: :string, desc: "Start date for visit time range (YYYY-MM-DD or timestamp)"
+          option :to, type: :string, desc: "End date for visit time range (YYYY-MM-DD or timestamp)"
+          option :event_occurrence_id, type: :numeric, desc: "Scope to a specific event occurrence"
           def list(person_id)
+            validate_date_format(options[:from], "from") if options[:from]
+            validate_date_format(options[:to], "to") if options[:to]
+
             handle_error do
-              result = with_progress("Fetching person visits") do
-                Pike13::Desk::PersonVisit.all(person_id: person_id)
+              params = {}
+              params[:from] = options[:from] if options[:from]
+              params[:to] = options[:to] if options[:to]
+              params[:event_occurrence_id] = options[:event_occurrence_id] if options[:event_occurrence_id]
+
+              result = with_progress("Fetching visits for person #{person_id}") do
+                Pike13::Desk::PersonVisit.all(person_id: person_id, **params)
               end
               output(result)
             end

data/lib/pike13/cli/commands/desk/staff_member.rb

@@ -5,6 +5,10 @@ module Pike13
     module Commands
       class Desk < Base
         class StaffMember < Base
+          # Override the command name display to use "staff" instead of "staffmember"
+          def self.base_usage
+            "desk staff"
+          end
           desc "list", "List all staff"
           map "ls" => :list
           format_options

data/lib/pike13/cli/commands/desk/visit.rb

@@ -5,18 +5,6 @@ module Pike13
     module Commands
       class Desk < Base
         class Visit < Base
-          desc "list", "List all visits"
-          map "ls" => :list
-          format_options
-          def list
-            handle_error do
-              result = with_progress("Fetching visits") do
-                Pike13::Desk::Visit.all
-              end
-              output(result)
-            end
-          end
-
           desc "get ID", "Get a visit by ID"
           format_options
           def get(id)

data/lib/pike13/cli/commands/front/event.rb

@@ -7,14 +7,36 @@ module Pike13
         class Event < Base
           desc "list", "List events (client view)"
           format_options
+          option :from, type: :string, desc: "Start date (YYYY-MM-DD or timestamp)"
+          option :to, type: :string, desc: "End date (YYYY-MM-DD or timestamp, max 120 days from from)"
+          option :ids, type: :string, desc: "Comma-separated event IDs"
+          option :service_ids, type: :string, desc: "Comma-separated service IDs"
           def list
+            validate_front_event_date_formats
             handle_error do
+              params = build_front_event_params
               result = with_progress("Fetching events") do
-                Pike13::Front::Event.all
+                Pike13::Front::Event.all(**params)
               end
               output(result)
             end
           end
+
+          private
+
+          def validate_front_event_date_formats
+            validate_date_format(options[:from], "from") if options[:from]
+            validate_date_format(options[:to], "to") if options[:to]
+          end
+
+          def build_front_event_params
+            params = {}
+            params[:from] = options[:from] if options[:from]
+            params[:to] = options[:to] if options[:to]
+            params[:ids] = options[:ids] if options[:ids]
+            params[:service_ids] = options[:service_ids] if options[:service_ids]
+            params
+          end
         end
       end
     end

data/lib/pike13/cli/commands/front/event_occurrence.rb

@@ -13,21 +13,34 @@ module Pike13
           format_options
           option :from, type: :string, desc: "Start date (YYYY-MM-DD)"
           option :to, type: :string, desc: "End date (YYYY-MM-DD)"
+          option :ids, type: :string, desc: "Comma-separated event occurrence IDs"
+          option :state, type: :string, desc: "Comma-separated states (active,canceled,reserved,deleted)"
+          option :staff_member_ids, type: :string, desc: "Comma-separated staff member IDs"
+          option :service_ids, type: :string, desc: "Comma-separated service IDs"
+          option :event_ids, type: :string, desc: "Comma-separated event IDs"
+          option :location_ids, type: :string, desc: "Comma-separated location IDs"
           def list
-            validate_date_format(options[:from], "from") if options[:from]
-            validate_date_format(options[:to], "to") if options[:to]
-
+            validate_front_event_occurrence_date_formats
             handle_error do
-              params = {}
-              params[:from] = options[:from] if options[:from]
-              params[:to] = options[:to] if options[:to]
-
+              params = build_front_event_occurrence_params
               result = with_progress("Fetching event occurrences") do
                 Pike13::Front::EventOccurrence.all(**params)
               end
               output(result)
             end
           end
+
+          private
+
+          def validate_front_event_occurrence_date_formats
+            validate_date_format(options[:from], "from") if options[:from]
+            validate_date_format(options[:to], "to") if options[:to]
+          end
+
+          def build_front_event_occurrence_params
+            %i[from to ids state staff_member_ids service_ids event_ids location_ids]
+              .each_with_object({}) { |key, params| params[key] = options[key] if options[key] }
+          end
         end
       end
     end

data/lib/pike13/cli/commands/front/person.rb

@@ -5,6 +5,10 @@ module Pike13
     module Commands
       class Front < Base
         class Person < Base
+          # Override the command name display to use "people" instead of "person"
+          def self.base_usage
+            "front people"
+          end
           desc "me", "Get current authenticated client user"
           format_options
           def me

data/lib/pike13/cli/commands/front/plan_product.rb

@@ -5,6 +5,10 @@ module Pike13
     module Commands
       class Front < Base
         class PlanProduct < Base
+          # Override the command name display to use "plan_products" instead of "planproduct"
+          def self.base_usage
+            "front plan_products"
+          end
           desc "list", "List all plan products"
           format_options
           def list

data/lib/pike13/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Pike13
   module CLI
-    VERSION = "0.1.4"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pike13-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Pike13 CLI Contributors