supportify_client 0.0.4 → 1.0.0

data/lib/supportify_client/api_client.rb

@@ -0,0 +1,271 @@
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'typhoeus'
+require 'uri'
+
+module Supportify
+  class ApiClient
+
+    attr_accessor :host
+
+    # Defines the headers to be used in HTTP requests of all API calls by default.
+    #
+    # @return [Hash]
+    attr_accessor :default_headers
+
+    # Stores the HTTP response from the last API call using this API client.
+    attr_accessor :last_response
+
+    def initialize(host = nil)
+      @host = host || Configuration.base_url
+      @format = 'json'
+      @user_agent = "ruby-swagger-#{VERSION}"
+      @default_headers = {
+        'Content-Type' => "application/#{@format.downcase}",
+        'User-Agent' => @user_agent
+      }
+    end
+
+    def call_api(http_method, path, opts = {})
+      request = build_request(http_method, path, opts)
+      response = request.run
+
+      # record as last response
+      @last_response = response
+
+      if Configuration.debugging
+        Configuration.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
+
+      unless response.success?
+        fail ApiError.new(:code => response.code,
+                          :response_headers => response.headers,
+                          :response_body => response.body),
+             response.status_message
+      end
+
+      if opts[:return_type]
+        deserialize(response, opts[:return_type])
+      else
+        nil
+      end
+    end
+
+    def build_request(http_method, path, opts = {})
+      url = build_request_url(path)
+      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]
+      
+
+      req_opts = {
+        :method => http_method,
+        :headers => header_params,
+        :params => query_params,
+        :ssl_verifypeer => Configuration.verify_ssl,
+        :cainfo => Configuration.ssl_ca_cert,
+        :verbose => Configuration.debugging
+      }
+
+      if [:post, :patch, :put, :delete].include?(http_method)
+        req_body = build_request_body(header_params, form_params, opts[:body])
+        req_opts.update :body => req_body
+        if Configuration.debugging
+          Configuration.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
+        end
+      end
+
+      Typhoeus::Request.new(url, req_opts)
+    end
+
+    # Deserialize the response to the given return type.
+    #
+    # @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?
+
+      # handle file downloading - save response body into a tmp file and return the File instance
+      return download_file(response) if return_type == 'File'
+
+      # ensuring a default content type
+      content_type = response.headers['Content-Type'] || 'application/json'
+
+      unless content_type.start_with?('application/json')
+        fail "Content-Type is not supported: #{content_type}"
+      end
+
+      begin
+        data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
+      rescue JSON::ParserError => e
+        if %w(String Date DateTime).include?(return_type)
+          data = body
+        else
+          raise e
+        end
+      end
+
+      convert_to_type data, return_type
+    end
+
+    # Convert data to the given return 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 'DateTime'
+        # parse date time (expecting ISO 8601 format)
+        DateTime.parse data
+      when 'Date'
+        # parse date time (expecting ISO 8601 format)
+        Date.parse data
+      when 'Object'
+        # generic object, 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
+        Supportify.const_get(return_type).new.tap do |model|
+          model.build_from_hash data
+        end
+      end
+    end
+
+    # Save response body into a file in (the defined) temporary folder, using the filename
+    # from the "Content-Disposition" header if provided, otherwise a random filename.
+    #
+    # @see Configuration#temp_folder_path
+    # @return [File] the file downloaded
+    def download_file(response)
+      tmp_file = Tempfile.new '', Configuration.temp_folder_path
+      content_disposition = response.headers['Content-Disposition']
+      if content_disposition
+        filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+        path = File.join File.dirname(tmp_file), filename
+      else
+        path = tmp_file.path
+      end
+      # close and delete temp file
+      tmp_file.close!
+
+      File.open(path, 'w') { |file| file.write(response.body) }
+      Configuration.logger.info "File written to #{path}. Please move the file to a proper "\
+                                "folder for further processing and delete the temp afterwards"
+      File.new(path)
+    end
+
+    def build_request_url(path)
+      # Add leading and trailing slashes to path
+      path = "/#{path}".gsub(/\/+/, '/')
+      URI.encode(host + path)
+    end
+
+    def build_request_body(header_params, form_params, body)
+      # http form
+      if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
+          header_params['Content-Type'] == 'multipart/form-data'
+        data = form_params.dup
+        data.each do |key, value|
+          data[key] = value.to_s if value && !value.is_a?(File)
+        end
+      elsif body
+        data = body.is_a?(String) ? body : body.to_json
+      else
+        data = nil
+      end
+      data
+    end
+
+    # Update hearder and query params based on authentication settings.
+    def update_params_for_auth!(header_params, query_params, auth_names)
+      Array(auth_names).each do |auth_name|
+        auth_setting = Configuration.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` of `header`'
+        end
+      end
+    end
+
+    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)
+      if accepts.empty?
+        return
+      elsif accepts.any?{ |s| s.casecmp('application/json') == 0 }
+        'application/json' # look for json data by default
+      else
+        accepts.join(',')
+      end
+    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)
+      if content_types.empty?
+        'application/json' # use application/json by default
+      elsif content_types.any?{ |s| s.casecmp('application/json')==0 }
+        'application/json' # use application/json if it's included
+      else
+        content_types[0] # otherwise, use the first one
+      end
+    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 if model.nil?
+      _body = nil
+      if model.is_a?(Array)
+        _body = model.map{|m| object_to_hash(m) }
+      else
+        _body = object_to_hash(model)
+      end
+      _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
+  end
+end

data/lib/supportify_client/api_error.rb

@@ -0,0 +1,24 @@
+module Supportify
+  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
+        arg.each do |k, v|
+          if k.to_s == 'message'
+            super v
+          else
+            instance_variable_set "@#{k}", v
+          end
+        end
+      else
+        super arg
+      end
+    end
+  end
+end

data/lib/supportify_client/configuration.rb

@@ -0,0 +1,187 @@
+require 'uri'
+require 'singleton'
+
+module Supportify
+  class Configuration
+
+    include Singleton
+
+    # Default api client
+    attr_accessor :api_client
+
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    class << self
+      def method_missing(method_name, *args, &block)
+        config = Configuration.instance
+        if config.respond_to?(method_name)
+          config.send(method_name, *args, &block)
+        else
+          super
+        end
+      end
+    end
+
+    def initialize
+      @scheme = 'https'
+      @host = 'api.supportify.io'
+      @base_path = '/v2'
+      @api_key = {}
+      @api_key_prefix = {}
+      @verify_ssl = true
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+
+    def api_client
+      @api_client ||= ApiClient.new
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = "" if @base_path == "/"
+    end
+
+    def base_url
+      url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}"
+      URI.encode(url)
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    def account_api_key=(value)
+      @api_key['X-SUPPORTIFY-APIKEY'] = value
+    end
+
+    def account_api_key
+      @api_key['X-SUPPORTIFY-APIKEY']
+    end
+
+    def application_api_key=(value)
+      @api_key['X-SUPPORTIFY-APPKEY'] = value
+    end
+
+    def application_api_key
+      @api_key['X-SUPPORTIFY-APPKEY']
+    end
+    
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'api_key' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'X-SUPPORTIFY-APIKEY',
+            value: api_key_with_prefix('X-SUPPORTIFY-APIKEY')
+          },
+        'app_key' =>
+          {
+            type: 'api_key',
+            in: 'header',
+            key: 'X-SUPPORTIFY-APPKEY',
+            value: api_key_with_prefix('X-SUPPORTIFY-APPKEY')
+          },
+      }
+    end
+  end
+end

data/lib/supportify_client/models/base_object.rb

@@ -0,0 +1,87 @@
+require 'date'
+
+module Supportify
+  # base class containing fundamental method such as to_hash, build_from_hash and more
+  class BaseObject
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    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 =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      else # model
+        _model = Supportify.const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |key, value|
+        if self.send(key).is_a?(Array)
+          next if self.send(key).empty?
+          hash[value] = self.send(key).select{|v| !v.nil?}.map{ |v| _to_hash v} unless self.send(key).nil?
+        else
+          unless (_tmp_value = _to_hash self.send(key)).nil?
+            hash[value] = _tmp_value
+          end
+        end
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/supportify_client/models/category.rb

@@ -0,0 +1,53 @@
+module Supportify
+  # 
+  class Category < BaseObject
+    attr_accessor :id, :description, :name
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # Unique identifier representing a specific category within an application.
+        :'id' => :'id',
+        
+        # Description of the category.
+        :'description' => :'description',
+        
+        # Display name of the category.
+        :'name' => :'name'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'id' => :'Integer',
+        :'description' => :'String',
+        :'name' => :'String'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'id']
+        self.id = attributes[:'id']
+      end
+      
+      if attributes[:'description']
+        self.description = attributes[:'description']
+      end
+      
+      if attributes[:'name']
+        self.name = attributes[:'name']
+      end
+      
+    end
+
+  end
+end

data/lib/supportify_client/models/error.rb

@@ -0,0 +1,53 @@
+module Supportify
+  # 
+  class Error < BaseObject
+    attr_accessor :code, :short_description, :long_description
+    # attribute mapping from ruby-style variable name to JSON key
+    def self.attribute_map
+      {
+        
+        # An HTTP error code.
+        :'code' => :'code',
+        
+        # A short keyword describing the error that occurred.
+        :'short_description' => :'short_description',
+        
+        # A more detailed description of the cause of the error.
+        :'long_description' => :'long_description'
+        
+      }
+    end
+
+    # attribute type
+    def self.swagger_types
+      {
+        :'code' => :'Integer',
+        :'short_description' => :'String',
+        :'long_description' => :'String'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return if !attributes.is_a?(Hash) || attributes.empty?
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'code']
+        self.code = attributes[:'code']
+      end
+      
+      if attributes[:'short_description']
+        self.short_description = attributes[:'short_description']
+      end
+      
+      if attributes[:'long_description']
+        self.long_description = attributes[:'long_description']
+      end
+      
+    end
+
+  end
+end