The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
SYAGI / Artifactory-Client-v1.3.1 / README.md

Build Status

NAME

Artifactory::Client - Perl client for Artifactory REST API

VERSION

Version 1.3.1

SYNOPSIS

This is a Perl client for Artifactory REST API: https://www.jfrog.com/confluence/display/RTF/Artifactory+REST+API Every public method provided in this module returns a HTTP::Response object.

use Artifactory::Client;

my $h = HTTP::Headers->new();
$h->authorization_basic( 'admin', 'password' );
my $ua = LWP::UserAgent->new( default_headers => $h );

my $args = {
    artifactory  => 'http://artifactory.server.com',
    port         => 8080,
    repository   => 'myrepository',
    context_root => '/', # Context root for artifactory. Defaults to 'artifactory'.
    ua           => $ua  # Dropping in custom UA with default_headers set.  Default is a plain LWP::UserAgent.
};

my $client = Artifactory::Client->new( $args );
my $path = '/foo'; # path on artifactory

# Properties are a hashref of key-arrayref pairs.  Note that value must be an arrayref even for a single element.
# This is to conform with Artifactory which treats property values as a list.
my $properties = {
    one => ['two'],
    baz => ['three'],
};
my $file = '/local/file.xml';

# Name of methods are taken straight from Artifactory REST API documentation.  'Deploy Artifact' would map to
# deploy_artifact method, like below.  The caller gets HTTP::Response object back.
my $resp = $client->deploy_artifact( path => $path, properties => $properties, file => $file );

# Custom requests can also be made via usual get / post / put / delete requests.
my $resp = $client->get( 'http://artifactory.server.com/path/to/resource' );

# Repository override for calls that have a repository in the endpoint.  The passed-in repository will not persist.
my $resp = $client->calculate_yum_repository_metadata( repository => 'different_repo', async => 1 );

Dev Env Setup / Running Tests

carton install

# to run unit tests
prove -r t

# to run functional tests (requires Artifactory running somewhere)
perl t_func/functional.t --server <hostname>

GENERIC METHODS

get( @args )

Invokes GET request on LWP::UserAgent-like object; params are passed through.

post( @args )

nvokes POST request on LWP::UserAgent-like object; params are passed through.

put( @args )

Invokes PUT request on LWP::UserAgent-like object; params are passed through.

delete( @args )

Invokes DELETE request on LWP::UserAgent-like object; params are passed through.

request( @args )

Invokes request() on LWP::UserAgent-like object; params are passed through.

BUILDS

all_builds

Retrieves information on all builds from artifactory.

build_runs( $build_name )

Retrieves information of a particular build from artifactory.

build_upload( $path_to_json )

Upload Build

build_info( $build_name, $build_number )

Retrieves information of a particular build number.

builds_diff( $build_name, $new_build_number, $old_build_number )

Retrieves diff of 2 builds

build_promotion( $build_name, $build_number, $payload )

Promotes a build by POSTing payload

promote_docker_image( targetRepo => "target_repo", dockerRepository => "dockerRepository", tag => "tag", copy => 'false' )

Promotes a Docker image from one repository to another

delete_builds( name => $build_name, buildnumbers => [ buildnumbers ], artifacts => 0,1, deleteall => 0,1 )

Removes builds stored in Artifactory. Useful for cleaning up old build info data

build_rename( $build_name, $new_build_name )

Renames a build

distribute_build( 'build_name', $build_number, %hash_of_json_payload )

Deploys builds from Artifactory to Bintray, and creates an entry in the corresponding Artifactory distribution repository specified.

ARTIFACTS & STORAGE

folder_info( $path )

Returns folder info

file_info( $path )

Returns file info

get_storage_summary_info

Returns storage summary information regarding binaries, file store and repositories

item_last_modified( $path )

Returns item_last_modified for a given path

file_statistics( $path )

Returns file_statistics for a given path

item_properties( path => $path, properties => [ key_names ] )

Takes path and properties then get item properties.

set_item_properties( path => $path, properties => { key => [ values ] }, recursive => 0,1 )

Takes path and properties then set item properties. Supply recursive => 0 if you want to suppress propagation of properties downstream. Note that properties are a hashref with key-arrayref pairs, such as:

$prop = { key1 => ['a'], key2 => ['a', 'b'] }

delete_item_properties( path => $path, properties => [ key_names ], recursive => 0,1 )

Takes path and properties then delete item properties. Supply recursive => 0 if you want to suppress propagation of properties downstream.

set_item_sha256_checksum( repoKey => 'foo', path => 'bar' )

Calculates an artifact's SHA256 checksum and attaches it as a property (with key "sha256"). If the artifact is a folder, then recursively calculates the SHA256 of each item in the folder and attaches the property to each item.

retrieve_artifact( $path, $filename )

Takes path and retrieves artifact on the path. If $filename is given, artifact content goes into the $filename rather than the HTTP::Response object.

retrieve_latest_artifact( path => $path, version => $version, release => $release, integration => $integration,

flag => 'snapshot', 'release', 'integration' )

Takes path, version, flag of 'snapshot', 'release' or 'integration' and retrieves artifact

retrieve_build_artifacts_archive( $payload )

Takes payload (hashref) then retrieve build artifacts archive.

retrieve_folder_or_repository_archive( path => '/foobar', archiveType => 'zip' )

Retrieves an archive file (supports zip/tar/tar.gz/tgz) containing all the artifacts that reside under the specified path (folder or repository root). Requires Enable Folder Download to be set.

trace_artifact_retrieval( $path )

Takes path and traces artifact retrieval

archive_entry_download( $path, $archive_path )

Takes path and archive_path, retrieves an archived resource from the specified archive destination.

create_directory( path => $path, properties => { key => [ values ] } )

Takes path, properties then create a directory. Directory needs to end with a /, such as "/some_dir/".

deploy_artifact( path => $path, properties => { key => [ values ] }, file => $file )

Takes path on Artifactory, properties and filename then deploys the file. Note that properties are a hashref with key-arrayref pairs, such as:

$prop = { key1 => ['a'], key2 => ['a', 'b'] }

deploy_artifact_by_checksum( path => $path, properties => { key => [ values ] }, file => $file, sha1 => $sha1 )

Takes path, properties, filename and sha1 then deploys the file. Note that properties are a hashref with key-arrayref pairs, such as:

$prop = { key1 => ['a'], key2 => ['a', 'b'] }

deploy_artifacts_from_archive( path => $path, file => $file )

Path is the path on Artifactory, file is path to local archive. Will deploy $file to $path.

push_a_set_of_artifacts_to_bintray( descriptor => 'foo', gpgPassphrase => 'top_secret', gpgSign => 'true' )

Push a set of artifacts to Bintray as a version. Uses a descriptor file (that must have 'bintray-info' in it's filename and a .json extension) that was deployed to artifactory, the call accepts the full path to the descriptor as a parameter.

push_docker_tag_to_bintray( dockerImage => 'jfrog/ubuntu:latest', async => 'true', ... )

Push Docker tag to Bintray. Calculation can be synchronous (the default) or asynchronous. You will need to enter your Bintray credentials, for more details, please refer to Entering your Bintray credentials.

distribute_artifact( publish => 'true', async => 'false' )

Deploys artifacts from Artifactory to Bintray, and creates an entry in the corresponding Artifactory distribution repository specified

file_compliance_info( $path )

Retrieves file compliance info of a given path.

delete_item( $path )

Delete $path on artifactory.

copy_item( from => $from, to => $to, dry => 1, suppressLayouts => 0/1, failFast => 0/1 )

Copies an artifact from $from to $to. Note that for this particular API call, the $from and $to must include repository names as copy source and destination may be different repositories. You can also supply dry, suppressLayouts and failFast values as specified in the documentation.

move_item( from => $from, to => $to, dry => 1, suppressLayouts => 0/1, failFast => 0/1 )

Moves an artifact from $from to $to. Note that for this particular API call, the $from and $to must include repository names as copy source and destination may be different repositories. You can also supply dry, suppressLayouts and failFast values as specified in the documentation.

get_repository_replication_configuration

Get repository replication configuration

set_repository_replication_configuration( $payload )

Set repository replication configuration

update_repository_replication_configuration( $payload )

Update repository replication configuration

delete_repository_replication_configuration

Delete repository replication configuration

scheduled_replication_status

Gets scheduled replication status of a repository

pull_push_replication( payload => $payload, path => $path )

Schedules immediate content replication between two Artifactory instances

create_or_replace_local_multi_push_replication( $payload )

Creates or replaces a local multi-push replication configuration. Supported by local and local-cached repositories

update_local_multi_push_replication( $payload )

Updates a local multi-push replication configuration. Supported by local and local-cached repositories

delete_local_multi_push_replication( $url )

Deletes a local multi-push replication configuration. Supported by local and local-cached repositories

enable_or_disable_multiple_replications( 'enable|disable', include => [ ], exclude => [ ] )

Enables/disables multiple replication tasks by repository or Artifactory server based in include and exclude patterns.

get_global_system_replication_configuration

Returns the global system replication configuration status, i.e. if push and pull replications are blocked or unblocked.

block_system_replication( push => 'false', pull => 'true' )

Blocks replications globally. Push and pull are true by default. If false, replication for the corresponding type is not blocked.

unblock_system_replication( push => 'false', pull => 'true' )

Unblocks replications globally. Push and pull are true by default. If false, replication for the corresponding type is not unblocked.

artifact_sync_download( $path, content => 'progress', mark => 1000 )

Downloads an artifact with or without returning the actual content to the client. When tracking the progress marks are printed (by default every 1024 bytes). This is extremely useful if you want to trigger downloads on a remote Artifactory server, for example to force eager cache population of large artifacts, but want to avoid the bandwidth consumption involved in transferring the artifacts to the triggering client. If no content parameter is specified the file content is downloaded to the client.

file_list( $dir, %opts )

Get a flat (the default) or deep listing of the files and folders (not included by default) within a folder

get_background_tasks

Retrieves list of background tasks currently scheduled or running in Artifactory. In HA, the nodeId is added to each task. Task can be in one of few states: scheduled, running, stopped, canceled. Running task also shows the task start time.

empty_trash_can

Empties the trash can permanently deleting all its current contents.

delete_item_from_trash_can($path)

Permanently deletes an item from the trash can.

restore_item_from_trash_can( $from, $to )

Restore an item from the trash can.

optimize_system_storage

Raises a flag to invoke balancing between redundant storage units of a sharded filestore following the next garbage collection.

SEARCHES

artifactory_query_language( $aql_statement )

Flexible and high performance search using Artifactory Query Language (AQL).

artifact_search( name => $name, repos => [ @repos ], result_detail => [qw(info properties)], )

Artifact search by part of file name

archive_entry_search( name => $name, repos => [ @repos ] )

Search archive entries for classes or any other jar resources

gavc_search( g => 'foo', c => 'bar', result_detail => [qw(info properties)], )

Search by Maven coordinates: groupId, artifactId, version & classifier

property_search( p => [ 'v1', 'v2' ], repos => [ 'repo1', 'repo2' ], result_detail => [qw(info properties)], )

Search by properties

checksum_search( md5 => '12345', repos => [ 'repo1', 'repo2' ], result_detail => [qw(info properties)], )

Artifact search by checksum (md5 or sha1)

bad_checksum_search( type => 'md5', repos => [ 'repo1', 'repo2' ] )

Find all artifacts that have a bad or missing client checksum values (md5 or sha1)

artifacts_not_downloaded_since( notUsedSince => 12345, createdBefore => 12345, repos => [ 'repo1', 'repo2' ] )

Retrieve all artifacts not downloaded since the specified Java epoch in msec.

artifacts_with_date_in_date_range( from => 12345, repos => [ 'repo1', 'repo2' ], dateFields => [ 'created' ] )

Get all artifacts with specified dates within the given range. Search can be limited to specific repositories (local or caches).

artifacts_created_in_date_range( from => 12345, to => 12345, repos => [ 'repo1', 'repo2' ] )

Get all artifacts created in date range

pattern_search( $pattern )

Get all artifacts matching the given Ant path pattern

builds_for_dependency( sha1 => 'abcde' )

Find all the builds an artifact is a dependency of (where the artifact is included in the build-info dependencies)

license_search( unapproved => 1, unknown => 1, notfound => 0, neutral => 0, repos => [ 'foo', 'bar' ] )

Search for artifacts with specified statuses

artifact_version_search( g => 'foo', a => 'bar', v => '1.0', repos => [ 'foo', 'bar' ] )

Search for all available artifact versions by GroupId and ArtifactId in local, remote or virtual repositories

artifact_latest_version_search_based_on_layout( g => 'foo', a => 'bar', v => '1.0', repos => [ 'foo', 'bar' ] )

Search for the latest artifact version by groupId and artifactId, based on the layout defined in the repository

artifact_latest_version_search_based_on_properties( repo => '_any', path => '/a/b', listFiles => 1 )

Search for artifacts with the latest value in the "version" property

build_artifacts_search( buildNumber => 15, buildName => 'foobar' )

Find all the artifacts related to a specific build

list_docker_repositories

Lists all Docker repositories hosted in under an Artifactory Docker repository.

SECURITY

get_users

Get the users list

get_user_details( $user )

Get the details of an Artifactory user

get_user_encrypted_password

Get the encrypted password of the authenticated requestor

create_or_replace_user( $user, %args )

Creates a new user in Artifactory or replaces an existing user

update_user( $user, %args )

Updates an exiting user in Artifactory with the provided user details

delete_user( $user )

Removes an Artifactory user

expire_password_for_a_single_user( $user )

Expires a user's password

expire_password_for_multiple_users( $user1, $user2 )

Expires password for a list of users

expire_password_for_all_users

Expires password for all users

unexpire_password_for_a_single_user( $user )

Unexpires a user's password

change_password( user => 'david', oldPassword => 'foo', newPassword => 'bar' )

Changes a user's password

get_password_expiration_policy

Retrieves the password expiration policy

set_password_expiration_policy

Sets the password expiration policy

configure_user_lock_policy( enabled => 'true|false', loginAttempts => $num )

Configures the user lock policy that locks users out of their account if the number of repeated incorrect login attempts exceeds the configured maximum allowed.

retrieve_user_lock_policy

Retrieves the currently configured user lock policy.

get_locked_out_users

If locking out users is enabled, lists all users that were locked out due to recurrent incorrect login attempts.

unlock_locked_out_user

Unlocks a single user that was locked out due to recurrent incorrect login attempts.

unlock_locked_out_users

Unlocks a list of users that were locked out due to recurrent incorrect login attempts.

unlock_all_locked_out_users

Unlocks all users that were locked out due to recurrent incorrect login attempts.

create_api_key( apiKey => '3OloposOtVFyCMrT+cXmCAScmVMPrSYXkWIjiyDCXsY=' )

Create an API key for the current user

get_api_key

Get the current user's own API key

revoke_api_key

Revokes the current user's API key

revoke_user_api_key

Revokes the API key of another user

revoke_all_api_keys

Revokes all API keys currently defined in the system

get_groups

Get the groups list

get_group_details( $group )

Get the details of an Artifactory Group

create_or_replace_group( $group, %args )

Creates a new group in Artifactory or replaces an existing group

update_group( $group, %args )

Updates an exiting group in Artifactory with the provided group details

delete_group( $group )

Removes an Artifactory group

get_permission_targets

Get the permission targets list

get_permission_target_details( $name )

Get the details of an Artifactory Permission Target

create_or_replace_permission_target( $name, %args )

Creates a new permission target in Artifactory or replaces an existing permission target

delete_permission_target( $name )

Deletes an Artifactory permission target

effective_item_permissions( $path )

Returns a list of effective permissions for the specified item (file or folder)

security_configuration

Retrieve the security configuration (security.xml)

activate_master_key_encryption

Creates a new master key and activates master key encryption

deactivate_master_key_encryption

Removes the current master key and deactivates master key encryption

set_gpg_public_key( key => $string )

Sets the public key that Artifactory provides to Debian clients to verify packages

get_gpg_public_key

Gets the public key that Artifactory provides to Debian clients to verify packages

set_gpg_private_key( key => $string )

Sets the private key that Artifactory will use to sign Debian packages

set_gpg_pass_phrase( $passphrase )

Sets the pass phrase required signing Debian packages using the private key

REPOSITORIES

get_repositories( $type )

Returns a list of minimal repository details for all repositories of the specified type

repository_configuration( $name, %args )

Retrieves the current configuration of a repository

create_or_replace_repository_configuration( $name, \%payload, %args )

Creates a new repository in Artifactory with the provided configuration or replaces the configuration of an existing repository

update_repository_configuration( $name, \%payload )

Updates an exiting repository configuration in Artifactory with the provided configuration elements

delete_repository( $name )

Removes a repository configuration together with the whole repository content

calculate_yum_repository_metadata( async => 0/1 )

Calculates/recalculates the YUM metdata for this repository, based on the RPM package currently hosted in the repository

calculate_nuget_repository_metadata

Recalculates all the NuGet packages for this repository (local/cache/virtual), and re-annotate the NuGet properties for each NuGet package according to it's internal nuspec file

calculate_npm_repository_metadata

Recalculates the npm search index for this repository (local/virtual). Please see the Npm integration documentation for more details.

calculate_maven_index( repos => [ 'repo1', 'repo2' ], force => 0/1 )

Calculates/caches a Maven index for the specified repositories

calculate_maven_metadata( $path )

Calculates Maven metadata on the specified path (local repositories only)

calculate_debian_repository_metadata( async => 0/1 )

Calculates/recalculates the Packages and Release metadata for this repository,based on the Debian packages in it. Calculation can be synchronous (the default) or asynchronous.

calculate_opkg_repository_metadata( async => 0/1, writeProps => 1 )

Calculates/recalculates the Packages and Release metadata for this repository,based on the ipk packages in it (in each feed location).

calculate_bower_index

Recalculates the index for a Bower repository.

SYSTEM & CONFIGURATION

system_info

Get general system information

verify_connection( endpoint => 'http://server/foobar', username => 'admin', password => 'password' )

Verifies a two-way connection between Artifactory and another product

system_health_ping

Get a simple status response about the state of Artifactory

general_configuration

Get the general configuration (artifactory.config.xml)

save_general_configuration( $file )

Save the general configuration (artifactory.config.xml)

update_custom_url_base( $url )

Changes the Custom URL base

license_information

Retrieve information about the currently installed license

install_license( $licensekey )

Install new license key or change the current one

version_and_addons_information

Retrieve information about the current Artifactory version, revision, and currently installed Add-ons

get_reverse_proxy_configuration

Retrieves the reverse proxy configuration

update_reverse_proxy_configuration(%data)

Updates the reverse proxy configuration

get_reverse_proxy_snippet

Gets the reverse proxy configuration snippet in text format

PLUGINS

execute_plugin_code( $execution_name, $params, $async )

Executes a named execution closure found in the executions section of a user plugin

retrieve_all_available_plugin_info

Retrieves all available user plugin information (subject to the permissions of the provided credentials)

retrieve_plugin_info_of_a_certain_type( $type )

Retrieves all available user plugin information (subject to the permissions of the provided credentials) of the specified type

retrieve_build_staging_strategy( strategyName => 'strategy1', buildName => 'build1', %args )

Retrieves a build staging strategy defined by a user plugin

execute_build_promotion( promotionName => 'promotion1', buildName => 'build1', buildNumber => 3, %args )

Executes a named promotion closure found in the promotions section of a user plugin

reload_plugins

Reloads user plugins if there are modifications since the last user plugins reload. Works regardless of the automatic user plugins refresh interval

IMPORT & EXPORT

import_repository_content( path => 'foobar', repo => 'repo', metadata => 1, verbose => 0 )

Import one or more repositories

import_system_settings_example

Returned default Import Settings JSON

full_system_import( importPath => '/import/path', includeMetadata => 'false' etc )

Import full system from a server local Artifactory export directory

export_system_settings_example

Returned default Export Settings JSON

export_system( exportPath => '/export/path', includeMetadata => 'true' etc )

Export full system to a server local directory

create_bundle( %hash of data structure )

Create a new support bundle

list_bundles

Lists previously created bundle currently stored in the system

get_bundle( $name )

Downloads a previously created bundle currently stored in the system

delete_bundle( $name )

Deletes a previously created bundle from the system.

AUTHOR

Satoshi Yagi, <satoshi.yagi at yahoo.com>

BUGS

Please report any bugs or feature requests to bug-artifactory-client at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Artifactory-Client. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Artifactory::Client

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2014-2015, Yahoo! Inc.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.