gopad 1.0.0 → 1.1.0

data/lib/gopad/api/user_api.rb

@@ -72,7 +72,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Notification'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'UserApi.attach_user_to_team',
@@ -139,7 +139,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'User'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'UserApi.create_user',
@@ -201,7 +201,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Notification'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'UserApi.delete_user',
@@ -274,7 +274,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Notification'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'UserApi.delete_user_from_team',
@@ -297,8 +297,8 @@ module Gopad
     # @param user_id [String] A user identifier or slug
     # @param [Hash] opts the optional parameters
     # @option opts [String] :search Search query
-    # @option opts [String] :sort Sorting column
-    # @option opts [String] :order Sorting order
+    # @option opts [String] :sort Sorting column (default to 'name')
+    # @option opts [String] :order Sorting order (default to 'asc')
     # @option opts [Integer] :limit Paging limit
     # @option opts [Integer] :offset Paging offset
     # @return [UserTeams]
@@ -311,8 +311,8 @@ module Gopad
     # @param user_id [String] A user identifier or slug
     # @param [Hash] opts the optional parameters
     # @option opts [String] :search Search query
-    # @option opts [String] :sort Sorting column
-    # @option opts [String] :order Sorting order
+    # @option opts [String] :sort Sorting column (default to 'name')
+    # @option opts [String] :order Sorting order (default to 'asc')
     # @option opts [Integer] :limit Paging limit
     # @option opts [Integer] :offset Paging offset
     # @return [Array<(UserTeams, Integer, Hash)>] UserTeams data, response status code and response headers
@@ -361,7 +361,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'UserTeams'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'UserApi.list_user_teams',
@@ -383,10 +383,10 @@ module Gopad
     # Fetch all available users
     # @param [Hash] opts the optional parameters
     # @option opts [String] :search Search query
-    # @option opts [String] :sort Sorting column
-    # @option opts [String] :order Sorting order
-    # @option opts [Integer] :limit Paging limit
-    # @option opts [Integer] :offset Paging offset
+    # @option opts [String] :sort Sorting column (default to 'username')
+    # @option opts [String] :order Sorting order (default to 'asc')
+    # @option opts [Integer] :limit Paging limit (default to 100)
+    # @option opts [Integer] :offset Paging offset (default to 0)
     # @return [Users]
     def list_users(opts = {})
       data, _status_code, _headers = list_users_with_http_info(opts)
@@ -396,10 +396,10 @@ module Gopad
     # Fetch all available users
     # @param [Hash] opts the optional parameters
     # @option opts [String] :search Search query
-    # @option opts [String] :sort Sorting column
-    # @option opts [String] :order Sorting order
-    # @option opts [Integer] :limit Paging limit
-    # @option opts [Integer] :offset Paging offset
+    # @option opts [String] :sort Sorting column (default to 'username')
+    # @option opts [String] :order Sorting order (default to 'asc')
+    # @option opts [Integer] :limit Paging limit (default to 100)
+    # @option opts [Integer] :offset Paging offset (default to 0)
     # @return [Array<(Users, Integer, Hash)>] Users data, response status code and response headers
     def list_users_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -441,7 +441,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Users'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'UserApi.list_users',
@@ -514,7 +514,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'Notification'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'UserApi.permit_user_team',
@@ -576,7 +576,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'User'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'UserApi.show_user',
@@ -649,7 +649,7 @@ module Gopad
       return_type = opts[:debug_return_type] || 'User'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header]
+      auth_names = opts[:debug_auth_names] || %w[Cookie Basic Header Bearer]
 
       new_options = opts.merge(
         operation: :'UserApi.update_user',

data/lib/gopad/configuration.rb

@@ -234,13 +234,6 @@ module Gopad
     # Returns Auth Settings hash for api client.
     def auth_settings
       {
-        'Cookie' =>
-          {
-            type: 'api_key',
-            in: 'header',
-            key: 'Cookie',
-            value: api_key_with_prefix('Cookie')
-          },
         'Header' =>
           {
             type: 'api_key',
@@ -248,12 +241,26 @@ module Gopad
             key: 'X-API-Key',
             value: api_key_with_prefix('Header')
           },
+        'Bearer' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
         'Basic' =>
           {
             type: 'basic',
             in: 'header',
             key: 'Authorization',
             value: basic_auth_token
+          },
+        'Cookie' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'Cookie',
+            value: api_key_with_prefix('Cookie')
           }
       }
     end

data/lib/gopad/models/auth_login.rb

@@ -0,0 +1,231 @@
+# Gopad OpenAPI
+#
+# API definition for Gopad, Etherpad for markdown with go
+#
+# The version of the OpenAPI document: 1.0.0-alpha1
+# Contact: gopad@webhippie.de
+# Generated by: https://openapi-generator.tech
+# Generator version: 7.6.0
+#
+
+require 'date'
+require 'time'
+
+module Gopad
+  class AuthLogin
+    attr_accessor :username, :password
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        username: :username,
+        password: :password
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        username: :String,
+        password: :String
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+              ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      unless attributes.is_a?(Hash)
+        raise ArgumentError, 'The input argument (attributes) must be a hash in `Gopad::AuthLogin` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) do |(k, v), h|
+        unless self.class.attribute_map.key?(k.to_sym)
+          raise ArgumentError, "`#{k}` is not a valid attribute in `Gopad::AuthLogin`. 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
+      end
+
+      self.username = if attributes.key?(:username)
+                        attributes[:username]
+                      end
+
+      self.password = if attributes.key?(:password)
+                        attributes[:password]
+                      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = []
+      if @username.nil?
+        invalid_properties.push('invalid value for "username", username cannot be nil.')
+      end
+
+      if @password.nil?
+        invalid_properties.push('invalid value for "password", password 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @username.nil?
+      return false if @password.nil?
+
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        username == other.username &&
+        password == other.password
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [username, password].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)
+      return nil unless attributes.is_a?(Hash)
+
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash[key.to_s] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Gopad.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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 = 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/gopad/models/auth_token.rb

@@ -0,0 +1,227 @@
+# Gopad OpenAPI
+#
+# API definition for Gopad, Etherpad for markdown with go
+#
+# The version of the OpenAPI document: 1.0.0-alpha1
+# Contact: gopad@webhippie.de
+# Generated by: https://openapi-generator.tech
+# Generator version: 7.6.0
+#
+
+require 'date'
+require 'time'
+
+module Gopad
+  class AuthToken
+    attr_accessor :token, :expires_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        token: :token,
+        expires_at: :expires_at
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        token: :String,
+        expires_at: :Time
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+                :expires_at
+              ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      unless attributes.is_a?(Hash)
+        raise ArgumentError, 'The input argument (attributes) must be a hash in `Gopad::AuthToken` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) do |(k, v), h|
+        unless self.class.attribute_map.key?(k.to_sym)
+          raise ArgumentError, "`#{k}` is not a valid attribute in `Gopad::AuthToken`. 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
+      end
+
+      self.token = if attributes.key?(:token)
+                     attributes[:token]
+                   end
+
+      if attributes.key?(:expires_at)
+        self.expires_at = attributes[:expires_at]
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = []
+      if @token.nil?
+        invalid_properties.push('invalid value for "token", token 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @token.nil?
+
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        token == other.token &&
+        expires_at == other.expires_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [token, expires_at].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)
+      return nil unless attributes.is_a?(Hash)
+
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash[key.to_s] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash[key.to_s] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash[key.to_s] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = Gopad.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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 = 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