/ 
CPAN-Testers-Metabase-1.999
River stage one • 1 direct dependent • 1 total dependent
/ CPAN::Testers::Metabase::AWS

NAME

CPAN::Testers::Metabase::AWS - Metabase backend on Amazon Web Services

VERSION

This documentation describes version 1.999.

SYNOPSIS

Direct usage

  use CPAN::Testers::Metabase::AWS;

  my $mb = CPAN::Testers::Metabase::AWS->new( 
    bucket    => 'myS3bucket',
    namespace => 'prod' 
  );

  $mb->public_librarian->search( %search spec );
  ...

Metabase::Web config

---
Model::Metabase:
  class: CPAN::Testers::Metabase::AWS
    args:
      bucket: myS3bucket
      namespace: prod

DESCRIPTION

This class instantiates a Metabase backend on the S3 and SimpleDB Amazon Web Services (AWS). It uses Net::Amazon::Config to provide user credentials and the Metabase::Gateway Role to provide actual functionality. As such, it is mostly glue to get the right credentials to setup AWS clients and provide them with standard resource names.

For example, given the bucket "example" and the namespace "alpha", the following resource names would be used:

  Public S3: http://example.s3.amazonaws.com/metabase/alpha/public/*
  Public SDB domain: example.metabase.alpha.public

  Private S3: http://example.s3.amazonaws.com/metabase/alpha/private/*
  Private SDB domain: example.metabase.alpha.private

USAGE

new

my $mb = CPAN::Testers::Metabase::AWS->new( 
  bucket    => 'myS3bucket',
  namespace     => 'prod', 
  profile_name  => 'cpantesters',
);

Arguments for new:

  • bucket -- required -- the Amazon S3 bucket name to hold both public and private fact content. Bucket names must be unique across all of AWS. The bucket name is also used as part of the SimpleDB namespace for consistency.

  • namespace -- required -- a short phrase that uniquely identifies this metabase. E.g. "dev", "test" or "prod". It is used to specify specific locations within the S3 bucket and to uniquely identify a SimpleDB domain for indexing.

  • amazon_config -- optional -- a Net::Amazon::Config object containing Amazon Web Service credentials. If not provided, one will be created using the default location for the config file.

  • profile_name -- optional -- the name of a profile for use with Net::Amazon::Config. If not provided, it defaults to 'cpantesters'.

access_key_id

Returns the AWS Access Key ID.

secret_access_key

Returns the AWS Secret Access Key

Metabase::Gateway Role

This class does the Metabase::Gateway role, including the following methods:

  • handle_submission

  • handle_registration

  • enqueue

see Metabase::Gateway for more.

BUGS

Please report any bugs or feature requests using the CPAN Request Tracker web interface at http://rt.cpan.org/Dist/Display.html?Queue=CPAN-Testers-Metabase

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SEE ALSO

AUTHOR

David A. Golden (DAGOLDEN)

COPYRIGHT AND LICENSE

Copyright (c) 2010 by David A. Golden. All rights reserved.

Licensed under Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License was distributed with this file or you may obtain a copy of the License from http://www.apache.org/licenses/LICENSE-2.0

Files produced as output though the use of this software, shall not be considered Derivative Works, but shall be considered the original work of the Licensor.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.