Steve Huff > WebService-Scriptogram-v0.0.2 > WebService::Scriptogram

Download:
WebService-Scriptogram-v0.0.2.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: v0.0.2   Source  

NAME ^

WebService::Scriptogram - Scriptogr.am API

This module provides a Perl wrapper around the Scriptogr.am ( <http://scriptogr.am> ) API. You'll need a Scriptogr.am blog and an API key before you'll be able to do anything interesting with this module.

See <http://scriptogr.am/dashboard#api_documentation> for authoritative documentation of API calls.

VERSION ^

Version v0.0.2

SYNOPSIS ^

    use WebService::Scriptogram;

    my $sg = WebService::Scriptogram->new;

    my $text = <<TEXT;
    **Hello, World!**

    First post!

    I'm using [WebService::Scriptogram](https://github.com/hakamadare/webservice-scriptogram).
    TEXT

    my $status = $sg->article(
        app_key => 'Scriptogr.am App Key',
        user_id => 'Scriptogr.am User ID',
        name => 'My First API Post',
        text => $text,
    );

Each method corresponds to an API call; methods accept a hash of parameters, and return a hashref representing the status returned by the API (see Scriptogr.am API documentation for an explanation of status values).

METHODS ^

article

Post a new article or edit an existing article. Accepts the following parameters:

app_key

Scriptogr.am API key. Register an application with Scriptogr.am to obtain one.

user_id

Scriptogr.am user ID. Get this from the settings pane of the Scriptogr.am dashboard.

name

Title of the article as you would like it to appear on your blog.

text

(Optional) text of the article, in Markdown format.

delete

Delete an existing article. Accepts the following parameters:

app_key

Scriptogr.am API key. Register an application with Scriptogr.am to obtain one.

user_id

Scriptogr.am user ID. Get this from the settings pane of the Scriptogr.am dashboard.

filename

Name of the file as it appears in your Dropbox folder.

text

(Optional) text of the article, in Markdown format.

AUTHOR ^

Steve Huff, <shuff at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-webservice-scriptogram at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-Scriptogram. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc WebService::Scriptogram

You can also look for information at:

ACKNOWLEDGEMENTS ^

Thanks to the fine folks at #crimsonfu for bringing Scriptogr.am to my attention.

LICENSE AND COPYRIGHT ^

Copyright 2012 Steve Huff.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: