pulp_file_client 0.1.0b1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50d046dd679d64ae09a6c4e3a6cb3eda04eef253971e369b727e72070dbdf634
+  data.tar.gz: e83da6f101e2a1ef4d6359bb76c13e5ecfca6c59002271223cac617d1cafa074
+SHA512:
+  metadata.gz: ff4dddab242262052453c811b22b128bfae52a9c0c9a656391f30abb72872d0f32574179f105033536f936fa24d04b4ef4194cb1b534d1dd0c34f72f3981b9a6
+  data.tar.gz: 146aabec554b0a4675e9cc3618c9b65b1afac8d324ffb330586d49d77a444cff62a6c86386ff7e0407f57f1c4508995298764b3a20f598f354024d1a74fd5e36

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    pulp_file_client (0.1.0b1)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  pulp_file_client!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,127 @@
+# pulp_file_client
+
+PulpFileClient - the Ruby gem for the Pulp 3 API
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: v3
+- Package version: 0.1.0b1
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build pulp_file_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./pulp_file_client-0.1.0b1.gem
+```
+
+(for development, run `gem install --dev ./pulp_file_client-0.1.0b1.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_file_client', '~> 0.1.0b1'
+
+### 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_file_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_file_client'
+
+# Setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::ContentFilesApi.new
+data = PulpFileClient::FileContent.new # FileContent | 
+
+begin
+  #Create a file content
+  result = api_instance.create(data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling ContentFilesApi->create: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:24817*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PulpFileClient::ContentFilesApi* | [**create**](docs/ContentFilesApi.md#create) | **POST** /pulp/api/v3/content/file/files/ | Create a file content
+*PulpFileClient::ContentFilesApi* | [**list**](docs/ContentFilesApi.md#list) | **GET** /pulp/api/v3/content/file/files/ | List file contents
+*PulpFileClient::ContentFilesApi* | [**read**](docs/ContentFilesApi.md#read) | **GET** {file_content_href} | Inspect a file content
+*PulpFileClient::DistributionsFileApi* | [**create**](docs/DistributionsFileApi.md#create) | **POST** /pulp/api/v3/distributions/file/file/ | Create a file distribution
+*PulpFileClient::DistributionsFileApi* | [**delete**](docs/DistributionsFileApi.md#delete) | **DELETE** {file_distribution_href} | Delete a file distribution
+*PulpFileClient::DistributionsFileApi* | [**list**](docs/DistributionsFileApi.md#list) | **GET** /pulp/api/v3/distributions/file/file/ | List file distributions
+*PulpFileClient::DistributionsFileApi* | [**partial_update**](docs/DistributionsFileApi.md#partial_update) | **PATCH** {file_distribution_href} | Partially update a file distribution
+*PulpFileClient::DistributionsFileApi* | [**read**](docs/DistributionsFileApi.md#read) | **GET** {file_distribution_href} | Inspect a file distribution
+*PulpFileClient::DistributionsFileApi* | [**update**](docs/DistributionsFileApi.md#update) | **PUT** {file_distribution_href} | Update a file distribution
+*PulpFileClient::PublicationsFileApi* | [**create**](docs/PublicationsFileApi.md#create) | **POST** /pulp/api/v3/publications/file/file/ | Create a file publication
+*PulpFileClient::PublicationsFileApi* | [**delete**](docs/PublicationsFileApi.md#delete) | **DELETE** {file_publication_href} | Delete a file publication
+*PulpFileClient::PublicationsFileApi* | [**list**](docs/PublicationsFileApi.md#list) | **GET** /pulp/api/v3/publications/file/file/ | List file publications
+*PulpFileClient::PublicationsFileApi* | [**read**](docs/PublicationsFileApi.md#read) | **GET** {file_publication_href} | Inspect a file publication
+*PulpFileClient::RemotesFileApi* | [**create**](docs/RemotesFileApi.md#create) | **POST** /pulp/api/v3/remotes/file/file/ | Create a file remote
+*PulpFileClient::RemotesFileApi* | [**delete**](docs/RemotesFileApi.md#delete) | **DELETE** {file_remote_href} | Delete a file remote
+*PulpFileClient::RemotesFileApi* | [**list**](docs/RemotesFileApi.md#list) | **GET** /pulp/api/v3/remotes/file/file/ | List file remotes
+*PulpFileClient::RemotesFileApi* | [**partial_update**](docs/RemotesFileApi.md#partial_update) | **PATCH** {file_remote_href} | Partially update a file remote
+*PulpFileClient::RemotesFileApi* | [**read**](docs/RemotesFileApi.md#read) | **GET** {file_remote_href} | Inspect a file remote
+*PulpFileClient::RemotesFileApi* | [**sync**](docs/RemotesFileApi.md#sync) | **POST** {file_remote_href}sync/ | 
+*PulpFileClient::RemotesFileApi* | [**update**](docs/RemotesFileApi.md#update) | **PUT** {file_remote_href} | Update a file remote
+
+
+## Documentation for Models
+
+ - [PulpFileClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
+ - [PulpFileClient::FileContent](docs/FileContent.md)
+ - [PulpFileClient::FileDistribution](docs/FileDistribution.md)
+ - [PulpFileClient::FilePublication](docs/FilePublication.md)
+ - [PulpFileClient::FileRemote](docs/FileRemote.md)
+ - [PulpFileClient::InlineResponse200](docs/InlineResponse200.md)
+ - [PulpFileClient::InlineResponse2001](docs/InlineResponse2001.md)
+ - [PulpFileClient::InlineResponse2002](docs/InlineResponse2002.md)
+ - [PulpFileClient::InlineResponse2003](docs/InlineResponse2003.md)
+ - [PulpFileClient::RepositorySyncURL](docs/RepositorySyncURL.md)
+
+
+## Documentation for Authorization
+
+
+### Basic
+
+- **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 @@
+# PulpFileClient::AsyncOperationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**task** | **String** | The href of the task. | 
+
+## Code Sample
+
+```ruby
+require 'PulpFileClient'
+
+instance = PulpFileClient::AsyncOperationResponse.new(task: null)
+```
+
+

data/docs/ContentFilesApi.md

@@ -0,0 +1,184 @@
+# PulpFileClient::ContentFilesApi
+
+All URIs are relative to *http://localhost:24817*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](ContentFilesApi.md#create) | **POST** /pulp/api/v3/content/file/files/ | Create a file content
+[**list**](ContentFilesApi.md#list) | **GET** /pulp/api/v3/content/file/files/ | List file contents
+[**read**](ContentFilesApi.md#read) | **GET** {file_content_href} | Inspect a file content
+
+
+
+## create
+
+> FileContent create(data)
+
+Create a file content
+
+<!-- User-facing documentation, rendered as html--> FileContent represents a single file and its metadata, which can be added and removed from repositories.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::ContentFilesApi.new
+data = PulpFileClient::FileContent.new # FileContent | 
+
+begin
+  #Create a file content
+  result = api_instance.create(data)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling ContentFilesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **data** | [**FileContent**](FileContent.md)|  | 
+
+### Return type
+
+[**FileContent**](FileContent.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list
+
+> InlineResponse200 list(opts)
+
+List file contents
+
+<!-- User-facing documentation, rendered as html--> FileContent represents a single file and its metadata, which can be added and removed from repositories.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::ContentFilesApi.new
+opts = {
+  relative_path: 'relative_path_example', # String | Filter results where relative_path matches value
+  digest: 'digest_example', # String | Filter results where digest matches value
+  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
+  page: 56, # Integer | A page number within the paginated result set.
+  page_size: 56 # Integer | Number of results to return per page.
+}
+
+begin
+  #List file contents
+  result = api_instance.list(opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling ContentFilesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **relative_path** | **String**| Filter results where relative_path matches value | [optional] 
+ **digest** | **String**| Filter results where digest matches value | [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] 
+ **page** | **Integer**| A page number within the paginated result set. | [optional] 
+ **page_size** | **Integer**| Number of results to return per page. | [optional] 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> FileContent read(file_content_href)
+
+Inspect a file content
+
+<!-- User-facing documentation, rendered as html--> FileContent represents a single file and its metadata, which can be added and removed from repositories.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::ContentFilesApi.new
+file_content_href = 'file_content_href_example' # String | URI of File Content. e.g.: /pulp/api/v3/content/file/files/1/
+
+begin
+  #Inspect a file content
+  result = api_instance.read(file_content_href)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling ContentFilesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_content_href** | **String**| URI of File Content. e.g.: /pulp/api/v3/content/file/files/1/ | 
+
+### Return type
+
+[**FileContent**](FileContent.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+