smartsheet 2.77.0 → 2.101.1

data/lib/smartsheet/endpoints/workspaces/workspaces_share.rb

@@ -1,71 +1,71 @@
-require 'smartsheet/endpoints/share/share'
-
-module Smartsheet
-  # Workspace Sharing Endpoints
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#workspace-sharing API Workspace
-  #   Sharing Docs
-  class WorkspacesShare
-    attr_reader :client
-    private :client
-
-    URL = ['workspaces', :workspace_id].freeze
-
-    def initialize(client)
-      @client = client
-    end
-
-    def delete(workspace_id:, share_id:, params: {}, header_overrides: {})
-      delete_share(
-          share_id: share_id,
-          url: URL,
-          params: params,
-          header_overrides: header_overrides,
-          workspace_id: workspace_id
-      )
-    end
-
-    def get(workspace_id:, share_id:, params: {}, header_overrides: {})
-      get_share(
-          share_id: share_id,
-          url: URL,
-          params: params,
-          header_overrides: header_overrides,
-          workspace_id: workspace_id
-      )
-    end
-
-    def list(workspace_id:, params: {}, header_overrides: {})
-      list_share(
-          url: URL,
-          header_overrides: header_overrides,
-          params: params,
-          workspace_id: workspace_id
-      )
-    end
-
-    def create(workspace_id:, body:, params: {}, header_overrides: {})
-      create_share(
-          url: URL,
-          header_overrides: header_overrides,
-          params: params,
-          body: body,
-          workspace_id: workspace_id
-      )
-    end
-
-    def update(workspace_id:, share_id:, body:, params: {}, header_overrides: {})
-      update_share(
-          share_id: share_id,
-          url: URL,
-          params: params,
-          header_overrides: header_overrides,
-          body: body,
-          workspace_id: workspace_id
-      )
-    end
-
-    private
-
-    include Smartsheet::Share
-  end
+require 'smartsheet/endpoints/share/share'
+
+module Smartsheet
+  # Workspace Sharing Endpoints
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#workspace-sharing API Workspace
+  #   Sharing Docs
+  class WorkspacesShare
+    attr_reader :client
+    private :client
+
+    URL = ['workspaces', :workspace_id].freeze
+
+    def initialize(client)
+      @client = client
+    end
+
+    def delete(workspace_id:, share_id:, params: {}, header_overrides: {})
+      delete_share(
+          share_id: share_id,
+          url: URL,
+          params: params,
+          header_overrides: header_overrides,
+          workspace_id: workspace_id
+      )
+    end
+
+    def get(workspace_id:, share_id:, params: {}, header_overrides: {})
+      get_share(
+          share_id: share_id,
+          url: URL,
+          params: params,
+          header_overrides: header_overrides,
+          workspace_id: workspace_id
+      )
+    end
+
+    def list(workspace_id:, params: {}, header_overrides: {})
+      list_share(
+          url: URL,
+          header_overrides: header_overrides,
+          params: params,
+          workspace_id: workspace_id
+      )
+    end
+
+    def create(workspace_id:, body:, params: {}, header_overrides: {})
+      create_share(
+          url: URL,
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          workspace_id: workspace_id
+      )
+    end
+
+    def update(workspace_id:, share_id:, body:, params: {}, header_overrides: {})
+      update_share(
+          share_id: share_id,
+          url: URL,
+          params: params,
+          header_overrides: header_overrides,
+          body: body,
+          workspace_id: workspace_id
+      )
+    end
+
+    private
+
+    include Smartsheet::Share
+  end
 end

data/lib/smartsheet/error.rb

@@ -1,70 +1,70 @@
-require 'forwardable'
-
-module Smartsheet
-  # Top-level Smartsheet Error
-  class Error < StandardError; end
-
-  # Errors for invalid requests, timeouts, etc.
-  class RequestError < Error
-    attr_reader :wrapped_exception
-
-    def initialize(ex)
-      super(ex.message)
-      @wrapped_exception = ex
-    end
-  end
-
-  # Errors for generic HTTP error codes
-  # @!attribute [r] status_code
-  #   @return [Fixnum] HTTP status code
-  # @!attribute [r] reason_phrase
-  #   @return [String] HTTP reason phrase
-  # @!attribute [r] headers
-  #   @return [Hash] HTTP response headers
-  class HttpResponseError < Error
-    attr_reader :status_code, :reason_phrase, :headers
-
-    def initialize(status_code:, reason_phrase:, headers:, message:)
-      super(message)
-
-      @status_code = status_code
-      @reason_phrase = reason_phrase
-      @headers = headers
-    end
-  end
-
-  # Errors for Smartsheet API error objects
-  # @see https://smartsheet-platform.github.io/api-docs/?ruby#error-object API Error Object Docs
-  #
-  # @!attribute [r] error_code
-  #   @return [Fixnum] Smartsheet error code
-  #   @see https://smartsheet-platform.github.io/api-docs/?ruby#complete-error-code-list API Error
-  #     Code Docs
-  # @!attribute [r] message
-  #   @return [String] Smartsheet error message
-  #   @see https://smartsheet-platform.github.io/api-docs/?ruby#complete-error-code-list API Error
-  #     Code Docs
-  # @!attribute [r] ref_id
-  #   @return [String] Smartsheet error reference ID
-  # @!attribute [r] detail
-  #   @return [Hash, Array, nil] optional details for some error scenarios
-  class ApiError < HttpResponseError
-    extend Forwardable
-
-    def initialize(error_response)
-      super(
-          status_code: error_response.status_code,
-          reason_phrase: error_response.reason_phrase,
-          headers: error_response.headers,
-          message: error_response.message
-      )
-      @error_response = error_response
-    end
-
-    def_delegators :error_response, :error_code, :message, :ref_id, :detail
-
-    private
-
-    attr_reader :error_response
-  end
+require 'forwardable'
+
+module Smartsheet
+  # Top-level Smartsheet Error
+  class Error < StandardError; end
+
+  # Errors for invalid requests, timeouts, etc.
+  class RequestError < Error
+    attr_reader :wrapped_exception
+
+    def initialize(ex)
+      super(ex.message)
+      @wrapped_exception = ex
+    end
+  end
+
+  # Errors for generic HTTP error codes
+  # @!attribute [r] status_code
+  #   @return [Fixnum] HTTP status code
+  # @!attribute [r] reason_phrase
+  #   @return [String] HTTP reason phrase
+  # @!attribute [r] headers
+  #   @return [Hash] HTTP response headers
+  class HttpResponseError < Error
+    attr_reader :status_code, :reason_phrase, :headers
+
+    def initialize(status_code:, reason_phrase:, headers:, message:)
+      super(message)
+
+      @status_code = status_code
+      @reason_phrase = reason_phrase
+      @headers = headers
+    end
+  end
+
+  # Errors for Smartsheet API error objects
+  # @see https://smartsheet-platform.github.io/api-docs/?ruby#error-object API Error Object Docs
+  #
+  # @!attribute [r] error_code
+  #   @return [Fixnum] Smartsheet error code
+  #   @see https://smartsheet-platform.github.io/api-docs/?ruby#complete-error-code-list API Error
+  #     Code Docs
+  # @!attribute [r] message
+  #   @return [String] Smartsheet error message
+  #   @see https://smartsheet-platform.github.io/api-docs/?ruby#complete-error-code-list API Error
+  #     Code Docs
+  # @!attribute [r] ref_id
+  #   @return [String] Smartsheet error reference ID
+  # @!attribute [r] detail
+  #   @return [Hash, Array, nil] optional details for some error scenarios
+  class ApiError < HttpResponseError
+    extend Forwardable
+
+    def initialize(error_response)
+      super(
+          status_code: error_response.status_code,
+          reason_phrase: error_response.reason_phrase,
+          headers: error_response.headers,
+          message: error_response.message
+      )
+      @error_response = error_response
+    end
+
+    def_delegators :error_response, :error_code, :message, :ref_id, :detail
+
+    private
+
+    attr_reader :error_response
+  end
 end

data/lib/smartsheet/general_request.rb

@@ -1,75 +1,75 @@
-require 'smartsheet/api/file_spec'
-
-module Smartsheet
-  module GeneralRequest
-    # Create a custom request using a provided method and URL path
-    # @example Make a GET request to 'https://api.smartsheet.com/2.0/sheets/list'
-    #   client.request(method: :get, url_path: 'sheets/list')
-    def request(method:, url_path:, body: nil, params: {}, header_overrides: {})
-      spec = body.nil? ? {} : {body_type: :json}
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(method, [url_path], **spec)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          body: body,
-          params: params
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-
-    # Create a custom request using a provided method, URL path, and file details
-    # @example Make a POST request to 'https://api.smartsheet.com/2.0/sheets/1/attachments' with a file
-    #   client.request_with_file(
-    #     method: :get,
-    #     url_path: 'sheets/1/attachments',
-    #     file: File.open('my-file.docx'),
-    #     file_length: 1000,
-    #     filename: 'my-uploaded-file.docx',
-    #     content_type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
-    #   )
-    def request_with_file(
-        method:,
-        url_path:,
-        file:,
-        file_length:,
-        filename:,
-        content_type: '',
-        params: {},
-        header_overrides: {}
-    )
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(method, [url_path], body_type: :file)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          file_spec: Smartsheet::API::ObjectFileSpec.new(file, filename, file_length, content_type)
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-
-    # Create a custom request using a provided method, URL path, and filepath details
-    # @example Make a POST request to 'https://api.smartsheet.com/2.0/sheets/1/attachments' with a file
-    #   client.request_with_file_from_path(
-    #     method: :get,
-    #     url_path: 'sheets/1/attachments',
-    #     path: './my-file.docx',
-    #     filename: 'my-uploaded-file.docx',
-    #     content_type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
-    #   )
-    def request_with_file_from_path(
-        method:,
-        url_path:,
-        path:,
-        filename: nil,
-        content_type: '',
-        params: {},
-        header_overrides: {}
-    )
-      endpoint_spec = Smartsheet::API::EndpointSpec.new(method, [url_path], body_type: :file)
-      request_spec = Smartsheet::API::RequestSpec.new(
-          header_overrides: header_overrides,
-          params: params,
-          file_spec: Smartsheet::API::PathFileSpec.new(path, filename, content_type)
-      )
-      client.make_request(endpoint_spec, request_spec)
-    end
-  end
+require 'smartsheet/api/file_spec'
+
+module Smartsheet
+  module GeneralRequest
+    # Create a custom request using a provided method and URL path
+    # @example Make a GET request to 'https://api.smartsheet.com/2.0/sheets/list'
+    #   client.request(method: :get, url_path: 'sheets/list')
+    def request(method:, url_path:, body: nil, params: {}, header_overrides: {})
+      spec = body.nil? ? {} : {body_type: :json}
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(method, [url_path], **spec)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          body: body,
+          params: params
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    # Create a custom request using a provided method, URL path, and file details
+    # @example Make a POST request to 'https://api.smartsheet.com/2.0/sheets/1/attachments' with a file
+    #   client.request_with_file(
+    #     method: :get,
+    #     url_path: 'sheets/1/attachments',
+    #     file: File.open('my-file.docx'),
+    #     file_length: 1000,
+    #     filename: 'my-uploaded-file.docx',
+    #     content_type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+    #   )
+    def request_with_file(
+        method:,
+        url_path:,
+        file:,
+        file_length:,
+        filename:,
+        content_type: '',
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(method, [url_path], body_type: :file)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          file_spec: Smartsheet::API::ObjectFileSpec.new(file, filename, file_length, content_type)
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    # Create a custom request using a provided method, URL path, and filepath details
+    # @example Make a POST request to 'https://api.smartsheet.com/2.0/sheets/1/attachments' with a file
+    #   client.request_with_file_from_path(
+    #     method: :get,
+    #     url_path: 'sheets/1/attachments',
+    #     path: './my-file.docx',
+    #     filename: 'my-uploaded-file.docx',
+    #     content_type: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+    #   )
+    def request_with_file_from_path(
+        method:,
+        url_path:,
+        path:,
+        filename: nil,
+        content_type: '',
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(method, [url_path], body_type: :file)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          file_spec: Smartsheet::API::PathFileSpec.new(path, filename, content_type)
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
 end

data/lib/smartsheet/version.rb

@@ -1,5 +1,5 @@
-require 'smartsheet/constants'
-
-module Smartsheet
-  VERSION = Constants::VERSION
-end
+require 'smartsheet/constants'
+
+module Smartsheet
+  VERSION = Constants::VERSION
+end

data/smartsheet.gemspec

@@ -1,54 +1,54 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'smartsheet/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'smartsheet'
-  spec.version       = Smartsheet::VERSION
-  spec.author        = 'Smartsheet'
-  spec.email        = 'api@smartsheet.com'
-
-  spec.summary       = 'An SDK to simplify connecting to the Smartsheet API from Ruby applications.'
-  spec.description   = <<-EOF
-    This is an SDK to simplify connecting to the Smartsheet API
-    (http://www.smartsheet.com/developers/api-documentation) from Ruby applications.
-  EOF
-  spec.homepage      = 'https://github.com/smartsheet-platform/smartsheet-ruby-sdk'
-  spec.license       = 'Apache-2.0'
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  unless spec.respond_to?(:metadata)
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
-
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(/^(test|spec|features)/)
-  end
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.required_ruby_version = '~> 2.2'
-
-  spec.add_dependency 'faraday', '~> 0.13.1'
-  spec.add_dependency 'faraday_middleware', '~> 0.10.0'
-  spec.add_dependency 'plissken', '~> 1.2'
-  spec.add_dependency 'awrence', '~> 1.0'
-
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'coveralls', '~> 0.8.21'
-  spec.add_development_dependency 'cli', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'mocha', '~> 1.3'
-  spec.add_development_dependency 'timecop', '~> 0.9.1'
-  spec.add_development_dependency 'rubocop', '~> 0.49'
-  spec.add_development_dependency 'reek', '~> 4.7'
-  spec.add_development_dependency 'rubycritic', '~> 3.4'
-  spec.add_development_dependency 'yard', '~> 0.9'
-  spec.add_development_dependency 'redcarpet', '~> 3.4'
-  spec.add_development_dependency 'github-markup', '~> 1.6'
-end
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smartsheet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'smartsheet'
+  spec.version       = Smartsheet::VERSION
+  spec.author        = 'Smartsheet'
+  spec.email        = 'api@smartsheet.com'
+
+  spec.summary       = 'An SDK to simplify connecting to the Smartsheet API from Ruby applications.'
+  spec.description   = <<-EOF
+    This is an SDK to simplify connecting to the Smartsheet API
+    (http://www.smartsheet.com/developers/api-documentation) from Ruby applications.
+  EOF
+  spec.homepage      = 'https://github.com/smartsheet-platform/smartsheet-ruby-sdk'
+  spec.license       = 'Apache-2.0'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  unless spec.respond_to?(:metadata)
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)/)
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.2'
+
+  spec.add_dependency 'faraday', '>= 0.13.1', '< 2'
+  spec.add_dependency 'faraday_middleware', '>= 0.10.0', '< 2'
+  spec.add_dependency 'plissken', '~> 1.2'
+  spec.add_dependency 'awrence', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'coveralls', '~> 0.8.21'
+  spec.add_development_dependency 'cli', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'mocha', '~> 1.3'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+  spec.add_development_dependency 'reek', '~> 4.7'
+  spec.add_development_dependency 'rubycritic', '~> 3.4'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+  spec.add_development_dependency 'github-markup', '~> 1.6'
+end