Gist-class

Class to handle gists (https://gist.github.com/)

Author

hoppfrosch

Credits

Perl Module WWW::GitHub::Gist (https://metacpan.org/module/WWW::GitHub::Gist)
ComObject HTTPRequest (http://www.autohotkey.com/board/topic/56987-com-object-reference-autohotkey-l/#entry358508 & http://msdn.microsoft.com/en-us/library/aa384106.aspx)
Base64 Encoding by Laszlo (http://www.autohotkey.com/board/topic/5545-base64-coderdecoder/page-2#entry64250)
Gist() by Geekdude (https://gist.github.com/4421950)

License

Changelog

0.3.0 (20130816)	hoppfrosch (Internal reorganization concerning documentation) - #1,#2
0.2.0 (20130102)	hoppfrosch (Create new gist & delete existing gist)
0.1.2 (20130102)	hoppfrosch (Functions AKK2StandardControlCharacter(), Standard2AHKControlCharacter())
0.1.1 (20121015)	hoppfrosch (Memberfunction getJSON())
0.1.0 (20121015)	hoppfrosch (Initial)

Summary

Gist-class	Class to handle gists (https://gist.github.com/)
Functions
delete
files	Returns an array with filenames stored in gist
get	Returns an Object with current GIST
getJSON	Returns the JSON string with current GIST
put	Creates a new gist
url	Returns the URL of the gist
version	Current version of the class (Versioning scheme according to http://semver.org)
__basic_auth_header	Creates authorization token for github (INTERNAL)
__extractIDFromURL	Extracts ID from a given gist-url(INTERNAL)
__HTTPdelete	HTTPdelete on Github-URL (INTERNAL)
__HTTPget_obj	HTTPget on Github-URL, returning result as Object (INTERNAL)
__HTTPget	HTTPget on Github-URL, returning result as JSON-String (INTERNAL)
__HTTPpost	HTTPpost JSON-string to on Github-URL, returning result as JSON-String (INTERNAL)
__New	Constructor
AHK2StandardControlCharacter	Replace AHK-style control characters to Standard
Standard2AHKControlCharacter	Replace Standard control characters to AHK-style

Functions

delete

delete( id = )

Deletes an Gist with given ID

if ID is missing the internally stored ID is used

Params

id	id of gist to delete (optional - default: internally stored id)

Author(s)

20130102 (Original)

hoppfrosch

files

files()

Returns an array with filenames stored in gist

Returns

Array with filenames. The several files can be accessed via gist.files[fn] with fn as name of the file to access...

Author(s)

20120928 (Original)

hoppfrosch

get

get( id = )

Returns an Object with current GIST

Returns

GIST-Object

Author(s)

20120928 (Original)

hoppfrosch

getJSON

getJSON( id = )

Returns the JSON string with current GIST

Returns

String (JSON)

Author(s)

20121015 (Original)

hoppfrosch

put

put( Contents,
Title = "AutoHotkey",
Public = "1" )

Creates a new gist

Parameters

Contents	Contents of the new gist (required)
Title	title (filename) of the new gist (optional - default: “Autohotkey”)
Public	Flag to indicate wheter new gist should be public (optional - default: 1 (true))

Returns

GIST-Object

Author(s)

20120928 (Original)

hoppfrosch

url

url()

Returns the URL of the gist

Returns

String (URL)

Author(s)

20130102 (Original)

hoppfrosch

version

version()

Current version of the class (Versioning scheme according to http://semver.org)

Returns

current version number of the class

Author(s)

20120621 (Original)

hoppfrosch

__basic_auth_header

__basic_auth_header()

Creates authorization token for github (**INTERNAL**)

Returns

authorization token (string)

Author(s)

20120928 (Original)

hoppfrosch 20130102 Support anonymous authorization

__extractIDFromURL

__extractIDFromURL( url )

Extracts ID from a given gist-url(**INTERNAL**)

Parameters

url	gist-URL (required)

Returns

gist-ID

Author(s)

20130102 (Original)

hoppfrosch

__HTTPdelete

__HTTPdelete( url )

HTTPdelete on Github-URL (**INTERNAL**)

Parameters

url	URL to delete - it’s a relative URL to “https://api.github.com” (required)

Returns

String (“{“message”:”Not Found”}” in case of Error)

Author(s)

20130102 (Original)

hoppfrosch

__HTTPget_obj

__HTTPget_obj( url )

HTTPget on Github-URL, returning result as Object (**INTERNAL**)

Parameters

url	URL to get - it’s a relative URL to “https://api.github.com” (required)

Returns

json object, (empty object in case of error)

Author(s)

20120928 (Original)

hoppfrosch

__HTTPget

__HTTPget( url )

HTTPget on Github-URL, returning result as JSON-String (**INTERNAL**)

Parameters

url	URL to get - it’s a relative URL to “https://api.github.com” (required)

Returns

String (“{“message”:”Not Found”}” in case of Error)

Author(s)

20120928 (Original)

hoppfrosch

__HTTPpost

__HTTPpost( Contents,
url = "/gists" )

HTTPpost JSON-string to on Github-URL, returning result as JSON-String (**INTERNAL**)

Parameters

Contents	Contents to post
url	URL to get - it’s a relative URL to “https://api.github.com” (required)

Returns

String (“{“message”:”Not Found”}” in case of Error)

Author(s)

20130201 (Original)

hoppfrosch

__New

__New( user = "AHKUser",
password = "AHKUser2012",
debug = 1 )

Constructor

Parameters

user	Username for https://gist.github.com/
password	Password for https://gist.github.com/

Author(s)

20120621 (Original)

hoppfrosch 20130102 Removed ID as parameter

AHK2StandardControlCharacter

AHK2StandardControlCharacter( J )

Replace AHK-style control characters to Standard

Parameters

J	String to convert to Standard style

Returns

String in Standard Style

Author(s)

20130201 (Original)	hoppfrosch
Original	geekdude - http://www.autohotkey.com/board/topic/88675-gist-ahk-l/

Standard2AHKControlCharacter

Standard2AHKControlCharacter( J )

Replace Standard control characters to AHK-style

Parameters

J	String to convert to AHK-Style

Returns

String in AHK style

Author(s)

20130201 (Original)

hoppfrosch