Labbeemint / syspro-ruby

  module Syspro
    class SysproClient

      attr_accessor :conn, :api_base
  

      def initialize(conn = nil)
        self.conn = conn || self.class.default_conn
        @system_profiler = SystemProfiler.new
      end
  
      def self.active_client
        Thread.current[:syspro_client] || default_client
      end
  
      def self.default_client
        Thread.current[:syspro_client_default_client] ||= SysproClient.new(default_conn)
      end
  
      def get_syspro_version

        version_getter = Syspro::ApiOperations::GetVersion.new
        version_getter.request(:get, version_getter.resource_url)
      end
  
      # A default Faraday connection to be used when one isn't configured. This
      # object should never be mutated, and instead instantiating your own
      # connection and wrapping it in a SysproClient object should be preferred.
      def self.default_conn
        # We're going to keep connections around so that we can take advantage
        # of connection re-use, so make sure that we have a separate connection
        # object per thread.
        Thread.current[:syspro_client_default_conn] ||= begin
          conn = Faraday.new do |c|
            c.use Faraday::Request::Multipart
            c.use Faraday::Request::UrlEncoded
            c.use Faraday::Response::RaiseError
            c.adapter Faraday.default_adapter
          end
  
          #if Syspro.verify_ssl_certs
            #conn.ssl.verify = true
            #conn.ssl.cert_store = Syspro.ca_store
          #else
          conn.ssl.verify = false
  
          unless @verify_ssl_warned
            @verify_ssl_warned = true
            $stderr.puts("WARNING: Running without SSL cert verification. " \
              "You should never do this in production. " \
              "Execute 'Syspro.verify_ssl_certs = true' to enable verification.")
          end
          #end
  
          conn
        end
      end
  
      def execute_request(method, path, api_base: nil, headers: {}, params: {})
        api_base ||= Syspro.api_base
  
        params = Util.objects_to_ids(params)
        url = api_url(path, api_base)
  
        body = nil
        query_params = nil
  
        case method.to_s.downcase.to_sym
        when :get, :head, :delete
          query_params = params
        else
          body = if headers[:content_type] && headers[:content_type] == "multipart/form-data"
                   params
                 else
                   Util.encode_parameters(params)
                 end
        end
  
        headers = request_headers(method)
                  .update(Util.normalize_headers(headers))
  
        # stores information on the request we're about to make so that we don't
        # have to pass as many parameters around for logging.
        context = RequestLogContext.new
        context.body            = body
        context.method          = method
        context.path            = path
        context.query_params    = query_params ? Util.encode_parameters(query_params) : nil
  
        http_resp = execute_request_with_rescues(api_base, context) do
          conn.run_request(method, url, body, headers) do |req|
            req.options.open_timeout = Syspro.open_timeout
            req.options.timeout = Syspro.read_timeout
            req.params = query_params unless query_params.nil?
          end
        end
  
        begin
          resp = SysproResponse.from_faraday_response(http_resp)
        rescue JSON::ParserError
          raise general_api_error(http_resp.status, http_resp.body)
        end
  
        # Allows SysproClient#request to return a response object to a caller.
        @last_response = resp
        [resp]
      end
  
      def general_api_error(status, body)
        APIError.new("Invalid response object from API: #{body.inspect} " \
                     "(HTTP response code was #{status})",
                     http_status: status, http_body: body)
      end
  
      def api_url(url = "", api_base = nil)
        (api_base || Syspro.api_base) + url
      end
  
      def request_headers(method)
        user_agent = "Syspro/7 RubyBindings/#{Syspro::VERSION}"
  
        headers = {
          "User-Agent" => user_agent,
          "Content-Type" => "application/x-www-form-urlencoded",
        }
  
        headers
      end
  
      def execute_request_with_rescues(api_base, context)
        num_retries = 0
        begin
          request_start = Time.now
          log_request(context, num_retries)
          resp = yield
          context = context.dup_from_response(resp)
          log_response(context, request_start, resp.status, resp.body)
  
        # We rescue all exceptions from a request so that we have an easy spot to
        # implement our retry logic across the board. We'll re-raise if it's a type
        # of exception that we didn't expect to handle.
        rescue StandardError => e
          # If we modify context we copy it into a new variable so as not to
          # taint the original on a retry.
          error_context = context
  
          if e.respond_to?(:response) && e.response
            error_context = context.dup_from_response(e.response)
            log_response(error_context, request_start,
                         e.response[:status], e.response[:body])
          else
            log_response_error(error_context, request_start, e)
          end
  
          if self.class.should_retry?(e, num_retries)
            num_retries += 1
            sleep self.class.sleep_time(num_retries)
            retry
          end
  
          case e
          when Faraday::ClientError
            if e.response
              handle_error_response(e.response, error_context)
            else
              handle_network_error(e, error_context, num_retries, api_base)
            end
  
          # Only handle errors when we know we can do so, and re-raise otherwise.
          # This should be pretty infrequent.
          else
            raise
          end
        end
  
        resp
      end
  
      def self.should_retry?(e, num_retries)
        # Retry on timeout-related problems (either on open or read).
        return true if e.is_a?(Faraday::TimeoutError)
  
        # Destination refused the connection, the connection was reset, or a
        # variety of other connection failures. This could occur from a single
        # saturated server, so retry in case it's intermittent.
        return true if e.is_a?(Faraday::ConnectionFailed)
  
        if e.is_a?(Faraday::ClientError) && e.response
          # 409 conflict
          return true if e.response[:status] == 409
        end
  
        false
      end
  
      def log_request(context, num_retries)
        Util.log_info("Request to Syspro API",
                      account: context.account,
                      api_version: context.api_version,
                      method: context.method,
                      num_retries: num_retries,
                      path: context.path)
        Util.log_debug("Request details",
                       body: context.body,
                       query_params: context.query_params)
      end
      private :log_request
  
      def log_response(context, request_start, status, body)
        Util.log_info("Response from Syspro API",
                      account: context.account,
                      api_version: context.api_version,
                      elapsed: Time.now - request_start,
                      method: context.method,
                      path: context.path,
                      request_id: context.request_id,
                      status: status)
        Util.log_debug("Response details",
                       body: body,
                       request_id: context.request_id)
      end
      private :log_response
  
      def log_response_error(context, request_start, e)
        Util.log_error("Request error",
                       elapsed: Time.now - request_start,
                       error_message: e.message,
                       method: context.method,
                       path: context.path)
      end
      private :log_response_error
  
      # RequestLogContext stores information about a request that's begin made so
      # that we can log certain information. It's useful because it means that we
      # don't have to pass around as many parameters.
      class RequestLogContext
        attr_accessor :body
        attr_accessor :account
        attr_accessor :api_version
        attr_accessor :method
        attr_accessor :path
        attr_accessor :query_params
        attr_accessor :request_id
  
        # The idea with this method is that we might want to update some of
        # context information because a response that we've received from the API
        # contains information that's more authoritative than what we started
        # with for a request. For example, we should trust whatever came back in
        # a `Stripe-Version` header beyond what configuration information that we
        # might have had available.
        def dup_from_response(resp)
          return self if resp.nil?
  
          # Faraday's API is a little unusual. Normally it'll produce a response
          # object with a `headers` method, but on error what it puts into
          # `e.response` is an untyped `Hash`.
          headers = if resp.is_a?(Faraday::Response)
                      resp.headers
                    else
                      resp[:headers]
                    end
  
          context = dup
          context.account = headers["Stripe-Account"]
          context.api_version = headers["Stripe-Version"]
          context.request_id = headers["Request-Id"]
          context
        end
      end
  
      # SystemProfiler extracts information about the system that we're running
      # in so that we can generate a rich user agent header to help debug
      # integrations.
      class SystemProfiler
        def self.uname
          if File.exist?("/proc/version")
            File.read("/proc/version").strip
          else
            case RbConfig::CONFIG["host_os"]
            when /linux|darwin|bsd|sunos|solaris|cygwin/i
              uname_from_system
            when /mswin|mingw/i
              uname_from_system_ver
            else
              "unknown platform"
            end
          end
        end
  
        def self.uname_from_system
          (`uname -a 2>/dev/null` || "").strip
        rescue Errno::ENOENT
          "uname executable not found"
        rescue Errno::ENOMEM # couldn't create subprocess
          "uname lookup failed"
        end
  
        def self.uname_from_system_ver
          (`ver` || "").strip
        rescue Errno::ENOENT
          "ver executable not found"
        rescue Errno::ENOMEM # couldn't create subprocess
          "uname lookup failed"
        end
  
        def initialize
          @uname = self.class.uname
        end
  
        def user_agent
          lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"

          {
            application: Syspro.app_info,
            bindings_version: Syspro::VERSION,
            lang: "ruby",
            lang_version: lang_version,
            platform: RUBY_PLATFORM,
            engine: defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
            uname: @uname,
            hostname: Socket.gethostname,
          }.delete_if { |_k, v| v.nil? }
        end

      end
    end
  end