API-Basecamp
view release on metacpan or search on metacpan
Changelog for API-Basecamp
0.06 2015-10-11T08:11:18
- Updated build.
- Modified the implementation style and dependencies.
0.05 2015-09-28T13:19:59
- v0.05
- Updated build.
- Updated inconsistency in documentation.
- Updated dist.ini to generate META files.
This is the Perl distribution API-Basecamp.
Installing API-Basecamp is straightforward.
## Installation with cpanm
If you have cpanm, you only need one line:
% cpanm API::Basecamp
If you are installing into a system-wide directory, you may need to pass the
"-S" flag to cpanm, which uses sudo to install the module:
% cpanm -S API::Basecamp
## Installing with the CPAN shell
Alternatively, if your CPAN shell is set up, you should just be able to do:
% cpan API::Basecamp
## Manual installation
As a last resort, you can manually install it. Download the tarball, untar it,
then build it:
% perl Makefile.PL
% make && make test
Then install it:
% make install
If you are installing into a system-wide directory, you may need to run:
% sudo make install
## Documentation
API-Basecamp documentation is available as POD.
You can run perldoc from a shell to read the documentation:
% perldoc API::Basecamp
# This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.037.
CHANGES
INSTALL
LICENSE
MANIFEST
META.json
Makefile.PL
README.mkdn
cpanfile
lib/API/Basecamp.pm
t/main.t
{
"abstract" : "Basecamp.com API Client",
"author" : [
"Al Newkirk <anewkirk@ana.io>"
],
"dynamic_config" : 0,
"generated_by" : "Dist::Zilla version 5.037, CPAN::Meta::Converter version 2.150005",
"license" : [
"perl_5"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
"version" : 2
},
"name" : "API-Basecamp",
"prereqs" : {
"configure" : {
"requires" : {
"ExtUtils::MakeMaker" : "0"
}
},
"runtime" : {
"requires" : {
"API::Client" : "0.03",
"Data::Object" : "0.57",
},
"test" : {
"requires" : {
"perl" : "v5.14.0"
}
}
},
"release_status" : "stable",
"resources" : {
"bugtracker" : {
"web" : "https://github.com/alnewkirk/API-Basecamp/issues"
},
"homepage" : "http://metacpan.org/release/API-Basecamp/",
"repository" : {
"type" : "git",
"url" : "git://github.com/alnewkirk/API-Basecamp.git",
"web" : "https://github.com/alnewkirk/API-Basecamp"
}
},
"version" : "0.06",
"x_authority" : "cpan:AWNCORP"
}
Makefile.PL view on Meta::CPAN
# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.037.
use strict;
use warnings;
use 5.014000;
use ExtUtils::MakeMaker;
my %WriteMakefileArgs = (
"ABSTRACT" => "Basecamp.com API Client",
"AUTHOR" => "Al Newkirk <anewkirk\@ana.io>",
"CONFIGURE_REQUIRES" => {
"ExtUtils::MakeMaker" => 0
},
"DISTNAME" => "API-Basecamp",
"EXE_FILES" => [],
"LICENSE" => "perl",
"MIN_PERL_VERSION" => "5.014000",
"NAME" => "API::Basecamp",
"PREREQ_PM" => {
"API::Client" => "0.03",
"Data::Object" => "0.57",
"Mojolicious" => "6.22"
},
"VERSION" => "0.06",
"test" => {
"TESTS" => "t/*.t"
}
);
README.mkdn view on Meta::CPAN
# NAME
API::Basecamp - Basecamp.com API Client
# VERSION
version 0.06
# SYNOPSIS
use API::Basecamp;
my $basecamp = API::Basecamp->new(
username => 'USERNAME',
password => 'PASSWORD',
identifier => 'APPLICATION NAME',
account => 'ACCOUNT NUMBER',
);
$basecamp->debug(1);
$basecamp->fatal(1);
my $project = $basecamp->projects('605816632');
my $results = $project->fetch;
# after some introspection
$project->update( ... );
# DESCRIPTION
This distribution provides an object-oriented thin-client library for
interacting with the Basecamp ([http://basecamp.com](http://basecamp.com)) API. For usage and
documentation information visit [https://github.com/basecamp/bcx-api](https://github.com/basecamp/bcx-api).
API::Basecamp is derived from [API::Client](https://metacpan.org/pod/API::Client) and inherits all of it's
functionality. Please read the documentation for API::Client for more usage
information.
# ATTRIBUTES
## account
$basecamp->account;
$basecamp->account('ACCOUNT');
The account attribute should be set to the account holder's account ID number.
## identifier
$basecamp->identifier;
$basecamp->identifier('IDENTIFIER');
The identifier attribute should be set to a string that identifies your application.
## password
$basecamp->password;
$basecamp->password('PASSWORD');
The password attribute should be set to the account holder's password.
## username
$basecamp->username;
$basecamp->username('USERNAME');
The username attribute should be set to the account holder's username.
## debug
$basecamp->debug;
$basecamp->debug(1);
The debug attribute if true prints HTTP requests and responses to standard out.
## fatal
$basecamp->fatal;
$basecamp->fatal(1);
The fatal attribute if true promotes 4xx and 5xx server response codes to
exceptions, a [API::Client::Exception](https://metacpan.org/pod/API::Client::Exception) object.
## retries
$basecamp->retries;
$basecamp->retries(10);
The retries attribute determines how many times an HTTP request should be
retried if a 4xx or 5xx response is received. This attribute defaults to 0.
## timeout
$basecamp->timeout;
$basecamp->timeout(5);
The timeout attribute determines how long an HTTP connection should be kept
alive. This attribute defaults to 10.
## url
$basecamp->url;
$basecamp->url(Mojo::URL->new('https://basecamp.com'));
The url attribute set the base/pre-configured URL object that will be used in
all HTTP requests. This attribute expects a [Mojo::URL](https://metacpan.org/pod/Mojo::URL) object.
## user\_agent
$basecamp->user_agent;
$basecamp->user_agent(Mojo::UserAgent->new);
The user\_agent attribute set the pre-configured UserAgent object that will be
used in all HTTP requests. This attribute expects a [Mojo::UserAgent](https://metacpan.org/pod/Mojo::UserAgent) object.
# METHODS
## action
my $result = $basecamp->action($verb, %args);
# e.g.
$basecamp->action('head', %args); # HEAD request
$basecamp->action('options', %args); # OPTIONS request
$basecamp->action('patch', %args); # PATCH request
The action method issues a request to the API resource represented by the
object. The first parameter will be used as the HTTP request method. The
arguments, expected to be a list of key/value pairs, will be included in the
request if the key is either `data` or `query`.
## create
my $results = $basecamp->create(%args);
# or
$basecamp->POST(%args);
The create method issues a `POST` request to the API resource represented by
the object. The arguments, expected to be a list of key/value pairs, will be
included in the request if the key is either `data` or `query`.
## delete
my $results = $basecamp->delete(%args);
# or
$basecamp->DELETE(%args);
The delete method issues a `DELETE` request to the API resource represented by
the object. The arguments, expected to be a list of key/value pairs, will be
included in the request if the key is either `data` or `query`.
## fetch
my $results = $basecamp->fetch(%args);
# or
$basecamp->GET(%args);
The fetch method issues a `GET` request to the API resource represented by the
object. The arguments, expected to be a list of key/value pairs, will be
included in the request if the key is either `data` or `query`.
## update
my $results = $basecamp->update(%args);
# or
$basecamp->PUT(%args);
The update method issues a `PUT` request to the API resource represented by
the object. The arguments, expected to be a list of key/value pairs, will be
included in the request if the key is either `data` or `query`.
# RESOURCES
## accesses
$basecamp->projects('605816632')->accesses;
The accesses method returns a new instance representative of the API
_Accesses_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/accesses.md](https://github.com/basecamp/bcx-api/blob/master/sections/accesses.md).
## attachments
$basecamp->attachments;
The attachments method returns a new instance representative of the API
_Attachments_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/attachments.md](https://github.com/basecamp/bcx-api/blob/master/sections/attachments.md).
## calendar\_events
$basecamp->calendar_events;
The calendar\_events method returns a new instance representative of the API
_Calendar Events_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/calendar\_events.md](https://github.com/basecamp/bcx-api/blob/master/sections/calendar_events.md).
## calendars
$basecamp->calendars;
The calendars method returns a new instance representative of the API
_Calendars_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/calendars.md](https://github.com/basecamp/bcx-api/blob/master/sections/calendars.md).
## comments
$basecamp->projects('605816632')->comments;
The comments method returns a new instance representative of the API
_Comments_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/comments.md](https://github.com/basecamp/bcx-api/blob/master/sections/comments.md).
## documents
$basecamp->documents;
The documents method returns a new instance representative of the API
_Documents_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/documents.md](https://github.com/basecamp/bcx-api/blob/master/sections/documents.md).
## events
$basecamp->events;
The events method returns a new instance representative of the API
_Events_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/events.md](https://github.com/basecamp/bcx-api/blob/master/sections/events.md).
## groups
$basecamp->groups;
The groups method returns a new instance representative of the API
_Groups_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/groups.md](https://github.com/basecamp/bcx-api/blob/master/sections/groups.md).
## messages
$basecamp->projects('605816632')->messages;
The messages method returns a new instance representative of the API
_Messages_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/messages.md](https://github.com/basecamp/bcx-api/blob/master/sections/messages.md).
## people
$basecamp->people;
The people method returns a new instance representative of the API
_People_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/people.md](https://github.com/basecamp/bcx-api/blob/master/sections/people.md).
## project\_templates
$basecamp->project_templates;
The project\_templates method returns a new instance representative of the API
_Project Templates_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/project\_templates.md](https://github.com/basecamp/bcx-api/blob/master/sections/project_templates.md).
## projects
$basecamp->projects;
The projects method returns a new instance representative of the API
_Projects_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/projects.md](https://github.com/basecamp/bcx-api/blob/master/sections/projects.md).
## stars
$basecamp->stars;
The stars method returns a new instance representative of the API
_Stars_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/stars.md](https://github.com/basecamp/bcx-api/blob/master/sections/stars.md).
## todo\_lists
$basecamp->todo_lists;
The todo\_lists method returns a new instance representative of the API
_Todo Lists_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/todolists.md](https://github.com/basecamp/bcx-api/blob/master/sections/todolists.md).
## todos
$basecamp->projects('605816632')->todos;
The todos method returns a new instance representative of the API
_Todos_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/todos.md](https://github.com/basecamp/bcx-api/blob/master/sections/todos.md).
## topics
$basecamp->topics;
The topics method returns a new instance representative of the API
_Topics_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/topics.md](https://github.com/basecamp/bcx-api/blob/master/sections/topics.md).
## uploads
$basecamp->projects('605816632')->uploads;
The uploads method returns a new instance representative of the API
_Uploads_ resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. [https://github.com/basecamp/bcx-api/blob/master/sections/uploads.md](https://github.com/basecamp/bcx-api/blob/master/sections/uploads.md).
# AUTHOR
Al Newkirk <anewkirk@ana.io>
# COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by Al Newkirk.
This is free software; you can redistribute it and/or modify it under
lib/API/Basecamp.pm view on Meta::CPAN
# ABSTRACT: Basecamp.com API Client
package API::Basecamp;
use Data::Object::Class;
use Data::Object::Signatures;
use Data::Object::Library qw(
Str
);
extends 'API::Client';
our $VERSION = '0.06'; # VERSION
our $DEFAULT_URL = "https://basecamp.com";
# ATTRIBUTES
has account => (
is => 'rw',
isa => Str,
required => 1,
);
has password => (
lib/API/Basecamp.pm view on Meta::CPAN
has username => (
is => 'rw',
isa => Str,
required => 1,
);
# DEFAULTS
has '+identifier' => (
default => 'API::Basecamp (Perl)',
required => 0,
);
has '+url' => (
default => $DEFAULT_URL,
required => 0,
);
has '+version' => (
default => 1,
lib/API/Basecamp.pm view on Meta::CPAN
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
API::Basecamp - Basecamp.com API Client
=head1 VERSION
version 0.06
=head1 SYNOPSIS
use API::Basecamp;
my $basecamp = API::Basecamp->new(
username => 'USERNAME',
password => 'PASSWORD',
identifier => 'APPLICATION NAME',
account => 'ACCOUNT NUMBER',
);
$basecamp->debug(1);
$basecamp->fatal(1);
my $project = $basecamp->projects('605816632');
my $results = $project->fetch;
# after some introspection
$project->update( ... );
=head1 DESCRIPTION
This distribution provides an object-oriented thin-client library for
interacting with the Basecamp (L<http://basecamp.com>) API. For usage and
documentation information visit L<https://github.com/basecamp/bcx-api>.
API::Basecamp is derived from L<API::Client> and inherits all of it's
functionality. Please read the documentation for API::Client for more usage
information.
=head1 ATTRIBUTES
=head2 account
$basecamp->account;
$basecamp->account('ACCOUNT');
The account attribute should be set to the account holder's account ID number.
=head2 identifier
$basecamp->identifier;
$basecamp->identifier('IDENTIFIER');
The identifier attribute should be set to a string that identifies your application.
=head2 password
$basecamp->password;
$basecamp->password('PASSWORD');
The password attribute should be set to the account holder's password.
=head2 username
$basecamp->username;
$basecamp->username('USERNAME');
The username attribute should be set to the account holder's username.
=head2 debug
$basecamp->debug;
$basecamp->debug(1);
The debug attribute if true prints HTTP requests and responses to standard out.
=head2 fatal
$basecamp->fatal;
$basecamp->fatal(1);
The fatal attribute if true promotes 4xx and 5xx server response codes to
exceptions, a L<API::Client::Exception> object.
=head2 retries
$basecamp->retries;
$basecamp->retries(10);
The retries attribute determines how many times an HTTP request should be
retried if a 4xx or 5xx response is received. This attribute defaults to 0.
=head2 timeout
$basecamp->timeout;
$basecamp->timeout(5);
The timeout attribute determines how long an HTTP connection should be kept
alive. This attribute defaults to 10.
=head2 url
$basecamp->url;
$basecamp->url(Mojo::URL->new('https://basecamp.com'));
The url attribute set the base/pre-configured URL object that will be used in
all HTTP requests. This attribute expects a L<Mojo::URL> object.
=head2 user_agent
$basecamp->user_agent;
$basecamp->user_agent(Mojo::UserAgent->new);
The user_agent attribute set the pre-configured UserAgent object that will be
used in all HTTP requests. This attribute expects a L<Mojo::UserAgent> object.
=head1 METHODS
=head2 action
my $result = $basecamp->action($verb, %args);
# e.g.
$basecamp->action('head', %args); # HEAD request
$basecamp->action('options', %args); # OPTIONS request
$basecamp->action('patch', %args); # PATCH request
The action method issues a request to the API resource represented by the
object. The first parameter will be used as the HTTP request method. The
arguments, expected to be a list of key/value pairs, will be included in the
request if the key is either C<data> or C<query>.
=head2 create
my $results = $basecamp->create(%args);
# or
$basecamp->POST(%args);
The create method issues a C<POST> request to the API resource represented by
the object. The arguments, expected to be a list of key/value pairs, will be
included in the request if the key is either C<data> or C<query>.
=head2 delete
my $results = $basecamp->delete(%args);
# or
$basecamp->DELETE(%args);
The delete method issues a C<DELETE> request to the API resource represented by
the object. The arguments, expected to be a list of key/value pairs, will be
included in the request if the key is either C<data> or C<query>.
=head2 fetch
my $results = $basecamp->fetch(%args);
# or
$basecamp->GET(%args);
The fetch method issues a C<GET> request to the API resource represented by the
object. The arguments, expected to be a list of key/value pairs, will be
included in the request if the key is either C<data> or C<query>.
=head2 update
my $results = $basecamp->update(%args);
# or
$basecamp->PUT(%args);
The update method issues a C<PUT> request to the API resource represented by
the object. The arguments, expected to be a list of key/value pairs, will be
included in the request if the key is either C<data> or C<query>.
=head1 RESOURCES
=head2 accesses
$basecamp->projects('605816632')->accesses;
The accesses method returns a new instance representative of the API
I<Accesses> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/accesses.md>.
=head2 attachments
$basecamp->attachments;
The attachments method returns a new instance representative of the API
I<Attachments> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/attachments.md>.
=head2 calendar_events
$basecamp->calendar_events;
The calendar_events method returns a new instance representative of the API
I<Calendar Events> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/calendar_events.md>.
=head2 calendars
$basecamp->calendars;
The calendars method returns a new instance representative of the API
I<Calendars> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/calendars.md>.
=head2 comments
$basecamp->projects('605816632')->comments;
The comments method returns a new instance representative of the API
I<Comments> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/comments.md>.
=head2 documents
$basecamp->documents;
The documents method returns a new instance representative of the API
I<Documents> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/documents.md>.
=head2 events
$basecamp->events;
The events method returns a new instance representative of the API
I<Events> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/events.md>.
=head2 groups
$basecamp->groups;
The groups method returns a new instance representative of the API
I<Groups> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/groups.md>.
=head2 messages
$basecamp->projects('605816632')->messages;
The messages method returns a new instance representative of the API
I<Messages> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/messages.md>.
=head2 people
$basecamp->people;
The people method returns a new instance representative of the API
I<People> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/people.md>.
=head2 project_templates
$basecamp->project_templates;
The project_templates method returns a new instance representative of the API
I<Project Templates> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/project_templates.md>.
=head2 projects
$basecamp->projects;
The projects method returns a new instance representative of the API
I<Projects> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/projects.md>.
=head2 stars
$basecamp->stars;
The stars method returns a new instance representative of the API
I<Stars> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/stars.md>.
=head2 todo_lists
$basecamp->todo_lists;
The todo_lists method returns a new instance representative of the API
I<Todo Lists> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/todolists.md>.
=head2 todos
$basecamp->projects('605816632')->todos;
The todos method returns a new instance representative of the API
I<Todos> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/todos.md>.
=head2 topics
$basecamp->topics;
The topics method returns a new instance representative of the API
I<Topics> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/topics.md>.
=head2 uploads
$basecamp->projects('605816632')->uploads;
The uploads method returns a new instance representative of the API
I<Uploads> resource requested. This method accepts a list of path
segments which will be used in the HTTP request. The following documentation
can be used to find more information. L<https://github.com/basecamp/bcx-api/blob/master/sections/uploads.md>.
=head1 AUTHOR
Al Newkirk <anewkirk@ana.io>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by Al Newkirk.
This is free software; you can redistribute it and/or modify it under
use Test::More;
use_ok 'API::Basecamp';
ok 1 and done_testing;
( run in 0.986 second using v1.01-cache-2.11-cpan-39bf76dae61 )