smartsheet 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39e7fb7367eec5afc35fd45a2b6d22c9e0bdb8dc
-  data.tar.gz: cb77015b925dd36ef95109ce6e6130deb366b2ec
+  metadata.gz: d40986baa13b5cbda5dbf6bab61056dfc3e64b34
+  data.tar.gz: e8fea36ef79dd09ce22a632f5134d5561db01673
 SHA512:
-  metadata.gz: 2c076e95bbc9b1e31152df02c10c69b7ffc4c1e2dac4290d6ec235144f19720fbf98c403e9d30548ca3abded03c03f58176b09dea1207f3c1b35d346680be7de
-  data.tar.gz: 79946c8168b1a0d39654ac6a0b27e305cd7f6252fdef0c3a7fa5da5dade00c3cf9f7da65033846501403bfe5082297fce58426904c8e4dfb0dead95195e61e85
+  metadata.gz: bc87fcc08699c74aa731c9f0c1fd04b2790abbd473ae14ccf92ee3b39a522b9f8369e3b5a5c15b1963923263b7b84d4a2b366de8241198ab6e73ddb3904c6f56
+  data.tar.gz: 54e1bc705a081fcf7809a14b11cbc43f571f61ce59cd225772d66a613397cd0318d5a574eb0b973c8622860a3496ad6f0a6560386fb3a1f03e519e4f8d881d19

data/CHANGELOG.md

@@ -6,7 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-N/A
+## [1.2.0] - 2018-06-29
+### Added
+- Added support for 'import sheet from XLSX, CSV file' endpoints
 
 ## [1.1.0] - 2018-03-16
 ### Added
@@ -95,7 +97,8 @@ N/A
 - Support for logging
 - Test suite with unit tests and two-column-accounting endpoint tests
 
-[Unreleased]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.1.0...HEAD
+[Unreleased]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0.beta.2...v1.0.0
 [1.0.0.beta.2]: https://github.com/smartsheet-platform/smartsheet-ruby-sdk/compare/v1.0.0.beta.1...v1.0.0.beta.2

data/lib/smartsheet/api/file_spec.rb

@@ -27,5 +27,29 @@ module Smartsheet
         @content_type = content_type
       end
     end
+
+    # Specification for file sheet import by path and MIME content type
+    class ImportPathFileSpec
+      attr_reader :upload_io, :filename, :content_type, :file_length
+
+      def initialize(path, content_type)
+        @file_length = File.size(path)
+        @filename = nil
+        @upload_io = Faraday::UploadIO.new(path, content_type)
+        @content_type = content_type
+      end
+    end
+
+    # Specification for file sheet import by {::File}, file length, and MIME content type
+    class ImportObjectFileSpec
+      attr_reader :upload_io, :filename, :content_type, :file_length
+
+      def initialize(file, file_length, content_type)
+        @file_length = file_length
+        @filename = nil
+        @upload_io = Faraday::UploadIO.new(file, content_type)
+        @content_type = content_type
+      end
+    end
   end
 end

data/lib/smartsheet/api/header_builder.rb

@@ -69,7 +69,12 @@ module Smartsheet
 
       def content_disposition
         if endpoint_spec.sending_file?
-          {'Content-Disposition': "attachment; filename=\"#{CGI::escape(request_spec.filename)}\""}
+          filename_suffix =
+            if request_spec.filename.nil?
+              then ''
+              else "; filename=\"#{CGI::escape(request_spec.filename)}\""
+            end
+          {'Content-Disposition': "attachment#{filename_suffix}"}
         else
           {}
         end
@@ -88,4 +93,4 @@ module Smartsheet
       end
     end
   end
-end
+end

data/lib/smartsheet/constants.rb

@@ -1,6 +1,6 @@
 module Smartsheet
   module Constants
-    VERSION = '1.1.0'.freeze
+    VERSION = '1.2.0'.freeze
 
     USER_AGENT = 'smartsheet-ruby-sdk'.freeze
     API_URL = 'https://api.smartsheet.com/2.0'.freeze
@@ -9,6 +9,8 @@ module Smartsheet
     EXCEL_TYPE = 'application/vnd.ms-excel'.freeze
     PDF_TYPE = 'application/pdf'.freeze
     CSV_TYPE = 'text/csv'.freeze
+    OPENXML_SPREADSHEET_TYPE =
+      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'.freeze
 
     DEFAULT_MAX_RETRY_TIME = 15
     DEFAULT_BACKOFF_METHOD = proc { |iteration, _result| 2**iteration + rand }

data/lib/smartsheet/endpoints/sheets/cross_sheet_references.rb

@@ -1,45 +1,45 @@
 module Smartsheet
-    # Cross-sheet References Endpoints
-    # @see http://smartsheet-platform.github.io/api-docs/?ruby#cross-sheet-references API
-    #   Cross-sheet References Docs
-    class CrossSheetReferences
-      attr_reader :client
-      private :client
-  
-      def initialize(client)
-        @client = client
-      end
-  
-      def create(sheet_id:, body:, params: {}, header_overrides: {})
-        endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'crosssheetreferences'], body_type: :json)
-        request_spec = Smartsheet::API::RequestSpec.new(
-            header_overrides: header_overrides,
-            params: params,
-            body: body,
-            sheet_id: sheet_id
-        )
-        client.make_request(endpoint_spec, request_spec)
-      end
-      
-      def list(sheet_id:, params: {}, header_overrides: {})
-        endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'crosssheetreferences'])
-        request_spec = Smartsheet::API::RequestSpec.new(
-            params: params,
-            header_overrides: header_overrides,
-            sheet_id: sheet_id
-        )
-        client.make_request(endpoint_spec, request_spec)
-      end
-      
-      def get(sheet_id:, cross_sheet_reference_id:, params: {}, header_overrides: {})
-        endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'crosssheetreferences', :cross_sheet_reference_id])
-        request_spec = Smartsheet::API::RequestSpec.new(
-            params: params,
-            header_overrides: header_overrides,
-            sheet_id: sheet_id,
-            cross_sheet_reference_id: cross_sheet_reference_id
-        )
-        client.make_request(endpoint_spec, request_spec)
-      end
+  # Cross-sheet References Endpoints
+  # @see http://smartsheet-platform.github.io/api-docs/?ruby#cross-sheet-references API
+  #   Cross-sheet References Docs
+  class CrossSheetReferences
+    attr_reader :client
+    private :client
+
+    def initialize(client)
+      @client = client
     end
-  end
+
+    def create(sheet_id:, body:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:post, ['sheets', :sheet_id, 'crosssheetreferences'], body_type: :json)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          header_overrides: header_overrides,
+          params: params,
+          body: body,
+          sheet_id: sheet_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def list(sheet_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'crosssheetreferences'])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          sheet_id: sheet_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def get(sheet_id:, cross_sheet_reference_id:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(:get, ['sheets', :sheet_id, 'crosssheetreferences', :cross_sheet_reference_id])
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          sheet_id: sheet_id,
+          cross_sheet_reference_id: cross_sheet_reference_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+  end
+end

data/lib/smartsheet/endpoints/sheets/sheets.rb

@@ -1,6 +1,7 @@
 require 'smartsheet/api/endpoint_spec'
 require 'smartsheet/api/request_spec'
 require 'smartsheet/constants'
+require 'smartsheet/error'
 
 require 'smartsheet/endpoints/sheets/automation_rules'
 require 'smartsheet/endpoints/sheets/cells'
@@ -214,6 +215,172 @@ module Smartsheet
       client.make_request(endpoint_spec, request_spec)
     end
 
+    def import_from_file(file:, file_type:, file_length:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['sheets', 'import'],
+          body_type: :file
+      )
+      content_type = file_type_to_content_type(file_type)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          file_spec: Smartsheet::API::ImportObjectFileSpec.new(file, file_length, content_type)
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def import_from_file_path(path:, file_type:, params: {}, header_overrides: {})
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['sheets', 'import'],
+          body_type: :file
+      )
+      content_type = file_type_to_content_type(file_type)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          file_spec: Smartsheet::API::ImportPathFileSpec.new(path, content_type)
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def import_from_file_into_folder(
+        folder_id:,
+        file:,
+        file_type:,
+        file_length:,
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['folders', :folder_id, 'sheets', 'import'],
+          body_type: :file
+      )
+      content_type = file_type_to_content_type(file_type)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          file_spec: Smartsheet::API::ImportObjectFileSpec.new(file, file_length, content_type),
+          folder_id: folder_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def import_from_file_path_into_folder(
+        folder_id:,
+        path:,
+        file_type:,
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['folders', :folder_id, 'sheets', 'import'],
+          body_type: :file
+      )
+      content_type = file_type_to_content_type(file_type)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          file_spec: Smartsheet::API::ImportPathFileSpec.new(path, content_type),
+          folder_id: folder_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def import_from_file_into_workspace(
+        workspace_id:,
+        file:,
+        file_type:,
+        file_length:,
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['workspaces', :workspace_id, 'sheets', 'import'],
+          body_type: :file
+      )
+      content_type = file_type_to_content_type(file_type)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          file_spec: Smartsheet::API::ImportObjectFileSpec.new(file, file_length, content_type),
+          workspace_id: workspace_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    def import_from_file_path_into_workspace(
+        workspace_id:,
+        path:,
+        file_type:,
+        params: {},
+        header_overrides: {}
+    )
+      endpoint_spec = Smartsheet::API::EndpointSpec.new(
+          :post,
+          ['workspaces', :workspace_id, 'sheets', 'import'],
+          body_type: :file
+      )
+      content_type = file_type_to_content_type(file_type)
+      request_spec = Smartsheet::API::RequestSpec.new(
+          params: params,
+          header_overrides: header_overrides,
+          file_spec: Smartsheet::API::ImportPathFileSpec.new(path, content_type),
+          workspace_id: workspace_id
+      )
+      client.make_request(endpoint_spec, request_spec)
+    end
+
+    ### These endpoints are not yet implemented; these endpoints can be re-included once they are
+    ### active
+
+    # def import_and_replace_sheet_from_file(
+    #     sheet_id:,
+    #     file:,
+    #     file_type:,
+    #     file_length:,
+    #     params: {},
+    #     header_overrides: {}
+    # )
+    #   endpoint_spec = Smartsheet::API::EndpointSpec.new(
+    #       :post,
+    #       ['sheets', :sheet_id, 'import'],
+    #       body_type: :file
+    #   )
+    #   content_type = file_type_to_content_type(file_type)
+    #   request_spec = Smartsheet::API::RequestSpec.new(
+    #       params: params,
+    #       header_overrides: header_overrides,
+    #       file_spec: Smartsheet::API::ImportObjectFileSpec.new(file, file_length, content_type)
+    #   )
+    #   client.make_request(endpoint_spec, request_spec)
+    # end
+
+    # def import_and_replace_sheet_from_file_path(
+    #     sheet_id:,
+    #     path:,
+    #     file_type:,
+    #     params: {},
+    #     header_overrides: {}
+    # )
+    #   endpoint_spec = Smartsheet::API::EndpointSpec.new(
+    #       :post,
+    #       ['sheets', :sheet_id, 'import'],
+    #       body_type: :file
+    #   )
+    #   content_type = file_type_to_content_type(file_type)
+    #   request_spec = Smartsheet::API::RequestSpec.new(
+    #       params: params,
+    #       header_overrides: header_overrides,
+    #       file_spec: Smartsheet::API::ImportPathFileSpec.new(path, content_type)
+    #   )
+    #   client.make_request(endpoint_spec, request_spec)
+    # end
+
     def copy(sheet_id:, body:, params: {}, header_overrides: {})
       endpoint_spec = Smartsheet::API::EndpointSpec.new(
           :post,
@@ -322,5 +489,22 @@ module Smartsheet
       )
       client.make_request(endpoint_spec, request_spec)
     end
+
+    private
+
+    def file_type_to_content_type(file_type)
+      mapping = {
+        csv: Constants::CSV_TYPE,
+        xlsx: Constants::OPENXML_SPREADSHEET_TYPE
+      }
+
+      mapping.fetch(file_type) do |_|
+        available_types = mapping.keys.join(', ')
+
+        raise Smartsheet::Error.new(
+          "Unsupported file type: #{file_type}\nValid types: #{available_types}"
+        )
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartsheet
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Smartsheet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday