Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Ruby Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Ruby) Using Pre-defined JSON Templates

Demonstrates how to predefine a JSON template, and then use it to emit JSON with variable substitutions.

Note: This example requires Chilkat v9.5.0.67 or greater.

Chilkat Ruby Downloads

Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# One way to create JSON is to do it in a straightforward manner:
json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)
json.UpdateString("id","0001")
json.UpdateString("type","donut")
json.UpdateString("name","Cake")
json.UpdateString("image.url","images/0001.jpg")
json.UpdateInt("image.width",200)
json.UpdateInt("image.height",200)
json.UpdateString("thumbnail.url","images/thumbnails/0001.jpg")
json.UpdateInt("thumbnail.width",32)
json.UpdateInt("thumbnail.height",32)
print json.emit() + "\n";

# The JSON created by the above code:

# 	{ 
# 	  "id": "0001",
# 	  "type": "donut",
# 	  "name": "Cake",
# 	  "image": { 
# 	    "url": "images/0001.jpg",
# 	    "width": 200,
# 	    "height": 200
# 	  },
# 	  "thumbnail": { 
# 	    "url": "images/thumbnails/0001.jpg",
# 	    "width": 32,
# 	    "height": 32
# 	  }
# 	}

# An alternative is to predefine a template, and then use it to emit with variable substitutions.
# For example:

jsonTemplate = Chilkat::CkJsonObject.new()
jsonTemplate.UpdateString("id","{$id}")
jsonTemplate.UpdateString("type","donut")
jsonTemplate.UpdateString("name","{$name}")
jsonTemplate.UpdateString("image.url","{$imageUrl}")
# The "i." indicates that it's an integer variable.
jsonTemplate.UpdateString("image.width","{$i.imageWidth}")
jsonTemplate.UpdateString("image.height","{$i.imageHeight}")
jsonTemplate.UpdateString("thumbnail.url","{$thumbUrl}")
jsonTemplate.UpdateString("thumbnail.width","{$i.thumbWidth}")
jsonTemplate.UpdateString("thumbnail.height","{$i.thumbHeight}")
# Give this template a name.
jsonTemplate.Predefine("donut")

# --------------------------------------------------------------------------
# OK, the template is defined.  Defining a template can be done once
# at the start of your program, and you can discard the jsonTemplate object (it
# doesn't need to stick around..)

# Now we can create instances of the JSON object by name:
jsonDonut = Chilkat::CkJsonObject.new()
jsonDonut.put_EmitCompact(false)
jsonDonut.LoadPredefined("donut")
print jsonDonut.emit() + "\n";

# The output is this:

# 	{ 
# 	  "id": "{$id}",
# 	  "type": "donut",
# 	  "name": "{$name}",
# 	  "image": { 
# 	    "url": "{$imageUrl}",
# 	    "width": "{$i.imageWidth}",
# 	    "height": "{$i.imageHeight}"
# 	  },
# 	  "thumbnail": { 
# 	    "url": "{$thumbUrl}",
# 	    "width": "{$i.thumbWidth}",
# 	    "height": "{$i.thumbHeight}"
# 	  }
# 	}

# Finally, we can substitute variables like this:
donutValues = Chilkat::CkHashtable.new()
donutValues.AddStr("id","0001")
donutValues.AddStr("name","Cake")
donutValues.AddStr("imageUrl","images/0001.jpg")
donutValues.AddInt("imageWidth",200)
donutValues.AddInt("imageHeight",200)
donutValues.AddStr("thumbUrl","images/thumbnails/0001.jpg")
donutValues.AddInt("thumbWidth",32)
donutValues.AddInt("thumbHeight",32)

# Emit with variable substitutions:
omitEmpty = true
print jsonDonut.emitWithSubs(donutValues,omitEmpty) + "\n";

# Output:

# 	{ 
# 	  "id": "0001",
# 	  "type": "donut",
# 	  "name": "Cake",
# 	  "image": { 
# 	    "url": "images/0001.jpg",
# 	    "width": 200,
# 	    "height": 200
# 	  },
# 	  "thumbnail": { 
# 	    "url": "images/thumbnails/0001.jpg",
# 	    "width": 32,
# 	    "height": 32
# 	  }
# 	}

# Change some of the values:
donutValues.AddStr("id","0002")
donutValues.AddStr("imageUrl","images/0002.jpg")
donutValues.AddStr("thumbUrl","images/thumbnails/0002.jpg")

print jsonDonut.emitWithSubs(donutValues,omitEmpty) + "\n";

# Output:

# 	{ 
# 	  "id": "0002",
# 	  "type": "donut",
# 	  "name": "Cake",
# 	  "image": { 
# 	    "url": "images/0002.jpg",
# 	    "width": 200,
# 	    "height": 200
# 	  },
# 	  "thumbnail": { 
# 	    "url": "images/thumbnails/0002.jpg",
# 	    "width": 32,
# 	    "height": 32
# 	  }
# 	}

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.