(Ruby) GeoOp - Export Clients to CSV

Export client data to a CSV.

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

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# This example also assumes an OAuth2 access token was previously fetched.
# and saved in a JSON file.  

# First get our previously obtained access token.
# {"access_token":"e6dqdG....mzjpT04w==","token_type":"Bearer","expires_in":2592000,"owner_id":999236}
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/geoop.json")

# This example assumes we previously obtained an access token
oauth2 = Chilkat::CkOAuth2.new()
oauth2.put_AccessToken(jsonToken.stringOf("access_token"))

rest = Chilkat::CkRest.new()

# Connect to GeoOp and send the following GET request:

# GET /users HTTP/1.1
# Host: api.geoop.com
bAutoReconnect = true
success = rest.Connect("api.geoop.com",443,true,bAutoReconnect)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

# Provide the authentication credentials (i.e. the access token)
rest.SetAuthOAuth2(oauth2)

# Set the X-Version header.
rest.AddHeader("X-Version","1.0")

responseBody = rest.fullRequestNoBody("GET","/clients")
if (rest.get_LastMethodSuccess() != true)
    print rest.lastErrorText() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)

# If the response status code did not indicate success, then see what happened..
if (rest.get_ResponseStatusCode() != 200)
    print "Request Header: " + "\n";
    print rest.lastRequestHeader() + "\n";
    print "----" + "\n";
    print "Response StatusCode = " + rest.get_ResponseStatusCode().to_s() + "\n";
    print "Response StatusLine: " + rest.responseStatusText() + "\n";
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    json.Load(responseBody)
    print json.emit() + "\n";
    exit
end

json.Load(responseBody)
# Show the full JSON response.. (see below)
print json.emit() + "\n";
print "---" + "\n";

csv = Chilkat::CkCsv.new()
csv.put_HasColumnNames(true)
csv.SetColumnName(0,"id")
csv.SetColumnName(1,"companyName")
csv.SetColumnName(2,"businessType")
csv.SetColumnName(3,"account_id")
csv.SetColumnName(4,"address_line1")
csv.SetColumnName(5,"address_city")
csv.SetColumnName(6,"address_postcode")

# Iterate over each client and populate the CSV...
numRecords = json.SizeOfArray("clients")
i = 0
while i < numRecords

    json.put_I(i)
    csv.SetCellByName(i,"id",json.stringOf("clients[i].id"))
    csv.SetCellByName(i,"companyName",json.stringOf("clients[i].companyName"))
    csv.SetCellByName(i,"businessType",json.stringOf("clients[i].businessType"))
    csv.SetCellByName(i,"account_id",json.stringOf("clients[i].account.id"))
    csv.SetCellByName(i,"address_line1",json.stringOf("clients[i].address.line1"))
    csv.SetCellByName(i,"address_city",json.stringOf("clients[i].address.city"))
    csv.SetCellByName(i,"address_postcode",json.stringOf("clients[i].address.postcode"))
    i = i + 1
end

# Show the CSV.
print csv.saveToString() + "\n";

# Save the CSV.
csv.SaveFile("qa_output/clients.csv")

# ---------------------------------------------------------------------
# The full JSON response containing all client data:
# 
# 	{
# 	  "result": "success",
# 	  "clients": [
# 	    {
# 	      "id": 9555868,
# 	      "firstName": "[ Demo",
# 	      "lastName": "Client ]",
# 	      "companyName": "Miller Park Cafe",
# 	      "businessType": "Licensed Restaurant",
# 	      "leadSource": "",
# 	      "emailAddress": null,
# 	      "phoneNumber": null,
# 	      "mobileNumber": null,
# 	      "faxNumber": null,
# 	      "notes": "",
# 	      "deleted": false,
# 	      "hasRecentJobs": true,
# 	      "created": "2016-10-26T12:05:09+00:00",
# 	      "modified": "2016-10-26T12:05:09+00:00",
# 	      "billingClient": null,
# 	      "account": {
# 	        "id": 39409
# 	      },
# 	      "address": {
# 	        "line1": "1732 Pennsylvania Avenue NW",
# 	        "line2": "",
# 	        "city": "Washington",
# 	        "postcode": "20006",
# 	        "latitude": 38.899037,
# 	        "longitude": -77.040207
# 	      },
# 	      "mailingAddress": {}
# 	    },
# 	    {
# 	      "id": 9571176,
# 	      "firstName": "Mildred",
# 	      "lastName": "Vanildred",
# 	      "companyName": "Ice Cream Industries",
# 	      "businessType": "Ice Cream",
# 	      "leadSource": null,
# 	      "emailAddress": "milli@icecreamindustries.com",
# 	      "phoneNumber": "678-555-1012",
# 	      "mobileNumber": null,
# 	      "faxNumber": null,
# 	      "notes": "",
# 	      "deleted": false,
# 	      "hasRecentJobs": true,
# 	      "created": "2016-10-31T12:32:12+00:00",
# 	      "modified": "2016-10-31T12:32:13+00:00",
# 	      "billingClient": null,
# 	      "account": {
# 	        "id": 39409
# 	      },
# 	      "address": {
# 	        "line1": "2101 West Roosevelt Road",
# 	        "line2": null,
# 	        "city": "Wheaton",
# 	        "postcode": "60187",
# 	        "latitude": 41.8581778,
# 	        "longitude": -88.1380111
# 	      },
# 	      "mailingAddress": {
# 	        "line1": "2101 West Roosevelt Road",
# 	        "line2": null,
# 	        "city": "Wheaton"
# 	      }
# 	    },
# 	    {
# 	      "id": 9571218,
# 	      "firstName": "Joe",
# 	      "lastName": "Miller",
# 	      "companyName": "Miller Bakery",
# 	      "businessType": "Licensed Bakery",
# 	      "leadSource": "",
# 	      "emailAddress": null,
# 	      "phoneNumber": null,
# 	      "mobileNumber": null,
# 	      "faxNumber": null,
# 	      "notes": "",
# 	      "deleted": false,
# 	      "hasRecentJobs": true,
# 	      "created": "2016-10-31T13:02:07+00:00",
# 	      "modified": "2016-10-31T13:02:07+00:00",
# 	      "billingClient": null,
# 	      "account": {
# 	        "id": 39409
# 	      },
# 	      "address": {
# 	        "line1": "1832 Pennsylvania Avenue NW",
# 	        "line2": "",
# 	        "city": "Washington",
# 	        "postcode": "20006",
# 	        "latitude": 0,
# 	        "longitude": 0
# 	      },
# 	      "mailingAddress": {
# 	        "line1": "",
# 	        "line2": "",
# 	        "city": ""
# 	      }
# 	    }
# 	  ],
# 	  "metadata": {
# 	    "page": 1,
# 	    "pagesCount": 1,
# 	    "recordsPerPage": 20,
# 	    "recordsCount": 3
# 	  }
# 	}
#