org.ysb33r.gradle.jruby.api.resolver

Interface RubyGemQueryRestApi

public interface RubyGemQueryRestApi

Interface for querying a service that confirms to the RubyGem API. See https://guides.rubygems.org/rubygems-org-api

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	allVersions(java.lang.String gemName) Return all published versions for a specific GEM
java.util.List<java.lang.String>	allVersions(java.lang.String gemName, boolean includePrelease) Return all published versions for a specific GEM
java.lang.String	latestVersion(java.lang.String gemName) Return latest published version of GEM.
java.lang.String	latestVersion(java.lang.String gemName, boolean allowPrerelease) Return latest published version of GEM.
GemInfo	metadata(java.lang.String gemName, java.lang.String version) Returns the basic metadata for a GEM.

Method Detail

allVersions

java.util.List<java.lang.String> allVersions(java.lang.String gemName)
                                      throws org.ysb33r.gradle.jruby.api.resolver.ApiException

Return all published versions for a specific GEM

Parameters:

gemName - Name of GEM.

Returns:

List of versions. Can be empty if the GEM does not have any versions. Never null.

Throws:

org.ysb33r.gradle.jruby.api.resolver.ApiException - - if a networking or parser error occurs.

allVersions

java.util.List<java.lang.String> allVersions(java.lang.String gemName,
                                             boolean includePrelease)
                                      throws org.ysb33r.gradle.jruby.api.resolver.ApiException

Return all published versions for a specific GEM

Parameters:

gemName - Name of GEM.

includePrelease - Whether pre-release versions should be included.

Returns:

List of versions. Can be empty if the GEM does not have any versions. Never null.

Throws:

org.ysb33r.gradle.jruby.api.resolver.ApiException - - if a networking or parser error occurs.

latestVersion

java.lang.String latestVersion(java.lang.String gemName)
                        throws org.ysb33r.gradle.jruby.api.resolver.ApiException

Return latest published version of GEM.

Parameters:

gemName - Name of GEM.

Returns:

Version of GEM

Throws:

org.ysb33r.gradle.jruby.api.resolver.ApiException - if GEM does not exist.

latestVersion

java.lang.String latestVersion(java.lang.String gemName,
                               boolean allowPrerelease)
                        throws org.ysb33r.gradle.jruby.api.resolver.ApiException

Return latest published version of GEM.

Parameters:

gemName - Name of GEM.

allowPrerelease - Whether a prereleased version can be considered a latest version.

Returns:

Version of GEM

Throws:

org.ysb33r.gradle.jruby.api.resolver.ApiException - - if GEM does not exist.

metadata

GemInfo metadata(java.lang.String gemName,
                 java.lang.String version)
          throws org.ysb33r.gradle.jruby.api.resolver.ApiException

Returns the basic metadata for a GEM.

Parameters:

gemName - Name of GEM.

version - Version of GEM.

Returns:

Metadata for GEM

Throws:

org.ysb33r.gradle.jruby.api.resolver.ApiException - - if GEM + version does not exist.