The ayah-captcha Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The ayah-captcha Reference Manual

This is the ayah-captcha Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:47:32 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

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

The library is now part of quicklisp (10/2013) and can be downloaded and loaded by quicklisp.

See Docs/index.html for documentation.



Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 ayah-captcha

Author

Andy Peterson <andy.arvid@gmail.com>

License

MIT

Description

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

Version

0.1

Dependencies
Source

ayah-captcha.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 ayah-captcha.asd

Location

ayah-captcha.asd

Systems

ayah-captcha (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 ayah-captcha/package.lisp

Parent

ayah-captcha (system)

Location

package.lisp

Packages

ayah-captcha


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 ayah-captcha/ayah-captcha.lisp

Dependency

package.lisp (file)

Parent

ayah-captcha (system)

Location

ayah-captcha.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 ayah-captcha

Source

package.lisp (file)

Nickname

ayah

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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 (file)

Special Variable: *scoring-key*

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

Package

ayah-captcha

Source

ayah-captcha.lisp (file)

Special Variable: *web-service-host*

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

Package

ayah-captcha

Source

ayah-captcha.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 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 (file)

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 (file)

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 (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 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 (file)

Function: record-conversation-url SESSION-SECRET &key HOST
Package

ayah-captcha

Source

ayah-captcha.lisp (file)

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 (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   A   F   L  
Index Entry  Section

A
ayah-captcha.asd: The ayah-captcha<dot>asd file
ayah-captcha/ayah-captcha.lisp: The ayah-captcha/ayah-captcha<dot>lisp file
ayah-captcha/package.lisp: The ayah-captcha/package<dot>lisp file

F
File, Lisp, ayah-captcha.asd: The ayah-captcha<dot>asd file
File, Lisp, ayah-captcha/ayah-captcha.lisp: The ayah-captcha/ayah-captcha<dot>lisp file
File, Lisp, ayah-captcha/package.lisp: The ayah-captcha/package<dot>lisp file

L
Lisp File, ayah-captcha.asd: The ayah-captcha<dot>asd file
Lisp File, ayah-captcha/ayah-captcha.lisp: The ayah-captcha/ayah-captcha<dot>lisp file
Lisp File, ayah-captcha/package.lisp: The ayah-captcha/package<dot>lisp file

Jump to:   A   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   F   H   P   R   S  
Index Entry  Section

F
Function, human-p: Exported functions
Function, publisher-html: Exported functions
Function, publisher-script-url: Internal functions
Function, record-conversation-html: Exported functions
Function, record-conversation-url: Internal functions
Function, scoring-url: Internal functions

H
human-p: Exported functions

P
publisher-html: Exported functions
publisher-script-url: Internal functions

R
record-conversation-html: Exported functions
record-conversation-url: Internal functions

S
scoring-url: Internal functions

Jump to:   F   H   P   R   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*publisher-key*: Exported special variables
*scoring-key*: Exported special variables
*web-service-host*: Exported special variables

S
Special Variable, *publisher-key*: Exported special variables
Special Variable, *scoring-key*: Exported special variables
Special Variable, *web-service-host*: Exported special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   A   P   S  
Index Entry  Section

A
ayah-captcha: The ayah-captcha system
ayah-captcha: The ayah-captcha package

P
Package, ayah-captcha: The ayah-captcha package

S
System, ayah-captcha: The ayah-captcha system

Jump to:   A   P   S