README
1NAME
2 Metabase::Client::Simple - a client that submits to Metabase servers
3
4VERSION
5 version 0.012
6
7SYNOPSIS
8 use Metabase::Client::Simple;
9 use Metabase::User::Profile;
10 use Metabase::User::Secret;
11
12 my $profile = Metabase::User::Profile->load('user.profile.json');
13 my $secret = Metabase::User::Secret ->load('user.secret.json' );
14
15 my $client = Metabase::Client::Simple->new({
16 profile => $profile,
17 secret => $secret,
18 uri => 'http://metabase.example.com/',
19 });
20
21 my $fact = generate_metabase_fact;
22
23 $client->submit_fact($fact);
24
25DESCRIPTION
26 Metabase::Client::Simple provides is extremely simple, lightweight
27 library for submitting facts to a Metabase web server.
28
29METHODS
30 new
31 my $client = Metabase::Client::Simple->new(\%arg)
32
33 This is the object constructor.
34
35 Valid arguments are:
36
37 profile - a Metabase::User::Profile object
38 secret - a Metabase::User::Secret object
39 uri - the root URI for the metabase server
40
41 If you use a "uri" argument with the 'https' scheme, you must have
42 IO::Socket::SSL and Net::SSLeay installed. You may also require
43 Mozilla::CA.
44
45 submit_fact
46 $client->submit_fact($fact);
47
48 This method will submit a Metabase::Fact object to the client's server.
49 On success, it will return a true value. On failure, it will raise an
50 exception.
51
52 guid_exists
53 $client->guid_exists('2f8519c6-24cf-11df-90b1-0018f34ec37c');
54
55 This method will check whether the given GUID is found on the metabase
56 server. The GUID must be in lower-case, string form. It will return true
57 or false. Note that a server error will also result in a false value.
58
59 register
60 $client->register;
61
62 This method will submit the user credentials to the metabase server. It
63 will be called automatically by "submit_fact" if necessary. You
64 generally won't need to use it. On success, it will return a true value.
65 On failure, it will raise an exception.
66
67SUPPORT
68 Bugs / Feature Requests
69 Please report any bugs or feature requests through the issue tracker at
70 <https://github.com/cpan-testers/Metabase-Client-Simple/issues>. You
71 will be notified automatically of any progress on your issue.
72
73 Source Code
74 This is open source software. The code repository is available for
75 public review and contribution under the terms of the license.
76
77 <https://github.com/cpan-testers/Metabase-Client-Simple>
78
79 git clone https://github.com/cpan-testers/Metabase-Client-Simple.git
80
81AUTHORS
82 * David Golden <dagolden@cpan.org>
83
84 * Ricardo Signes <rjbs@cpan.org>
85
86CONTRIBUTORS
87 * Alexandr Ciornii <alexchorny@gmail.com>
88
89 * David Steinbrunner <dsteinbrunner@pobox.com>
90
91 * James McCoy <vega.james@gmail.com>
92
93 * Karen Etheridge <ether@cpan.org>
94
95COPYRIGHT AND LICENSE
96 This software is Copyright (c) 2016 by David Golden.
97
98 This is free software, licensed under:
99
100 The Apache License, Version 2.0, January 2004
101
102