(Ruby) Creating an application/json HTTP POST Request

Demonstrates how to create an HTTP POST request having the Content-Type application/json, where the body of the HTTP request is the following JSON:

{
   "username" : "my_username",
   "password" : "my_password",
   "validation-factors" : {
      "validationFactors" : [
         {
            "name" : "remote_address",
            "value" : "127.0.0.1"
         }
      ]
   }
}

The generated HTTP request looks like this:

POST /something HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: domain
Content-Length: 216

{
  "username": "my_username",
  "password": "my_password",
  "validation-factors": {
    "validationFactors": [
      {
        "name": "remote_address",
        "value": "127.0.0.1"
      }
    ]
  }
}

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This example demonstrates building an application/json request.

req = Chilkat::CkHttpRequest.new()

# The ContentType, HttpVerb, and Path properties should
# always be explicitly set.
req.put_HttpVerb("POST")
req.put_Path("/something")
req.put_ContentType("application/json")

# We may wish to add an "Accept" header to the request.
# This tells the server we'll accept an application/json response.
req.AddHeader("Accept","application/json")

# We'll use Chilkat's JSON API to create the JSON body of the HTTP request.
json = Chilkat::CkJsonObject.new()
json.AppendString("username","my_username")
json.AppendString("password","my_password")
# vFactors is a CkJsonObject
vFactors = json.AppendObject("validation-factors")
# vArray is a CkJsonArray
vArray = vFactors.AppendArray("validationFactors")
vArray.AddObjectAt(0)
# factorObj is a CkJsonObject
factorObj = vArray.ObjectAt(0)
factorObj.AppendString("name","remote_address")
factorObj.AppendString("value","127.0.0.1")

# Use the JSON for the HTTP request body
# By default, the Emit method will output compact JSON.
# This is best for generating the smallest size request.
# To generate a more human-readable (pretty-printed) JSON request body,
# set the EmitCompact property to FALSE
json.put_EmitCompact(false)
req.LoadBodyFromString(json.emit(),"utf-8")

# View the request that would be sent if SynchronousRequest was called:
requestMime = req.generateRequestText()
print requestMime + "\n";

# A few important comments about the HTTP request that is generated:
# 
# 1) The Content-Length header is automatically generated based on the actual length of the MIME message
#    that follows the intial (topmost) MIME header.
# 2) The HOST header will automatically get filled in with the actual domain when SynchronousRequest
#    is called