I ended up writing a wrapper for the RestClient that logs what I need to log, but is specific to the API I'm working with.

    # Private: Wrapper for the Gooddata REST client that performs logging and simplifies
    # setting REST parameters.
    #
    # method - Symbol speciying the REST method to use.  Curerntly only support :get and :put.
    # url    - Full URL to make the request against.
    # log    - Array that specifies whether requests and/or responses should be logged.
    #          Sometimes it is necessary to turn of response logging for large responses 
    #          (e.g., data files).  (default: [:request, :response]).
    # &block - This method only works by specifying a block. It yeilds
    #          a RestParams object where the user sets the REST headers and values.
    #
    # Examples
    #
    #  rest_client :post, "#{url_base}/gdc/account/login" do |params|
    #    params.headers = {
    #      content_type: 'application/json',
    #      accept: 'application/json'
    #    }
    #
    #    params.values = {
    #      postUserLogin: {
    #        login: "#{username}",
    #        password: "#{password}",
    #        remember: 1
    #      }
    #    }
    #  end
    #
    # Returns a RestClient::Response when successful.
    def rest_client(method, url, log: [:request, :response], &block)
      params = RestParams.new
      yield params

      if Array(log).include? :request
        masked_values = params.values.to_json
        if params.values[:postUserLogin] && params.values[:postUserLogin][:password]
          masked_values = masked_values.gsub(/#{params.values[:postUserLogin][:password]}/,'******')
        end

        @rest_log.info "#{method.upcase}: #{url}"
        @rest_log.info "HEADERS: #{JSON.pretty_generate params.headers rescue params.headers}"
        @rest_log.info "VALUES: #{JSON.pretty_generate JSON.parse(masked_values) rescue masked_values}"
      end

      response = case method
      when :get
        RestClient.get url, params.headers
      when :post
        RestClient.post url, params.values.to_json, params.headers
      else
        raise "Unkown RestClient method #{method}"
      end

      @rest_log.info "RESPONSE (headers): #{JSON.pretty_generate response.headers rescue response.headers}"
      @rest_log.info "RESPONSE: #{JSON.pretty_generate JSON.parse(response) rescue response}" if Array(log).include? :response

      response
    end

    # Public: Simple class to hold headers and values for REST queries.
    class RestParams

      # Public: Initializes the REST parameters (headers and values).  Headers
      # and values may either be a hash or a JSON-formatted string.  Strings
      # are converted and stored as a hash.
      #
      # headers - The REST headers parameters.  May be a hash or a JSON-formatting string.
      # values  - The REST values parameters.  May be a hash or a JSON-formatting string.
      def initialize(headers: {}, values: {})
        self.headers = headers
        self.values = values
      end

      # Public: Returns the headers parameters as a hash.
      attr_reader :headers

      # Public: Returns the values parameters as a hash.
      attr_reader :values

      # Public: Setter for the headers.  Strings are parsed with JSON.  Otherwise,
      # it assumes the headers are stored as a hash.
      def headers=(val)
        @headers = val.is_a?(String) ? JSON.parse(val) : val
      end

      # Public: Setter for the values.  Strings are parsed with JSON.  Otherwise,
      # it assumes the values are stored as a hash.
      def values=(val)
        @values = val.is_a?(String) ? JSON.parse(val) : val
      end
    end

Is there a way to hide the password in the log? #349

Description

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions