tyler_efm_client 1.0.0.pre.alpha.1

data/examples/authentication_example.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/tyler_efm_client'
+
+##
+# Tyler EFM Client - Authentication Example
+#
+# This example demonstrates how to authenticate with Tyler EFM services
+# using the tyler_efm_client gem.
+def main
+  puts 'Tyler EFM Client - Authentication Example'
+  puts '=' * 50
+
+  # Initialize the client
+  client = TylerEfmClient::Client.new
+
+  # Configuration - REPLACE WITH YOUR ACTUAL VALUES
+  base_url = 'https://georgia-stage.tylertech.cloud/EFM/EFMUserService.svc'
+  pfx_file = 'path/to/your/certificate.pfx'  # Path to your PFX certificate
+  pfx_password = 'your-pfx-password'         # PFX certificate password
+  user_email = 'your-email@example.com'     # Your EFM user email
+  user_password = 'your-password'           # Your EFM user password
+
+  begin
+    puts '🔐 Authenticating with Tyler EFM...'
+
+    # Authenticate
+    auth_result = client.authenticate(
+      base_url: base_url,
+      pfx_file: pfx_file,
+      pfx_password: pfx_password,
+      user_email: user_email,
+      user_password: user_password
+    )
+
+    if auth_result.success?
+      puts '✅ Authentication successful!'
+      puts "   Password Hash: #{auth_result.password_hash}"
+      puts "   User ID: #{auth_result.user_id}"
+      puts "   Name: #{auth_result.first_name} #{auth_result.last_name}"
+      puts "   Email: #{auth_result.email}"
+      puts "   Expires: #{auth_result.expiration_date}"
+
+      # Store the password hash for subsequent service calls
+      password_hash = auth_result.password_hash
+      puts "\n💡 Save this password hash for service calls: #{password_hash}"
+
+    else
+      puts '❌ Authentication failed!'
+      puts "   Error Code: #{auth_result.error_code}"
+      puts "   Error Message: #{auth_result.error_message}"
+    end
+
+  rescue TylerEfmClient::AuthenticationError => e
+    puts "❌ Authentication error: #{e.message}"
+  rescue TylerEfmClient::Error => e
+    puts "❌ EFM client error: #{e.message}"
+  rescue StandardError => e
+    puts "❌ Unexpected error: #{e.message}"
+  end
+end
+
+main if __FILE__ == $0

data/examples/complete_workflow_example.rb

@@ -0,0 +1,149 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/tyler_efm_client'
+
+##
+# Tyler EFM Client - Complete Workflow Example
+#
+# This example demonstrates a complete workflow:
+# 1. Authentication
+# 2. GetCaseList operation  
+# 3. Multiple service calls with the same client
+def main
+  puts 'Tyler EFM Client - Complete Workflow Example'
+  puts '=' * 60
+
+  # Configuration - REPLACE WITH YOUR ACTUAL VALUES
+  config = {
+    user_service_url: 'https://georgia-stage.tylertech.cloud/EFM/EFMUserService.svc',
+    court_service_url: 'https://georgia-stage.tylertech.cloud/efm/v5/CourtRecordService.svc',
+    pfx_file: 'path/to/your/certificate.pfx',
+    pfx_password: 'your-pfx-password',
+    user_email: 'your-email@example.com',
+    user_password: 'your-password'
+  }
+
+  # Initialize the client (reuse for multiple operations)
+  client = TylerEfmClient::Client.new
+
+  begin
+    # Step 1: Authentication
+    puts '🔐 Step 1: Authenticating with Tyler EFM...'
+
+    auth_result = client.authenticate(
+      base_url: config[:user_service_url],
+      pfx_file: config[:pfx_file],
+      pfx_password: config[:pfx_password],
+      user_email: config[:user_email],
+      user_password: config[:user_password]
+    )
+
+    unless auth_result.success?
+      puts "❌ Authentication failed: #{auth_result.error_message}"
+      return
+    end
+
+    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: GetCaseList Operation
+    puts "\n📋 Step 2: Getting case list..."
+
+    case_list_body = <<~SOAP
+      <wrappers:GetCaseListRequest xmlns:wrappers="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/wrappers">
+          <caselistrequest:GetCaseListRequestMessage 
+              xmlns:caselistrequest="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/caselistrequest"
+              xmlns:j="http://release.niem.gov/niem/domains/jxdm/6.1/"
+              xmlns:nc="http://release.niem.gov/niem/niem-core/4.0/"
+              xmlns:tylercommon="urn:tyler:ecf:v5.0:extensions:common"
+              xmlns:ecf="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/ecf">
+              
+              <nc:DocumentIdentification/>
+              <ecf:SendingMDELocationID>
+                  <nc:IdentificationID>https://filingassemblymde.com</nc:IdentificationID>
+              </ecf:SendingMDELocationID>
+              <ecf:ServiceInteractionProfileCode>urn:oasis:names:tc:legalxml-courtfiling:schema:xsd:WebServicesMessaging-5.0</ecf:ServiceInteractionProfileCode>
+              <j:CaseCourt>
+                  <nc:OrganizationIdentification>
+                      <nc:IdentificationID>fulton:mag</nc:IdentificationID>
+                  </nc:OrganizationIdentification>
+              </j:CaseCourt>
+              <nc:DocumentPostDate>
+                  <nc:DateTime>2025-06-27T20:00:00.000000Z</nc:DateTime>
+              </nc:DocumentPostDate>
+              <caselistrequest:CaseListQueryCriteria>
+                  <tylercommon:CaseListQueryCriteriaAugmentation>
+                      <j:CaseNumberText>23MPF011258</j:CaseNumberText>
+                  </tylercommon:CaseListQueryCriteriaAugmentation>
+              </caselistrequest:CaseListQueryCriteria>
+          </caselistrequest:GetCaseListRequestMessage>
+      </wrappers:GetCaseListRequest>
+    SOAP
+
+    response = client.call_service(
+      base_url: config[:court_service_url],
+      password_hash: auth_result.password_hash,
+      operation: 'GetCaseList',
+      soap_body: case_list_body,
+      user_email: config[:user_email],
+      return_json: false  # Get raw XML this time
+    )
+
+    if response.success?
+      puts '✅ GetCaseList successful!'
+      puts "   Response length: #{response.raw_xml.length} characters"
+
+      # Quick case extraction from XML
+      if response.raw_xml.include?('CaseNumberText')
+        puts '   📁 Found case data in response'
+      else
+        puts '   ⚠️ No case data found'
+      end
+    else
+      puts "❌ GetCaseList failed: HTTP #{response.status_code}"
+    end
+
+    # Step 3: Demonstrate multiple calls with same client
+    puts "\n🔄 Step 3: Making another call with same client..."
+
+    # You can make multiple calls without re-authenticating
+    # The client retains the certificate and can be reused
+
+    # Example: Call a User Service operation
+    user_service_body = <<~SOAP
+      <tns:GetUser xmlns:tns="urn:tyler:efm:services">
+          <tns:GetUserRequest>
+              <UserID xmlns="urn:tyler:efm:services:schema:GetUserRequest">#{auth_result.user_id}</UserID>
+          </tns:GetUserRequest>
+      </tns:GetUser>
+    SOAP
+
+    user_response = client.call_service(
+      base_url: config[:user_service_url],
+      password_hash: auth_result.password_hash,
+      operation: 'GetUser',
+      soap_body: user_service_body
+    )
+
+    if user_response.success?
+      puts '✅ GetUser call successful!'
+    else
+      puts "ℹ️ GetUser call: HTTP #{user_response.status_code} (expected - may need different parameters)"
+    end
+
+    puts "\n🎉 Workflow completed successfully!"
+    puts '   Total operations: Authentication + 2 service calls'
+    puts '   Client reused: ✅'
+    puts '   Certificate handling: Automatic'
+
+  rescue TylerEfmClient::Error => e
+    puts "❌ EFM client error: #{e.message}"
+  rescue StandardError => e
+    puts "❌ Unexpected error: #{e.message}"
+  end
+end
+
+main if __FILE__ == $0

data/examples/getcaselist_example.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/tyler_efm_client'
+
+##
+# Tyler EFM Client - GetCaseList Example
+#
+# This example demonstrates how to call the GetCaseList operation
+# using the tyler_efm_client gem.
+def main
+  puts 'Tyler EFM Client - GetCaseList Example'
+  puts '=' * 50
+
+  # Initialize the client
+  client = TylerEfmClient::Client.new
+
+  # Configuration - REPLACE WITH YOUR ACTUAL VALUES
+  user_service_url = 'https://georgia-stage.tylertech.cloud/EFM/EFMUserService.svc'
+  court_service_url = 'https://georgia-stage.tylertech.cloud/efm/v5/CourtRecordService.svc'
+  pfx_file = 'path/to/your/certificate.pfx'
+  pfx_password = 'your-pfx-password'
+  user_email = 'your-email@example.com'
+  user_password = 'your-password'
+  case_number = '23MPF011258'  # Example case number
+
+  begin
+    puts '🔐 Step 1: Authenticating...'
+
+    # First, authenticate to get password hash
+    auth_result = client.authenticate(
+      base_url: user_service_url,
+      pfx_file: pfx_file,
+      pfx_password: pfx_password,
+      user_email: user_email,
+      user_password: user_password
+    )
+
+    unless auth_result.success?
+      puts "❌ Authentication failed: #{auth_result.error_message}"
+      return
+    end
+
+    puts "✅ Authentication successful! Password hash: #{auth_result.password_hash}"
+
+    puts "\n📋 Step 2: Building GetCaseList request..."
+
+    # Build GetCaseList SOAP body
+    soap_body = <<~SOAP
+      <wrappers:GetCaseListRequest xmlns:wrappers="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/wrappers">
+          <caselistrequest:GetCaseListRequestMessage 
+              xmlns:caselistrequest="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/caselistrequest"
+              xmlns:j="http://release.niem.gov/niem/domains/jxdm/6.1/"
+              xmlns:nc="http://release.niem.gov/niem/niem-core/4.0/"
+              xmlns:tylercommon="urn:tyler:ecf:v5.0:extensions:common"
+              xmlns:ecf="https://docs.oasis-open.org/legalxml-courtfiling/ns/v5.0/ecf">
+              
+              <nc:DocumentIdentification/>
+              
+              <ecf:SendingMDELocationID>
+                  <nc:IdentificationID>https://filingassemblymde.com</nc:IdentificationID>
+              </ecf:SendingMDELocationID>
+              
+              <ecf:ServiceInteractionProfileCode>urn:oasis:names:tc:legalxml-courtfiling:schema:xsd:WebServicesMessaging-5.0</ecf:ServiceInteractionProfileCode>
+              
+              <j:CaseCourt>
+                  <nc:OrganizationIdentification>
+                      <nc:IdentificationID>fulton:mag</nc:IdentificationID>
+                  </nc:OrganizationIdentification>
+              </j:CaseCourt>
+              
+              <nc:DocumentPostDate>
+                  <nc:DateTime>2025-06-27T20:00:00.000000Z</nc:DateTime>
+              </nc:DocumentPostDate>
+              
+              <caselistrequest:CaseListQueryCriteria>
+                  <tylercommon:CaseListQueryCriteriaAugmentation>
+                      <j:CaseNumberText>#{case_number}</j:CaseNumberText>
+                  </tylercommon:CaseListQueryCriteriaAugmentation>
+              </caselistrequest:CaseListQueryCriteria>
+              
+          </caselistrequest:GetCaseListRequestMessage>
+      </wrappers:GetCaseListRequest>
+    SOAP
+
+    puts '📤 Step 3: Calling GetCaseList service...'
+
+    # Call GetCaseList service
+    response = client.call_service(
+      base_url: court_service_url,
+      password_hash: auth_result.password_hash,
+      operation: 'GetCaseList',
+      soap_body: soap_body,
+      user_email: user_email,
+      return_json: true  # Get JSON response for easier parsing
+    )
+
+    if response.success?
+      puts '✅ GetCaseList call successful!'
+
+      if response.json_data
+        puts "\n🎯 JSON Response Summary:"
+        # Navigate the JSON structure to find cases
+        begin
+          envelope = response.json_data
+          body = envelope['Body'] || {}
+          case_list_response = body['GetCaseListResponse'] || {}
+          message = case_list_response['GetCaseListResponseMessage'] || {}
+          cases = message['Case'] || []
+
+          cases = [cases] unless cases.is_a?(Array)  # Single case
+
+          puts "   Found #{cases.length} case(s):"
+          cases.each_with_index do |case_data, index|
+            case_number = case_data.dig('CaseAugmentation', 'CaseNumberText') || 'N/A'
+            case_title = case_data['CaseTitleText'] || 'N/A'
+            puts "     #{index + 1}. Case: #{case_number}"
+            puts "        Title: #{case_title}"
+          end
+
+        rescue StandardError => parse_error
+          puts "   JSON parsing note: #{parse_error.message}"
+          puts '   (Raw response available in response.raw_xml)'
+        end
+      end
+
+      puts "\n📄 Raw XML Response Length: #{response.raw_xml.length} characters"
+
+    else
+      puts "❌ GetCaseList call failed: HTTP #{response.status_code}"
+      puts "   Error: #{response.error_message}" if response.error_message
+      puts "   Response preview: #{response.raw_xml[0..499]}#{'...' if response.raw_xml.length > 500}"
+    end
+
+  rescue TylerEfmClient::Error => e
+    puts "❌ EFM client error: #{e.message}"
+  rescue StandardError => e
+    puts "❌ Unexpected error: #{e.message}"
+  end
+end
+
+main if __FILE__ == $0