pulp_file_client 0.3.0 → 1.0.0

data/lib/pulp_file_client/api/repositories_file_api.rb

@@ -23,7 +23,7 @@ module PulpFileClient
     #  FileRepository represents a single file repository, to which content can be synced, added, or removed.
     # @param data [FileFileRepository] 
     # @param [Hash] opts the optional parameters
-    # @return [FileFileRepository]
+    # @return [FileFileRepositoryRead]
     def create(data, opts = {})
       data, _status_code, _headers = create_with_http_info(data, opts)
       data
@@ -33,7 +33,7 @@ module PulpFileClient
     #  FileRepository represents a single file repository, to which content can be synced, added, or removed.
     # @param data [FileFileRepository] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(FileFileRepository, Integer, Hash)>] FileFileRepository data, response status code and response headers
+    # @return [Array<(FileFileRepositoryRead, Integer, Hash)>] FileFileRepositoryRead data, response status code and response headers
     def create_with_http_info(data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: RepositoriesFileApi.create ...'
@@ -62,7 +62,7 @@ module PulpFileClient
       post_body = opts[:body] || @api_client.object_to_http_body(data) 
 
       # return_type
-      return_type = opts[:return_type] || 'FileFileRepository' 
+      return_type = opts[:return_type] || 'FileFileRepositoryRead' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['Basic']
@@ -84,7 +84,7 @@ module PulpFileClient
     end
 
     # Delete a file repository
-    # Trigger an asynchronous task to delete a repository.
+    # Trigger an asynchronous delete task
     # @param file_repository_href [String] URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
     # @param [Hash] opts the optional parameters
     # @return [AsyncOperationResponse]
@@ -94,7 +94,7 @@ module PulpFileClient
     end
 
     # Delete a file repository
-    # Trigger an asynchronous task to delete a repository.
+    # Trigger an asynchronous delete task
     # @param file_repository_href [String] URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
     # @param [Hash] opts the optional parameters
     # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
@@ -293,22 +293,22 @@ module PulpFileClient
     end
 
     # Partially update a file repository
-    #  FileRepository represents a single file repository, to which content can be synced, added, or removed.
+    # Trigger an asynchronous partial update task
     # @param file_repository_href [String] URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
     # @param data [FileFileRepository] 
     # @param [Hash] opts the optional parameters
-    # @return [FileFileRepository]
+    # @return [AsyncOperationResponse]
     def partial_update(file_repository_href, data, opts = {})
       data, _status_code, _headers = partial_update_with_http_info(file_repository_href, data, opts)
       data
     end
 
     # Partially update a file repository
-    #  FileRepository represents a single file repository, to which content can be synced, added, or removed.
+    # Trigger an asynchronous partial update task
     # @param file_repository_href [String] URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
     # @param data [FileFileRepository] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(FileFileRepository, Integer, Hash)>] FileFileRepository data, response status code and response headers
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
     def partial_update_with_http_info(file_repository_href, data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: RepositoriesFileApi.partial_update ...'
@@ -341,7 +341,7 @@ module PulpFileClient
       post_body = opts[:body] || @api_client.object_to_http_body(data) 
 
       # return_type
-      return_type = opts[:return_type] || 'FileFileRepository' 
+      return_type = opts[:return_type] || 'AsyncOperationResponse' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['Basic']
@@ -368,7 +368,7 @@ module PulpFileClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
-    # @return [FileFileRepository]
+    # @return [FileFileRepositoryRead]
     def read(file_repository_href, opts = {})
       data, _status_code, _headers = read_with_http_info(file_repository_href, opts)
       data
@@ -380,7 +380,7 @@ module PulpFileClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
-    # @return [Array<(FileFileRepository, Integer, Hash)>] FileFileRepository data, response status code and response headers
+    # @return [Array<(FileFileRepositoryRead, Integer, Hash)>] FileFileRepositoryRead data, response status code and response headers
     def read_with_http_info(file_repository_href, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: RepositoriesFileApi.read ...'
@@ -409,7 +409,7 @@ module PulpFileClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'FileFileRepository' 
+      return_type = opts[:return_type] || 'FileFileRepositoryRead' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['Basic']
@@ -499,7 +499,7 @@ module PulpFileClient
     end
 
     # Update a file repository
-    # Trigger an asynchronous task to update a repository.
+    # Trigger an asynchronous update task
     # @param file_repository_href [String] URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
     # @param data [FileFileRepository] 
     # @param [Hash] opts the optional parameters
@@ -510,7 +510,7 @@ module PulpFileClient
     end
 
     # Update a file repository
-    # Trigger an asynchronous task to update a repository.
+    # Trigger an asynchronous update task
     # @param file_repository_href [String] URI of File Repository. e.g.: /pulp/api/v3/repositories/file/file/1/
     # @param data [FileFileRepository] 
     # @param [Hash] opts the optional parameters

data/lib/pulp_file_client/api/repositories_file_versions_api.rb

@@ -203,7 +203,7 @@ module PulpFileClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
-    # @return [RepositoryVersion]
+    # @return [RepositoryVersionRead]
     def read(file_repository_version_href, opts = {})
       data, _status_code, _headers = read_with_http_info(file_repository_version_href, opts)
       data
@@ -215,7 +215,7 @@ module PulpFileClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
-    # @return [Array<(RepositoryVersion, Integer, Hash)>] RepositoryVersion data, response status code and response headers
+    # @return [Array<(RepositoryVersionRead, Integer, Hash)>] RepositoryVersionRead data, response status code and response headers
     def read_with_http_info(file_repository_version_href, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: RepositoriesFileVersionsApi.read ...'
@@ -244,7 +244,7 @@ module PulpFileClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'RepositoryVersion' 
+      return_type = opts[:return_type] || 'RepositoryVersionRead' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['Basic']

data/lib/pulp_file_client/configuration.rb

@@ -122,7 +122,7 @@ module PulpFileClient
 
     def initialize
       @scheme = 'http'
-      @host = 'localhost'
+      @host = 'pulp'
       @base_path = ''
       @api_key = {}
       @api_key_prefix = {}
@@ -202,7 +202,7 @@ module PulpFileClient
     def server_settings
       [
         {
-          url: "http://localhost:24817/",
+          url: "http://pulp/",
           description: "No description provided",
         }
       ]

data/lib/pulp_file_client/models/{export.rb → export_read.rb}

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.2.3
 require 'date'
 
 module PulpFileClient
-  class Export
+  class ExportRead
     attr_accessor :pulp_href
 
     # Timestamp of creation.
@@ -53,6 +53,7 @@ module PulpFileClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'task',
       ])
     end
 
@@ -60,13 +61,13 @@ module PulpFileClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `PulpFileClient::Export` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PulpFileClient::ExportRead` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `PulpFileClient::Export`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PulpFileClient::ExportRead`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -98,22 +99,12 @@ module PulpFileClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @task.nil?
-        invalid_properties.push('invalid value for "task", task cannot be nil.')
-      end
-
-      if @params.nil?
-        invalid_properties.push('invalid value for "params", params cannot be nil.')
-      end
-
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @task.nil?
-      return false if @params.nil?
       true
     end
 

data/lib/pulp_file_client/models/{file_file_content.rb → file_file_content_read.rb}

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.2.3
 require 'date'
 
 module PulpFileClient
-  class FileFileContent
+  class FileFileContentRead
     attr_accessor :pulp_href
 
     # Timestamp of creation.
@@ -85,13 +85,13 @@ module PulpFileClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `PulpFileClient::FileFileContent` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PulpFileClient::FileFileContentRead` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `PulpFileClient::FileFileContent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PulpFileClient::FileFileContentRead`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/pulp_file_client/models/file_file_distribution_read.rb

@@ -0,0 +1,331 @@
+=begin
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'date'
+
+module PulpFileClient
+  class FileFileDistributionRead
+    attr_accessor :pulp_href
+
+    # Timestamp of creation.
+    attr_accessor :pulp_created
+
+    # The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\")
+    attr_accessor :base_path
+
+    # The URL for accessing the publication as defined by this distribution.
+    attr_accessor :base_url
+
+    # An optional content-guard.
+    attr_accessor :content_guard
+
+    # A unique name. Ex, `rawhide` and `stable`.
+    attr_accessor :name
+
+    # Publication to be served
+    attr_accessor :publication
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pulp_href' => :'pulp_href',
+        :'pulp_created' => :'pulp_created',
+        :'base_path' => :'base_path',
+        :'base_url' => :'base_url',
+        :'content_guard' => :'content_guard',
+        :'name' => :'name',
+        :'publication' => :'publication'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'pulp_href' => :'String',
+        :'pulp_created' => :'DateTime',
+        :'base_path' => :'String',
+        :'base_url' => :'String',
+        :'content_guard' => :'String',
+        :'name' => :'String',
+        :'publication' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'content_guard',
+        :'publication'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PulpFileClient::FileFileDistributionRead` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PulpFileClient::FileFileDistributionRead`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'pulp_href')
+        self.pulp_href = attributes[:'pulp_href']
+      end
+
+      if attributes.key?(:'pulp_created')
+        self.pulp_created = attributes[:'pulp_created']
+      end
+
+      if attributes.key?(:'base_path')
+        self.base_path = attributes[:'base_path']
+      end
+
+      if attributes.key?(:'base_url')
+        self.base_url = attributes[:'base_url']
+      end
+
+      if attributes.key?(:'content_guard')
+        self.content_guard = attributes[:'content_guard']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'publication')
+        self.publication = attributes[:'publication']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @base_path.nil?
+        invalid_properties.push('invalid value for "base_path", base_path cannot be nil.')
+      end
+
+      if @base_path.to_s.length < 1
+        invalid_properties.push('invalid value for "base_path", the character length must be great than or equal to 1.')
+      end
+
+      if !@base_url.nil? && @base_url.to_s.length < 1
+        invalid_properties.push('invalid value for "base_url", the character length must be great than or equal to 1.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @base_path.nil?
+      return false if @base_path.to_s.length < 1
+      return false if !@base_url.nil? && @base_url.to_s.length < 1
+      return false if @name.nil?
+      return false if @name.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] base_path Value to be assigned
+    def base_path=(base_path)
+      if base_path.nil?
+        fail ArgumentError, 'base_path cannot be nil'
+      end
+
+      if base_path.to_s.length < 1
+        fail ArgumentError, 'invalid value for "base_path", the character length must be great than or equal to 1.'
+      end
+
+      @base_path = base_path
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] base_url Value to be assigned
+    def base_url=(base_url)
+      if !base_url.nil? && base_url.to_s.length < 1
+        fail ArgumentError, 'invalid value for "base_url", the character length must be great than or equal to 1.'
+      end
+
+      @base_url = base_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          pulp_href == o.pulp_href &&
+          pulp_created == o.pulp_created &&
+          base_path == o.base_path &&
+          base_url == o.base_url &&
+          content_guard == o.content_guard &&
+          name == o.name &&
+          publication == o.publication
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [pulp_href, pulp_created, base_path, base_url, content_guard, name, publication].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        PulpFileClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/pulp_file_client/models/{file_file_file_system_exporter.rb → file_file_filesystem_exporter.rb}

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.2.3
 require 'date'
 
 module PulpFileClient
-  class FileFileFileSystemExporter
+  class FileFileFilesystemExporter
     attr_accessor :pulp_href
 
     # Timestamp of creation.
@@ -55,13 +55,13 @@ module PulpFileClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `PulpFileClient::FileFileFileSystemExporter` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PulpFileClient::FileFileFilesystemExporter` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `PulpFileClient::FileFileFileSystemExporter`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PulpFileClient::FileFileFilesystemExporter`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }