tyler_efm_client 1.0.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88d92317b5acb03095243792d00d37678bc9c661806f3a6855440df15c82edca
+  data.tar.gz: 25f07c97e2454d9277c61022951c59d45801f8831eae32493d497bf10bc2e2ef
+SHA512:
+  metadata.gz: e1b14745936b70901fbec4e485b820818a60d6e7abce4fda9fad13d41896744a814df67b7865cf40e260bcb2468e29b31d9772269f45808f18f52bc75614d4a6
+  data.tar.gz: e78fde612b7b9a5a83f9bc3a54779e6904bda9a792d85de51df54705e56467ac11ca4aa77889dc6f41e2b14b1fc71c823730d8d657604217c979601a539635ce

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# 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).
+
+## [1.0.0] - 2025-06-27
+
+### Added
+- Initial release of Tyler EFM Client Ruby SDK
+- Authentication method for Tyler EFM User Service
+- Flexible SOAP service call method for any Tyler EFM operation
+- WS-Security digital signatures (RSA-SHA1/SHA1 for Tyler compatibility)
+- Automatic PFX certificate handling
+- Support for both User Service and Court Record Service operations
+- Critical UserNameHeader implementation for Court Record Service
+- XML to JSON response conversion option
+- Comprehensive error handling with specific exception types
+- Complete example usage scripts
+- Production-ready code based on working Tyler ECF 5.0 integration
+
+### Security
+- Implements Tyler's exact security requirements:
+  - RSA-SHA1/SHA1 digital signatures (Tyler legacy requirement)
+  - Mutual TLS authentication using PFX certificates
+  - Proper WS-Security header structure
+  - UserNameHeader without namespace prefix (critical Tyler requirement)
+
+### Documentation
+- Complete API documentation
+- Usage examples for common scenarios
+- Architecture notes explaining Tyler ECF 5.0 requirements
+- Security feature documentation

data/GITHUB_SETUP.md

@@ -0,0 +1,221 @@
+# GitHub Repository Setup Guide - Ruby Gem
+
+This guide will help you set up the Ruby gem GitHub repository and configure it for automated publishing to RubyGems.
+
+## Repository Information
+
+- **Repository**: `tyler-technologies/cj-esol-efm-client-ruby`
+- **Purpose**: Ruby SDK for Tyler EFM integration
+- **Gem Name**: `tyler_efm_client`
+- **Version**: 1.0.0
+
+## Required Secrets Configuration
+
+Add this secret in GitHub Settings → Secrets and variables → Actions:
+
+### RUBYGEMS_API_KEY
+- **Get from**: https://rubygems.org/profile/edit
+- **Generate**: API key with push permissions
+- **Format**: `rubygems_abcdef123456...`
+
+## Publishing Workflow
+
+### Automated Publishing (Recommended)
+
+The repository is configured for automated publishing:
+
+1. **Create a Release Tag**:
+   ```bash
+   git tag v1.0.0
+   git push origin v1.0.0
+   ```
+
+2. **GitHub Actions Will**:
+   - Run tests across Ruby versions (2.7, 3.0, 3.1, 3.2, 3.3)
+   - Run RuboCop linting
+   - Build the gem
+   - Publish to RubyGems automatically
+
+### Manual Triggering
+
+You can also trigger publishing manually:
+1. Go to Actions tab in GitHub
+2. Select "Build and Publish Ruby Gem" workflow
+3. Click "Run workflow"
+
+## Repository Structure
+
+```
+tyler_efm_client/
+├── .github/
+│   └── workflows/
+│       └── publish.yml          # GitHub Actions workflow
+├── lib/
+│   ├── tyler_efm_client.rb      # Main entry point
+│   └── tyler_efm_client/
+│       ├── client.rb            # Main client class
+│       ├── errors.rb            # Exception classes
+│       ├── result_types.rb      # Result classes
+│       └── version.rb           # Version constant
+├── examples/
+│   ├── authentication_example.rb     # Authentication demo
+│   ├── getcaselist_example.rb        # GetCaseList demo
+│   └── complete_workflow_example.rb  # Full workflow demo
+├── .gitignore                   # Git ignore rules
+├── tyler_efm_client.gemspec     # Gem specification
+├── Gemfile                      # Bundle dependencies
+├── Rakefile                     # Build tasks
+├── README.md                    # Complete documentation
+├── LICENSE                      # MIT license
+├── CHANGELOG.md                 # Version history
+├── test_gem.rb                  # Gem functionality tests
+├── build_gem.rb                 # Local build script
+├── publish_gem.rb               # Local publish script
+└── PUBLICATION_GUIDE.md         # Manual publishing guide
+```
+
+## First Commit Commands
+
+```bash
+# In tyler_efm_client_ruby directory
+git init
+git add .
+git commit -m "Initial commit: Tyler EFM Client Ruby SDK v1.0.0
+
+🚀 Features:
+- Complete authenticate and call_service methods
+- WS-Security digital signatures (RSA-SHA1/SHA1)
+- Automatic PFX certificate handling
+- JSON/XML response support
+- Production-ready from working Tyler ECF 5.0 integration
+
+📦 Package Details:
+- Ruby 2.7+ compatibility
+- Nokogiri dependency for XML processing
+- Complete examples and documentation
+- GitHub Actions for automated publishing
+
+🔒 Security:
+- Tyler's exact ECF 5.0 requirements
+- UserNameHeader implementation for Court Record Service
+- Legacy algorithm support for Tyler compatibility
+
+💎 Generated with [Claude Code](https://claude.ai/code)
+
+Co-Authored-By: Claude <noreply@anthropic.com>"
+
+git remote add origin https://github.com/tyler-technologies/cj-esol-efm-client-ruby.git
+git branch -M main
+git push -u origin main
+
+# Create first release tag
+git tag v1.0.0
+git push origin v1.0.0
+```
+
+## Environment Setup (Optional but Recommended)
+
+For additional security, create a "release" environment:
+
+1. Go to Settings → Environments
+2. Create new environment named "release"
+3. Add protection rules:
+   - Required reviewers
+   - Restrict to protected branches
+   - Environment secrets for production tokens
+
+## Verification Steps
+
+After pushing and tagging:
+
+1. **Check GitHub Actions**:
+   - Go to Actions tab
+   - Verify "Build and Publish Ruby Gem" workflow runs successfully
+   - Check build and test results across Ruby versions
+
+2. **Verify Gem Publishing**:
+   - Check https://rubygems.org/gems/tyler_efm_client
+   - Verify gem information and documentation
+
+3. **Test Installation**:
+   ```bash
+   gem install tyler_efm_client
+   
+   # Test in Ruby console
+   irb
+   require 'tyler_efm_client'
+   client = TylerEfmClient::Client.new
+   # Should work without errors
+   ```
+
+## Branch Protection (Recommended)
+
+Set up branch protection for main branch:
+1. Settings → Branches → Add rule
+2. Branch name pattern: `main`
+3. Enable:
+   - Require pull request reviews
+   - Require status checks to pass
+   - Include administrators
+
+## Local Development Commands
+
+For local development and testing:
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests
+ruby test_gem.rb
+
+# Build gem locally
+ruby build_gem.rb
+
+# Publish manually (if needed)
+ruby publish_gem.rb
+```
+
+## Version Management
+
+To release a new version:
+
+1. Update version in `lib/tyler_efm_client/version.rb`
+2. Update `CHANGELOG.md` with new changes
+3. Commit changes
+4. Create and push new tag:
+   ```bash
+   git tag v1.1.0
+   git push origin v1.1.0
+   ```
+
+## Troubleshooting
+
+### Common Issues:
+
+1. **RUBYGEMS_API_KEY not found**: 
+   - Verify secret name matches exactly
+   - Check secret is set in repository settings
+
+2. **Permission denied on RubyGems**:
+   - Check API key has push permissions
+   - Verify gem name is available on RubyGems.org
+
+3. **Build failures**:
+   - Review logs in Actions tab
+   - Check Ruby version compatibility
+   - Verify all dependencies are correct
+
+4. **Gem already exists**:
+   - RubyGems.org doesn't allow overwriting versions
+   - Increment version number for new releases
+
+### Getting Help:
+
+- RubyGems guides: https://guides.rubygems.org/publishing/
+- GitHub Actions docs: https://docs.github.com/en/actions
+- Bundler documentation: https://bundler.io/
+
+---
+
+**Ready to publish your Ruby gem!** 💎

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tyler_efm_client.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'yard', '~> 0.9'
+gem 'rubocop', '~> 1.21'

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tyler Technologies, Inc.
+
+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.

data/PUBLICATION_GUIDE.md

@@ -0,0 +1,146 @@
+# Tyler EFM Client - Ruby Gem Publication Guide
+
+This guide will help you publish the Tyler EFM Client Ruby gem to RubyGems.org.
+
+## Prerequisites
+
+1. **RubyGems.org Account**: Create account at https://rubygems.org/sign_up
+2. **Email Verification**: Verify your email address
+3. **API Access**: Set up API key for gem publishing
+
+## Publication Steps
+
+### 1. Set Up RubyGems.org Credentials
+
+After creating your account, set up API access:
+
+```bash
+gem signin
+```
+
+This will prompt for your RubyGems.org credentials and create an API key.
+
+### 2. Run Publication Script
+
+The automated publication script handles all steps:
+
+```bash
+./publish_gem.rb
+```
+
+**What the script does:**
+- ✅ Cleans previous build artifacts
+- ✅ Runs pre-publication checks
+- ✅ Installs dependencies with `bundle install`
+- ✅ Builds the gem with `gem build`
+- ✅ Verifies gem structure and metadata
+- ✅ Runs final tests to ensure quality
+- ✅ Prompts for confirmation before publishing
+- ✅ Publishes to RubyGems.org with `gem push`
+
+### 3. Manual Publication (Alternative)
+
+If you prefer manual steps:
+
+```bash
+# Clean and build
+rm -f *.gem Gemfile.lock
+bundle install
+gem build tyler_efm_client.gemspec
+
+# Verify
+gem specification tyler_efm_client-1.0.0.gem
+ruby test_gem.rb
+
+# Publish
+gem push tyler_efm_client-1.0.0.gem
+```
+
+## Verification
+
+After publication, verify your gem:
+
+1. **Visit gem page**: https://rubygems.org/gems/tyler_efm_client
+2. **Test installation**: `gem install tyler_efm_client`
+3. **Test functionality**: Run examples to ensure everything works
+
+## Gem Information
+
+- **Name**: `tyler_efm_client`
+- **Version**: `1.0.0`
+- **Description**: Ruby SDK for Tyler Technologies Electronic Filing Manager (EFM) Services
+- **License**: MIT
+- **Ruby Version**: >= 2.7.0
+
+## Package Contents
+
+The published gem includes:
+
+```
+📦 tyler_efm_client-1.0.0.gem
+├── lib/
+│   ├── tyler_efm_client.rb           # Main entry point
+│   └── tyler_efm_client/
+│       ├── client.rb                 # Main client class
+│       ├── errors.rb                 # Exception classes
+│       ├── result_types.rb           # Result classes
+│       └── version.rb                # Version constant
+├── examples/
+│   ├── authentication_example.rb     # Authentication demo
+│   ├── getcaselist_example.rb        # GetCaseList demo
+│   └── complete_workflow_example.rb  # Full workflow demo
+├── README.md                         # Complete documentation
+├── LICENSE                           # MIT license
+├── CHANGELOG.md                      # Version history
+└── tyler_efm_client.gemspec         # Gem specification
+```
+
+## Post-Publication
+
+After successful publication:
+
+1. **Update Documentation**: Update any references to point to the published gem
+2. **Announce**: Notify team members and stakeholders
+3. **Monitor**: Watch for issues or feedback from users
+4. **Maintain**: Plan for future versions and updates
+
+## Troubleshooting
+
+### Common Issues
+
+**Authentication Error**:
+```
+ERROR: While executing gem ... (Gem::RemoteFetcher::FetchError)
+```
+**Solution**: Run `gem signin` to authenticate with RubyGems.org
+
+**Version Conflict**:
+```
+ERROR: There was a problem saving the gem: Name has already been taken
+```
+**Solution**: The gem name exists. Contact RubyGems.org support if you own the name.
+
+**Build Errors**:
+```
+ERROR: While executing gem ... (NoMethodError)
+```
+**Solution**: Check gemspec syntax and ensure all files exist.
+
+### Getting Help
+
+- **RubyGems.org Help**: https://guides.rubygems.org/publishing/
+- **Tyler Support**: Contact ECF integration team for Tyler-specific issues
+- **Gem Issues**: Check gem specification and file structure
+
+## Success Criteria
+
+Your gem is successfully published when:
+
+- ✅ Gem appears on https://rubygems.org/gems/tyler_efm_client
+- ✅ `gem install tyler_efm_client` works from any machine
+- ✅ Examples run successfully after installation
+- ✅ All tests pass on fresh installation
+
+---
+
+**Ready to publish? Run `./publish_gem.rb` to get started!** 🚀