RubyGems Repositories

Artifactory provides full support for RubyGems repositories including:

For general information on configuring Artifactory to work with RubyGems, please refer to RubyGems Repositories.

All RubyGems commands, including gem source and gem push, must prepend the repository path with api/gems .

For example, if you are using Artifactory standalone or as a local service, you would access your RubyGems repositories using the following URL:

http://localhost:8081/artifactory/api/gems/<repository key>

Or, if you are using Artifactory Cloud, the URL would be:

https://<server name>.jfrog.io/artifactory/api/gems/<repository key>

Local RubyGems repositories are physical, locally-managed repositories into which you can deploy and manage your in-house Gems.

To create a local RubyGems repository, in the Administration module, under Repositories | Repositories | Local, click New Local Repository and set Gems to be the Package Type.

You can set up a local RubyGems repository as follows:

You need to add the repository source URL by modifying your ~/.gemrc file or using the gem source command as displayed below. You can extract the source URL by selecting the repository in the Tree Browser and clicking Set Me Up.

Notice that there are two sources. First, the remote proxy, then the local one. This will effectively allow you to retrieve Gems from both of them in the specified order.

gem source -a http://localhost:8081/artifactory/api/gems/my-gems-local/

Default Files

Upon creation of a Local RubyGems repository, Artifactory populates it with the following set of files that are required for indexing the repository:

• rubygems-update-*.gem (created under the gems folder of the repository)

• quick/Marshal.*

• latest_specs.*.gz

• prerelease_specs.*.gz

• specs.*.gz

The local RubyGems repository is displayed in the Application module | Artifactory | Artifacts.

Usage

First, setup the appropriate credentials for the gem tool: either include the API key in the ~/.gem/credentials file or issue this command:

Setting Up Credentials

curl http://localhost:8081/artifactory/api/gems/<repository key>/api/v1/api_key.yaml -u admin:password > ~/.gem/credentials

Running on Linux

You may need to change the permissions of the credentials file to 600 (chmod 600)

Running on Windows

The credentials file is located under %USERPROFILE%/.gem/credentials

You also need to set the API key encoding to be "ASCII". For example:

curl http://localhost:8081/artifactory/api/gems/<repository key>/api/v1/api_key.yaml | Out-File ~/.gem/credentials -Encoding "ASCII"

API keys

You can modify the credentials file manually and add different API keys. You can later use gem push -k key to choose the relevant API key.

In order to push gems to the local repository, you can set the global variable $RUBYGEMS_HOST to point to the local repository as follows:

Setting RUBYGEMS_HOST

export RUBYGEMS_HOST=http://localhost:8081/artifactory/api/gems/<repository key>

To get this value, select your repository in the Application module | Artifactory | Artifacts | Gems-local and click Set Me Up.

Alternatively you could use the gem push command with --host, and optionally, --key to specify the relevant API key.

Note

Make sure you are familiar with your effective sources and their order as specified in the ~/.gemrc file.

Also, make sure you are familiar with your global $RUBYGEMS_HOST variable before you issue a gem push command or use the push --host option.

When a local repository is first created, it is populated with rubygems-update-*.gemby default. In order to disable this behavior, you must change the system properties to include:Artifactory Configuration Files

artifactory.gems.gemsAfterRepoInitHack=false

Make sure you deploy to a "gems" folder

When deploying Gems to your repositories, you need to place them in a gems folder for Artifactory to include them in its indexing calculations.

A remote RubyGems repository serves as a caching proxy for a repository managed at a remote URL such as http://rubygems.org.

Once requested, artifacts (Gems) are cached on demand. They can then be removed, but you cannot manually deploy anything into a remote repository.

To create a remote RubyGems repository, execute the following steps:

A Virtual RubyGems repository (or "repository group") can aggregate multiple local and remote RubyGems repositories, seamlessly exposing them under a single URL.

The repository is virtual in that you can resolve and retrieve artifacts from it but you cannot deploy anything to it. For more information please refer to Virtual Repositories.

The procedure for setting up a virtual repository is very similar to setting up a local or remote repository, however as a last step, you need to select the repositories that will be included in the virtual repository you are creating.

The REST API provides access to the Gems Add-on through the repository key using the following URL:

http://localhost:8081/artifactory/api/gems/<repository key>/

In addition to the basic binary repository operations, such as download, deploy, delete etc., the following RubyGems.org API Gem commands are supported:

Indexing is done automatically by Artifactory in the background, however if you still need to recreate or update the spec index files, the following REST API commands are also available:

If you select a RubyGems artifact in the Tree Browser you can select the RubyGems tab to view detailed information on the selected artifact.

The Bundler Compact Index feature allows you to retrieve the latest RubyGems version compatible with your installed Ruby version in the project applies to local, remote, and virtual repositories.

To apply this feature, set the artifactory.gems.compact.index.enabled=true value in the artifactory.system.properties file.