pulp_gem_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1388894d978d4a7b49acc0b8af3291d056ba70a255694b14f8984a5aa3312b6
+  data.tar.gz: b56bcdaaccdc131b44d5c95ef96e1bd2cd59c153d10ac61e2b3a70bdf57953d1
+SHA512:
+  metadata.gz: 0b4261fac86fc60dc7c88fef11205b2f2a404fb2d69b427e55356b472b5c5454cd0a306067baaa575ed8ecdba0290dab836114746bcbd3920b25ab49fd5185c6
+  data.tar.gz: d6f1fda8755da75ece6b48df700a772e333f841a1ec348627ae899de8a3bb1cf820cd5e03caa384bb8f4ac9fe16636dce339400805891d71407c695ae33d73b0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,160 @@
+# pulp_gem_client
+
+PulpGemClient - the Ruby gem for the Pulp 3 API
+
+Fetch, Upload, Organize, and Distribute Software Packages
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v3
+- Package version: 0.1.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://pulpproject.org](https://pulpproject.org)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pulp_gem_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./pulp_gem_client-0.1.0.gem
+```
+
+(for development, run `gem install --dev ./pulp_gem_client-0.1.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'pulp_gem_client', '~> 0.1.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'pulp_gem_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'pulp_gem_client'
+
+# Setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+end
+
+api_instance = PulpGemClient::ContentGemApi.new
+opts = {
+  artifact: 'artifact_example', # String | Artifact file representing the physical content
+  file: File.new('/path/to/file'), # File | An uploaded file that should be turned into the artifact of the content unit.
+  repository: 'repository_example' # String | A URI of a repository the new content unit should be associated with.
+}
+
+begin
+  #Create a gem content
+  result = api_instance.create(opts)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling ContentGemApi->create: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://pulp*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PulpGemClient::ContentGemApi* | [**create**](docs/ContentGemApi.md#create) | **POST** /pulp/api/v3/content/gem/gem/ | Create a gem content
+*PulpGemClient::ContentGemApi* | [**list**](docs/ContentGemApi.md#list) | **GET** /pulp/api/v3/content/gem/gem/ | List gem contents
+*PulpGemClient::ContentGemApi* | [**read**](docs/ContentGemApi.md#read) | **GET** {gem_gem_content_href} | Inspect a gem content
+*PulpGemClient::DistributionsGemApi* | [**create**](docs/DistributionsGemApi.md#create) | **POST** /pulp/api/v3/distributions/gem/gem/ | Create a gem distribution
+*PulpGemClient::DistributionsGemApi* | [**delete**](docs/DistributionsGemApi.md#delete) | **DELETE** {gem_gem_distribution_href} | Delete a gem distribution
+*PulpGemClient::DistributionsGemApi* | [**list**](docs/DistributionsGemApi.md#list) | **GET** /pulp/api/v3/distributions/gem/gem/ | List gem distributions
+*PulpGemClient::DistributionsGemApi* | [**partial_update**](docs/DistributionsGemApi.md#partial_update) | **PATCH** {gem_gem_distribution_href} | Update a gem distribution
+*PulpGemClient::DistributionsGemApi* | [**read**](docs/DistributionsGemApi.md#read) | **GET** {gem_gem_distribution_href} | Inspect a gem distribution
+*PulpGemClient::DistributionsGemApi* | [**update**](docs/DistributionsGemApi.md#update) | **PUT** {gem_gem_distribution_href} | Update a gem distribution
+*PulpGemClient::PublicationsGemApi* | [**create**](docs/PublicationsGemApi.md#create) | **POST** /pulp/api/v3/publications/gem/gem/ | Create a gem publication
+*PulpGemClient::PublicationsGemApi* | [**delete**](docs/PublicationsGemApi.md#delete) | **DELETE** {gem_gem_publication_href} | Delete a gem publication
+*PulpGemClient::PublicationsGemApi* | [**list**](docs/PublicationsGemApi.md#list) | **GET** /pulp/api/v3/publications/gem/gem/ | List gem publications
+*PulpGemClient::PublicationsGemApi* | [**read**](docs/PublicationsGemApi.md#read) | **GET** {gem_gem_publication_href} | Inspect a gem publication
+*PulpGemClient::RemotesGemApi* | [**create**](docs/RemotesGemApi.md#create) | **POST** /pulp/api/v3/remotes/gem/gem/ | Create a gem remote
+*PulpGemClient::RemotesGemApi* | [**delete**](docs/RemotesGemApi.md#delete) | **DELETE** {gem_gem_remote_href} | Delete a gem remote
+*PulpGemClient::RemotesGemApi* | [**list**](docs/RemotesGemApi.md#list) | **GET** /pulp/api/v3/remotes/gem/gem/ | List gem remotes
+*PulpGemClient::RemotesGemApi* | [**partial_update**](docs/RemotesGemApi.md#partial_update) | **PATCH** {gem_gem_remote_href} | Update a gem remote
+*PulpGemClient::RemotesGemApi* | [**read**](docs/RemotesGemApi.md#read) | **GET** {gem_gem_remote_href} | Inspect a gem remote
+*PulpGemClient::RemotesGemApi* | [**update**](docs/RemotesGemApi.md#update) | **PUT** {gem_gem_remote_href} | Update a gem remote
+*PulpGemClient::RepositoriesGemApi* | [**create**](docs/RepositoriesGemApi.md#create) | **POST** /pulp/api/v3/repositories/gem/gem/ | Create a gem repository
+*PulpGemClient::RepositoriesGemApi* | [**delete**](docs/RepositoriesGemApi.md#delete) | **DELETE** {gem_gem_repository_href} | Delete a gem repository
+*PulpGemClient::RepositoriesGemApi* | [**list**](docs/RepositoriesGemApi.md#list) | **GET** /pulp/api/v3/repositories/gem/gem/ | List gem repositorys
+*PulpGemClient::RepositoriesGemApi* | [**modify**](docs/RepositoriesGemApi.md#modify) | **POST** {gem_gem_repository_href}modify/ | Modify Repository Content
+*PulpGemClient::RepositoriesGemApi* | [**partial_update**](docs/RepositoriesGemApi.md#partial_update) | **PATCH** {gem_gem_repository_href} | Update a gem repository
+*PulpGemClient::RepositoriesGemApi* | [**read**](docs/RepositoriesGemApi.md#read) | **GET** {gem_gem_repository_href} | Inspect a gem repository
+*PulpGemClient::RepositoriesGemApi* | [**sync**](docs/RepositoriesGemApi.md#sync) | **POST** {gem_gem_repository_href}sync/ | Sync from a remote
+*PulpGemClient::RepositoriesGemApi* | [**update**](docs/RepositoriesGemApi.md#update) | **PUT** {gem_gem_repository_href} | Update a gem repository
+*PulpGemClient::RepositoriesGemVersionsApi* | [**delete**](docs/RepositoriesGemVersionsApi.md#delete) | **DELETE** {gem_gem_repository_version_href} | Delete a repository version
+*PulpGemClient::RepositoriesGemVersionsApi* | [**list**](docs/RepositoriesGemVersionsApi.md#list) | **GET** {gem_gem_repository_href}versions/ | List repository versions
+*PulpGemClient::RepositoriesGemVersionsApi* | [**read**](docs/RepositoriesGemVersionsApi.md#read) | **GET** {gem_gem_repository_version_href} | Inspect a repository version
+*PulpGemClient::RepositoriesGemVersionsApi* | [**repair**](docs/RepositoriesGemVersionsApi.md#repair) | **POST** {gem_gem_repository_version_href}repair/ | 
+
+
+## Documentation for Models
+
+ - [PulpGemClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
+ - [PulpGemClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
+ - [PulpGemClient::GemGemContent](docs/GemGemContent.md)
+ - [PulpGemClient::GemGemContentResponse](docs/GemGemContentResponse.md)
+ - [PulpGemClient::GemGemDistribution](docs/GemGemDistribution.md)
+ - [PulpGemClient::GemGemDistributionResponse](docs/GemGemDistributionResponse.md)
+ - [PulpGemClient::GemGemPublication](docs/GemGemPublication.md)
+ - [PulpGemClient::GemGemPublicationResponse](docs/GemGemPublicationResponse.md)
+ - [PulpGemClient::GemGemRemote](docs/GemGemRemote.md)
+ - [PulpGemClient::GemGemRemoteResponse](docs/GemGemRemoteResponse.md)
+ - [PulpGemClient::GemGemRemoteResponseHiddenFields](docs/GemGemRemoteResponseHiddenFields.md)
+ - [PulpGemClient::GemGemRepository](docs/GemGemRepository.md)
+ - [PulpGemClient::GemGemRepositoryResponse](docs/GemGemRepositoryResponse.md)
+ - [PulpGemClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
+ - [PulpGemClient::PaginatedgemGemContentResponseList](docs/PaginatedgemGemContentResponseList.md)
+ - [PulpGemClient::PaginatedgemGemDistributionResponseList](docs/PaginatedgemGemDistributionResponseList.md)
+ - [PulpGemClient::PaginatedgemGemPublicationResponseList](docs/PaginatedgemGemPublicationResponseList.md)
+ - [PulpGemClient::PaginatedgemGemRemoteResponseList](docs/PaginatedgemGemRemoteResponseList.md)
+ - [PulpGemClient::PaginatedgemGemRepositoryResponseList](docs/PaginatedgemGemRepositoryResponseList.md)
+ - [PulpGemClient::PatchedgemGemDistribution](docs/PatchedgemGemDistribution.md)
+ - [PulpGemClient::PatchedgemGemRemote](docs/PatchedgemGemRemote.md)
+ - [PulpGemClient::PatchedgemGemRepository](docs/PatchedgemGemRepository.md)
+ - [PulpGemClient::PolicyEnum](docs/PolicyEnum.md)
+ - [PulpGemClient::Repair](docs/Repair.md)
+ - [PulpGemClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
+ - [PulpGemClient::RepositorySyncURL](docs/RepositorySyncURL.md)
+ - [PulpGemClient::RepositoryVersionResponse](docs/RepositoryVersionResponse.md)
+
+
+## Documentation for Authorization
+
+
+### basicAuth
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AsyncOperationResponse.md

@@ -0,0 +1,17 @@
+# PulpGemClient::AsyncOperationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task** | **String** | The href of the task. | 
+
+## Code Sample
+
+```ruby
+require 'PulpGemClient'
+
+instance = PulpGemClient::AsyncOperationResponse.new(task: null)
+```
+
+

data/docs/ContentGemApi.md

@@ -0,0 +1,210 @@
+# PulpGemClient::ContentGemApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentGemApi.md#create) | **POST** /pulp/api/v3/content/gem/gem/ | Create a gem content
+[**list**](ContentGemApi.md#list) | **GET** /pulp/api/v3/content/gem/gem/ | List gem contents
+[**read**](ContentGemApi.md#read) | **GET** {gem_gem_content_href} | Inspect a gem content
+
+
+
+## create
+
+> AsyncOperationResponse create(opts)
+
+Create a gem content
+
+Trigger an asynchronous task to create content,optionally create new repository version.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::ContentGemApi.new
+opts = {
+  artifact: 'artifact_example', # String | Artifact file representing the physical content
+  file: File.new('/path/to/file'), # File | An uploaded file that should be turned into the artifact of the content unit.
+  repository: 'repository_example' # String | A URI of a repository the new content unit should be associated with.
+}
+
+begin
+  #Create a gem content
+  result = api_instance.create(opts)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling ContentGemApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **artifact** | **String**| Artifact file representing the physical content | [optional] 
+ **file** | **File**| An uploaded file that should be turned into the artifact of the content unit. | [optional] 
+ **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedgemGemContentResponseList list(opts)
+
+List gem contents
+
+A ViewSet for GemContent.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::ContentGemApi.new
+opts = {
+  checksum: 'checksum_example', # String | Filter results where checksum matches value
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | Filter results where name matches value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `name` - Name * `-name` - Name (descending) * `version` - Version * `-version` - Version (descending) * `checksum` - Checksum * `-checksum` - Checksum (descending) * `prerelease` - Prerelease * `-prerelease` - Prerelease (descending) * `dependencies` - Dependencies * `-dependencies` - Dependencies (descending) * `required_ruby_version` - Required ruby version * `-required_ruby_version` - Required ruby version (descending) * `required_rubygems_version` - Required rubygems version * `-required_rubygems_version` - Required rubygems version (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  prerelease: true, # Boolean | Filter results where prerelease matches value
+  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
+  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
+  version: 'version_example', # String | Filter results where version matches value
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #List gem contents
+  result = api_instance.list(opts)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling ContentGemApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **checksum** | **String**| Filter results where checksum matches value | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;version&#x60; - Version * &#x60;-version&#x60; - Version (descending) * &#x60;checksum&#x60; - Checksum * &#x60;-checksum&#x60; - Checksum (descending) * &#x60;prerelease&#x60; - Prerelease * &#x60;-prerelease&#x60; - Prerelease (descending) * &#x60;dependencies&#x60; - Dependencies * &#x60;-dependencies&#x60; - Dependencies (descending) * &#x60;required_ruby_version&#x60; - Required ruby version * &#x60;-required_ruby_version&#x60; - Required ruby version (descending) * &#x60;required_rubygems_version&#x60; - Required rubygems version * &#x60;-required_rubygems_version&#x60; - Required rubygems version (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
+ **prerelease** | **Boolean**| Filter results where prerelease matches value | [optional] 
+ **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_added** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional] 
+ **version** | **String**| Filter results where version matches value | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PaginatedgemGemContentResponseList**](PaginatedgemGemContentResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> GemGemContentResponse read(gem_gem_content_href, opts)
+
+Inspect a gem content
+
+A ViewSet for GemContent.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_gem_client'
+# setup authorization
+PulpGemClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpGemClient::ContentGemApi.new
+gem_gem_content_href = 'gem_gem_content_href_example' # String | 
+opts = {
+  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect a gem content
+  result = api_instance.read(gem_gem_content_href, opts)
+  p result
+rescue PulpGemClient::ApiError => e
+  puts "Exception when calling ContentGemApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gem_gem_content_href** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**GemGemContentResponse**](GemGemContentResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ContentSummaryResponse.md

@@ -0,0 +1,21 @@
+# PulpGemClient::ContentSummaryResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**added** | **Hash<String, Object>** |  | 
+**removed** | **Hash<String, Object>** |  | 
+**present** | **Hash<String, Object>** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpGemClient'
+
+instance = PulpGemClient::ContentSummaryResponse.new(added: null,
+                                 removed: null,
+                                 present: null)
+```
+
+