peal 0.2.0 → 0.3.0

data/lib/peal/api_client.rb

@@ -1,441 +0,0 @@
-=begin
-#Peal API
-
-#Schedule posts across social platforms, follow how they did, and manage a Peal workspace's channels, media and members.
-
-The version of the OpenAPI document: 0.0.1
-Contact: hello@peal.social
-Generated by: https://openapi-generator.tech
-Generator version: 7.27.0
-
-=end
-
-require 'date'
-require 'json'
-require 'logger'
-require 'tempfile'
-require 'time'
-require 'faraday'
-require 'faraday/multipart' if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
-require 'marcel'
-
-
-module Peal
-  class ApiClient
-    # The Configuration object holding settings to be used in the API client.
-    attr_accessor :config
-
-    # Defines the headers to be used in HTTP requests of all API calls by default.
-    #
-    # @return [Hash]
-    attr_accessor :default_headers
-
-    # Initializes the ApiClient
-    # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
-    def initialize(config = Configuration.default)
-      @config = config
-      @user_agent = "OpenAPI-Generator/#{VERSION}/ruby"
-      @default_headers = {
-        'Content-Type' => 'application/json',
-        'User-Agent' => @user_agent
-      }
-    end
-
-    def self.default
-      @@default ||= ApiClient.new
-    end
-
-    # Call an API with given options.
-    #
-    # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
-    #   the data deserialized from response body (could be nil), response status code and response headers.
-    def call_api(http_method, path, opts = {})
-      stream = nil
-      begin
-        response = connection(opts).public_send(http_method.to_sym.downcase) do |req|
-          request = build_request(http_method, path, req, opts)
-          stream = download_file(request) if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
-        end
-
-        if config.debugging
-          config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
-        end
-
-        unless response.success?
-          if response.status == 0 && response.respond_to?(:return_message)
-            # Errors from libcurl will be made visible here
-            fail ApiError.new(code: 0,
-                              message: response.return_message)
-          else
-            fail ApiError.new(code: response.status,
-                              response_headers: response.headers,
-                              response_body: response.body),
-                 response.reason_phrase
-          end
-        end
-      rescue Faraday::TimeoutError
-        fail ApiError.new('Connection timed out')
-      rescue Faraday::ConnectionFailed
-        fail ApiError.new('Connection failed')
-      end
-
-      if opts[:return_type] == 'File' || opts[:return_type] == 'Binary'
-        data = deserialize_file(response, stream)
-      elsif opts[:return_type]
-        data = deserialize(response, opts[:return_type])
-      else
-        data = nil
-      end
-      return data, response.status, response.headers
-    end
-
-    # Builds the HTTP request
-    #
-    # @param [String] http_method HTTP method/verb (e.g. POST)
-    # @param [String] path URL path (e.g. /account/new)
-    # @option opts [Hash] :header_params Header parameters
-    # @option opts [Hash] :query_params Query parameters
-    # @option opts [Hash] :form_params Query parameters
-    # @option opts [Object] :body HTTP body (JSON/XML)
-    # @return [Faraday::Request] A Faraday Request
-    def build_request(http_method, path, request, opts = {})
-      url = build_request_url(path, opts)
-      http_method = http_method.to_sym.downcase
-
-      header_params = @default_headers.merge(opts[:header_params] || {})
-      query_params = opts[:query_params] || {}
-      form_params = opts[:form_params] || {}
-
-      update_params_for_auth! header_params, query_params, opts[:auth_names]
-
-      if [:post, :patch, :put, :delete].include?(http_method)
-        req_body = build_request_body(header_params, form_params, opts[:body])
-        if config.debugging
-          config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
-        end
-      end
-      request.headers = header_params
-      request.body = req_body
-
-      # Overload default options only if provided
-      request.options.params_encoder = config.params_encoder if config.params_encoder
-      request.options.timeout        = config.timeout        if config.timeout
-
-      request.url url
-      request.params = query_params
-      request
-    end
-
-    # Builds the HTTP request body
-    #
-    # @param [Hash] header_params Header parameters
-    # @param [Hash] form_params Query parameters
-    # @param [Object] body HTTP body (JSON/XML)
-    # @return [String] HTTP body data in the form of string
-    def build_request_body(header_params, form_params, body)
-      # http form
-      if header_params['Content-Type'] == 'application/x-www-form-urlencoded'
-        data = URI.encode_www_form(form_params)
-      elsif header_params['Content-Type'] == 'multipart/form-data'
-        data = {}
-        form_params.each do |key, value|
-          case value
-          when ::File, ::Tempfile
-            data[key] = Faraday::FilePart.new(value.path, Marcel::MimeType.for(Pathname.new(value.path)))
-          when ::Array, nil
-            # let Faraday handle Array and nil parameters
-            data[key] = value
-          else
-            data[key] = value.to_s
-          end
-        end
-      elsif body
-        data = body.is_a?(String) ? body : body.to_json
-      else
-        data = nil
-      end
-      data
-    end
-
-    def download_file(request)
-      stream = []
-
-      # handle streaming Responses
-      request.options.on_data = Proc.new do |chunk, overall_received_bytes|
-        stream << chunk
-      end
-
-      stream
-    end
-
-    def deserialize_file(response, stream)
-      body     = response.body
-      encoding = body.encoding
-
-      # reconstruct content
-      content = stream.join
-      content = content.unpack('m').join if response.headers['Content-Transfer-Encoding'] == 'binary'
-      content = content.force_encoding(encoding)
-
-      # return byte stream
-      return content if @config.return_binary_data == true
-
-      # return file instead of binary data
-      content_disposition = response.headers['Content-Disposition']
-      if content_disposition && content_disposition =~ /filename=/i
-        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-        prefix = sanitize_filename(filename)
-      else
-        prefix = 'download-'
-      end
-      prefix = prefix + '-' unless prefix.end_with?('-')
-
-      tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-      tempfile.write(content)
-      tempfile.close
-
-      config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                          "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                          "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                          "explicitly with `tempfile.delete`"
-      tempfile
-    end
-
-    def connection(opts)
-      opts[:header_params]['Content-Type'] == 'multipart/form-data' ? connection_multipart : connection_regular
-    end
-
-    def connection_multipart
-      @connection_multipart ||= build_connection do |conn|
-        conn.request :multipart
-        conn.request :url_encoded
-      end
-    end
-
-    def connection_regular
-      @connection_regular ||= build_connection
-    end
-
-    def build_connection
-      Faraday.new(url: config.base_url, ssl: ssl_options, proxy: config.proxy) do |conn|
-        basic_auth(conn)
-        config.configure_middleware(conn)
-        yield(conn) if block_given?
-        conn.adapter(Faraday.default_adapter)
-        config.configure_connection(conn)
-      end
-    end
-
-    def ssl_options
-      {
-        ca_file: config.ssl_ca_file,
-        verify: config.ssl_verify,
-        verify_mode: config.ssl_verify_mode,
-        client_cert: config.ssl_client_cert,
-        client_key: config.ssl_client_key
-      }
-    end
-
-    def basic_auth(conn)
-      if config.username && config.password
-        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
-          conn.request(:authorization, :basic, config.username, config.password)
-        else
-          conn.request(:basic_auth, config.username, config.password)
-        end
-      end
-    end
-
-    # Check if the given MIME is a JSON MIME.
-    # JSON MIME examples:
-    #   application/json
-    #   application/json; charset=UTF8
-    #   APPLICATION/JSON
-    #   */*
-    # @param [String] mime MIME
-    # @return [Boolean] True if the MIME is application/json
-    def json_mime?(mime)
-      (mime == '*/*') || !(mime =~ /^Application\/.*json(?!p)(;.*)?/i).nil?
-    end
-
-    # Deserialize the response to the given return type.
-    #
-    # @param [Response] response HTTP response
-    # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
-    def deserialize(response, return_type)
-      body = response.body
-      return nil if body.nil? || body.empty?
-
-      # return response body directly for String return type
-      return body.to_s if return_type == 'String'
-
-      # ensuring a default content type
-      content_type = response.headers['Content-Type'] || 'application/json'
-
-      fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
-
-      begin
-        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
-      rescue JSON::ParserError => e
-        if %w(String Date Time).include?(return_type)
-          data = body
-        else
-          raise e
-        end
-      end
-
-      convert_to_type data, return_type
-    end
-
-    # Convert data to the given return type.
-    # @param [Object] data Data to be converted
-    # @param [String] return_type Return type
-    # @return [Mixed] Data in a particular type
-    def convert_to_type(data, return_type)
-      return nil if data.nil?
-      case return_type
-      when 'String'
-        data.to_s
-      when 'Integer'
-        data.to_i
-      when 'Float'
-        data.to_f
-      when 'Boolean'
-        data == true
-      when 'Time'
-        # parse date time (expecting ISO 8601 format)
-        Time.parse data
-      when 'Date'
-        # parse date time (expecting ISO 8601 format)
-        Date.parse data
-      when 'Object'
-        # generic object (usually a Hash), return directly
-        data
-      when /\AArray<(.+)>\z/
-        # e.g. Array<Pet>
-        sub_type = $1
-        data.map { |item| convert_to_type(item, sub_type) }
-      when /\AHash\<String, (.+)\>\z/
-        # e.g. Hash<String, Integer>
-        sub_type = $1
-        {}.tap do |hash|
-          data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
-        end
-      else
-        # models (e.g. Pet) or oneOf/anyOf
-        klass = Peal.const_get(return_type)
-        if klass.respond_to?(:openapi_one_of) || klass.respond_to?(:openapi_any_of)
-          klass.build(data)
-        else
-          klass.build_from_hash(data)
-        end
-      end
-    end
-
-    # Sanitize filename by removing path.
-    # e.g. ../../sun.gif becomes sun.gif
-    #
-    # @param [String] filename the filename to be sanitized
-    # @return [String] the sanitized filename
-    def sanitize_filename(filename)
-      filename.split(/[\/\\]/).last
-    end
-
-    def build_request_url(path, opts = {})
-      # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(/\/+/, '/')
-      @config.base_url(opts[:operation]) + path
-    end
-
-    # Update header and query params based on authentication settings.
-    #
-    # @param [Hash] header_params Header parameters
-    # @param [Hash] query_params Query parameters
-    # @param [String] auth_names Authentication scheme name
-    def update_params_for_auth!(header_params, query_params, auth_names)
-      Array(auth_names).each do |auth_name|
-        auth_setting = @config.auth_settings[auth_name]
-        next unless auth_setting
-        case auth_setting[:in]
-        when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
-        when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-        else fail ArgumentError, 'Authentication token must be in `query` or `header`'
-        end
-      end
-    end
-
-    # Sets user agent in HTTP header
-    #
-    # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0)
-    def user_agent=(user_agent)
-      @user_agent = user_agent
-      @default_headers['User-Agent'] = @user_agent
-    end
-
-    # Return Accept header based on an array of accepts provided.
-    # @param [Array] accepts array for Accept
-    # @return [String] the Accept header (e.g. application/json)
-    def select_header_accept(accepts)
-      return nil if accepts.nil? || accepts.empty?
-      # use JSON when present, otherwise use all of the provided
-      json_accept = accepts.find { |s| json_mime?(s) }
-      json_accept || accepts.join(',')
-    end
-
-    # Return Content-Type header based on an array of content types provided.
-    # @param [Array] content_types array for Content-Type
-    # @return [String] the Content-Type header  (e.g. application/json)
-    def select_header_content_type(content_types)
-      # return nil by default
-      return if content_types.nil? || content_types.empty?
-      # use JSON when present, otherwise use the first one
-      json_content_type = content_types.find { |s| json_mime?(s) }
-      json_content_type || content_types.first
-    end
-
-    # Convert object (array, hash, object, etc) to JSON string.
-    # @param [Object] model object to be converted into JSON string
-    # @return [String] JSON string representation of the object
-    def object_to_http_body(model)
-      return model if model.nil? || model.is_a?(String)
-      local_body = nil
-      if model.is_a?(Array)
-        local_body = model.map { |m| object_to_hash(m) }
-      else
-        local_body = object_to_hash(model)
-      end
-      local_body.to_json
-    end
-
-    # Convert object(non-array) to hash.
-    # @param [Object] obj object to be converted into JSON string
-    # @return [String] JSON string representation of the object
-    def object_to_hash(obj)
-      if obj.respond_to?(:to_hash)
-        obj.to_hash
-      else
-        obj
-      end
-    end
-
-    # Build parameter value according to the given collection format.
-    # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
-    def build_collection_param(param, collection_format)
-      case collection_format
-      when :csv
-        param.join(',')
-      when :ssv
-        param.join(' ')
-      when :tsv
-        param.join("\t")
-      when :pipes
-        param.join('|')
-      when :multi
-        # return the array directly as typhoeus will handle it as expected
-        param
-      else
-        fail "unknown collection format: #{collection_format.inspect}"
-      end
-    end
-  end
-end

data/lib/peal/api_error.rb

@@ -1,58 +0,0 @@
-=begin
-#Peal API
-
-#Schedule posts across social platforms, follow how they did, and manage a Peal workspace's channels, media and members.
-
-The version of the OpenAPI document: 0.0.1
-Contact: hello@peal.social
-Generated by: https://openapi-generator.tech
-Generator version: 7.27.0
-
-=end
-
-module Peal
-  class ApiError < StandardError
-    attr_reader :code, :response_headers, :response_body
-
-    # Usage examples:
-    #   ApiError.new
-    #   ApiError.new("message")
-    #   ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
-    #   ApiError.new(:code => 404, :message => "Not Found")
-    def initialize(arg = nil)
-      if arg.is_a? Hash
-        if arg.key?(:message) || arg.key?('message')
-          super(arg[:message] || arg['message'])
-        else
-          super arg
-        end
-
-        arg.each do |k, v|
-          instance_variable_set "@#{k}", v
-        end
-      else
-        super arg
-        @message = arg
-      end
-    end
-
-    # Override to_s to display a friendly error message
-    def to_s
-      message
-    end
-
-    def message
-      if @message.nil?
-        msg = "Error message: the server returns an error"
-      else
-        msg = @message
-      end
-
-      msg += "\nHTTP status code: #{code}" if code
-      msg += "\nResponse headers: #{response_headers}" if response_headers
-      msg += "\nResponse body: #{response_body}" if response_body
-
-      msg
-    end
-  end
-end

data/lib/peal/api_model_base.rb

@@ -1,88 +0,0 @@
-=begin
-#Peal API
-
-#Schedule posts across social platforms, follow how they did, and manage a Peal workspace's channels, media and members.
-
-The version of the OpenAPI document: 0.0.1
-Contact: hello@peal.social
-Generated by: https://openapi-generator.tech
-Generator version: 7.27.0
-
-=end
-
-module Peal
-  class ApiModelBase
-    # 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 = Peal.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
-
-    # 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