indiana-university/puppet-forge-api-php

A set of classes meant to make interacting with the Puppet Forge easier

v1.1.1 2022-06-28 14:13 UTC

Requires

• php: ^7.3|^8
• guzzlehttp/guzzle: ^7

Requires (Dev)

• phpmd/phpmd: ^2.10
• phpstan/phpstan: ^0.12
• phpunit/phpunit: ^9
• squizlabs/php_codesniffer: ^3.6

BSD-3-Clause

• Anthony Vitacco

• php
• api
• module
• puppet
• forge

README

A PHP interface to the Puppet Forge REST API

Requirements

This library requires at least PHP 7.3

Usage

use Edu\Iu\Uits\Webtech\ForgeApi\ForgeApi;

$api = new ForgeApi('YOUR API KEY HERE');

/**
 * User operations
 */

// Listing users
$api->user()->list([
    // See official API documentation for parameters
    'limit' => 20,
]);

// Fetching a user
$api->user('puppetlabs')->fetch();

/**
* Module operations
 */

// Fetch a module
$api->module('puppetlabs-apache')->fetch();

// Delete a module
$api->module('puppetlabs-apache')->delete('Broken code');

// Deprecate a module
$api->module('puppetlabs-apache')->deprecate(
    'No longer maintained',
    'puppet-nginx'
);

// List modules
$api->module()->list(['limit' => 20]);

/**
 * Release operations
 */

// List releases
$api->release()->list(['limit' => 20]);

// Create a release
$api->release('puppetlabs-apache')->create('base64 encoded string');

// Fetch a release
$api->release('puppetlabs-apache-4.0.0')->fetch();

// Delete a release
$api->release('puppetlabs-apache-4.0.0')->delete('bugs');

Limitations

1. Currently module release plans are not supported. This is strictly because of time limitations. They will probably be supported in the future.

2. It is not currently possible to customize the user agent.