rose-nielsen-sdk 0.0.2 → 0.0.3

data/lib/swagger_petstore/controllers/store_controller.rb

@@ -0,0 +1,94 @@
+# swagger_petstore
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module SwaggerPetstore
+  # StoreController
+  class StoreController < BaseController
+    # For valid response try integer IDs with value >= 1 and <= 10. Other values
+    # will generated exceptions
+    # @param [Integer] order_id Required parameter: ID of pet that needs to be
+    # fetched
+    # @return [Order] Response from the API call.
+    def get_order_by_id(order_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/store/order/{orderId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Order.method(:from_hash))
+                    .local_error('400',
+                                 'Invalid ID supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'Order not found',
+                                 APIException))
+        .execute
+    end
+
+    # For valid response try integer IDs with positive integer value. Negative
+    # or non-integer values will generate API errors
+    # @param [Integer] order_id Required parameter: ID of the order that needs
+    # to be deleted
+    # @return [void] Response from the API call.
+    def delete_order(order_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/store/order/{orderId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(order_id, key: 'orderId')
+                                    .should_encode(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .local_error('400',
+                                 'Invalid ID supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'Order not found',
+                                 APIException))
+        .execute
+    end
+
+    # Returns a map of status codes to quantities
+    # @return [Hash[String, Integer]] Response from the API call.
+    def get_inventory
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/store/inventory',
+                                     Server::DEFAULT)
+                   .auth(Single.new('api_key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:deserialize_primitive_types))
+                    .deserialize_into(proc do |response| response&.to_i end)
+                    .is_primitive_response(true))
+        .execute
+    end
+
+    # Place an order for a pet
+    # @param [StoreOrderRequest] body Required parameter: order placed for
+    # purchasing the pet
+    # @return [Order] Response from the API call.
+    def place_order(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/store/order',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Order.method(:from_hash))
+                    .local_error('400',
+                                 'Invalid Order',
+                                 APIException))
+        .execute
+    end
+  end
+end

data/lib/swagger_petstore/controllers/user_controller.rb

@@ -0,0 +1,165 @@
+# swagger_petstore
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module SwaggerPetstore
+  # UserController
+  class UserController < BaseController
+    # Creates list of users with given input array
+    # @param [Array[User]] body Required parameter: List of user object
+    # @return [void] Response from the API call.
+    def create_users_with_list_input(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/user/createWithList',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Get user by user name
+    # @param [String] username Required parameter: The name that needs to be
+    # fetched. Use user1 for testing.
+    # @return [User] Response from the API call.
+    def get_user_by_name(username)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/user/{username}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(username, key: 'username')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(User.method(:from_hash))
+                    .local_error('400',
+                                 'Invalid username supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'User not found',
+                                 APIException))
+        .execute
+    end
+
+    # This can only be done by the logged in user.
+    # @param [String] username Required parameter: name that need to be
+    # updated
+    # @param [UserRequest] body Required parameter: Updated user object
+    # @return [void] Response from the API call.
+    def update_user(username,
+                    body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/user/{username}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(username, key: 'username')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .local_error('400',
+                                 'Invalid user supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'User not found',
+                                 APIException))
+        .execute
+    end
+
+    # This can only be done by the logged in user.
+    # @param [String] username Required parameter: The name that needs to be
+    # deleted
+    # @return [void] Response from the API call.
+    def delete_user(username)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/user/{username}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(username, key: 'username')
+                                    .should_encode(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .local_error('400',
+                                 'Invalid username supplied',
+                                 APIException)
+                    .local_error('404',
+                                 'User not found',
+                                 APIException))
+        .execute
+    end
+
+    # Logs out current logged in user session
+    # @return [void] Response from the API call.
+    def logout_user
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/user/logout',
+                                     Server::DEFAULT))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # This can only be done by the logged in user.
+    # @param [UserRequest] body Required parameter: Created user object
+    # @return [void] Response from the API call.
+    def create_user(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/user',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Creates list of users with given input array
+    # @param [Array[User]] body Required parameter: List of user object
+    # @return [void] Response from the API call.
+    def create_users_with_array_input(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/user/createWithArray',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Logs user into the system
+    # @param [String] username Required parameter: The user name for login
+    # @param [String] password Required parameter: The password for login in
+    # clear text
+    # @return [String] Response from the API call.
+    def login_user(username,
+                   password)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/user/login',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(username, key: 'username'))
+                   .query_param(new_parameter(password, key: 'password')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:deserialize_primitive_types))
+                    .deserialize_into(proc do |response| response&.to_s end)
+                    .is_primitive_response(true)
+                    .local_error('400',
+                                 'Invalid username/password supplied',
+                                 APIException))
+        .execute
+    end
+  end
+end

data/lib/{cypress_test_api → swagger_petstore}/exceptions/api_exception.rb

@@ -1,9 +1,9 @@
-# cypress_test_api
+# swagger_petstore
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module CypressTestApi
+module SwaggerPetstore
   # Class for exceptions when there is a network error, status code error, etc.
   class APIException < CoreLibrary::ApiException
     # Provides a human-readable string representation of the object.

data/lib/swagger_petstore/exceptions/o_auth_provider_exception.rb

@@ -0,0 +1,64 @@
+# swagger_petstore
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module SwaggerPetstore
+  # OAuth 2 Authorization endpoint exception.
+  class OAuthProviderException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Gets or sets error code.
+    # @return [OAuthProviderErrorEnum]
+    attr_accessor :error
+
+    # Gets or sets human-readable text providing additional information on
+    # error.
+    # Used to assist the client developer in understanding the error that
+    # occurred.
+    # @return [String]
+    attr_accessor :error_description
+
+    # Gets or sets a URI identifying a human-readable web page with information
+    # about the error, used to provide the client developer with additional
+    # information about the error.
+    # @return [String]
+    attr_accessor :error_uri
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error = hash.key?('error') ? hash['error'] : nil
+      @error_description =
+        hash.key?('error_description') ? hash['error_description'] : SKIP
+      @error_uri = hash.key?('error_uri') ? hash['error_uri'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, error_description: #{@error_description}, error_uri:"\
+      " #{@error_uri}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, error_description: #{@error_description.inspect},"\
+      " error_uri: #{@error_uri.inspect}>"
+    end
+  end
+end

data/lib/swagger_petstore/http/auth/api_key.rb

@@ -0,0 +1,42 @@
+# swagger_petstore
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module SwaggerPetstore
+  # Utility class for custom header authorization.
+  class ApiKey < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ApiKey: api_key is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(api_key_credentials)
+      auth_params = {}
+      auth_params['api_key'] = api_key_credentials.api_key unless
+        api_key_credentials.nil? || api_key_credentials.api_key.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for ApiKeyCredentials.
+  # Data class for ApiKeyCredentials.
+  class ApiKeyCredentials
+    attr_reader :api_key
+
+    def initialize(api_key:)
+      raise ArgumentError, 'api_key cannot be nil' if api_key.nil?
+
+      @api_key = api_key
+    end
+
+    def clone_with(api_key: nil)
+      api_key ||= self.api_key
+
+      ApiKeyCredentials.new(api_key: api_key)
+    end
+  end
+end

data/lib/swagger_petstore/http/auth/http_basic.rb

@@ -0,0 +1,50 @@
+# swagger_petstore
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module SwaggerPetstore
+  # Utility class for basic authorization.
+  class HttpBasic < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'HttpBasic: username or passwprd is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(http_basic_credentials)
+      auth_params = {}
+      unless http_basic_credentials.nil? ||
+             http_basic_credentials.username.nil? ||
+             http_basic_credentials.passwprd.nil?
+        auth_params['Authorization'] =
+          "Basic #{AuthHelper.get_base64_encoded_value(http_basic_credentials.username,
+                                                       http_basic_credentials.passwprd)}"
+      end
+
+      super auth_params
+    end
+  end
+
+  # Data class for HttpBasicCredentials.
+  class HttpBasicCredentials
+    attr_reader :username, :passwprd
+
+    def initialize(username:, passwprd:)
+      raise ArgumentError, 'username cannot be nil' if username.nil?
+      raise ArgumentError, 'passwprd cannot be nil' if passwprd.nil?
+
+      @username = username
+      @passwprd = passwprd
+    end
+
+    def clone_with(username: nil, passwprd: nil)
+      username ||= self.username
+      passwprd ||= self.passwprd
+
+      HttpBasicCredentials.new(username: username, passwprd: passwprd)
+    end
+  end
+end

data/lib/swagger_petstore/http/auth/petstore_auth.rb

@@ -0,0 +1,98 @@
+# swagger_petstore
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module SwaggerPetstore
+  # Utility class for OAuth 2 authorization and token management.
+  class PetstoreAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'PetstoreAuth: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(petstore_auth_credentials, config)
+      auth_params = {}
+      @_o_auth_client_id = petstore_auth_credentials.o_auth_client_id unless
+        petstore_auth_credentials.nil? || petstore_auth_credentials.o_auth_client_id.nil?
+      @_o_auth_redirect_uri = petstore_auth_credentials.o_auth_redirect_uri unless
+        petstore_auth_credentials.nil? || petstore_auth_credentials.o_auth_redirect_uri.nil?
+      @_o_auth_token = petstore_auth_credentials.o_auth_token unless
+        petstore_auth_credentials.nil? || petstore_auth_credentials.o_auth_token.nil?
+      @_o_auth_scopes = petstore_auth_credentials.o_auth_scopes unless
+        petstore_auth_credentials.nil? || petstore_auth_credentials.o_auth_scopes.nil?
+      @_o_auth_api = OAuthAuthorizationController.new(config)
+      auth_params[:Authorization] = "Bearer #{@_o_auth_token.access_token}" unless @_o_auth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_o_auth_token.nil? && !token_expired?(@_o_auth_token)
+    end
+
+    # Builds and returns an authorization URL.
+    # The user is expected to obtain an authorization code from this URL and then call the
+    # fetch token function with that authorization code.
+    # @param [String] state An opaque state string.
+    # @param [Hash] additional_params Any additional query parameters to be added to the URL.
+    # @return [String] The authorization URL.
+    def get_authorization_url(state: nil, additional_params: nil)
+      auth_url = @_config.get_base_uri_executor.call(Server::DEFAULT)
+      auth_url += '/authorize'
+      query_params = {
+        'response_type' => 'code',
+        'client_id' => @_o_auth_client_id,
+        'redirect_uri' => @_o_auth_redirect_uri
+      }
+      query_params['scope'] = Array(@_o_auth_scopes).compact.join(' ') if @_o_auth_scopes
+      query_params['state'] = state if state
+      query_params.merge!(additional_params) if additional_params
+      auth_url = APIHelper.append_url_with_query_parameters(auth_url,
+                                                            query_params)
+      APIHelper.clean_url(auth_url)
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token is present and not expired.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+    end
+  end
+
+  # Data class for PetstoreAuthCredentials.
+  class PetstoreAuthCredentials
+    attr_reader :o_auth_client_id, :o_auth_redirect_uri, :o_auth_token,
+                :o_auth_scopes
+
+    def initialize(o_auth_client_id:, o_auth_redirect_uri:, o_auth_token: nil,
+                   o_auth_scopes: nil)
+      raise ArgumentError, 'o_auth_client_id cannot be nil' if o_auth_client_id.nil?
+      raise ArgumentError, 'o_auth_redirect_uri cannot be nil' if o_auth_redirect_uri.nil?
+
+      @o_auth_client_id = o_auth_client_id
+      @o_auth_redirect_uri = o_auth_redirect_uri
+      @o_auth_token = o_auth_token
+      @o_auth_scopes = o_auth_scopes
+    end
+
+    def clone_with(o_auth_client_id: nil, o_auth_redirect_uri: nil,
+                   o_auth_token: nil, o_auth_scopes: nil)
+      o_auth_client_id ||= self.o_auth_client_id
+      o_auth_redirect_uri ||= self.o_auth_redirect_uri
+      o_auth_token ||= self.o_auth_token
+      o_auth_scopes ||= self.o_auth_scopes
+
+      PetstoreAuthCredentials.new(o_auth_client_id: o_auth_client_id,
+                                  o_auth_redirect_uri: o_auth_redirect_uri,
+                                  o_auth_token: o_auth_token,
+                                  o_auth_scopes: o_auth_scopes)
+    end
+  end
+end

data/lib/{cypress_test_api → swagger_petstore}/http/http_call_back.rb

@@ -1,9 +1,9 @@
-# cypress_test_api
+# swagger_petstore
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module CypressTestApi
+module SwaggerPetstore
   # HttpCallBack allows defining callables for pre and post API calls.
   class HttpCallBack < CoreLibrary::HttpCallback
   end

data/lib/{cypress_test_api → swagger_petstore}/http/http_method_enum.rb

@@ -1,9 +1,9 @@
-# cypress_test_api
+# swagger_petstore
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module CypressTestApi
+module SwaggerPetstore
   # HTTP Methods Enumeration.
   class HttpMethodEnum < CoreLibrary::HttpMethod
   end

data/lib/{cypress_test_api → swagger_petstore}/http/http_request.rb

@@ -1,9 +1,9 @@
-# cypress_test_api
+# swagger_petstore
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module CypressTestApi
+module SwaggerPetstore
   # Represents a single Http Request.
   class HttpRequest < CoreLibrary::HttpRequest
   end

data/lib/{cypress_test_api → swagger_petstore}/http/http_response.rb

@@ -1,9 +1,9 @@
-# cypress_test_api
+# swagger_petstore
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module CypressTestApi
+module SwaggerPetstore
   # Http response received.
   class HttpResponse < CoreLibrary::HttpResponse
   end

data/lib/{cypress_test_api → swagger_petstore}/http/proxy_settings.rb

@@ -1,9 +1,9 @@
-# cypress_test_api
+# swagger_petstore
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module CypressTestApi
+module SwaggerPetstore
   ##
   # ProxySettings encapsulates HTTP proxy configuration for Faraday,
   # including optional basic authentication.