smartsheet 1.0.0 → 1.1.0

data/lib/smartsheet/api/file_spec.rb

@@ -1,31 +1,31 @@
-require 'cgi'
-require 'faraday'
-
-module Smartsheet
-  module API
-    # Specification for a file attachment by path, target filename, and MIME content type
-    class PathFileSpec
-      attr_reader :upload_io, :filename, :content_type, :file_length
-
-      def initialize(path, filename, content_type)
-        @file_length = File.size(path)
-        @filename = filename.nil? ? File.basename(path) : filename
-        @upload_io = Faraday::UploadIO.new(path, content_type, CGI::escape(@filename))
-        @content_type = content_type
-      end
-    end
-
-    # Specification for a file attachment by {::File}, target filename, file length, and MIME
-    # content type
-    class ObjectFileSpec
-      attr_reader :upload_io, :filename, :content_type, :file_length
-
-      def initialize(file, filename, file_length, content_type)
-        @file_length = file_length
-        @filename = filename
-        @upload_io = Faraday::UploadIO.new(file, content_type, CGI::escape(filename))
-        @content_type = content_type
-      end
-    end
-  end
-end
+require 'cgi'
+require 'faraday'
+
+module Smartsheet
+  module API
+    # Specification for a file attachment by path, target filename, and MIME content type
+    class PathFileSpec
+      attr_reader :upload_io, :filename, :content_type, :file_length
+
+      def initialize(path, filename, content_type)
+        @file_length = File.size(path)
+        @filename = (filename.nil? || filename.empty?) ? File.basename(path) : filename
+        @upload_io = Faraday::UploadIO.new(path, content_type, CGI::escape(@filename))
+        @content_type = content_type
+      end
+    end
+
+    # Specification for a file attachment by {::File}, target filename, file length, and MIME
+    # content type
+    class ObjectFileSpec
+      attr_reader :upload_io, :filename, :content_type, :file_length
+
+      def initialize(file, filename, file_length, content_type)
+        @file_length = file_length
+        @filename = filename
+        @upload_io = Faraday::UploadIO.new(file, content_type, CGI::escape(filename))
+        @content_type = content_type
+      end
+    end
+  end
+end

data/lib/smartsheet/api/header_builder.rb

@@ -1,85 +1,91 @@
-require 'cgi'
-require 'smartsheet/version'
-require 'smartsheet/constants'
-
-module Smartsheet
-  module API
-    # Constructs headers for accessing the Smartsheet API
-    class HeaderBuilder
-      include Smartsheet::Constants
-      def initialize(token, endpoint_spec, request_spec, assume_user: nil)
-        @token = token
-        @endpoint_spec = endpoint_spec
-        @request_spec = request_spec
-        @assume_user = assume_user
-      end
-
-      def build
-        base_headers
-            .merge(endpoint_headers)
-            .merge(content_type)
-            .merge(content_disposition)
-            .merge(content_length)
-            .merge(request_headers)
-            .merge(assume_user)
-      end
-
-      private
-
-      attr_accessor :endpoint_spec, :request_spec
-      attr_reader :token
-
-      def base_headers
-        base = {
-            Accept: JSON_TYPE,
-            'User-Agent': "#{USER_AGENT}/#{Smartsheet::VERSION}"
-        }
-        base[:Authorization] = "Bearer #{token}" if endpoint_spec.requires_auth?
-
-        base
-      end
-
-      def assume_user
-        if @assume_user.nil?
-          {}
-        else
-          {'Assume-User': CGI::escape(@assume_user)}
-        end
-      end
-
-      def endpoint_headers
-        endpoint_spec.headers
-      end
-
-      def content_type
-        if endpoint_spec.sending_json? && request_spec.body
-          {'Content-Type': JSON_TYPE}
-        elsif endpoint_spec.sending_file?
-          {'Content-Type': request_spec.content_type}
-        else
-          {}
-        end
-      end
-
-      def content_disposition
-        if endpoint_spec.sending_file?
-          {'Content-Disposition': "attachment; filename=\"#{CGI::escape(request_spec.filename)}\""}
-        else
-          {}
-        end
-      end
-
-      def content_length
-        if endpoint_spec.sending_file?
-          {'Content-Length': request_spec.file_length.to_s}
-        else
-          {}
-        end
-      end
-
-      def request_headers
-        request_spec.header_overrides
-      end
-    end
-  end
+require 'cgi'
+require 'smartsheet/version'
+require 'smartsheet/constants'
+
+module Smartsheet
+  module API
+    # Constructs headers for accessing the Smartsheet API
+    class HeaderBuilder
+      include Smartsheet::Constants
+      def initialize(token, endpoint_spec, request_spec, app_user_agent: nil, assume_user: nil)
+        @token = token
+        @endpoint_spec = endpoint_spec
+        @request_spec = request_spec
+        @app_user_agent = app_user_agent
+        @assume_user = assume_user
+      end
+
+      def build
+        base_headers
+            .merge(assume_user)
+            .merge(endpoint_headers)
+            .merge(content_type)
+            .merge(content_disposition)
+            .merge(content_length)
+            .merge(request_headers)
+      end
+
+      private
+
+      attr_accessor :endpoint_spec, :request_spec
+      attr_reader :token
+
+      def base_headers
+        base = {
+            Accept: JSON_TYPE,
+            'User-Agent': user_agent
+        }
+        base[:Authorization] = "Bearer #{token}" if endpoint_spec.requires_auth?
+
+        base
+      end
+
+      def user_agent
+        "#{USER_AGENT}/#{Smartsheet::VERSION}" +
+          (@app_user_agent.nil? ? '' : "/#{@app_user_agent}")
+      end
+
+      def assume_user
+        if @assume_user.nil?
+          {}
+        else
+          {'Assume-User': CGI::escape(@assume_user)}
+        end
+      end
+
+      def endpoint_headers
+        endpoint_spec.headers
+      end
+
+      def content_type
+        if endpoint_spec.sending_json? && request_spec.body
+          {'Content-Type': JSON_TYPE}
+        elsif endpoint_spec.sending_file?
+          {'Content-Type': request_spec.content_type}
+        else
+          {}
+        end
+      end
+
+      def content_disposition
+        if endpoint_spec.sending_file?
+          {'Content-Disposition': "attachment; filename=\"#{CGI::escape(request_spec.filename)}\""}
+        else
+          {}
+        end
+      end
+
+      def content_length
+        if endpoint_spec.sending_file?
+          {'Content-Length': request_spec.file_length.to_s}
+        else
+          {}
+        end
+      end
+
+      def request_headers
+        request_spec.header_overrides
+      end
+    end
+  end
 end

data/lib/smartsheet/api/request.rb

@@ -1,30 +1,43 @@
-require 'smartsheet/api/url_builder'
-require 'smartsheet/api/header_builder'
-require 'smartsheet/api/body_builder'
-
-module Smartsheet
-  module API
-    # Full specification for a single request to an endpoint
-    class Request
-      attr_reader :method, :url, :headers, :params, :body
-
-      def initialize(token, endpoint_spec, request_spec, base_url, assume_user: nil)
-        @method = endpoint_spec.method
-        @url = Smartsheet::API::UrlBuilder.new(endpoint_spec, request_spec, base_url).build
-        @headers = Smartsheet::API::HeaderBuilder.new(token, endpoint_spec, request_spec, assume_user: assume_user).build
-        @params = request_spec.params
-        @body = Smartsheet::API::BodyBuilder.new(endpoint_spec, request_spec).build
-      end
-
-      def ==(other)
-        other.class == self.class && other.equality_state == equality_state
-      end
-
-      protected
-
-      def equality_state
-        [method, url, headers, params, body]
-      end
-    end
-  end
+require 'smartsheet/api/url_builder'
+require 'smartsheet/api/header_builder'
+require 'smartsheet/api/body_builder'
+
+module Smartsheet
+  module API
+    # Full specification for a single request to an endpoint
+    class Request
+      attr_reader :method, :url, :headers, :params, :body
+
+      def initialize(
+          token,
+          endpoint_spec,
+          request_spec,
+          base_url,
+          app_user_agent: nil,
+          assume_user: nil
+      )
+        @method = endpoint_spec.method
+        @url = Smartsheet::API::UrlBuilder.new(endpoint_spec, request_spec, base_url).build
+        @headers = Smartsheet::API::HeaderBuilder.new(
+          token,
+          endpoint_spec,
+          request_spec,
+          app_user_agent: app_user_agent,
+          assume_user: assume_user
+        ).build
+        @params = request_spec.params
+        @body = Smartsheet::API::BodyBuilder.new(endpoint_spec, request_spec).build
+      end
+
+      def ==(other)
+        other.class == self.class && other.equality_state == equality_state
+      end
+
+      protected
+
+      def equality_state
+        [method, url, headers, params, body]
+      end
+    end
+  end
 end

data/lib/smartsheet/api/request_client.rb

@@ -1,28 +1,44 @@
-require 'smartsheet/error'
-
-module Smartsheet
-  module API
-    # Composes {EndpointSpec endpoint specifications} and {RequestSpec request specifications} to
-    # form a single {Request} that it submits to the provided client
-    class RequestClient
-      def initialize(token, client, base_url, assume_user: nil, logger: MuteRequestLogger.new)
-        @token = token
-        @client = client
-        @assume_user = assume_user
-        @logger = logger
-        @base_url = base_url
-      end
-
-      def make_request(endpoint_spec, request_spec)
-        request = Request.new(token, endpoint_spec, request_spec, base_url, assume_user: assume_user)
-
-        logger.log_request(request)
-        client.make_request(request)
-      end
-
-      private
-
-      attr_reader :token, :client, :assume_user, :logger, :base_url
-    end
-  end
+require 'smartsheet/version'
+require 'smartsheet/error'
+
+module Smartsheet
+  module API
+    # Composes {EndpointSpec endpoint specifications} and {RequestSpec request specifications} to
+    # form a single {Request} that it submits to the provided client
+    class RequestClient
+      def initialize(
+          token,
+          client,
+          base_url,
+          app_user_agent: nil,
+          assume_user: nil,
+          logger: MuteRequestLogger.new
+      )
+        @token = token
+        @client = client
+        @app_user_agent = app_user_agent
+        @assume_user = assume_user
+        @logger = logger
+        @base_url = base_url
+      end
+
+      def make_request(endpoint_spec, request_spec)
+        request = Request.new(
+          token,
+          endpoint_spec,
+          request_spec,
+          base_url,
+          app_user_agent: app_user_agent,
+          assume_user: assume_user
+        )
+
+        logger.log_request(request)
+        client.make_request(request)
+      end
+
+      private
+
+      attr_reader :token, :client, :app_user_agent, :assume_user, :logger, :base_url
+    end
+  end
 end

data/lib/smartsheet/api/request_logger.rb

@@ -1,183 +1,183 @@
-require 'logger'
-
-module Smartsheet
-  module API
-    # Censors strings and hash values for select blacklisted keys
-    class Censor
-      EXPOSED_CHARS = 4
-      KEY_TO_STRING = ->(k){ k.to_s }
-      KEY_TO_DOWNCASE_STRING = ->(k){ k.to_s.downcase }
-
-      def initialize(*blacklist)
-        @blacklist = Set.new(blacklist)
-      end
-
-      def censor_hash(h, case_insensitive: false)
-        if case_insensitive
-          _censor_hash(h, KEY_TO_DOWNCASE_STRING, downcased_blacklist)
-        else
-          _censor_hash(h, KEY_TO_STRING, blacklist)
-        end
-      end
-
-      def censor(str)
-        total_length = str.length
-        censored_length = [total_length - EXPOSED_CHARS, 0].max
-        ('*' * censored_length) + str[censored_length...total_length]
-      end
-
-      private
-
-      def _censor_hash(h, key_transform, cased_blacklist)
-        h.collect do |(k, v)|
-          new_v =
-              cased_blacklist.include?(key_transform.call(k)) ?
-                  censor(v) :
-                  v
-
-          [k, new_v]
-        end.to_h
-      end
-
-      def downcased_blacklist
-        blacklist.collect { |x| x.downcase }
-      end
-
-      attr_reader :blacklist
-    end
-
-    # Logs request and response information, while censoring OAuth-relevant keys
-    class RequestLogger
-      QUERY_PARAM_CENSOR = Censor.new 'code', 'client_id', 'hash', 'refresh_token'
-      HEADER_CENSOR = Censor.new 'authorization'
-      PAYLOAD_CENSOR = Censor.new 'access_token', 'refresh_token'
-
-      TRUNCATED_BODY_LENGTH = 1024
-
-      def initialize(logger, log_full_body:)
-        @logger = logger
-        @log_full_body = log_full_body
-      end
-
-      def log_request(request)
-        log_request_basics(Logger::INFO, request)
-        log_headers('Request', request)
-        log_body('Request', request.body)
-      end
-
-      def log_retry_attempt(request, response, attempt_num)
-        logger.warn { "Request attempt #{attempt_num} failed" }
-        log_request_basics(Logger::WARN, request)
-        log_api_error(Logger::WARN, response)
-      end
-
-      def log_retry_failure(num_tries)
-        try_word = num_tries == 1 ? 'try' : 'tries'
-        logger.error { "Request failed after #{num_tries} #{try_word}" }
-      end
-
-      def log_successful_response(response)
-        log_status(Logger::INFO, response)
-        log_headers('Response', response)
-        log_body('Response', response.result)
-      end
-
-      def log_api_error_response(request, error)
-        log_request_basics(Logger::ERROR, request)
-        log_api_error(Logger::ERROR, error)
-      end
-
-      def log_http_error_response(request, error)
-        log_request_basics(Logger::ERROR, request)
-        log_http_error(Logger::ERROR, error)
-      end
-
-      private
-
-      attr_reader :logger, :log_full_body
-
-      def log_request_basics(level, request)
-        logger.log(level) { "Request: #{request.method.upcase} #{build_logging_url(request)}" }
-      end
-
-      def build_logging_url(request)
-        query_params = QUERY_PARAM_CENSOR.censor_hash(request.params)
-        query_param_str =
-          if query_params.empty?
-            ''
-          else
-            '?' + query_params.collect { |(k, v)| "#{k}=#{v}" }.join('&') # TODO: URI Encoding
-          end
-        request.url + query_param_str
-      end
-
-      def log_api_error(level, response)
-        log_status(level, response)
-        logger.log(level) do
-          "#{response.error_code}: #{response.message} - Ref ID: #{response.ref_id}"
-        end
-        log_headers('Response', response)
-      end
-
-      def log_http_error(level, response)
-        log_status(level, response)
-        log_headers('Response', response)
-      end
-
-      def log_status(level, response)
-        logger.log(level) { "Response: #{response.status_code} #{response.reason_phrase}" }
-      end
-
-      def log_headers(context, req_or_resp)
-        censored_hash = HEADER_CENSOR.censor_hash(req_or_resp.headers, case_insensitive: true)
-        logger.debug { "#{context} Headers: #{censored_hash}" }
-      end
-
-      def log_body(context, body)
-        return unless body
-
-        body_str =
-            if body.is_a? String
-              body
-            elsif body.is_a? Hash
-              PAYLOAD_CENSOR.censor_hash(body).to_s
-            else
-              '<Binary body>'
-            end
-
-        body_str = truncate_body(body_str) unless log_full_body
-
-        logger.debug "#{context} Body: #{body_str}"
-      end
-
-      def truncate_body(body_str)
-        if body_str.length > TRUNCATED_BODY_LENGTH
-          body_str[0...TRUNCATED_BODY_LENGTH] + '...'
-        else
-          body_str
-        end
-      end
-    end
-
-    # Stubs all request logging methods by doing nothing (see {RequestLogger})
-    class MuteRequestLogger
-      def log_request(request)
-      end
-
-      def log_retry_attempt(request, response, attempt_num)
-      end
-
-      def log_retry_failure(num_retries)
-      end
-
-      def log_successful_response(response)
-      end
-
-      def log_api_error_response(request, error)
-      end
-
-      def log_http_error_response(request, error)
-      end
-    end
-  end
+require 'logger'
+
+module Smartsheet
+  module API
+    # Censors strings and hash values for select blacklisted keys
+    class Censor
+      EXPOSED_CHARS = 4
+      KEY_TO_STRING = ->(k){ k.to_s }
+      KEY_TO_DOWNCASE_STRING = ->(k){ k.to_s.downcase }
+
+      def initialize(*blacklist)
+        @blacklist = Set.new(blacklist)
+      end
+
+      def censor_hash(h, case_insensitive: false)
+        if case_insensitive
+          _censor_hash(h, KEY_TO_DOWNCASE_STRING, downcased_blacklist)
+        else
+          _censor_hash(h, KEY_TO_STRING, blacklist)
+        end
+      end
+
+      def censor(str)
+        total_length = str.length
+        censored_length = [total_length - EXPOSED_CHARS, 0].max
+        ('*' * censored_length) + str[censored_length...total_length]
+      end
+
+      private
+
+      def _censor_hash(h, key_transform, cased_blacklist)
+        h.collect do |(k, v)|
+          new_v =
+              cased_blacklist.include?(key_transform.call(k)) ?
+                  censor(v) :
+                  v
+
+          [k, new_v]
+        end.to_h
+      end
+
+      def downcased_blacklist
+        blacklist.collect { |x| x.downcase }
+      end
+
+      attr_reader :blacklist
+    end
+
+    # Logs request and response information, while censoring OAuth-relevant keys
+    class RequestLogger
+      QUERY_PARAM_CENSOR = Censor.new 'code', 'client_id', 'hash', 'refresh_token'
+      HEADER_CENSOR = Censor.new 'authorization'
+      PAYLOAD_CENSOR = Censor.new 'access_token', 'refresh_token'
+
+      TRUNCATED_BODY_LENGTH = 1024
+
+      def initialize(logger, log_full_body:)
+        @logger = logger
+        @log_full_body = log_full_body
+      end
+
+      def log_request(request)
+        log_request_basics(Logger::INFO, request)
+        log_headers('Request', request)
+        log_body('Request', request.body)
+      end
+
+      def log_retry_attempt(request, response, attempt_num)
+        logger.warn { "Request attempt #{attempt_num} failed" }
+        log_request_basics(Logger::WARN, request)
+        log_api_error(Logger::WARN, response)
+      end
+
+      def log_retry_failure(num_tries)
+        try_word = num_tries == 1 ? 'try' : 'tries'
+        logger.error { "Request failed after #{num_tries} #{try_word}" }
+      end
+
+      def log_successful_response(response)
+        log_status(Logger::INFO, response)
+        log_headers('Response', response)
+        log_body('Response', response.result)
+      end
+
+      def log_api_error_response(request, error)
+        log_request_basics(Logger::ERROR, request)
+        log_api_error(Logger::ERROR, error)
+      end
+
+      def log_http_error_response(request, error)
+        log_request_basics(Logger::ERROR, request)
+        log_http_error(Logger::ERROR, error)
+      end
+
+      private
+
+      attr_reader :logger, :log_full_body
+
+      def log_request_basics(level, request)
+        logger.log(level) { "Request: #{request.method.upcase} #{build_logging_url(request)}" }
+      end
+
+      def build_logging_url(request)
+        query_params = QUERY_PARAM_CENSOR.censor_hash(request.params)
+        query_param_str =
+          if query_params.empty?
+            ''
+          else
+            '?' + query_params.collect { |(k, v)| "#{k}=#{v}" }.join('&') # TODO: URI Encoding
+          end
+        request.url + query_param_str
+      end
+
+      def log_api_error(level, response)
+        log_status(level, response)
+        logger.log(level) do
+          "#{response.error_code}: #{response.message} - Ref ID: #{response.ref_id}"
+        end
+        log_headers('Response', response)
+      end
+
+      def log_http_error(level, response)
+        log_status(level, response)
+        log_headers('Response', response)
+      end
+
+      def log_status(level, response)
+        logger.log(level) { "Response: #{response.status_code} #{response.reason_phrase}" }
+      end
+
+      def log_headers(context, req_or_resp)
+        censored_hash = HEADER_CENSOR.censor_hash(req_or_resp.headers, case_insensitive: true)
+        logger.debug { "#{context} Headers: #{censored_hash}" }
+      end
+
+      def log_body(context, body)
+        return unless body
+
+        body_str =
+            if body.is_a? String
+              body
+            elsif body.is_a? Hash
+              PAYLOAD_CENSOR.censor_hash(body).to_s
+            else
+              '<Binary body>'
+            end
+
+        body_str = truncate_body(body_str) unless log_full_body
+
+        logger.debug "#{context} Body: #{body_str}"
+      end
+
+      def truncate_body(body_str)
+        if body_str.length > TRUNCATED_BODY_LENGTH
+          body_str[0...TRUNCATED_BODY_LENGTH] + '...'
+        else
+          body_str
+        end
+      end
+    end
+
+    # Stubs all request logging methods by doing nothing (see {RequestLogger})
+    class MuteRequestLogger
+      def log_request(request)
+      end
+
+      def log_retry_attempt(request, response, attempt_num)
+      end
+
+      def log_retry_failure(num_retries)
+      end
+
+      def log_successful_response(response)
+      end
+
+      def log_api_error_response(request, error)
+      end
+
+      def log_http_error_response(request, error)
+      end
+    end
+  end
 end