GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  METABASE::CLIENT::SIMPLE (3)

.ds Aq ’

NAME

Metabase::Client::Simple - a client that submits to Metabase servers

CONTENTS

VERSION

version 0.010

SYNOPSIS



  use Metabase::Client::Simple;
  use Metabase::User::Profile;
  use Metabase::User::Secret;

  my $profile = Metabase::User::Profile->load(user.profile.json);
  my $secret  = Metabase::User::Secret ->load(user.secret.json );

  my $client = Metabase::Client::Simple->new({
    profile => $profile,
    secret  => $secret,
    uri     => http://metabase.example.com/,
  });

  my $fact = generate_metabase_fact;

  $client->submit_fact($fact);



DESCRIPTION

Metabase::Client::Simple provides is extremely simple, lightweight library for submitting facts to a Metabase web server.

METHODS

    new



  my $client = Metabase::Client::Simple->new(\%arg)



This is the object constructor.

Valid arguments are:



  profile - a Metabase::User::Profile object
  secret  - a Metabase::User::Secret object
  uri     - the root URI for the metabase server



If you use a uri argument with the ’https’ scheme, you must have LWP::Protocol::https installed.

    submit_fact



  $client->submit_fact($fact);



This method will submit a Metabase::Fact object to the client’s server. On success, it will return a true value. On failure, it will raise an exception.

    guid_exists



  $client->guid_exists(2f8519c6-24cf-11df-90b1-0018f34ec37c);



This method will check whether the given GUID is found on the metabase server. The GUID must be in lower-case, string form. It will return true or false. Note that a server error will also result in a false value.

    register



  $client->register;



This method will submit the user credentials to the metabase server. It will be called automatically by submit_fact if necessary. You generally won’t need to use it. On success, it will return a true value. On failure, it will raise an exception.

SUPPORT

    Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at <https://github.com/cpan-testers/Metabase-Client-Simple/issues>. You will be notified automatically of any progress on your issue.

    Source Code

This is open source software. The code repository is available for public review and contribution under the terms of the license.

<https://github.com/cpan-testers/Metabase-Client-Simple>



  git clone https://github.com/cpan-testers/Metabase-Client-Simple.git



AUTHORS

o David Golden <dagolden@cpan.org>
o Ricardo Signes <rjbs@cpan.org>

CONTRIBUTORS

o Alexandr Ciornii <alexchorny@gmail.com>
o David Steinbrunner <dsteinbrunner@pobox.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2015 by David Golden.

This is free software, licensed under:



  The Apache License, Version 2.0, January 2004



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 METABASE::CLIENT::SIMPLE (3) 2015-01-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.