The ayah-captcha Reference Manual

This is the ayah-captcha Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:23:20 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 ayah-captcha

A simple interface to the API of the play-thru captcha of areYouAHuman.com

Author

Andy Peterson <>

License

MIT

Version

0.1

Dependencies
  • drakma (system).
  • cl-json (system).
Source

ayah-captcha.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 ayah-captcha/ayah-captcha.asd

Source

ayah-captcha.asd.

Parent Component

ayah-captcha (system).

ASDF Systems

ayah-captcha.


3.1.2 ayah-captcha/package.lisp

Source

ayah-captcha.asd.

Parent Component

ayah-captcha (system).

Packages

ayah-captcha.


3.1.3 ayah-captcha/ayah-captcha.lisp

Dependency

package.lisp (file).

Source

ayah-captcha.asd.

Parent Component

ayah-captcha (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 ayah-captcha

Source

package.lisp.

Nickname

ayah

Use List

common-lisp.

Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Special variables

Special Variable: *publisher-key*

Identifies you and your application to the areyouahuman web service.

Package

ayah-captcha.

Source

ayah-captcha.lisp.

Special Variable: *scoring-key*

Used to retrieve pass or fail results from areyouahuman web service.

Package

ayah-captcha.

Source

ayah-captcha.lisp.

Special Variable: *web-service-host*

The default web service host for the areyouahuman play-thru captcha.

Package

ayah-captcha.

Source

ayah-captcha.lisp.


5.1.2 Ordinary functions

Function: human-p (session-secret &key scoring-key host)

session-secret should be the value of the parameter session_secret submitted by the form containing publisher-html. Returns boolean value indicating whether the client passed the captcha test.

Package

ayah-captcha.

Source

ayah-captcha.lisp.

Function: publisher-html (&key publisher-key host)

Returns HTML snippet to be inserted within the html form to display play-thru content. Will pass the parameter session_secret on submit to be passed onto the function human-p

Package

ayah-captcha.

Source

ayah-captcha.lisp.

Function: record-conversation-html (session-secret &key host)

Returns the HTML snippet needed to be embedded in the confirmation page after a form submission. Once the code loads on the page it will record a conversion with our system.
session-secret
Pass in the value of the hidden input field with id=’session_secret’

Package

ayah-captcha.

Source

ayah-captcha.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: publisher-script-url (&key publisher-key host)

Returns URL for script to be loaded within the form.

Package

ayah-captcha.

Source

ayah-captcha.lisp.

Function: record-conversation-url (session-secret &key host)
Package

ayah-captcha.

Source

ayah-captcha.lisp.

Function: scoring-url (&key host)

Returns the URL for an http-request post to obtain the scoring result.

Package

ayah-captcha.

Source

ayah-captcha.lisp.


Appendix A Indexes


A.1 Concepts