tyler_efm_client 1.0.0.pre.alpha.1 → 1.0.0.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88d92317b5acb03095243792d00d37678bc9c661806f3a6855440df15c82edca
-  data.tar.gz: 25f07c97e2454d9277c61022951c59d45801f8831eae32493d497bf10bc2e2ef
+  metadata.gz: 940661dea706efa9a8dd63f546d602431afe69536117c8b7ed1796aa72b9e429
+  data.tar.gz: a71cae0f5d4444a9cb6fc59d2a92f62e4813996040dc4b94f502980113f227f5
 SHA512:
-  metadata.gz: e1b14745936b70901fbec4e485b820818a60d6e7abce4fda9fad13d41896744a814df67b7865cf40e260bcb2468e29b31d9772269f45808f18f52bc75614d4a6
-  data.tar.gz: e78fde612b7b9a5a83f9bc3a54779e6904bda9a792d85de51df54705e56467ac11ca4aa77889dc6f41e2b14b1fc71c823730d8d657604217c979601a539635ce
+  metadata.gz: d459b94478d7626451b233b86cc3ea50c7a1f8554bde038b97e2adce8dae228c152487858752c3ff681e01687d90cea1718ac42a5406cc8a59df9e563fc49a72
+  data.tar.gz: 6779fbec068348f282e7c7866b49e45e0733d8dcdd78e6775ea50763f5e2385a2c721824eaed4a4936925a5468b60c37cc5d349f55a64dbef74619f2ef10522f

data/README.md

@@ -268,12 +268,35 @@ To install this gem onto your local machine, run:
 bundle exec rake install
 ```
 
-To release a new version:
+## 🚀 Releases & Versioning
 
-1. Update the version number in `lib/tyler_efm_client/version.rb`
-2. Run `bundle exec rake release`
+This gem uses **automated version management** through GitHub Actions. The system automatically handles version conflicts and increments alpha releases.
 
-This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Quick Release Guide
+
+**Alpha/Development Releases** (Most Common):
+- Go to GitHub Actions → "Publish Ruby Gem" → "Run workflow"  
+- Leave version input blank - system will auto-increment to next available version
+- Perfect for continuous integration and testing
+
+**Production Releases**:
+```bash
+# Create a version tag and GitHub release
+git tag v1.0.0
+git push origin v1.0.0
+# Then create GitHub Release using the tag
+```
+
+**Manual Version Override**:
+- Use GitHub Actions workflow with specific version input
+- Example: `1.0.0.pre.alpha.10` or `1.1.0.pre.beta.1`
+
+📖 **See [VERSIONING.md](./VERSIONING.md) for complete versioning guide**
+
+### Current Version Strategy
+- **Auto-increment**: System automatically finds next available alpha version
+- **Conflict Resolution**: Handles "version already exists" errors automatically  
+- **No Manual File Editing**: Version files updated during CI/CD process
 
 ## 🤝 Contributing
 

data/VERSIONING.md

@@ -0,0 +1,224 @@
+# Tyler EFM Client Ruby - Versioning Guide
+
+This document explains how to manage versions and releases for the Tyler EFM Client Ruby gem.
+
+## 🎯 Versioning Strategy
+
+We use **Semantic Versioning (SemVer)** with intelligent automation for development releases:
+
+- **Production Releases**: `1.0.0`, `1.1.0`, `2.0.0`
+- **Alpha/Beta Releases**: `1.0.0.pre.alpha.1`, `1.0.0.pre.beta.1`
+- **Release Candidates**: `1.0.0.rc.1`
+
+## 🤖 Automated Version Management
+
+The GitHub Actions workflow automatically handles versioning to prevent conflicts and streamline releases.
+
+### Current System Behavior
+
+1. **Auto-increment Alpha Versions**: When publishing alpha releases, the system automatically finds the next available version number
+2. **Conflict Resolution**: If a version already exists on RubyGems, it auto-increments to the next available number
+3. **Dynamic Version Updates**: The `lib/tyler_efm_client/version.rb` file is updated during the build process
+
+## 📋 Release Types & Workflows
+
+### 1. Alpha/Development Releases (Most Common)
+
+**Use Case**: Regular development releases, testing, continuous integration
+
+**How to Trigger**:
+```bash
+# Option A: Manual workflow dispatch (no version specified)
+# Go to GitHub Actions → "Publish Ruby Gem" → "Run workflow"
+# Leave version input blank - system will auto-increment
+
+# Option B: Manual workflow dispatch (specific version)
+# Go to GitHub Actions → "Publish Ruby Gem" → "Run workflow"  
+# Enter version like: 1.0.0.pre.alpha.5
+```
+
+**What Happens**:
+- System reads current version from `version.rb` (e.g., `1.0.0.pre.alpha.2`)
+- Checks if that version exists on RubyGems
+- If exists, auto-increments to next available (e.g., `1.0.0.pre.alpha.3`)
+- Updates `version.rb` dynamically
+- Builds and publishes gem
+
+**File Updates**: No manual file changes needed - fully automated!
+
+### 2. Production Releases
+
+**Use Case**: Official releases for end users
+
+**How to Trigger**:
+```bash
+# Create a GitHub release with a version tag
+git tag v1.0.0
+git push origin v1.0.0
+
+# Then create a GitHub Release using the tag
+# Go to GitHub → Releases → "Create a new release"
+# Use tag: v1.0.0, Title: "Version 1.0.0"
+```
+
+**What Happens**:
+- System uses the release tag as the version (removes 'v' prefix)
+- Updates `version.rb` to the production version
+- Builds and publishes to RubyGems as a production release
+
+### 3. Manual Version Override
+
+**Use Case**: Specific version requirements, fixing version conflicts
+
+**How to Trigger**:
+- Go to GitHub Actions → "Publish Ruby Gem" → "Run workflow"
+- Enter specific version in the input field
+- Examples: `1.0.0.pre.alpha.10`, `1.1.0.pre.beta.1`, `2.0.0.rc.1`
+
+## 🔧 Version File Management
+
+### Current Version Location
+```ruby
+# lib/tyler_efm_client/version.rb
+module TylerEfmClient
+  VERSION = '1.0.0.pre.alpha.1'
+end
+```
+
+### ⚠️ Important Notes for Developers
+
+1. **Don't Manually Edit Version File**: The CI/CD system handles this automatically
+2. **Version File is Updated During Build**: Changes are made during the GitHub Actions workflow
+3. **Local Development**: Your local `version.rb` may differ from published versions
+4. **Commit After Release**: Version changes are made in CI, consider updating locally after successful releases
+
+## 📊 Version Examples & Progression
+
+### Alpha Release Progression
+```
+Start:           1.0.0.pre.alpha.1
+Auto-increment:  1.0.0.pre.alpha.2  
+Auto-increment:  1.0.0.pre.alpha.3
+...
+Manual bump:     1.0.0.pre.alpha.10
+```
+
+### Production Release Examples
+```
+Alpha series:    1.0.0.pre.alpha.x
+Release tag:     v1.0.0
+Published as:    1.0.0
+
+Next series:     1.1.0.pre.alpha.1
+Release tag:     v1.1.0  
+Published as:    1.1.0
+```
+
+## 🚨 Troubleshooting Version Conflicts
+
+### "Version Already Exists" Error
+
+**For Alpha Versions (Automatic)**:
+- System detects conflict
+- Auto-increments to next available version
+- No manual intervention needed
+
+**For Production Versions (Manual)**:
+If you get a conflict with a production version:
+
+1. **Check RubyGems**: Visit https://rubygems.org/gems/tyler_efm_client/versions
+2. **Choose New Version**: Pick a version that doesn't exist
+3. **Manual Override**: Use workflow dispatch with specific version
+4. **Or Yank Existing**: If you own the version, yank it first:
+   ```bash
+   gem yank tyler_efm_client -v 1.0.0
+   ```
+
+### Version Rollback
+
+If you need to rollback a version:
+```bash
+# Yank the problematic version
+gem yank tyler_efm_client -v 1.0.0.pre.alpha.5
+
+# Republish with corrected code using manual version override
+```
+
+## 🎯 Best Practices for Engineers
+
+### Daily Development
+1. **Use Auto-increment**: Don't specify versions for regular alpha releases
+2. **Let CI Handle It**: The system will find the next available version
+3. **Test Locally First**: Ensure your changes work before triggering releases
+
+### Preparing for Production
+1. **Plan Version Number**: Decide on major.minor.patch based on changes
+2. **Update Documentation**: Ensure README, CHANGELOG reflect new features
+3. **Create Git Tag**: Use clean tags like `v1.0.0`, `v1.1.0`
+4. **GitHub Release**: Create formal release with notes
+
+### Semantic Versioning Guidelines
+- **MAJOR** (1.0.0 → 2.0.0): Breaking changes, API changes
+- **MINOR** (1.0.0 → 1.1.0): New features, backwards compatible
+- **PATCH** (1.0.0 → 1.0.1): Bug fixes, backwards compatible
+
+## 🔍 Monitoring Releases
+
+### Check Published Versions
+```bash
+# List all published versions
+gem list tyler_efm_client --remote --all
+
+# Check specific version details
+gem specification tyler_efm_client -v 1.0.0.pre.alpha.3
+```
+
+### GitHub Actions Monitoring
+- Go to GitHub → Actions → "Publish Ruby Gem" 
+- Monitor workflow runs for success/failure
+- Check logs for version conflicts or publishing issues
+
+## 📝 Version History Tracking
+
+The system maintains version history through:
+- **Git Tags**: Production releases
+- **GitHub Releases**: Release notes and changelogs  
+- **RubyGems History**: All published versions
+- **GitHub Actions Logs**: Build and publish details
+
+## 🆘 Getting Help
+
+### Common Issues
+1. **Build Failures**: Check GitHub Actions logs
+2. **Version Conflicts**: System should auto-resolve for alphas
+3. **Publishing Errors**: Check RubyGems API key and permissions
+
+### Support Contacts
+- **Tyler ECF Team**: For Tyler EFM service issues
+- **Ruby Gem Issues**: Check GitHub Issues in this repository
+- **CI/CD Problems**: Review GitHub Actions workflow logs
+
+---
+
+## Quick Reference Commands
+
+```bash
+# Check current published versions
+gem list tyler_efm_client --remote
+
+# Manual publish (alpha - auto-increment)
+# GitHub Actions → "Publish Ruby Gem" → Run (leave version blank)
+
+# Manual publish (specific version)  
+# GitHub Actions → "Publish Ruby Gem" → Run → Enter version
+
+# Production release
+git tag v1.0.0
+git push origin v1.0.0
+# Then create GitHub Release
+
+# Emergency yank
+gem yank tyler_efm_client -v VERSION_NUMBER
+```
+
+This automated versioning system eliminates most manual version management while providing flexibility for special cases.

data/docs/getting_started.md

@@ -259,16 +259,16 @@ end
 Now that you have the basics working:
 
 1. **Explore Examples**: Check the `examples/` directory for complete working examples
-2. **Review Samples**: Look at `samples/` for real-world integration patterns
-3. **Read API Reference**: See `docs/api_reference.md` for detailed method documentation
-4. **Check Troubleshooting**: Review `docs/troubleshooting.md` for common issues
+2. **Review Samples**: Look at `samples/` for real-world integration patterns  
+3. **Read Documentation**: See the main README.md for detailed method documentation
+4. **Release Management**: Review versioning guide for package updates
 
 ## 🔗 Quick Links
 
-- [Authentication Guide](authentication_guide.md) - Detailed authentication setup
-- [API Reference](api_reference.md) - Complete method documentation
-- [Tyler ECF Requirements](tyler_ecf_requirements.md) - Understanding Tyler's system
-- [Troubleshooting](troubleshooting.md) - Common issues and solutions
+- [Main Documentation](../README.md) - Complete API reference and usage examples
+- [Versioning Guide](../VERSIONING.md) - Release and version management
+- [Examples Directory](../examples/) - Working code examples
+- [Court Filing Samples](../samples/court_filing_workflow/) - Real-world integration patterns
 
 ## 💎 Ruby Conventions
 

data/examples/SETUP_AND_TEST.md

@@ -0,0 +1,134 @@
+# Tyler EFM Client Ruby Gem - Alpha Testing Setup
+
+🧪 **Quick setup guide** to test the published alpha gem with your existing configuration.
+
+## 🚀 Fast Track Testing
+
+### Option 1: Test with Your Existing Config (Recommended)
+
+```bash
+# Navigate to the sample application directory
+cd examples/sample_application
+
+# Install the published alpha gem
+gem install tyler_efm_client --pre
+
+# Run the test using your existing working config
+ruby test_with_working_config.rb
+```
+
+This will:
+1. Load your existing `python_auth/config.json` 
+2. Use your working certificate and credentials
+3. Test both authentication and GetCaseList operations
+4. Show you exactly what the alpha gem produces
+
+### Option 2: Full Sample Application
+
+```bash
+# Install dependencies
+bundle install
+
+# Copy and configure
+cp config.example.json config.json
+# Edit config.json with your credentials
+
+# Run the full sample app
+ruby sample_app.rb
+```
+
+## 📋 Expected Test Results
+
+### ✅ Successful Test Output:
+```
+🧪 Testing Tyler EFM Client Ruby Gem Alpha Version
+📦 Gem Version: 1.0.0.pre.alpha.1
+📁 Using config: ../../../python_auth/config.json
+============================================================
+
+🔐 Test 1: Authentication
+   🔑 Authenticating with Tyler EFM User Service...
+✅ Authentication test passed!
+
+📋 Test 2: GetCaseList Operation
+   📊 Calling GetCaseList with password hash...
+✅ GetCaseList test passed!
+
+🎉 All alpha gem tests successful!
+```
+
+### 🎯 What This Proves:
+- ✅ **Alpha gem works** with your real Tyler environment
+- ✅ **Authentication successful** - same password hash as your working scripts
+- ✅ **GetCaseList functional** - retrieves actual case data
+- ✅ **Certificate handling** - properly processes your PFX file
+- ✅ **WS-Security working** - creates valid RSA-SHA1/SHA1 signatures
+
+## 🔧 Troubleshooting
+
+### Common Issues:
+
+**"Gem not found"**
+```bash
+# Make sure you install the prerelease version
+gem install tyler_efm_client --pre
+```
+
+**"Config file not found"**
+```bash
+# Verify your config.json exists
+ls -la ../../../python_auth/config.json
+```
+
+**"Certificate file not found"**
+```bash
+# Check certificate path in config.json
+# Path should be relative to python_auth directory
+```
+
+**Ruby version issues**
+```bash
+# The gem requires Ruby 3.0+
+ruby --version
+```
+
+## 📊 Comparison with Working Scripts
+
+Run this to compare alpha gem results with your working Ruby script:
+
+```bash
+# Test your original working Ruby script
+cd ../../../python_auth
+ruby auth_test.rb
+
+# Test the alpha gem
+cd ../github_repositories/cj-esol-efm-client-ruby/examples/sample_application
+ruby test_with_working_config.rb
+```
+
+**Both should produce the same password hash:** `5c31af92-391e-4ca2-a530-3ee61af1fa37`
+
+## 🎯 Success Criteria
+
+Your alpha gem test is successful when:
+- ✅ **Authentication returns password hash** matching your working scripts
+- ✅ **GetCaseList returns case data** (including "AARONS vs. JAREKA LEWIS")
+- ✅ **No certificate errors** or WS-Security failures
+- ✅ **Same results** as your proven working implementations
+
+## 🚀 Next Steps After Successful Test
+
+1. **🐛 Report any issues** found during alpha testing
+2. **💡 Suggest improvements** for the stable v1.0.0 release  
+3. **📚 Share feedback** on the developer experience
+4. **🎉 Celebrate** - you're using the first Tyler EFM Client Ruby gem!
+
+## 🔗 Support Resources
+
+- **Issues**: [GitHub Issues](https://github.com/tyler-technologies/cj-esol-efm-client-ruby/issues)
+- **Documentation**: [Developer Portal](https://tyler-technologies.github.io/cj-esol-efm-client-developer-portal/)
+- **Tyler Support**: ecf-support@tylertech.com
+
+---
+
+**🧪 Ready to test the future of Tyler ECF integration!**

data/examples/sample_application/.gitignore

@@ -0,0 +1,31 @@
+# Configuration files with sensitive data
+config.json
+
+# Certificate files
+*.pfx
+*.pem
+*.key
+*.p12
+*.crt
+*.cer
+
+# Bundler
+.bundle/
+vendor/
+
+# Ruby
+*.gem
+.rbenv-version
+.ruby-version
+
+# Logs
+*.log
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

data/examples/sample_application/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Use the alpha version of Tyler EFM Client
+gem 'tyler_efm_client', '~> 1.0.0.pre.alpha.1'
+
+# Additional gems for the sample application
+gem 'json', '~> 2.6'
+gem 'optparse', '~> 0.2'
+
+group :development do
+  gem 'rubocop', '~> 1.0', require: false
+end

data/examples/sample_application/README.md

@@ -0,0 +1,160 @@
+# Tyler EFM Client Ruby Gem - Sample Application
+
+🧪 **Alpha Testing Application** for the Tyler EFM Client Ruby gem.
+
+This sample application demonstrates how to use the `tyler_efm_client` gem to authenticate with Tyler EFM services and retrieve case lists.
+
+## 🚀 Quick Start
+
+### 1. Install Dependencies
+
+```bash
+# Install the alpha gem and dependencies
+bundle install
+```
+
+### 2. Configure Credentials
+
+```bash
+# Copy the example configuration
+cp config.example.json config.json
+
+# Edit config.json with your actual credentials
+nano config.json
+```
+
+**Required Configuration:**
+- **Certificate file**: Path to your Tyler PFX certificate
+- **Certificate password**: Password for the PFX file
+- **User credentials**: Your Tyler EFM email and password
+- **Service URLs**: Tyler staging or production endpoints
+
+### 3. Run the Sample Application
+
+```bash
+# Run with default config.json
+ruby sample_app.rb
+
+# Or specify a different config file
+ruby sample_app.rb --config my_config.json
+```
+
+## 📋 What It Does
+
+The sample application performs these steps:
+
+1. **🔐 Authentication**
+   - Loads your PFX certificate
+   - Creates WS-Security digital signatures (RSA-SHA1/SHA1)
+   - Authenticates with Tyler EFM User Service
+   - Retrieves password hash for subsequent calls
+
+2. **📊 Case List Retrieval**
+   - Uses the password hash from authentication
+   - Calls Tyler Court Record Service GetCaseList operation
+   - Displays case information in a readable format
+
+## 💻 Example Output
+
+```
+🎯 Tyler EFM Client Ruby Gem - Sample Application
+📦 Using alpha version: 1.0.0.pre.alpha.1
+============================================================
+
+🔐 Step 1: Authenticating with Tyler EFM...
+✅ Authentication successful!
+👤 User: John Doe
+📧 Email: john.doe@example.com
+🔑 Password Hash: 5c31af92-391e-4ca2-a530-3ee61af1fa37
+
+📋 Step 2: Retrieving case list...
+✅ Case list retrieved successfully!
+
+📊 Found 3 cases:
+
+1. Case: 23MPF011258
+   Title: AARONS vs. JAREKA LEWIS
+   Status: Active
+   Court: Georgia Magistrate Court
+
+2. Case: 23CV001234
+   Title: SMITH vs. JONES
+   Status: Pending
+   Court: Georgia Superior Court
+
+3. Case: 23TR005678
+   Title: STATE vs. JOHNSON
+   Status: Closed
+   Court: Georgia Municipal Court
+```
+
+## 🔧 Configuration Options
+
+### config.json Structure
+
+```json
+{
+  "service": {
+    "user_service_url": "https://georgia-stage.tylertech.cloud/EFM/EFMUserService.svc",
+    "court_service_url": "https://georgia-stage.tylertech.cloud/efm/v5/CourtRecordService.svc"
+  },
+  "certificate": {
+    "pfx_file": "path/to/your/certificate.pfx",
+    "pfx_password": "your_pfx_password"
+  },
+  "credentials": {
+    "email": "your-email@domain.com",
+    "password": "your-password"
+  },
+  "court": {
+    "court_id": "georgia:statewide"
+  }
+}
+```
+
+### Environment Options
+
+- **Production URLs**: Use Tyler production service endpoints
+- **Different Courts**: Change `court_id` for specific jurisdictions
+- **Debug Mode**: Set `DEBUG=1` environment variable for detailed error traces
+
+## 🧪 Alpha Testing Notes
+
+This application uses the **alpha version** of the Tyler EFM Client gem:
+
+### ✅ What Works
+- **Authentication**: Complete WS-Security implementation
+- **GetCaseList**: Retrieves case data successfully
+- **Certificate handling**: Automatic PFX processing
+- **Error handling**: Comprehensive error reporting
+
+### ⚠️  Alpha Limitations
+- **Limited testing**: May have edge cases not yet discovered
+- **API stability**: Methods may change before v1.0.0 stable
+- **Documentation**: Some features may not be fully documented
+
+### 🐛 Feedback Welcome
+
+Please report any issues or suggestions:
+- [GitHub Issues](https://github.com/tyler-technologies/cj-esol-efm-client-ruby/issues)
+- Tyler Support: ecf-support@tylertech.com
+
+## 📚 Additional Examples
+
+The `examples/` directory contains more specialized examples:
+
+- `simple_auth.rb` - Basic authentication only
+- `advanced_soap.rb` - Custom SOAP operations
+- `error_handling.rb` - Comprehensive error handling patterns
+- `batch_operations.rb` - Multiple service calls
+
+## 🔗 Resources
+
+- [Tyler EFM Client Ruby Gem](https://rubygems.org/gems/tyler_efm_client)
+- [Developer Portal](https://tyler-technologies.github.io/cj-esol-efm-client-developer-portal/)
+- [Python SDK](https://github.com/tyler-technologies/cj-esol-efm-client-python)
+- [Tyler ECF Documentation](https://github.com/tyler-technologies/cj-esol-efm-client-management)
+
+---
+
+**🚀 Built for Tyler ECF integration partners using the alpha Tyler EFM Client Ruby gem.**

data/examples/sample_application/config.example.json

@@ -0,0 +1,17 @@
+{
+  "service": {
+    "user_service_url": "https://georgia-stage.tylertech.cloud/EFM/EFMUserService.svc",
+    "court_service_url": "https://georgia-stage.tylertech.cloud/efm/v5/CourtRecordService.svc"
+  },
+  "certificate": {
+    "pfx_file": "path/to/your/certificate.pfx",
+    "pfx_password": "your_pfx_password"
+  },
+  "credentials": {
+    "email": "your-email@domain.com",
+    "password": "your-password"
+  },
+  "court": {
+    "court_id": "georgia:statewide"
+  }
+}

data/examples/sample_application/sample_app.rb

@@ -0,0 +1,187 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'tyler_efm_client'
+require 'json'
+require 'optparse'
+
+# Sample Tyler EFM Client Application
+# Demonstrates authentication and GetCaseList using the alpha gem
+
+class TylerEFMSampleApp
+  def initialize(config_file = 'config.json')
+    @config_file = config_file
+    @config = load_config
+    @client = TylerEfmClient::Client.new
+  end
+
+  def run
+    puts "🎯 Tyler EFM Client Ruby Gem - Sample Application"
+    puts "📦 Using alpha version: #{TylerEfmClient::VERSION}"
+    puts "=" * 60
+
+    # Step 1: Authenticate
+    puts "\n🔐 Step 1: Authenticating with Tyler EFM..."
+    auth_result = authenticate
+
+    if auth_result[:success]
+      puts "✅ Authentication successful!"
+      puts "👤 User: #{auth_result[:first_name]} #{auth_result[:last_name]}"
+      puts "📧 Email: #{auth_result[:email]}"
+      puts "🔑 Password Hash: #{auth_result[:password_hash]}"
+
+      # Step 2: Get Case List
+      puts "\n📋 Step 2: Retrieving case list..."
+      case_result = get_case_list(auth_result[:password_hash])
+
+      if case_result[:success]
+        puts "✅ Case list retrieved successfully!"
+        display_cases(case_result[:data])
+      else
+        puts "❌ Failed to retrieve case list: #{case_result[:error_message]}"
+      end
+    else
+      puts "❌ Authentication failed: #{auth_result[:error_message]}"
+      exit 1
+    end
+  end
+
+  private
+
+  def load_config
+    unless File.exist?(@config_file)
+      puts "❌ Configuration file not found: #{@config_file}"
+      puts "📝 Please copy config.example.json to #{@config_file} and update with your credentials."
+      exit 1
+    end
+
+    JSON.parse(File.read(@config_file), symbolize_names: true)
+  rescue JSON::ParserError => e
+    puts "❌ Invalid JSON in configuration file: #{e.message}"
+    exit 1
+  end
+
+  def authenticate
+    @client.authenticate(
+      base_url: @config[:service][:user_service_url],
+      pfx_file: @config[:certificate][:pfx_file],
+      pfx_password: @config[:certificate][:pfx_password],
+      user_email: @config[:credentials][:email],
+      user_password: @config[:credentials][:password]
+    )
+  rescue StandardError => e
+    {
+      success: false,
+      error_message: "Authentication error: #{e.message}"
+    }
+  end
+
+  def get_case_list(password_hash)
+    # Create SOAP body for GetCaseList operation
+    soap_body = build_get_case_list_soap_body
+
+    @client.call_service(
+      base_url: @config[:service][:court_service_url],
+      password_hash: password_hash,
+      operation: 'GetCaseList',
+      soap_body: soap_body,
+      user_email: @config[:credentials][:email],
+      pfx_file: @config[:certificate][:pfx_file],
+      pfx_password: @config[:certificate][:pfx_password],
+      return_json: true
+    )
+  rescue StandardError => e
+    {
+      success: false,
+      error_message: "GetCaseList error: #{e.message}"
+    }
+  end
+
+  def build_get_case_list_soap_body
+    court_id = @config[:court][:court_id]
+    
+    <<~SOAP
+      <wrappers:GetCaseListRequest xmlns:wrappers="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/wrappers">
+        <wrappers:CourtLocationId>
+          <nc:IdentificationID>#{court_id}</nc:IdentificationID>
+        </wrappers:CourtLocationId>
+        <wrappers:CaseListQueryMessage>
+          <ecf:ElectronicCourtFilingQueryMessage xmlns:ecf="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/ecf">
+            <nc:DocumentIdentification xmlns:nc="http://niem.gov/niem/niem-core/2.0">
+              <nc:IdentificationID>GetCaseList-#{Time.now.to_i}</nc:IdentificationID>
+            </nc:DocumentIdentification>
+            <nc:DocumentSubmitter xmlns:nc="http://niem.gov/niem/niem-core/2.0">
+              <nc:EntityRepresentation>
+                <nc:EntityPerson>
+                  <nc:PersonName>
+                    <nc:PersonFullName>Sample Application User</nc:PersonFullName>
+                  </nc:PersonName>
+                </nc:EntityPerson>
+              </nc:EntityRepresentation>
+            </nc:DocumentSubmitter>
+            <ecf:CaseListQueryCriteria>
+              <ecf:CaseParticipantRoleCode>Party</ecf:CaseParticipantRoleCode>
+            </ecf:CaseListQueryCriteria>
+          </ecf:ElectronicCourtFilingQueryMessage>
+        </wrappers:CaseListQueryMessage>
+      </wrappers:GetCaseListRequest>
+    SOAP
+  end
+
+  def display_cases(case_data)
+    if case_data.is_a?(Hash) && case_data['cases']
+      cases = case_data['cases']
+      puts "\n📊 Found #{cases.length} cases:"
+      
+      cases.each_with_index do |case_info, index|
+        puts "\n#{index + 1}. Case: #{case_info['case_number'] || 'Unknown'}"
+        puts "   Title: #{case_info['case_title'] || 'No title'}"
+        puts "   Status: #{case_info['status'] || 'Unknown'}"
+        puts "   Court: #{case_info['court'] || 'Unknown'}"
+      end
+    elsif case_data.is_a?(String)
+      # Raw XML response
+      puts "\n📄 Raw XML Response (first 500 characters):"
+      puts case_data[0..500]
+      puts "..." if case_data.length > 500
+    else
+      puts "\n📄 Response data:"
+      puts case_data.inspect
+    end
+  end
+end
+
+# Command line interface
+def main
+  options = {}
+  
+  OptionParser.new do |opts|
+    opts.banner = "Usage: ruby sample_app.rb [options]"
+    
+    opts.on('-c', '--config FILE', 'Configuration file (default: config.json)') do |file|
+      options[:config] = file
+    end
+    
+    opts.on('-h', '--help', 'Show this help message') do
+      puts opts
+      exit
+    end
+  end.parse!
+
+  config_file = options[:config] || 'config.json'
+  
+  begin
+    app = TylerEFMSampleApp.new(config_file)
+    app.run
+  rescue Interrupt
+    puts "\n\n👋 Application interrupted by user"
+    exit 0
+  rescue StandardError => e
+    puts "\n❌ Application error: #{e.message}"
+    puts "🔍 #{e.backtrace.first}" if ENV['DEBUG']
+    exit 1
+  end
+end
+
+# Run the application if this file is executed directly
+main if __FILE__ == $PROGRAM_NAME

data/examples/sample_application/test_with_working_config.rb

@@ -0,0 +1,147 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'tyler_efm_client'
+require 'json'
+
+# Test the alpha gem with working configuration
+# This uses the same config as your working Python/Ruby implementations
+
+class AlphaGemTester
+  def initialize
+    # Load configuration from the working setup
+    @config_path = '../../../python_auth/config.json'
+    @config = load_config
+    @client = TylerEfmClient::Client.new
+    
+    puts "🧪 Testing Tyler EFM Client Ruby Gem Alpha Version"
+    puts "📦 Gem Version: #{TylerEfmClient::VERSION}"
+    puts "📁 Using config: #{@config_path}"
+    puts "=" * 60
+  end
+
+  def run_test
+    # Test 1: Authentication
+    puts "\n🔐 Test 1: Authentication"
+    auth_result = test_authentication
+    
+    if auth_result[:success]
+      puts "✅ Authentication test passed!"
+      
+      # Test 2: GetCaseList
+      puts "\n📋 Test 2: GetCaseList Operation"
+      case_result = test_get_case_list(auth_result[:password_hash])
+      
+      if case_result[:success]
+        puts "✅ GetCaseList test passed!"
+        puts "\n🎉 All alpha gem tests successful!"
+      else
+        puts "❌ GetCaseList test failed: #{case_result[:error_message]}"
+      end
+    else
+      puts "❌ Authentication test failed: #{auth_result[:error_message]}"
+    end
+  end
+
+  private
+
+  def load_config
+    full_path = File.expand_path(@config_path, __FILE__)
+    
+    unless File.exist?(full_path)
+      puts "❌ Config file not found: #{full_path}"
+      puts "📝 Make sure you have config.json in your python_auth directory"
+      exit 1
+    end
+
+    JSON.parse(File.read(full_path), symbolize_names: true)
+  rescue JSON::ParserError => e
+    puts "❌ Invalid JSON in config file: #{e.message}"
+    exit 1
+  end
+
+  def test_authentication
+    puts "   🔑 Authenticating with Tyler EFM User Service..."
+    
+    @client.authenticate(
+      base_url: @config[:service][:endpoint],
+      pfx_file: File.expand_path(@config[:certificate][:pfx_file], File.dirname(@config_path)),
+      pfx_password: @config[:certificate][:pfx_password],
+      user_email: @config[:credentials][:email],
+      user_password: @config[:credentials][:password]
+    )
+  rescue StandardError => e
+    {
+      success: false,
+      error_message: "Authentication error: #{e.message}"
+    }
+  end
+
+  def test_get_case_list(password_hash)
+    puts "   📊 Calling GetCaseList with password hash..."
+    
+    # Use the same SOAP body structure as your working implementation
+    soap_body = build_get_case_list_soap
+
+    court_service_url = @config[:service][:court_service_url] || 
+                       "https://georgia-stage.tylertech.cloud/efm/v5/CourtRecordService.svc"
+
+    @client.call_service(
+      base_url: court_service_url,
+      password_hash: password_hash,
+      operation: 'GetCaseList',
+      soap_body: soap_body,
+      user_email: @config[:credentials][:email],
+      pfx_file: File.expand_path(@config[:certificate][:pfx_file], File.dirname(@config_path)),
+      pfx_password: @config[:certificate][:pfx_password],
+      return_json: false  # Get raw XML first for debugging
+    )
+  rescue StandardError => e
+    {
+      success: false,
+      error_message: "GetCaseList error: #{e.message}"
+    }
+  end
+
+  def build_get_case_list_soap
+    # Simple GetCaseList request - matches your working implementation pattern
+    <<~SOAP
+      <wrappers:GetCaseListRequest xmlns:wrappers="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/wrappers">
+        <wrappers:CourtLocationId>
+          <nc:IdentificationID xmlns:nc="http://niem.gov/niem/niem-core/2.0">georgia:statewide</nc:IdentificationID>
+        </wrappers:CourtLocationId>
+        <wrappers:CaseListQueryMessage>
+          <ecf:ElectronicCourtFilingQueryMessage xmlns:ecf="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/ecf">
+            <nc:DocumentIdentification xmlns:nc="http://niem.gov/niem/niem-core/2.0">
+              <nc:IdentificationID>GetCaseList-Test-#{Time.now.to_i}</nc:IdentificationID>
+            </nc:DocumentIdentification>
+            <nc:DocumentSubmitter xmlns:nc="http://niem.gov/niem/niem-core/2.0">
+              <nc:EntityRepresentation>
+                <nc:EntityPerson>
+                  <nc:PersonName>
+                    <nc:PersonFullName>Alpha Gem Tester</nc:PersonFullName>
+                  </nc:PersonName>
+                </nc:EntityPerson>
+              </nc:EntityRepresentation>
+            </nc:DocumentSubmitter>
+            <ecf:CaseListQueryCriteria>
+              <ecf:CaseParticipantRoleCode>Party</ecf:CaseParticipantRoleCode>
+            </ecf:CaseListQueryCriteria>
+          </ecf:ElectronicCourtFilingQueryMessage>
+        </wrappers:CaseListQueryMessage>
+      </wrappers:GetCaseListRequest>
+    SOAP
+  end
+end
+
+# Run the test
+begin
+  tester = AlphaGemTester.new
+  tester.run_test
+rescue Interrupt
+  puts "\n\n👋 Test interrupted by user"
+rescue StandardError => e
+  puts "\n💥 Test failed with exception: #{e.message}"
+  puts "🔍 #{e.backtrace.first}" if ENV['DEBUG']
+  exit 1
+end

data/examples/simple_examples/basic_auth.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'tyler_efm_client'
+
+# Simple authentication example using Tyler EFM Client Ruby gem
+# This is the most basic usage - just authenticate and get the password hash
+
+puts "🔐 Tyler EFM Client - Basic Authentication Example"
+puts "=" * 50
+
+# Initialize the client
+client = TylerEfmClient::Client.new
+
+# Authenticate with Tyler EFM
+begin
+  result = client.authenticate(
+    base_url: 'https://georgia-stage.tylertech.cloud/EFM/EFMUserService.svc',
+    pfx_file: 'path/to/your/certificate.pfx',
+    pfx_password: 'your_pfx_password',
+    user_email: 'your-email@domain.com',
+    user_password: 'your_password'
+  )
+
+  if result[:success]
+    puts "✅ Authentication successful!"
+    puts "👤 User: #{result[:first_name]} #{result[:last_name]}"
+    puts "📧 Email: #{result[:email]}"
+    puts "🔑 Password Hash: #{result[:password_hash]}"
+    puts "⏰ Expires: #{result[:expiration_date]}"
+  else
+    puts "❌ Authentication failed!"
+    puts "🚨 Error: #{result[:error_message]}"
+    puts "📋 Code: #{result[:error_code]}" if result[:error_code]
+  end
+
+rescue StandardError => e
+  puts "💥 Exception occurred: #{e.message}"
+  puts "🔍 Details: #{e.backtrace.first}" if ENV['DEBUG']
+end
+
+puts "\n✨ That's it! You've successfully used the Tyler EFM Client Ruby gem."

data/lib/tyler_efm_client/version.rb

@@ -2,5 +2,5 @@
 
 module TylerEfmClient
   # Current version of the Tyler EFM Client gem
-  VERSION = '1.0.0.pre.alpha.1'
+  VERSION = '1.0.0.pre.alpha.2'
 end

data/samples/court_filing_workflow/README.md

@@ -315,9 +315,9 @@ puts "Certificate subject: #{cert.certificate.subject}"
 ## 🔗 Related Documentation
 
 - [Getting Started Guide](../../docs/getting_started.md)
-- [Authentication Guide](../../docs/authentication_guide.md)
-- [API Reference](../../docs/api_reference.md)
-- [Case Management Samples](../case_management/)
+- [Main README](../../README.md)
+- [Versioning Guide](../../VERSIONING.md)
+- [Ruby Gem Documentation](https://rubygems.org/gems/tyler_efm_client)
 
 ## 📞 Support
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tyler_efm_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.1
+  version: 1.0.0.pre.alpha.2
 platform: ruby
 authors:
 - Tyler Technologies ECF Integration Team
@@ -118,12 +118,21 @@ files:
 - PUBLICATION_GUIDE.md
 - README.md
 - Rakefile
+- VERSIONING.md
 - build_gem.rb
 - config.example.json
 - docs/getting_started.md
+- examples/SETUP_AND_TEST.md
 - examples/authentication_example.rb
 - examples/complete_workflow_example.rb
 - examples/getcaselist_example.rb
+- examples/sample_application/.gitignore
+- examples/sample_application/Gemfile
+- examples/sample_application/README.md
+- examples/sample_application/config.example.json
+- examples/sample_application/sample_app.rb
+- examples/sample_application/test_with_working_config.rb
+- examples/simple_examples/basic_auth.rb
 - lib/tyler_efm_client.rb
 - lib/tyler_efm_client/client.rb
 - lib/tyler_efm_client/errors.rb