Page Comparison

Need some help? Contact us:

...

The SHELL adapter library is just intended to something you copy and rename and make it into a real adapter for a real system. It has all the boiler plate you need. I made it because I wanted to try to build a few adapters to Solve the calendar management problem.

...

The shell adapter ships with Iguana just add the Shell Example - see Create a Component .

So how do we use it say Let’s use the Shell Adapter to create an Atlassian adapter .using the Atlassian APIs:

Expand

title	A good adapter is a library showing how to connect to a system

In Iguana XIguanaX, an open system, we provide adapters as libraries to connect with various applications. These adapters are intentionally designed to be simple and intuitive, making them easily extendable by users to meet their specific needs. This approach contrasts with the complexity often found in open-source projects and the rigidness of complete platforms like Zapier. Iguana's inclusive environment, featuring a Translator, logging, queuing system, and dashboard, though convenient, requires users to invest effort in learning. Our goal is to empower users with adaptable tools, understanding that no adapter can be universally complete.

See:

...

Implementation Approach:

Expand

title	STEP 1: Start with a copy of new Custom component

Let’s use a copy of new Custom component (Create a Component ) and name it ‘Confluence adapter’

Expand

title	STEP 2: Import the SHELL library and associate it with a new repo

Let’s say git@bitbucket.org:interfaceware/atlassian ( - see Create a library

Expand

title	STEP 3: Rename the SHELL Library folder and all the files in it to a new prefix

For instanceRename the Library Folders and Files to use a new prefix. For example:

Image Modified

This gets

Expand

title	STEP 4: Search and replace SHELL for ATTL in the project

to replace all the prefixes in the scripts

Use Project Search and Replace to replace all the prefixes consistentused within scripts on all files in the project.

Add this project

Expand

title	Make sure STEP 5: Provide the ATTLclient function gets all the parameters needed to authenticate

title

Code Block

language	lua

function ATTLclient(T)
   local S= {}
   setmetatable(S, MT)
   S.key = T.key
   return S
end

So in In the case of Atlassian we need:

user - I.e. fred.smith@interfaceware.com
space - i.e. ABC for a Confluence space that has this ID
key - A unique personal API key for a confluence user
organization - to construct base URL to our Confluence space, e.g. https://acme.atalassian.net

This adheres with Naming convention for table parameters in Iguana.

These should just be passed through in the table arguments. So the code becomes:

Code Block

language	lua

function ATTLclient(T)
   local S= {}
   setmetatable(S, MT)
   S.key           = T.key
   S.space         = T.space
   S.user          = T.user
   S.organization  = T.organization
   return S
end

Expand

Now we need to add the API access key to

the project as a Custom Fields. The API access key needs to be treated as password. Thus we create in config.json a custom field named ‘key' of type 'Password’ and store in it the personal Atlassian API access key, respective to the user name in use.

Expand

title	STEP 6: Implement a good custom method

The custom method should do most is the guts of the adapter - handling most of the API call logic. Most web APIs have some magic sauce that you have to make an API call. The custom method does this and should make it easy to call methods on the API which have not been wrapped explicitly.

Let’s call our new Custom custom method ATTLdescendants. We can rename ATTLhello into ATTLdescendants and to rewrite its content.

This method will help us to invoke the API method ATTLgetDescendants.

Expand

title	STEP 7: Implement a good API method

Let’s call our new API method ATTLgetDescendants. We can rename ATTLcustom into ATTLgetDescendants and to rewrite its content.

This method will returns return all pages in a space.

Expand

title	More about API methods

Sometimes Now, sometimes an API method would require a parameter which can be discovered only programmatically. In our example of Confluence Adapter this is Confluence Space Id parameter, which isn’t the same as a Space Key above.

The API method ATTLgetSpaceId will help us to discover this value. Let’s create new Lua file, name it ATTLgetSpaceId and write its content.

Expand

title	STEP 8: Update the Client Constructor

Append to the Client’s meta table, the three newly added methods and the ‘space_id’ variable declaration.

Code Block

local MT={}

MT.__index = {}
MT.__index.descendants     = require 'ATTL.ATTLdescendants'
MT.__index.getSpaceId      = require 'ATTL.ATTLgetSpaceId'
MT.__index.getDescendants  = require 'ATTL.ATTLgetDescendants'

help.map{dir='ATTL/help',methods=MT.__index}

function ATTLclient(T)
   local S= {}
   setmetatable(S, MT)
   S.key           = T.key
   S.space         = T.space
   S.user          = T.user
   S.organization  = T.organization
   S.space_id      = T.space_id
   return S
end

Expand

title	Not to forget the STEP 9: Create your own Help files!

Add Help files Files (*.help) to explain what parameters the methods expect. Other users will appreciate this!

Expand

title	Time to put all of this to good workSTEP 10: Call your methods in main.lua

Let’s create a simple main.lua file:

Code Block

require "ATTL.ATTLclient"

A = ATTLclient{
   key          = component.fields().key,
   space        = 'EC',
   user         = 'fred.smith@interfaceware.com',
   organization = 'interfaceware'
} 

function main(Data)
   A:getSpaceId() 
   local count = 2 
   A:descendants{count = count, live = true}
end

Expand

title	How does this main.lua work?

Right after declaration of Client instance and passing the parameters to it, we discover the Confluence Space ID. This value couldn’t be known without running this API call.

Next we prepare for paginated API call and require only 2 calls to be executed by setting ‘count’ variable to number 2. This will save the time while testing. The parameters for this method are described in respective help file.

And finally, we request from API to return the listing of descendants for 50 pages.

Expand

title	Share a little of 'what is next'?Continue adding methods to expand your adapter!

So, we can query Atlassian API for Confluence! What it is good for? We can query documents, we can edit documents, we can modify/export/add/delete content in any manner we imagine. The complete documentation for this API is available here.

Just create more API methods and more Custom methods.

Custom methods are very helpful to keep the API methods true to vendors API documentation. Custom methods will help to create your specific parameters combination, and to massage the responses. Custom methods are the interface, between your code to clean and true API methods.

...

Versions Compared

Old Version 29

New Version Current

Key